Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_appliance_traffic_shaping_uplink_selection – Модуль ресурсов для networks_appliance_trafficshaping_uplinkselection

Примечание

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

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

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

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

Новое в cisco.meraki 2.16.0

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

Обзор

  • Управление обновлением операции ресурса networks_appliance_trafficshaping_uplinkselection.
  • Обновление настроек выбора канала uplink для сети MX.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

activeActiveAutoVpnEnabled

boolean

Переключатель для включения или отключения активного-активного AutoVPN.

Варианты:

  • false
  • true

defaultUplink

string

Узел по умолчанию. Должен быть одним из ‘wan1’ или ‘wan2’.

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 / required

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_caller

string

meraki_caller (string), необязательный идентификатор для отслеживания использования API; может быть также установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER

По умолчанию: ""

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

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

failOverCriterion

string

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

performanceClass

dictionary

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

builtinPerformanceClassName

string

Имя встроенного класса производительности, должно быть указано, когда тип performanceClass равен ‘builtin’, а значение должно быть одним из ‘VoIP’.

customPerformanceClassId

string

ID созданного пользовательского класса производительности, должен быть указан, когда тип performanceClass равен ‘custom’.

type

string

Тип этого класса производительности. Должен быть одним из ‘builtin’ или ‘custom’.

preferredUplink

string

Предпочтительный канал для этого правила приоритета канала. Должен быть одним из ‘wan1’, ‘wan2’, ‘bestForVoIP’, ‘loadBalancing’ или ‘defaultUplink’.

trafficFilters

list / elements=dictionary

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

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 настроенного 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 настроенного VLAN в сети Meraki. В настоящее время доступен только в сети шаблона.

wanTrafficUplinkPreferences

list / elements=dictionary

Массив правил предпочтения канала связи для трафика WAN.

preferredUplink

string

Предпочтительный канал связи для этого правила предпочтения канала связи. Должно быть одним из «wan1» или «wan2».

trafficFilters

list / elements=dictionary

Массив фильтров трафика для этого правила предпочтения канала связи.

type

string

Тип этого фильтра трафика. Должно быть «custom».

value

словарь

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

destination

словарь

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

cidr

строка

Адрес в формате CIDR или «любой». Примеры: «192.168.10.0/24», «192.168.10.1» (то же, что «192.168.10.1/32»), «0.0.0.0/0» (то же, что «любой»).

port

строка

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

protocol

строка

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

source

словарь

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

cidr

строка

Адрес в формате CIDR или «любой». Примеры: «192.168.10.0/24», «192.168.10.1» (то же, что «192.168.10.1/32»), «0.0.0.0/0» (то же, что «любой»).

host

целое число

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

port

строка

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

vlan

целое число

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

Примечания

Примечание

  • Используемые методы SDK: appliance.Appliance.update_network_appliance_traffic_shaping_uplink_selection,
  • Используемые пути: put /networks/{networkId}/appliance/trafficShaping/uplinkSelection,
  • Не поддерживает check_mode
  • Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения Cisco DNAC 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_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

словарь

Словарь или список с ответом, возвращенным 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": {"cidr": "string", "port": "string"}, "protocol": "string", "source": {"cidr": "string", "host": 0, "port": "string", "vlan": 0}}}]}]}

Авторы

  • 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_uplink_selection_module.html

Spec-Zone.ru

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