Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_adaptive_policy_policies_info — информационный модуль для organizations _adaptivepolicy _policies

Примечание

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

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

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

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

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

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

Обзор

  • Информационный модуль для Organizations Adaptivepolicy Policies Info.
  • Получить все organizations _adaptivepolicy _policies.
  • Получить organizations _adaptivepolicy _policies по идентификатору.
  • Вывести список адаптивных политик организации.
  • Вернуть адаптивную политику.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

headers

словарь

Дополнительные заголовки.

id

строка

Информационный модуль для Organizations Adaptivepolicy Policies Info.

Параметр пути id.

meraki_action_batch_retry_wait_time

целое число

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

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

meraki_api_key

строка / обязательный

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

meraki_base_url

строка

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

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

meraki_be_geo_id

строка

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

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

meraki_certificate_path

строка

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

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

meraki_inherit_logging_config

логическое значение

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

Варианты:

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

meraki_log_file_prefix

строка

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

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

meraki_log_path

строка

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

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

meraki_maximum_retries

целое число

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

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

meraki_nginx_429_retry_wait_time

целое число

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

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

meraki_output_log

логическое значение

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

Варианты:

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

meraki_print_console

логическое значение

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

Варианты:

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

meraki_requests_proxy

строка

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

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

meraki_retry_4xx_error

логическое значение

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

Варианты:

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

meraki_retry_4xx_error_wait_time

целое число

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

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

meraki_simulate

логическое значение

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

Варианты:

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

meraki_single_request_timeout

целое число

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

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

meraki_suppress_logging

логическое значение

meraki_suppress_logging (логическое значение) — отключить ведение журнала? Тогда вы сами за себя!

Варианты:

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

meraki_use_iterator_for_get_pages

логическое значение

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

Варианты:

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

meraki_wait_on_rate_limit

логическое значение

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

Варианты:

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

organizationId

строка

Информационный модуль для Organizations Adaptivepolicy Policies Info.

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

Примечания

Примечание

  • Используются методы SDK organizations.Organizations.get_organization_adaptive_policy_policies, organizations.Organizations.get_organization_adaptive_policy_policy,
  • Используются пути get /organizations/{organizationId}/adaptivePolicy/policies, get /organizations/{organizationId}/adaptivePolicy/policies/{id},
  • Поддерживает check_mode
  • Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а использует встроенный менеджер подключений из Cisco meraki SDK
  • Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки соединения

См. также

См. также

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

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

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

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

Примеры

- name: Get all organizations _adaptivepolicy _policies
  cisco.meraki.organizations_adaptive_policy_policies_info:
    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 }}"
    organizationId: string
  register: result
- name: Get organizations _adaptivepolicy _policies by id
  cisco.meraki.organizations_adaptive_policy_policies_info:
    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 }}"
    organizationId: string
    id: string
  register: result

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

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"acls": [{"id": "string", "name": "string"}], "adaptivePolicyId": "string", "createdAt": "string", "destinationGroup": {"id": "string", "name": "string", "sgt": 0}, "lastEntryRule": "string", "sourceGroup": {"id": "string", "name": "string", "sgt": 0}, "updatedAt": "string"}

Авторы

  • 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_adaptive_policy_policies_info_module.html

Spec-Zone.ru

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