Spec-Zone.ru › Ansible

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

Пользовательская строка для аннотирования объекта.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_ANNOTATION.

Если значение не указано в задаче и переменная среды ACI_ANNOTATION, будет использовано значение по умолчанию.

По умолчанию: "orchestrator:ansible"

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, который используется для аутентификации на основе подписи.

Если указан файл private_key, по умолчанию используется имя файла private_key без расширения.

Если для private_key указано содержимое в формате PEM, по умолчанию используется значение username.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_CERTIFICATE_NAME.

custom_source_address

string

Пользовательский IP-адрес источника.

Его можно использовать только при условии source_ip_type=custom_source_ip.

description

псевдонимы: descr

string

Описание политики экспортера NetFlow.

destination_address

string

IP-адрес назначения удаленного узла.

destination_port

string

Порт назначения удаленного узла.

Допустимы любые корректные диапазоны портов TCP/UDP.

Если при создании значение не задано, APIC использует unspecified.

dscp

string

Значение 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

string

IP-адрес или имя узла APIC, доступное для разрешения на управляющем узле Ansible.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_HOST.

netflow_exporter_policy

псевдонимы: 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

псевдонимы: 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

псевдонимы: no_previous, ignore_previous

boolean

Если true, перед отправкой POST-запроса на обновление в APIC не будет выполняться GET-запрос для проверки предыдущего состояния.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым.

Предыдущее состояние объекта не будет проверено, а POST-запрос на обновление будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после отправки POST-запроса на обновление в APIC не будет выполняться проверочный GET-запрос.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате текущему возвращаемому значению будет присвоено предложенное значение.

Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи.

Варианты:

  • false
  • true

tenant

псевдонимы: 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

псевдонимы: 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

Дополнительная информация о внутреннем классе 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

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Информация об ошибке, возвращенная APIC

Возвращается: failure

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная для запроса

Возвращается: failure or debug

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до запуска модуля

Возвращается: info

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе параметров, предоставленных пользователем

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Необработанный вывод, возвращенный REST API APIC (xml или json)

Возвращается: parse error

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: failure or debug

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, переданная в APIC

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: failure or debug

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Gaspard Micol (@gmicol)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API