Get-SCOMClassInstance

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

Get-SCOMClassInstance

Gets a list of class instances.

Syntax

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

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

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

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

Parameter Set: FromGroup
Get-SCOMClassInstance [-Group] <EnterpriseManagementObject> [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

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

Detailed Description

The Get-SCOMClassInstance cmdlet gets a list of class instances.

Parameters

-Class<ManagementPackClass>

Retrieves the class instance for one or more 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?

true

Position?

1

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

localhost

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

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

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

true

-Group<EnterpriseManagementObject>

Retrieves the class instance 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?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Id<Guid>

Retrieves the class instance with the specified GUID. The GUID is stored in the Id property of the object that represents an SCOMClassInstance. To get the GUID of a class, type "Get-SCOMClassInstance | Format-Table DisplayName, Id".

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

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

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

true

-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

<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 class instances that have "Server01.Contoso.Com" in their display name and class instances that are in the Contoso.com domain.

PS C:\>Get-SCOMClassInstance -Displayname "Server01.Contoso.Com", "*.Contoso.com"

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

Description-----------This command gets all classes with "Windows" in their name. It then uses the pipeline operator (|) to send the classes to the Get-SCOMClassInstance cmdlet which retrieves the class instances for each of the classes.

PS C:\>Get-SCOMClass -Name *Windows* | Get-SCOMClassInstance

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

Description-----------This command gets all groups with "Windows" in their name. It then uses the pipeline operator (|) to send the groups to the Get-SCOMClassInstance cmdlet which retrieves the class instances for each of the groups.

PS C:\>Get-SCOMGroup -DisplayName *Windows* | Get-SCOMClassInstance

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

Description

-----------

This command gets the class instance that has an Id of 7413b06b-a95b-4ae3-98f2-dac9ff76dabd.

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

Get-SCOMClass

Get-SCOMGroup