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。

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

集合链接

• 问题追踪器
• 仓库 (源代码)