networktocode.nautobot.controller module – Create, update or delete controllers 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.controller
.
New in networktocode.nautobot 5.3.0
Synopsis
Creates, updates or removes controllers from Nautobot.
Requirements
The below requirements are needed on the host that executes this module.
pynautobot
Parameters
Parameter |
Comments |
---|---|
API Version Nautobot REST API |
|
Device that runs the controller software |
|
Related device redundancy group the controller will be assigned to |
|
Must exist in Nautobot and in key/value format |
|
Description of the controller |
|
External connection for the controller, such as Meraki Cloud URL |
|
Required if state=present and the controller does not exist yet |
|
The name of the controller |
|
The platform of the controller |
|
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. |
|
Required if state=present and the controller does not exist yet |
|
Use |
|
The status of the controller Required if state=present and the controller does not exist yet |
|
Any tags that this item may need to be associated with |
|
The tenant that the controller will be assigned to |
|
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` |
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 controller within Nautobot with only required information
networktocode.nautobot.controller:
url: http://nautobot.local
token: thisIsMyToken
name: "test_controller_2"
location: My Location
status: "Active"
state: present
- name: "CREATE THE SECOND CONTROLLER"
networktocode.nautobot.controller:
name: "test_controller_3"
url: http://nautobot.local
token: thisIsMyToken
status: "Active"
description: "Description of the controller"
location: "Cisco"
external_integration: "Cisco Catalyst SD-WAN"
role: "Administrative"
platform: "Cisco IOS"
tenant: "Nautobot Baseball Stadiums"
controller_device_redundancy_group: "controller_test"
- name: Delete controller within nautobot
networktocode.nautobot.controller:
url: http://nautobot.local
token: thisIsMyToken
name: test_controller_3
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Serialized object as created or already existent within Nautobot :ansible-option-returned-bold:`Returned:` success (when state=present) |
|
Message indicating failure or info about what has been achieved |