netbox.netbox.netbox_tag module – Creates or removes tags from NetBox
Note
This module is part of the netbox.netbox collection (version 3.20.0).
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 netbox.netbox
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netbox.netbox.netbox_tag
.
New in netbox.netbox 1.2.0
Synopsis
Creates or removes tags from NetBox
Requirements
The below requirements are needed on the host that executes this module.
pynetbox
Parameters
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the tag configuration |
|
Tag color |
|
Tag description |
|
Tag name |
|
The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
If This should only be used on personally controlled sites using a self-signed certificates. :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 hostslocalhost
Examples
- name: "Test tags creation/deletion"
connection: local
hosts: localhost
gather_facts: false
tasks:
- name: Create tags
netbox.netbox.netbox_tag:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: "{{ item.name }}"
description: "{{ item.description }}"
loop:
- { name: mgmt, description: "management" }
- { name: tun, description: "tunnel" }
- name: Delete tags
netbox.netbox.netbox_tag:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
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 |
---|---|
Message indicating failure or info about what has been achieved |
|
Serialized object as created/existent/updated/deleted within NetBox |
Authors
Pavel Korovin (@pkorovin)