cisco.aci.aci_config_snapshot 模块 – 管理配置快照 (config:Snapshot 和 config:ExportP)

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.aci。

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

概要 

管理 Cisco ACI 结构上的配置快照。
使用 configExportP 类创建新的快照。
使用 configSnapshot 类删除快照。

参数 

参数	注释
annotation 字符串	用户定义的字符串，用于注释对象。如果任务中未指定此值，则将改用环境变量 `ACI_ANNOTATION` 的值。如果任务中未指定此值且环境变量 `ACI_ANNOTATION` 未设置，则将使用默认值。默认值： `"orchestrator:ansible"`
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。如果提供了 `private_key` 文件名，则默认为 `private_key` 基名（不含扩展名）。如果为 `private_key` 提供了 PEM 格式的内容，则默认为 `username` 值。如果任务中未指定此值，则将改用环境变量 `ACI_CERTIFICATE_NAME` 的值。
description 别名：descr 字符串	配置导出策略的描述。
export_policy 别名：name 字符串	用于配置快照的导出策略的名称。
format 字符串	将配置备份格式设置为 JSON 或 XML。未设置时，APIC 默认值为 `json`。选项 `"json"` `"xml"`
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定此值，则将改用环境变量 `ACI_HOST` 的值。
include_secure 布尔值	确定是否应在备份中包含安全信息。未设置时，APIC 默认值为 `true`。选项 `false` `true`
max_count 整数	确定在 APIC 开始循环之前，导出策略可以存在多少个快照。可接受的值范围为 `1` 到 `10`。未设置时，APIC 默认值为 `3`。
output_level 字符串	影响此 ACI 模块的输出。 `normal` 表示标准输出，包括 `current` 字典 `info` 添加信息输出，包括 `previous`、`proposed` 和 `sent` 字典 `debug` 添加调试输出，包括 `filter_string`、`method`、`response`、`status` 和 `url` 信息如果任务中未指定此值，则将改用环境变量 `ACI_OUTPUT_LEVEL` 的值。选项 `"debug"` `"info"` `"normal"` ← (默认值)
output_path 字符串	将用于转储模块生成的 ACI JSON 配置对象的路径。如果任务中未指定此值，则将改用环境变量 `ACI_OUTPUT_PATH` 的值。
password 字符串	用于身份验证的密码。此选项与 `private_key` 相互排斥。如果也提供了 `private_key`，则将改用它。如果任务中未指定此值，则将改用环境变量 `ACI_PASSWORD` 或 `ANSIBLE_NET_PASSWORD` 的值。
port 整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果任务中未指定此值，则将改用环境变量 `ACI_PORT` 的值。
private_key 别名：cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。此值还会影响使用的默认`certificate_name`。此选项与`password`互斥。如果同时提供`password`，则会忽略。如果任务中未指定此值，则会改用环境变量`ACI_PRIVATE_KEY`或`ANSIBLE_NET_SSH_KEYFILE`的值。
snapshot 字符串	要删除的快照名称。
state 字符串	使用`present`或`absent`添加或删除。使用`query`列出单个对象或多个对象。选项 `"absent"` `"present"` ← (默认) `"query"`
suppress_previous 别名：no_previous, ignore_previous 布尔值	如果为`true`，则在向APIC发出POST更新之前，不会发送GET请求以检查之前的状态。如果任务中未指定此值，则会改用环境变量`ACI_SUPPRESS_PREVIOUS`的值。默认值为`false`。警告 - 这会导致之前的返回值为空。不会检查对象的先前状态，POST更新将包含所有属性。选项 `false` `true`
suppress_verification 别名：no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为`true`，则在向APIC发出POST更新后，不会发送GET请求进行验证。如果任务中未指定此值，则会改用环境变量`ACI_SUPPRESS_VERIFICATION`的值。默认值为`false`。警告 - 这会导致当前返回值设置为建议值。包含默认值在内的当前对象在一个任务中将无法验证。选项 `false` `true`
timeout 整数	套接字级别超时（秒）。如果任务中未指定此值，则会改用环境变量`ACI_TIMEOUT`的值。默认值为30。
use_proxy 布尔值	如果为`false`，即使目标主机上的环境变量中定义了代理，也不会使用代理。如果任务中未指定此值，则会改用环境变量`ACI_USE_PROXY`的值。默认值为true。选项 `false` `true`
use_ssl 布尔值	如果为`false`，将使用HTTP连接而不是默认的HTTPS连接。如果任务中未指定此值，则会改用环境变量`ACI_USE_SSL`的值。当连接为本地连接时，默认值为true。选项 `false` `true`
username 别名：user 字符串	用于身份验证的用户名。如果任务中未指定此值，则会改用环境变量`ACI_USERNAME`或`ANSIBLE_NET_USERNAME`的值。默认值为admin。
validate_certs 布尔值	如果为`false`，则不会验证SSL证书。只有在使用自签名证书的个人控制站点上使用时，才应将其设置为`false`。如果任务中未指定此值，则会改用环境变量`ACI_VALIDATE_CERTS`的值。默认值为true。选项 `false` `true`

备注 

注意

APIC没有提供命名快照的机制。
快照文件使用以下命名结构：ce_<配置导出策略名称>-<yyyy>-<mm>-<dd>T<hh>:<mm>:<ss>.<mss>+<hh>:<mm>。
快照对象使用以下命名结构：run-<yyyy>-<mm>-<dd>T<hh>-<mm>-<ss>。
强烈建议在创建快照后添加暂停任务。
在查询、比较快照或处理回滚之前，等待快照完成。

另请参阅 

另请参阅

cisco.aci.aci_config_rollback: 提供回滚和回滚预览功能 (config:ImportP)。
APIC管理信息模型参考: 有关内部APIC类config:Snapshot和config:ExportP的更多信息。
Cisco ACI指南: 使用Ansible管理ACI基础设施的详细信息。
开发Cisco ACI模块: 有关如何编写您自己的Cisco ACI模块以进行贡献的详细指南。

示例 

- name: Create a Snapshot
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: present
    export_policy: config_backup
    max_count: 10
    description: Backups taken before new configs are applied.
  delegate_to: localhost

- name: Wait for snapshot to be finished before querying
  pause:
    seconds: 10

- name: Query all Snapshots
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query Snapshots associated with a particular Export Policy
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    export_policy: config_backup
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a Snapshot
  cisco.aci.aci_config_snapshot:
    host: apic
    username: admin
    password: SomeSecretPassword
    export_policy: config_backup
    snapshot: run-2017-08-24T17-20-05
    state: absent
  delegate_to: localhost

返回值 

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

键	描述
current 列表 / 元素=字符串	模块完成后的APIC现有配置返回：成功示例：`[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error 字典	APIC返回的错误信息返回：失败示例：`{"code": "122", "text": "unknown managed object class foo"}`
filter_string 字符串	请求使用的过滤器字符串返回：失败或调试示例：`"?rsp-prop-include=config-only"`
method 字符串	用于向APIC发出请求的HTTP方法返回：失败或调试示例：`"POST"`
previous 列表 / 元素=字符串	模块启动前APIC的原始配置返回：信息示例：`[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed 字典	用户提供的参数组装的配置返回：信息示例：`{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw 字符串	APIC REST API返回的原始输出（xml或json）返回：解析错误示例：`"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response 字符串	APIC的HTTP响应返回：失败或调试示例：`"OK (30 bytes)"`
sent 列表 / 元素=字符串	实际/最小推送到APIC的配置返回：信息示例：`{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status 整数	APIC的HTTP状态返回：失败或调试示例：`200`
url 字符串	用于向APIC发出请求的HTTP URL 返回：失败或调试示例：`"https://10.11.12.13/api/mo/uni/tn-production.json"`

作者

Jacob McGill (@jmcgill298)
Gaspard Micol (@gmicol)