networktocode.nautobot.power_outlet module – Create, update or delete power outlets within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 4.1.1).

To install it, use: ansible-galaxy collection install networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: networktocode.nautobot.power_outlet.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates, updates or removes power outlets from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

api_version

string

added in 4.1.0 of networktocode.nautobot

API Version Nautobot REST API

description

string

added in 3.0.0 of networktocode.nautobot

Description of the power outlet

device

any / required

added in 3.0.0 of networktocode.nautobot

The device the power outlet is attached to

feed_leg

string

added in 3.0.0 of networktocode.nautobot

The phase, in case of three-phase feed

Choices:

  • A

  • B

  • C

name

string / required

added in 3.0.0 of networktocode.nautobot

The name of the power outlet

power_port

any

added in 3.0.0 of networktocode.nautobot

The attached power port

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined

in plugins/module_utils/utils.py and provides control to users on what may make

an object unique in their environment.

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

tags

list / elements=any

added in 3.0.0 of networktocode.nautobot

Any tags that the power outlet may need to be associated with

token

string / required

The token created within Nautobot to authorize API access

type

string

added in 3.0.0 of networktocode.nautobot

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

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

any

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using 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 Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create power port within Nautobot with only required information
      networktocode.nautobot.power_outlet:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Outlet
        device: Test Device
        state: present

    - name: Update power port with other fields
      networktocode.nautobot.power_outlet:
        url: http://nautobot.local
        token: thisIsMyToken
        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 nautobot
      networktocode.nautobot.power_outlet:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Outlet
        device: Test Device
        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

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

Authors

  • Tobias Groß (@toerb)