Activities
- Connect to Orchestrator
- Disconnect from Orchestrator
- Get Runbook
- Get Runbook Instance Parameters
- Get Runbook Instances
- Get Runbook Parameters
- List Events
- List Jobs
- List Runbook Servers
- List Runbooks
- Start Runbook
- Stop Job
Connect to Orchestrator
...
- Orchestrator URL (text box editor type) (type: string): the Orchestrator URL in the following format: "http://10.201.0.1:81/Orchestrator2012/Orchestrator.svc".
- Password (password editor type) (type: string): the password for the provided username.
- Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the connection. (This parameter is used only when the user wants to send an encripted password from outside the taskworkflow, for example Flowster Portal).
- Username (text box editor type) (type: string): the username to connect to the Orchestrator Server . The accepted format is domain\username or username.
...
- Connection (type: object): outputs an Orchestrator Connection. This parameter should be used as input for all Connection parameters used for activities placed under Microsoft System Center category.
Execution:
Disconnect from Orchestrator
...
- Connection (text box editor type) (type: object): the Orchestrator Connection. The output parameter from Connect To Orchestrator activity should be used as Input here.
Get Runbook
This activity retrieves details about a specified Runbook.
...
- Output (type: dictionary<string,string>): returns a dictionary containing the specified Runbook details. In order to use the output you can use the GetKeyValuePair activity with the keys: Id, Name, IsMonitor, CheckedOutBy, CheckedOutTime, CreatedBy and Description.
...
Execution: The example below is an execution where the first runbook returned by List Runbooks activity is used as input for Get Runbook activity and extracts the runbook name:
In order to extract the values from the output parameter, GetKeyValuePair activity is used to extract the value for the Name key:
Get Runbook Instance Parameters
...
- Output (type: collection<dictionary<string,string>>): returns a collection of dictionaries containing the Direction, Name and Value for each Runbook Instance Parameter. In order to use the output you can iterate through the elements and use the GetKeyValuePair activity with the keys: Direction, Name and Value .
...
In order to extract the values from the output parameter (in our case the output is a Collection(Of Dictionary(Of String,String)), For Each and GetKeyValuePair activities should be used:
...
Get Runbook Instances
This activity retrieves all the instances of a particular Runbook.
...
- Output (type: collection<dictionary<string,string>>): returns a collection of dictionaries containing the Id, JobId, CompletionTime and Status for each Runbook Instance found. In order to use the output you can iterate through the elements and use the GetKeyValuePair activity with the keys: Id, JobId, CompletionTime and Status.
In order to extract the values from the output parameter (in our case the output is a Collection(Of Dictionary(Of String,String)), For Each and GetKeyValuePair activities should be used:
Execution: The example below is an execution where the first runbook returned by List Runbooks activity is used as input for Get Runbook Instances activity and extracts the runbook instance id:
...
Get Runbook Parameters
This activity retrieves all the parameters for a specified runbook.
...
- Output (type: collection<dictionary<string,string>>): returns a collection of dictionaries containing the Direction, Name and Value for each Runbook Parameter. In order to use the output you can iterate through the elements and use the GetKeyValuePair activity with the keys: Direction, Name and Value .
In order to extract the values from the output parameter (in our case the output is a Collection(Of Dictionary(Of String,String)), For Each and GetKeyValuePair activities should be used:
...
Execution: The example below is an execution where the first runbook returned by List Runbooks activity is used as input for Get Runbook Parameters activity and extracts the runbook parameter direction:
List Events
This activity lists all the events from the Microsoft Orchestrator Server.
...
- Output (type: collection<dictionary<string,string>>): returns a collection of dictionaries containing the Id, Type, CreationTime and Summary for each event found. In order to use the output you can iterate through the elements and use the GetKeyValuePair activity with the keys: Id, Id, Type, CreationTime and Summary.
Execution: The example below is an execution where all the events are listed between 01/02/2016 - 02/02/2016 dates:
In order to extract the values from the output parameter, For Each and GetKeyValuePair activities are used to extract the value for the Type key:
List Jobs
This activity lists jobs according to a given filter.
...
Execution: The example below is an execution where all the jobs are listed:
In order to extract the values from the output parameter, For Each and GetKeyValuePair activities are used to extract the value for the Status key:
List Runbook Servers
This activity lists all the runbook servers from the Microsoft Orchestrator Server.
...
The List Runbook Servers activity parameters can be provided by manual inserted values or via IN arguments or variables:
The Read Only Output variable are the possible output values that the activity will provide:
...
Execution: The example below is an execution where all the runbook servers are listed:
In order to extract the values from the output parameter, For Each and GetKeyValuePair activities are used to extract the value for the Name key:
List Runbooks
This activity lists all the runbooks.
...
In order to extract the values from the output parameter, For Each and GetKeyValuePair activities are used to extract the value for the Id key:
Start Runbook
This activity starts the specified Runbook.
Activity Parameters
The Start Runbook activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Parameters collection (collection editor type) (type: string): specify the parameters you want to send with the request.
- Runbook Id (text box editor type) (type: string): the runbook Id for which you want to obtain details. The accepted format should be written as in the given example:
The value also can be obtained from the List Runbooks activity, using a sequence like the following to extract the Id for the desired Runbook from the output returned by List Runbooks activity:
The Read Only Output variable are the possible output values that the activity will provide:
- Output (type: string): returns the resulting JobId of the started runbook.
Execution: The example below is an execution where the started runbook JobId is returned:
Stop Job
This activity stops the specified running Job.
Activity Parameters
The Stop Job activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Job Id (text box editor type) (type: string): the job Id that you wish to stop. The accepted format should be written as in the given example:
The value also can be obtained from the List Jobs activity, using the filter Running and using a sequence like the following to extract the Id for the desired Job from the output returned by List Jobs activity:
The Read Only Output variable are the possible output values that the activity will provide:
- Output Result (type: boolean): returns whether the operation succeeded or not.
Execution: The example below is an execution where a running job is stopped:
