cisco.ise.backup_schedule_config_update 模块 – 用于备份计划配置更新的资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

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

cisco.ise 2.0.0 中的新增功能

概要

• 管理资源备份计划配置更新的操作。

• 根据输入参数更新ISE节点上配置备份的计划。此API仅用于编辑计划。

注意

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

要求

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
backupDescription 字符串	备份的描述。
backupEncryptionKey 字符串	备份文件的加密密钥。加密密钥必须满足以下条件：包含至少一个大写字母 A-Z，包含至少一个小写字母 a-z，包含至少一个数字 0-9，仅包含 A-Za-z0-9_#，至少有 8 个字符，最多有 15 个字符，不能包含 ‘CcIiSsCco’，不能以开头。
backupName 字符串	备份文件将以此名称保存。
endDate 字符串	计划备份作业的结束日期。允许的格式 MM/DD/YYYY。如果频率为 ONE_TIME，则不需要结束日期。
frequency 字符串	备份计划配置更新的频率。
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 Gateway发送请求的标志。 如果为true，则使用ISE的API Gateway并将请求发送到 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 ← (默认)
monthDay 字符串	当计划频率为MONTHLY时，您希望执行备份的月份日期。允许的值 - 从1到28。
repositoryName 字符串	生成的备份文件将被复制到的已配置存储库的名称。
startDate 字符串	计划备份作业的开始日期。允许的格式 MM/DD/YYYY。
status 字符串	备份计划配置更新的状态。
time 字符串	计划备份作业的时间。例如-12 00 AM。
weekDay 字符串	备份计划配置更新的weekDay。

注释

注意

• 使用的SDK方法是 backup_and_restore.BackupAndRestore.update_scheduled_config_backup，

• 使用的路径是 put /api/v1/backup-restore/config/schedule-config-backup，

• 不支持 check_mode

• 此插件运行在控制节点上，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 的嵌入式连接管理器。

• 以 `ise_` 开头的参数由 Cisco ISE Python SDK 用于建立连接。

参见

另见

Cisco ISE 备份和还原文档。

备份和还原 API 的完整参考。

示例

- name: Update all
  cisco.ise.backup_schedule_config_update:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    backupDescription: string
    backupEncryptionKey: string
    backupName: string
    endDate: string
    frequency: string
    monthDay: string
    repositoryName: string
    startDate: string
    status: string
    time: string
    weekDay: string

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段：

键	描述
ise_response 字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终返回 示例： {"response": {"link": {"href": "string", "rel": "string", "type": "string"}, "message": "string"}, "version": "string"}

作者

• Rafael Campos (@racampos)

资源链接

• 问题追踪
• 代码仓库