Модуль cisco.meraki.networks_appliance_traffic_shaping_vpn_exclusions — Модуль ресурсов для networks_appliance_trafficshaping_vpnexclusions

Примечание

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

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

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

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

Новое в cisco.meraki 2.18.0

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

Описание

Управление обновлением операции ресурса networks_appliance_trafficshaping_vpnexclusions.
Обновление правил исключения VPN для сети MX.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
custom список / элементы=словарь	Настраиваемые правила исключения VPN. Передайте пустой массив для очистки существующих правил.
destination строка	Адрес назначения; имя хоста необходимо для DNS, иначе IPv4.
port строка	Порт назначения.
protocol строка	Протокол.
majorApplications список / элементы=словарь	Правила исключения VPN на основе основных приложений. Передайте пустой массив для очистки существующих правил.
id строка	Идентификатор приложения Meraki.
name строка	Название приложения.
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 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. Идентификатор сети.

Примечания

Примечание

Используемый метод SDK: appliance.Appliance.update_network_appliance_traffic_shaping_vpn_exclusions,
Используемые пути: put /networks/{networkId}/appliance/trafficShaping/vpnExclusions,
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki для appliance updateNetworkApplianceTrafficShapingVpnExclusions: Полная справка по API updateNetworkApplianceTrafficShapingVpnExclusions.

Примеры

- name: Update all
  cisco.meraki.networks_appliance_traffic_shaping_vpn_exclusions:
    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}}"
    custom:
    - destination: 192.168.3.0/24
      port: '8000'
      protocol: tcp
    majorApplications:
    - id: meraki:vpnExclusion/application/2
      name: Office 365 Sharepoint
    networkId: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: `{"custom": [{"destination": "string", "port": "string", "protocol": "string"}], "majorApplications": [{"id": "string", "name": "string"}], "networkId": "string", "networkName": "string"}`

Авторы

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_appliance_traffic_shaping_vpn_exclusions_module.html