Note
This plugin is part of the netbox.netbox collection (version 2.0.0).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_tag
.
New in version 1.2.0: of netbox.netbox
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
data dictionary / required | Defines the tag configuration | ||
color string | Tag color | ||
description string | Tag description | ||
name string / required | Tag name | ||
slug string | The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided | ||
netbox_token string / required | The token created within Netbox to authorize API access | ||
netbox_url string / required | URL of the Netbox instance resolvable by Ansible control host | ||
query_params list / elements=string | This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. | ||
state string |
| Use present or absent for adding or removing. | |
validate_certs raw | Default: "yes" | If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Note
local
and hosts localhost
- 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 here, 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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netbox/netbox/netbox_tag_module.html