orphan: |
---|
Note
This plugin is part of the netbox.netbox collection (version 3.1.2).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_tag
.
.. versionadded:: 1.2.0 of netbox.netbox
- Creates or removes tags from Netbox
The below requirements are needed on the host that executes this module.
- pynetbox
Note
- Tags should be defined as a YAML list
- This should be ran with connection
local
and hostslocalhost
- name: "Test tags creation/deletion"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create tags
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_tag:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: "{{ item }}"
state: absent
loop:
- mgmt
- tun
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
msg
string
|
always |
Message indicating failure or info about what has been achieved
|
tags
dictionary
|
always |
Serialized object as created/existent/updated/deleted within Netbox
|
- Pavel Korovin (@pkorovin)