cisco.aci.aci_fabric_switch_policy_group 模块 – 管理 Fabric Switch Policy Group 对象 (fabric:LeNodePGrp 和 fabric:SpNodePGrp)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构上的 Fabric Switch Policy Group 配置。

参数

参数	注释
analytics_cluster 字符串	分析集群的名称。需要 analytics_name 参数。
analytics_name 字符串	分析策略的名称。需要 analytics_cluster 参数。
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 的值。
core_export_policy 别名：core, core_export, fabricRsNodeCoreP 字符串	要附加到此 Fabric Switch Policy Group 的核心导出策略。
description 字符串	Fabric Switch Policy Group 的描述。
host 别名：hostname 字符串	Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将使用环境变量 ACI_HOST 的值。
inventory_policy 别名：inventory, fabricRsCallhomeInvPol 字符串	要附加到此 Fabric Switch Policy Group 的清单策略。
monitoring_policy 别名：monitoring, fabricRsMonInstFabricPol 字符串	要附加到此 Fabric Switch Policy Group 的监控策略。
name 别名：policy_group, policy_group_name 字符串	Fabric Switch Policy Group 的名称。
node_control_policy 别名：node_control, fabricRsNodeCtrl 字符串	要附加到此 Fabric Switch Policy Group 的节点控制策略。
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的值。
password 字符串	用于身份验证的密码。 此选项与private_key互斥。如果也提供了private_key，则将使用它。 如果任务中未指定值，则将使用环境变量ACI_PASSWORD或ANSIBLE_NET_PASSWORD的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数use_ssl。 如果任务中未指定值，则将使用环境变量ACI_PORT的值。
power_redundancy_policy 别名：power_redundancy, fabricRsPsuInstPol 字符串	要附加到此 Fabric Switch Policy Group 的电源冗余策略。
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
switch_type 字符串 / 必填	这是否是叶子或脊柱 Fabric Switch Policy Group。 选项 "leaf" "spine"
tech_support_export_policy 别名：tech_support, tech_support_export, fabricRsNodeTechSupP 字符串	要附加到此 Fabric Switch Policy Group 的技术支持导出策略。
timeout 整数	以秒为单位的套接字级别超时。 如果任务中未指定值，则将使用环境变量ACI_TIMEOUT的值。 默认值为 30。
twamp_responder_policy 别名：twamp_responder, fabricRsTwampResponderPol 字符串	要附加到此 Fabric Switch Policy Group 的 TWAMP Responder 策略。
twamp_server_policy 别名：twamp_server, fabricRsTwampServerPol 字符串	要附加到此 Fabric Switch Policy Group 的 TWAMP Server 策略。
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 类fabric:LeNodePGrp和fabric:SpNodePGrp的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new Fabric Leaf Policy Group
  cisco.aci.aci_fabric_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_fabric_leaf_policy_group
    switch_type: leaf
    monitoring_policy: my_monitor_policy
    inventory_policy: my_inv_policy
    state: present
    delegate_to: localhost

- name: Remove existing analytics and monitoring policy bindings from a Policy Group
  cisco.aci.aci_fabric_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_fabric_leaf_policy_group
    switch_type: leaf
    monitoring_policy: ""
    analytics_cluster: ""
    analytics_name: ""
    state: present
    delegate_to: localhost

- name: Remove a Fabric Leaf Policy Group
  cisco.aci.aci_fabric_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_fabric_leaf_policy_group
    switch_type: leaf
    state: absent
    delegate_to: localhost

- name: Query a Fabric Leaf Policy Group
  cisco.aci.aci_fabric_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_fabric_leaf_policy_group
    switch_type: leaf
    state: query
    delegate_to: localhost
    register: query_result

- name: Query all Fabric Leaf Policy Groups
  cisco.aci.aci_fabric_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>"
response 字符串	APIC 的 HTTP 响应 返回：失败或调试 示例： "OK (30 字节)"
已发送 列表 / 元素=字符串	实际/最小配置已推送到APIC 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "生产 环境"}}}
状态 整数	APIC的HTTP状态 返回：失败或调试 示例： 200
URL 字符串	用于向APIC发出请求的HTTP URL 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Tim Cragg (@timcragg)

资源链接

• 问题追踪器
• 代码库（源代码）