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.1.1).
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¶
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: 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: