Модуль fortinet.fortios.fortios_user_fsso — настройка агентов Fortinet Single Sign On (FSSO) в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_user_fsso.

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

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

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

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций user и категории fsso. В примерах приведены все параметры; перед использованием необходимо скорректировать значения в соответствии с источниками данных. Протестировано с 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"`
state string / обязательный	Определяет, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
user_fsso dictionary	Настройка агентов Fortinet Single Sign On (FSSO).
group_poll_interval integer	Интервал в минутах между получением групп с сервера FSSO; если параметр не задан, получение отключается.
interface string	Исходящий интерфейс для связи с сервером. Источник: system.interface.name.
interface_select_method string	Способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
ldap_poll string	Включить или отключить автоматическое получение групп с LDAP-сервера. Варианты: `"enable"` `"disable"`
ldap_poll_filter string	Фильтр для получения групп.
ldap_poll_interval integer	Интервал в минутах между получением групп с LDAP-сервера.
ldap_server string	LDAP-сервер для получения сведений о группах. Источник: user.ldap.name.
logon_timeout integer	Время в минутах, в течение которого сохраняются сеансы входа после отключения сервера FSSO.
name string / обязательный	Имя.
password string	Пароль первого агента-сборщика FSSO.
password2 string	Пароль второго агента-сборщика FSSO.
password3 string	Пароль третьего агента-сборщика FSSO.
password4 string	Пароль четвёртого агента-сборщика FSSO.
password5 string	Пароль пятого агента-сборщика FSSO.
port integer	Порт первого агента-сборщика FSSO.
port2 integer	Порт второго агента-сборщика FSSO.
port3 integer	Порт третьего агента-сборщика FSSO.
port4 integer	Порт четвёртого агента-сборщика FSSO.
port5 integer	Порт пятого агента-сборщика FSSO.
server string	Доменное имя или IP-адрес первого агента-сборщика FSSO.
server2 string	Доменное имя или IP-адрес второго агента-сборщика FSSO.
server3 string	Доменное имя или IP-адрес третьего агента-сборщика FSSO.
server4 string	Доменное имя или IP-адрес четвёртого агента-сборщика FSSO.
server5 string	Доменное имя или IP-адрес пятого агента-сборщика FSSO.
sni string	Индикация имени сервера (SNI).
source_ip string	Исходный IP-адрес для связи с агентом FSSO.
source_ip6 string	Исходный адрес IPv6 для связи с агентом FSSO.
ssl string	Включить или отключить использование SSL. Варианты: `"enable"` `"disable"`
ssl_server_host_ip_check string	Включить или отключить проверку имени узла или IP-адреса сервера. Варианты: `"enable"` `"disable"`
ssl_trusted_cert string	Доверенный сертификат сервера или сертификат CA. Источник: vpn.certificate.remote.name vpn.certificate.ca.name.
type string	Тип сервера. Варианты: `"default"` `"fortinac"` `"fortiems"` `"fortiems-cloud"`
user_info_server string	LDAP-сервер для получения сведений о пользователях. Источник: user.ldap.name.
vrf_select integer	Идентификатор VRF, используемый для подключения к серверу.
vdom string	Виртуальный домен из ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure Fortinet Single Sign On (FSSO) agents.
  fortinet.fortios.fortios_user_fsso:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_fsso:
          group_poll_interval: "0"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          ldap_poll: "enable"
          ldap_poll_filter: "<your_own_value>"
          ldap_poll_interval: "180"
          ldap_server: "<your_own_value> (source user.ldap.name)"
          logon_timeout: "5"
          name: "default_name_11"
          password: "<your_own_value>"
          password2: "<your_own_value>"
          password3: "<your_own_value>"
          password4: "<your_own_value>"
          password5: "<your_own_value>"
          port: "8000"
          port2: "8000"
          port3: "8000"
          port4: "8000"
          port5: "8000"
          server: "192.168.100.40"
          server2: "<your_own_value>"
          server3: "<your_own_value>"
          server4: "<your_own_value>"
          server5: "<your_own_value>"
          sni: "<your_own_value>"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          ssl: "enable"
          ssl_server_host_ip_check: "enable"
          ssl_trusted_cert: "<your_own_value> (source vpn.certificate.remote.name vpn.certificate.ca.name)"
          type: "default"
          user_info_server: "<your_own_value> (source user.ldap.name)"
          vrf_select: "0"

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

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

Ключ	Описание
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_user_fsso_module.html