networktocode.nautobot.power_feed module – Create, update or delete power feeds 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.power_feed
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates, updates or removes power feeds from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
The amperage of the power feed |
|
Comments related to the power feed |
|
must exist in Nautobot |
|
The maximum permissible draw of the power feed in percent |
|
The name of the power feed |
|
The phase type of the power feed Choices:
|
|
The power panel the power feed is terminated on |
|
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 rack the power feed is assigned to |
|
Use Choices:
|
|
The status of the power feed Required if state=present and does not exist yet |
|
The supply type of the power feed Choices:
|
|
Any tags that the power feed may need to be associated with |
|
The token created within Nautobot to authorize API access |
|
The type of the power feed Choices:
|
|
URL of the Nautobot instance resolvable by Ansible control host |
|
If Default: “yes” |
|
The voltage of the power feed |
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 power feed within Nautobot with only required information
networktocode.nautobot.power_feed:
url: http://nautobot.local
token: thisIsMyToken
name: Test Power Feed
power_panel: Test Power Panel
status: active
state: present
- name: Update power feed with other fields
networktocode.nautobot.power_feed:
url: http://nautobot.local
token: thisIsMyToken
name: Test Power Feed
power_panel: Test Power Panel
status: offline
type: primary
supply: ac
phase: single-phase
voltage: 230
amperage: 16
max_utilization: 80
comments: normal power feed
state: present
- name: Delete power feed within nautobot
networktocode.nautobot.power_feed:
url: http://nautobot.local
token: thisIsMyToken
name: Test Power Feed
power_panel: Test Power Panel
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) |