netbox.netbox.netbox_vlan – Create, update or delete vlans within Netbox¶
Note
This plugin is part of the netbox.netbox collection (version 3.0.0).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_vlan
.
New in version 0.1.0: of netbox.netbox
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 within Netbox with only required information
netbox_vlan:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test VLAN
vid: 400
state: present
- name: Delete vlan within netbox
netbox_vlan:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test VLAN
vid: 400
state: absent
- name: Create vlan with all information
netbox_vlan:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test VLAN
vid: 400
site: Test Site
group: Test VLAN Group
tenant: Test Tenant
status: Deprecated
vlan_role: Test VLAN Role
description: Just a test
tags:
- Schnozzberry
state: present
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Mikhail Yohman (@FragmentedPacket)