fortinet.fortimanager.fmgr_dvmdb_workflow_start – Продолжить сеанс выполнения рабочего процесса. Начать новый сеанс, если идентификатор не указан в запросе.<br/><br/>Обратитесь к объектам workflow и wflog для …

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое		Варианты: нет ← да	устанавливается в True только при различиях между схемой модуля и структурой API FortiManager, модуль продолжает выполняться без проверки параметров
dvmdb_workflow_start словарь			параметры верхнего уровня
	desc строка		нет описания
	name строка		нет описания
rc_failed список / элементы=строка			список кодов rc, при которых выполнение будет прекращено
rc_succeeded список / элементы=строка			список кодов rc, при которых выполнение будет успешно завершено
session_id строка / обязательно			параметр (session_id) в запрошенном URL
workspace_locking_adom строка			adom для блокировки при работе FortiManager в режиме рабочего пространства. Может быть глобальным или другим, включая корневой.
workspace_locking_timeout целое число		По умолчанию: 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: Continue a workflow session. Start a new session if ID is not specified in the request.<br/><br/>Refer to workflow and wflog object for ...
     fmgr_dvmdb_workflow_start:
        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>
        session_id: <your own value>
        dvmdb_workflow_start:
           desc: <value of string>
           name: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
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_dvmdb_workflow_start_module.html