netbox_rack_module.rst

orphan:

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

Note

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

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_rack_module_requirements>` for details.

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

.. rst-class:: ansible-version-added

New in netbox.netbox 0.1.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Creates, updates or removes racks from NetBox

Requirements

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

• pynetbox

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title cert .. rst-class:: ansible-option-type-line any	Certificate path
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary / required	Defines the rack configuration
.. rst-class:: ansible-option-title asset_tag .. rst-class:: ansible-option-type-line string	Asset tag that is associated to the rack
.. rst-class:: ansible-option-title comments .. rst-class:: ansible-option-type-line string	Comments that may include additional information in regards to the rack
.. rst-class:: ansible-option-title custom_fields .. rst-class:: ansible-option-type-line dictionary	must exist in NetBox
.. rst-class:: ansible-option-title desc_units .. rst-class:: ansible-option-type-line boolean	Rack units will be numbered top-to-bottom .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string added in netbox.netbox 3.10.0	Description of the rack
.. rst-class:: ansible-option-title facility_id .. rst-class:: ansible-option-type-line string	The unique rack ID assigned by the facility
.. rst-class:: ansible-option-title location .. rst-class:: ansible-option-type-line any added in netbox.netbox 3.1.0	The location the rack will be associated to (NetBox 2.11+)
.. rst-class:: ansible-option-title max_weight .. rst-class:: ansible-option-type-line integer added in netbox.netbox 3.10.0	Maximum load capacity of the rack
.. rst-class:: ansible-option-title mounting_depth .. rst-class:: ansible-option-type-line integer added in netbox.netbox 3.10.0	The mounting depth of the rack
.. rst-class:: ansible-option-title name .. rst-class:: ansible-option-type-line string / required	The name of the rack
.. rst-class:: ansible-option-title outer_depth .. rst-class:: ansible-option-type-line integer	The outer depth of the rack
.. rst-class:: ansible-option-title outer_unit .. rst-class:: ansible-option-type-line string	Whether the rack unit is in Millimeters or Inches and is required if outer_width/outer_depth is specified .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"Millimeters"` :ansible-option-choices-entry:`"Inches"`
.. rst-class:: ansible-option-title outer_width .. rst-class:: ansible-option-type-line integer	The outer width of the rack
.. rst-class:: ansible-option-title rack_group .. rst-class:: ansible-option-type-line any	The rack group the rack will be associated to (NetBox < 2.11) Will be removed in version 5.0.0
.. rst-class:: ansible-option-title rack_role .. rst-class:: ansible-option-type-line any	The rack role the rack will be associated to
.. rst-class:: ansible-option-title serial .. rst-class:: ansible-option-type-line string	Serial number of the rack
.. rst-class:: ansible-option-title site .. rst-class:: ansible-option-type-line any	Required if state=present and the rack does not exist yet
.. rst-class:: ansible-option-title status .. rst-class:: ansible-option-type-line any	The status of the rack
.. rst-class:: ansible-option-title tags .. rst-class:: ansible-option-type-line list / elements=any	Any tags that the rack may need to be associated with
.. rst-class:: ansible-option-title tenant .. rst-class:: ansible-option-type-line any	The tenant that the device will be assigned to
.. rst-class:: ansible-option-title type .. rst-class:: ansible-option-type-line string	The type of rack .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"2-post frame"` :ansible-option-choices-entry:`"4-post frame"` :ansible-option-choices-entry:`"4-post cabinet"` :ansible-option-choices-entry:`"Wall-mounted frame"` :ansible-option-choices-entry:`"Wall-mounted cabinet"`
.. rst-class:: ansible-option-title u_height .. rst-class:: ansible-option-type-line integer	The height of the rack in rack units
.. rst-class:: ansible-option-title weight .. rst-class:: ansible-option-type-line float added in netbox.netbox 3.10.0	The weight of the rack
.. rst-class:: ansible-option-title weight_unit .. rst-class:: ansible-option-type-line string added in netbox.netbox 3.10.0	The weight unit .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"kg"` :ansible-option-choices-entry:`"g"` :ansible-option-choices-entry:`"lb"` :ansible-option-choices-entry:`"oz"`
.. rst-class:: ansible-option-title width .. rst-class:: ansible-option-type-line integer	The rail-to-rail width .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`10` :ansible-option-choices-entry:`19` :ansible-option-choices-entry:`21` :ansible-option-choices-entry:`23`
.. rst-class:: ansible-option-title netbox_token .. rst-class:: ansible-option-type-line string / required	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. rst-class:: ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. rst-class:: ansible-option-type-line 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.
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	The state of the object. .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line 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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table

Key	Description
.. rst-class:: ansible-option-title msg .. rst-class:: ansible-option-type-line string	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always
.. rst-class:: ansible-option-title rack .. rst-class:: ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line Returned: success (when state=present)

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links

Issue Tracker Repository (Sources)