networktocode.nautobot.vlan module – Create, update or delete vlans within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 3.4.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 networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.vlan.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates, updates or removes vlans from Nautobot

Requirements

The below requirements are needed on the host that executes this module.

  • pynautobot

Parameters

Parameter

Comments

custom_fields

dictionary

added in 3.0.0 of networktocode.nautobot

must exist in Nautobot

description

string

added in 3.0.0 of networktocode.nautobot

The description of the vlan

name

string / required

added in 3.0.0 of networktocode.nautobot

The name of the vlan

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined

in plugins/module_utils/utils.py and provides control to users on what may make

an object unique in their environment.

site

raw

added in 3.0.0 of networktocode.nautobot

The site the VLAN will be associated to

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

status

raw

added in 3.0.0 of networktocode.nautobot

The status of the vlan

Required if state=present and does not exist yet

tags

list / elements=raw

added in 3.0.0 of networktocode.nautobot

Any tags that the vlan may need to be associated with

tenant

raw

added in 3.0.0 of networktocode.nautobot

The tenant that the vlan will be assigned to

token

string / required

The token created within Nautobot to authorize API access

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

raw

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

vid

integer

added in 3.0.0 of networktocode.nautobot

The VLAN ID

vlan_group

raw

added in 3.0.0 of networktocode.nautobot

The VLAN group the VLAN will be associated to

vlan_role

raw

added in 3.0.0 of networktocode.nautobot

The role of the VLAN.

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create vlan within Nautobot with only required information
      networktocode.nautobot.vlan:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test VLAN
        vid: 400
        status: active
        state: present

    - name: Delete vlan within nautobot
      networktocode.nautobot.vlan:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test VLAN
        vid: 400
        status: active
        state: absent

    - name: Create vlan with all information
      networktocode.nautobot.vlan:
        url: http://nautobot.local
        token: thisIsMyToken
        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

msg

string

Message indicating failure or info about what has been achieved

Returned: always

vlan

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

Authors

  • Mikhail Yohman (@FragmentedPacket)