netbox.netbox.netbox_power_panel module – Create, update or delete power panels within NetBox

Note

This module is part of the netbox.netbox collection (version 3.7.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netbox.netbox.

To use it in a playbook, specify: netbox.netbox.netbox_power_panel.

New in version 0.2.3: of netbox.netbox

Synopsis

  • Creates, updates or removes power panels from NetBox

Requirements

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

  • pynetbox

Parameters

Parameter

Comments

cert

raw

Certificate path

data

dictionary / required

Defines the power panel configuration

custom_fields

dictionary

added in 3.6.0 of netbox.netbox

Must exist in NetBox

location

raw

added in 3.1.0 of netbox.netbox

The location the power panel is assigned to (NetBox 2.11+)

name

string / required

The name of the power panel

rack_group

raw

The rack group the power panel is assigned to (NetBox < 2.11)

Will be removed in version 5.0.0

site

raw / required

The site the power panel is located in

tags

list / elements=raw

added in 3.6.0 of netbox.netbox

The tags to add/update

netbox_token

string / required

The NetBox API token.

netbox_url

string / required

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

list / elements=string

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

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

an object unique in their environment.

state

string

The state of the object.

Choices:

  • present ← (default)

  • absent

validate_certs

raw

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

Default: “yes”

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create power panel within NetBox with only required information
      netbox_power_panel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Panel
          site: Test Site
        state: present

    - name: Update power panel with other fields - Pre 2.11
      netbox_power_panel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Panel
          site: Test Site
          rack_group: Test Rack Group
        state: present

    - name: Create power panel within NetBox with only required information - Post 2.11
      netbox_power_panel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Panel
          site: Test Site
          location: Test Location
        state: present

    - name: Delete power panel within netbox
      netbox_power_panel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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 NetBox

Returned: success (when state=present)

Authors

  • Tobias Groß (@toerb)