cisco.ise.stop_replication 模块 – 用于停止复制的资源模块

注意

此模块是 cisco.ise 集合（版本 2.9.6）的一部分。

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

要安装它，请使用： ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：cisco.ise.stop_replication。

cisco.ise 1.0.0 中的新增功能

概要 

管理资源“停止复制”的操作更新。
此 API 更新端点停止复制服务的状态。

注意

此模块有一个对应的操作插件。

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
ise_debug 布尔值	用于启用调试的 Identity Services Engine SDK 的标志。选项 `false` ←（默认） `true`
ise_hostname 字符串 / 必需	Identity Services Engine 主机名。
ise_password 字符串 / 必需	用于进行身份验证的 Identity Services Engine 密码。
ise_single_request_timeout 整数在 cisco.ise 3.0.0 中添加	RESTful HTTP 请求的超时时间（以秒为单位）。默认值： `60`
ise_username 字符串 / 必需	用于进行身份验证的 Identity Services Engine 用户名。
ise_uses_api_gateway 布尔值在 cisco.ise 1.1.0 中添加	一个标志，用于通知 SDK 是否使用 Identity Services Engine 的 API 网关发送请求。如果为 true，它将使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。如果为 false，它会将请求发送到 https://{{ise_hostname}}:{{port}}，其中端口值取决于使用的服务（ERS、Mnt、UI、PxGrid）。选项 `false` `true` ←（默认）
ise_uses_csrf_token 布尔值在 cisco.ise 3.0.0 中添加	一个标志，用于通知 SDK 是否将 CSRF 令牌发送到 ISE 的 ERS API。如果为 True，则 SDK 假定您的 ISE CSRF 检查已启用。如果为 True，则假定您需要 SDK 自动为您管理 CSRF 令牌。选项 `false` ←（默认） `true`
ise_verify 布尔值	用于启用或禁用 SSL 证书验证的标志。选项 `false` `true` ←（默认）
ise_version 字符串	通知 SDK 使用哪个版本的 Identity Services Engine。默认值： `"3.1_Patch_1"`
ise_wait_on_rate_limit 布尔值	用于启用自动速率限制处理的 Identity Services Engine SDK 的标志。选项 `false` `true` ←（默认）
isEnabled 布尔值	IsEnabled 标志。选项 `false` `true`

备注 

注意

使用的 SDK 方法是 endpoint_stop_replication_service.EndpointStopReplicationService.set_stop_replication_service。
使用的路径是 put /api/v1/stop-replication。
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco ISE SDK 中嵌入的连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Update all
  cisco.ise.stop_replication:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    isEnabled: true

返回值 

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

键	描述
ise_response 字典	一个字典或列表，包含 Cisco ISE Python SDK 返回的响应已返回：总是示例： `{"isEnabled": true}`
ise_update_response 字典在 cisco.ise 1.1.0 中添加	一个字典或列表，包含 Cisco ISE Python SDK 返回的响应已返回：总是示例： `{"success": {"message": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)