netbox.netbox.netbox_power_feed module – Create, update or delete power feeds within NetBox

Note

This module is part of the netbox.netbox collection (version 3.20.0).

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 netbox.netbox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: netbox.netbox.netbox_power_feed.

New in netbox.netbox 0.2.3

Synopsis

• Creates, updates or removes power feeds from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the power feed configuration
amperage	The amperage of the power feed
comments	Comments related to the power feed
custom_fields	must exist in NetBox
description :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	Description of the power feed
max_utilization	The maximum permissible draw of the power feed in percent
name	The name of the power feed
phase	The phase type of the power feed :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"single-phase"` :ansible-option-choices-entry:`"three-phase"`
power_panel	The power panel the power feed is terminated on
rack	The rack the power feed is assigned to
status	The status of the power feed :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"offline"` :ansible-option-choices-entry:`"active"` :ansible-option-choices-entry:`"planned"` :ansible-option-choices-entry:`"failed"`
supply	The supply type of the power feed :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"ac"` :ansible-option-choices-entry:`"dc"`
tags	Any tags that the power feed may need to be associated with
type	The type of the power feed :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"primary"` :ansible-option-choices-entry:`"redundant"`
voltage	The voltage of the power feed
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
state	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`Default:` :ansible-option-default:`true`

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: false

  tasks:
    - name: Create power feed within NetBox with only required information
      netbox.netbox.netbox_power_feed:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Feed
          power_panel: Test Power Panel
        state: present

    - name: Update power feed with other fields
      netbox.netbox.netbox_power_feed:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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 netbox
      netbox.netbox.netbox_power_feed:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always
power_feed	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)

Authors

• Tobias Groß (@toerb)

Collection links