Spec-Zone.ru › Ansible

fortinet.fortios.fortios_system_speed_test_schedule модуль – Расписание тестирования скорости для каждого интерфейса в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).

Возможно, эта коллекция уже установлена, если вы используете пакет 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), позволяя пользователю устанавливать и изменять системные функции и категорию speed_test_schedule. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировано с FOS v6.0.0

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

строка

Аутентификация на основе токена. Сгенерирована из графического интерфейса Fortigate.

enable_log

булево

Включить/выключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

строка

Путь к атрибуту члена для обработки.

Разделяется слешем, если атрибутов несколько.

Параметр, помеченный member_path, подходит для выполнения операции с членом.

member_state

строка

Добавить или удалить члена по указанному пути к атрибуту.

Если задан member_state, опция state игнорируется.

Варианты:

  • "present"
  • "absent"

state

строка / обязательно

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

system_speed_test_schedule

словарь

Расписание тестов скорости для каждого интерфейса.

ctrl_port

целое число

Порт контроллера для получения токена доступа.

diffserv

строка

DSCP, используемый для тестирования скорости.

dynamic_server

строка

Включить/выключить динамический сервер.

Варианты:

  • "disable"
  • "enable"

interface

строка / обязательно

Имя интерфейса. Источник system.interface.name.

mode

строка

Протокол Auto (по умолчанию), TCP или UDP, используемый для тестирования скорости.

Варианты:

  • "UDP"
  • "TCP"
  • "Auto"

schedules

список / элементы=словарь

Расписания для интерфейса.

name

строка / обязательно

Имя повторяющегося расписания брандмауэра. Источник firewall.schedule.recurring.name.

server_name

строка

Имя сервера для тестирования скорости.

server_port

целое число

Порт сервера для проведения теста скорости.

status

строка

Включить/выключить запланированный тест скорости.

Варианты:

  • "disable"
  • "enable"

update_inbandwidth

строка

Включить/выключить пропуск настроек входящей пропускной способности интерфейса.

Варианты:

  • "disable"
  • "enable"

update_inbandwidth_maximum

целое число

Максимальная скорость загрузки (кбит/с), используемая при тестировании скорости.

update_inbandwidth_minimum

целое число

Минимальная скорость загрузки (кбит/с), которая считается эффективной.

update_outbandwidth

строка

Включить/выключить пропуск настроек исходящей пропускной способности интерфейса.

Варианты:

  • "disable"
  • "enable"

update_outbandwidth_maximum

целое число

Максимальная скорость загрузки (кбит/с), используемая при тестировании скорости.

END_OF_DOCUMENT_MARKER

update_outbandwidth_minimum

integer

Минимальная скорость загрузки (кбит/с), которая считается эффективной.

update_shaper

string

Установить ограничитель исходящего трафика на основе результатов теста.

Choices:

  • "disable"
  • "local"
  • "remote"
  • "both"

vdom

string

Виртуальный домен, среди ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок.

Default: "root"

Примечания

Примечание

  • Устаревший fortiosapi был объявлен устаревшим, httpapi — предпочтительный способ запуска playbook'ов

Примеры

- 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"
          interface: "<your_own_value> (source system.interface.name)"
          mode: "UDP"
          schedules:
              -
                  name: "default_name_9 (source firewall.schedule.recurring.name)"
          server_name: "<your_own_value>"
          server_port: "5201"
          status: "disable"
          update_inbandwidth: "disable"
          update_inbandwidth_maximum: "0"
          update_inbandwidth_minimum: "0"
          update_outbandwidth: "disable"
          update_outbandwidth_maximum: "0"
          update_outbandwidth_minimum: "0"
          update_shaper: "disable"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

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

Пример: "1547"

http_method

string

Последний метод, использованный для подготовки контента в FortiGate

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

Пример: "PUT"

http_status

string

Последний результат, полученный от FortiGate при последней примененной операции

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

Пример: "200"

mkey

string

Главный ключ (id), использованный в последнем вызове FortiGate

Возвращается: успех

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

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

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

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

Пример: "webfilter"

revision

string

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Указание результата операции

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

Пример: "success"

vdom

string

Использованный виртуальный домен

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

Пример: "root"

version

string

Версия FortiGate

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

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/fortinet/fortios/fortios_system_speed_test_schedule_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API