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

Примечание

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

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

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

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

Впервые в cisco.meraki 2.16.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 / 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. Идентификатор сети.
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») в Кбит/с. Эти значения применяются только в том случае, если «settings» установлено в «custom».
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 DNAC 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_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 словарь	Словарь или список со значением возврата, полученным от 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

словарь

Словарь или список со значением возврата, полученным от 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/networks_wireless_ssids_traffic_shaping_rules_module.html