fortinet.fortimanager.fmgr_sys_login_user – Авторизация на устройстве с именем пользователя и паролем. Новый сеанс cookie будет сгенерирован и возвращен в качестве свойства объекта ответа.

Примечание

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

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

Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_sys_login_user.

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed list / elements=string			список кодов rc, при которых выполнение будет прервано
rc_succeeded list / elements=string			список кодов rc, при которых выполнение будет успешно завершено
sys_login_user dictionary			устанавливает параметры верхнего уровня
	passwd string		без описания
	user string		без описания
workspace_locking_adom string			область (adom) для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой
workspace_locking_timeout integer		Значение по умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем

Примечания

Примечание

В этом модуле FortiManager поддерживается режим блокировки рабочего пространства; параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачно, если возвращается ненулевой код rc. Вы также можете переопределить условия завершения с ошибкой или успехом с помощью параметров 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: Log into the device with user name and password. A new session cookies will be generated and returned as a property of the response object.
     fmgr_sys_login_user:
        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, ...]
        sys_login_user:
           passwd: <value of string>
           user: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрошенный URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Описание ответа 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_sys_login_user_module.html