netbox.netbox.netbox_power_outlet_template module – Create, update or delete power outlet templates within NetBox

Note

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

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_outlet_template.

New in version netbox.netbox: 0.2.3

Synopsis

  • Creates, updates or removes power outlet templates from NetBox

Requirements

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

  • pynetbox

Parameters

Parameter

Comments

cert

any

Certificate path

data

dictionary / required

Defines the power outlet configuration

device_type

any / required

The device type the power outlet is attached to

feed_leg

string

The phase, in case of three-phase feed

Choices:

  • A

  • B

  • C

name

string / required

The name of the power outlet

power_port_template

any

The attached power port template

type

string

The type of the power outlet

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

netbox_token

string / required

The NetBox API token.

netbox_url

string / required

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

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.

state

string

The state of the object.

Choices:

  • present ← (default)

  • absent

validate_certs

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

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 outlet template within NetBox with only required information
      netbox_power_outlet_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Outlet Template
          device_type: Test Device Type
        state: present

    - name: Update power outlet template with other fields
      netbox_power_outlet_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Outlet Template
          device_type: Test Device Type
          type: iec-60320-c6
          power_port_template: Test Power Port Template
          feed_leg: A
        state: present

    - name: Delete power outlet template within netbox
      netbox_power_outlet_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Outlet Template
          device_type: Test Device Type
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

Message indicating failure or info about what has been achieved

Returned: always

power_outlet_template

dictionary

Serialized object as created or already existent within NetBox

Returned: success (when state=present)

Authors

  • Tobias Groß (@toerb)