cisco.dnac.itsm_cmdb_sync_status_info 模块 – 用于 Itsm Cmdb 同步状态信息的 Information 模块

注意

此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,请参阅 要求了解详细信息。

要在 playbook 中使用它,请指定: cisco.dnac.itsm_cmdb_sync_status_info

cisco.dnac 3.1.0 中的新功能

概要

  • 此模块表示模块 itsm_cmdb_sync_status_v1_info 的别名

注意

此模块有一个对应的 action 插件

要求

执行此模块的主机需要满足以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

date

string

日期查询参数。以 “YYYY-MM-DD” 格式提供日期。

dnac_debug

boolean

Cisco DNA Center SDK 用于启用调试的标志。

选项

  • false ← (默认)

  • true

dnac_host

string / 必填

Cisco DNA Center 主机名。

dnac_password

string

用于身份验证的 Cisco DNA Center 密码。

dnac_port

integer

Cisco DNA Center 端口。

默认: 443

dnac_username

别名:user

string

用于身份验证的 Cisco DNA Center 用户名。

默认: "admin"

dnac_verify

boolean

用于启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

dnac_version

string

通知 SDK 要使用哪个版本的 Cisco DNA Center。

默认: "2.3.7.6"

headers

dictionary

其他标头。

status

string

状态查询参数。支持的值为“Success”、“Failed”和“Unknown”。提供其他值将导致所有可用的同步作业状态。

validate_response_schema

boolean

Cisco DNA Center SDK 用于启用针对 JSON 架构验证请求体的标志。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 itsm.Itsm.get_cmdb_sync_status_v1,

  • 使用的路径是 get /dna/intent/api/v1/cmdb-sync/detail,

  • 应该注意的是,此模块是 itsm_cmdb_sync_status_v1_info 的别名

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

有关 ITSM GetCMDBSyncStatusV1 的 Cisco DNA Center 文档

GetCMDBSyncStatusV1 API 的完整参考。

示例

- name: Get all Itsm Cmdb Sync Status Info
  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

返回值

常见的返回值记录在 这里,以下是此模块独有的字段

描述

dnac_response

list / elements=dictionary

带有 Cisco DNAC Python SDK 返回的响应的字典或列表

已返回: 始终

示例: "[\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"

作者

  • Rafael Campos (@racampos)