Модуль cisco.meraki.networks_wireless_ssids_hotspot20 – Модуль ресурсов для сетей _wireless _ssids _hotspot20

Примечание

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

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

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

Для использования в книге задач укажите: cisco.meraki.networks_wireless_ssids_hotspot20.

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

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

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

Управление обновлением операций ресурса 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. Варианты: `false` `true`
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), время ожидания повторной попытки при ошибке параллельной обработки действий По умолчанию: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; может быть также установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем конечным точкам ресурсов По умолчанию: `"https://api.meraki.com/api/v1"`
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), наследует ваш собственный экземпляр логгера Варианты: `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` ← (по умолчанию)
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).
id string	Идентификатор метода.
realm string	Название области.
networkAccessType string	Тип сети данного SSID (‘Сеть Private network’, ‘Сеть Private network с гостевым доступом’, ‘Платная публичная сеть’, ‘Бесплатная публичная сеть’, ‘Сеть личного устройства’, ‘Только сеть экстренных служб’, ‘Тестовая или экспериментальная сеть’, ‘Подстановка’).
networkId string	Параметр пути networkId. Идентификатор сети.
number string	Параметр пути number.
operator dictionary	Настройки оператора для данного SSID.
name string	Имя оператора.
roamConsortOis list / elements=string	Массив идентификаторов консорциума роуминга (шестнадцатеричное число длиной от 3 до 5 октетов).
venue dictionary	Настройки места для данного SSID.
name string	Имя места.

END_OF_DOCUMENT_MARKER

тип

строка

Тип помещения ('Не указано', 'Не указанное собрание', 'Арена', 'Стадион', 'Пассажирский терминал', 'Амфитеатр', 'Парк развлечений', 'Место поклонения', 'Конгресс-центр', 'Библиотека', 'Музей', 'Ресторан', 'Театр', 'Бар', 'Кофейня', 'Зоопарк или аквариум', 'Центр координации чрезвычайных ситуаций', 'Не указанный бизнес', 'Кабинет врача или стоматолога', 'Банк', 'Пожарная станция', 'Полицейский участок', 'Почтовое отделение', 'Профессиональный офис', 'Учебный центр исследований и разработок', 'Юридическая консультация', 'Не указанное образование', 'Начальная школа', 'Средняя школа', 'Университет или колледж', 'Не указанный завод и промышленность', 'Завод', 'Не указанное учреждение', 'Больница', 'Учреждение для долгосрочного ухода', 'Центр реабилитации от алкогольной и наркотической зависимости', 'Семейный дом', 'Пенсионный дом или тюрьма', 'Не указанная торговля', 'Магазин розничной торговли', 'Рынок продуктов', 'Автосервисная станция', 'Торговый центр', 'АЗС', 'Не указанное жильё', 'Частный дом', 'Отель или мотель', 'Общежитие', 'Дом для приезжих', 'Не указанное хранилище', 'Не указанные коммунальные услуги и прочие', 'Не указанное транспортное средство', 'Автомобиль или грузовик', 'Самолет', 'Автобус', 'Паром', 'Корабль или лодка', 'Поезд', 'Мотоцикл', 'Не указанное открытое пространство', 'Сеть МУНИ-меш', 'Городской парк', 'Отдыха зона', 'Управление движением', 'Автобусная остановка', 'Киоск').

Примечания

Примечание

Используемые методы SDK: wireless.Wireless.update_network_wireless_ssid_hotspot20,
Используемые пути: put /networks/{networkId}/wireless/ssids/{number}/hotspot20,
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация 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_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'
    - mcc: '563'
      mnc: '232'
    naiRealms:
    - format: '1'
      methods:
      - authenticationTypes:
          credentials: []
          eapInnerAuthentication:
          - EAP-TTLS with MSCHAPv2
          nonEapInnerAuthentication:
          - MSCHAP
          tunneledEapMethodCredentials: []
        id: '1'
      name: 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 словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{}`

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 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_ssids_hotspot20_module.html