cisco.aci.aci_firmware_policy 模块 – 管理固件策略 (firmware:FwP)

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.aci.aci_firmware_policy。

概要

• 此模块为固件组创建固件策略。

• 在分配固件时，可以显式忽略兼容性检查。

参数

参数	注释
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 字符串	固件策略的描述。
effective_on_reboot 布尔值	一个属性，指示所选的固件版本是否在重新启动后生效。 固件必须在计划的维护操作之前在计划外的重新启动时生效。 选择 false true
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将使用环境变量 ACI_HOST 的值。
ignore_compat 别名：ignoreCompat 布尔值	检查是否应忽略兼容性检查 选择 false true
name 字符串	固件策略的名称
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
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 的值。
owner_key 字符串	用于 ACI 对象的 ownerKey 属性的用户定义字符串。 此属性表示一个键，用于使客户端能够拥有其数据以进行实体关联。 如果任务中未指定该值，则将使用环境变量 ACI_OWNER_KEY 的值。
owner_tag 字符串	用于 ACI 对象的 ownerTag 属性的用户定义字符串。 此属性表示一个标签，用于使客户端能够添加自己的数据。 例如，指示谁创建了此对象。 如果任务中未指定该值，则将使用环境变量 ACI_OWNER_TAG 的值。
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 的值。
sr_upgrade 布尔值	SR 固件升级。 选择 false true
sr_version 字符串	与此策略关联的固件的 SR 版本。
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
version 字符串	与此策略关联的固件版本。 此字段的语法为 n9000-xx.x。 如果完整版本为 13.1(1i)，则此字段的值将为 n9000-13.1(1i)。
version_check_override 字符串	版本检查覆盖。 这是忽略下次安装的版本检查的指令。 版本检查（在维护窗口期间发生）会检查所需的版本是否与正在运行的版本匹配。 如果版本不匹配，则执行安装。如果版本匹配，则不执行安装。 版本检查覆盖是一次性覆盖，无论版本是否匹配，都会执行安装。 在创建期间未设置时，APIC 默认为 untriggered。 选择 "trigger" "trigger_immediate" "triggered" "untriggered"

另请参阅

另请参阅

APIC 管理信息模型参考

有关内部 APIC 类 firmware:FwP 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a firmware policy
  cisco.aci.aci_firmware_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_firmware_policy
    version: n9000-13.2(1m)
    ignore_compat: false
    state: present
  delegate_to: localhost

- name: Delete a firmware policy
  cisco.aci.aci_firmware_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_firmware_policy
    state: absent
  delegate_to: localhost

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

- name: Query a specific firmware policy
  cisco.aci.aci_firmware_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_firmware_policy
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键	描述
current list / elements=string	模块完成后，来自 APIC 的现有配置 返回： 成功 示例： [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error dictionary	从 APIC 返回的错误信息 返回： 失败 示例： {"code": "122", "text": "unknown managed object class foo"}
filter_string 字符串	用于请求的筛选字符串 返回： 失败或调试 示例： "?rsp-prop-include=config-only"
method 字符串	用于向 APIC 发出请求的 HTTP 方法 返回： 失败或调试 示例： "POST"
previous list / elements=string	模块启动之前来自 APIC 的原始配置 返回： 信息 示例： [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed dictionary	来自用户提供的参数的组装配置 返回： 信息 示例： {"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 list / elements=string	推送到 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"

作者

• Steven Gerhart (@sgerhart)

• Gaspard Micol (@gmicol)

集合链接

• 问题跟踪器
• 存储库（源）