status¶
Collection Note
This module is part of the networktocode.nautobot collection. To install the collection, use:
Added in version1.0.0
.
You need further requirements to be able to use this module, see the Requirements section for details.
Synopsis¶
- Creates or removes status from Nautobot
Requirements¶
The following Python packages are needed on the host that executes this module:
Parameters¶
Parameter | Defaults / Choices | Comments |
---|---|---|
api_version str |
API Version Nautobot REST API Version Added: 4.1.0 |
|
color str |
Status color Version Added: 3.0.0 |
|
content_types list / elements=str |
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) Version Added: 3.0.0 |
|
description str |
The description for the status Version Added: 3.0.0 |
|
id str |
The UUID of the object to operate on Version Added: 5.13.0 |
|
name str |
Status name Required if I(state=present) and the status does not exist yet Version Added: 3.0.0 |
|
query_params list / elements=str |
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. Version Added: 3.0.0 |
|
state str |
Default: present Choices: absent, present |
Use C(present) or C(absent) for adding or removing. |
token str required |
The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured. |
|
url str required |
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured. |
|
validate_certs raw |
Default: True |
If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured. |
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
- name: Delete status by id
networktocode.nautobot.status:
url: http://nautobot.local
token: thisIsMyToken
id: 00000000-0000-0000-0000-000000000000
state: absent
Return Values¶
Key | Data Type | Description | Returned |
---|---|---|---|
msg | str | Message indicating failure or info about what has been achieved | always |
statuses | dict | Serialized object as created/existent/updated/deleted within Nautobot | always |
Authors¶
- Network To Code (@networktocode)
- Mikhail Yohman (@fragmentedpacket)
- Josh Vanderaa (@jvanaderaa)