networktocode.nautobot.status module – Creates or removes status from Nautobot

Note

This module is part of the networktocode.nautobot collection (version 5.1.1).

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 string added in networktocode.nautobot 4.1.0	API Version Nautobot REST API
color string added in networktocode.nautobot 3.0.0	Status color
content_types list / elements=string added in networktocode.nautobot 3.0.0	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)
description string added in networktocode.nautobot 3.0.0	The description for the status
name string / required added in networktocode.nautobot 3.0.0	Status name
query_params list / elements=string added in networktocode.nautobot 3.0.0	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.
state string	Use present or absent for adding or removing. Choices: :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` ← (default)
token string / required	The token created within Nautobot to authorize API access
url string / required	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. 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
msg string	Message indicating failure or info about what has been achieved Returned: always
statuses dictionary	Serialized object as created/existent/updated/deleted within Nautobot Returned: always

Authors

• Network to Code (@networktocode)

• Mikhail Yohman (@fragmentedpacket)

• Josh VanDeraa (@jvanaderaa)

Collection links

Issue Tracker Repository (Sources)