netbox.netbox.netbox_vlan – Create, update or delete vlans within Netbox
netbox.netbox.netbox_vlan – Create, update or delete vlans within Netbox
Note
This plugin is part of the netbox.netbox collection (version 1.2.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
Synopsis
- Creates, updates or removes vlans 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 configuration | ||
custom_fields dictionary |
must exist in Netbox | ||
description string |
The description of the vlan | ||
name string / required |
The name of the vlan | ||
site raw |
The site the VLAN will be associated to | ||
status raw |
The status of the vlan | ||
tags list / elements=string |
Any tags that the vlan may need to be associated with | ||
tenant raw |
The tenant that the vlan will be assigned to | ||
vid integer |
The VLAN ID | ||
vlan_group raw |
The VLAN group the VLAN will be associated to | ||
vlan_role raw |
Required if state=present and the vlan does not exist yet | ||
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 |
|
Use | |
validate_certs raw |
Default: "yes" |
If |
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:
Key | Returned | Description |
---|---|---|
msg string |
always |
Message indicating failure or info about what has been achieved
|
vlan dictionary |
success (when state=present) |
Serialized object as created or already existent within Netbox
|
Authors
- Mikhail Yohman (@FragmentedPacket)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netbox/netbox/netbox_vlan_module.html