W3cubDocs

/Ansible

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

Note

This plugin is part of the netbox.netbox collection (version 3.3.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 netbox.netbox.

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

New in version 0.2.3: of netbox.netbox

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 Choices/Defaults Comments
cert
raw
Certificate path
data
dictionary / required
Defines the power feed configuration
amperage
integer
The amperage of the power feed
comments
string
Comments related to the power feed
custom_fields
dictionary
must exist in Netbox
max_utilization
integer
The maximum permissible draw of the power feed in percent
name
string / required
The name of the power feed
phase
string
    Choices:
  • single-phase
  • three-phase
The phase type of the power feed
power_panel
raw / required
The power panel the power feed is terminated on
rack
raw
The rack the power feed is assigned to
status
string
    Choices:
  • offline
  • active
  • planned
  • failed
The status of the power feed
supply
string
    Choices:
  • ac
  • dc
The supply type of the power feed
tags
list / elements=raw
Any tags that the power feed may need to be associated with
type
string
    Choices:
  • primary
  • redundant
The type of the power feed
voltage
integer
The voltage of the power feed
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
    Choices:
  • absent
  • present ←
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.

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_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_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_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 Returned Description
msg
string
always
Message indicating failure or info about what has been achieved
power_feed
dictionary
success (when state=present)
Serialized object as created or already existent within Netbox


Authors

  • Tobias Groß (@toerb)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_power_feed_module.html