cisco.dnac.network_device_module – Manage NetworkDeviceModule objects of Devices

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.network_device_module.

New in version 1.0.0: of cisco.dnac

Synopsis

• Returns modules by specified device id.

• Returns Module info by id.

• Returns Module Count.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
count boolean / required	Choices: no yes	If true gets the number of objects.
device_id string / required		DeviceId query parameter.
id string / required		Id path parameter.
limit string		Limit query parameter.
name_list string		NameList query parameter.
offset string		Offset query parameter.
operational_state_code_list string		OperationalStateCodeList query parameter.
part_number_list string		PartNumberList query parameter.
vendor_equipment_type_list string		VendorEquipmentTypeList query parameter.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.network_device_module

The official documentation on the cisco.dnac.plugins.module_utils.definitions.network_device_module module.

NetworkDeviceModule reference

Complete reference of the NetworkDeviceModule object model.

NetworkDeviceModule reference

SDK reference.

Examples

- name: get_modules
  cisco.dnac.network_device_module:
    state: query  # required
    device_id: SomeValue  # string, required
    limit: SomeValue  # string
    name_list: SomeValue  # string
    offset: SomeValue  # string
    operational_state_code_list: SomeValue  # string
    part_number_list: SomeValue  # string
    vendor_equipment_type_list: SomeValue  # string
  register: nm_get_modules

- name: get_module_info_by_id
  cisco.dnac.network_device_module:
    state: query  # required
    id: SomeValue  # string, required
  register: nm_get_module_info_by_id

- name: get_module_count
  cisco.dnac.network_device_module:
    state: query  # required
    device_id: SomeValue  # string, required
    count: True  # boolean, required
    name_list: SomeValue  # string
    operational_state_code_list: SomeValue  # string
    part_number_list: SomeValue  # string
    vendor_equipment_type_list: SomeValue  # string
  register: nm_get_module_count

Return Values

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

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: devices.get_module_count

Authors

• Rafael Campos (@racampos)