модуль cisco.aci.aci_netflow_exporter_policy — управление политикой экспортера NetFlow (netflow:ExporterPol)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать коллекцию в плейбуке, укажите: cisco.aci.aci_netflow_exporter_policy.
Краткое описание
- Управление политиками экспортеров NetFlow для арендаторов в фабриках Cisco ACI.
- Информация об экспортере для начальной настройки агента сбора данных NetFlow.
Параметры
Параметр | Комментарии |
|---|---|
annotation string | Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Если значение не указано в задаче и переменная среды По умолчанию: |
associated_epg псевдонимы: epg dictionary | Связанная EPG. Чтобы удалить текущую связанную EPG, передайте пустой словарь. |
|
ap string |
Имя связанного профиля приложения, к которому относится связанная EPG. |
|
epg string |
Имя связанной EPG. |
|
tenant string |
Имя арендатора, которому принадлежат связанная AP/EPG. |
associated_extepg псевдонимы: external_epg, associated_external_epg dictionary | Связанная внешняя EPG. Чтобы удалить текущую связанную внешнюю EPG, передайте пустой словарь. |
|
extepg string |
Имя связанной EPG. |
|
l3out string |
Имя L3Out, к которому относится связанная внешняя EPG. |
|
tenant string |
Имя арендатора, которому принадлежат связанная L3Out/внешняя EPG. |
associated_vrf псевдонимы: vrf, context, associated_context dictionary | Связанная VRF. Чтобы удалить текущую связанную VRF, передайте пустой словарь. |
|
tenant string |
Имя арендатора, которому принадлежит связанная VRF. |
|
vrf string |
Имя связанной VRF. |
certificate_name псевдонимы: cert_name string | Имя сертификата X.509, связанного с пользователем AAA APIC, который используется для аутентификации на основе подписи. Если указан файл Если для Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
custom_source_address string | Пользовательский IP-адрес источника. Его можно использовать только при условии |
description псевдонимы: descr string | Описание политики экспортера NetFlow. |
destination_address string | IP-адрес назначения удаленного узла. |
destination_port string | Порт назначения удаленного узла. Допустимы любые корректные диапазоны портов TCP/UDP. Если при создании значение не задано, APIC использует |
dscp string | Значение IP DSCP. Если при создании значение не задано, APIC использует Варианты:
|
host псевдонимы: hostname string | IP-адрес или имя узла APIC, доступное для разрешения на управляющем узле Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
netflow_exporter_policy псевдонимы: netflow_exporter, netflow_exporter_name, name string | Имя политики экспортера NetFlow. |
output_level string | Управляет выводом этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
output_path string | Путь к файлу, в который будут записываться созданные модулем объекты конфигурации ACI в формате JSON. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
owner_key string | Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для сопоставления сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
owner_tag string | Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
password string | Пароль для аутентификации. Этот параметр несовместим с Если значение не указано в задаче, вместо него будут использованы значения переменных среды |
port integer | Номер порта для REST-подключения. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
private_key псевдонимы: cert_key string | Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на используемое значение Этот параметр несовместим с Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
source_ip_type string | Тип IP-адреса источника экспортера. Это может быть один из доступных IP-адресов управления для заданного leaf-коммутатора либо пользовательский IP-адрес. Варианты:
|
state string | Для добавления или удаления используйте Для вывода одного или нескольких объектов используйте Варианты:
|
suppress_previous псевдонимы: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию: ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым. Предыдущее состояние объекта не будет проверено, а POST-запрос на обновление будет содержать все свойства. Варианты:
|
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию: ПРЕДУПРЕЖДЕНИЕ — в результате текущему возвращаемому значению будет присвоено предложенное значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты:
|
tenant псевдонимы: tenant_name string | Имя существующего арендатора. |
timeout integer | Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — 30. |
use_proxy boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды При локальном подключении значение по умолчанию — true. Варианты:
|
username псевдонимы: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды Значение по умолчанию — admin. |
validate_certs boolean | Если Задавайте значение Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — 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
-
Дополнительная информация о внутреннем классе 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 list / elements=string | Текущая конфигурация APIC после выполнения модуля Возвращается: success Пример: |
error dictionary | Информация об ошибке, возвращенная APIC Возвращается: failure Пример: |
filter_string string | Строка фильтра, использованная для запроса Возвращается: failure or debug Пример: |
method string | Метод HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: |
previous list / elements=string | Исходная конфигурация APIC до запуска модуля Возвращается: info Пример: |
proposed dictionary | Сформированная конфигурация на основе параметров, предоставленных пользователем Возвращается: info Пример: |
raw string | Необработанный вывод, возвращенный REST API APIC (xml или json) Возвращается: parse error Пример: |
response string | Ответ HTTP от APIC Возвращается: failure or debug Пример: |
sent list / elements=string | Фактическая/минимальная конфигурация, переданная в APIC Возвращается: info Пример: |
status integer | Статус HTTP от APIC Возвращается: failure or debug Пример: |
url string | URL HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_netflow_exporter_policy_module.html