Note
This plugin is part of the netbox.netbox collection.
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_power_outlet_template
.
New in version 0.2.3: of netbox.netbox
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
data dictionary / required | Defines the power outlet configuration | ||
device_type raw / required | The device type 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 | ||
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 present or absent for adding or removing. | |
validate_certs raw | Default: "yes" | If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Note
local
and hosts localhost
- 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_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Outlet device_type: Test Device Type state: present - name: Update power port with other fields netbox_power_outlet_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Outlet device_type: Test Device Type type: iec-60320-c6 power_port: Test Power Port feed_leg: A state: present - name: Delete power port within netbox netbox_power_outlet_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Outlet device_type: Test Device Type state: absent
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_template dictionary | success (when state=present) | Serialized object as created or already existent within Netbox |
© 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_template_module.html