vlan¶

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

Added in version 1.0.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis¶

Creates, updates or removes vlans from Nautobot

Requirements¶

The following Python packages are needed on the host that executes this module:

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
description str		The description of the vlan Version Added: 3.0.0
group raw		The group of the VLAN. Version Added: 5.10.0
id str		The UUID of the object to operate on Version Added: 5.13.0
location raw		The single location the VLAN will be associated to If you want to associate multiple locations, use the C(vlan_location) module Using this parameter will override the C(api_version) option to C(2.0) Version Added: 3.0.0
name str		The name of the vlan Required if I(state=present) and the vlan does not exist yet Version Added: 3.0.0
query_params list / elements=str		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. Version Added: 3.0.0
role raw		The role of the VLAN. Version Added: 3.0.0
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
status raw		The status of the vlan Required if I(state=present) and does not exist yet Version Added: 3.0.0
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
tenant raw		The tenant that the vlan will be assigned to Version Added: 3.0.0
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url str required		The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs raw	Default: True	If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.
vid int		The VLAN ID Version Added: 3.0.0
vlan_group raw		The VLAN group the VLAN will be associated to Version Added: 3.0.0

Notes¶

Note

Tags should be defined as a YAML list
This should be ran with connection C(local) and hosts C(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
        location:
          name: My Location
          parent: Parent Location
        group: Test VLAN Group
        tenant: Test Tenant
        status: Deprecated
        role: Test VLAN Role
        description: Just a test
        tags:
          - Schnozzberry
        state: present

    - name: Delete vlan by id
      networktocode.nautobot.vlan:
        url: http://nautobot.local
        token: thisIsMyToken
        id: 00000000-0000-0000-0000-000000000000
        state: absent

Return Values¶

Key	Data Type	Description	Returned
msg	str	Message indicating failure or info about what has been achieved	always
vlan	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))

Authors¶

Mikhail Yohman (@fragmentedpacket)