netbox.netbox.netbox_vlan module – Create, update or delete vlans 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.

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

cert

any

Certificate path

data

dictionary / required

Defines the vlan configuration

comments

string

added in netbox.netbox 3.10.0

Comments that may include additional information in regards to the VLAN

custom_fields

dictionary

must exist in NetBox

description

string

The description of the vlan

name

string / required

The name of the vlan

site

any

The site the VLAN will be associated to

status

any

The status of the vlan

tags

list / elements=any

Any tags that the vlan may need to be associated with

tenant

any

The tenant that the vlan will be assigned to

vid

integer

The VLAN ID

vlan_group

any

The VLAN group the VLAN will be associated to

vlan_role

any

Required if state=present and the vlan does not exist yet

netbox_token

string / required

The NetBox API token.

netbox_url

string / required

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

list / elements=string

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.

state

string

The state of the object.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

Default: true

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

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
          vlan_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

msg

string

Message indicating failure or info about what has been achieved

Returned: always

vlan

dictionary

Serialized object as created or already existent within NetBox

Returned: success (when state=present)

Authors

  • Mikhail Yohman (@FragmentedPacket)