cisco.aci.aci_l3out_hsrp_group 模块 – 管理 HSRP 接口配置文件 (hsrp:IfP) 的 HSRP 组 (hsrp:GroupP)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构中 HSRP 接口配置文件的 HSRP 组。

参数

参数	注释
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 字符串	HSRP 接口组的描述。
group_id 整数	HSRP 接口组的组 ID。
group_name 字符串	组名用于定义和管理特定的 HSRP 接口组，从而促进网络中的高可用性。
group_policy 字符串	HSRP 接口组的组策略。
group_type 字符串	HSRP 接口组的类型。 选项 "ipv4" "ipv6"
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改用环境变量 ACI_HOST 的值。
hsrp_interface_group 别名：name, hsrp_group 字符串	HSRP 接口组的名称。
interface_profile 别名：interface_profile_name, logical_interface 字符串	现有接口配置文件的名称。
ip 字符串	HSRP 接口组的虚拟 IP 地址。
ip_obtain_mode 字符串	用于获取 IP 地址的方法模式。 选项 "admin" "auto" "learn"
l3out 别名：l3out_name 字符串	现有 L3Out 的名称。
mac 字符串	HSRP 接口组的 MAC 地址。
node_profile 别名：node_profile_name, logical_node 字符串	节点配置文件的名称。
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的值。
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
tenant 别名：tenant_name 字符串	现有租户的名称。
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

备注

注意

• 在您的 playbook 中使用此模块之前，必须存在tenant、l3out、logical_node_profile、logical_interface_profile和hsrp_interface_profile。可以使用cisco.aci.aci_tenant、cisco.aci.aci_l3out、cisco.aci.aci_l3out_logical_node_profile、cisco.aci.aci_l3out_logical_interface_profile和cisco.aci.aci_l3out_hsrp_interface_profile来实现。

另请参阅

另请参阅

aci_tenant

**aci_tenant** 模块的官方文档。

aci_l3out

**aci_l3out** 模块的官方文档。

aci_l3out_logical_node_profile

**aci_l3out_logical_node_profile** 模块的官方文档。

aci_l3out_logical_interface_profile

**aci_l3out_logical_interface_profile** 模块的官方文档。

aci_l3out_hsrp_interface_profile

**aci_l3out_hsrp_interface_profile** 模块的官方文档。

APIC 管理信息模型参考

关于内部 APIC 类 **hsrp:IfP** 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new HSRP group
  cisco.aci.aci_l3out_hsrp_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_interface_group: group1
    ip: 12.34.56.32
    group_type: ipv4
    ip_obtain_mode: admin
    group_policy: default
    state: present
  delegate_to: localhost

- name: Delete a HSRP group
  cisco.aci.aci_l3out_hsrp_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_interface_group: group1
    ip: 12.34.56.32
    group_type: ipv4
    ip_obtain_mode: admin
    group_policy: default
    state: absent
  delegate_to: localhost

- name: Query a HSRP group
  cisco.aci.aci_l3out_hsrp_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_interface_group: group1
    ip: 12.34.56.32
    group_type: ipv4
    ip_obtain_mode: admin
    group_policy: default
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all HSRP groups
  cisco.aci.aci_l3out_hsrp_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    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>"
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"

作者

• Shreyas Srish (@shrsr)

集合链接

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