power_port¶
Collection Note
This module is part of the networktocode.nautobot collection. To install the collection, use:
Added in version1.0.0
.
You need further requirements to be able to use this module, see the Requirements section for details.
Synopsis¶
- Creates, updates or removes power ports from Nautobot
Requirements¶
The following Python packages are needed on the host that executes this module:
Parameters¶
Parameter | Defaults / Choices | Comments |
---|---|---|
allocated_draw int |
The allocated draw of the power port in watt Version Added: 3.0.0 |
|
api_version str |
API Version Nautobot REST API Version Added: 4.1.0 |
|
description str |
Description of the power port Version Added: 3.0.0 |
|
device raw |
The device the power port is attached to Requires one of I(device) or I(module) when I(state=present) and the power port does not exist yet Version Added: 3.0.0 |
|
id str |
The UUID of the object to operate on Version Added: 5.13.0 |
|
maximum_draw int |
The maximum permissible draw of the power port in watt Version Added: 3.0.0 |
|
module raw |
The attached module Requires one of I(device) or I(module) when I(state=present) and the power port does not exist yet Version Added: 5.4.0 |
|
name str |
The name of the power port Required if I(state=present) and the power port does not exist yet Version Added: 3.0.0 |
|
query_params list / elements=str |
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. Version Added: 3.0.0 |
|
state str |
Default: present Choices: absent, present |
Use C(present) or C(absent) for adding or removing. |
tags list / elements=raw |
Any tags that this item may need to be associated with Version Added: 3.0.0 |
|
token str required |
The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured. |
|
type str |
The type of the power port Version Added: 3.0.0 |
|
url str required |
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured. |
|
validate_certs raw |
Default: True |
If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured. |
Notes¶
Note
- Tags should be defined as a YAML list
- This should be ran with connection C(local) and hosts C(localhost)
Examples¶
- name: "Test Nautobot modules"
connection: local
hosts: localhost
gather_facts: false
tasks:
- name: Create power port within Nautobot with only required information
networktocode.nautobot.power_port:
url: http://nautobot.local
token: thisIsMyToken
name: Test Power Port
device: Test Device
state: present
- name: Update power port with other fields
networktocode.nautobot.power_port:
url: http://nautobot.local
token: thisIsMyToken
name: Test Power Port
device: Test Device
type: iec-60320-c6
allocated_draw: 16
maximum_draw: 80
description: power port description
state: present
- name: Delete power port within nautobot
networktocode.nautobot.power_port:
url: http://nautobot.local
token: thisIsMyToken
name: Test Power Port
device: Test Device
state: absent
- name: Delete power port by id
networktocode.nautobot.power_port:
url: http://nautobot.local
token: thisIsMyToken
id: 00000000-0000-0000-0000-000000000000
state: absent
Return Values¶
Key | Data Type | Description | Returned |
---|---|---|---|
msg | str | Message indicating failure or info about what has been achieved | always |
power_port | dict | Serialized object as created or already existent within Nautobot | success (when I(state=present)) |
Authors¶
- Tobias Groß (@toerb)