cisco.aci.aci_interface_policy_port_channel 模块 – 管理端口通道接口策略 (lacp:LagPol)

注意

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

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

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

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

概要

• 管理 Cisco ACI 架构上的端口通道接口策略。

参数

参数	注释
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 字符串	端口通道的描述。
fast_select 布尔值	确定是否为热备端口启用快速选择。 这构成了 LACP 策略控制策略；如果定义了一个设置，则在运行任务后，所有其他未定义或设置为 false 的控制属性将不存在。 APIC 在创建期间未设置时默认为 true。 选项 false true
graceful_convergence 布尔值	确定是否启用平稳收敛。 这构成了 LACP 策略控制策略；如果定义了一个设置，则在运行任务后，所有其他未定义或设置为 false 的控制属性将不存在。 APIC 在创建期间未设置时默认为 true。 选项 false true
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果未在任务中指定该值，则将改为使用环境变量 ACI_HOST 的值。
load_defer 布尔值	确定是否启用加载延迟。 这构成了 LACP 策略控制策略；如果定义了一个设置，则在运行任务后，所有其他未定义或设置为 false 的控制属性将不存在。 APIC 在创建期间未设置时默认为 false。 选项 false true
max_links 整数	最大链接数。 接受的值范围介于 1 到 16 之间。 APIC 在创建期间未设置时默认为 16。
min_links 整数	最小链接数。 接受的值范围介于 1 到 16 之间。 APIC 在创建期间未设置时默认为 1。
mode 字符串	端口通道接口策略模式。 确定用于形成端口通道的 LACP 方法。 APIC 在创建期间未设置时默认为 off。 选项 "active" "mac-pin" "mac-pin-nicload" "off" "passive"
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
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 的值。
端口 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将使用环境变量 ACI_PORT 的值代替。
port_channel 别名: name 字符串	端口通道的名称。
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
suspend_individual 布尔值	确定是否启用“暂停单独”功能。 这构成了 LACP 策略控制策略；如果定义了一个设置，则在运行任务后，所有其他未定义或设置为 false 的控制属性将不存在。 APIC 在创建期间未设置时默认为 true。 选项 false true
symmetric_hash 布尔值	确定是否启用“对称哈希”功能。 这构成了 LACP 策略控制策略；如果定义了一个设置，则在运行任务后，所有其他未定义或设置为 false 的控制属性将不存在。 APIC 在创建期间未设置时默认为 false。 选项 false true
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

另请参阅

另请参阅

APIC 管理信息模型参考

有关内部 APIC 类 lacp:LagPol 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a Port Channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel: LACP_ACTIVE
    mode: active
    min_links: 1
    max_links: 16
    state: present
  delegate_to: localhost

- name: Delete a Port Channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel: LACP_ACTIVE
    state: absent
  delegate_to: localhost

- name: Query all Port Channel interface policies
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific Port Channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel: LACP_ACTIVE
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键	描述
current list / elements=string	模块完成后，来自 APIC 的现有配置 已返回: 成功 示例: [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	从 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 字典	从用户提供的参数组装的配置 已返回: 信息 示例: {"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 整数	来自 APIC 的 HTTP 状态 已返回: 失败或调试 示例: 200
url 字符串	用于向 APIC 发送请求的 HTTP URL 已返回: 失败或调试 示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Dag Wieers (@dagwieers)

集合链接

• 问题跟踪器
• 存储库（源代码）