networktocode.nautobot.role module – Create, update or delete roles within 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.role
.
New in networktocode.nautobot 5.0.0
Synopsis
Creates, updates or removes roles from Nautobot
Requirements
The below requirements are needed on the host that executes this module.
pynautobot
Parameters
Parameter |
Comments |
---|---|
API Version Nautobot REST API |
|
Hexidecimal code for a color, ex. FFFFFF |
|
Model names which the role can be related to. |
|
Must exist in Nautobot and in key/value format |
|
The description of the role |
|
The name of the role |
|
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` |
|
Weight assigned to the role. |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples
- name: "Test Nautobot modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create role within Nautobot with only required information
networktocode.nautobot.role:
url: http://nautobot.local
token: thisIsMyToken
name: Test role
color: FFFFFF
content_types:
- "dcim.device"
state: present
- name: Delete role within nautobot
networktocode.nautobot.role:
url: http://nautobot.local
token: thisIsMyToken
name: Test role
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 or already existent within Nautobot :ansible-option-returned-bold:`Returned:` success (when state=present) |