Docs4dev
Docs
ansible / 2.10 / collections / netbox / netbox / netbox_power_outlet_template_module.html

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

Note

This plugin is part of the netbox.netbox collection (version 1.2.0).

To install it use: ansible-galaxy collection install netbox.netbox.

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

New in version 0.2.3: of netbox.netbox

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 Choices/Defaults Comments
data
dictionary / required
Defines the power outlet configuration
device_type
raw / required
The device type the power outlet is attached to
feed_leg
string
    Choices:
  • A
  • B
  • C
The phase, in case of three-phase feed
name
string / required
The name of the power outlet
power_port
raw
The attached power port
type
string
    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
The type of the power outlet
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 port within Netbox with only required information
      netbox_power_outlet_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Outlet
          device_type: Test Device Type
        state: present

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

    - name: Delete power port within netbox
      netbox_power_outlet_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Outlet
          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 Returned Description
msg
string
always
Message indicating failure or info about what has been achieved

power_outlet_template
dictionary
success (when state=present)
Serialized object as created or already existent within Netbox



Authors

  • Tobias Groß (@toerb)

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