cisco.meraki.networks_wireless_ssids_hotspot20 module – Модуль ресурсов для networks _wireless _ssids _hotspot20
Примечание
Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_wireless_ssids_hotspot20.
Добавлено в cisco.meraki 1.0.0
Краткое описание
- Управление операцией update ресурса networks _wireless _ssids _hotspot20.
- Обновление настроек Hotspot 2.0 для SSID.
Примечание
Для этого модуля имеется соответствующий плагин действий.
Требования
На узле, выполняющем этот модуль, необходимы следующие компоненты.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
domains list / elements=string | Массив доменных имён. |
enabled boolean | Включён ли Hotspot 2.0 для этого SSID. Варианты:
|
mccMncs list / elements=dictionary | Массив пар MCC/MNC. |
|
mcc string |
Значение MCC. |
|
mnc string |
Значение MNC. |
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: |
meraki_api_key string / обязательный | meraki_api_key (string), ключ API, созданный в панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), базовый URL для всех ресурсов конечных точек По умолчанию: |
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), наследовать экземпляр собственного регистратора Варианты:
|
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), время ожидания перед повторной попыткой при ошибке Nginx 429 По умолчанию: |
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? Варианты:
|
naiRealms list / elements=dictionary | Массив областей NAI. |
|
format string |
Формат области (‘1’ или ‘0’). |
|
methods list / elements=dictionary |
Массив методов EAP для области. |
|
authenticationTypes dictionary |
Типы аутентификации для метода. Они должны быть представлены в виде объекта, где ключом служит название категории метода EAP в camelCase, а значением — список типов (nonEapInnerAuthentication: Reserved, PAP, CHAP, MSCHAP, MSCHAPV2; eapInnerAuthentication: EAP-TLS, EAP-SIM, EAP-AKA, EAP-TTLS with MSCHAPv2; credentials: SIM, USIM, NFC Secure Element, Hardware Token, Softoken, Certificate, username/password, none, Reserved, Vendor Specific; tunneledEapMethodCredentials: SIM, USIM, NFC Secure Element, Hardware Token, Softoken, Certificate, username/password, Reserved, Anonymous, Vendor Specific). |
|
credentials list / elements=string |
Массив учётных данных. |
|
eapInnerAuthentication list / elements=string |
Массив типов внутренней аутентификации EAP. |
|
nonEapInnerAuthentication list / elements=string |
Массив типов внутренней аутентификации без EAP. |
|
tunneledEapMethodCredentials list / elements=string |
Массив учётных данных для туннелированных методов EAP. |
|
id string |
Идентификатор метода. |
|
realm string |
Название области. |
networkAccessType string | Тип сети этого SSID (‘Private network’, ‘Private network with guest access’, ‘Chargeable public network’, ‘Free public network’, ‘Personal device network’, ‘Emergency services only network’, ‘Test or experimental’, ‘Wildcard’). |
networkId string | Параметр пути NetworkId. Идентификатор сети. |
number string | Параметр пути Number. |
operator dictionary | Настройки оператора для этого SSID. |
|
name string |
Название оператора. |
roamConsortOis list / elements=string | Массив OI роуминговых консорциумов (шестнадцатеричное число длиной 3–5 октетов). |
venue dictionary | Настройки места проведения для этого SSID. |
|
name string |
Название места проведения. |
|
type string |
Тип места проведения (‘Unspecified’, ‘Unspecified Assembly’, ‘Arena’, ‘Stadium’, ‘Passenger Terminal’, ‘Amphitheater’, ‘Amusement Park’, ‘Place of Worship’, ‘Convention Center’, ‘Library’, ‘Museum’, ‘Restaurant’, ‘Theater’, ‘Bar’, ‘Coffee Shop’, ‘Zoo or Aquarium’, ‘Emergency Coordination Center’, ‘Unspecified Business’, ‘Doctor or Dentist office’, ‘Bank’, ‘Fire Station’, ‘Police Station’, ‘Post Office’, ‘Professional Office’, ‘Research and Development Facility’, ‘Attorney Office’, ‘Unspecified Educational’, ‘School, Primary’, ‘School, Secondary’, ‘University or College’, ‘Unspecified Factory and Industrial’, ‘Factory’, ‘Unspecified Institutional’, ‘Hospital’, ‘Long-Term Care Facility’, ‘Alcohol and Drug Rehabilitation Center’, ‘Group Home’, ‘Prison or Jail’, ‘Unspecified Mercantile’, ‘Retail Store’, ‘Grocery Market’, ‘Automotive Service Station’, ‘Shopping Mall’, ‘Gas Station’, ‘Unspecified Residential’, ‘Private Residence’, ‘Hotel or Motel’, ‘Dormitory’, ‘Boarding House’, ‘Unspecified Storage’, ‘Unspecified Utility and Miscellaneous’, ‘Unspecified Vehicular’, ‘Automobile or Truck’, ‘Airplane’, ‘Bus’, ‘Ferry’, ‘Ship or Boat’, ‘Train’, ‘Motor Bike’, ‘Unspecified Outdoor’, ‘Muni-mesh Network’, ‘City Park’, ‘Rest Area’, ‘Traffic Control’, ‘Bus Stop’, ‘Kiosk’). |
Примечания
Примечание
- Используемый метод SDK: wireless.Wireless.update_network_wireless_ssid_hotspot20,
- Используемый путь: put /networks/{networkId}/wireless/ssids/{number}/hotspot20,
- Не поддерживает
check_mode - Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений
- из Cisco Dashboard API Python(SDK)
- Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления подключения
См. также
См. также
- Документация Cisco Meraki по wireless updateNetworkWirelessSsidHotspot20
-
Полный справочник по API updateNetworkWirelessSsidHotspot20.
Примеры
- name: Update all
cisco.meraki.networks_wireless_ssids_hotspot20:
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 }}"
state: present
domains:
- meraki.local
- domain2.com
enabled: true
mccMncs:
- mcc: '123'
mnc: '456'
naiRealms:
- format: '1'
methods:
- authenticationTypes:
credentials: []
eapInnerAuthentication:
- EAP-TTLS with MSCHAPv2
nonEapInnerAuthentication:
- MSCHAP
tunneledEapMethodCredentials: []
id: '1'
realm: Realm 1
networkAccessType: Private network
networkId: string
number: string
operator:
name: Meraki Product Management
roamConsortOis:
- ABC123
- 456EFG
venue:
name: SF Branch
type: Unspecified Assembly
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_ssids_hotspot20_module.html