Модуль cisco.meraki.networks_wireless_rf_profiles_info — информационный модуль для networks _wireless _rfprofiles
Примечание
Этот модуль является частью коллекции cisco.meraki (версия 2.23.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_wireless_rf_profiles_info.
Добавлено в cisco.meraki 1.0.0
Краткое описание
- Информационный модуль Networks Wireless Rfprofiles Info.
- Получение всех networks _wireless _rfprofiles.
- Получение networks _wireless _rfprofiles по идентификатору.
- Список RF-профилей для этой сети.
- Возврат RF-профиля.
Примечание
Этому модулю соответствует плагин действий.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
headers dictionary | Дополнительные заголовки. |
includeTemplateProfiles boolean | Информационный модуль Networks Wireless Rfprofiles Info. Параметр запроса IncludeTemplateProfiles. Если сеть привязана к шаблону, этот параметр определяет, следует ли включать в ответ нестандартные RF-профили, заданные в шаблоне, наряду с нестандартными профилями, заданными в привязанной сети. По умолчанию — false. Варианты:
|
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (целое число), время ожидания перед повтором пакета действий при ошибке параллельного выполнения По умолчанию: |
meraki_api_key string / обязательный | meraki_api_key (строка), ключ API, созданный на панели управления; также можно задать как переменную окружения MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (строка), базовый URL для всех конечных точек По умолчанию: |
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 (логическое значение), наследовать ваш экземпляр регистратора Варианты:
|
meraki_log_file_prefix string | meraki_log_file_prefix (строка), имя файла журнала с добавленными датой и временем По умолчанию: |
meraki_log_path string | log_path (строка), путь для выходного файла журнала; если не указан, используется рабочий каталог скрипта По умолчанию: |
meraki_maximum_retries integer | meraki_maximum_retries (целое число), количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повтором при ошибке Nginx 429 По умолчанию: |
meraki_output_log boolean | meraki_output_log (логическое значение), создавать выходной файл журнала? Варианты:
|
meraki_print_console boolean | meraki_print_console (логическое значение), выводить журнал в консоль? Варианты:
|
meraki_requests_proxy string | meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если он требуется По умолчанию: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (логическое значение), повторять запрос при других ошибках 4XX (кроме 429)? Варианты:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором при других ошибках 4XX По умолчанию: |
meraki_simulate boolean | meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API По умолчанию: |
meraki_suppress_logging boolean | meraki_suppress_logging (логическое значение), отключить все ведение журнала? Тогда действуйте на свой страх и риск! Варианты:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (логическое значение), повторять запрос при ошибке ограничения частоты запросов 429? Варианты:
|
networkId string | Информационный модуль Networks Wireless Rfprofiles Info. Параметр пути NetworkId. Идентификатор сети. |
rfProfileId string | Информационный модуль Networks Wireless Rfprofiles Info. Параметр пути RfProfileId. Идентификатор RF-профиля. |
Примечания
Примечание
- Используемые методы SDK: wireless.Wireless.get_network_wireless_rf_profile, wireless.Wireless.get_network_wireless_rf_profiles,
- Используемые пути: get /networks/{networkId}/wireless/rfProfiles, get /networks/{networkId}/wireless/rfProfiles/{rfProfileId},
- Поддерживает
check_mode - Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо них использует встроенный диспетчер подключений из Cisco meraki SDK
- Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки соединения
См. также
См. также
- Документация Cisco Meraki для wireless getNetworkWirelessRfProfile
-
Полное описание API getNetworkWirelessRfProfile.
- Документация Cisco Meraki для wireless getNetworkWirelessRfProfiles
-
Полное описание API getNetworkWirelessRfProfiles.
Примеры
- name: Get all networks _wireless _rfprofiles
cisco.meraki.networks_wireless_rf_profiles_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 }}"
includeTemplateProfiles: true
networkId: string
register: result
- name: Get networks _wireless _rfprofiles by id
cisco.meraki.networks_wireless_rf_profiles_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 }}"
networkId: string
rfProfileId: string
register: result
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meraki_response dictionary | Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/networks_wireless_rf_profiles_info_module.html
