cisco.dnac.itsm_cmdb_sync_status_info module – Information module for Itsm Cmdb Sync Status
Note
This module is part of the cisco.dnac collection (version 6.20.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.itsm_cmdb_sync_status_info
.
New in cisco.dnac 3.1.0
Synopsis
Get all Itsm Cmdb Sync Status.
This API allows to retrieve the detail of CMDB sync status.It accepts two query parameter “status”,”date”.The supported values for status field are “Success”,”Failed”,”Unknown” and date field should be in “YYYY-MM-DD” format. By default all the cmdb sync status will be send as response and based on the query parameter filtered detail will be send as response.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Date query parameter. Provide date in “YYYY-MM-DD” format. |
|
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. |
|
Status query parameter. Supported values are “Success”,”Failed” and “Unknown”. Providing other values will result in all the available sync job status. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are itsm.Itsm.get_cmdb_sync_status,
Paths used are get /dna/intent/api/v1/cmdb-sync/detail,
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 ITSM GetCMDBSyncStatus
Complete reference of the GetCMDBSyncStatus API.
Examples
- name: Get all Itsm Cmdb Sync Status
cisco.dnac.itsm_cmdb_sync_status_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}}"
status: string
date: 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: |