cisco.aci.aci_l2out_logical_interface_path 模块 – 管理二层外部 (L2Out) 逻辑接口路径 (l2ext:RsPathL2OutAtt)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构中 L2 外部节点 (BD 扩展) 的接口路径条目。

参数

参数	注释
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 的值。
interface 字符串	tDn 的 interface 字符串值部分。 通常是一个策略组，例如 test-IntPolGrp 或取决于 interface_type 的以下格式的接口 1/7。
interface_profile 别名：name, interface_profile_name, logical_interface 字符串	接口配置文件的名称。
interface_type 字符串	静态 EPG 部署的接口类型。 选项 "switch_port" ← (默认) "port_channel" "vpc"
l2out 别名：l2out_name 字符串	现有 L2Out 的名称。
leaves 别名：leafs, nodes, paths, switches 列表 / 元素=字符串	interface 所属的交换机 ID。 当 interface_type 为 switch_port 或 port_channel 时，leaves 是叶子 ID 的字符串。 当 interface_type 为 vpc 时，leaves 是包含两个叶子 ID 的列表。 leaves 值通常类似于 '101' 或 '101-102'，具体取决于 connection_type。
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，pod_number 整数	tDn 的 pod 编号部分。 pod_id 通常是一个小于 10 的整数。
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，则在进行 POST 更新到 APIC 之前不会发送 GET 请求来检查之前的状态。 如果任务中未指定值，则使用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致之前的返回值为空。 不会检查对象的先前状态，POST 更新将包含所有属性。 选项 false true
suppress_verification 别名：no_verification，no_verify，suppress_verify，ignore_verify，ignore_verification 布尔值	如果为 true，则在进行 POST 更新到 APIC 后不会发送验证性 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

另请参见

另请参见

aci_l2out

关于 **aci_l2out** 模块的官方文档。

aci_l2out_logical_node_profile

关于 **aci_l2out_logical_node_profile** 模块的官方文档。

aci_l2out_logical_interface_profile

关于 **aci_l2out_logical_interface_profile** 模块的官方文档。

aci_l2out_extepg

关于 **aci_l2out_extepg** 模块的官方文档。

APIC 管理信息模型参考

关于内部 APIC 类 **l2ext:RsPathL2OutAtt** 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add new path to interface profile
  cisco.aci.aci_l2out_logical_interface_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l2out: my_l2out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    leaves: 101-102
    interface: L2o1
    state: present
  delegate_to: localhost

- name: Delete path to interface profile
  cisco.aci.aci_l2out_logical_interface_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l2out: my_l2out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    leaves: 101-102
    interface: L2o1
    state: absent
  delegate_to: localhost

- name: Query a path to interface profile
  cisco.aci.aci_l2out_logical_interface_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l2out: my_l2out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    leaves: 101-102
    interface: L2o1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all paths to interface profiles
  cisco.aci.aci_l2out_logical_interface_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    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"

作者

• Oleksandr Kreshchenko (@alexkross)

收藏链接

• 问题追踪器
• 代码仓库