netbox_vlan_module.rst

orphan:

netbox.netbox.netbox_vlan module -- Create, update or delete vlans within NetBox

Note

This module is part of the netbox.netbox collection (version 3.13.0).

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_vlan_module_requirements>` for details.

To use it in a playbook, specify: netbox.netbox.netbox_vlan.

.. rst-class:: ansible-version-added

New in netbox.netbox 0.1.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Creates, updates or removes vlans from NetBox

Requirements

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

• pynetbox

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title cert .. rst-class:: ansible-option-type-line any	Certificate path
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary / required	Defines the vlan configuration
.. rst-class:: ansible-option-title comments .. rst-class:: ansible-option-type-line string added in netbox.netbox 3.10.0	Comments that may include additional information in regards to the VLAN
.. rst-class:: ansible-option-title custom_fields .. rst-class:: ansible-option-type-line dictionary	must exist in NetBox
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string	The description of the vlan
.. rst-class:: ansible-option-title name .. rst-class:: ansible-option-type-line string / required	The name of the vlan
.. rst-class:: ansible-option-title site .. rst-class:: ansible-option-type-line any	The site the VLAN will be associated to
.. rst-class:: ansible-option-title status .. rst-class:: ansible-option-type-line any	The status of the vlan
.. rst-class:: ansible-option-title tags .. rst-class:: ansible-option-type-line list / elements=any	Any tags that the vlan may need to be associated with
.. rst-class:: ansible-option-title tenant .. rst-class:: ansible-option-type-line any	The tenant that the vlan will be assigned to
.. rst-class:: ansible-option-title vid .. rst-class:: ansible-option-type-line integer	The VLAN ID
.. rst-class:: ansible-option-title vlan_group .. rst-class:: ansible-option-type-line any	The VLAN group the VLAN will be associated to
.. rst-class:: ansible-option-title vlan_role .. rst-class:: ansible-option-type-line any	Required if state=present and the vlan does not exist yet
.. rst-class:: ansible-option-title netbox_token .. rst-class:: ansible-option-type-line string / required	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. rst-class:: ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. rst-class:: ansible-option-type-line 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.
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	The state of the object. .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line Default: :ansible-option-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
          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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table

Key	Description
.. rst-class:: ansible-option-title msg .. rst-class:: ansible-option-type-line string	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always
.. rst-class:: ansible-option-title vlan .. rst-class:: ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line Returned: success (when state=present)

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links

Issue Tracker Repository (Sources)