Spec-Zone.ru › Ansible

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

Для использования в плейбуке укажите: cisco.aci.aci_netflow_monitor_to_exporter.

  • Описание
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Устанавливает связь между политиками Netflow Экспортера и политиками Netflow Монитора для тенентов на тканях Cisco ACI.
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

annotation

строка

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

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

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

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

certificate_name

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

строка

Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.

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

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

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

host

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

строка

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

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

netflow_exporter_policy

псевдонимы: netflow_exporter, netflow_exporter_name

строка

Имя политики Netflow Exporter.

netflow_monitor_policy

псевдонимы: netflow_monitor, netflow_monitor_name, name

строка

Имя политики Netflow Monitor.

output_level

строка

Влияет на вывод модуля ACI.

normal означает стандартный вывод, включая словарь current.

info добавляет информативный вывод, включая словари previous, proposed и sent.

debug добавляет отладочный вывод, включая словари filter_string, method, response, status и url.

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

Доступные значения:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)
END_OF_DOCUMENT_MARKER

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

Если значение не указано в задаче, будет использовано значение переменной среды 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, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.

Если значение не указано в задаче, будет использовано значение переменной среды 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, 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 Management Information Model reference

Дополнительная информация об внутренней внутренней классе APIC netflow:RsMonitorToExporter.

Руководство по Cisco ACI

Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.

Разработка модулей 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": ""}}}]

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_monitor_to_exporter_module.html

Spec-Zone.ru

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