cisco.dnac.integration_settings_instances_itsm_v1 模块 – 用于集成设置实例 Itsm V1 的资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块,有关详细信息,请参阅 要求

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理资源集成设置实例 Itsm V1 的创建、更新和删除操作。

  • 创建 ITSM 集成设置。

  • 删除 ITSM 集成设置。

  • 更新 ITSM 集成设置。

注意

此模块具有相应的 操作插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

data

字典

集成设置实例 Itsm 的数据。

ConnectionSettings

字典

集成设置实例 Itsm 的 ConnectionSettings。

Auth_Password

字符串

身份验证密码。

Auth_UserName

字符串

身份验证用户名。

Url

字符串

Url。

description

字符串

设置实例的描述。

dnac_debug

布尔值

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

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

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

dnac_port

整数

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

字符串

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

默认值: "admin"

dnac_verify

布尔值

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

选项

  • false

  • true ← (默认)

dnac_version

字符串

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

默认值: "2.3.7.6"

dypName

字符串

它可以是 ServiceNowConnection。

instanceId

字符串

InstanceId 路径参数。集成设置实例的实例 ID。

name

字符串

设置实例的名称。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 启用针对 JSON 模式验证请求正文的标志。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 itsm_integration.ItsmIntegration.create_itsm_integration_setting_v1、itsm_integration.ItsmIntegration.delete_itsm_integration_setting_v1、itsm_integration.ItsmIntegration.update_itsm_integration_setting_v1,

  • 使用的路径是 post /dna/intent/api/v1/integration-settings/instances/itsm、delete /dna/intent/api/v1/integration-settings/instances/itsm/{instanceId}、put /dna/intent/api/v1/integration-settings/instances/itsm/{instanceId},

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解 ITSM 集成 CreateITSMIntegrationSettingV1

CreateITSMIntegrationSettingV1 API 的完整参考。

Cisco DNA Center 文档,了解 ITSM 集成 DeleteITSMIntegrationSettingV1

DeleteITSMIntegrationSettingV1 API 的完整参考。

Cisco DNA Center 文档,了解 ITSM 集成 UpdateITSMIntegrationSettingV1

UpdateITSMIntegrationSettingV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.integration_settings_instances_itsm_v1:
    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}}"
    state: present
    data:
      ConnectionSettings:
        Auth_Password: string
        Auth_UserName: string
        Url: string
    description: string
    dypName: string
    name: string

- name: Update by id
  cisco.dnac.integration_settings_instances_itsm_v1:
    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}}"
    state: present
    data:
      ConnectionSettings:
        Auth_Password: string
        Auth_UserName: string
        Url: string
    description: string
    dypName: string
    instanceId: string
    name: string

- name: Delete by id
  cisco.dnac.integration_settings_instances_itsm_v1:
    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}}"
    state: absent
    instanceId: string

返回值

通用返回值记录在此处,以下是此模块特有的字段

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回值: 始终

示例: {"createdBy": "string", "createdDate": 0, "data": {"ConnectionSettings": {"Auth_Password": "string", "Auth_UserName": "string", "Url": "string"}}, "description": "string", "dypId": "string", "dypMajorVersion": 0, "dypName": "string", "id": "string", "name": "string", "schemaVersion": 0, "softwareVersionLog": [{}], "tenantId": "string", "uniqueKey": "string", "updatedBy": "string"}

作者

  • Rafael Campos (@racampos)