module_bay

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis

• Creates, updates or removes module bays from Nautobot

Requirements

The following Python packages are needed on the host that executes this module:

• pynautobot

Parameters

Parameter	Data Type	Environment Variable	Comments
api_version	str		API Version Nautobot REST API Version Added: 4.1.0
custom_fields	dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
description	str		The description of the module bay
label	str		The label of the module bay
name required	str		The name of the module bay
parent_device	raw		The parent device of the module bay
parent_module	raw		The parent module of the module bay
position	str		The position of the module bay within the device or module
query_params	list		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. Version Added: 3.0.0
state	str		Use C(present) or C(absent) for adding or removing.
tags	list		Any tags that this item may need to be associated with Version Added: 3.0.0
token required	str		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url required	str		The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs	raw		If C(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 E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.

Notes

Note

• Tags should be defined as a YAML list
• This should be ran with connection C(local) and hosts C(localhost)

Examples

- name: Create a module bay inside a device
  networktocode.nautobot.module_bay:
    url: http://nautobot.local
    token: thisIsMyToken
    parent_device: test100
    name: Watch Bay
    label: watchbay
    position: "42"
    description: The bay of watches
    state: present

- name: Create a module bay inside a module
  networktocode.nautobot.module_bay:
    url: http://nautobot.local
    token: thisIsMyToken
    parent_module:
      module_type: HooverMaxProModel60
      parent_module_bay: "{{ some_module_bay['key'] }}"
    name: Fixing Good
    label: FiXiNgGoOd
    position: "321"
    description: Good Fixing is better than Bad Breaking
    state: present

- name: Delete a module bay
  networktocode.nautobot.module_bay:
    url: http://nautobot.local
    token: thisIsMyToken
    parent_device: test100
    name: Watch Bay
    state: absent

Return Values

Key	Data Type	Description	Returned
module_bay	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))
msg	str	Message indicating failure or info about what has been achieved	always

Authors

• Travis Smith (@tsm1th)