Вызов RunbookInvoke Runbook

Важно!

Эта версия Orchestrator достигла конца поддержки, мы рекомендуем выполнить обновление до Orchestrator 2019.This version of Orchestrator has reached the end of support, we recommend you to upgrade to Orchestrator 2019.

Действие вызов Runbook запускает указанный модуль Runbook.The Invoke Runbook activity launches a runbook that you have specified. Вы можете передавать данные в модули Runbook, настроив действие " Инициализация данных " в вызываемом модуле Runbook.You can transfer data to runbooks by configuring an Initialize Data activity in the invoked runbook. Вы можете вернуть данные из вызванного модуля Runbook, настроив действие return Data .You can return data from the invoked runbook by configuring a Return Data activity.

Действие вызвать Runbook можно использовать для вызова универсальных модулей Runbook, которые выполняют только определенные действия, не зависящие от способа вызова модуля Runbook.You can use the Invoke Runbook activity to invoke generic runbooks that only perform specific actions that do not depend on how the runbook is invoked. Например, можно создать модуль Runbook, который вызывает отдельные модули Runbook для выполнения процедуры обслуживания резервного копирования, которая, в свою очередь, вызывает модуль Runbook для завершения работы служб, другой модуль Runbook для резервного копирования данных, а затем окончательный модуль Runbook для перезапуска служб.For example, you can create a runbook that calls separate runbooks to perform a backup maintenance procedure that in turn calls a runbook to shut down services, another runbook to back up data, and then a final runbook to restart the services.

Важно!

Если изменить имя папки или расположение модуля Runbook, необходимо также повторно настроить все действия вызова Runbook, которые ссылаются на измененный модуль Runbook.If you modify the folder name or location of a runbook, you must also re-configure any Invoke Runbook activity that references the modified runbook.

Настройка действия "вызов Runbook"Configuring the Invoke Runbook activity

Перед настройкой действия "вызов Runbook" необходимо знать, какой модуль Runbook вы вызываете.Before you configure the Invoke Runbook activity, you need to know which runbook you are invoking.

Используйте следующие сведения для настройки действия "вызов Runbook".Use the following information to configure the Invoke Runbook activity.

СведенияDetails

ПараметрыSettings Инструкции по настройкеConfiguration Instructions
Модуль RunbookRunbook Нажмите кнопку с многоточием (...) , чтобы найти модуль Runbook, который требуется вызвать.Click the ellipsis (...) button to browse for the runbook that you want to invoke. Важно. Не вызывайте модуль Runbook, который начинается с действия Monitor.Important: Do not invoke a runbook that starts with a Monitor activity.
Вызов по путиInvoke by path Выберите, чтобы принудительно вызвать Runbook действие вызов Runbook по указанному пути и имени.Select to force the Invoke Runbook activity to invoke the runbook by the specific path and name. Если этот флажок установлен, вызывается любой модуль Runbook с тем же именем в одном расположении папки.When selected, any runbook with the same name in the same folder location is invoked. Если этот параметр не выбран, вызываемый модуль Runbook может быть перемещен вокруг среды, а действие вызвать Runbook автоматически сопоставляется с новым расположением.When unselected, the runbook that is invoked can be moved around the environment and the Invoke Runbook activity automatically maps itself to the new location.
Ожидание завершенияWait for completion Выберите, чтобы принудительно выполнить действие "вызов Runbook" для сохранения вызванного модуля Runbook, пока он не будет завершен.Select to force the Invoke Runbook activity to keep the invoked runbook running until it is completed. Важно. Не выбирайте параметр ожидать завершения , если какие-либо возвращаемые данные в вызываемом модуле Runbook также возвращают данные в вызывающий модуль Runbook.Important: Do not select Wait for completion if any return data in the invoked runbook is also return data in the invoking runbook.
ПараметрыParameters Если вы выбрали модуль Runbook, содержащий действие " Инициализация данных ", будет отображен список параметров, необходимых для вызова этого действия.If you have selected a runbook that contains an Initialize Data activity, the list of parameters required to invoke that activity will be displayed. Введите значение для каждого параметра.Enter a value for each parameter.
Серверы RunbookRunbook Servers Введите список серверов Runbook, которые будут запускать этот модуль Runbook.Type the list of runbook servers that will run this runbook. Каждое имя отделяется точкой с запятой (;) .Separate each name with a semi-colon (;). Порядок, в котором перечислены серверы Runbook, будет использоваться для отработки отказа и балансировки нагрузки модуля Runbook.The order in which the runbook servers are listed will be the order used for failover and load balancing of the runbook. Имена серверов Runbook должны соответствовать именам, отображаемым в дереве сервера Runbook в диспетчер развертывания Orchestrator.The runbook server names must correspond to the names that are displayed within the runbook server’s tree in the Orchestrator Deployment Manager. Оставьте это поле пустым, чтобы использовать Runbook или глобальные значения по умолчанию для назначения сервера Runbook Server.Leave this field blank to use the runbook or global defaults for the runbook server assignment.

Опубликованные данныеPublished Data

В следующей таблице перечислены элементы опубликованных данных из действия "вызов Runbook".The following table lists the published data items from the Invoke Runbook activity.

ЭлементItem ОписаниеDescription
Идентификатор задания дочернего RunbookChild runbook Job ID Идентификатор задания вызванного модуля Runbook.The job ID of the invoked runbook.
Состояние дочернего RunbookChild runbook status Состояние, опубликованное дочерним модулем Runbook.The status published by the child runbook.

Действие вызов Runbook возвращает все данные, которые вызываемый модуль Runbook определил на вкладке возвращенные данные свойств Runbook.The Invoke Runbook activity returns any data that the invoked runbook has defined in the Returned Data tab of the runbook properties. Значения этих свойств должны быть заполнены с помощью действия возврата данных в этом рабочем процессе.The values of these properties must be populated using Return Data activity in that workflow. Если текущий модуль Runbook должен возвращать данные из вызванного модуля Runbook, он должен иметь собственное действие return Data , которое включает эти значения.If the current runbook needs to return data from the invoked runbook, then it must have its own Return Data activity that includes these values.

Учетные данныеCredentials

Если вы используете действие "вызов Runbook" и используете учетные данные безопасности, используемая учетная запись должна быть членом системной группы Orchestrator для успешного выполнения.If you use the Invoke Runbook activity and you use Security Credentials, the account you use must be a member of the Orchestrator System group to run successfully.

См. также:See Also

Инициализация данных Initialize Data
Возврат данных Return Data
Учетная запись для безопасного доступаSecurity Credentials