Get-SCOMRule

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-SCOMRule

Gets a list of monitoring rules.

Syntax

Parameter Set: Empty
Get-SCOMRule [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromManagementPack
Get-SCOMRule [-ManagementPack] <ManagementPack> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromManagementPackClass
Get-SCOMRule [-Target] <ManagementPackClass> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromMonitoringDisplayRuleName
Get-SCOMRule [-DisplayName] <String> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromMonitoringRuleId
Get-SCOMRule [-Id] <Guid> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromMonitoringRuleName
Get-SCOMRule [-Name] <String> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Detailed Description

The Get-SCOMRule cmdlet gets a list of monitoring rules.

Parameters

-ComputerName<String>

Specifies the name of a computer to establish a connection with. The computer must be running the System Center Data Access Service. The default value is the computer for the current management group connection. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name. To specify the local computer, type the computer name, "localhost", or a dot (.).

-Credential<PSCredential>

Specifies a user account under which the management group connection will run. The default is the current user. Type a user name, such as "User01", "Domain01\User01", or "User@Domain.com", or enter a PSCredential object, such as one returned by the Get-Credential cmdlet. When you type a user name, you will be prompted for a password. For more information, type Get-Help Get-Credential.

-DisplayName<String>

Specifies the display name of an object. This parameter takes one or more strings and will look for matches in the DisplayName property of the given objects that this cmdlet works with. DisplayName values may vary depending on which localized management packs are imported into the management group and the locale of the user running Windows PowerShell.

-Id<Guid>

Retrieves the monitoring rule with the specified GUID.

The GUID is stored in the Id property of the object that represents an SCGroup. To get the GUID of a class, type "Get-SCOMGroup | Format-Table DisplayName, Id".

-ManagementPack<ManagementPack>

Retrieves monitoring rules for one or more specified management pack objects. Enter a variable that represents the management packs, or type a command that gets the management packs.

For information about how to get a management pack object, type Get-Help Get-SCOMManagementPack.

-Name<String>

Specifies the name of an object.

This parameter takes one or more strings and will look for matches in the Name property of the given objects that this cmdlet works with.

-SCSession<Connection>

Specifies a connection to a management server. The default is the current management group connection. Specify a Management group connection object, such as one returned by the Get-SCOMManagementGroupConnection cmdlet.

-Target<ManagementPackClass>

Retrieves monitoring rules for one or more specified target class objects. Enter a variable that represents the target classes, or type a command that gets the target classes.

For information about how to get a class object, type Get-Help Get-SCOMClass.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

This command gets all monitoring rules with "health" in their name.

PS C:\>Get-SCOMRule -Name *health*

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

This command gets all monitoring rules with "performance" in their display name.

PS C:\>Get-SCOMRule -DisplayName *performance*

-------------------------- EXAMPLE 3 --------------------------

Description

-----------

This command gets all management packs with "System Center Core Monitoring" in their display name. It then uses the pipeline operator (|) to send the management pack objects to the Get-SCOMRule cmdlet which gets the monitoring rules for each management pack object.

PS C:\>Get-SCOMManagementPack -DisplayName "System Center Core Monitoring" | Get-SCOMRule

-------------------------- EXAMPLE 4 --------------------------

Description

-----------

This command gets the monitoring rules for each target class with "health" in their display name.

PS C:\>Get-SCOMRule -Target (Get-SCOMClass -DisplayName *health*)

-------------------------- EXAMPLE 5 --------------------------

Description

-----------

The first command gets the path to a management pack file and saves it in the $MPFile variable.

The second command uses the ManagementPack parameter to get the monitoring rules contained in the management pack stored in the $MPFile variable.

PS C:\>$MPFile = "D:\Program Files\System Center Operations Manager 2007\Microsoft.SystemCenter.2007.mp"
PS C:\>Get-SCOMRule -ManagementPack $MPFile

-------------------------- EXAMPLE 6 --------------------------

Description

-----------

This example gets the monitoring rule with an Id of 7413b06b-a95b-4ae3-98f2-dac9ff76dabd.

PS C:\>Get-SCOMRule -Id 7413b06b-a95b-4ae3-98f2-dac9ff76dabd

Related topics

Get-SCOMClass

Get-SCOMManagementPack

Disable-SCOMRule

Enable-SCOMRule