Модуль cisco.meraki.networks_appliance_traffic_shaping_rules – модуль ресурса для networks _appliance _trafficshaping _rules

Примечание

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

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

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

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

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

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

Обзор

Управление операцией обновления ресурса networks _appliance _trafficshaping _rules.
Обновление правил настройки формирования трафика для сети MX.

Примечание

Этому модулю соответствует модуль действия.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
defaultRulesEnabled логическое значение	Включены (true) или отключены (false) правила формирования трафика по умолчанию. Существует 4 правила по умолчанию, которые можно просмотреть на странице формирования трафика вашей сети. Обратите внимание, что правила по умолчанию учитываются в максимальном количестве из 8 правил. Варианты: `false` `true`
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 (строка), базовый адрес для всех конечных точек API По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также его можно задать в переменной среды BE_GEO_ID По умолчанию: `""`
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 (целое число), время ожидания перед повтором при ответе 429 от Nginx По умолчанию: `60`
meraki_output_log логическое значение	meraki_output_log (логическое значение), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логическое значение	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error логическое значение	meraki_retry_4xx_error (логическое значение), повторять запрос при получении другой ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором при другой ошибке 4XX По умолчанию: `60`
meraki_simulate логическое значение	meraki_simulate (логическое значение), имитировать запросы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging логическое значение	meraki_suppress_logging (логическое значение), отключить ведение всех журналов? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логическое значение	meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логическое значение	meraki_wait_on_rate_limit (логическое значение), повторять запрос при достижении ограничения частоты запросов (ошибка 429)? Варианты: `false` `true` ← (по умолчанию)
networkId строка	Параметр пути NetworkId. Идентификатор сети.
rules список / элементы=словарь	Массив правил формирования трафика. Правила применяются в указанном порядке. Пустой список (или null) означает отсутствие правил. Обратите внимание, что допускается не более 8 правил.
definitions список / элементы=словарь	Список объектов, описывающих условия правила формирования трафика. Требуется как минимум одно условие.
type строка	Тип условия. Возможные значения: ‘application’, ‘applicationCategory’, ‘host’, ‘port’, ‘ipRange’ или ‘localNet’.
value строка	Если значение “type” равно ‘host’, ‘port’, ‘ipRange’ или ‘localNet’, параметр “value” должен быть строкой, соответствующей имени узла (например, “somesite.com”), порту (например, 8080) или диапазону IP-адресов (“192.1.0.0”, “192.1.0.0/16” или “10.1.0.0/16 80”). Для ‘localNet’ также поддерживается нотация CIDR, кроме пользовательских портов. Если значение “type” равно ‘application’ или ‘applicationCategory’, параметр “value” должен быть объектом со структурой { “id” “meraki layer7/…” }, где “id” — это идентификатор категории приложения или самого приложения (список идентификаторов для вашей сети можно получить с помощью конечной точки trafficShaping/applicationCategories).
dscpTagValue целое число	Метка DSCP, применяемая правилом. Значение Null означает «не изменять метку DSCP». Список возможных значений меток можно получить с помощью конечной точки trafficShaping/dscpTaggingOptions.
perClientBandwidthLimits словарь	Объект с описанием параметров пропускной способности для правила.
bandwidthLimits словарь	Объект с ограничениями пропускной способности, задающий скорость отправки (‘limitUp’) и загрузки (‘limitDown’) в Кбит/с. Эти ограничения применяются только при значении ‘custom’ параметра ‘settings’.
limitDown целое число	Максимальное ограничение скорости загрузки (целое число, в Кбит/с).
limitUp целое число	Максимальное ограничение скорости отправки (целое число, в Кбит/с).
settings строка	Способ применения ограничений пропускной способности правилом. Возможные значения: ‘network default’, ‘ignore’ или ‘custom’.
priority строка	Строка, указывающая приоритет пакетов, соответствующих правилу. Возможные значения: ‘low’, ‘normal’ или ‘high’.

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_appliance_traffic_shaping_rules:
    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
    defaultRulesEnabled: true
    networkId: string
    rules:
      - definitions:
          - type: host
            value: google.com
          - type: port
            value: '9090'
          - type: ipRange
            value: 192.1.0.0
          - type: ipRange
            value: 192.1.0.0/16
          - type: ipRange
            value: 10.1.0.0/16:80
          - type: localNet
            value: 192.168.0.0/16
        dscpTagValue: 0
        perClientBandwidthLimits:
          bandwidthLimits:
            limitDown: 1000000
            limitUp: 1000000
          settings: custom
        priority: normal

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, полученным от Cisco Meraki Python SDK Возвращается: всегда Пример: `{}`

Авторы

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