networktocode.nautobot.status module – Creates or removes status 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.status
.
New in networktocode.nautobot 1.0.0
Synopsis
Creates or removes status from Nautobot
Requirements
The below requirements are needed on the host that executes this module.
pynautobot
Parameters
Parameter |
Comments |
---|---|
API Version Nautobot REST API |
|
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. |
|
Use |
|
The token created within Nautobot to authorize API access Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured. |
|
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. |
|
If Can be omitted if the :ansenvvar:`NAUTOBOT\_VALIDATE\_CERTS` environment variable is configured. :ansible-option-default-bold:`Default:` :ansible-option-default:`true` |
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
- 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 |
|
Serialized object as created/existent/updated/deleted within Nautobot |