Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_user_local — настройка локальных пользователей в 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_local.

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

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

Обзор

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

Имя локального пользователя.

passwd

string

Пароль пользователя.

passwd_policy

string

Политика паролей, применяемая к этому пользователю, как задано в config user password-policy. Источник: user.password-policy.name.

passwd_time

string

Время последнего обновления пароля.

ppk_identity

string

Идентификатор постквантового предварительно общего ключа IKEv2.

ppk_secret

string

Постквантовый предварительно общий ключ IKEv2 (строка ASCII или шестнадцатеричное значение с префиксом 0x).

qkd_profile

string

Профиль распределения квантовых ключей (QKD). Источник: vpn.qkd.name.

radius_server

string

Имя RADIUS-сервера, на котором пользователь должен пройти аутентификацию. Источник: user.radius.name.

saml_server

string

Имя SAML-сервера, на котором пользователь должен пройти аутентификацию. Источник: user.saml.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"
  • "saml"

username_case_sensitivity

string

Включить или отключить учёт регистра при сопоставлении имён пользователей (прописные и строчные буквы будут считаться различными или эквивалентными).

Варианты:

  • "disable"
  • "enable"

username_sensitivity

string

Включить или отключить учёт регистра и диакритических знаков при сопоставлении имён пользователей (если параметр отключён, диакритические знаки удаляются, а регистр не учитывается).

Варианты:

  • "disable"
  • "enable"

workstation

string

Имя удалённой рабочей станции пользователя, если требуется разрешить аутентификацию только с определённой рабочей станции.

vdom

string

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

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

Примечания

Примечание

  • Устаревшая библиотека fortiosapi объявлена устаревшей; предпочтительный способ запуска плейбуков — httpapi
  • Модуль поддерживает 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)"
          saml_server: "<your_own_value> (source user.saml.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

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

Spec-Zone.ru

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