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

Note

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

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

  • Get all Network Device Functional Capability.

  • Get Network Device Functional Capability by id.

  • Returns functional capability with given Id.

  • Returns the functional-capability for given devices.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_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:

Notes

Note

  • SDK Method used are devices.Devices.get_functional_capability_by_id, devices.Devices.get_functional_capability_for_devices,

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

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Devices GetFunctionalCapabilityById

Complete reference of the GetFunctionalCapabilityById API.

Cisco DNA Center documentation for Devices GetFunctionalCapabilityForDevices

Complete reference of the GetFunctionalCapabilityForDevices API.

Examples

---
- name: Get all Network Device Functional Capability
  cisco.catalystcenter.network_device_functional_capability_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    deviceId: string
    functionName: []
  register: result
- name: Get Network Device Functional Capability by
    id
  cisco.catalystcenter.network_device_functional_capability_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_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

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco CATALYST 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)