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:

The Read Only Output variable are the possible output values that the activity will provide:

 

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:

 

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:

The Read Only Output variable are the possible output values that the activity will provide:

 

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:

The Read Only Output variable are the possible output values that the activity will provide:

 

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:

The Read Only Output variable are the possible output values that the activity will provide:

 

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:

The Read Only Output variable are the possible output values that the activity will provide:

 

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.

Activity Parameters

The List Events activity parameters can be provided by manual inserted values or via IN arguments or variables:

 

Parameters:

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 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. 

Activity Parameters

The List Jobs activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

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 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. 

Activity Parameters

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. 

Activity Parameters

The List Runbooks 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 runbooks 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 Id key: