модуль fortinet.fortimanager.fmgr_user_fsso — Настройка единого входа Fortinet

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_user_fsso.

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

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

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

Этот модуль позволяет настроить устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, которыми будут переопределены условия ошибки.
rc_succeeded list / elements=integer	Список кодов rc, которыми будут переопределены условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
user_fsso dictionary	Набор параметров верхнего уровня.
_gui_meta string	Метаданные GUI.
dynamic_mapping list / elements=dictionary	Динамическое сопоставление.
_gui_meta string	Метаданные GUI.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	Виртуальный домен.
group_poll_interval aliases: group-poll-interval integer	Интервал опроса групп.
interface string	Интерфейс.
interface_select_method aliases: interface-select-method string	Метод выбора интерфейса. Варианты: `"auto"` `"sdwan"` `"specify"`
ldap_poll aliases: ldap-poll string	Опрос LDAP. Варианты: `"disable"` `"enable"`
ldap_poll_filter aliases: ldap-poll-filter string	Фильтр опроса LDAP.
ldap_poll_interval aliases: ldap-poll-interval integer	Интервал опроса LDAP.
ldap_server aliases: ldap-server string	Сервер LDAP.
logon_timeout aliases: logon-timeout integer	Интервал в минутах, в течение которого сохраняются сеансы входа после отключения сервера FSSO.
password any	(список) Пароль.
password2 any	(список) Пароль 2.
password3 any	(список) Пароль 3.
password4 any	(список) Пароль 4.
password5 any	(список) Пароль 5.
port integer	Порт.
port2 integer	Порт 2.
port3 integer	Порт 3.
port4 integer	Порт 4.
port5 integer	Порт 5.
server string	Сервер.
server2 string	Сервер 2.
server3 string	Сервер 3.
server4 string	Сервер 4.
server5 string	Сервер 5.
sni string	Индикация имени сервера.
source_ip aliases: source-ip string	IP-адрес источника.
source_ip6 aliases: source-ip6 string	IPv6-адрес источника.
ssl string	SSL. Варианты: `"disable"` `"enable"`
ssl_server_host_ip_check aliases: ssl-server-host-ip-check string	Включить/отключить проверку имени узла/ IP-адреса сервера. Варианты: `"disable"` `"enable"`
ssl_trusted_cert aliases: ssl-trusted-cert string	Доверенный сертификат SSL.
type string	Тип. Варианты: `"default"` `"fortiems"` `"fortinac"` `"fortiems-cloud"`
user_info_server aliases: user-info-server any	(список или строка) Сервер сведений о пользователях.
vrf_select aliases: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
group_poll_interval aliases: group-poll-interval integer	Интервал в минутах между получением групп с сервера FSSO; если параметр не задан, получение отключено.
interface string	Укажите исходящий интерфейс для подключения к серверу.
interface_select_method aliases: interface-select-method string	Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
ldap_poll aliases: ldap-poll string	Включить/отключить автоматическое получение групп с сервера LDAP. Варианты: `"disable"` `"enable"`
ldap_poll_filter aliases: ldap-poll-filter string	Фильтр для получения групп.
ldap_poll_interval aliases: ldap-poll-interval integer	Интервал в минутах между получением групп с сервера LDAP.
ldap_server aliases: ldap-server string	Сервер LDAP для получения сведений о группах.
logon_timeout aliases: logon-timeout integer	Интервал в минутах, в течение которого сохраняются сеансы входа после отключения сервера FSSO.
name string / обязательный	Имя.
password any	(список) Пароль первого агента-сборщика FSSO.
password2 any	(список) Пароль второго агента-сборщика FSSO.
password3 any	(список) Пароль третьего агента-сборщика FSSO.
password4 any	(список) Пароль четвёртого агента-сборщика FSSO.
password5 any	(список) Пароль пятого агента-сборщика 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	Индикация имени сервера.
source_ip aliases: source-ip string	Исходный IP-адрес для связи с агентом FSSO.
source_ip6 aliases: source-ip6 string	Исходный IPv6-адрес для связи с агентом FSSO.
ssl string	Включить/отключить использование SSL. Варианты: `"disable"` `"enable"`
ssl_server_host_ip_check aliases: ssl-server-host-ip-check string	Включить/отключить проверку имени/IP-адреса узла сервера. Варианты: `"disable"` `"enable"`
ssl_trusted_cert aliases: ssl-trusted-cert string	Доверенный сертификат сервера или сертификат центра сертификации.
type string	Тип сервера. Варианты: `"default"` `"fortiems"` `"fortinac"` `"fortiems-cloud"`
user_info_server aliases: user-info-server string	LDAP-сервер для получения сведений о пользователях.
vrf_select aliases: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другие значения, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов записываются в формате snake_case с подчёркиваниями. Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но будут выдаваться предупреждения об устаревании. Это предупреждение можно игнорировать, задав deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочего пространства; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается ошибкой при возврате ненулевого кода rc. Условия завершения с ошибкой или успехом также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure Fortinet Single Sign On (FSSO) agents.
      fortinet.fortimanager.fmgr_user_fsso:
        bypass_validation: false
        adom: ansible
        state: present
        user_fsso:
          name: ansible-test-fsso
          password: fortinet
          port: 9000
          server: ansible

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the Fortinet Single Sign On (FSSO) agents
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_fsso"
          params:
            adom: "ansible"
            fsso: "your_value"

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortimanager/fmgr_user_fsso_module.html