cisco.aci.aci_interface_policy_leaf_policy_group 模块 – 管理 Fabric 接口策略 Leaf 策略组 (infra:AccBndlGrp 和 infra:AccPortGrp)

注意

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

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

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

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

概要

• 管理 Cisco ACI Fabric 上的 Fabric 接口策略 Leaf 策略组。

参数

参数	注释
aep 别名：aep_name 字符串	Leaf 接口策略组使用的附加实体配置文件 (AEP) 的名称。
注释 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定此值且环境变量 ACI_ANNOTATION 也不存在，则将使用默认值。 默认值： "orchestrator:ansible"
cdp_policy 别名：cdp_policy_name 字符串	Leaf 接口策略组使用的 CDP 策略的名称。
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
copp_policy 别名：copp_policy_name 字符串	Leaf 接口策略组使用的 COPP 策略的名称。
description 别名：descr 字符串	Leaf 接口策略组的描述。
dwdm 别名：dwdm_name 字符串	Leaf 接口策略组使用的 DWDM 的名称。
egress_data_plane_policing_policy 别名：egress_data_plane_policing_policy_name 字符串	Leaf 接口策略组使用的出站数据平面策略的名称。
fibre_channel_interface_policy 别名：fibre_channel_interface_policy_name 字符串	Leaf 接口策略组使用的光纤通道接口策略的名称。
host 别名：hostname 字符串	Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将使用环境变量 ACI_HOST 的值。
ingress_data_plane_policing_policy 别名：ingress_data_plane_policing_policy_name 字符串	Leaf 接口策略组使用的入站数据平面策略的名称。
l2_interface_policy 别名：l2_interface_policy_name 字符串	Leaf 接口策略组使用的 L2 接口策略的名称。
lag_type 别名：lag_type_name 字符串 / 必填	Leaf 接口策略组类型的选择器。 leaf 用于 Leaf 接入端口策略组 link 用于端口通道 (PC) node 用于虚拟端口通道 (VPC) 选项 "leaf" "link" "node"
link_flap_policy 别名：link_flap_policy_name 字符串	Leaf 接口策略组使用的链路抖动策略的名称。
link_level_flow_control 别名：link_level_flow_control_name 字符串	Leaf 接口策略组使用的链路级流量控制的名称。
link_level_policy 别名：link_level_policy_name 字符串	Leaf 接口策略组使用的链路级策略的名称。
lldp_policy 别名：lldp_policy_name 字符串	Leaf 接口策略组使用的 LLDP 策略的名称。
mac_sec_interface_policy 别名：mac_sec_interface_policy_name 字符串	Leaf 接口策略组使用的 MAC 安全接口策略的名称。
mcp_policy 别名：mcp_policy_name 字符串	Leaf 接口策略组使用的 MCP 策略的名称。
monitoring_policy 别名：monitoring_policy_name 字符串	Leaf 接口策略组使用的监控策略的名称。
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的值。
poe_interface_policy 别名：poe_interface_policy_name 字符串	叶子接口策略组使用的 poe 接口策略的名称。
policy_group 别名：name, policy_group_name 字符串	叶子接口策略组的名称。
port 整数	用于 REST 连接的端口号。 默认值取决于参数use_ssl。 如果任务中未指定此值，则将使用环境变量ACI_PORT的值。
port_authentication 别名：port_authentication_name 字符串	叶子接口策略组使用的端口身份验证的名称。
port_channel_policy 别名：port_channel_policy_name 字符串	叶子接口策略组使用的端口通道策略的名称。
port_security_policy 别名：port_security_policy_name 字符串	叶子接口策略组使用的端口安全策略的名称。
priority_flow_control_policy 别名：priority_flow_control_policy_name 字符串	叶子接口策略组使用的优先级流控制策略的名称。
private_key 别名：cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将被忽略。 如果任务中未指定此值，则将使用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
slow_drain_policy 别名：slow_drain_policy_name 字符串	叶子接口策略组使用的慢速排水策略的名称。
state 字符串	使用present或absent进行添加或删除。 使用query列出单个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
storm_control_interface_policy 别名：storm_control_interface_policy_name 字符串	叶子接口策略组使用的风暴控制接口策略的名称。
stp_interface_policy 别名：stp_interface_policy_name 字符串	叶子接口策略组使用的 STP 接口策略的名称。
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
sync_e_interface_policy 别名：sync_e_interface_policy_name 字符串	叶子接口策略组使用的 SyncE 接口策略的名称。 仅在 APIC 版本 5.2 或更高版本中可用。
timeout 整数	以秒为单位的套接字级别超时。 如果任务中未指定此值，则将使用环境变量ACI_TIMEOUT的值。 默认值为 30。
transceiver_policy 字典	叶子接口策略组使用的收发器策略的名称。 仅在 APIC 版本 6.0(2h) 或更高版本中可用。
name 别名：transceiver_policy_name 字符串 / 必填	收发器策略的名称。
type 别名：transceiver_policy_type 字符串 / 必填	收发器策略的类型。 选项 "zr" "zrp"
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

注释

注意

• 使用此模块时，请选择合适的 link_aggregation_type (lag_type)。

• 端口通道 (PC) 使用link，虚拟端口通道 (VPC) 使用node，叶子访问端口策略组使用leaf。

另请参阅

另请参阅

APIC 管理信息模型参考

有关内部 APIC 类infra:AccBndlGrp和infra:AccPortGrp的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a Port Channel (PC) Interface Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: link
    policy_group: policygroupname
    description: policygroupname description
    link_level_policy: linklevelpolicy
    cdp_policy: cdppolicy
    lldp_policy: lldppolicy
    port_channel_policy: lacppolicy
    state: present
  delegate_to: localhost

- name: Create a Virtual Port Channel (VPC) Interface Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: node
    policy_group: policygroupname
    link_level_policy: linklevelpolicy
    cdp_policy: cdppolicy
    lldp_policy: lldppolicy
    port_channel_policy: lacppolicy
    state: present
  delegate_to: localhost

- name: Create a Leaf Access Port Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: leaf
    policy_group: policygroupname
    link_level_policy: linklevelpolicy
    cdp_policy: cdppolicy
    lldp_policy: lldppolicy
    state: present
  delegate_to: localhost

- name: Query all Leaf Access Port Policy Groups of type link
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: link
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific Lead Access Port Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: leaf
    policy_group: policygroupname
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete an Interface policy Leaf Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: leaf
    policy_group: policygroupname
    state: absent
  delegate_to: localhost

返回值

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

键	描述
current 列表 / 元素=字符串	模块完成后的 APIC 中的现有配置 返回：成功 示例： [{"fvTenant": {"attributes": {"descr": "生产 环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
错误 字典	APIC 返回的错误信息 返回：失败 示例： {"code": "122", "text": "未知 托管 对象 类 foo"}
筛选字符串 字符串	请求使用的筛选字符串 返回：失败或调试信息 示例： "?rsp-prop-include=config-only"
方法 字符串	用于向 APIC 发出请求的 HTTP 方法 返回：失败或调试信息 示例： "POST"
先前状态 列表 / 元素=字符串	模块启动之前 APIC 中的原始配置 返回：信息 示例： [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
建议配置 字典	用户提供的参数组装而成的配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
原始输出 字符串	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"

作者

• Bruno Calogero (@brunocalogero)

集合链接

• 问题追踪器
• 代码库 (源码)