cisco.aci.aci_l3out_floating_svi_path 模块 – 管理三层外部 (L3Out) 浮动 SVI 路径属性 (l3ext:RsDynPathAtt)

注意

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

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

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

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

概要

• 管理 Cisco ACI 交换矩阵上的 L3Out 浮动 SVI 路径属性。

参数

参数	注释
access_encap 字符串	端口封装选项。
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 的值。
domain 字符串	此选项允许虚拟机发送带有 MAC 地址的帧。
domain_type 字符串	路径的域类型。 仅在 APIC v5.0 及更高版本中支持物理域类型。 选择 "physical" "vmware"
encap 字符串 / 必需	接口上的封装（例如，“vlan-500”）
enhanced_lag_policy 字符串	路径的增强型 LAG 策略。 传递 “” 作为值以删除现有的增强型 LAG 策略（请参阅示例）。
floating_ip 别名：floating_address 字符串	浮动 IP 地址。
forged_transmit 字符串	此选项允许虚拟机发送带有 MAC 地址的帧。 仅在 APIC v5.0 及更高版本中支持。 选择 "enabled" "disabled"
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将使用环境变量 ACI_HOST 的值。
interface_profile 别名：interface_profile_name, logical_interface 字符串 / 必需	接口配置文件的名称。
l3out 别名：l3out_name 字符串 / 必需	现有 L3Out 的名称。
mac_change 字符串	外部 VMM 控制器中端口组的 MAC 地址更改支持的状态。 仅在 APIC v5.0 及更高版本中支持。 选择 "enabled" "disabled"
node_id 字符串 / 必需	为端口通道和单个端口在其上构建接口的节点。
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 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果同时提供了 private_key，则会使用 private_key。 如果任务中未指定该值，则会使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
pod_id 字符串 / 必需	在其上构建接口的Pod。
port 整数	用于REST连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则会使用环境变量 ACI_PORT 的值。
private_key 别名：cert_key 字符串	用于基于签名的身份验证的PEM格式的私钥文件或私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果同时提供了 password，则会忽略 password。 如果任务中未指定该值，则会使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
promiscuous_mode 字符串	外部VMM控制器中端口组的混杂模式状态。 仅在 APIC v5.0 及更高版本中支持。 选择 "enabled" "disabled"
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

备注

注意

• 在剧本中使用此模块之前，必须存在 tenant、 l3out、logical_node_profile、logical_interface_profile 和 floating_svi。可以使用 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_floating_svi来实现此目的。

参见

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_l3out

管理第 3 层外部 (L3Out) 对象 (l3ext:Out)。

cisco.aci.aci_l3out_logical_node_profile

管理第 3 层外部 (L3Out) 逻辑节点配置文件 (l3ext:LNodeP)。

cisco.aci.aci_l3out_logical_interface_profile

管理第 3 层外部 (L3Out) 逻辑接口配置文件 (l3ext:LIfP)。

cisco.aci.aci_l3out_floating_svi

管理第 3 层外部 (L3Out) 接口 (l3ext:VirtualLIfP)。

APIC 管理信息模型参考

有关内部 APIC 类 l3ext:RsDynPathAtt 的更多信息)

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a Floating SVI path attribute
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    floating_ip: 23.45.67.90/24
    domain_type: virtual
    domain: anstest
    enhanced_lag_policy: enhanced
    state: present
  delegate_to: localhost

- name: Remove enhanced lag policy from the path
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    floating_ip: 23.45.67.90/24
    domain_type: virtual
    domain: anstest
    enhanced_lag_policy: ""
    state: present
  delegate_to: localhost

- name: Remove a Floating SVI path attribute
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    domain_type: virtual
    domain: anstest
    state: absent
  delegate_to: localhost

- name: Query a Floating SVI path attribute
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    domain_type: virtual
    domain: anstest
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all the Floating SVI path attributes
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    state: query
  delegate_to: localhost
  register: query_results

返回值

此处记录了常见的返回值 这里，以下是此模块独有的字段

键	描述
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": "生产环境"}}}
状态 整数	来自 APIC 的 HTTP 状态 返回： 失败或调试 示例: 200
URL 字符串	用于向 APIC 发送请求的 HTTP URL 返回： 失败或调试 示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Shreyas Srish (@shrsr)

集合链接

• 问题跟踪器
• 存储库 (源代码)