Модуль cisco.meraki.networks_wireless_ssids_vpn – модуль ресурсов для networks _wireless _ssids _vpn

Примечание

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

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

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

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

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

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

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

Управление операцией обновления ресурса networks _wireless _ssids _vpn.
Обновление настроек VPN для SSID.

Примечание

Для этого модуля существует соответствующий плагин действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
concentrator dictionary	Настройки VPN-концентратора для этого SSID.
networkId string	NAT ID концентраторa, который следует задать.
vlanId integer	VLAN, который следует назначить тегом для концентратора.
failover dictionary	Настройки резервного VPN-концентратора. Используются только в том случае, если для SSID настроены два VPN-концентратора.
heartbeatInterval integer	Интервал таймера ожидания в секундах.
idleTimeout integer	Тайм-аут таймера ожидания в секундах.
requestIp string	IP-адрес, зарезервированный на DHCP-сервере, на котором будет завершаться подключение SSID.
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` ← (по умолчанию)
networkId string	Параметр пути NetworkId. Идентификатор сети.
number string	Параметр пути Number.
splitTunnel dictionary	Настройки раздельного туннелирования VPN для этого SSID.
enabled boolean	Если значение равно true, раздельное туннелирование VPN включено. Варианты: `false` `true`
rules list / элементы=dictionary	Список правил раздельного туннелирования VPN.
comment string	Описание этого правила раздельного туннелирования (необязательно).
destCidr string	Назначение для этого правила раздельного туннелирования: IP-адрес, полное доменное имя (FQDN) или ‘any’.
destPort string	Порт назначения для этого правила раздельного туннелирования (целое число в диапазоне 1–65535) или ‘any’.
policy string	Политика обработки трафика для этого правила раздельного туннелирования: ‘allow’ или ‘deny’.
protocol string	Протокол для этого правила раздельного туннелирования.

Примечания

Примечание

Используемый метод SDK: wireless.Wireless.update_network_wireless_ssid_vpn,
Используемый путь: put /networks/{networkId}/wireless/ssids/{number}/vpn,
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо них применяет встроенный диспетчер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления подключения

См. также

Документация Cisco Meraki по wireless updateNetworkWirelessSsidVpn: Полный справочник по API updateNetworkWirelessSsidVpn.

Примеры

- name: Update all
  cisco.meraki.networks_wireless_ssids_vpn:
    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
    concentrator:
      name: some concentrator name
      networkId: N_123
      vlanId: 44
    failover:
      heartbeatInterval: 10
      idleTimeout: 30
      requestIp: 1.1.1.1
    networkId: string
    number: string
    splitTunnel:
      enabled: true
      rules:
        - comment: split tunnel rule 1
          destCidr: 1.1.1.1/32
          destPort: any
          policy: allow
          protocol: Any
        - comment: split tunnel rule 2
          destCidr: foo.com
          destPort: any
          policy: deny

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{}`

Авторы

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/networks_wireless_ssids_vpn_module.html