*As-Is*
Mirror site of the previous content in CodePlex, with updated 2016 content. CodePlex is scheduled to shutdown December 2017.
-
System Center Orchestrator
Community ReleasesThis projects contains integrations, code samples and other community content for System Center 2012 Orchestrator, released by the Orchestrator product team and other related Microsoft groups.
Note: Integration Packs, utilities and other samples provided on this site are not compatible with Opalis Integration Server. For those integrations, go to http://opalis.codeplex.com.
New to Orchestrator? Get Started with these Resources
- Download System Center 2016 Orchestrator Trial software
- View the Product Documentation
- Join in the Conversation in the Forums
- Read the Orchestrator Team Blog
- Visit the TechNet Gallery to find other Orchestrator integrations
- See product information on Microsoft.com
- Get additional downloads for Orchestrator
What Can You Find Here?
Sample Runbooks you can import Community-Developed Integration Packs Community Tools and Scripts
- SCO Job Runner (Command-Line Tool)
- Category Switcher
- Orchestrator Web Service PowerShell Examples
- Orchestrator Visio and Word Generator (replaced by the SMART Documentation and Conversion Helper 2.0)
- Orchestrator Remote Tools
- SCO Job Runner
Custom IP Development Other Orchestrator-Related Projects on CodePlex
- Ryan Andorfer’s Community IPs
- Ryan is well-known in the Opalis / Orchestrator community for creating lots of cool integrations, including Active Directory, Configuration Manager 2007, Exchange Mail and Calendaring, Local Security, Scheduled Tasks, Orchestrator Utilities, and a VMWare IP.
SC2012 Solution Runbook Examples
This export includes runbook examples for each of the System Center 2012 components, plus a few generic administrative task runbooks to round things out.
There are 43 different runbooks (master and sub-routine) each tied to a specific global configuration for their respective SC2012 component. You should be able to simply import, reconfigure the global configurations to fit your environment and go. And while they do not solve for any specific solution, they do provide simple example usages of each of the SC2012 component IPs (with many of the activities from each IP leveraged).
Much of the effort put in to these example runbooks was related to input and output mechanisms, leveraging the “Initiate Data” and “Send Platform Event” activities… this way each of these runbooks can be initiated via the Orchestration Console, by each other, or from an external program/web service (to include via Service Manager Connector).
NOTE: These runbooks were built in and are intended to be used with the RTM version of Orchestrator and SC2012 Integration Packs for Orchestrator.
Microsoft Team Foundation Server 2010 IP 20120419
The Team Foundation Server Integration Pack (TFS IP) is for performing work item tracking, team build, source respository, as well as test management on TFS 2010. It works with Orchestrator 2012 RC/RTM and incompatible with previous versions.
Windows PowerShell 2 IP 20110902
Some reliability issues have been fixed. The OIP files (will include other IP as well) are also stored in $orchestrator/IntegrationPacks/QIKv4/bin/ directory as I update them.
Orchestrator IP for Microsoft SharePoint RC
RELEASE NOTES
The Integration Pack for Microsoft SharePoint enables you to manipulate SharePoint Lists and Libraries (e.g. Document Libraries, Image Libraries etc.) to add, modify and remove entries, files and attachments.This Integration Pack adds the following objects to System Center Orchestrator:
• Create List Item
• Delete Attachment
• Delete Document
• Delete List Item
• Download Attachment
• Download Document
• Get Attachment List
• Get List Item
• Monitor List Item
• Update List Item
• Upload AttachmentOrchestrator IP for Data Manipulation
RELEASE NOTES
The Orchestrator Integration Pack for Data Manipulation enables you to perform a wider variety of data manipulation tasks as well as aggregate data into common activity for enhanced processing.This Integration Pack adds the following activities to System Center Orchestrator:
- Aggregate Data
- Compare Multiple Values
- Expand Fields
- Join Fields
- Match Pattern
- Replace Text
- Split Fields
- Transform Data
Orchestrator IP for Text Manipulation
The Integration Pack for Text Manipulation 1.1
This IP provides extended Text Manipulation functions to the Orchestrator.
This Integration Pack adds the following activities to the Orchestrator:
- Blank Line Search and Destroy
- Count Character Occurrence Text
- Find Character Occurrence Text
- In File Replace Text
- Keyword Range Search and Destroy Text
- Keyword Search and Destroy Text
- Passthrough Text
- Replace Text
The Team Foundation Server Integration Pack (TFS IP) is for performing work item tracking, team build
Orchestrator IP for MSSQL Tasks
The Integration Pack for MSSQL Tasks 1.1
This IP provides extended Data Management functions to the Orchestrator and MSSQL.
This Integration Pack adds the following activities to the Orchestrator:
- Test MSSQL Connection
- Deploy MSSQL Scripts
- Get Variable Info
- Update Variable Value
- Generate XML from MSSQL
Please Refer to the included User Guide for usage information.
Take particular note of the “Get Variable Info” and “Update Variable Value”, if implemented, these objects enable you to make those Orchestrator Variables you have, actuall Variable! Oh, and if you wanted to be able to generate XML from a standard SQL table, check out “Generate XML from MSSQL” 🙂
Orchestrator IP for Windows Tasks
RELEASE NOTES
Integration Pack for Windows Tasks 1.1
This Integration Pack extends the current Standard Activity Functionality within the Orchestrator.
NOTE: There are two objects in this Integration Pack, each one has multiple uses. Each object comes with its own documentation. See below for a brief description of each:
The Integration Pack Activity – File System Maintenance
This activity extends the current Standard Activity Functionality within Orchestrator. Specifically, this object extends the functionality of the Delete File, Delete Folder, and Get File Status Activities. It also works well with many of the Standard Activities which can process the information generated by this activity.
This Integration Pack Activity has configuration options which determine functionality:
- File and Directory Maintenance (default)
- Either Reports or Deletes File and Directory Items for a configurable number of configurable location within a File System on either a Local or Remote Server.
- Orchestrator Footprint Maintenance
- Either Reports or Deletes File and Directory Items for a configurable number of configurable location within a File System on either a Local or Remote Server. Seven of the File System locations have been pre-populated with Default values corresponding to the Orchestrator Install Footprint.
- Report (default)
- Provides the option to simply report information about the File and Directory Items from the specified File System locations.
- Delete
- Provides the option to both report and delete the File and Directory Items from the specified File System locations.
- Remote Server (default = False)
- Provides the option to execute the File Sytem Maintenance on a Local or Remote Server (assumes Runbook Service permissions allow such execution).
The Integration Pack Activity – Multi-Server WMI Query
This object extends the current Standard Activity Functionality within Orchestrator. Specifically, this object extends the functionality of the Query WMI, and Get Process Status Activities. It also works well with many of the Standard Activities which can process Windows Process Information or WMI Output.
This Integration Pack Activity has configuration options which determine functionality:
- WMI Query Results (default)
- Returns Correlated Data based on the Results of a WMI Namespace/Query Execution on a specified (delimited) list of Servers
- Process Info
- Returns Correlated Process Info Data based on the Results of a WMI Query Execution for a specified Process Name on a specified (delimited) list of Servers
- Process Counter
- Returns Correlated Process Count and Info Data based on the Results of a WMI Query Execution for a specified Process Name on a specified (delimited) list of Servers
The Team Found
Orchestrator IP for PS Script Execution
RELEASE NOTES
Integration Pack for PowerShell Script Execution 1.1
This Integration Pack provides extended PowerShell Script Execution capabilities for the Orchestrator (executed from and against both x86 and x64 OSs).
This Integration Pack adds the following activities to the Orchestrator:
- Execute PS Script
- Execute PS Script – Global
System Requirements
- System Center 2012 Orchestrator
- System Center 2012 Orchestrator Integration Toolkit (library included)
- Microsoft .NET 3.0 Framework
- PowerShell 2.0
- winrm quickconfig command executed on local and target machines where PS Scripts will be executed
Please Refer to the included User Guide as well as the available TechNet Blog Post (http://blogs.technet.com/b/charlesjoy/archive/2011/05/04/ois-integration-pack-for-powershell-script-execution-1-00.aspx) for more information (some of the blog post is for OIS 6.3, but the concepts remain the same – some of the names have changed, but everything functions identically).
Some reliability issu
Orchestrator IP for Standard Logging
RELEASE NOTES
Integration Pack for Standard Logging 1.2
(NOTE: This upgrades policy objects from the OIS 6.3 release of this IP (version 1.0 – product code: 10331343-e41f-4057-be50-0b892bd8d1fb)
This Integration Pack provides extended Runbook Logging functions for Orchestrator and MSSQL.
This Integration Pack adds the following objects to the Orchestrator:
- Start
- Success
- Warning
- Failure
- End
- Restart
- Get Log data
System Requirements
- System Center 2012 Orchestrator
- System Center 2012 Orchestrator Integration Toolkit (library included)
- Microsoft .NET 2.0 Framework
For more usage information, please see the following TechNet Blog Post: http://blogs.technet.com/b/charlesjoy/archive/2011/04/13/8-minute-demo-integration-pack-for-standard-ois-logging.aspx (some of the blog post (and video) is for OIS 6.3, but the concepts remain the same – some of the names have changed, but everything functions identically).
NOTE: This version (for Orchestrator) has a LoggingID limit of 2,147,483,647 (in a previous version it was 32,767) – If you had IP version 1.2 (DLL version 1.0) previously installed and hit the limit, the included DLL below has been updated with the expanded limit mentioned here (StandardLogging.dll (version 1.2 with int32 LoggingID)) – the DLL version is actuall 1.2 now to distinguish it from all of the other previous versions.
NOTE: If you installed the version 1.1 (Product Code: ff3ebec8-e9b9-4f57-9ca2-f668e69899bc) released in November 2011 (inital release for the RC), that was not associated with the correct upgrade path for the current (and final) version of this IP (as it wasn’t a direct upgrade from OIS 6.3). There are options, but the easiest is to transcribe the work from that version to this new version, OR update all the GUID references in the DB (not supported).
SCO Job Runner – Command Line Utility
RELEASE NOTES
This is a command-line tool that you can use to quickly start new runbook jobs using a script or some other tool like Operations Manager, ConfigMgr, or Task Scheduler.SCOJobRunner – a command line tool to invoke runbooks for Orchestrator 2012.
SYNTAX
ScoJobRunner -ID:<runbookID> -Parameters:<job parameters>
-Webserver:<server> -Port:<port number> -RunbookServer:<server>
[-Username:<username>] [-Domain:<domain>] [-Password:<password>]
-VerboseScoJobRunner -ID:<runbookID> -GetParameters -Verbose
PARAMETERS
-ID <string>
The runbook ID to be invoked in the format of a GUID
(i.e. “2d2fd2b4-339a-47ad-9914-a217d9fd47a6”).-Parameters <string>
A list of name-value pairs of the parameters needed by the runbook.
The format of these parameters is: “Name=Value;Name=Value”
Enclose in quotes to correctly handle spaces.
Example: -Parameters “Path=’Path 1′;Other Text=’sample data here'”-GetParameters
When this parameter is added, the utility returns a list of the runbook
parameters formatted in a way you can use them on the command line.
Example return value: “Path=’Path 1′;Other Text=’sample data here'”-Webserver <string>
The name of the Orchestrator server where the web service is installed.
If not provided, defaults to the current computer.-Port <int>
The port number used by the web service. If not provided, defaults to 81.-RunbookServer <string>
The Runbook Server where the job should be run.
If not provided, defaults to the configured primary Runbook Server.-Username <string> -Domain <string> -Password <string>
If provided, allows the use of alternate credentials for invoking the
runbook. All three parameters must be specified if used.
If not provided, the current user credentials are used.-Verbose
If this parameter is included, provides additional console output during
the processing of the job creation process.The Team Foundation Server
Category Switcher Tool
RELEASE NOTES
Note from the legal dept: The process described and the tool provied here is not officially supported by Microsoft and are provided only as an example to the community.Neither I nor Microsoft, nor any other person, animal, vegetable or mineral assumes responsibility for the process demonstrated here. USE AT YOUR OWN RISK!
================================================
This tool provides a way to easily hide/unhide categories in the Activities pane.For more information, see the Orchestrator blog article:
http://blogs.technet.com/b/orchestrator/archive/2012/05/08/cool-tool-hiding-unused-categories-in-the-activities-pane.aspxSystem Center Orchestrator Web Service PowerShell
RELEASE NOTES
For the current official version of the PowerShell Module for System Center 2012 Orchestrator Web Service please install it from the Orchestrator 2012 R2 installer.This blog post has more information: http://blogs.technet.com/b/orchestrator/archive/2014/02/09/service-management-automation-integration-with-orchestrator.aspx
———————————————————————
PowerShell Module and Examples for System Center 2012 Orchestrator Web Service
This download contains a PowerShell module and test scripts that provide examples of how to use PowerShell to automate Orchestrator via the web service. The download zip package contains the following:- OrchestratorServiceModule.psm1
- Test-GetCollection.ps1
- Test-GetInstance.ps1
- Test-GetInstanceDetails.ps1
- Test-GetJob.ps1
- Test-GetRunbook.ps1
- Test-StartRunbook.ps1
- Test-StartRunbookAndGetInstanceDetails.ps1
- Test-StopJob.ps1
- Test-StopJobsOnServers.ps1
- OrchWebService.pptx
v1.2 contains minor fixes to support PowerShell 3.0
v1.1 contains support for accessing runbooks via name (rather than GUID).Orchestrator Remote Tools 2.51
RELEASE NOTES
These tools provide a way to launch Orchestrator runbooks remotely from a UI or a command-line, and complement other out of the box capabilities like Web Service calls.
You can use them to launch workflows from a command line (just providing the path to the runbook and the expected parameters) or you can use them to generate a custom UI and provides optional parameter validation when the runbook is being run from the UI or command line (for example, you might want to make sure that someone sends “Yes” or “No” for a specific parameter, or provides a parameter that starts with “VM*” when asking the name of a machine to provision).The Orchestrator Remote Tools provide 3 components:
– The UI Generator lets an Orchestrator administrator browse graphically through all runbooks with an “Initialize Data” start activity, pick one of them, configure parameters and generate a XML template
– The Remote Runbook Launcher is a generic executable that will use that XML template as long as it sits in the same directory. This executable adapts its UI to the XML file and makes sure that parameter validation is correct.
– The Remote Runbook Launcher CLI does the same job, but from a command line. Note : This CLI tool also include the “turbo” mode which allows direct remote execution of runbooks, bypassing generation of a XML file and without parameter validation
A scenario to use these could be as a System Center Operations Manager delegated task for example.The remote launch itself is done using a web service call to the new Orchestrator Web Service. This will run under the user’s credentials, and a “Run As” launch would also be possible to leverage other credentials.
Main new features in v2.5x are 1/ the ability to run a runbook without generating the XML file, i.e. using a command line only and passing the path and parameters (no validation) and 2/ the flexibility to pass the XML template name which allows for multiple templates in the same folder.
For more information and screenshots, you can look at this blog entry : http://blogs.technet.com/b/yasc/archive/2011/11/17/orchestrator-remote-tools-2-0-fka-the-opalis-ui-generator.aspx
Note : This is a follow up to the Opalis UI Generator that can still be found here : http://opalis.codeplex.com/releases/view/57082
Recent log:
Changes in v2.51:
-Corrected an issue when working with a “initialize data” runbook without any parameters at all
– Added help in the CLI toolChanges in v2.5:
-New! Added an ORTXML parameter to specify an alternate XML template. This allows to save several XML templates for different policies in the same folder, and run them. You can still run the tool without specifying the ORTXML parameter, and it will look for the default policy_template.xml file, which is the name generated by the UI Generator.
– New! “Turbo” in the CLI launcher : It is now possible to directly pass the path to the runbook to execute, and configuration information (web service server and port, database server and name). Note : Turbo mode requires remote access to the database, which is not the case when running in standard mode where all the information has already been stored in the database.
– Corrected an issue with numeric value ranges in the Runbook LauncherSCO Job Runner – Command Line Utility
RELEASE NOTES
This is a command-line tool that you can use to quickly start new runbook jobs using a script or some other tool like Operations Manager, ConfigMgr, or Task Scheduler.SCOJobRunner – a command line tool to invoke runbooks for Orchestrator 2012.
SYNTAX
ScoJobRunner -ID:<runbookID> -Parameters:<job parameters>
-Webserver:<server> -Port:<port number> -RunbookServer:<server>
[-Username:<username>] [-Domain:<domain>] [-Password:<password>]
-VerboseScoJobRunner -ID:<runbookID> -GetParameters -Verbose
PARAMETERS
-ID <string>
The runbook ID to be invoked in the format of a GUID
(i.e. “2d2fd2b4-339a-47ad-9914-a217d9fd47a6”).-Parameters <string>
A list of name-value pairs of the parameters needed by the runbook.
The format of these parameters is: “Name=Value;Name=Value”
Enclose in quotes to correctly handle spaces.
Example: -Parameters “Path=’Path 1′;Other Text=’sample data here'”-GetParameters
When this parameter is added, the utility returns a list of the runbook
parameters formatted in a way you can use them on the command line.
Example return value: “Path=’Path 1′;Other Text=’sample data here'”-Webserver <string>
The name of the Orchestrator server where the web service is installed.
If not provided, defaults to the current computer.-Port <int>
The port number used by the web service. If not provided, defaults to 81.-RunbookServer <string>
The Runbook Server where the job should be run.
If not provided, defaults to the configured primary Runbook Server.-Username <string> -Domain <string> -Password <string>
If provided, allows the use of alternate credentials for invoking the
runbook. All three parameters must be specified if used.
If not provided, the current user credentials are used.-Verbose
If this parameter is included, provides additional console output during
the processing of the job creation process.QIK-to-SCO CodeMigration Script
RELEASE NOTES
Opalis to Orchestrator Source Code Conversion Script
This PowerShell script can be used to covert existing source code written to the Opalis 6.3 (QIK 3.0) API to be compatible with Orchestrator 2012’s SDK.
Migrating QIK API Custom Activities
NOTE: The following procedure will modify your source code. It is your responsibility to ensure that you maintain a backup copy of your source code in the event of an error in the script or other process!
- If your source code is maintained under a source control program, ensure that your latest versions are checked in and saved. If you are not using a source control program, make a backup copy of your source code and store it in a separate directory.
- Obtain the migration script (“QIKtoSCO-Migration.ps1”).
- Click Start > All Programs > Accessories > Windows PowerShell > Windows PowerShell ISE. The PowerShell script editor opens.
- Open the script in the editor by clicking File > Open and then browsing to and selecting the QIKtoSCO-Migration.ps1 file. The script should be displayed in a tab in the script pane.
- Run the script using the green arrow icon in the toolbar. This loads the functions of the script in memory.
- Locate the root directory of the source code project you wish to migrate and note the full path.
- In the Command Pane of the PowerShell editor, type: ReplaceSDKText –dirname “<dir>” (replacing <dir> with the full or relative path to the root of the project in step 6).
- As the script runs, it will display a list of all files scanned and the files that were changed.. Note that not all files that are scanned will have changes.
- When the process is complete, you should review the output window to ensure that no errors occurred. If any errors did occur, you may need to manually remediate those issues. If the errors were substantial, you may need to re-copy the source files into that location and re-run the script to migrate the code.
- When migration is complete and you have fixed any errors, close the PowerShell ISE application and return to your source code editor.
- Perform a build with the updated source code. Find and fix any errors in the code.
Note: One issue you are likely to encounter is that while the script updated any references in .csproj files to the Opalis.QuickIntegrationKit.dll so it now points to the new Microsoft.SystemCenter.Orchestrator.Integration.dll file, the new file must physically exist in the directory where the previous assembly was located. Simply copy the new reference assembly to that directory, or you can update the reference to point to a different location.
Orchestrator SDK Code Samples
RELEASE NOTES
The System Center 2012 Orchestrator Software Development Kit (SDK), previously named the Opalis API, is a way for developers to create custom integrations with Orchestrator by using their own custom code and adding on an easy-to-understand interface layer that enables the integration with Orchestrator activities. Using the SDK, developers create custom assemblies, which can then be used by Orchestrator as individual assemblies using the activities in the Integration Toolkit .NET or Java Integration Packs, or by creating new Integration Packs using the Integration Pack Wizard.
For more details about the Orchestrator SDK, please see the documentation available in this downloads section..Orchestrator SDK code examples
The SDK code examples demonstrate how to develop custom Integration Pack activities for use with Orchestrator.Note: The sample files are located in the Source Code check-ins.
(use the link next to “Change Set” above)
- Ryan is well-known in the Opalis / Orchestrator community for creating lots of cool integrations, including Active Directory, Configuration Manager 2007, Exchange Mail and Calendaring, Local Security, Scheduled Tasks, Orchestrator Utilities, and a VMWare IP.
SC Joe 