cisco.meraki.networks_wireless_rf_profiles_info модуль — Модуль информации для сетей _wireless _rfprofiles
Примечание
Этот модуль является частью коллекции cisco.meraki (версия 2.18.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля потребуются дополнительные требования, см. Требования для подробностей.
Чтобы использовать его в плейбуке, укажите: cisco.meraki.networks_wireless_rf_profiles_info.
Новый в cisco.meraki 2.16.0
Обзор
- Получить все сети _wireless _rfprofiles.
- Получить сети _wireless _rfprofiles по идентификатору.
- Список профилей RF для этой сети.
- Возврат профиля RF.
Примечание
У этого модуля есть соответствующий плагин действия.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
headers dictionary | Дополнительные заголовки. |
includeTemplateProfiles boolean | Параметр запроса IncludeTemplateProfiles. Если сеть привязана к шаблону, этот параметр управляет тем, следует ли включать в ответ нестандартные профили RF, определенные в шаблоне, наряду с нестандартными профилями, определенными в привязанной сети. По умолчанию — false. Варианты:
|
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий По умолчанию: |
meraki_api_key string / required | meraki_api_key (string), API-ключ, сгенерированный на панели управления; может также быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), предшествует всем конечным точкам ресурсов По умолчанию: |
meraki_be_geo_id string | meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная среды BE_GEO_ID По умолчанию: |
meraki_caller string | meraki_caller (string), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER По умолчанию: |
meraki_certificate_path string | meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер По умолчанию: |
meraki_inherit_logging_config boolean | meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр регистратора Варианты:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), имя файла журнала с добавленной датой и временной меткой По умолчанию: |
meraki_log_path string | log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан По умолчанию: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера По умолчанию: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки при ошибке 429 Nginx По умолчанию: |
meraki_output_log boolean | meraki_output_log (boolean), создать файл выходного журнала? Варианты:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить журналы в консоль? Варианты:
|
meraki_requests_proxy string | meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS По умолчанию: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Варианты:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при других ошибках 4XX По умолчанию: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE для предотвращения изменений? Варианты:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: |
meraki_suppress_logging boolean | meraki_suppress_logging (boolean), отключить всю регистрацию? Тогда вы наедине со своими проблемами! Варианты:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (boolean), методы *list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429? Варианты:
|
networkId string | Параметр пути NetworkId. Идентификатор сети. |
rfProfileId string | Параметр пути RfProfileId. Идентификатор профиля беспроводной сети. |
Примечания
Примечание
- Используемые методы 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_, используются Cisco meraki Python SDK для установления подключения
См. также
См. также
- Документация 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_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_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 словарь | Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращаемое значение: всегда Пример: |
Ссылки на коллекцию
© 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/meraki/networks_wireless_rf_profiles_info_module.html
