Skip to content

module_bay_template

Collection Note

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

ansible-galaxy collection install networktocode.nautobot
Added in version 5.4.0.

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

Synopsis

  • Creates, updates or removes module bay templates from Nautobot

Requirements

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

Parameters

Parameter Defaults / Choices 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 template
device_type
raw
The device type of the module bay template
Requires one of I(device_type) or I(module_type) when I(state=present) and the module bay template does not exist yet
id
str
The UUID of the object to operate on
Version Added: 5.13.0
label
str
The label of the module bay template
module_type
raw
The module type of the module bay template
Requires one of I(device_type) or I(module_type) when I(state=present) and the module bay template does not exist yet
name
str
The name of the module bay template
Required if I(state=present) and the module bay template does not exist yet
position
str
The position of the module bay within the device or module
query_params
list / elements=str
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
Default: present
Choices: absent, present
Use C(present) or C(absent) for adding or removing.
tags
list / elements=raw
Any tags that this item may need to be associated with
Version Added: 3.0.0
token
str
required
The token created within Nautobot to authorize API access
Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url
str
required
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
Default: True
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 template
  networktocode.nautobot.module_bay_template:
    url: http://nautobot.local
    token: thisIsMyToken
    module_type: HooverMaxProModel60
    name: Edward Galbraith
    label: Br Ba
    position: "1"
    description: Granite State
    state: present

- name: Delete a module bay template
  networktocode.nautobot.module_bay_template:
    url: http://nautobot.local
    token: thisIsMyToken
    module_type: HooverMaxProModel60
    name: Edward Galbraith
    state: absent

- name: Delete a module bay template by id
  networktocode.nautobot.module_bay_template:
    url: http://nautobot.local
    token: thisIsMyToken
    id: 00000000-0000-0000-0000-000000000000
    state: absent

Return Values

Key Data Type Description Returned
module_bay_template 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)