power_port_template¶

Collection Note

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

ansible-galaxy collection install networktocode.nautobot

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

Synopsis¶

Creates, updates or removes power port templates from Nautobot

Requirements¶

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

pynautobot

Parameters¶

Parameter	Data Type	Comments
allocated_draw	int	The allocated draw of the power port in watt Version Added: 3.0.0
api_version	str	API Version Nautobot REST API Version Added: 4.1.0
device_type	raw	The device type the power port is attached to Version Added: 3.0.0
maximum_draw	int	The maximum permissible draw of the power port in watt Version Added: 3.0.0
module_type	raw	The module type the power port template is attached to Version Added: 5.4.0
name required	str	The name of the power port Version Added: 3.0.0
query_params	list	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	Use C(present) or C(absent) for adding or removing.
token required	str	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 port Version Added: 3.0.0
url required	str	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	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: &#34;Test Nautobot modules&#34;
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create power port within Nautobot with only required information
      networktocode.nautobot.power_port_template:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Port Template
        device_type: Test Device Type
        state: present

    - name: Update power port with other fields
      networktocode.nautobot.power_port_template:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Port Template
        device_type: Test Device Type
        type: iec-60320-c6
        allocated_draw: 16
        maximum_draw: 80
        state: present

    - name: Delete power port within nautobot
      networktocode.nautobot.power_port_template:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Port Template
        device_type: Test Device Type
        state: absent

Return Values¶

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

Authors¶

Tobias Groß (@toerb)