netbox_wireless_link_module.rst

orphan

netbox.netbox.netbox_wireless_link -- Creates or removes Wireless links from NetBox

Note

This plugin is part of the netbox.netbox collection (version 3.5.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netbox.netbox.

To use it in a playbook, specify: netbox.netbox.netbox_wireless_link.

3.5.0 of netbox.netbox

Synopsis

• Creates or removes wireless links from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

Parameter		Choices/Defaults	Comments
cert raw			Certificate path
data dictionary / required			Defines the wireless link configuration
	auth_cipher string	Choices: auto tkip aes	The authentication cipher of the wireless link
	auth_psk string		The PSK of the wireless link
	auth_type string	Choices: open wep wpa-personal wpa-enterprise	The authentication type of the wireless link
	custom_fields dictionary		must exist in NetBox
	description string		Description of the wireless link
	interface_a raw / required		Interface A of the wireless link
	interface_b raw / required		Interface A of the wireless link
	ssid string		The SSID of the wireless link
	status string	Choices: connected planned decommissioning	The status of the wireless link
	tags list / elements=raw		Any tags that the wireless link may need to be associated with
netbox_token string / required			The NetBox API token.
netbox_url string / required			The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params list / elements=string			This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
state string		Choices: present ← absent	The state of the object.
validate_certs raw		Default: "yes"	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates.

Notes

Note

- This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create wireless link within NetBox with only required information
      netbox_wireless_link:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          interface_a:
            device: Device One
            name: wireless_link_0
          interface_b:
            device: Device Two
            name: wireless_link_0
        state: present

    - name: Delete wireless link within netbox
      netbox_wireless_link:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          interface_a:
            device: Device One
            name: wireless_link_0
          interface_b:
            device: Device Two
            name: wireless_link_0
        state: absent

    - name: Create wireless link with all parameters
      netbox_wireless_link:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          interface_a:
            device: Device One
            name: wireless_link_0
          interface_b:
            device: Device Two
            name: wireless_link_0
          ssid: Wireless Network One          
          description: Cool Wireless Network
          auth_type: wpa-enterprise
          auth_cipher: aes
          auth_psk: psk123456                    
          tags:
            - tagA
            - tagB
            - tagC
        state: present

Return Values

Common return values are documented here <common_return_values>, the following are the fields unique to this module:

Key	Returned	Description
msg string	always	Message indicating failure or info about what has been achieved
wireless_link dictionary	on creation	Serialized object as created or already existent within NetBox

Authors

• Martin Rødvand (@rodvand)