networktocode.nautobot.rack module – Create, update or delete racks 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.rack.

New in networktocode.nautobot 1.0.0

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

api_version

string

added in networktocode.nautobot 4.1.0

API Version Nautobot REST API

asset_tag

string

added in networktocode.nautobot 3.0.0

Asset tag that is associated to the rack.

comments

string

added in networktocode.nautobot 3.0.0

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

custom_fields

dictionary

added in networktocode.nautobot 3.0.0

Must exist in Nautobot and in key/value format

desc_units

boolean

added in networktocode.nautobot 3.0.0

Rack units will be numbered top-to-bottom.

Choices:

facility_id

string

added in networktocode.nautobot 3.0.0

The unique rack ID assigned by the facility.

location

any

added in networktocode.nautobot 3.0.0

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

name

string / required

added in networktocode.nautobot 3.0.0

The name of the rack.

outer_depth

integer

added in networktocode.nautobot 3.0.0

The outer depth of the rack.

outer_unit

string

added in networktocode.nautobot 3.0.0

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

Choices:

outer_width

integer

added in networktocode.nautobot 3.0.0

The outer width of the rack.

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 rack will be associated to.

role

any

added in networktocode.nautobot 3.0.0

The rack role the rack will be associated to.

serial

string

added in networktocode.nautobot 3.0.0

Serial number of the rack.

state

string

Use present or absent for adding or removing.

Choices:

status

any

added in networktocode.nautobot 3.0.0

The status of the rack

Required if state=present and does not exist yet.

tags

list / elements=any

added in networktocode.nautobot 3.0.0

Any tags that this item may need to be associated with

tenant

any

added in networktocode.nautobot 3.0.0

The tenant that the device will be assigned to.

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

The type of rack.

u_height

integer

added in networktocode.nautobot 3.0.0

The height of the rack in rack units.

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`

width

integer

added in networktocode.nautobot 3.0.0

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
        location:
          name: My Location
          parent: Parent Location
        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)