netbox_power_feed_module.rst

orphan:

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.16.0).

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_power_feed_module_requirements>` for details.

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

.. rst-class:: ansible-version-added

New in netbox.netbox 0.2.3

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Creates, updates or removes power feeds from NetBox

Requirements

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

• pynetbox

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title cert .. rst-class:: ansible-option-type-line any	Certificate path
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary / required	Defines the power feed configuration
.. rst-class:: ansible-option-title amperage .. rst-class:: ansible-option-type-line integer	The amperage of the power feed
.. rst-class:: ansible-option-title comments .. rst-class:: ansible-option-type-line string	Comments related to the power feed
.. rst-class:: ansible-option-title custom_fields .. rst-class:: ansible-option-type-line dictionary	must exist in NetBox
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string added in netbox.netbox 3.10.0	Description of the power feed
.. rst-class:: ansible-option-title max_utilization .. rst-class:: ansible-option-type-line integer	The maximum permissible draw of the power feed in percent
.. rst-class:: ansible-option-title name .. rst-class:: ansible-option-type-line string / required	The name of the power feed
.. rst-class:: ansible-option-title phase .. rst-class:: ansible-option-type-line string	The phase type of the power feed .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"single-phase"` :ansible-option-choices-entry:`"three-phase"`
.. rst-class:: ansible-option-title power_panel .. rst-class:: ansible-option-type-line any / required	The power panel the power feed is terminated on
.. rst-class:: ansible-option-title rack .. rst-class:: ansible-option-type-line any	The rack the power feed is assigned to
.. rst-class:: ansible-option-title status .. rst-class:: ansible-option-type-line string	The status of the power feed .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"offline"` :ansible-option-choices-entry:`"active"` :ansible-option-choices-entry:`"planned"` :ansible-option-choices-entry:`"failed"`
.. rst-class:: ansible-option-title supply .. rst-class:: ansible-option-type-line string	The supply type of the power feed .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"ac"` :ansible-option-choices-entry:`"dc"`
.. rst-class:: ansible-option-title tags .. rst-class:: ansible-option-type-line list / elements=any	Any tags that the power feed may need to be associated with
.. rst-class:: ansible-option-title type .. rst-class:: ansible-option-type-line string	The type of the power feed .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"primary"` :ansible-option-choices-entry:`"redundant"`
.. rst-class:: ansible-option-title voltage .. rst-class:: ansible-option-type-line integer	The voltage of the power feed
.. rst-class:: ansible-option-title netbox_token .. rst-class:: ansible-option-type-line string / required	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. rst-class:: ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. rst-class:: ansible-option-type-line list / elements=string	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.
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	The state of the object. .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line 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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table

Key	Description
.. rst-class:: ansible-option-title msg .. rst-class:: ansible-option-type-line string	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always
.. rst-class:: ansible-option-title power_feed .. rst-class:: ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line Returned: success (when state=present)

Authors

• Tobias Groß (@toerb)

Collection links

Issue Tracker Repository (Sources)