/ home / cisco / cisco.dnac / 2.0.7 / module / network_device_module

cisco.dnac.network_device_module (2.0.7) — module

Manage NetworkDeviceModule objects of Devices

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Returns modules by specified device id.

Returns Module info by id.

Returns Module Count.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Inputs

    
id:
    description:
    - Id path parameter.
    required: true
    type: str

count:
    description:
    - If true gets the number of objects.
    required: true
    type: bool

limit:
    description:
    - Limit query parameter.
    type: str

offset:
    description:
    - Offset query parameter.
    type: str

device_id:
    description:
    - DeviceId query parameter.
    required: true
    type: str

name_list:
    description:
    - NameList query parameter.
    type: str

part_number_list:
    description:
    - PartNumberList query parameter.
    type: str

vendor_equipment_type_list:
    description:
    - VendorEquipmentTypeList query parameter.
    type: str

operational_state_code_list:
    description:
    - OperationalStateCodeList query parameter.
    type: str

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: devices.get_module_count
  type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also