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

Note

This plugin is part of the netbox.netbox collection.

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

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
data dictionary / required			Defines the vlan group configuration
	name string / required		The name of the vlan group
	site raw		The site the vlan will be assigned to
	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 token created within Netbox to authorize API access
netbox_url string / required			URL of the Netbox instance resolvable by Ansible control host
query_params list / elements=string			This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is 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: absent present ←	Use present or absent for adding or removing.
validate_certs raw		Default: "yes"	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using 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
      netbox_vlan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test vlan group
          site: 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)