networktocode.nautobot.power_feed module – Create, update or delete power feeds within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 5.2.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_feed.

New in networktocode.nautobot 1.0.0

Synopsis

  • Creates, updates or removes power feeds from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

amperage

integer

added in networktocode.nautobot 3.0.0

The amperage of the power feed

api_version

string

added in networktocode.nautobot 4.1.0

API Version Nautobot REST API

comments

string

added in networktocode.nautobot 3.0.0

Comments related to the power feed

custom_fields

dictionary

added in networktocode.nautobot 3.0.0

Must exist in Nautobot and in key/value format

max_utilization

integer

added in networktocode.nautobot 3.0.0

The maximum permissible draw of the power feed in percent

name

string / required

added in networktocode.nautobot 3.0.0

The name of the power feed

phase

string

added in networktocode.nautobot 3.0.0

power_panel

any / required

added in networktocode.nautobot 3.0.0

The power panel the power feed is terminated on

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

any

added in networktocode.nautobot 3.0.0

The rack the power feed is assigned to

state

string

Use present or absent for adding or removing.

Choices:

status

string

added in networktocode.nautobot 3.0.0

The status of the power feed

Required if state=present and does not exist yet

supply

string

added in networktocode.nautobot 3.0.0

tags

list / elements=any

added in networktocode.nautobot 3.0.0

Any tags that this item may need to be associated with

token

string / required

The token created within Nautobot to authorize API access

Can be omitted if the NAUTOBOT_TOKEN environment variable is configured.

type

string

added in networktocode.nautobot 3.0.0

url

string / required

The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)

Can be omitted if the NAUTOBOT_URL environment variable is configured.

validate_certs

any

If 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 NAUTOBOT_VALIDATE_CERTS environment variable is configured.

Default: :ansible-option-default:`true`

voltage

integer

added in networktocode.nautobot 3.0.0

The voltage of the power feed

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 feed within Nautobot with only required information
      networktocode.nautobot.power_feed:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Feed
        power_panel: Test Power Panel
        status: active
        state: present

    - name: Update power feed with other fields
      networktocode.nautobot.power_feed:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Feed
        power_panel: Test Power Panel
        status: offline
        type: primary
        supply: ac
        phase: single-phase
        voltage: 230
        amperage: 16
        max_utilization: 80
        comments: normal power feed
        state: present

    - name: Delete power feed within nautobot
      networktocode.nautobot.power_feed:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Power Feed
        power_panel: Test Power Panel
        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_feed

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

Authors

  • Tobias Groß (@toerb)