netbox.netbox.netbox_wireless_link module – Creates or removes Wireless links from NetBox¶
Note
This module is part of the netbox.netbox collection (version 3.10.0).
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_link
.
New in netbox.netbox 3.5.0
Synopsis¶
Creates or removes wireless links from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the wireless link configuration |
|
The authentication cipher of the wireless link Choices: |
|
The PSK of the wireless link |
|
The authentication type of the wireless link Choices: |
|
Comments of the wireless link |
|
must exist in NetBox |
|
Description of the wireless link |
|
Interface A of the wireless link |
|
Interface A of the wireless link |
|
The SSID of the wireless link |
|
The status of the wireless link Choices: |
|
Any tags that the wireless link may need to be associated with |
|
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. |
|
The state of the object. Choices: |
|
If This should only be used on personally controlled sites using a self-signed certificates. 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 link within NetBox with only required information
netbox_wireless_link:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
interface_a:
device: Device One
name: wireless_link_0
interface_b:
device: Device Two
name: wireless_link_0
state: present
- name: Delete wireless link within netbox
netbox_wireless_link:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
interface_a:
device: Device One
name: wireless_link_0
interface_b:
device: Device Two
name: wireless_link_0
state: absent
- name: Create wireless link with all parameters
netbox_wireless_link:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
interface_a:
device: Device One
name: wireless_link_0
interface_b:
device: Device Two
name: wireless_link_0
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 Returned: always |
|
Serialized object as created or already existent within NetBox Returned: on creation |