netbox.netbox.netbox_wireless_lan_group module – Creates or removes Wireless LAN Groups from NetBox

Note

This module is part of the netbox.netbox collection (version 3.23.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_group.

New in netbox.netbox 3.5.0

Synopsis

• Creates or removes Wireless LAN Groups 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 contact configuration
custom_fields	must exist in NetBox
description	Description of the Wireless LAN Group
name	Name of the Wireless LAN Group to be created
parent_wireless_lan_group	The parent Wireless LAN group
slug	The slug of the Wireless LAN Group
tags	Any tags that the Wireless LAN Group may need to be associated with
headers	Dictionary of headers to be passed to the NetBox API.
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 LAN Group within NetBox with only required information
      netbox_wireless_lan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Wireless LAN Group One
        state: present

    - name: Delete Wireless LAN within netbox
      netbox_wireless_lan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Wireless LAN Group One
        state: absent

    - name: Create Wireless LAN Group with all parameters
      netbox_wireless_lan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Wireless LAN Group One
          description: Wireless LAN Group description
          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_lan_group	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation

Authors

• Martin Rødvand (@rodvand)

Collection links