netbox.netbox.netbox_vlan_group module – Create, update or delete vlans groups within 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_vlan_group.

New in netbox.netbox 0.1.0

Synopsis

• Creates, updates or removes vlans 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 vlan group configuration
custom_fields :ansible-option-versionadded:`added in netbox.netbox 3.1.0`	must exist in NetBox
description :ansible-option-versionadded:`added in netbox.netbox 3.1.0`	Description for VLAN group
max_vid :ansible-option-versionadded:`added in netbox.netbox 3.7.0`	Highest permissible ID of a child VLAN
min_vid :ansible-option-versionadded:`added in netbox.netbox 3.7.0`	Lowest permissible ID of a child VLAN
name	The name of the vlan group
scope :ansible-option-versionadded:`added in netbox.netbox 3.1.0`	Object related to scope type (NetBox 2.11+)
scope_type :ansible-option-versionadded:`added in netbox.netbox 3.1.0`	Type of scope to be applied (NetBox 2.11+) :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"dcim.location"` :ansible-option-choices-entry:`"dcim.rack"` :ansible-option-choices-entry:`"dcim.region"` :ansible-option-choices-entry:`"dcim.site"` :ansible-option-choices-entry:`"dcim.sitegroup"` :ansible-option-choices-entry:`"virtualization.cluster"` :ansible-option-choices-entry:`"virtualization.clustergroup"`
site	The site the vlan will be assigned to (NetBox < 2.11) Will be removed in version 5.0.0
slug	The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided
tags :ansible-option-versionadded:`added in netbox.netbox 3.6.0`	The tags to add/update
tenant :ansible-option-versionadded:`added in netbox.netbox 3.23.0`	The tenant that the VLAN group will be assigned to
vid_ranges :ansible-option-versionadded:`added in netbox.netbox 3.20.0`	Array of starting and ending VLAN ID pairs
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

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: false

  tasks:
    - name: Create vlan group within NetBox with only required information - Pre 2.11
      netbox_vlan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test vlan group
          site: Test Site
        state: present

    - name: Create vlan group within NetBox with only required information - Post 2.11
      netbox_vlan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test vlan group
          scope_type: "dcim.site"
          scope: Test Site
        state: present

    - name: Create vlan group within NetBox with vid_ranges
      netbox_vlan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test vlan group
          vid_ranges: [
            [1300, 1329],
            [1, 2]
          ]
        state: present

    - name: Create vlan group with tenant assignment
      netbox_vlan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test vlan group
          scope_type: "dcim.site"
          scope: Test Site
          tenant: Test Tenant
        state: present

    - name: Delete vlan group within netbox
      netbox_vlan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test vlan group
        state: absent

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
vlan_group	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links