cisco.aci.aci_access_switch_policy_group 模块 – 管理接入交换机策略组 (infra:AccNodePGrp 和 infra:SpineAccNodePGrp)。

注意

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

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

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

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

概要

  • 管理 Cisco ACI 结构中的接入交换机策略组。

参数

参数

注释

annotation

字符串

用于注释对象的自定义字符串。

如果任务中未指定此值，则将使用环境变量 ACI_ANNOTATION 的值。

如果任务和环境变量 ACI_ANNOTATION 中均未指定此值，则将使用默认值。

默认值： "orchestrator:ansible"

bfd_ipv4_policy

字符串

绑定到接入交换机策略组的 BFD IPv4 策略。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

bfd_ipv6_policy

字符串

绑定到接入交换机策略组的 BFD IPv6 策略。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

bfd_multihop_ipv4_policy

字符串

绑定到接入交换机策略组的 BFD 多跳 IPv4 策略。

仅在 APIC 版本 5.x 或更高版本中可用。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

bfd_multihop_ipv6_policy

字符串

绑定到接入交换机策略组的 BFD 多跳 IPv6 策略。

仅在 APIC 版本 5.x 或更高版本中可用。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

cdp_policy

字符串

绑定到接入交换机策略组的 CDP 策略。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

certificate_name

别名：cert_name

字符串

附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。

如果提供了 private_key 文件名，则默认为 private_key 基名（不含扩展名）。

如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。

如果任务中未指定此值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。

copp_policy

字符串

绑定到接入交换机策略组的 CoPP 策略。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

copp_pre_filter_policy

字符串

绑定到接入交换机策略组的 CoPP 预过滤器策略。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

description

字符串

接入交换机策略组的描述。

equipment_flash_policy

字符串

绑定到接入交换机策略组的设备闪存策略。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

字符串

绑定到接入交换机策略组的快速链路故障转移策略。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

fibre_channel_node_policy

字符串

绑定到接入交换机策略组的光纤通道节点策略。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

fibre_channel_san_policy

字符串

绑定到接入交换机策略组的光纤通道 SAN 策略。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

forward_scale_profile_policy

字符串

绑定到接入交换机策略组的前向扩展配置文件策略。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

host

别名：hostname

字符串

Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。

如果任务中未指定此值，则将使用环境变量 ACI_HOST 的值。

lldp_policy

字符串

绑定到接入交换机策略组的 LLDP 策略。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

monitoring_policy

字符串

绑定到接入交换机策略组的监控策略。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

name

别名：policy_group

字符串

接入交换机策略组的名称。

netflow_node_policy

字符串

绑定到接入交换机策略组的 NetFlow 节点策略。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

node_802_1x_authentication_policy

字符串

绑定到接入交换机策略组的 802.1x 节点身份验证策略。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

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_node_policy

字符串

绑定到访问交换机策略组的 PoE 节点策略。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

port

整数

用于 REST 连接的端口号。

默认值取决于参数 use_ssl。

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

private_key

别名：cert_key

字符串

PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。

此值还会影响使用的默认 certificate_name。

此选项与 password 互斥。如果也提供了 password，则将被忽略。

如果任务中未指定值，则将改用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。

ptp_node_policy

字符串

绑定到访问交换机策略组的 PTP 节点策略。

仅在 APIC 版本 5.2 或更高版本中可用。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

spanning_tree_policy

字符串

绑定到访问交换机策略组的生成树策略。

仅在 APIC 版本 5.2 或更高版本中可用。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

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

switch_type

字符串 / 必填

这是叶子策略组还是脊柱策略组

选项

  • "leaf"

  • "spine"

sync_e_node_policy

字符串

绑定到访问交换机策略组的 SyncE 节点策略。

仅在 APIC 版本 5.x 或更高版本中可用。

仅当 *switch_type=leaf* 时可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

timeout

整数

以秒为单位的套接字级别超时。

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

默认值为 30。

usb_configuration_policy

字符串

绑定到访问交换机策略组的 USB 配置策略。

仅在 APIC 版本 5.2 或更高版本中可用。

APIC 默认值为 ""，这会导致在创建期间未设置时目标 DN 设置为默认策略。

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 类 infra:AccNodePGrp 和 infra:SpineAccNodePGrp 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create Leaf Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_spine
    switch_type: leaf
    spanning_tree_policy: example_spanning_tree_policy
    bfd_ipv4_policy: example_bfd_ipv4_policy
    bfd_ipv6_policy: example_bfd_ipv6_policy
    fibre_channel_node_policy: example_fibre_channel_node_policy
    poe_node_policy: example_poe_node_policy
    fibre_channel_san_policy: example_fibre_channel_san_policy
    monitoring_policy: example_monitoring_policy
    copp_policy: example_copp_policy
    forward_scale_profile_policy: example_forward_scale_profile_policy
    fast_link_failover_policy: example_fast_link_failover_policy
    node_802_1x_authentication_policy: example_node_802_1x_authentication_policy
    copp_pre_filter_policy: example_copp_pre_filter_policy
    equipment_flash_policy: example_equipment_flash_policy
    cdp_policy: example_cdp_policy
    lldp_policy: example_lldp_policy
    state: present
  delegate_to: localhost

- name: Create Spine Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_leaf
    switch_type: spine
    bfd_ipv4_policy: example_bfd_ipv4_policy
    bfd_ipv6_policy: example_bfd_ipv6_policy
    copp_policy: example_copp_policy
    copp_pre_filter_policy: example_copp_pre_filter_policy
    cdp_policy: example_cdp_policy
    lldp_policy: example_lldp_policy
    state: present
  delegate_to: localhost

- name: Delete Leaf Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_leaf
    switch_type: leaf
    state: absent
  delegate_to: localhost

- name: Query Leaf Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_leaf
    switch_type: leaf
    state: query
  delegate_to: localhost
  register: query_result

- name: Query All Leaf Access Switch Policy Groups
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_type: leaf
    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 \"/></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"

作者

  • Tim Cragg (@timcragg)

  • Akini Ross (@akinross)