fortinet.fortios.fortios_user_saml модуль — Настройка входа сервера SAML в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля потребуются дополнительные требования, см. Требования для подробностей.
Чтобы использовать его в playbook, укажите: fortinet.fortios.fortios_user_saml.
Новое в fortinet.fortios 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры пользователя и категорию SAML. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токенов. Сгенерировано в графическом интерфейсе Fortigate. |
enable_log логическое | Включить/выключить ведение журнала для задачи. Выборы:
|
member_path строка | Путь к атрибуту участника для обработки. Разделяется символом косой черты, если атрибутов несколько. Параметр, помеченный как member_path, подходит для выполнения операций с участниками. |
member_state строка | Добавить или удалить участника по указанному пути к атрибуту. При указании member_state параметр state игнорируется. Выборы:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Выборы:
|
user_saml словарь | Настройка входа сервера SAML. |
|
adfs_claim строка |
Включить/выключить ADFS Claim для атрибута пользователя/группы в заявлении утверждения. Выборы:
|
|
auth_url строка |
URL для проверки аутентификации. |
|
cert строка |
Сертификат для подписи сообщений SAML. Источник vpn.certificate.local.name. |
|
clock_tolerance целое число |
Допуск смещения часов в секундах (0 - 300). |
|
digest_method строка |
Алгоритм метода дайджеста. Выборы:
|
|
entity_id строка |
Идентификатор сущности SP. |
|
group_claim_type строка |
Тип утверждения группы в заявлении утверждения. Выборы:
|
|
group_name строка |
Имя группы в заявлении утверждения. |
|
idp_cert строка |
Имя сертификата IDP. Источник vpn.certificate.remote.name. |
|
idp_entity_id строка |
Идентификатор сущности IDP. |
|
idp_single_logout_url строка |
URL единого выхода IDP. |
|
idp_single_sign_on_url строка |
URL единого входа IDP. |
|
limit_relaystate строка |
Включить/выключить ограничение параметра relay-state, если он превышает лимиты спецификации SAML 2.0 (80 байт). Выборы:
|
|
name строка / обязательно |
Имя входа сервера SAML. |
|
reauth строка |
Включить/выключить передачу сигнала IDP для принудительной повторной аутентификации пользователя. Выборы:
|
|
single_logout_url string |
URL для выхода из системы SP. |
|
single_sign_on_url string |
URL для входа SP. |
|
user_claim_type string |
Имя пользователя в утверждении. Варианты:
|
|
user_name string |
Имя пользователя в утверждении. |
vdom string | Виртуальная область, среди ранее определённых. VDOM — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks
- Модуль поддерживает режим проверки (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"
single_logout_url: "<your_own_value>"
single_sign_on_url: "<your_own_value>"
user_claim_type: "email"
user_name: "<your_own_value>"
Значения возврата
Общие значения возврата документированы здесь, ниже приведены поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate после последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: успех Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер версии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Использованный виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_user_saml_module.html
