fortinet.fortimanager.fmgr_user_fortitoken – Настройка FortiToken.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation булево		Варианты: нет ← да	устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка			список кодов rc, при которых выполнение будет прервано
rc_succeeded список / элементы=строка			список кодов rc, при которых выполнение будет завершено успешно
state строка / обязательно		Варианты: present absent	указание на создание, обновление или удаление объекта
user_fortitoken словарь			параметры верхнего уровня
	comments строка		Комментарий.
	license строка		Лицензия для мобильного токена.
	os-ver строка		Версия мобильного устройства.
	reg-id строка		ID регистрации устройства.
	serial-number строка		Серийный номер.
	status строка	Варианты: lock active	Статус
workspace_locking_adom строка			Область, блокируемая для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и др. включая корень
workspace_locking_timeout целое число		Значение по умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочей области

Примечания

Примечание

Работа в режиме блокировки рабочей области поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться неудачей, если возвращен код rc != 0. Вы можете также переопределить условия неудачи или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure FortiToken.
     fmgr_user_fortitoken:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        user_fortitoken:
           comments: <value of string>
           license: <value of string>
           os-ver: <value of string>
           reg-id: <value of string>
           serial-number: <value of string>
           status: <value in [lock, active]>

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрос URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_user_fortitoken_module.html