Модуль fortinet.fortios.fortios_system_session_helper — Настройка помощника сессии в FortiOS и FortiGate Fortinet.

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: fortinet.fortios.fortios_system_session_helper.

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

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано из GUI Fortigate.
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента для работы. Разделяется символом косой черты, если атрибутов несколько. Параметр с member_path допустим для выполнения операций с элементами.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. При указании member_state параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательно	Указывает, создавать или удалять объект. Варианты: `"present"` `"absent"`
system_session_helper словарь	Настройка помощника сессии.
id целое число / обязательно	ID помощника сессии. см. <a href=’#notes’>Примечания</a>.
name строка	Имя помощника. Варианты: `"ftp"` `"tftp"` `"ras"` `"h323"` `"tns"` `"mms"` `"sip"` `"pptp"` `"rtsp"` `"dns-udp"` `"dns-tcp"` `"pmap"` `"rsh"` `"dcerpc"` `"mgcp"` `"gtp-c"` `"gtp-u"` `"gtp-b"` `"pfcp"`
port целое число	Порт протокола.
protocol целое число	Номер протокола.
vdom строка	Виртуальная доменная область, среди тех, которые были определены ранее. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельная единица. По умолчанию: `"root"`

Примечания

Примечание

Мы настоятельно рекомендуем использовать собственное значение в качестве id вместо 0, хотя ‘0’ — это специальный маркер, который позволяет бэкенду назначить последнее доступное число для объекта, но у него есть ограничения. Подробнее об этом см. в разделе ВЧ.
Устаревший fortiosapi был исключен, httpapi — предпочтительный способ запуска плейбуков.
Модуль поддерживает режим check_mode.

Примеры

- name: Configure session helper.
  fortinet.fortios.fortios_system_session_helper:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_session_helper:
          id: "3"
          name: "default_name_4"
          port: "0"
          protocol: "0"

Значения возврата

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

Ключ	Описание
build строка	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для подготовки содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, предоставленный FortiGate для последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый в последнем вызове 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_session_helper_module.html