Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_speed_test_server — настройка списка серверов проверки скорости в 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_server.

Добавлено в fortinet.fortios 2.0.0

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

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

  • Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), задавая и изменяя функцию system и категорию speed_test_server. В примерах приведены все параметры и значения; перед использованием их необходимо адаптировать к источникам данных. Протестировано с FOS v6.0.0

Требования

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

  • ansible>=2.16

Параметры

Параметр

Описание

access_token

строка

Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.

enable_log

логический

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

Варианты:

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

member_path

строка

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

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с указанием member_path подходит для выполнения операций над элементами.

member_state

строка

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

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

Варианты:

  • "present"
  • "absent"

state

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

Определяет, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

system_speed_test_server

словарь

Настройка списка серверов проверки скорости.

host

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

Узлы сервера.

distance

целое число

Расстояние до узла проверки скорости.

id

целое число / обязательный

Идентификатор узла сервера. См. <a href=’#notes’>примечания</a>.

ip

строка

IPv4-адрес узла сервера.

latitude

строка

Широта узла проверки скорости.

longitude

строка

Долгота узла проверки скорости.

password

строка

Пароль узла проверки скорости.

port

целое число

Номер порта узла сервера для связи с клиентом.

user

строка

Имя пользователя узла проверки скорости.

name

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

Имя сервера проверки скорости.

timestamp

целое число

Метка времени сервера проверки скорости.

vdom

строка

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

По умолчанию: "root"

Примечания

Примечание

  • Устаревшая библиотека fortiosapi объявлена устаревшей; предпочтительный способ запуска плейбуков — httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure speed test server list.
  fortinet.fortios.fortios_system_speed_test_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_speed_test_server:
          host:
              -
                  distance: "0"
                  id: "5"
                  ip: "<your_own_value>"
                  latitude: "<your_own_value>"
                  longitude: "<your_own_value>"
                  password: "<your_own_value>"
                  port: "5204"
                  user: "<your_own_value>"
          name: "default_name_12"
          timestamp: "0"

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

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

Ключ

Описание

build

строка

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

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

Пример: "1547"

http_method

строка

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

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

Пример: "PUT"

http_status

строка

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

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

Пример: "200"

mkey

строка

Главный ключ (идентификатор), использованный при последнем обращении к FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

строка

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

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

Пример: "urlfilter"

path

строка

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

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

Пример: "webfilter"

revision

строка

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

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

Пример: "17.0.2.10658"

serial

строка

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

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

Пример: "FGVMEVYYQT3AB5352"

status

строка

Результат операции

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

Пример: "success"

vdom

строка

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

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

Пример: "root"

version

строка

Версия 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–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_server_module.html

Spec-Zone.ru

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