[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Returns information about the pools used in your deployment of Microsoft Communications Server 2010. Pools are a collection of computers in a site that all run the same set of services.

Syntax


Get-CsPool [-Identity <XdsGlobalRelativeIdentity>] [-Site <String>]


Get-CsPool [-Filter <String>] [-Site <String>]

Parameters

Parameter	Required	Type	Description
Identity	Optional	String	Fully qualified domain name of the pool to be returned. For example: -Identity atl-cs-001.litwareinc.com. If this parameter is not present then all the pools in your organization will be returned.
Filter	Optional	String	Enables you to use wildcards when specifying the Identity of the pool (or pools) to be returned. For example, this syntax returns all the pools that have an Identity that ends with the string value ".fabrikam.com": -Filter "*.fabrikam.com". Note that you cannot use both –Filter and –Identity in the same command.
Site	Optional	String	Returns all the pools found on the specified site. Note that the site in question should be referenced using the site name (e.g., Redmond) rather than the site Identity (e.g., site:Redmond). For example: -Site "Redmond".

Parameter

Required

Type

Description

Identity

Optional

String

Fully qualified domain name of the pool to be returned. For example: -Identity atl-cs-001.litwareinc.com.

If this parameter is not present then all the pools in your organization will be returned.

Filter

Optional

String

Enables you to use wildcards when specifying the Identity of the pool (or pools) to be returned. For example, this syntax returns all the pools that have an Identity that ends with the string value ".fabrikam.com": -Filter "*.fabrikam.com".

Note that you cannot use both –Filter and –Identity in the same command.

Site

Optional

String

Returns all the pools found on the specified site. Note that the site in question should be referenced using the site name (e.g., Redmond) rather than the site Identity (e.g., site:Redmond). For example: -Site "Redmond".

Detailed Description

In Microsoft Communications Server “14” a pool is one or more computers in the same site that run the same set of Microsoft Communications Server services. For example, if you have one server running the Mediation Server service in the Redmond site then you would have a Mediation Service pool consisting of a single computer. If you have two computers running the Mediation Service in the Redmond site then you would have a Mediation Service pool consisting of two computers. The number of pools used in your organization depends on the number of servers you have and the different services run by those servers.

The Get-CsPool cmdlet enables you to retrieve information about each pool in use in your organization, including information about the services running on each of those pool.

Return Types

Get-CsPool returns instances of the Microsoft.Rtc.Management.Deploy.Internal.Cluster object.

Examples

-------------------------- Example 1 --------------------------

	Copy Code
Get-CsPool

The preceding commands returns all the pools found in your deployment of Communications Server 2010.

-------------------------- Example 2 --------------------------

	Copy Code
Get-CsPool \| Select-Object -ExpandProperty Machines

Example 2 displays detailed information about the computers found in each pool. This is done by calling Get-CsPool and then piping the returned data to the Select-Object cmdlet. Select-Object's -ExpandProperty parameter is used to "expand" the value of the Machines property. The Machines property is actually an array of objects representing each computer in the pool. When you expand the Machines property you get back detailed information about each of these computers.

-------------------------- Example 3 --------------------------

	Copy Code
Get-CsPool -Identity pool0.litwareinc.com

In the preceding example, the -Identity parameter is used to restrict the returned data to the pool that has the Identity pool0.litwareinc.com.

-------------------------- Example 4 --------------------------

	Copy Code
Get-CsPool -Site "Redmond"

Example 4 returns all the pools found in the Redmond site. To do this, the command uses the -Site parameter; the parameter value "Redmond" limits the returned data to pools where the Site property is equal to Redmond.

-------------------------- Example 5 --------------------------

	Copy Code
Get-CsPool \| Where-Object {$_.Services.Count -eq 0}

The command shown in Example 5 returns a collection of all the pools that are not configured for any Communications Server services. To carry out this task, the command first calls Get-CsPool without any parameters; that returns a collection of all the pools currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out all the pools where the Count (number of) services is equal to (-eq) 0. If the Count equals 0, that means that there are no Communications Server services configured for that pool.