cisco.aci.aci_l3out_floating_svi 模块 – 管理三层外部 (L3Out) 接口 (l3ext:VirtualLIfP)

注意

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

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

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

要在剧本中使用它，请指定：cisco.aci.aci_l3out_floating_svi。

概要

• 管理 Cisco ACI 结构中的 L3Out 接口。

参数

参数	注释
address 别名：addr，ip_address 字符串	IP 地址。
注释 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将改用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定此值，并且环境变量 ACI_ANNOTATION 也未设置，则将使用默认值。 默认值： "orchestrator:ansible"
auto_state 字符串	SVI 自动状态。 选项 "enabled" "disabled"
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将改用环境变量 ACI_CERTIFICATE_NAME 的值。
dscp 别名：target_dscp 字符串	目标区分服务 (DSCP) 值。 在创建期间未设置时，APIC 默认为 unspecified。 选项 "AF11" "AF12" "AF13" "AF21" "AF22" "AF23" "AF31" "AF32" "AF33" "AF41" "AF42" "AF43" "CS0" "CS1" "CS2" "CS3" "CS4" "CS5" "CS6" "CS7" "EF" "VA" "unspecified"
encap 字符串	接口上的封装（例如“vlan-500”）
encap_scope 字符串	封装范围。 选项 "vrf" "local"
external_bridge_group_profile 字符串	外部桥接组配置文件。 将“”作为值传递以删除现有的外部桥接组配置文件（请参见示例）。 这仅在 APIC v5.0 及更高版本中受支持。
host 别名：hostname 字符串	Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改用环境变量 ACI_HOST 的值。
interface_profile 别名：interface_profile_name，logical_interface 字符串 / 必需	接口配置文件的名称。
ipv6_dad 字符串	IPv6 双地址检测 (DAD) 功能。 选项 "enabled" "disabled"
l3out 别名：l3out_name 字符串 / 必需	现有 L3Out 的名称。
link_local_address 字符串	接口的链路本地地址选项。
mac_address 字符串	接口的 MAC 地址选项。
mode 字符串	ext-svi 接口的模式选项。 选项 "regular" "native" "untagged"
mtu 字符串	接口 MTU。
node_id 字符串	用于端口通道和单个端口的构建接口的节点 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，则将改用它。 如果任务中未指定此值，则将改用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
pod_id 字符串	用于构建接口的 Pod ID。
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。可以使用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_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_l3out

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

cisco.aci.aci_l3out_logical_node_profile

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

cisco.aci.aci_l3out_logical_interface_profile

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

APIC 管理信息模型参考

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

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a Floating SVI
  cisco.aci.aci_l3out_floating_svi:
    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
    address: 23.45.67.90/24
    external_bridge_group_profile: bridge1
    state: present
  delegate_to: localhost

- name: Remove an external bridge group profile
  cisco.aci.aci_l3out_floating_svi:
    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
    address: 23.45.67.90/24
    external_bridge_group_profile: ""
    state: present
  delegate_to: localhost

- name: Remove a Floating SVI
  cisco.aci.aci_l3out_floating_svi:
    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: absent
  delegate_to: localhost

- name: Query a Floating SVI
  cisco.aci.aci_l3out_floating_svi:
    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_result

- name: Query all the Floating SVIs under an interface profile
  cisco.aci.aci_l3out_floating_svi:
    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_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>"
response 字符串	来自 APIC 的 HTTP 响应 返回：失败或调试 示例："OK (30 bytes)"
sent 列表 / 元素=字符串	推送到 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)

资源链接

• 问题追踪
• 代码仓库