netbox_power_outlet_module.rst

orphan

netbox.netbox.netbox_power_outlet module -- Create, update or delete power outlets within NetBox

Note

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

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

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

ansible-version-added

New in netbox.netbox 0.2.3

Synopsis

• Creates, updates or removes power outlets from NetBox

Requirements

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

• pynetbox

Parameters

ansible-option-table

Parameter	Comments
ansible-option-title cert ansible-option-type-line any	Certificate path
ansible-option-title data ansible-option-type-line dictionary / required	Defines the power outlet configuration
ansible-option-title description ansible-option-type-line string	Description of the power outlet
ansible-option-title device ansible-option-type-line any / required	The device the power outlet is attached to
ansible-option-title feed_leg ansible-option-type-line string	The phase, in case of three-phase feed ansible-option-line Choices: "A" "B" "C"
ansible-option-title name ansible-option-type-line string / required	The name of the power outlet
ansible-option-title power_port ansible-option-type-line any	The attached power port
ansible-option-title tags ansible-option-type-line list / elements=any	Any tags that the power outlet may need to be associated with
ansible-option-title type ansible-option-type-line string	The type of the power outlet ansible-option-line Choices: "iec-60320-c5" "iec-60320-c7" "iec-60320-c13" "iec-60320-c15" "iec-60320-c19" "iec-60309-p-n-e-4h" "iec-60309-p-n-e-6h" "iec-60309-p-n-e-9h" "iec-60309-2p-e-4h" "iec-60309-2p-e-6h" "iec-60309-2p-e-9h" "iec-60309-3p-e-4h" "iec-60309-3p-e-6h" "iec-60309-3p-e-9h" "iec-60309-3p-n-e-4h" "iec-60309-3p-n-e-6h" "iec-60309-3p-n-e-9h" "nema-5-15r" "nema-5-20r" "nema-5-30r" "nema-5-50r" "nema-6-15r" "nema-6-20r" "nema-6-30r" "nema-6-50r" "nema-l5-15r" "nema-l5-20r" "nema-l5-30r" "nema-l5-50r" "nema-l6-20r" "nema-l6-30r" "nema-l6-50r" "nema-l14-20r" "nema-l14-30r" "nema-l21-20r" "nema-l21-30r" "CS6360C" "CS6364C" "CS8164C" "CS8264C" "CS8364C" "CS8464C" "ita-e" "ita-f" "ita-g" "ita-h" "ita-i" "ita-j" "ita-k" "ita-l" "ita-m" "ita-n" "ita-o" "hdot-cx"
ansible-option-title netbox_token ansible-option-type-line string / required	The NetBox API token.
ansible-option-title netbox_url ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
ansible-option-title query_params 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.
ansible-option-title state ansible-option-type-line string	The state of the object. ansible-option-line Choices: "present" ← (default) "absent"
ansible-option-title validate_certs 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. ansible-option-line 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 port within NetBox with only required information
      netbox.netbox.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.netbox.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.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 <common_return_values>, the following are the fields unique to this module:

ansible-option-table

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

Authors

• Tobias Groß (@toerb)

Collection links

Issue Tracker Repository (Sources)