cisco.mso.mso_backup_schedule 模块 – 管理备份计划

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.mso.mso_backup_schedule。

概要 

管理 Cisco ACI 多站点上的备份计划。

要求 

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

多站点协调器 v2.1 或更高版本

参数 

参数	注释
frequency_length 整数	计划触发频率的小时数或天数
frequency_unit 字符串	间隔单位类型选项 `"hours"` `"days"`
host 别名：hostname 字符串	ACI 多站点协调器主机的 IP 地址或主机名。如果任务中未指定此值，则将使用环境变量 `MSO_HOST` 的值。
login_domain 字符串	用于身份验证的登录域名。默认值为 Local。如果任务中未指定此值，则将使用环境变量 `MSO_LOGIN_DOMAIN` 的值。使用 HTTPAPI 连接插件时，如果未指定此属性，则将使用清单变量 `ansible_httpapi_login_domain`。
output_level 字符串	影响此 MSO 模块的输出。 `normal` 表示标准输出，包括 `current` 字典 `info` 添加信息输出，包括 `previous`、`proposed` 和 `sent` 字典 `debug` 添加调试输出，包括 `filter_string`、`method`、`response`、`status` 和 `url` 信息如果任务中未指定此值，则将使用环境变量 `MSO_OUTPUT_LEVEL` 的值。选项 `"debug"` `"info"` `"normal"` ← (默认)
password 字符串	用于身份验证的密码。如果任务中未指定此值，则将使用环境变量 `MSO_PASSWORD` 或 `ANSIBLE_NET_PASSWORD` 的值。
port 整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果任务中未指定此值，则将使用环境变量 `MSO_PORT` 的值。
remote_location 字符串	应将备份存储到的远程位置的名称
remote_path 字符串	此路径相对于远程位置。远程位置文件夹和此路径之间会自动添加“/”。此文件夹结构应该已经存在于远程位置。
start_date 字符串	以 YYYY-MM-DD 格式启动调度的日期如果没有提供日期，则将使用当前日期。
start_time 字符串	以 HH:MM:SS 格式启动调度的日期如果没有提供时间，则将使用午夜“00:00:00”。
state 字符串	使用 `present` 或 `absent` 添加或删除。使用 `query` 列出对象或多个对象。选项 `"absent"` `"present"` ← (默认) `"query"`
timeout 整数	以秒为单位的套接字级别超时。默认值为 30 秒。如果任务中未指定此值，则将使用环境变量 `MSO_TIMEOUT` 的值。
use_proxy 布尔值	如果为 `false`，即使在目标主机上已在环境变量中定义了代理，它也不会使用代理。如果任务中未指定值，则将改用环境变量`MSO_USE_PROXY`的值。默认值为`true`。选项 `false` `true`
use_ssl 布尔值	如果为`false`，则将使用 HTTP 连接而不是默认的 HTTPS 连接。如果任务中未指定值，则将改用环境变量`MSO_USE_SSL`的值。当使用 HTTPAPI 连接插件时，如果未指定此属性，则将使用清单变量`ansible_httpapi_use_ssl`。使用 HTTPAPI 连接插件 (mso 或 nd) 时，默认值为`false`；使用传统连接方法 (仅限于 mso) 时，默认值为`true`。选项 `false` `true`
username 字符串	用于身份验证的用户名。如果任务中未指定值，则将改用环境变量`MSO_USERNAME`或`ANSIBLE_NET_USERNAME`的值。
validate_certs 布尔值	如果为`false`，则不会验证 SSL 证书。仅当在使用自签名证书的个人控制站点上使用时，才应将其设置为`false`。如果任务中未指定值，则将改用环境变量`MSO_VALIDATE_CERTS`的值。默认值为`true`。选项 `false` `true`

备注 

注意

此模块编写用于支持 Multi Site Orchestrator v2.1 或更高版本。某些或所有功能可能在早期版本中不起作用。

示例 

- name: Get current backup schedule
  cisco.mso.mso_backup_schedule:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  register: query_result

- name: Set backup schedule
  cisco.mso.mso_backup_schedule:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    frequency_unit: hours
    frequency_length: 7
    remote_location: ansible_test
    state: present

- name: Set backup schedule with date and time
  cisco.mso.mso_backup_schedule:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    frequency_unit: days
    frequency_length: 1
    remote_location: ansible_test
    remote_path: test
    start_time: 20:57:36
    start_date: 2023-04-09
    state: present

- name: Delete backup schedule
  cisco.mso.mso_backup_schedule:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: absent

作者

Akini Ross (@akinross)