Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook, укажите: fortinet.fortios.fortios_user_fsso.

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

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

Обзор

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

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

строка

Аутентификация на основе токена. Сгенерировано из графического интерфейса Fortigate.

enable_log

булево

Включить/выключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

строка

Путь к атрибуту члена для обработки.

Разделяется слешем, если атрибутов более одного.

Параметр, помеченный member_path, подходит для выполнения операций с членами.

member_state

строка

Добавить или удалить члена по указанному пути к атрибуту.

При указании member_state параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

строка / обязательно

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

user_fsso

словарь

Настройка агентов Fortinet Single Sign On (FSSO).

group_poll_interval

целое число

Интервал в минутах для получения групп с сервера FSSO, или не задано для отключения.

interface

строка

Укажите исходящий интерфейс для достижения сервера. Имя интерфейса целевой системы.

interface_select_method

строка

Укажите, как выбрать исходящий интерфейс для достижения сервера.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

ldap_poll

строка

Включить/выключить автоматическое извлечение групп с сервера LDAP.

Варианты:

  • "enable"
  • "disable"

ldap_poll_filter

строка

Фильтр, используемый для извлечения групп.

ldap_poll_interval

целое число

Интервал в минутах для получения групп с сервера LDAP.

ldap_server

строка

Сервер LDAP для получения информации о группах. Имя LDAP сервера пользователя.

logon_timeout

целое число

Интервал в минутах для сохранения логинов после выключения сервера FSSO.

name

строка / обязательно

Имя.

password

строка

Пароль первого агента-коллектора FSSO.

password2

строка

Пароль второго агента-коллектора FSSO.

password3

строка

Пароль третьего агента-коллектора FSSO.

password4

строка

Пароль четвертого агента-коллектора FSSO.

password5

строка

Пароль пятого агента-коллектора FSSO.

port

целое число

Порт первого агента-коллектора FSSO.

port2

целое число

Порт второго агента-коллектора FSSO.

port3

целое число

Порт третьего агента-коллектора FSSO.

port4

целое число

Порт четвертого агента-коллектора FSSO.
END_OF_DOCUMENT_MARKER

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

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.

vdom

string

Виртуальный домен, среди тех, что определены ранее. Vdom — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельный блок.

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

Примечания

Примечание

  • Модуль fortiosapi устарел, httpapi предпочтительнее для выполнения playbooks
  • Модуль поддерживает режим 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)"

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

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

Ключ

Описание

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

Spec-Zone.ru

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