netbox.netbox.netbox_vlan module – Create, update or delete vlans within NetBox¶
Note
This module is part of the netbox.netbox collection (version 3.8.1).
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
.
New in netbox.netbox 0.1.0
Synopsis¶
Creates, updates or removes vlans from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the vlan configuration |
|
Comments that may include additional information in regards to the VLAN |
|
must exist in NetBox |
|
The description of the vlan |
|
The name of the vlan |
|
The site the VLAN will be associated to |
|
The status of the vlan |
|
Any tags that the vlan may need to be associated with |
|
The tenant that the vlan will be assigned to |
|
The VLAN ID |
|
The VLAN group the VLAN will be associated to |
|
Required if state=present and the vlan does not exist yet |
|
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: :ansible-option-default:`true` |
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 |
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) |