netbox.netbox.netbox_wireless_link – Creates or removes Wireless links from NetBox¶
Note
This plugin is part of the netbox.netbox collection (version 3.5.1).
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_link
.
New in version 3.5.0: of netbox.netbox
Synopsis¶
Creates or removes wireless links from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
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: