cisco.aci.aci_config_export_policy 模块 – 管理配置导出策略 (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_export_policy。

概要

• 管理 Cisco ACI 结构上的配置导出策略。

参数

参数	注释
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 字符串	配置导出策略的描述。
export_destination 字符串	用于存储为配置导出策略生成的配置备份数据的远程路径策略的名称。
format 字符串	导出文件的格式。 在创建时未设置时，默认为 APIC 上的 json。 选项 "json" "xml"
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将使用环境变量 ACI_HOST 的值。
name 字符串	配置导出策略的名称。
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的值。
调度程序 字符串	用于运行计划导出作业的调度程序策略的名称。
快照 布尔值	启用配置导出策略的快照。 在 APIC 上创建时，如果未设置，则默认为 False。 选项 false true
立即启动 布尔值	指定是否应立即或在其他时间应用配置导出策略。 在 APIC 上创建时，如果未设置，则默认为 False。 选项 false true
状态 字符串	使用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
目标 DN 字符串	要导出的对象的区分名称。 如果没有包含 target_dn，APIC 将导出策略全集。
超时 整数	以秒为单位的套接字级别超时。 如果任务中未指定此值，则将改用环境变量ACI_TIMEOUT的值。 默认值为 30。
使用代理 布尔值	如果false，即使目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定此值，则将改用环境变量ACI_USE_PROXY的值。 默认值为 true。 选项 false true
使用 SSL 布尔值	如果false，将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定此值，则将改用环境变量ACI_USE_SSL的值。 当连接是本地连接时，默认值为 true。 选项 false true
用户名 别名：user 字符串	用于身份验证的用户名。 如果任务中未指定此值，则将改用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。 默认值为 admin。
验证证书 布尔值	如果false，则不会验证 SSL 证书。 只有在使用自签名证书的个人控制站点上使用时，才应将其设置为false。 如果任务中未指定此值，则将改用环境变量ACI_VALIDATE_CERTS的值。 默认值为 true。 选项 false true

另请参见

另请参见

APIC 管理信息模型参考

有关内部 APIC 类config:ExportP的更多信息。

Cisco ACI 指南

有关如何使用 Ansible 管理 ACI 基础设施的详细信息。

开发 Cisco ACI 模块

有关如何编写自己的 Cisco ACI 模块以供贡献的详细指南。

示例

- name: Add a Configuration Export Policy
  cisco.aci.aci_config_export_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ans_conf_export
    state: present
  delegate_to: localhost

- name: Query a Configuration Export Policy
  cisco.aci.aci_config_export_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ans_conf_export
    state: query
  delegate_to: localhost

- name: Query all Configuration Export Policies
  cisco.aci.aci_config_export_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove a Configuration Export Policies
  cisco.aci.aci_file_remote_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ans_conf_export
    state: absent
  delegate_to: localhost

返回值

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

键	描述
当前 列表 / 元素=字符串	模块完成后从 APIC 获取的现有配置 返回：成功 示例：[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
错误 字典	APIC 返回的错误信息 返回：失败 示例：{"code": "122", "text": "unknown managed object class foo"}
筛选字符串 字符串	用于请求的筛选字符串 返回：失败或调试 示例："?rsp-prop-include=config-only"
方法 字符串	用于向 APIC 发送请求的 HTTP 方法 返回：失败或调试 示例："POST"
之前 列表 / 元素=字符串	模块启动之前从 APIC 获取的原始配置 返回：信息 示例：[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
建议 字典	由用户提供的参数组装的配置 返回：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
原始 字符串	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>"
响应 字符串	来自 APIC 的 HTTP 响应 返回：失败或调试 示例："OK (30 bytes)"
已发送 列表 / 元素=字符串	实际/最小配置推送到 APIC 返回：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment"}}}
状态 整数	来自 APIC 的 HTTP 状态 返回：失败或调试 示例：200
URL 字符串	用于向 APIC 发送请求的 HTTP URL 返回：失败或调试 示例："https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Tim Cragg (@timcragg)

收藏链接

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