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.20.0).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netbox.netbox.netbox_wireless_lan
.
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
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the contact configuration |
|
The authentication cipher of the Wireless LAN |
|
The PSK of the Wireless LAN |
|
Comments of the wireless LAN |
|
must exist in NetBox |
|
The description of the Wireless LAN |
|
Name of the SSID to be created |
|
Status of the wireless LAN |
|
Any tags that the Wireless LAN may need to be associated with |
|
The VLAN of the Wireless LAN |
|
The wireless LAN group |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
If This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`Default:` :ansible-option-default:`true` |
Notes
Note
This should be ran with connection
local
and hostslocalhost
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 |
Description |
---|---|
Message indicating failure or info about what has been achieved |
|
Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation |