cisco.ise.backup_schedule_config 模块 – 备份计划配置的资源模块

注意

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

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

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

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

cisco.ise 1.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 网关发送请求的标志。 如果为 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 是否向 ISE 的 ERS API 发送 CSRF 令牌的标志。 如果为 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.create_scheduled_config_backup,

• 使用的路径是 post /api/v1/backup-restore/config/schedule-config-backup,

• 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco ISE 备份和恢复文档

备份和恢复 API 的完整参考。

示例

- name: Create
  cisco.ise.backup_schedule_config:
    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)

集合链接

• 问题跟踪器
• 存储库（源代码）