cisco.aci.aci_maintenance_policy 模块 – 管理固件维护策略 (maint:MaintP)

注意

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

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

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

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

概要

• 管理定义 ACI 升级期间行为的维护策略。

参数

参数	注释
admin_state 别名：adminst 字符串	可执行策略的管理状态。 如果 admin_state 设置为 triggered，则将触发节点的立即升级。 在创建期间未设置时，APIC 默认值为 untriggered。 选项 "triggered" "untriggered"
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 字符串	维护策略的描述。
download_state 字符串	可执行策略的下载状态。 在创建期间未设置时，APIC 默认值为 untriggered。 选项 "triggered" "untriggered"
graceful 布尔值	系统是否会在升级期间优雅地关闭节点，从而减少流量损失。 在创建期间未设置时，APIC 默认值为 false。 选项 false true
host 别名：hostname 字符串	Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改用环境变量 ACI_HOST 的值。
ignore_compat 别名：ignoreCompat 布尔值	检查是否应忽略兼容性检查 在创建期间未设置时，APIC 默认值为 false。 选项 false true
name 别名：maintenance_policy 字符串	维护策略的名称。
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
notify_condition 字符串	指定在什么暂停条件下会通过电子邮件/短信通知管理员（根据配置）。 此通知机制独立于事件/故障。 在创建期间未设置时，APIC 默认值为 notifyOnlyOnFailures。 选项 "notify_always_between_sets" "notify_never" "notify_only_on_failures"
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的值。
密码 字符串	用于身份验证的密码。 此选项与private_key互斥。如果也提供了private_key，则将优先使用它。 如果任务中未指定此值，则将使用环境变量ACI_PASSWORD或ANSIBLE_NET_PASSWORD的值。
端口 整数	用于 REST 连接的端口号。 默认值取决于参数use_ssl。 如果任务中未指定此值，则将使用环境变量ACI_PORT的值。
私钥 别名：cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将忽略它。 如果任务中未指定此值，则将使用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
运行模式 别名：runmode 字符串	系统在出错时暂停还是继续执行。 在创建期间未设置时，APIC 默认值为pauseOnlyOnFailures。 选项 “pause_always_between_sets” “pause_only_on_failures” “pause_never” “pauseOnlyOnFailures” “pauseNever”
调度程序 字符串	应用于策略的调度程序名称。
smu_operation 字符串	指定 SMU 操作。 选项 “smu_install” “smu_uninstall”
smu_operation_flags 字符串	指定 SMU 操作标志 指示节点是否应立即重新加载或跳过 SMU 安装/卸载时的自动重新加载。 选项 “smu_reload_immediate” “smu_reload_skip”
sr_upgrade 布尔值	SR 固件升级。 选项 false true
sr_version 字符串	兼容性目录的 SR 版本。
状态 字符串	使用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
超时 整数	以秒为单位的套接字级别超时。 如果任务中未指定此值，则将使用环境变量ACI_TIMEOUT的值。 默认值为 30。
use_proxy 布尔值	如果为false，即使目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定此值，则将使用环境变量ACI_USE_PROXY的值。 默认值为 true。 选项 false true
use_ssl 布尔值	如果为false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定此值，则将使用环境变量ACI_USE_SSL的值。 当连接为本地连接时，默认值为 true。 选项 false true
用户名 别名：user 字符串	用于身份验证的用户名。 如果任务中未指定此值，则将使用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。 默认值为 admin。
validate_certs 布尔值	如果为false，则不会验证 SSL 证书。 只有在使用自签名证书的个人控制站点上时，才应将其设置为false。 如果任务中未指定此值，则将使用环境变量ACI_VALIDATE_CERTS的值。 默认值为 true。 选项 false true
版本 字符串	兼容性目录的版本。
version_check_override 字符串	版本检查覆盖。 这是一个指令，用于忽略下一次安装的版本检查。 版本检查（在维护窗口期间发生）检查所需版本是否与运行版本匹配。 如果版本不匹配，则执行安装。如果版本匹配，则不执行安装。 版本检查覆盖是一个一次性覆盖，无论版本是否匹配，都会执行安装。 在创建期间未设置时，APIC 默认值为 untriggered。 选项 “trigger” “trigger_immediate” "triggered" "untriggered"

备注

注意

• 此模块需要一个调度程序，可以使用cisco.aci.aci_fabric_scheduler模块或通过 UI 创建。

另请参阅

另请参阅

cisco.aci.aci_fabric_scheduler

此模块创建 ACI 调度程序 (trig:SchedP)。

APIC 管理信息模型参考

有关内部 APIC 类maint:MaintP的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a maintenance policy
  cisco.aci.aci_maintenance_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_maintenance_policy
    scheduler: simpleScheduler
    state: present
  delegate_to: localhost

- name: Delete a maintenance policy
  cisco.aci.aci_maintenance_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_maintenance_policy
    state: absent
  delegate_to: localhost

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

- name: Query a specific maintenance policy
  cisco.aci.aci_maintenance_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_maintenance_policy
    state: query
  delegate_to: localhost
  register: query_result

返回值

公共返回值已在此处记录，以下是此模块独有的字段

键	描述
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>"
响应 字符串	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"

作者

• Steven Gerhart (@sgerhart)

• Gaspard Micol (@gmicol)

集合链接

• 问题追踪器
• 代码库（源码）