netbox.netbox.netbox_vlan_group – Create, update or delete vlans groups within NetBox

Note

This plugin is part of the netbox.netbox collection (version 3.4.0).

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_vlan_group.

New in version 0.1.0: of netbox.netbox

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 Choices/Defaults Comments
cert
raw
Certificate path
data
dictionary / required
Defines the vlan group configuration
custom_fields
dictionary
added in 3.1.0 of netbox.netbox
must exist in NetBox
description
string
added in 3.1.0 of netbox.netbox
Description for VLAN group
name
string / required
The name of the vlan group
scope
raw
added in 3.1.0 of netbox.netbox
Object related to scope type (NetBox 2.11+)
scope_type
string
added in 3.1.0 of netbox.netbox
    Choices:
  • dcim.location
  • dcim.rack
  • dcim.region
  • dcim.site
  • dcim.sitegroup
  • virtualization.cluster
  • virtualization.clustergroup
Type of scope to be applied (NetBox 2.11+)
site
raw
The site the vlan will be assigned to (NetBox < 2.11)
Will be removed in version 5.0.0
slug
string
The slugified version of the name or custom slug.
This is auto-generated following NetBox rules if not provided
netbox_token
string / required
The NetBox API token.
netbox_url
string / required
The URL of the NetBox instance.
Must be accessible by the Ansible control host.
query_params
list / elements=string
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
string
    Choices:
  • present ←
  • absent
The state of the object.
validate_certs
raw
Default:
"yes"
If no, SSL certificates will not be validated.
This should only be used on personally controlled sites using a self-signed certificates.

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: 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 Returned Description
msg
string
always
Message indicating failure or info about what has been achieved

vlan_group
dictionary
success (when state=present)
Serialized object as created or already existent within NetBox



Authors

  • Mikhail Yohman (@FragmentedPacket)