cisco.dnac.network_device_functional_capability – Manage NetworkDeviceFunctionalCapability 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_functional_capability.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Returns the functional-capability for given devices.

  • Returns functional capability with given Id.

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
device_id
string / required
Accepts comma separated deviceid's and return list of functional-capabilities for the given id's. If invalid or not-found id's are provided, null entry will be returned in the list.
function_name
string
FunctionName query parameter.
id
string / required
Functional Capability UUID.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.network_device_functional_capability

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

NetworkDeviceFunctionalCapability reference

Complete reference of the NetworkDeviceFunctionalCapability object model.

NetworkDeviceFunctionalCapability reference

SDK reference.

Examples

- name: get_functional_capability_for_devices
  cisco.dnac.network_device_functional_capability:
    state: query  # required
    device_id: SomeValue  # string, required
    function_name: SomeValue  # string
  register: nm_get_functional_capability_for_devices

- name: get_functional_capability_by_id
  cisco.dnac.network_device_functional_capability:
    state: query  # required
    id: SomeValue  # string, required
  register: nm_get_functional_capability_by_id

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_functional_capability_by_id


Authors

  • Rafael Campos (@racampos)