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_name

字符串

Leaf 接口策略组使用的链路抖动策略的名称。

别名:link_level_flow_control_name

字符串

Leaf 接口策略组使用的链路级流量控制的名称。

别名:link_level_policy_name

字符串

叶子接口策略组使用的链路层策略名称。

lldp_policy

别名:lldp_policy_name

字符串

叶子接口策略组使用的LLDP策略名称。

mac_sec_interface_policy

别名:mac_sec_interface_policy_name

字符串

叶子接口策略组使用的MAC安全接口策略名称。

mcp_policy

别名:mcp_policy_name

字符串

叶子接口策略组使用的MCP策略名称。

monitoring_policy

别名:monitoring_policy_name

字符串

叶子接口策略组使用的监控策略名称。

name_alias

字符串

当前对象的别名。这与ACI中的nameAlias字段相关。

output_level

字符串

影响此ACI模块的输出。

normal 表示标准输出,包括 current 字典

info 添加信息输出,包括 previousproposedsent 字典

debug 添加调试输出,包括 filter_stringmethodresponsestatusurl 信息

如果任务中未指定该值,则将使用环境变量 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_PASSWORDANSIBLE_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_KEYANSIBLE_NET_SSH_KEYFILE 的值。

slow_drain_policy

别名:slow_drain_policy_name

字符串

叶子接口策略组使用的慢速排水策略名称。

state

字符串

使用 presentabsent 来添加或删除。

使用 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_USERNAMEANSIBLE_NET_USERNAME 的值。

默认值为admin。

validate_certs

布尔值

如果为 false,则不会验证SSL证书。

仅在使用自签名证书的个人控制站点上才应将其设置为 false

如果任务中未指定值,则将改用环境变量ACI_VALIDATE_CERTS的值。

默认值为true。

选项

  • false

  • true

注释

注意

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

  • link 用于端口通道 (PC),node 用于虚拟端口通道 (VPC),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": "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": "Production environment"}}}

status

整数

APIC 返回的 HTTP 状态

返回:失败或调试

示例:200

url

字符串

对 APIC 的请求使用的 HTTP url

返回:失败或调试

示例:"https://10.11.12.13/api/mo/uni/tn-production.json"

作者

  • Bruno Calogero (@brunocalogero)