cisco.catalystcenter.network_device_functional_capability_info module -- Information module for Network Device Functional Capability Info

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.network_device_functional_capability_info.

New in cisco.catalystcenter 3.1.0

Synopsis

• This module represents an alias of the module network_device_functional_capability_v1_info

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
deviceId string	DeviceId query parameter. 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.
functionName list / elements=string	FunctionName query parameter.
headers dictionary	Additional headers.
id string	Id path parameter. Functional Capability UUID.
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are devices.Devices.get_functional_capability_by_id_v1, devices.Devices.get_functional_capability_for_devices_v1,

• Paths used are get /dna/intent/api/v1/network-device/functional-capability, get /dna/intent/api/v1/network-device/functional-capability/{id},

• It should be noted that this module is an alias of network_device_functional_capability_v1_info

• Supports check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Devices GetFunctionalCapabilityByIdV1

Complete reference of the GetFunctionalCapabilityByIdV1 API.

Cisco DNA Center documentation for Devices GetFunctionalCapabilityForDevicesV1

Complete reference of the GetFunctionalCapabilityForDevicesV1 API.

Examples

- name: Get all Network Device Functional Capability Info
  cisco.catalystcenter.network_device_functional_capability_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    headers: "{{my_headers | from_json}}"
    deviceId: string
    functionName: []
  register: result
- name: Get Network Device Functional Capability Info by id
  cisco.catalystcenter.network_device_functional_capability_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

Return Values

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

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"attributeInfo": {}, "functionDetails": [{"attributeInfo": {}, "id": "string", "propertyName": "string", "stringValue": "string"}], "functionName": "string", "functionOpState": "string", "id": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)