Spec-Zone.ru › Ansible

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

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

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции user и категории saml. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с 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_saml

dictionary

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

adfs_claim

string

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

Варианты:

  • "enable"
  • "disable"

auth_url

string

URL для проверки аутентификации.

cert

string

Сертификат для подписывания сообщений SAML. Источник: vpn.certificate.local.name.

clock_tolerance

integer

Допустимое расхождение времени в секундах (0–300).

digest_method

string

Алгоритм дайджест-функции.

Варианты:

  • "sha1"
  • "sha256"

entity_id

string

Идентификатор сущности SP.

group_claim_type

string

Утверждение о группе в операторе утверждения.

Варианты:

  • "email"
  • "given-name"
  • "name"
  • "upn"
  • "common-name"
  • "email-adfs-1x"
  • "group"
  • "upn-adfs-1x"
  • "role"
  • "sur-name"
  • "ppid"
  • "name-identifier"
  • "authentication-method"
  • "deny-only-group-sid"
  • "deny-only-primary-sid"
  • "deny-only-primary-group-sid"
  • "group-sid"
  • "primary-group-sid"
  • "primary-sid"
  • "windows-account-name"

group_name

string

Имя группы в операторе утверждения.

idp_cert

string

Имя сертификата IDP. Источник: vpn.certificate.remote.name.

idp_entity_id

string

Идентификатор сущности IDP.

idp_single_logout_url

string

URL единого выхода IDP.

idp_single_sign_on_url

string

URL единого входа IDP.

limit_relaystate

string

Включить или отключить ограничение параметра relay-state, если его размер превышает ограничения спецификации SAML 2.0 (80 байт).

Варианты:

  • "enable"
  • "disable"

name

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

Имя записи сервера SAML.

reauth

string

Включить или отключить передачу IDP сигнала для принудительной повторной аутентификации пользователя.

Варианты:

  • "enable"
  • "disable"

require_signed_resp_and_asrt

string

Требовать подпись и ответа, и утверждения от IDP, когда FGT выступает в роли SP.

Варианты:

  • "enable"
  • "disable"

scim_client

string

Имя клиента SCIM. Источник: user.scim.name.

scim_group_attr_type

string

Тип атрибута группы, используемый для сопоставления групп SCIM.

Варианты:

  • "display-name"
  • "external-id"

scim_user_attr_type

string

Тип атрибута пользователя, используемый для сопоставления пользователей SCIM.

Варианты:

  • "user-name"
  • "display-name"
  • "external-id"
  • "email"

single_logout_url

string

URL единого выхода SP.

single_sign_on_url

string

URL единого входа SP.

user_claim_type

string

Утверждение об имени пользователя в операторе утверждения.

Варианты:

  • "email"
  • "given-name"
  • "name"
  • "upn"
  • "common-name"
  • "email-adfs-1x"
  • "group"
  • "upn-adfs-1x"
  • "role"
  • "sur-name"
  • "ppid"
  • "name-identifier"
  • "authentication-method"
  • "deny-only-group-sid"
  • "deny-only-primary-sid"
  • "deny-only-primary-group-sid"
  • "group-sid"
  • "primary-group-sid"
  • "primary-sid"
  • "windows-account-name"

user_name

string

Имя пользователя в операторе утверждения.

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: SAML server entry configuration.
  fortinet.fortios.fortios_user_saml:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_saml:
          adfs_claim: "enable"
          auth_url: "<your_own_value>"
          cert: "<your_own_value> (source vpn.certificate.local.name)"
          clock_tolerance: "15"
          digest_method: "sha1"
          entity_id: "<your_own_value>"
          group_claim_type: "email"
          group_name: "<your_own_value>"
          idp_cert: "<your_own_value> (source vpn.certificate.remote.name)"
          idp_entity_id: "<your_own_value>"
          idp_single_logout_url: "<your_own_value>"
          idp_single_sign_on_url: "<your_own_value>"
          limit_relaystate: "enable"
          name: "default_name_16"
          reauth: "enable"
          require_signed_resp_and_asrt: "enable"
          scim_client: "<your_own_value> (source user.scim.name)"
          scim_group_attr_type: "display-name"
          scim_user_attr_type: "user-name"
          single_logout_url: "<your_own_value>"
          single_sign_on_url: "<your_own_value>"
          user_claim_type: "email"
          user_name: "<your_own_value>"

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

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

Ключ

Описание

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_saml_module.html

Spec-Zone.ru

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