netbox.netbox.netbox_power_outlet – Create, update or delete power outlets within Netbox
netbox.netbox.netbox_power_outlet – Create, update or delete power outlets within Netbox
Note
This plugin is part of the netbox.netbox collection (version 1.2.0).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_power_outlet
.
New in version 0.2.3: of netbox.netbox
Synopsis
- Creates, updates or removes power outlets from Netbox
Requirements
The below requirements are needed on the host that executes this module.
- pynetbox
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
data dictionary / required |
Defines the power outlet configuration | ||
description string |
Description of the power outlet | ||
device raw / required |
The device the power outlet is attached to | ||
feed_leg string |
|
The phase, in case of three-phase feed | |
name string / required |
The name of the power outlet | ||
power_port raw |
The attached power port | ||
tags list / elements=string |
Any tags that the power outlet may need to be associated with | ||
type string |
|
The type of the power outlet | |
netbox_token string / required |
The token created within Netbox to authorize API access | ||
netbox_url string / required |
URL of the Netbox instance resolvable by Ansible control host | ||
query_params list / elements=string |
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. | ||
state string |
|
Use | |
validate_certs raw |
Default: "yes" |
If |
Notes
Note
- Tags should be defined as a YAML list
- This should be ran with connection
local
and hostslocalhost
Examples
- name: "Test Netbox modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create power port within Netbox with only required information
netbox_power_outlet:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Power Outlet
device: Test Device
state: present
- name: Update power port with other fields
netbox_power_outlet:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Power Outlet
device: Test Device
type: iec-60320-c6
power_port: Test Power Port
feed_leg: A
description: power port description
state: present
- name: Delete power port within netbox
netbox_power_outlet:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Power Outlet
device: Test Device
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
msg string |
always |
Message indicating failure or info about what has been achieved
|
power_outlet dictionary |
success (when state=present) |
Serialized object as created or already existent within Netbox
|
Authors
- Tobias Groß (@toerb)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netbox/netbox/netbox_power_outlet_module.html