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

color

string

added in 3.0.0 of networktocode.nautobot

Status color

content_types

list / elements=string

added in 3.0.0 of networktocode.nautobot

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 3.0.0 of networktocode.nautobot

The description for the status

name

string / required

added in 3.0.0 of networktocode.nautobot

Status name

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

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.

slug

string

added in 3.0.0 of networktocode.nautobot

The slugified version of the name or custom slug.

This is auto-generated following Nautobot rules if not provided

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

token

string / required

The token created within Nautobot to authorize API access

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

raw

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

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

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)