module¶

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 modules from Nautobot

Requirements¶

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

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
asset_tag str		The asset tag of the module
contacts dict		Associate contacts Version Added: 6.3.0
contacts.objects		List of contacts to associate.
contacts.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
id str		The UUID of the object to operate on Version Added: 5.13.0
location raw		The location of the module Requires one of I(location) or I(parent_module_bay) when I(state=present) and the module does not exist yet
module_type raw		The module type of the module Required if I(state=present) and the module does not exist yet
notes dict		Manage notes on the object Version Added: 6.3.0
notes.objects		List of notes to manage.
notes.state	Default: merge Choices: merge, replace, delete	C(merge) adds notes without removing existing ones. C(replace) enforces exactly the listed notes, removing any extras. C(delete) removes the listed notes.
parent_module_bay raw		The parent module bay of the module Requires one of I(location) or I(parent_module_bay) when I(state=present) and the module does not exist yet
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
role raw		The role of the module
serial str		The serial number of the module
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
status raw		The status of the module Required if I(state=present) and the device does not exist yet
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
teams dict		Associate teams Version Added: 6.3.0
teams.objects		List of teams to associate.
teams.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
tenant raw		The tenant of the module
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 in module bay
  networktocode.nautobot.module:
    url: http://nautobot.local
    token: thisIsMyToken
    module_type: HooverMaxProModel60
    parent_module_bay:
      name: PowerStripTwo
      parent_device: test100
    status: Active
    state: present

- name: Create a module at location
  networktocode.nautobot.module:
    url: http://nautobot.local
    token: thisIsMyToken
    module_type: HooverMaxProModel60
    location:
      name: "Child Test Location"
      parent: "Parent Test Location"
    serial: "654321"
    asset_tag: "123456"
    role: Test Module Role
    status: Active
    tenant: Test Tenant
    state: present

- name: Delete a module
  networktocode.nautobot.module:
    url: http://nautobot.local
    token: thisIsMyToken
    module_type: HooverMaxProModel60
    parent_module_bay:
      name: PowerStripTwo
      parent_device: test100
    state: absent

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

Return Values¶

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