Модуль fortinet.fortios.fortios_system_speed_test_schedule — расписание тестирования скорости для каждого интерфейса в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_speed_test_schedule.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции system и категории speed_test_schedule. В примерах приведены все параметры; перед использованием необходимо скорректировать значения в соответствии с источниками данных. Проверено с FOS v6.0.0
Требования
На узле, на котором выполняется этот модуль, должны быть соблюдены следующие требования.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
system_speed_test_schedule dictionary | Расписание тестирования скорости для каждого интерфейса. |
|
ctrl_port integer |
Порт контроллера для получения токена доступа. |
|
diffserv string |
DSCP, используемый для тестирования скорости. |
|
dynamic_server string |
Включить/отключить параметр динамического сервера. Варианты:
|
|
expected_inbandwidth_maximum integer |
Задать максимальный порог входящей пропускной способности для применения результатов теста скорости к профилю shaping-profile. |
|
expected_inbandwidth_minimum integer |
Задать минимальный порог входящей пропускной способности для применения результатов теста скорости к профилю shaping-profile. |
|
expected_outbandwidth_maximum integer |
Задать максимальный порог исходящей пропускной способности для применения результатов теста скорости к профилю shaping-profile. |
|
expected_outbandwidth_minimum integer |
Задать минимальный порог исходящей пропускной способности для применения результатов теста скорости к профилю shaping-profile. |
|
interface string / обязательный |
Имя интерфейса. Источник: system.interface.name. |
|
mode string |
Протокол для тестирования скорости: Auto (по умолчанию), TCP или UDP. Варианты:
|
|
retries integer |
Максимальное количество попыток подключения устройства FortiGate к одному и тому же серверу, прежде чем тест скорости будет считаться неудачным (1–10). |
|
retry_pause integer |
Количество секунд, в течение которых FortiGate ожидает между последовательными тестами скорости перед попыткой подключения к другому серверу (60–3600). |
|
schedules list / elements=dictionary |
Расписания для интерфейса. |
|
name string / обязательный |
Имя повторяющегося расписания брандмауэра. Источник: firewall.schedule.recurring.name. |
|
server_name string |
Имя сервера тестирования скорости из списка system.speed-test-server. Оставьте значение пустым, чтобы выбрать сервер по умолчанию «FTNT_Auto». Источник: system .speed-test-server.name. |
|
server_port integer |
Порт сервера, на котором выполняется тест скорости. |
|
status string |
Включить/отключить запланированное тестирование скорости. Варианты:
|
|
update_inbandwidth string |
Включить/отключить обход настройки входящей пропускной способности интерфейса. Варианты:
|
|
update_inbandwidth_maximum integer |
Максимальная пропускная способность загрузки (кбит/с), используемая при тестировании скорости. |
|
update_inbandwidth_minimum integer |
Минимальная пропускная способность загрузки (кбит/с), которая считается эффективной. |
|
update_interface_shaping string |
Включить/отключить использование результатов теста скорости в качестве ориентира для формирования трафика интерфейса (с переопределением настроенных значений входящей/исходящей пропускной способности). Варианты:
|
|
update_outbandwidth string |
Включить/отключить обход настройки исходящей пропускной способности интерфейса. Варианты:
|
|
update_outbandwidth_maximum integer |
Максимальная пропускная способность отдачи (кбит/с), используемая при тестировании скорости. |
|
update_outbandwidth_minimum integer |
Минимальная пропускная способность отдачи (кбит/с), которая считается эффективной. |
|
update_shaper string |
Задать шейпер исходящего трафика на основе результата теста. Варианты:
|
vdom string | Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревшая библиотека fortiosapi объявлена устаревшей; для выполнения плейбуков рекомендуется использовать httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Speed test schedule for each interface.
fortinet.fortios.fortios_system_speed_test_schedule:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_speed_test_schedule:
ctrl_port: "5200"
diffserv: "<your_own_value>"
dynamic_server: "disable"
expected_inbandwidth_maximum: "0"
expected_inbandwidth_minimum: "0"
expected_outbandwidth_maximum: "0"
expected_outbandwidth_minimum: "0"
interface: "<your_own_value> (source system.interface.name)"
mode: "UDP"
retries: "5"
retry_pause: "300"
schedules:
-
name: "default_name_15 (source firewall.schedule.recurring.name)"
server_name: "<your_own_value> (source system.speed-test-server.name)"
server_port: "5201"
status: "disable"
update_inbandwidth: "disable"
update_inbandwidth_maximum: "0"
update_inbandwidth_minimum: "0"
update_interface_shaping: "disable"
update_outbandwidth: "disable"
update_outbandwidth_maximum: "0"
update_outbandwidth_minimum: "0"
update_shaper: "disable"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate при последней выполненной операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortinet/fortios/fortios_system_speed_test_schedule_module.html
