power_feed¶
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 feeds from Nautobot
Requirements¶
The following Python packages are needed on the host that executes this module:
Parameters¶
Parameter | Defaults / Choices | Comments |
---|---|---|
amperage int |
The amperage of the power feed Version Added: 3.0.0 |
|
api_version str |
API Version Nautobot REST API Version Added: 4.1.0 |
|
comments str |
Comments related to the power feed Version Added: 3.0.0 |
|
custom_fields dict |
Must exist in Nautobot and in key/value format Version Added: 3.0.0 |
|
id str |
The UUID of the object to operate on Version Added: 5.13.0 |
|
max_utilization int |
The maximum permissible draw of the power feed in percent Version Added: 3.0.0 |
|
name str |
The name of the power feed Required if I(state=present) and the power feed does not exist yet Version Added: 3.0.0 |
|
phase str |
Choices: single-phase, three-phase | The phase type of the power feed Version Added: 3.0.0 |
power_panel raw |
The power panel the power feed is terminated on Required if I(state=present) and the power feed 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 |
|
rack raw |
The rack the power feed is assigned to Version Added: 3.0.0 |
|
state str |
Default: present Choices: absent, present |
Use C(present) or C(absent) for adding or removing. |
status str |
The status of the power feed Required if I(state=present) and does not exist yet Version Added: 3.0.0 |
|
supply str |
Choices: ac, dc | The supply type of the power feed Version Added: 3.0.0 |
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 |
Choices: primary, redundant | The type of the power feed 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. |
voltage int |
The voltage of the power feed Version Added: 3.0.0 |
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 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
- name: Delete power feed by id
networktocode.nautobot.power_feed:
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_feed | dict | Serialized object as created or already existent within Nautobot | success (when I(state=present)) |
Authors¶
- Tobias Groß (@toerb)