cisco.aci.aci_netflow_monitor_to_exporter 模块 – 管理 Netflow 监控到导出器 (netflow:RsMonitorToExporter)

注意

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

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

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

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

概要 

将 Netflow 导出器策略链接到 Cisco ACI 结构上租户的 Netflow 监控策略。

参数 

参数	注释
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` 的值。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定值，则将改为使用环境变量 `ACI_HOST` 的值。
netflow_exporter_policy 别名：netflow_exporter, netflow_exporter_name 字符串	Netflow 导出器策略的名称。
netflow_monitor_policy 别名：netflow_monitor, netflow_monitor_name, name 字符串	Netflow 监控策略的名称。
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`的值。
端口整数	用于REST连接的端口号。默认值取决于参数`use_ssl`。如果任务中未指定此值，则将改用环境变量`ACI_PORT`的值。
私钥别名：cert_key 字符串	PEM格式的私钥文件或用于基于签名的身份验证的私钥内容。此值还会影响使用的默认`certificate_name`。此选项与`password`互斥。如果同时提供了`password`，则将忽略它。如果任务中未指定此值，则将改用环境变量`ACI_PRIVATE_KEY`或`ANSIBLE_NET_SSH_KEYFILE`的值。
状态字符串	使用`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_name 字符串	现有租户的名称。
超时整数	以秒为单位的套接字级别超时。如果任务中未指定此值，则将改用环境变量`ACI_TIMEOUT`的值。默认值为30。
use_proxy 布尔值	如果为`false`，即使目标主机上的环境变量中定义了代理，也不会使用代理。如果任务中未指定此值，则将改用环境变量`ACI_USE_PROXY`的值。默认值为true。选项 `false` `true`
use_ssl 布尔值	如果为`false`，将使用HTTP连接而不是默认的HTTPS连接。如果任务中未指定此值，则将改用环境变量`ACI_USE_SSL`的值。当连接为本地连接时，默认值为true。选项 `false` `true`
用户名别名：user 字符串	用于身份验证的用户名。如果任务中未指定此值，则将改用环境变量`ACI_USERNAME`或`ANSIBLE_NET_USERNAME`的值。默认值为admin。
validate_certs 布尔值	如果为`false`，则不会验证SSL证书。只有在使用自签名证书的个人控制站点上时，才应将其设置为`false`。如果任务中未指定此值，则将改用环境变量`ACI_VALIDATE_CERTS`的值。默认值为true。选项 `false` `true`

注释 

注意

在您的playbook中使用此模块之前，必须存在租户、netflow_monitor_policy和netflow_exporter_policy。cisco.aci.aci_tenant、cisco.aci.aci_netflow_monitor_policy、cisco.aci.aci_netflow_exporter_policy可用于此目的。

另请参阅 

另请参阅

cisco.aci.aci_tenant: 管理租户 (fv:Tenant)。
cisco.aci.aci_netflow_monitor_policy: 管理Netflow监控策略 (netflow:MonitorPol)。
cisco.aci.aci_netflow_exporter_policy: 管理Netflow导出策略 (netflow:ExporterPol)。
APIC管理信息模型参考: 有关内部APIC类netflow:RsMonitorToExporter的更多信息。
Cisco ACI指南: 有关如何使用Ansible管理ACI基础设施的详细信息。
开发Cisco ACI模块: 有关如何编写您自己的Cisco ACI模块以进行贡献的详细指南。

示例 

- name: Add a new Netflow Monitor Policy
  cisco.aci.aci_netflow_monitor_to_exporter:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    netflow_monitor_policy: my_netflow_monitor_policy
    netflow_exporter_policy: my_netflow_exporter_policy
    state: present
  delegate_to: localhost

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

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

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

- name: Delete a Netflow Monitor Policy
  cisco.aci.aci_netflow_monitor_to_exporter:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    netflow_monitor_policy: my_netflow_monitor_policy
    netflow_exporter_policy: my_netflow_exporter_policy
    state: absent
  delegate_to: localhost

返回值 

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

键	描述
current 列表 / 元素=字符串	模块完成后从APIC获取的现有配置返回：成功示例：`[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
错误字典	APIC返回的错误信息返回：失败示例：`{"code": "122", "text": "unknown managed object class foo"}`
filter_string 字符串	用于请求的过滤器字符串返回：失败或调试示例：`"?rsp-prop-include=config-only"`
方法字符串	用于向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 字节)"`
已发送列表 / 元素=字符串	实际/最小配置已推送到APIC 返回：信息示例： `{"fvTenant": {"attributes": {"descr": "生产环境"}}}`
状态整数	APIC返回的HTTP状态码返回：失败或调试示例： `200`
URL 字符串	用于向APIC发出请求的HTTP URL 返回：失败或调试示例： `"https://10.11.12.13/api/mo/uni/tn-production.json"`

作者

Gaspard Micol (@gmicol)

参数	注释
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` 的值。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定值，则将改为使用环境变量 `ACI_HOST` 的值。
netflow_exporter_policy 别名：netflow_exporter, netflow_exporter_name 字符串	Netflow 导出器策略的名称。
netflow_monitor_policy 别名：netflow_monitor, netflow_monitor_name, name 字符串	Netflow 监控策略的名称。
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`的值。
端口整数	用于REST连接的端口号。默认值取决于参数`use_ssl`。如果任务中未指定此值，则将改用环境变量`ACI_PORT`的值。
私钥别名：cert_key 字符串	PEM格式的私钥文件或用于基于签名的身份验证的私钥内容。此值还会影响使用的默认`certificate_name`。此选项与`password`互斥。如果同时提供了`password`，则将忽略它。如果任务中未指定此值，则将改用环境变量`ACI_PRIVATE_KEY`或`ANSIBLE_NET_SSH_KEYFILE`的值。
状态字符串	使用`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_name 字符串	现有租户的名称。
超时整数	以秒为单位的套接字级别超时。如果任务中未指定此值，则将改用环境变量`ACI_TIMEOUT`的值。默认值为30。
use_proxy 布尔值	如果为`false`，即使目标主机上的环境变量中定义了代理，也不会使用代理。如果任务中未指定此值，则将改用环境变量`ACI_USE_PROXY`的值。默认值为true。选项 `false` `true`
use_ssl 布尔值	如果为`false`，将使用HTTP连接而不是默认的HTTPS连接。如果任务中未指定此值，则将改用环境变量`ACI_USE_SSL`的值。当连接为本地连接时，默认值为true。选项 `false` `true`
用户名别名：user 字符串	用于身份验证的用户名。如果任务中未指定此值，则将改用环境变量`ACI_USERNAME`或`ANSIBLE_NET_USERNAME`的值。默认值为admin。
validate_certs 布尔值	如果为`false`，则不会验证SSL证书。只有在使用自签名证书的个人控制站点上时，才应将其设置为`false`。如果任务中未指定此值，则将改用环境变量`ACI_VALIDATE_CERTS`的值。默认值为true。选项 `false` `true`