cisco.mso.mso_backup 模块 – 管理备份

注意

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

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

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

要在剧本中使用它，请指定：cisco.mso.mso_backup。

概要

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

要求

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

• 多站点编排器 v2.1 或更高版本

参数

参数	注释
backup 别名：name 字符串	给定备份的名称 backup 与 backup_id 互斥。只能使用两者之一。
backup_id 别名：id 字符串	特定备份的 ID backup_id 与 backup 互斥。只能使用两者之一。
description 字符串	有关备份的简要信息。
destination 字符串	将备份下载到的位置
host 别名：hostname 字符串	ACI 多站点编排器主机的 IP 地址或主机名。 如果未在任务中指定该值，则将改为使用环境变量 MSO_HOST 的值。
location_type 字符串	要存储备份的位置类型 选择 "local" ← （默认） "remote"
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 字符串	此路径相对于远程位置。 在远程位置文件夹和此路径之间会自动添加“/”。 此文件夹结构应已存在于远程位置。
state 字符串	使用 present 或 absent 添加或删除。 使用 query 列出一个或多个对象。 使用 upload 上传备份。 使用 restore 恢复备份。 使用 download 下载备份。 使用 move 将备份从本地位置移动到远程位置。 选择 "absent" "present" ← （默认） "query" "upload" "restore" "download" "move"
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: Create a new local backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    description: via Ansible
    location_type: local
    state: present

- name: Create a new remote backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    description: via Ansible
    location_type: remote
    remote_location: ansible_test
    state: present

- name: Move backup to remote location
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup0
    remote_location: ansible_test
    remote_path: test
    state: move

- name: Download a backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    destination: ./
    state: download

- name: Upload a backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: ./Backup
    state: upload

- name: Restore a backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    state: restore

- name: Remove a Backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    state: absent

- name: Query a backup
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup
    state: query
  register: query_result

- name: Query a backup with its complete name
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    backup: Backup_20200721220043
    state: query
  register: query_result

- name: Query all backups
  cisco.mso.mso_backup:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  register: query_result

作者

• Shreyas Srish (@shrsr)

• Lionel Hercot (@lhercot)

• Sabari Jaganathan (@sajagana)

合集链接

• 问题追踪器
• 主页
• 仓库（源代码）