Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_appliance_traffic_shaping_uplink_selection – модуль ресурсов для networks _appliance _trafficshaping _uplinkselection

Примечание

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

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

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

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

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

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

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

  • Управление операцией обновления ресурса networks _appliance _trafficshaping _uplinkselection.
  • Обновление настроек выбора восходящего канала для сети MX.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

activeActiveAutoVpnEnabled

boolean

Включение или отключение активного-активного режима AutoVPN.

Варианты:

  • false
  • true

defaultUplink

string

Канал uplink по умолчанию. Должен быть интерфейсом WAN вида «wanX».

failoverAndFailback

dictionary

Поведение при переключении и возврате каналов WAN.

immediate

dictionary

Немедленное переключение WAN прекращает все потоки (новые и существующие) на текущем канале WAN, если он признан ненадёжным.

enabled

boolean

Включение или отключение немедленного переключения и возврата WAN.

Варианты:

  • false
  • true

loadBalancingEnabled

boolean

Включение или отключение балансировки нагрузки.

Варианты:

  • false
  • true

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. Идентификатор сети.

vpnTrafficUplinkPreferences

list / elements=dictionary

Массив правил выбора канала uplink для VPN-трафика.

failOverCriterion

string

Критерий переключения для этого правила выбора канала uplink. Должен иметь значение «poorPerformance» или «uplinkDown».

performanceClass

dictionary

Настройка класса производительности для этого правила выбора канала uplink.

builtinPerformanceClassName

string

Имя встроенного класса производительности. Необходимо указать, если тип performanceClass — «builtin»; допустимое значение — «VoIP».

customPerformanceClassId

string

Идентификатор созданного пользовательского класса производительности. Необходимо указать, если тип performanceClass — «custom».

type

string

Тип этого класса производительности. Должен иметь значение «builtin» или «custom».

preferredUplink

string

Предпочитаемый канал uplink для этого правила. Должен иметь значение «wan1», «wan2», «bestForVoIP», «loadBalancing» или «defaultUplink» либо любое другое допустимое имя канала uplink (wanX), если он доступен в сети.

trafficFilters

list / elements=dictionary

Массив фильтров трафика для этого правила выбора канала uplink.

type

string

Тип этого фильтра трафика. Должен иметь значение «applicationCategory», «application» или «custom».

value

dictionary

Объект значения этого фильтра трафика.

destination

dictionary

Назначение фильтра трафика пользовательского типа.

cidr

string

Адрес в формате CIDR или «any». Например: «192.168.10.0/24», «192.168.10.1» (эквивалентно «192.168.10.1/32»), «0.0.0.0/0» (эквивалентно «any»).

fqdn

string

Адрес в формате FQDN. В настоящее время доступен только в поле «destination» объекта «vpnTrafficUplinkPreference». Например: «www.google.com».

host

integer

Идентификатор хоста в VLAN. Следует использовать вместе с «vlan»; значение не должно превышать ёмкость подсети VLAN. В настоящее время доступен только в сети-шаблоне.

network

string

Идентификатор сети Meraki. В настоящее время доступен только в сети-шаблоне; значением должен быть идентификатор этой же сети-шаблона или другой сети-шаблона. Например: «L_12345678».

port

string

Например: «any», «0» (также означает «any»), «8080», «1-1024».

vlan

integer

Идентификатор настроенной VLAN в сети Meraki. В настоящее время доступен только в сети-шаблоне.

id

string

Идентификатор фильтра трафика типа applicationCategory или application. Например: «meraki layer7/category/1», «meraki layer7/application/4».

protocol

string

Протокол фильтра трафика пользовательского типа. Должен иметь значение «tcp», «udp», «icmp», «icmp6» или «any».

source

dictionary

Источник фильтра трафика пользовательского типа.

cidr

string

Адрес в формате CIDR или «any». Например: «192.168.10.0/24», «192.168.10.1» (эквивалентно «192.168.10.1/32»), «0.0.0.0/0» (эквивалентно «any»).

host

integer

Идентификатор хоста в VLAN. Следует использовать вместе с «vlan»; значение не должно превышать ёмкость подсети VLAN. В настоящее время доступен только в сети-шаблоне.

network

string

Идентификатор сети Meraki. В настоящее время доступен только в сети-шаблоне; значением должен быть идентификатор этой же сети-шаблона или другой сети-шаблона. Например: «L_12345678».

port

string

Например: «any», «0» (также означает «any»), «8080», «1-1024».

vlan

integer

Идентификатор настроенной VLAN в сети Meraki. В настоящее время доступен только в сети-шаблоне.

wanTrafficUplinkPreferences

list / elements=dictionary

Массив правил выбора канала uplink для трафика WAN.

preferredUplink

string

Предпочитаемое восходящее соединение для этого правила выбора восходящего соединения. Должно быть указано ‘wan1’ или ‘wan2’ либо любое другое допустимое восходящее соединение (wanX), если оно доступно в сети.

trafficFilters

list / elements=dictionary

Массив фильтров трафика для этого правила выбора восходящего соединения.

type

string

Тип этого фильтра трафика. Должно быть указано ‘custom’.

value

dictionary

Объект значения этого фильтра трафика.

destination

dictionary

Назначение фильтра трафика пользовательского типа.

cidr

string

Адрес в формате CIDR или “any”. Например, “192.168.10.0/24”, “192.168.10.1” (эквивалентно “192.168.10.1/32”), “0.0.0.0/0” (эквивалентно “any”).

port

string

Например: “any”, “0” (также означает “any”), “8080”, “1-1024”.

protocol

string

Протокол фильтра трафика пользовательского типа. Должно быть указано ‘tcp’, ‘udp’, ‘icmp6’ или ‘any’.

source

dictionary

Источник фильтра трафика пользовательского типа.

cidr

string

Адрес в формате CIDR или “any”. Например, “192.168.10.0/24”, “192.168.10.1” (эквивалентно “192.168.10.1/32”), “0.0.0.0/0” (эквивалентно “any”).

host

integer

Идентификатор хоста в VLAN. Следует использовать вместе с ‘vlan’; значение не должно превышать ёмкость подсети VLAN. В настоящее время доступно только в сети-шаблоне.

port

string

Например: “any”, “0” (также означает “any”), “8080”, “1-1024”.

vlan

integer

Идентификатор настроенной VLAN в сети Meraki. В настоящее время доступно только в сети-шаблоне.

Примечания

Примечание

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

См. также

См. также

Документация Cisco Meraki по appliance updateNetworkApplianceTrafficShapingUplinkSelection

Полный справочник по API updateNetworkApplianceTrafficShapingUplinkSelection.

Примеры

- name: Update all
  cisco.meraki.networks_appliance_traffic_shaping_uplink_selection:
    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
    activeActiveAutoVpnEnabled: true
    defaultUplink: wan1
    failoverAndFailback:
      immediate:
        enabled: true
    loadBalancingEnabled: true
    networkId: string
    vpnTrafficUplinkPreferences:
      - failOverCriterion: poorPerformance
        performanceClass:
          builtinPerformanceClassName: VoIP
          customPerformanceClassId: '123456'
          type: custom
        preferredUplink: bestForVoIP
        trafficFilters:
          - type: applicationCategory
            value:
              destination:
                cidr: any
                fqdn: www.google.com
                host: 254
                network: L_12345678
                port: 1-1024
                vlan: 10
              id: meraki:layer7/category/1
              protocol: tcp
              source:
                cidr: 192.168.1.0/24
                host: 200
                network: L_23456789
                port: any
                vlan: 20
    wanTrafficUplinkPreferences:
      - preferredUplink: wan1
        trafficFilters:
          - type: custom
            value:
              destination:
                cidr: any
                port: any
              protocol: tcp
              source:
                cidr: 192.168.1.0/24
                host: 254
                port: 1-1024
                vlan: 10

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

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

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"activeActiveAutoVpnEnabled": true, "defaultUplink": "string", "failoverAndFailback": {"immediate": {"enabled": true}}, "loadBalancingEnabled": true, "vpnTrafficUplinkPreferences": [{"failOverCriterion": "string", "performanceClass": {"builtinPerformanceClassName": "string", "customPerformanceClassId": "string", "type": "string"}, "preferredUplink": "string", "trafficFilters": [{"type": "string", "value": {"destination": {"cidr": "string", "fqdn": "string", "host": 0, "network": "string", "port": "string", "vlan": 0}, "id": "string", "protocol": "string", "source": {"cidr": "string", "host": 0, "network": "string", "port": "string", "vlan": 0}}}]}], "wanTrafficUplinkPreferences": [{"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_traffic_shaping_uplink_selection_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API