cisco.aci.aci_l3out_logical_node_profile 模块 – 管理三层外部 (L3Out) 逻辑节点配置文件 (l3ext:LNodeP)

注意

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

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

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

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

概要

• 在 Cisco ACI 结构上管理三层外部 (L3Out) 逻辑节点配置文件。

参数

参数	注释
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 字符串	节点配置文件的描述。
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"
host 别名：hostname 字符串	可通过 Ansible 控制主机解析的 APIC 的 IP 地址或主机名。 如果任务中未指定值，则将使用环境变量 ACI_HOST 的值。
l3out 别名：l3out_name 字符串	现有 L3Out 的名称。
mpls_custom_qos_policy 别名：mpls_custom_qos_policy_name 字符串	节点配置文件的 MPLS 自定义 QoS 策略名称。 此参数仅应用于 Infra SR-MPLS L3Out。
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
node_profile 别名：node_profile_name, 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，则将使用 private_key。 如果任务中未指定该值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值代替。
port integer	用于 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 boolean	如果为 true，则在向 APIC 发送 POST 更新之前，不会发送 GET 请求来检查先前状态。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_PREVIOUS 的值代替。 默认值为 false。 警告 - 这会导致先前的返回值为空。 将不会检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false true
suppress_verification 别名: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	如果为 true，则在向 APIC 发送 POST 更新后，不会发送 GET 请求来进行验证。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_VERIFICATION 的值代替。 默认值为 false。 警告 - 这会导致将当前返回值设置为建议值。 在单个任务中，包括默认值在内的当前对象将无法验证。 选项 false true
tenant 别名: tenant_name 字符串	现有租户的名称。
timeout integer	套接字级别的超时时间（以秒为单位）。 如果任务中未指定该值，则将使用环境变量 ACI_TIMEOUT 的值代替。 默认值为 30。
use_proxy boolean	如果为 false，即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定该值，则将使用环境变量 ACI_USE_PROXY 的值代替。 默认值为 true。 选项 false true
use_ssl boolean	如果为 false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定该值，则将使用环境变量 ACI_USE_SSL 的值代替。 当连接为本地连接时，默认值为 true。 选项 false true
username 别名: user 字符串	用于身份验证的用户名。 如果任务中未指定该值，则将使用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值代替。 默认值为 admin。
validate_certs boolean	如果为 false，则不会验证 SSL 证书。 仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。 如果任务中未指定该值，则将使用环境变量 ACI_VALIDATE_CERTS 的值代替。 默认值为 true。 选项 false true

参见

参见

aci_l3out

关于 aci_l3out 模块的官方文档。

APIC 管理信息模型参考

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

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new node profile
  cisco.aci.aci_l3out_logical_node_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    node_profile: my_node_profile
    description: node profile for my_l3out
    l3out: my_l3out
    tenant: my_tenant
    dscp: CS0
    state: present
  delegate_to: localhost

- name: Add a new node profile with MPLS custom QOS policy to SR-MPLS infra l3out
  cisco.aci.aci_l3out_logical_node_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: infra
    l3out: infra_sr_mpls_l3out
    node_profile: infra_sr_mpls_l3out_node_profile
    mpls_custom_qos_policy: infra_mpls_custom_qos_policy
    state: present
  delegate_to: localhost

- name: Delete a node profile
  cisco.aci.aci_l3out_logical_node_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    node_profile: my_node_profile
    l3out: my_l3out
    tenant: my_tenant
    state: absent
  delegate_to: localhost

- name: Query a node profile
  cisco.aci.aci_l3out_logical_node_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    node_profile: my_node_profile
    l3out: my_l3out
    tenant: my_tenant
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all node profile for L3out
  cisco.aci.aci_l3out_logical_node_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    l3out: my_l3out
    tenant: my_tenant
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

Key	描述
current list / elements=string	模块完成后，来自 APIC 的现有配置 返回: 成功 示例: [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error dictionary	从 APIC 返回的错误信息 返回: 失败 示例: {"code": "122", "text": "未知的托管对象类 foo"}
filter_string 字符串	用于请求的过滤器字符串 返回: 失败或调试 示例: "?rsp-prop-include=config-only"
method 字符串	用于向 APIC 发出请求的 HTTP 方法 返回: 失败或调试 示例: "POST"
previous list / elements=string	在模块启动之前，来自 APIC 的原始配置 返回: 信息 示例: [{"fvTenant": {"attributes": {"descr": "生产", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed dictionary	从用户提供的参数组装的配置 返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "生产环境", "name": "production"}}}
raw 字符串	APIC REST API 返回的原始输出 (xml 或 json) 返回: 解析错误 示例: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"未知的托管对象类 foo\"/></imdata>"
response 字符串	来自 APIC 的 HTTP 响应 返回: 失败或调试 示例: "OK (30 bytes)"
sent list / elements=string	推送到 APIC 的实际/最小配置 返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "生产环境"}}}
status integer	来自 APIC 的 HTTP 状态码 返回: 失败或调试 示例: 200
url 字符串	用于向 APIC 发送请求的 HTTP url 返回: 失败或调试 示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Jason Juenger (@jasonjuenger)

• Akini Ross (@akinross)

集合链接

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