/ home / cisco / cisco.dnac / 6.13.3 / module / itsm_cmdb_sync_status_info

cisco.dnac.itsm_cmdb_sync_status_info (6.13.3) — module

Information module for Itsm Cmdb Sync Status

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

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.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

    
date:
    description:
    - Date query parameter. Provide date in "YYYY-MM-DD" format.
    type: str

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

      '
    type: str

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  elements: dict
  returned: always
  sample: "[\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"
  type: list