Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_assurance_alerts_dismiss – модуль ресурса для organizations _assurance _alerts _dismiss

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

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

Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.organizations_assurance_alerts_dismiss.

Добавлено в cisco.meraki 1.0.0

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

Краткое описание

  • Управление операцией создания ресурса organizations _assurance _alerts _dismiss.
  • Отклонение предупреждений о состоянии.

Примечание

Этому модулю соответствует плагин действия.

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Описание

alertIds

list / элементы=string

Массив идентификаторов предупреждений для отклонения.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (целое число), время ожидания перед повтором пакетного действия при ошибке параллельного выполнения

По умолчанию: 60

meraki_api_key

string / обязательный

meraki_api_key (строка), ключ API, созданный в панели управления; также можно задать с помощью переменной окружения MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (строка), базовый URL для всех ресурсов конечных точек

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также можно задать с помощью переменной окружения BE_GEO_ID

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

meraki_certificate_path

string

meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер

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

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (логическое значение), наследовать собственный экземпляр средства ведения журнала

Варианты:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (строка), к имени файла журнала добавляются дата и временная метка

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

meraki_log_path

string

log_path (строка), путь для сохранения журнала; если не указан, используется рабочий каталог скрипта

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

meraki_maximum_retries

integer

meraki_maximum_retries (целое число), максимальное количество повторных попыток при ошибках 429 или других ошибках на стороне сервера

По умолчанию: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повтором при ошибке Nginx 429

По умолчанию: 60

meraki_output_log

boolean

meraki_output_log (логическое значение), создавать файл журнала вывода?

Варианты:

  • false
  • true ← (по умолчанию)

meraki_print_console

boolean

meraki_print_console (логическое значение), выводить журнал в консоль?

Варианты:

  • false
  • true ← (по умолчанию)

meraki_requests_proxy

string

meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если он требуется

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

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (логическое значение), повторять запрос при возникновении других ошибок 4XX (кроме 429)?

Варианты:

  • false ← (по умолчанию)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором при других ошибках 4XX

По умолчанию: 60

meraki_simulate

boolean

meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений?

Варианты:

  • false ← (по умолчанию)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (целое число), максимальное время выполнения каждого вызова API в секундах

По умолчанию: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (логическое значение), отключить ведение всех журналов? В таком случае вы действуете на свой страх и риск!

Варианты:

  • false ← (по умолчанию)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов

Варианты:

  • false ← (по умолчанию)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (логическое значение), повторять запрос при возникновении ошибки ограничения частоты запросов 429?

Варианты:

  • false
  • true ← (по умолчанию)

organizationId

string

Параметр пути OrganizationId. Идентификатор организации.

Примечания

Примечание

  • Используемый метод SDK: organizations.Organizations.dismiss_organization_assurance_alerts,
  • Используемый путь: post /organizations/{organizationId}/assurance/alerts/dismiss,
  • Не поддерживает check_mode
  • Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений
  • из Cisco Dashboard API Python(SDK)
  • Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления подключения

См. также

См. также

Документация Cisco Meraki для organizations dismissOrganizationAssuranceAlerts

Полный справочник по API dismissOrganizationAssuranceAlerts.

Примеры

- name: Create
  cisco.meraki.organizations_assurance_alerts_dismiss:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    alertIds:
      - '1234'
      - '4567'
    organizationId: string

Возвращаемые значения

Общие возвращаемые значения описаны здесь; далее перечислены поля, уникальные для этого модуля:

Ключ

Описание

meraki_response

dictionary

Словарь или список с ответом, возвращённым Python SDK Cisco Meraki

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

Пример: {}

Авторы

  • Francisco Munoz (@fmunoz)

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

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

© 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/meraki/organizations_assurance_alerts_dismiss_module.html

Spec-Zone.ru

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