networktocode.nautobot.device_bay module – Create, update or delete device bays within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 4.1.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.device_bay.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates, updates or removes device bays from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

api_version

string

added in 4.1.0 of networktocode.nautobot

API Version Nautobot REST API

description

string

added in 3.0.0 of networktocode.nautobot

The description of the device bay. This is supported on v2.6+ of Nautobot

device

any

added in 3.0.0 of networktocode.nautobot

The device the device bay will be associated to. The device type must be “parent”.

installed_device

any

added in 3.0.0 of networktocode.nautobot

The ddevice that will be installed into the bay. The device type must be “child”.

name

string / required

added in 3.0.0 of networktocode.nautobot

The name of the device bay

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.

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

tags

list / elements=any

added in 3.0.0 of networktocode.nautobot

Any tags that the device bay may need to be associated with

token

string / required

The token created within Nautobot to authorize API access

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

any

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

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 Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create device bay within Nautobot with only required information
      networktocode.nautobot.device_bay:
        url: http://nautobot.local
        token: thisIsMyToken
        device: Test Nexus One
        name: "Device Bay One"
        state: present

    - name: Add device into device bay
      networktocode.nautobot.device_bay:
        url: http://nautobot.local
        token: thisIsMyToken
        device: Test Nexus One
        name: "Device Bay One"
        description: "First child"
        installed_device: Test Nexus Child One
        state: absent

    - name: Delete device bay within nautobot
      networktocode.nautobot.device_bay:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Device Bay One
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

device_bay

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Mikhail Yohman (@FragmentedPacket)