Модуль cisco.meraki.networks_appliance_traffic_shaping_uplink_bandwidth – Модуль ресурсов для networks_appliance_trafficshaping_uplinkbandwidth

Примечание

Этот модуль входит в коллекцию 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_bandwidth.

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

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

Описание

Управление обновлением операции ресурса networks_appliance_trafficshaping_uplinkbandwidth.
Обновляет настройки пропускной способности канала связи для вашей сети MX.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
bandwidthLimits словарь	Отображение каналов связи с их настройками пропускной способности (убедитесь, что проверены поддерживаемые каналы связи для вашей сети).
cellular словарь	Настройки пропускной способности для канала связи «cellular».
limitDown целое число	Максимальная скорость загрузки (целое число, в Кбит/с). Значение Null означает отсутствие ограничения.
limitUp целое число	Максимальная скорость загрузки (целое число, в Кбит/с). Значение Null означает отсутствие ограничения.
wan1 словарь	Настройки пропускной способности для канала связи «wan1».
limitDown целое число	Максимальная скорость загрузки (целое число, в Кбит/с). Значение Null означает отсутствие ограничения.
limitUp целое число	Максимальная скорость загрузки (целое число, в Кбит/с). Значение Null означает отсутствие ограничения.
wan2 словарь	Настройки пропускной способности для канала связи «wan2».
limitDown целое число	Максимальная скорость загрузки (целое число, в Кбит/с). Значение Null означает отсутствие ограничения.
limitUp целое число	Максимальная скорость загрузки (целое число, в Кбит/с). Значение Null означает отсутствие ограничения.
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 (строка), предшествующая всем ресурсам конечной точки По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID По умолчанию: `""`
meraki_caller строка	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть задан как переменная среды MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
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 integer	meraki_nginx_429_retry_wait_time (integer), Время ожидания повторной попытки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл журнала вывода? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), вывести лог в консоль? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять попытку при возникновении других ошибок 4XX (кроме 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки для других ошибок 4XX Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API Default: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все логирование? Тогда вы сами за себя! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Choices: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429? Choices: `false` `true` ← (default)
networkId string	Параметр пути NetworkId. Идентификатор сети.

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_appliance_traffic_shaping_uplink_bandwidth:
    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
    bandwidthLimits:
      cellular:
        limitDown: 1000000
        limitUp: 1000000
      wan1:
        limitDown: 1000000
        limitUp: 1000000
      wan2:
        limitDown: 1000000
        limitUp: 1000000
    networkId: string

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

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

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

Авторы

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