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.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_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
cert	Certificate path
data	Defines the wireless link configuration
auth_cipher	The authentication cipher of the wireless link :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"auto"` :ansible-option-choices-entry:`"tkip"` :ansible-option-choices-entry:`"aes"`
auth_psk	The PSK of the wireless link
auth_type	The authentication type of the wireless link :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"open"` :ansible-option-choices-entry:`"wep"` :ansible-option-choices-entry:`"wpa-personal"` :ansible-option-choices-entry:`"wpa-enterprise"`
comments :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	Comments of the wireless link
custom_fields	must exist in NetBox
description	Description of the wireless link
interface_a	Interface A of the wireless link
interface_b	Interface A of the wireless link
ssid	The SSID of the wireless link
status	The status of the wireless link :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"connected"` :ansible-option-choices-entry:`"planned"` :ansible-option-choices-entry:`"decommissioning"`
tags	Any tags that the wireless link may need to be associated with
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If `no`, SSL certificates will not be validated. 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 hosts localhost

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
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always
wireless_link	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation

Authors

Martin Rødvand (@rodvand)

netbox.netbox.netbox_wireless_link module – Creates or removes Wireless links from NetBox

Synopsis

Requirements

Parameters

Notes

Examples

Return Values