Модуль cisco.meraki.networks_wireless_ssids_vpn — Модуль ресурсов для сетей _wireless _ssids _vpn

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.meraki.networks_wireless_ssids_vpn.

Новое в cisco.meraki 2.16.0

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

Описание

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

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
concentrator словарь	Настройки концентратора VPN для этого SSID.
networkId строка	Идентификатор NAT концентратора, который должен быть установлен.
vlanId целое число	VLAN, который должен быть помечен для концентратора.
failover словарь	Настройки резервного концентратора VPN. Используются только при конфигурировании двух концентраторов VPN на SSID.
heartbeatInterval целое число	Интервал таймера простоя в секундах.
idleTimeout целое число	Время ожидания таймера простоя в секундах.
requestIp строка	IP-адрес, зарезервированный на DHCP-сервере, где SSID будет завершен.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания при повторной попытке сбоя конвейера действий По умолчанию: `60`
meraki_api_key строка / обязательно	meraki_api_key (строка), API-ключ, сгенерированный в панели управления; также может быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), предшествующая всем ресурсам конечной точки По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная среды BE_GEO_ID По умолчанию: `""`
meraki_caller строка	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если он находится за локальным прокси-сервером По умолчанию: `""`
meraki_inherit_logging_config логический	meraki_inherit_logging_config (логический), наследует собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла журнала, дополненное датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для вывода журнала; по умолчанию, рабочая директория скрипта, если не указано По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), повторить до этого количества раз при возникновении ошибок со стороны сервера 429 или других ошибок По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания повторной попытки Nginx 429 По умолчанию: `60`
meraki_output_log логический	meraki_output_log (логический), создать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логический	meraki_print_console (логический), выводить вывод журнала в консоль? Варианты: `false` `true` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

meraki_requests_proxy string	meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для 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 (целое число), время ожидания при повторной попытке ошибки 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), смоделировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова 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 / elements=dictionary	Список правил VPN разделенного туннеля.
comment string	Описание для этого правила разделенного туннеля (необязательно).
destCidr string	Назначение для этого правила разделенного туннеля. IP-адрес, полное доменное имя (FQDN) или «любой».
destPort string	Порт назначения для этого правила разделенного туннеля (целое число в диапазоне 1-65535) или «любой».
policy string	Политика трафика, указанная для этого правила разделенного туннеля, «разрешить» или «запретить».
protocol string	Протокол для этого правила разделенного туннеля.

Примечания

Примечание

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

См. также

Документация 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_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 словарь	Словарь или список со значением, возвращаемым 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_vpn_module.html