cisco.aci.aci_l3out_hsrp_secondary_vip 模块 – 管理 HSRP 组的辅助虚拟 IP (hsrp:SecVip)

注意

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

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

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

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

概要 

管理 Cisco ACI 结构中 HSRP 组的辅助虚拟 IP。

参数 

参数	注释
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` 的值。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定该值，则将改用环境变量 `ACI_HOST` 的值。
hsrp_interface_group 别名：name, hsrp_group 字符串	现有 HSRP 组的名称。
interface_profile 别名：interface_profile_name, logical_interface 字符串	现有接口配置文件的名称。
l3out 别名：l3out_name 字符串	现有 L3Out 的名称。
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`的值。
secondary_virtual_ip 别名：vip, secondary_vip 字符串	兼容性目录的版本。
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和hsrp_group。可以使用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和cisco.aci.aci_l3out_hsrp_group来实现。

另请参阅 

另请参阅

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** 模块的官方文档。
aci_l3out_hsrp_group: **aci_l3out_hsrp_group** 模块的官方文档。
APIC管理信息模型参考: 关于内部APIC类**hsrp:SecVip**的更多信息。
Cisco ACI指南: 使用Ansible管理ACI基础设施的详细信息。
开发Cisco ACI模块: 关于如何编写您自己的Cisco ACI模块以进行贡献的详细指南。

示例 

- name: Add a HSRP secondary virtual ip
  cisco.aci.aci_l3out_hsrp_secondary_vip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_group: my_hsrp_group
    secondary_virtual_ip: 191.1.1.1
    state: present
  delegate_to: localhost

- name: Delete a HSRP secondary virtual ip
  cisco.aci.aci_l3out_hsrp_secondary_vip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_group: my_hsrp_interface_group
    secondary_virtual_ip: 191.1.1.1
    state: absent
  delegate_to: localhost

- name: Query a HSRP secondary virtual ip
  cisco.aci.aci_l3out_hsrp_secondary_vip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_group: my_hsrp_group
    secondary_virtual_ip: 191.1.1.1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all HSRP secondary virtual ips
  cisco.aci.aci_l3out_hsrp_secondary_vip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_group: my_hsrp_group
    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)