cisco.catalystcenter.itsm_cmdb_sync_status_info module -- Information module for Itsm Cmdb Sync Status

Note

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

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.itsm_cmdb_sync_status_info.

New in cisco.catalystcenter 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.

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catc_api_port

integer

The Cisco Catalyst Center port.

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

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

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

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

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

date

string

Date query parameter. Provide date in "YYYY-MM-DD" format.

headers

dictionary

Additional headers.

status

string

Status query parameter. Supported values are "Success","Failed" and "Unknown". Providing other values will result in all the available sync job status.

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 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 uses the embedded connection manager from Cisco CATALYST SDK

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.catalystcenter.itsm_cmdb_sync_status_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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

dnac_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"successCount\\": \\"string\\",\\n \\"failureCount\\": \\"string\\",\\n \\"devices\\": [\\n {\\n \\"deviceId\\": \\"string\\",\\n \\"status\\": \\"string\\"\\n }\\n ],\\n \\"unknownErrorCount\\": \\"string\\",\\n \\"message\\": \\"string\\",\\n \\"syncTime\\": \\"string\\"\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)