networktocode.nautobot.power_panel module – Create, update or delete power panels within Nautobot

Note

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

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

New in networktocode.nautobot 1.0.0

Synopsis

• Creates, updates or removes power panels from Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Comments
api_version string added in networktocode.nautobot 4.1.0	API Version Nautobot REST API
name string / required added in networktocode.nautobot 3.0.0	The name of the power panel
query_params list / elements=string added in networktocode.nautobot 3.0.0	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.
rack_group any added in networktocode.nautobot 3.0.0	The rack group the power panel is assigned to
site any / required added in networktocode.nautobot 3.0.0	The site the power panel is located in
state string	Use present or absent for adding or removing. Choices: :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` ← (default)
token string / required	The token created within Nautobot to authorize API access
url string / required	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)
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: :ansible-option-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 panel within Nautobot with only required information
      networktocode.nautobot.power_panel:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Panel
        site: Test Site
        state: present

    - name: Update power panel with other fields
      networktocode.nautobot.power_panel:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Panel
        site: Test Site
        rack_group: Test Rack Group
        state: present

    - name: Delete power panel within nautobot
      networktocode.nautobot.power_panel:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Panel
        site: Test Site
        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_panel dictionary	Serialized object as created or already existent within Nautobot Returned: success (when state=present)

Authors

• Tobias Groß (@toerb)

Collection links

Issue Tracker Repository (Sources)