networktocode.nautobot.device_role – Create, update or delete devices roles within Nautobot

Note

This plugin is part of the networktocode.nautobot collection (version 1.0.4).

To install it use: ansible-galaxy collection install networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.device_role.

New in version 1.0.0: of networktocode.nautobot

Synopsis

• Creates, updates or removes devices roles from Nautobot

Requirements

The below requirements are needed on the host that executes this module.

• pynautobot

Parameters

Parameter		Choices/Defaults	Comments
data dictionary / required			Defines the device role configuration
	color string		Hexidecimal code for a color, ex. FFFFFF
	description string		The description of the device role
	name string / required		The name of the device role
	slug string		The slugified version of the name or custom slug. This is auto-generated following Nautobot rules if not provided
	vm_role boolean	Choices: no yes	Whether the role is a VM role
query_params list / elements=string			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		Choices: absent present ←	Use present or absent for adding or removing.
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		Default: "yes"	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

Examples

- name: "Test Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create device role within Nautobot with only required information
      networktocode.nautobot.device_role:
        url: http://nautobot.local
        token: thisIsMyToken
        data:
          name: Test device role
          color: FFFFFF
        state: present

    - name: Delete device role within nautobot
      networktocode.nautobot.device_role:
        url: http://nautobot.local
        token: thisIsMyToken
        data:
          name: Test Rack role
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
device_role dictionary	success (when state=present)	Serialized object as created or already existent within Nautobot
msg string	always	Message indicating failure or info about what has been achieved

Authors

• Network to Code (@networktocode)