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

注意

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

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

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

要在playbook中使用它，请指定：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)