cisco.dnac.icap_settings_device_deployments_v1_info module – Information module for Icap Settings Device Deployments V1
Note
This module is part of the cisco.dnac collection (version 6.27.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.dnac
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.icap_settings_device_deployments_v1_info
.
New in cisco.dnac 6.17.0
Synopsis
Get all Icap Settings Device Deployments V1.
Retrieves ICAP configuration deployment statuss per device based on filter criteria. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-ICAP_APIs-1.0.0-resolved.yaml.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
DeployActivityId query parameter. Activity from the /deploy task response. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
Limit query parameter. The number of records to show for this page. |
|
NetworkDeviceIds query parameter. Device ids, retrievable from the id attribute in intent/api/v1/network-device. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
Order query parameter. Whether ascending or descending order should be used to sort the response. |
|
SortBy query parameter. A property within the response to sort by. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are sensors.Sensors.get_device_deployment_status_v1,
Paths used are get /dna/intent/api/v1/icapSettings/deviceDeployments,
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 DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Sensors GetDeviceDeploymentStatusV1
Complete reference of the GetDeviceDeploymentStatusV1 API.
Examples
- name: Get all Icap Settings Device Deployments V1
cisco.dnac.icap_settings_device_deployments_v1_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers: "{{my_headers | from_json}}"
deployActivityId: string
networkDeviceIds: string
offset: 0
limit: 0
sortBy: string
order: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |