Get-SCOMResourcePool

Get-SCOMResourcePool

Retrieves resource pools in Operations Manager.

Syntax

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

Parameter Set: FromClassDisplayName
Get-SCOMResourcePool [-DisplayName] <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-EnableAutomaticMembership <Boolean> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromClassName
Get-SCOMResourcePool -Name <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-EnableAutomaticMembership <Boolean> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromId
Get-SCOMResourcePool -Id <Guid[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-EnableAutomaticMembership <Boolean> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromMember
Get-SCOMResourcePool [-Member] <ComputerHealthService[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-EnableAutomaticMembership <Boolean> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromObserver
Get-SCOMResourcePool [-Observer] <ComputerHealthService[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-EnableAutomaticMembership <Boolean> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Detailed Description

The Get-SCOMResourcePool cmdlet retrieves resource pools in System Center 2012 – Operations Manager. A resource pool enables a collection of management servers to distribute the workload.

Parameters

-ComputerName<String[]>

Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. You can use NetBIOS names, IP addresses, or fully qualified domain names (FQDNs). 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 PSCredential object for the management group connection. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type "Get-Help Get-Credential".If you specify a computer in the ComputerName parameter, use an account that has access to that computer. The default is the current user.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-DisplayName<String[]>

Specifies an array of display names of an object. Values of the DisplayName parameter may vary depending on which localized management packs a user imports into the management group and the locale of the user who is running Windows PowerShell.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-EnableAutomaticMembership<Boolean>

Indicates that the cmdlet returns only those resource pools for which automatic membership is enabled. These resource pools contain only management servers.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Id<Guid[]>

Specifies an array of GUIDs.

An object stores a GUID in the Id property for a resource pool. To obtain the GUID of a resource pool, type "Get-SCOMResourcePool | Format-Table DisplayName, Id".

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Member<ComputerHealthService[]>

Specifies an array of objects to include in the resource pool.

Valid objects of a resource pool include management servers and gateway servers. For information about how to get a management server object, type "Get-Help Get-SCOMManagementServer".

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names of an object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Observer<ComputerHealthService[]>

Specifies an array of management server or a gateway management server that is not a member of the resource pool.

To make a resource pool highly available, you must add a minimum of three members to the pool, or two members and one observer.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-SCSession<Connection[]>

Specifies an array of Connection objects. To obtain a Connection object, use the Get-SCManagementGroupConnection 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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Retrieve all resource pools by name

This command uses the Get-SCOMResourcePool cmdlet to get the resource pools with Management in their display name and resource pool names that begin with the string All.

PS C:\> Get-SCOMResourcePool -DisplayName "*Management*", "All*"

Example 2: Retrieve resource pool by IDs

This command uses the Get-SCOMResourcePool cmdlet to get the resource pools with the IDs 7413b06b-a95b-4ae3-98f2-dac9ff76dabd and 2ef74789-f9f5-46b0-af70-16d01d4f4577.

PS C:\> Get-SCOMResourcePool –Id 7413b06b-a95b-4ae3-98f2-dac9ff76dabd, 2ef74789-f9f5-46b0-af70-16d01d4f4577

Example 3: Retrieve resource pools by member name

This example retrieves resource pools by display name.

The first command uses the Get-SCOMManagementServer cmdlet to get the member with the display name Member01, and stores the result in the $Member variable.

The second command uses the Get-SCOMResourcePool cmdlet to return all resource pools for which the value stored in the $Member variable is a member.

PS C:\> $Member = Get-SCOMManagementServer -Name "Member01"
PS C:\> Get-SCOMResourcePool -Member $Member

Example 4: Retrieve resource pools by observer name

This example retrieves resource pools by display name.

The first command uses the Get-SCOMManagementServer cmdlet to get the observer with the display name Observer01, and stores the result in the $Observer variable.

The second command uses the Get-SCOMResourcePool cmdlet to return all resource pools for which the value stored in the $Observer variable is an observer.

PS C:\> $Observer = Get-SCOMManagementServer -Name "Observer01"
PS C:\> Get-SCOMResourcePool -Observer $Observer

New-SCOMResourcePool

Remove-SCOMResourcePool

Set-SCOMResourcePool