power_outlet¶

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

Added in version 1.0.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis¶

Creates, updates or removes power outlets from Nautobot

Requirements¶

The following Python packages are needed on the host that executes this module:

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
contacts dict		Associate contacts Version Added: 6.3.0
contacts.objects		List of contacts to associate.
contacts.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
description str		Description of the power outlet Version Added: 3.0.0
device raw		The device the power outlet is attached to Requires one of I(device) or I(module) when I(state=present) and the power outlet does not exist yet Version Added: 3.0.0
feed_leg str	Choices: A, B, C	The phase, in case of three-phase feed Version Added: 3.0.0
id str		The UUID of the object to operate on Version Added: 5.13.0
module raw		The attached module Requires one of I(device) or I(module) when I(state=present) and the power outlet does not exist yet Version Added: 5.4.0
name str		The name of the power outlet Required if I(state=present) and the power outlet does not exist yet Version Added: 3.0.0
notes dict		Manage notes on the object Version Added: 6.3.0
notes.objects		List of notes to manage.
notes.state	Default: merge Choices: merge, replace, delete	C(merge) adds notes without removing existing ones. C(replace) enforces exactly the listed notes, removing any extras. C(delete) removes the listed notes.
power_port raw		The attached power port Version Added: 3.0.0
query_params list / elements=str		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. Version Added: 3.0.0
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
teams dict		Associate teams Version Added: 6.3.0
teams.objects		List of teams to associate.
teams.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
type str		The type of the power outlet Version Added: 3.0.0
url str required		The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs raw	Default: True	If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.

Notes¶

Note

Tags should be defined as a YAML list
This should be ran with connection C(local) and hosts C(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

    - name: Delete power outlet by id
      networktocode.nautobot.power_outlet:
        url: http://nautobot.local
        token: thisIsMyToken
        id: 00000000-0000-0000-0000-000000000000
        state: absent

Return Values¶

Key	Data Type	Description	Returned
msg	str	Message indicating failure or info about what has been achieved	always
power_outlet	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))

Authors¶

Tobias Groß (@toerb)