netbox_wireless_lan_module.rst

orphan

netbox.netbox.netbox_wireless_lan module -- Creates or removes Wireless LANs from NetBox

Note

This module is part of the netbox.netbox collection (version 3.14.0).

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see Requirements <ansible_collections.netbox.netbox.netbox_wireless_lan_module_requirements> for details.

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

ansible-version-added

New in netbox.netbox 3.5.0

Synopsis

• Creates or removes wireless LANs from NetBox

Requirements

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

• pynetbox

Parameters

ansible-option-table

Parameter	Comments
ansible-option-title cert ansible-option-type-line any	Certificate path
ansible-option-title data ansible-option-type-line dictionary / required	Defines the contact configuration
ansible-option-title auth_cipher ansible-option-type-line string	The authentication cipher of the Wireless LAN ansible-option-line Choices: "auto" "tkip" "aes"
ansible-option-title auth_psk ansible-option-type-line string	The PSK of the Wireless LAN
ansible-option-title auth_type ansible-option-type-line string	The authentication type of the Wireless LAN ansible-option-line Choices: "open" "wep" "wpa-personal" "wpa-enterprise"
ansible-option-title comments ansible-option-type-line string added in netbox.netbox 3.10.0	Comments of the wireless LAN
ansible-option-title custom_fields ansible-option-type-line dictionary	must exist in NetBox
ansible-option-title description ansible-option-type-line string	The description of the Wireless LAN
ansible-option-title ssid ansible-option-type-line string / required	Name of the SSID to be created
ansible-option-title status ansible-option-type-line any	Status of the wireless LAN
ansible-option-title tags ansible-option-type-line list / elements=any	Any tags that the Wireless LAN may need to be associated with
ansible-option-title vlan ansible-option-type-line any	The VLAN of the Wireless LAN
ansible-option-title wireless_lan_group ansible-option-type-line any	The wireless LAN group
ansible-option-title netbox_token ansible-option-type-line string / required	The NetBox API token.
ansible-option-title netbox_url ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
ansible-option-title query_params ansible-option-type-line 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.
ansible-option-title state ansible-option-type-line string	The state of the object. ansible-option-line Choices: "present" ← (default) "absent"
ansible-option-title validate_certs ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. ansible-option-line Default: true

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 LAN within NetBox with only required information
      netbox_wireless_lan:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          ssid: Wireless Network One
        state: present

    - name: Delete Wireless LAN within netbox
      netbox_wireless_lan:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          ssid: Wireless Network One
        state: absent

    - name: Create Wireless LAN with all parameters
      netbox_wireless_lan:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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:

ansible-option-table

Key	Description
ansible-option-title msg ansible-option-type-line string	Message indicating failure or info about what has been achieved ansible-option-line Returned: always
ansible-option-title wireless_lan ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox ansible-option-line Returned: on creation

Authors

• Martin Rødvand (@rodvand)

Collection links

Issue Tracker Repository (Sources)