Модуль 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.

Чтобы использовать его в плейбуке, укажите: cisco.aci.aci_netflow_exporter_policy.

Обзор
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Управление политиками экспортера Netflow для теней на тканях Cisco ACI.
Информация об экспортере для настройки агента сбора Netflow.

Параметры

Параметр	Комментарии
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 строка	Имя L3Out, к которому относится связанный внешний EPG.
tenant строка	Имя клиента, к которому относятся связанные L3Out/внешний EPG.
associated_vrf псевдонимы: vrf, context, associated_context словарь	Связанный VRF. Для удаления текущего связанного VRF передайте пустой словарь.
tenant строка	Имя клиента, к которому относится связанный VRF.
vrf строка	Имя связанного VRF.
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `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`, если оно не задано при создании. По умолчанию значение `VA` для версий APIC 4.2 или более ранних. Варианты: `"AF11"` `"AF12"` `"AF13"` `"AF21"` `"AF22"` `"AF23"` `"AF31"` `"AF32"` `"AF33"` `"AF41"` `"AF42"` `"AF43"` `"CS0"` `"CS1"` `"CS2"` `"CS3"` `"CS4"` `"CS5"` `"CS6"` `"CS7"` `"EF"` `"VA"` `"unspecified"`

host aliases: hostname string	IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`.
netflow_exporter_policy aliases: netflow_exporter, netflow_exporter_name, name string	Имя политики экспорта Netflow.
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path string	Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, созданных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key string	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ для предоставления клиентам права владения своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OWNER_KEY`.
owner_tag string	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OWNER_TAG`.
password string	Пароль для аутентификации. Эта опция взаимоисключающая с `private_key`. Если также предоставлен `private_key`, он будет использован вместо этого. Если значение не указано в задаче, вместо него будут использованы значения переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта, который будет использоваться для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PORT`.
private_key aliases: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение `certificate_name` по умолчанию, которое используется. Эта опция взаимоисключающая с `password`. Если также предоставлен `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
source_ip_type string	Тип исходного IP-адреса экспортера. Это может быть один из доступных IP-адресов управления для данного leaf или пользовательский IP-адрес. Варианты: `"custom_source_ip"` `"inband_management_ip"` `"out_of_band_management_ip"` `"ptep"`
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения одного объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous aliases: no_previous, ignore_previous boolean	Если `true`, запрос GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию - `false`. ВНИМАНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, проверочный запрос GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию - `false`. ВНИМАНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, будет непроверяемым в одной задаче. Варианты: `false` `true`
tenant aliases: tenant_name string	Имя существующего арендатора.

timeout integer	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, используется значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Если значение не указано в задаче, используется значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию true. Варианты: `false` `true`
use_ssl boolean	Если `false`, вместо стандартного HTTPS соединения будет использоваться HTTP. Если значение не указано в задаче, используется значение переменной среды `ACI_USE_SSL`. Значение по умолчанию true при локальном подключении. Варианты: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, используется значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует установить в `false` только при работе с сайтами, которыми вы управляете, использующими самоподписанные сертификаты. Если значение не указано в задаче, используется значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию true. Варианты: `false` `true`

Примечания

Примечание

tenant должен существовать перед использованием этого модуля в вашей книге задач. Для этого можно использовать cisco.aci.aci_tenant.
associated_epg и associated_extepg взаимоисключающие.
Если используется associated_epg, то epg, tenant и ap должны существовать перед использованием этого модуля в вашей книге задач. Для этого можно использовать cisco.aci.aci_epg и cisco.aci.aci_ap.
Если используется associated_extepg, то extepg, tenant и l3out должны существовать перед использованием этого модуля в вашей книге задач. Для этого можно использовать cisco.aci.aci_l3out_extepg и cisco.aci.aci_l3out.
Если используется associated_vrf, то 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 Management Information Model reference: Более подробная информация об внутреннем классе APIC netflow:ExporterPol.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей 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": "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 строка	HTTP-метод, используемый для запроса к APIC Возвращено: неудача или отладка Пример: `"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 строка	Необработанный вывод, возвращённый API REST APIC (xml или json) Возвращено: ошибка парсинга Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response строка	HTTP-ответ от APIC Возвращено: неудача или отладка Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, отправленная в APIC Возвращено: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	HTTP-статус от APIC Возвращено: неудача или отладка Пример: `200`
url строка	HTTP-URL, используемый для запроса к APIC Возвращено: неудача или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Gaspard Micol (@gmicol)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_netflow_exporter_policy_module.html