Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_system_ptp – настройка информации PTP системы в 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_ptp.

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

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

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

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

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

enable_log

boolean

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

Варианты:

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

member_path

string

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

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

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

member_state

string

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

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

Варианты:

  • "present"
  • "absent"

system_ptp

dictionary

Настройка информации PTP системы.

delay_mechanism

string

Обнаружение задержки «от конца до конца» или «между узлами».

Варианты:

  • "E2E"
  • "P2P"

interface

string

Клиент PTP будет отправлять ответы через этот интерфейс. Источник: system.interface.name.

mode

string

Многоадресная или гибридная передача.

Варианты:

  • "multicast"
  • "hybrid"

request_interval

integer

Значение запроса задержки — логарифмический средний интервал в секундах между сообщениями запроса задержки, отправляемыми ведомым устройством ведущему.

server_interface

list / elements=dictionary

Интерфейсы FortiGate, на которых включен режим PTP-сервера. Устройства в вашей сети могут обращаться к этим интерфейсам для получения услуг PTP.

delay_mechanism

string

Обнаружение задержки «от конца до конца» или «между узлами».

Варианты:

  • "E2E"
  • "P2P"

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

server_interface_name

string

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

server_mode

string

Включить или отключить режим PTP-сервера FortiGate. Ваш FortiGate станет PTP-сервером для других устройств в сети.

Варианты:

  • "enable"
  • "disable"

status

string

Включить или отключить настройку системного времени FortiGate путем синхронизации с PTP-сервером.

Варианты:

  • "enable"
  • "disable"

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Configure system PTP information.
  fortinet.fortios.fortios_system_ptp:
      vdom: "{{ vdom }}"
      system_ptp:
          delay_mechanism: "E2E"
          interface: "<your_own_value> (source system.interface.name)"
          mode: "multicast"
          request_interval: "1"
          server_interface:
              -
                  delay_mechanism: "E2E"
                  id: "9"
                  server_interface_name: "<your_own_value> (source system.interface.name)"
          server_mode: "enable"
          status: "enable"

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

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

Ключ

Описание

build

string

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

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

Пример: "1547"

http_method

string

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

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

Пример: "PUT"

http_status

string

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

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

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный при последнем вызове 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–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_ptp_module.html

Spec-Zone.ru

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