модуль cisco.meraki.organizations_wireless_air_marshal_rules_info — информационный модуль для правил _wireless _air _marshal _rules организаций

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений о правилах Wireless Air Marshal организации.
Получение всех правил _wireless _air _marshal _rules организаций.
Возвращает текущие правила Air Marshal для этой организации.

Примечание

Этому модулю соответствует модуль действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string), направление пагинации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений о правилах Wireless Air Marshal организации. Параметр запроса EndingBefore. Токен, с помощью которого сервер указывает конец страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повтором при ошибке параллелизма пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный на панели управления; его также можно задать в переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), базовый URL, добавляемый перед всеми ресурсами конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; его также можно задать в переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату для проверки TLS/SSL при работе за локальным прокси-сервером По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследовать собственный экземпляр логгера Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для записи журнала; если не задан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), максимальное число повторных попыток при ошибках 429 или других ошибках на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повтором при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт для HTTPS, если необходимо По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять попытку при возникновении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания перед повтором при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное время выполнения каждого вызова API в секундах По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить ведение всех журналов? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторять попытку при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
networkIds list / элементы=string	Информационный модуль для получения сведений о правилах Wireless Air Marshal организации. Параметр запроса NetworkIds. (необязательно) Набор идентификаторов сетей, которые необходимо включить.
organizationId string	Информационный модуль для получения сведений о правилах Wireless Air Marshal организации. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений о правилах Wireless Air Marshal организации. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: от 3 до 1000. Значение по умолчанию — 1000.
startingAfter string	Информационный модуль для получения сведений о правилах Wireless Air Marshal организации. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить общее число результатов до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

Используемые методы SDK: wireless.Wireless.get_organization_wireless_air_marshal_rules,
Используемые пути: get /organizations/{organizationId}/wireless/airMarshal/rules,
Поддерживает check_mode
Плагин запускается на управляющем узле и не использует плагины подключения Ansible, а использует встроенный менеджер подключений Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки подключения

См. также

Документация Cisco Meraki для wireless getOrganizationWirelessAirMarshalRules: Полное описание API getOrganizationWirelessAirMarshalRules.

Примеры

- name: Get all organizations _wireless _air _marshal _rules
  cisco.meraki.organizations_wireless_air_marshal_rules_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 }}"
    networkIds: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"items": [{"createdAt": "string", "match": {"string": "string", "type": "string"}, "network": {"id": "string", "name": "string"}, "ruleId": "string", "type": "string", "updatedAt": "string"}], "meta": {"counts": {"items": {"total": 0}}}}`

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"items": [{"createdAt": "string", "match": {"string": "string", "type": "string"}, "network": {"id": "string", "name": "string"}, "ruleId": "string", "type": "string", "updatedAt": "string"}], "meta": {"counts": {"items": {"total": 0}}}}

Авторы

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