networktocode.nautobot.rear_port_template module – Create, update or delete rear port templates 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.rear_port_template
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates, updates or removes rear port templates from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
The device type the rear port template is attached to |
|
The name of the rear port template |
|
The number of front ports which may be mapped to each rear 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:
|
|
The token created within Nautobot to authorize API access |
|
The type of the rear 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 rear port template within Nautobot with only required information
networktocode.nautobot.rear_port_template:
url: http://nautobot.local
token: thisIsMyToken
name: Test Rear Port Template
device_type: Test Device Type
type: bnc
state: present
- name: Update rear port template with other fields
networktocode.nautobot.rear_port_template:
url: http://nautobot.local
token: thisIsMyToken
name: Test Rear Port Template
device_type: Test Device Type
type: bnc
positions: 5
state: present
- name: Delete rear port template within nautobot
networktocode.nautobot.rear_port_template:
url: http://nautobot.local
token: thisIsMyToken
name: Test Rear Port Template
device_type: Test Device Type
type: bnc
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 Returned: always |
|
Serialized object as created or already existent within Nautobot Returned: success (when state=present) |