Модуль fortinet.fortios.fortios_user_fortitoken — Настройка FortiToken в 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_fortitoken.

Новый в fortinet.fortios 2.0.0

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

Описание

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

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано в графическом интерфейсе Fortigate.
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется символом косой черты, если атрибутов более одного. Параметр, помеченный member_path, является допустимым для выполнения операции member.
member_state строка	Добавить или удалить члена по указанному пути к атрибуту. Когда member_state указан, опция state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательно	Указывает, создавать или удалять объект. Варианты: `"present"` `"absent"`
user_fortitoken словарь	Настройка FortiToken.
activation_code строка	Код активации мобильного токена пользователя.
activation_expire целое число	Время истечения кода активации мобильного токена пользователя.
comments строка	Комментарий.
license строка	Лицензия мобильного токена.
os_ver строка	Версия мобильного устройства.
reg_id строка	Регистрационный ID устройства.
seed строка	Семена токена.
serial_number строка / обязательно	Серийный номер.
status строка	Статус. Варианты: `"active"` `"lock"`
vdom строка	Виртуальная область, среди тех, которые были определены ранее. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использоваться как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure FortiToken.
  fortinet.fortios.fortios_user_fortitoken:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_fortitoken:
          activation_code: "<your_own_value>"
          activation_expire: "0"
          comments: "<your_own_value>"
          license: "<your_own_value>"
          os_ver: "<your_own_value>"
          reg_id: "<your_own_value>"
          seed: "<your_own_value>"
          serial_number: "<your_own_value>"
          status: "active"

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

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

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