Runbooks in System Center Orchestrator are based on activities from integration packs that are written specifically for Orchestrator while runbooks in Azure Automation are based on Windows PowerShell. Graphical runbooks in Azure Automation have a similar appearance to Orchestrator runbooks with their activities representing PowerShell cmdlets, child runbooks, and assets.
The System Center Orchestrator Migration Toolkit includes tools to assist you in converting runbooks from Orchestrator to Azure Automation. In addition to converting the runbooks themselves, you must convert the integration packs with the activities that the runbooks use to integration modules with Windows PowerShell cmdlets.
Following is the basic process for converting Orchestrator runbooks to Azure Automation. Each of these steps is described in detail in the sections below.
- Download the System Center Orchestrator Migration Toolkit which contains the tools and modules discussed in this article.
- Import Standard Activities Module into Azure Automation. This includes converted versions of standard Orchestrator activities that may be used by converted runbooks.
- Import System Center Orchestrator Integration Modules into Azure Automation for those integration packs used by your runbooks that access System Center.
- Convert custom and third party integration packs using the Integration Pack Converter and import into Azure Automation.
- Convert Orchestrator runbooks using the Runbook Converter and install in Azure Automation.
- Manually create required Orchestrator assets in Azure Automation since the Runbook Converter does not convert these resources.
- Configure a Hybrid Runbook Worker in your local data center to run converted runbooks that will access local resources.
Service Management Automation
Service Management Automation (SMA) stores and runs runbooks in your local data center like Orchestrator, and it uses the same integration modules as Azure Automation. The Runbook Converter converts Orchestrator runbooks to graphical runbooks though which are not supported in SMA. You can still install the Standard Activities Module and System Center Orchestrator Integration Modules into SMA, but you must manually rewrite your runbooks.
Hybrid Runbook Worker
Runbooks in Orchestrator are stored on a database server and run on runbook servers, both in your local data center. Runbooks in Azure Automation are stored in the Azure cloud and can run in your local data center using a Hybrid Runbook Worker. This is how you will usually run runbooks converted from Orchestrator since they are designed to run on local servers.
Integration Pack Converter
The Integration Pack Converter converts integration packs that were created using the Orchestrator Integration Toolkit (OIT) to integration modules based on Windows PowerShell that can be imported into Azure Automation or Service Management Automation.
When you run the Integration Pack Converter, you are presented with a wizard that will allow you to select an integration pack (.oip) file. The wizard then lists the activities included in that integration pack and allows you to select which will be migrated. When you complete the wizard, it creates an integration module that includes a corresponding cmdlet for each of the activities in the original integration pack.
Any properties of an activity in the integration pack are converted to parameters of the corresponding cmdlet in the integration module. Windows PowerShell cmdlets have a set of common parameters that can be used with all cmdlets. For example, the -Verbose parameter causes a cmdlet to output detailed information about its operation. No cmdlet may have a parameter with the same name as a common parameter. If an activity does have a property with the same name as a common parameter, the wizard will prompt you to provide another name for the parameter.
Monitor runbooks in Orchestrator start with a monitor activity and run continuously waiting to be invoked by a particular event. Azure Automation does not support monitor runbooks, so any monitor activities in the integration pack will not be converted. Instead, a placeholder cmdlet is created in the integration module for the monitor activity. This cmdlet has no functionality, but it allows any converted runbook that uses it to be installed. This runbook will not be able to run in Azure Automation, but it can be installed so that you can modify it.
Integration packs that cannot be converted
Integration packs that were not created with OIT cannot be converted with the Integration Pack Converter. There are also some integration packs provided by Microsoft that cannot currently be converted with this tool. Converted versions of these integration packs have been provided for download so that they can be installed in Azure Automation or Service Management Automation.
Standard Activities Module
Orchestrator includes a set of standard activities that are not included in an integration pack but are used by many runbooks. The Standard Activities module is an integration module that includes a cmdlet equivalent for each of these activities. You must install this integration module in Azure Automation before importing any converted runbooks that use a standard activity.
In addition to supporting converted runbooks, the cmdlets in the standard activities module can be used by someone familiar with Orchestrator to build new runbooks in Azure Automation. While the functionality of all of the standard activities can be performed with cmdlets, they may operate differently. The cmdlets in the converted standard activities module will work the same as their corresponding activities and use the same parameters. This can help the existing Orchestrator runbook author in their transition to Azure Automation runbooks.
System Center Orchestrator Integration Modules
Microsoft provides integration packs for building runbooks to automate System Center components and other products. Some of these integration packs are currently based on OIT but cannot currently be converted to integration modules because of known issues. System Center Orchestrator Integration Modules includes converted versions of these integration packs that can be imported into Azure Automation and Service Management Automation.
By the RTM version of this tool, updated versions of the integration packs based on OIT that can be converted with the Integration Pack Converter will be published. Guidance will also be provided to assist you in converting runbooks using activities from the integration packs not based on OIT.
The Runbook Converter converts Orchestrator runbooks into graphical runbooks that can be imported into Azure Automation.
Runbook Converter is implemented as a PowerShell module with a cmdlet called ConvertFrom-SCORunbook that performs the conversion. When you install the tool, it will create a shortcut to a PowerShell session that loads the cmdlet.
Following is the basic process to convert an Orchestrator runbook and import it into Azure Automation. The following sections provide further details on using the tool and working with converted runbooks.
- Export one or more runbooks from Orchestrator.
- Obtain integration modules for all activities in the runbook.
- Convert the Orchestrator runbooks in the exported file.
- Review information in logs to validate the conversion and to determine any required manual tasks.
- Import converted runbooks into Azure Automation.
- Create any required assets in Azure Automation.
- Edit the runbook in Azure Automation to modify any required activities.
Using Runbook Converter
The syntax for ConvertFrom-SCORunbook is as follows:
ConvertFrom-SCORunbook -RunbookPath <string> -Module <string> -OutputFolder <string>
- RunbookPath - Path to the export file containing the runbooks to convert.
- Module - Comma delimited list of integration modules containing activities in the runbooks.
- OutputFolder - Path to the folder to create converted graphical runbooks.
The following example command converts the runbooks in an export file called MyRunbooks.ois_export. These runbooks use the Active Directory and Data Protection Manager integration packs.
ConvertFrom-SCORunbook -RunbookPath "c:\runbooks\MyRunbooks.ois_export" -Module c:\ip\SystemCenter_IntegrationModule_ActiveDirectory.zip,c:\ip\SystemCenter_IntegrationModule_DPM.zip -OutputFolder "c:\runbooks"
The Runbook Converter will create the following log files in the same location as the converted runbook. If the files already exist, then they will be overwritten with information from the last conversion.
|Runbook Converter - Progress.log||Detailed steps of the conversion including information for each activity successfully converted and warning for each activity not converted.|
|Runbook Converter - Summary.log||Summary of the last conversion including any warnings and follow up tasks that you need to perform such as creating a variable required for the converted runbook.|
Exporting runbooks from Orchestrator
The Runbook Converter works with an export file from Orchestrator that contains one or more runbooks. It will create a corresponding Azure Automation runbook for each Orchestrator runbook in the export file.
To export a runbook from Orchestrator, right-click the name of the runbook in Runbook Designer and select Export. To export all runbooks in a folder, right-click the name of the folder and select Export.
The Runbook Converter converts each activity in the Orchestrator runbook to a corresponding activity in Azure Automation. For those activities that can't be converted, a placeholder activity is created in the runbook with warning text. After you import the converted runbook into Azure Automation, you must replace any of these activities with valid activities that perform the required functionality.
Any Orchestrator activities in the Standard Activities Module will be converted. There are some standard Orchestrator activities that are not in this module though and are not converted. For example, Send Platform Event has no Azure Automation equivalent since the event is specific to Orchestrator.
Monitor activities are not converted since there is no equivalent to them in Azure Automation. The exception are monitor activities in converted integration packs that will be converted to the placeholder activity.
Any activity from a converted integration pack will be converted if you provide the path to the integration module with the modules parameter. For System Center Integration Packs, you can use the System Center Orchestrator Integration Modules.
The Runbook Converter only converts runbooks, not other Orchestrator resources such as counters, variables, or connections. Counters are not supported in Azure Automation. Variables and connections are supported, but you must create them manually. The log files will inform you if the runbook requires such resources and specify corresponding resources that you need to create in Azure Automation for the converted runbook to operate properly.
For example, a runbook may use a variable to populate a particular value in an activity. The converted runbook will convert the activity and specify a variable asset in Azure Automation with the same name as the Orchestrator variable. This will be noted in the Runbook Converter - Summary.log file that is created after the conversion. You will need to manually create this variable asset in Azure Automation before using the runbook.
Runbooks in Orchestrator accept input parameters with the Initialize Data activity. If the runbook being converted includes this activity, then an input parameter in the Azure Automation runbook is created for each parameter in the activity. A Workflow Script control activity is created in the converted runbook that retrieves and returns each parameter. Any activities in the runbook that use an input parameter refer to the output from this activity.
The reason that this strategy is used is to best mirror the functionality in the Orchestrator runbook. Activities in new graphical runbooks should refer directly to input parameters using a Runbook input data source.
Invoke Runbook activity
Runbooks in Orchestrator start other runbooks with the Invoke Runbook activity. If the runbook being converted includes this activity and the Wait for completion option is set, then a runbook activity is created for it in the converted runbook. If the Wait for completion option is not set, then a Workflow Script activity is created that uses Start-AzureAutomationRunbook to start the runbook. After you import the converted runbook into Azure Automation, you must modify this activity with the information specified in the activity.