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.16.0).

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

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

.. rst-class:: ansible-version-added

New in netbox.netbox 3.5.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Creates or removes wireless LANs from NetBox

Requirements

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

• pynetbox

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title cert .. rst-class:: ansible-option-type-line any	Certificate path
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary / required	Defines the contact configuration
.. rst-class:: ansible-option-title auth_cipher .. rst-class:: ansible-option-type-line string	The authentication cipher of the Wireless LAN .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"auto"` :ansible-option-choices-entry:`"tkip"` :ansible-option-choices-entry:`"aes"`
.. rst-class:: ansible-option-title auth_psk .. rst-class:: ansible-option-type-line string	The PSK of the Wireless LAN
.. rst-class:: ansible-option-title auth_type .. rst-class:: ansible-option-type-line string	The authentication type of the Wireless LAN .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"open"` :ansible-option-choices-entry:`"wep"` :ansible-option-choices-entry:`"wpa-personal"` :ansible-option-choices-entry:`"wpa-enterprise"`
.. rst-class:: ansible-option-title comments .. rst-class:: ansible-option-type-line string added in netbox.netbox 3.10.0	Comments of the wireless LAN
.. rst-class:: ansible-option-title custom_fields .. rst-class:: ansible-option-type-line dictionary	must exist in NetBox
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string	The description of the Wireless LAN
.. rst-class:: ansible-option-title ssid .. rst-class:: ansible-option-type-line string / required	Name of the SSID to be created
.. rst-class:: ansible-option-title status .. rst-class:: ansible-option-type-line any	Status of the wireless LAN
.. rst-class:: ansible-option-title tags .. rst-class:: ansible-option-type-line list / elements=any	Any tags that the Wireless LAN may need to be associated with
.. rst-class:: ansible-option-title vlan .. rst-class:: ansible-option-type-line any	The VLAN of the Wireless LAN
.. rst-class:: ansible-option-title wireless_lan_group .. rst-class:: ansible-option-type-line any	The wireless LAN group
.. rst-class:: ansible-option-title netbox_token .. rst-class:: ansible-option-type-line string / required	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. rst-class:: ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. rst-class:: 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.
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	The state of the object. .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: 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. .. rst-class:: ansible-option-line Default: :ansible-option-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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table

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

Authors

• Martin Rødvand (@rodvand)

Collection links

Issue Tracker Repository (Sources)