Модуль fortinet.fortios.fortios_user_local — Настройка локальных пользователей в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortios.fortios_user_local.

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

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

Обзор

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

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается в графическом интерфейсе Fortigate.
enable_log boolean	Включить/отключить логирование для задачи. Варианты: `false` ← (default) `true`
member_path string	Путь к атрибуту члена для выполнения операции. Разделяется символом слеша, если атрибутов несколько. Параметр, помеченный как member_path, является допустимым для выполнения операции с членом.
member_state string	Добавить или удалить члена по указанному пути к атрибуту. При указании member_state опция state игнорируется. Варианты: `"present"` `"absent"`
state string / required	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
user_local dictionary	Настроить локальных пользователей.
auth_concurrent_override string	Включить/отключить переопределение policy-auth-concurrent в config system global. Варианты: `"enable"` `"disable"`
auth_concurrent_value integer	Максимальное количество одновременных входов, разрешенных для одного пользователя.
authtimeout integer	Время в минутах до истечения времени ожидания аутентификации для пользователя.
email_to string	Электронный адрес получателя двухфакторной аутентификации.
fortitoken string	Серийный номер FortiToken получателя двухфакторной аутентификации. Источник user.fortitoken.serial-number.
id integer	Идентификатор пользователя.
ldap_server string	Имя LDAP-сервера, с которым пользователь должен пройти аутентификацию. Источник user.ldap.name.
name string / required	Имя локального пользователя.
passwd string	Пароль пользователя.
passwd_policy string	Политика паролей, применяемая к этому пользователю, как определено в config user password-policy. Источник user.password-policy.name.
passwd_time string	Время последнего обновления пароля.
ppk_identity string	Идентификатор предварительно разделяемого ключа IKEv2 Postquantum.
ppk_secret string	Предварительно разделяемый ключ IKEv2 Postquantum (ASCII-строка или шестнадцатеричное кодирование с ведущим 0x).
qkd_profile string	Профиль квантового распределения ключей (QKD). Источник vpn.qkd.name.
radius_server string	Имя RADIUS-сервера, с которым пользователь должен пройти аутентификацию. Источник user.radius.name.
sms_custom_server string	SMS-сервер получателя двухфакторной аутентификации. Источник system.sms-server.name.
sms_phone string	Номер мобильного телефона получателя двухфакторной аутентификации.
sms_server string	Отправка SMS через FortiGuard или другой внешний сервер. Варианты: `"fortiguard"` `"custom"`

status string	Включить/отключить возможность локальному пользователю авторизоваться на устройстве FortiGate. Варианты: `"enable"` `"disable"`
tacacs_plus_server string	Имя сервера TACACS+ для авторизации пользователя. Источник: user.tacacs+.name.
two_factor string	Включить/отключить двухфакторную авторизацию. Варианты: `"disable"` `"fortitoken"` `"fortitoken-cloud"` `"email"` `"sms"`
two_factor_authentication string	Метод авторизации FortiToken Cloud. Варианты: `"fortitoken"` `"email"` `"sms"`
two_factor_notification string	Способ уведомления для активации пользователя FortiToken Cloud. Варианты: `"email"` `"sms"`
type string	Метод авторизации. Варианты: `"password"` `"radius"` `"tacacs+"` `"ldap"`
username_case_sensitivity string	Включить/отключить чувствительность к регистру при сопоставлении имен пользователей (заглавные и строчные буквы рассматриваются как разные или эквивалентные). Варианты: `"disable"` `"enable"`
username_sensitivity string	Включить/отключить чувствительность к регистру и акцентам при сопоставлении имен пользователей (акценты удаляются, а регистр игнорируется при отключении). Варианты: `"disable"` `"enable"`
workstation string	Имя удаленной рабочей станции пользователя, если нужно ограничить авторизацию только с определенной рабочей станции.
vdom string	Виртуальная область, определенная ранее. VDOM — виртуальная копия FortiGate, которая может быть настроена и использоваться как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, httpapi является предпочтительным способом выполнения playbooks
Модуль поддерживает режим check_mode.

Примеры

- name: Configure local users.
  fortinet.fortios.fortios_user_local:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_local:
          auth_concurrent_override: "enable"
          auth_concurrent_value: "0"
          authtimeout: "0"
          email_to: "<your_own_value>"
          fortitoken: "<your_own_value> (source user.fortitoken.serial-number)"
          id: "8"
          ldap_server: "<your_own_value> (source user.ldap.name)"
          name: "default_name_10"
          passwd: "<your_own_value>"
          passwd_policy: "<your_own_value> (source user.password-policy.name)"
          passwd_time: "<your_own_value>"
          ppk_identity: "<your_own_value>"
          ppk_secret: "<your_own_value>"
          qkd_profile: "<your_own_value> (source vpn.qkd.name)"
          radius_server: "<your_own_value> (source user.radius.name)"
          sms_custom_server: "<your_own_value> (source system.sms-server.name)"
          sms_phone: "<your_own_value>"
          sms_server: "fortiguard"
          status: "enable"
          tacacs_plus_server: "<your_own_value> (source user.tacacs+.name)"
          two_factor: "disable"
          two_factor_authentication: "fortitoken"
          two_factor_notification: "email"
          type: "password"
          username_case_sensitivity: "disable"
          username_sensitivity: "disable"
          workstation: "<your_own_value>"

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

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

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