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

Note

This module is part of the networktocode.nautobot collection (version 4.5.0).

To install it, use: ansible-galaxy collection install networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

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

New in networktocode.nautobot 1.0.0

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
api_version string added in networktocode.nautobot 4.1.0	API Version Nautobot REST API
custom_fields dictionary added in networktocode.nautobot 3.0.0	Must exist in Nautobot and in key/value format
description string added in networktocode.nautobot 3.0.0	The description of the vlan
name string / required added in networktocode.nautobot 3.0.0	The name of the vlan
query_params list / elements=string added in networktocode.nautobot 3.0.0	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 any added in networktocode.nautobot 3.0.0	The site the VLAN will be associated to
state string	Use present or absent for adding or removing. Choices: :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` ← (default)
status any added in networktocode.nautobot 3.0.0	The status of the vlan Required if state=present and does not exist yet
tags list / elements=any added in networktocode.nautobot 3.0.0	Any tags that this item may need to be associated with
tenant any added in networktocode.nautobot 3.0.0	The tenant that the vlan will be assigned to
token string / required	The token created within Nautobot to authorize API access
url string / required	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Default: :ansible-option-default:`true`
vid integer added in networktocode.nautobot 3.0.0	The VLAN ID
vlan_group any added in networktocode.nautobot 3.0.0	The VLAN group the VLAN will be associated to
vlan_role any added in networktocode.nautobot 3.0.0	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)

Collection links

Issue Tracker Repository (Sources)