netbox.netbox.netbox_rack module – Create, update or delete racks within NetBox

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in netbox.netbox 0.1.0

Synopsis

  • Creates, updates or removes racks from NetBox

Requirements

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

  • pynetbox

Parameters

Parameter

Comments

cert

Certificate path

data

Defines the rack configuration

asset_tag

Asset tag that is associated to the rack

comments

Comments that may include additional information in regards to the rack

custom_fields

must exist in NetBox

desc_units

Description of the rack

facility_id

The unique rack ID assigned by the facility

The location the rack will be associated to (NetBox 2.11+)

Maximum load capacity of the rack

The mounting depth of the rack

name

The name of the rack

outer_depth

The outer depth of the rack

outer_unit

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

:ansible-option-choices:`Choices:`

outer_width

The outer width of the rack

rack_group

The rack group the rack will be associated to (NetBox < 2.11)

Will be removed in version 5.0.0

rack_role

The rack role the rack will be associated to

serial

Serial number of the rack

site

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

status

The status of the rack

tags

Any tags that the rack may need to be associated with

tenant

The tenant that the device will be assigned to

type

u_height

The height of the rack in rack units

The weight of the rack

width

netbox_token

The NetBox API token.

netbox_url

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

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

validate_certs

If no, SSL certificates will not be validated.

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

:ansible-option-default-bold:`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 NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create rack within NetBox with only required information
      netbox.netbox.netbox_rack:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test rack
          site: Test Site
        state: present

    - name: Create rack within NetBox with only required information - Pre 2.11
      netbox.netbox.netbox_rack:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test rack
          site: Test Site
          rack_group: Test Rack Group
        state: present

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

    - name: Delete rack within netbox
      netbox.netbox.netbox_rack:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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

Message indicating failure or info about what has been achieved

:ansible-option-returned-bold:`Returned:` always

rack

Serialized object as created or already existent within NetBox

:ansible-option-returned-bold:`Returned:` success (when state=present)

Authors

  • Mikhail Yohman (@FragmentedPacket)