- orphan
Note
This module is part of the networktocode.nautobot collection (version 5.2.1).
To install it, use: ansible-galaxy collection install networktocode.nautobot
. You need further requirements to be able to use this module, see Requirements <ansible_collections.networktocode.nautobot.front_port_module_requirements>
for details.
To use it in a playbook, specify: networktocode.nautobot.front_port
.
ansible-version-added
New in networktocode.nautobot 1.0.0
- Creates, updates or removes front ports from Nautobot
The below requirements are needed on the host that executes this module.
- pynautobot
ansible-option-table
Parameter | Comments |
---|---|
API Version Nautobot REST API |
|
Description of the front port |
|
The device the front port is attached to |
|
The name of the front 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. |
|
The rear_port the front port is attached to |
|
The position of the rear port this front port is connected to |
|
Use ansible-option-line Choices:
|
|
Any tags that this item may need to be associated with |
|
The token created within Nautobot to authorize API access Can be omitted if the |
|
The type of the front port |
|
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the |
|
If Can be omitted if the ansible-option-line Default: |
Note
- Tags should be defined as a YAML list - This should be ran with connection local
and hosts localhost
- name: "Test Nautobot modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create front port within Nautobot with only required information
networktocode.nautobot.front_port:
url: http://nautobot.local
token: thisIsMyToken
name: Test Front Port
device: Test Device
type: bnc
rear_port: Test Rear Port
state: present
- name: Update front port with other fields
networktocode.nautobot.front_port:
url: http://nautobot.local
token: thisIsMyToken
name: Test Front Port
device: Test Device
type: bnc
rear_port: Test Rear Port
rear_port_position: 5
description: front port description
state: present
- name: Delete front port within nautobot
networktocode.nautobot.front_port:
url: http://nautobot.local
token: thisIsMyToken
name: Test Front Port
device: Test Device
type: bnc
rear_port: Test Rear Port
state: absent
Common return values are documented here <common_return_values>
, the following are the fields unique to this module:
ansible-option-table
Key | Description |
---|---|
Serialized object as created or already existent within Nautobot ansible-option-line Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved ansible-option-line Returned: always |
- Tobias Groß (@toerb)