Модуль cisco.meraki.networks_appliance_sdwan_internet_policies — модуль ресурса для networks _appliance _sdwan _internet _policies

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.meraki.networks_appliance_sdwan_internet_policies.

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

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

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

Управление операцией обновления ресурса networks _appliance _sdwan _internet _policies.
Обновление предпочтений интернет-трафика SD-WAN для сети MX.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
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), добавляется перед всеми ресурсами конечных точек По умолчанию: `"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. Идентификатор сети.
wanTrafficUplinkPreferences list / элементы=dictionary	Политики с соответствующими фильтрами трафика для сети MX.
failOverCriterion string	Поведение при переключении на резервный канал WAN и возврате на основной.
performanceClass dictionary	Настройка класса производительности для правила выбора восходящего канала.
builtinPerformanceClassName string	Название встроенного класса производительности. Должно быть указано, если тип performanceClass — ‘builtin’; допустимое значение — ‘VoIP’.
customPerformanceClassId string	Идентификатор созданного пользовательского класса производительности. Должен быть указан, если тип performanceClass — “custom”.
type string	Тип этого класса производительности. Допустимые значения: ‘builtin’ или ‘custom’.
preferredUplink string	Предпочтительный восходящий канал для правила выбора канала. Допустимые значения: ‘wan1’, ‘wan2’, ‘bestForVoIP’, ‘loadBalancing’ или ‘defaultUplink’.
trafficFilters list / элементы=dictionary	Фильтры трафика.
type string	Тип фильтра трафика. Допустимые значения: ‘custom’, ‘major_application’, ‘application (NBAR)’. Если type — ‘application’, можно передать категорию или приложение NBAR.
value dictionary	Значение фильтра трафика.
destination dictionary	Назначение фильтра трафика типа ‘custom’.
applications list / элементы=dictionary	Список объектов приложений (majorApplication или nbar).
id string	Идентификатор основного приложения либо список выбранных категорий приложений или приложений NBAR.
name string	Название выбранного основного приложения или категории приложений.
type string	Тип приложения (major или nbar).
cidr string	Адрес в формате CIDR (например, “192.168.10.1”, что эквивалентно “192.168.10.1/32”) или “any”.
port string	Например: “any”, “0” (также означает “any”), “8080”, “1-1024”.
protocol string	Протокол фильтра трафика. Допустимые значения: ‘tcp’, ‘udp’, ‘icmp6’ или ‘any’.
source dictionary	Источник фильтра трафика.
cidr string	Адрес в формате CIDR (например, “192.168.10.1”, что эквивалентно “192.168.10.1/32”) или “any”. Нельзя использовать вместе со свойством “vlan”.
host integer	Идентификатор узла в VLAN. Не должен превышать ёмкость подсети VLAN. Необходимо использовать вместе со свойством “vlan”; в настоящее время доступно только в сети на основе шаблона.
port string	Например: “any”, “0” (также означает “any”), “8080”, “1-1024”.
vlan integer	Идентификатор настроенной VLAN в сети Meraki. Нельзя использовать вместе со свойством “cidr”; в настоящее время доступно только в сети на основе шаблона.

Примечания

Примечание

Используемый метод SDK: appliance.Appliance.update_network_appliance_sdwan_internet_policies,
Используемые пути: put /networks/{networkId}/appliance/sdwan/internetPolicies,
Не поддерживает check_mode
Модуль выполняется на управляющем узле и не использует модули подключения Ansible, а вместо этого использует встроенный диспетчер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установки соединения

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_appliance_sdwan_internet_policies:
    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 }}"
    networkId: string
    wanTrafficUplinkPreferences:
      - failOverCriterion: poorPerformance
        performanceClass:
          builtinPerformanceClassName: VoIP
          customPerformanceClassId: '123456'
          type: custom
        preferredUplink: wan1
        trafficFilters:
          - type: custom
            value:
              destination:
                applications:
                  - id: meraki:layer7/application/3
                    name: DNS
                    type: major
                cidr: any
                port: any
              protocol: tcp
              source:
                cidr: 192.168.1.0/24
                host: 254
                port: 1-1024
                vlan: 10

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"wanTrafficUplinkPreferences": [{"failOverCriterion": "string", "performanceClass": {"builtinPerformanceClassName": "string", "customPerformanceClassId": "string", "type": "string"}, "preferredUplink": "string", "trafficFilters": [{"type": "string", "value": {"destination": {"applications": [{"id": "string", "name": "string", "type": "string"}], "cidr": "string", "port": "string"}, "protocol": "string", "source": {"cidr": "string", "host": 0, "port": "string", "vlan": 0}}}]}]}`

Ключ

Описание

meraki_response

dictionary

Словарь или список с ответом, возвращённым Python SDK Cisco Meraki

Возвращается: всегда

Пример: {"wanTrafficUplinkPreferences": [{"failOverCriterion": "string", "performanceClass": {"builtinPerformanceClassName": "string", "customPerformanceClassId": "string", "type": "string"}, "preferredUplink": "string", "trafficFilters": [{"type": "string", "value": {"destination": {"applications": [{"id": "string", "name": "string", "type": "string"}], "cidr": "string", "port": "string"}, "protocol": "string", "source": {"cidr": "string", "host": 0, "port": "string", "vlan": 0}}}]}]}

Авторы

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