networktocode.nautobot.tag module – Creates or removes tags from Nautobot

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in networktocode.nautobot 1.0.0

Synopsis

• Creates or removes tags from Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Comments
api_version :ansible-option-versionadded:`added in networktocode.nautobot 4.1.0`	API Version Nautobot REST API
color :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	Tag color
content_types	Tags content type(s). These match app.endpoint and the endpoint is singular. e.g. dcim.device, ipam.ipaddress (more can be found in the examples) Required if state=present and the tag does not exist yet
custom_fields :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	Must exist in Nautobot and in key/value format
description :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	Tag description
name :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	Tag name
query_params :ansible-option-versionadded:`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.
state	Use present or absent for adding or removing. :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
token	The token created within Nautobot to authorize API access Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured.
url	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the :ansenvvarref:`NAUTOBOT\_URL` environment variable is configured.
validate_certs	If 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 :ansenvvar:`NAUTOBOT\_VALIDATE\_CERTS` environment variable is configured. :ansible-option-default-bold:`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 tags creation/deletion"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create tags
      networktocode.nautobot.tag:
        url: http://nautobot.local
        token: thisIsMyToken
        api_version: "1.3"
        name: "{{ item.name }}"
        description: "{{ item.description }}"
        content_types:
          - circuits.circuit
          - circuits.circuit termination
          - circuits.provider
          - circuits.provider network
          - dcim.cable
          - dcim.console port
          - dcim.console server port
          - dcim.device
          - dcim.device bay
          - dcim.device type
          - dcim.front port
          - dcim.interface
          - dcim.inventory item
          - dcim.power feed
          - dcim.power outlet
          - dcim.power panel
          - dcim.power port
          - dcim.rack
          - dcim.rack reservation
          - dcim.rear port
          - dcim.virtual chassis
          - extras.Git repository
          - extras.job
          - extras.secret
          - ipam.aggregate
          - ipam.IP address
          - ipam.prefix
          - ipam.route target
          - ipam.service
          - ipam.VLAN
          - ipam.VRF
          - tenancy.tenant
          - virtualization.cluster
          - virtualization.virtual machine
          - virtualization.VM interface
      loop:
        - { name: mgmt, description: "management" }
        - { name: tun, description: "tunnel" }


    - name: Delete tags
      networktocode.nautobot.tag:
        url: http://nautobot.local
        token: thisIsMyToken
        name: "{{ item }}"
        state: absent
      loop:
        - mgmt
        - tun

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always
tags	Serialized object as created/existent/updated/deleted within Nautobot :ansible-option-returned-bold:`Returned:` always

Authors

• Pavel Korovin (@pkorovin)

Collection links