cisco.aci.aci_netflow_exporter_policy 模块 – 管理 Netflow 导出策略 (netflow:ExporterPol)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构中租户的 Netflow 导出策略。

• 用于引导 netflow Collection 代理的导出器信息。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定值，则将改为使用环境变量 ACI_ANNOTATION 的值。 如果任务和环境变量 ACI_ANNOTATION 中均未指定值，则将使用默认值。 默认值： "orchestrator:ansible"
associated_epg 别名：epg 字典	关联的 EPG。 要删除当前关联的 EPG，请传递一个空字典。
ap 字符串	关联的 EPG 所属的关联应用程序配置文件的名称。
epg 字符串	关联的 EPG 的名称。
tenant 字符串	关联的 AP/EPG 所属的租户的名称。
associated_extepg 别名：external_epg, associated_external_epg 字典	关联的外部 EPG。 要删除当前关联的外部 EPG，请传递一个空字典。
extepg 字符串	关联的 EPG 的名称。
l3out 字符串	关联的外部 EPG 所属的 L3Out 的名称。
tenant 字符串	关联的 L3Out/外部 EPG 所属的租户的名称。
associated_vrf 别名：vrf, context, associated_context 字典	关联的 VRF。 要删除当前关联的 VRF，请传递一个空字典。
tenant 字符串	关联的 VRF 所属的租户的名称。
vrf 字符串	关联的 VRF 的名称。
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定值，则将改为使用环境变量 ACI_CERTIFICATE_NAME 的值。
custom_source_address 字符串	自定义源 IP 地址。 只有在 source_ip_type=custom_source_ip 时才能使用。
description 别名：descr 字符串	Netflow 导出策略的描述。
destination_address 字符串	远程节点目标 IP 地址。
destination_port 字符串	远程节点目标端口。 可接受的值是任何有效的 TCP/UDP 端口范围。 在创建期间未设置时，APIC 默认值为 unspecified。
dscp 字符串	IP DSCP 值。 在创建期间未设置时，APIC 默认值为 CS2。对于 APIC 4.2 或更早版本，默认为 VA。 选项 "AF11" "AF12" "AF13" "AF21" "AF22" "AF23" "AF31" "AF32" "AF33" "AF41" "AF42" "AF43" "CS0" "CS1" "CS2" "CS3" "CS4" "CS5" "CS6" "CS7" "EF" "VA" "unspecified"
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定值，则将改为使用环境变量 ACI_HOST 的值。
netflow_exporter_policy 别名：netflow_exporter, netflow_exporter_name, name 字符串	Netflow 导出策略的名称。
output_level 字符串	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current dict 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 的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定值，则将使用环境变量 ACI_PORT 的值。
private_key 别名：cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将忽略它。 如果任务中未指定值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
source_ip_type 字符串	导出程序源 IP 地址的类型。 它可以是给定 leaf 的可用管理 IP 地址之一或自定义 IP 地址。 选项 "custom_source_ip" "inband_management_ip" "out_of_band_management_ip" "ptep"
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
tenant 别名：tenant_name 字符串	现有租户的名称。
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

备注

注意

• 在您的 playbook 中使用此模块之前，必须存在tenant。可以使用 cisco.aci.aci_tenant 来实现此目的。

• associated_epg 和 associated_extepg 是互斥的。

• 如果使用 associated_epg，则在您的 playbook 中使用此模块之前，必须存在 epg、(tenant) 和 ap。可以使用 cisco.aci.aci_epg 和 cisco.aci.aci_ap 来实现此目的。

• 如果使用 associated_extepg，则在您的 playbook 中使用此模块之前，必须存在 extepg、(tenant) 和 l3out。可以使用 cisco.aci.aci_l3out_extepg 和 cisco.aci.aci_l3out 来实现此目的。

• 如果使用 associated_vrf，则在您的 playbook 中使用此模块之前，必须存在 vrf 和 tenant。可以使用 cisco.aci.aci_vrf 来实现此目的。

另请参阅

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_vrf

管理上下文或 VRF (fv:Ctx)。

cisco.aci.aci_ap

管理顶级应用程序配置文件 (AP) 对象 (fv:Ap)。

cisco.aci.aci_epg

管理端点组 (EPG) 对象 (fv:AEPg)。

cisco.aci.aci_l3out

管理第 3 层外部 (L3Out) 对象 (l3ext:Out)。

cisco.aci.aci_l3out_extepg

管理外部网络实例配置文件 (ExtEpg) 对象 (l3ext:InstP)。

APIC 管理信息模型参考

有关内部 APIC 类 netflow:ExporterPol 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new Netflow Exporter Policy
  cisco.aci.aci_netflow_exporter_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    netflow_exporter_policy: my_netflow_exporter_policy
    dscp: CS2
    destination_address: 11.11.11.1
    destination_port: 25
    source_ip_type: custom_source_ip
    custom_source_address: 11.11.11.2
    associated_epg:
      tenant: my_tenant
      ap: my_ap
      epg: my_epg
    associated_vrf:
      tenant: my_tenant
      vrf: my_vrf
    state: present
  delegate_to: localhost

- name: Remove associated EPG and VRF from the new Netflow Exporter Policy
  cisco.aci.aci_netflow_exporter_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    netflow_exporter_policy: my_netflow_exporter_policy
    associated_epg: {}
    associated_vrf: {}
  delegate_to: localhost

- name: Query a Netflow Exporter Policy
  cisco.aci.aci_netflow_exporter_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    netflow_exporter_policy: my_netflow_exporter_policy
    state: query
  delegate_to: localhost

- name: Query all Netflow Exporter Policies in my_tenant
  cisco.aci.aci_netflow_exporter_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    state: query
  delegate_to: localhost

- name: Query all Netflow Exporter Policies
  cisco.aci.aci_netflow_exporter_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Delete a Netflow Exporter Policy
  cisco.aci.aci_netflow_exporter_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    netflow_exporter_policy: my_netflow_exporter_policy
    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"

作者

• Gaspard Micol (@gmicol)

资源链接

• 问题追踪
• 代码仓库