networktocode.nautobot.console_port module – Create, update or delete console ports within 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.console_port
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates, updates or removes console ports from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
Description of the console port |
|
The device the console port is attached to |
|
The name of the console port |
|
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 Choices:
|
|
Any tags that the console port may need to be associated with |
|
The token created within Nautobot to authorize API access |
|
The type of the console port Choices:
|
|
URL of the Nautobot instance resolvable by Ansible control host |
|
If Default: “yes” |
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 console port within Nautobot with only required information
networktocode.nautobot.console_port:
url: http://nautobot.local
token: thisIsMyToken
name: Test Console Port
device: Test Device
state: present
- name: Update console port with other fields
networktocode.nautobot.console_port:
url: http://nautobot.local
token: thisIsMyToken
name: Test Console Port
device: Test Device
type: usb-a
description: console port description
state: present
- name: Delete console port within nautobot
networktocode.nautobot.console_port:
url: http://nautobot.local
token: thisIsMyToken
name: Test Console Port
device: Test Device
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 Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved Returned: always |