networktocode.nautobot.status module – Creates or removes status from Nautobot¶
Note
This module is part of the networktocode.nautobot collection (version 3.4.0).
You might already have this collection installed if you are using the ansible
package.
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
.
To use it in a playbook, specify: networktocode.nautobot.status
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates or removes status from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
Status color |
|
Status 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) |
|
The description for the status |
|
Status name |
|
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. |
|
The slugified version of the name or custom slug. This is auto-generated following Nautobot rules if not provided |
|
Use Choices:
|
|
The token created within Nautobot to authorize API access |
|
URL of the Nautobot instance resolvable by Ansible control host |
|
Default: “yes” |
Notes¶
Note
Status should be defined as a YAML list
Examples¶
- name: "Test status creation/deletion"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create status
networktocode.nautobot.status:
url: http://nautobot.local
token: thisIsMyToken
name: "ansible_status"
description: "Status if provisioned by Ansible"
content_types:
- dcim.device
- dcim.cable
- dcim.powerfeed
- dcim.rack
- dcim.site
- circuits.circuit
- virtualization.virtualmachine
- ipam.prefix
- ipam.ipaddress
- ipam.vlan
color: 01bea3
- name: Delete status
networktocode.nautobot.status:
url: http://nautobot.local
token: thisIsMyToken
name: "ansible_status"
state: absent
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 Returned: always |
|
Serialized object as created/existent/updated/deleted within Nautobot Returned: always |