netbox.netbox.netbox_wireless_lan – Creates or removes Wireless LANs from NetBox

Note

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

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_lan.

New in version 3.5.0: of netbox.netbox

Synopsis

  • Creates or removes wireless LANs 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 contact configuration
auth_cipher
string
    Choices:
  • auto
  • tkip
  • aes
The authentication cipher of the Wireless LAN
auth_psk
string
The PSK of the Wireless LAN
auth_type
string
    Choices:
  • open
  • wep
  • wpa-personal
  • wpa-enterprise
The authentication type of the Wireless LAN
custom_fields
dictionary
must exist in NetBox
description
string
The description of the Wireless LAN
ssid
string / required
Name of the SSID to be created
tags
list / elements=raw
Any tags that the Wireless LAN may need to be associated with
vlan
raw
The VLAN of the Wireless LAN
wireless_lan_group
raw
The wireless LAN group
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 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, 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_lan
dictionary
on creation
Serialized object as created or already existent within NetBox


Authors

  • Martin Rødvand (@rodvand)