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.20.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
.
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 |
---|---|
Certificate path |
|
Defines the vlan group configuration |
|
must exist in NetBox |
|
Description for VLAN group |
|
Highest permissible ID of a child VLAN |
|
Lowest permissible ID of a child VLAN |
|
The name of the vlan group |
|
Object related to scope type (NetBox 2.11+) |
|
Type of scope to be applied (NetBox 2.11+) Choices:
|
|
The site the vlan will be assigned to (NetBox < 2.11) Will be removed in version 5.0.0 |
|
The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided |
|
The tags to add/update |
|
Array of starting and ending VLAN ID pairs |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
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: 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 |
---|---|
Message indicating failure or info about what has been achieved Returned: always |
|
Serialized object as created or already existent within NetBox Returned: success (when state=present) |