Return to section contents
       

Probe Action Modules


This reference describes Probe Action composite modules in the UNIX/Linux Authoring Library example Management Pack.

UNIX/Linux Shell Command Probe Action

ID

Unix.Authoring.ShellCommand.ProbeAction

Description

A probe action module type that runs a shell command through a WS-Management invocation.

Input

System.BaseData

Output

Microsoft.SystemCenter.WSManagement.WSManData

Configuration

Parameter

Type

Description

TargetSystem

String

The target system for the monitor.  Typically: $Target/#HostReferences#/Property[Type="#Unix Library Alias#!Microsoft.Unix.Computer"]/NetworkName$

ShellCommand

String

The “shell command” to execute on the remote host.  See the Appendix section for discussion of quotes and special characters.

Timeout

Integer

Timeout (in seconds). If the command runs for longer than the timeout, its process is stopped without waiting for completion.

UserName

String

The Run As reference providing the UserName of the user that will run the command/script.  $RunAs[Name="#MP Alias#!#Profile Name"]/UserName$

Password

String

The Run As reference providing the Password of the user that will run the command/script.  $RunAs[Name="#MP Alias#!#Profile Name"]/Password$

 

UNIX/Linux Shell Command Property Bag Probe Action

ID

Unix.Authoring.ShellScript.PropertyBag.ProbeAction

Description

A probe action module type that runs a shell command through a WS-Management invocation, and passes the output to a Microsoft.Windows.PowerShellPropertyBagProbe probe action.  The PowerShell Property Bag probe can be used to parse and manipulate output from the shell command.

Input

System.BaseData

Output

System.PropertyBagData

Configuration

Parameter

Type

Description

TargetSystem

String

The target system for the monitor.  Typically: $Target/#HostReferences#/Property[Type="#Unix Library Alias#!Microsoft.Unix.Computer"]/NetworkName$

ShellCommand

String

The “shell command” to execute on the remote host.  See the Appendix section for discussion of quotes and special characters.

Timeout

Integer

Timeout (in seconds). If the command runs for longer than the timeout, its process is stopped without waiting for completion.

UserName

String

The Run As reference providing the UserName of the user that will run the command/script.  $RunAs[Name="#MP Alias#!#Profile Name"]/UserName$

Password

String

The Run As reference providing the Password of the user that will run the command/script.  $RunAs[Name="#MP Alias#!#Profile Name"]/Password$

PSScriptName

String

The name given to the PowerShell script

PSScriptBody

String

The body of the PowerShell script.  In order to reference output from the shell command, the script must start with:

param([string]$StdOut,[string]$StdErr,[string]$ReturnCode)


The PowerShell script should return one or more Property Bags, using syntax such as:

$api = New-Object -comObject 'MOM.ScriptAPI'

$bag = $api.CreatePropertyBag()

$bag.AddValue("Name","Value")

$bag

 

 

UNIX/Linux Shell Script Probe Action

ID

Unix.Authoring.ShellScript.ProbeAction

Description

A probe action module type that runs a shell script through a WS-Management invocation.  The shell script is transferred to the UNIX/Linux host for each invocation.

Input

System!System.BaseData

Output

Microsoft.SystemCenter.WSManagement.WSManData

Configuration

Parameter

Type

Description

TargetSystem

String

The target system for the monitor.  Typically: $Target/#HostReferences#/Property[Type="#Unix Library Alias#!Microsoft.Unix.Computer"]/NetworkName$

ShellScript

String

The contents of the shell script to execute on the remote host.

ScriptArguments

String

Command line arguments to be passed to the script.

Timeout

Integer

Timeout (in seconds). If the script runs for longer than the timeout, its process is stopped without waiting for completion.

UserName

String

The Run As reference providing the UserName of the user that will run the command/script.  $RunAs[Name="#MP Alias#!#Profile Name"]/UserName$

Password

String

The Run As reference providing the Password of the user that will run the command/script.  $RunAs[Name="#MP Alias#!#Profile Name"]/Password$

 

UNIX/Linux Shell Script Property Bag Probe Action

ID

Unix.Authoring.ShellScript.PropertyBag.ProbeAction

Description

A probe action module type that runs a shell script through a WS-Management invocation, and passes the output to a Microsoft.Windows.PowerShellPropertyBagProbe probe action.  The PowerShell Property Bag probe can be used to parse and manipulate output from the shell command. The shell script is transferred to the UNIX/Linux host for each invocation.

Input

System.BaseData

Output

System.PropertyBagData

Configuration

Parameter

Type

Description

TargetSystem

String

The target system for the monitor.  Typically: $Target/#HostReferences#/Property[Type="#Unix Library Alias#!Microsoft.Unix.Computer"]/NetworkName$

ShellScript

String

The contents of the shell script to execute on the remote host.

ScriptArguments

String

Command line arguments to be passed to the script.

Timeout

Integer

Timeout (in seconds). If the script runs for longer than the timeout, its process is stopped without waiting for completion.

UserName

String

The Run As reference providing the UserName of the user that will run the command/script.  $RunAs[Name="#MP Alias#!#Profile Name"]/UserName$

Password

String

The Run As reference providing the Password of the user that will run the command/script.  $RunAs[Name="#MP Alias#!#Profile Name"]/Password$

PSScriptName

String

The name given to the PowerShell script

PSScriptBody

String

The body of the PowerShell script.  In order to reference output from the shell command, the script must start with:

param([string]$StdOut,[string]$StdErr,[string]$ReturnCode)


The PowerShell script should return one or more Property Bags, using syntax such as:

$api = New-Object -comObject 'MOM.ScriptAPI'

$bag = $api.CreatePropertyBag()

$bag.AddValue("Name","Value")

$bag