networktocode.nautobot.rack module – Create, update or delete racks within Nautobot

Note

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

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 networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.rack.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates, updates or removes racks from Nautobot.

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

asset_tag

string

added in 3.0.0 of networktocode.nautobot

Asset tag that is associated to the rack.

comments

string

added in 3.0.0 of networktocode.nautobot

Comments that may include additional information in regards to the rack.

custom_fields

dictionary

added in 3.0.0 of networktocode.nautobot

Must exist in Nautobot.

desc_units

boolean

added in 3.0.0 of networktocode.nautobot

Rack units will be numbered top-to-bottom.

Choices:

  • no

  • yes

facility_id

string

added in 3.0.0 of networktocode.nautobot

The unique rack ID assigned by the facility.

name

string / required

added in 3.0.0 of networktocode.nautobot

The name of the rack.

outer_depth

integer

added in 3.0.0 of networktocode.nautobot

The outer depth of the rack.

outer_unit

string

added in 3.0.0 of networktocode.nautobot

Whether the rack unit is in Millimeters or Inches and is required if outer_width/outer_depth is specified.

Choices:

  • Millimeters

  • Inches

outer_width

integer

added in 3.0.0 of networktocode.nautobot

The outer width of the rack.

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

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

raw

added in 3.0.0 of networktocode.nautobot

The rack group the rack will be associated to.

rack_role

raw

added in 3.0.0 of networktocode.nautobot

The rack role the rack will be associated to.

serial

string

added in 3.0.0 of networktocode.nautobot

Serial number of the rack.

site

raw

added in 3.0.0 of networktocode.nautobot

Required if state=present and the rack does not exist yet.

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

status

raw

added in 3.0.0 of networktocode.nautobot

The status of the rack

Required if state=present and does not exist yet.

tags

list / elements=raw

added in 3.0.0 of networktocode.nautobot

Any tags that the rack may need to be associated with.

tenant

raw

added in 3.0.0 of networktocode.nautobot

The tenant that the device will be assigned to.

token

string / required

The token created within Nautobot to authorize API access.

type

string

added in 3.0.0 of networktocode.nautobot

The type of rack.

Choices:

  • 2-post frame

  • 4-post frame

  • 4-post cabinet

  • Wall-mounted frame

  • Wall-mounted cabinet

u_height

integer

added in 3.0.0 of networktocode.nautobot

The height of the rack in rack units.

url

string / required

URL of the Nautobot instance resolvable by Ansible control host.

validate_certs

raw

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

width

integer

added in 3.0.0 of networktocode.nautobot

The rail-to-rail width.

Choices:

  • 10

  • 19

  • 21

  • 23

Notes

Note

  • Tags should be defined as a YAML list.

  • This should be ran with connection local and hosts localhost.

  • The module supports check_mode.

Examples

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

  tasks:
    - name: Create rack within Nautobot with only required information
      networktocode.nautobot.rack:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test rack
        site: Test Site
        status: active
        state: present

    - name: Delete rack within nautobot
      networktocode.nautobot.rack:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Rack
        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

rack

dictionary

Serialized object as created or already existent within Nautobot.

Returned: success (when state=present)

Authors

  • NMikhail Yohman (@FragmentedPacket)