wireless_network¶
Collection Note
This module is part of the networktocode.nautobot collection. To install the collection, use:
Added in version5.13.0
.
You need further requirements to be able to use this module, see the Requirements section for details.
Synopsis¶
- Manage wireless networks in Nautobot
Requirements¶
The following Python packages are needed on the host that executes this module:
Parameters¶
Parameter | Defaults / Choices | Comments |
---|---|---|
api_version str |
API Version Nautobot REST API Version Added: 4.1.0 |
|
authentication str |
Choices: Open, WPA2 Personal, WPA2 Enterprise, Enhanced Open, WPA3 Personal, WPA3 SAE, WPA3 Enterprise, WPA3 Enterprise 192Bit | The authentication method of the wireless network Required if I(state=present) and the wireless network does not exist yet |
custom_fields dict |
Must exist in Nautobot and in key/value format Version Added: 3.0.0 |
|
description str |
The description of the wireless network | |
enabled bool |
Whether the wireless network is enabled | |
hidden bool |
Whether the wireless network is hidden | |
id str |
The UUID of the object to operate on Version Added: 5.13.0 |
|
mode str |
Choices: Central, Fabric, Standalone (Autonomous), Local (Flex), Mesh, Bridge | The mode of the wireless network Required if I(state=present) and the wireless network does not exist yet |
name str |
The name of the wireless network Required if I(state=present) and the wireless network does not exist yet |
|
query_params list / elements=str |
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment. Version Added: 3.0.0 |
|
secrets_group raw |
The secrets group of the wireless network | |
ssid str |
The SSID of the wireless network Required if I(state=present) and the wireless network does not exist yet |
|
state str |
Default: present Choices: absent, present |
Use C(present) or C(absent) for adding or removing. |
tags list / elements=raw |
Any tags that this item may need to be associated with Version Added: 3.0.0 |
|
tenant raw |
The tenant of the wireless network | |
token str required |
The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured. |
|
url str required |
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured. |
|
validate_certs raw |
Default: True |
If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured. |
Notes¶
Note
- Tags should be defined as a YAML list
- This should be ran with connection C(local) and hosts C(localhost)
Examples¶
---
- name: Create a wireless network
networktocode.nautobot.wireless_network:
url: http://nautobot.local
token: thisIsMyToken
name: "My Wireless Network"
ssid: "C'mon in!"
mode: "Central"
authentication: "Open"
state: present
- name: Create a wireless network with all options
networktocode.nautobot.wireless_network:
url: http://nautobot.local
token: thisIsMyToken
name: "My Wireless Network"
ssid: "My SSID"
mode: "Central"
description: "My Wireless Network Description"
authentication: "WPA2 Personal"
enabled: true
hidden: false
secrets_group: "My Secrets Group"
tenant: "My Tenant"
state: present
- name: Delete a wireless network
networktocode.nautobot.wireless_network:
url: http://nautobot.local
token: thisIsMyToken
name: "My Wireless Network"
state: absent
- name: Delete a wireless network by id
networktocode.nautobot.wireless_network:
url: http://nautobot.local
token: thisIsMyToken
id: 00000000-0000-0000-0000-000000000000
state: absent
Return Values¶
Key | Data Type | Description | Returned |
---|---|---|---|
msg | str | Message indicating successful operation | success |
wireless_network | dict | Serialized object as created or already existent within Nautobot | success (when I(state=present)) |
Authors¶
- Joe Wesch (@joewesch)