Topic Last Modified: 2013-02-21
Retrieves settings for one or more pools that contain the computers that host trusted applications. This cmdlet was introduced in Lync Server 2010.
Syntax
Get-CsTrustedApplicationPool [-Identity
<XdsGlobalRelativeIdentity>] <COMMON PARAMETERS>
|
Get-CsTrustedApplicationPool [-Filter <String>]
<COMMON PARAMETERS>
|
COMMON PARAMETERS: [-PoolFqdn <String>]
|
Examples
EXAMPLE 1
Example 1 retrieves all pools within the Lync Server deployment that have been defined as trusted application pools.
Copy Code | |
---|---|
Get-CsTrustedApplicationPool |
EXAMPLE 2
In this example, we’ve used the Identity parameter to ensure we retrieve only one trusted application pool, in this case the pool with the FQDN TrustPool.litwareinc.com.
Copy Code | |
---|---|
Get-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com |
EXAMPLE 3
This example retrieves all trusted application pools that contain the site TrustPool in the pool FQDN. The Filter parameter is used with a value of *:TrustPool.*. This filter string will search the Identity values of all trusted application pools for those that contain the string “:TrustPool.”. For example, this command will retrieve the pool with the Identity value TrustedApplicationPool:TrustPool.litwareinc.com.
Copy Code | |
---|---|
Get-CsTrustedApplicationPool -Filter *:TrustPool.* |
EXAMPLE 4
The Filter parameter searches only on Identity, which in the case of trusted application pools is the service ID in the format TrustedApplicationPool:<FQDN>. This example searches for pools based on service ID in the format <site>-ExternalServer-<id>; for example, Redmond1-ExternalServer-1. This allows us to find trusted pools homed on a specific site. The example begins by calling the Get-CsTrustedApplicationPool cmdlet with no parameters, which retrieves a collection of all trusted application pools. This collection is then piped to the Where-Object cmdlet, which narrows down the collection to only those pools where the service ID ($_.ServiceId) matches the wildcard string (-like) Redmond1*. The result will be a collection of all trusted application pools with FQDNs beginning with the string Redmond1, such as Redmond1-ExternalServer-1, Redmond1-ExternalServer-2, and Redmond1-ExternalServer-3.
Copy Code | |
---|---|
Get-CsTrustedApplicationPool | Where-Object {$_.ServiceId -like "Redmond1*"} |
Detailed Description
It is recommended that computers that are running trusted applications within a Lync Server deployment be added to a separate pool that is only for trusted applications. However, you can add trusted application computers to an existing pool that is also used for other purposes. This cmdlet retrieves one or more pools that have been defined as trusted application pools.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsTrustedApplicationPool cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins. To return a list of the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsTrustedApplicationPool"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Filter |
Optional |
System.String |
A string containing one or more wildcard characters that is used to search for a pool with an Identity that matches the wildcard string. For example, specifying the string *Redmond* would retrieve all trusted application pools with identities containing the string Redmond, such as TrustedApplicationPool:Redmond.litwareinc.com. |
Identity |
Optional |
Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity |
The fully qualified domain name (FQDN) or service ID of the pool for which you want to retrieve settings. |
PoolFqdn |
Optional |
System.String |
The FQDN of the pool you want to retrieve. This behaves the same as the Identity parameter, except that Identity also accepts a service ID. |
Input Types
None.
Return Types
Retrieves one or more objects of type Microsoft.Rtc.Management.Xds.DisplayExternalServer.