Get-SCOMOverride

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

Get-SCOMOverride

Gets a list of overrides or a resulting set of overrides.

Syntax

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

Parameter Set: FromManagementPackDiagnostic
Get-SCOMOverride [[-Diagnostic] <ManagementPackDiagnostic> ] [-Class <ManagementPackClass> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-Group <EnterpriseManagementObject> ] [-Instance <EnterpriseManagementObject> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromManagementPackDiscovery
Get-SCOMOverride [[-Discovery] <ManagementPackDiscovery> ] [-Class <ManagementPackClass> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-Group <EnterpriseManagementObject> ] [-Instance <EnterpriseManagementObject> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromManagementPackMonitor
Get-SCOMOverride [[-Monitor] <ManagementPackMonitor> ] [-Class <ManagementPackClass> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-Group <EnterpriseManagementObject> ] [-Instance <EnterpriseManagementObject> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromManagementPackRecovery
Get-SCOMOverride [[-Recovery] <ManagementPackRecovery> ] [-Class <ManagementPackClass> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-Group <EnterpriseManagementObject> ] [-Instance <EnterpriseManagementObject> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromManagementPackRule
Get-SCOMOverride [[-Rule] <ManagementPackRule> ] [-Class <ManagementPackClass> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-Group <EnterpriseManagementObject> ] [-Instance <EnterpriseManagementObject> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromTask
Get-SCOMOverride [[-Task] <ManagementPackTask> ] [-Class <ManagementPackClass> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-Group <EnterpriseManagementObject> ] [-Instance <EnterpriseManagementObject> ] [-SCSession <Connection> ] [ <CommonParameters>]

Detailed Description

The Get-SCOMOverride cmdlet gets a list of overrides or a resulting set of overrides.

Parameters

-Class<ManagementPackClass>

Retrieves overrides for one or more specified class objects. Enter a variable that represents the classes, or type a command that gets the classes. For information about how to get a class object, type Get-Help Get-SCOMClass.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Diagnostic<ManagementPackDiagnostic>

Retrieves overrides for one or more specified diagnostic objects. Enter a variable that represents the diagnostics, or type a command that gets the diagnostics.

For information about how to get a diagnostic object, type Get-Help Get-SCOMDiagnostic.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Discovery<ManagementPackDiscovery>

Retrieves overrides for one or more specified discovery objects. Enter a variable that represents the discoveries, or type a command that gets the discoveries.

For information about how to get a discovery object, type Get-Help Get-SCOMDiscovery.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Group<EnterpriseManagementObject>

Retrieves overrides for one or more group objects. Enter a variable that represents the groups, or type a command that gets the groups.

For information about how to get a group object, type Get-Help Get-SCOMGroup.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Instance<EnterpriseManagementObject>

Retrieves overrides for one or more specified class instance objects. Enter a variable that represents the class instances, or type a command that gets the class instances. This parameter also accepts group objects.

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Monitor<ManagementPackMonitor>

Retrieves overrides for one or more specified monitor objects. Enter a variable that represents the monitors, or type a command that gets the monitors.

For information about how to get a monitor object, type Get-Help Get-SCOMMonitor.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Recovery<ManagementPackRecovery>

Retrieves overrides for one or more recovery objects. Enter a variable that represents the recoveries, or type a command that gets the recoveries.

For information about how to get a recovery object, type Get-Help Get-SCOMRecovery.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Rule<ManagementPackRule>

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

For information about how to get a monitoring rule object, type Get-Help Get-SCOMRule.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Task<ManagementPackTask>

Retrieves overrides for one or more specified task objects. Enter a variable that represents the tasks, or type a command that gets the tasks.

For information about how to get a task object, type Get-Help Get-SCOMTask.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

<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 that contain "health" in their name, and then returns the overrides for the rule objects.

Using the ErrorAction parameter with the SilentlyContinue value allows the command to continue if it cannot find an override for a specific monitoring rule, and will not display an error.

PS C:\>Get-SCOMRule -Name *health* | Get-SCOMOverride -ErrorAction SilentlyContinue

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

Description

-----------

This command gets the override for monitors that contain "health" in their name and are in a class with a display name that contains "computer".

PS C:\>Get-SCOMOverride -Monitor (Get-SCOMMonitor -Name *health*) -Class (Get-SCOMClass -DisplayName *computer*)

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

Description

-----------

This command gets all discoveries that contain "system" in their name, and then returns the overrides for those discovery objects.

Using the ErrorAction parameter with the SilentlyContinue value allows the command to continue if it cannot find an override for a specific discovery, and will not display an error.

PS C:\>Get-SCOMDiscovery -name *system* | Get-SCOMOverride -ErrorAction SilentlyContinue

Get-SCOMClass

Get-SCOMClassInstance

Get-SCOMDiscovery

Get-SCOMGroup

Get-SCOMDiagnostic

Get-SCOMMonitor

Get-SCOMRecovery

Get-SCOMRule

Get-SCOMTask