Spec-Zone.ru › Ansible

cisco.aci.aci_bd_to_netflow_monitor_policy модуль — Привязка домена Bridge к политике мониторинга Netflow (fv:RsBDToNetflowMonitorPol)

Примечание

Этот модуль является частью коллекции cisco.aci (версия 2.10.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.aci.

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

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

Описание

  • Привязка домена Bridge к политике мониторинга Netflow на тканях Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

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

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

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

Default: "orchestrator:ansible"

bd

aliases: bd_name, bridge_domain

string

Имя моста.

certificate_name

aliases: cert_name

string

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

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

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

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

filter_type

aliases: filter, type

string

Выбор типа фильтра при настройке политик мониторинга NetFlow.

Choices:

  • "ce"
  • "ipv4"
  • "ipv6"
  • "unspecified"

host

aliases: hostname

string

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

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

netflow_monitor_policy

aliases: netflow_monitor, netflow_monitor_name, name

string

Имя политики мониторинга NetFlow.

output_level

string

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

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

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

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

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

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

output_path

string

Путь к файлу, который будет использоваться для сохранения сгенерированных модулем объектов конфигурации ACI в формате JSON.

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

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.

state

string

Используйте present или absent для добавления или удаления.

Используйте query для отображения одного или нескольких объектов.

Choices:

  • "absent"
  • "present" ← (default)
  • "query"

suppress_previous

aliases: no_previous, ignore_previous

boolean

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

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

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

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

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

Choices:

  • false
  • true

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

Примечания

Примечание

  • Параметры bd и netflow_monitor_policy должны существовать перед использованием данного модуля. Для этого можно использовать модули cisco.aci.aci_bd и aci_netflow_monitor_policy.

См. также

См. также

cisco.aci.aci_bd

Управление объектами Bridge Domains (BD) (fv:BD).

cisco.aci.aci_netflow_monitor_policy

Управление политикой Netflow Monitor (netflow:MonitorPol).

APIC Management Information Model reference

Дополнительная информация о внутреннем классе APIC fv:RsBDToNetflowMonitorPol.

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

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

Разработка модулей Cisco ACI

Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Bind Bridge Domain to Netflow Monitor Policy
  cisco.aci.aci_bd_to_netflow_monitor_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    bd: web_servers
    netflow_monitor_policy: prod_netflow_monitor_policy
    tenant: prod
    filter_type: ipv4
    state: present
  delegate_to: localhost

- name: Query all Bridge Domains bound to Netflow Monitor Policy
  cisco.aci.aci_bd_to_netflow_monitor_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: true
    state: query
  delegate_to: localhost
  register: query_result

- name: Query specific Bridge Domain(s) bound to an Netflow Monitor Policy
  cisco.aci.aci_bd_to_netflow_monitor_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: true
    bd: web_servers
    netflow_monitor_policy: prod_netflow_monitor_policy
    tenant: prod
    state: query
  delegate_to: localhost
  register: query_result

- name: Unbind Bridge Domain from Netflow Monitor Policy
  cisco.aci.aci_bd_to_netflow_monitor_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: true
    bd: web_servers
    netflow_monitor_policy: prod_netflow_monitor_policy
    tenant: prod
    filter_type: ipv4
    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"

Авторы

  • Samita Bhattacharjee (@samitab)

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

  • Система отслеживания задач
  • Репозиторий (Исходный код)

© 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_bd_to_netflow_monitor_policy_module.html

Spec-Zone.ru

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