Модуль cisco.meraki.networks_wireless_ssids_traffic_shaping_rules – модуль ресурсов для networks _wireless _ssids _trafficshaping _rules

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
defaultRulesEnabled boolean	Включены (true) или отключены (false) ли правила формирования трафика по умолчанию. Предусмотрено 4 правила по умолчанию, которые отображаются на странице формирования трафика вашей сети. Обратите внимание, что правила по умолчанию учитываются в ограничении на количество правил (8). Допустимые значения: `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), время ожидания перед повторной попыткой после ошибки 429 от Nginx По умолчанию: `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. Идентификатор сети.
number string	Параметр пути Number.
rules list / elements=dictionary	Массив правил формирования трафика. Правила применяются в указанном порядке. Пустой список (или null) означает отсутствие правил. Обратите внимание, что допускается не более 8 правил.
definitions list / elements=dictionary	Список объектов с описанием определений правила формирования трафика. Необходимо указать хотя бы одно определение.
type string	Тип определения. Может принимать одно из значений: ‘application’, ‘applicationCategory’, ‘host’, ‘port’, ‘ipRange’ или ‘localNet’.
value string	Если значение “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 integer	Метка DSCP, применяемая правилом. Значение Null означает «Не изменять метку DSCP». Список возможных значений меток можно получить с помощью конечной точки trafficShaping/dscpTaggingOptions.
pcpTagValue integer	Метка PCP, применяемая правилом. Может принимать значения от 0 (наименьший приоритет) до 7 (наивысший приоритет). Значение Null означает «Не устанавливать метку PCP».
perClientBandwidthLimits dictionary	Объект с описанием настроек пропускной способности для правила.
bandwidthLimits dictionary	Объект ограничений пропускной способности, задающий скорость отправки (‘limitUp’) и загрузки (‘limitDown’) в Кбит/с. Эти ограничения применяются только при значении ‘custom’ параметра ‘settings’.
limitDown integer	Максимальное ограничение скорости загрузки (целое число, в Кбит/с).
limitUp integer	Максимальное ограничение скорости отправки (целое число, в Кбит/с).
settings string	Способ применения правилом ограничений пропускной способности. Может принимать одно из значений: ‘network default’, ‘ignore’ или ‘custom’.
trafficShapingEnabled boolean	Применяются ли правила формирования трафика к клиентам в вашей сети SSID. Допустимые значения: `false` `true`

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_wireless_ssids_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
    number: string
    rules:
      - definitions:
          - type: host
            value: google.com
        dscpTagValue: 0
        pcpTagValue: 0
        perClientBandwidthLimits:
          bandwidthLimits:
            limitDown: 1000000
            limitUp: 1000000
          settings: custom
    trafficShapingEnabled: true

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"defaultRulesEnabled": true, "rules": [{"definitions": [{"type": "string", "value": "string"}], "dscpTagValue": 0, "pcpTagValue": 0, "perClientBandwidthLimits": {"bandwidthLimits": {"limitDown": 0, "limitUp": 0}, "settings": "string"}}], "trafficShapingEnabled": true}`

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"defaultRulesEnabled": true, "rules": [{"definitions": [{"type": "string", "value": "string"}], "dscpTagValue": 0, "pcpTagValue": 0, "perClientBandwidthLimits": {"bandwidthLimits": {"limitDown": 0, "limitUp": 0}, "settings": "string"}}], "trafficShapingEnabled": true}

Авторы

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