Activities
Connect to Orchestrator
This activity connects to the Microsoft Orchestrator Server.
Activity Parameters
The Connect to Orchestrator activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- 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 task, 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.
The Read Only Output variable are the possible output values that the activity will provide:
- 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
This activity disconnects from Orchestrator Server.
Activity Parameters
The Disconnect from Orchestrator activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- 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.
Activity Parameters
The Get Runbook activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- 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: 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
This activity retrieves details about a specified Runbook.
Activity Parameters
The Get Runbook activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Runbook Instance Id (text box editor type) (type: string): the runbook instance 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 Get Runbook Instances activity, using a sequence like the following to extract the Id for the desired Runbook Instance from the output returned by Get Runbook Instances activity:
The Read Only Output variable are the possible output values that the activity will provide:
- 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.
Activity Parameters
The Get Runbook Instances activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Runbook Id (text box editor type) (type: string): the runbook instance 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: 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.
Activity Parameters
The Get Runbook Parameters activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Runbook Id (text box editor type) (type: string): the runbook instance 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: 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:
