Set-CsTrustedApplicationPool

 

Topic Last Modified: 2012-03-25

Modifies a pool that contains the computers that host trusted applications.

Syntax

Set-CsTrustedApplicationPool [-Identity <XdsGlobalRelativeIdentity>] [-AppSharingPortCount <UInt16>] [-AppSharingPortStart <UInt16>] [-AudioPortCount <UInt16>] [-AudioPortStart <UInt16>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-OutboundOnly <$true | $false>] [-Registrar <String>] [-RequiresReplication <$true | $false>] [-ThrottleAsServer <$true | $false>] [-TreatAsAuthenticated <$true | $false>] [-VideoPortCount <UInt16>] [-VideoPortStart <UInt16>] [-WhatIf [<SwitchParameter>]]

Detailed Description

We recommend that the computers that are running trusted applications within a Microsoft Lync Server 2010 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. The Set-CsTrustedApplicationPool cmdlet modifies the settings for an existing trusted application pool. Note that you can’t modify the computers that are associated with a pool by using this cmdlet; you must use the CsTrustedApplicationComputer cmdlets to do that.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsTrustedApplicationPool cmdlet locally: RTCUniversalServerAdmins. To return a list of all 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 "Set-CsTrustedApplicationPool"}

Parameters

Parameter Required Type Description

Identity

Required

XdsGlobalRelativeIdentity

The fully qualified domain name (FQDN) or service ID of the pool whose settings you want to modify.

AppSharingPortCount

Optional

Uint16

The number of ports available in the port range for application sharing connections.

AppSharingPortStart

Optional

UInt16

The number of the first port in the port range available for application sharing connections.

AudioPortCount

Optional

UInt16

The number of ports available in the port range for audio connections.

AudioPortStart

Optional

UInt16

The number of the first port in the port range available for audio connections.

OutboundOnly

Optional

Boolean

Specifies whether a trusted application can initiate a connection to a server within the pool. Set this value to True if you want all connections to be initiated by the server rather than the application.

Registrar

Optional

String

The service ID or FQDN of the Registrar service for the pool. Note that changing the Registrar will orphan any contacts attached to the application. Those contacts must be moved by calling the Move-CsApplicationEndpoint cmdlet.

RequiresReplication

Optional

Boolean

Determines whether replication is required for this pool. Set this value to False if replication is not required. You would ordinarily set this parameter to False for Microsoft Outlook Web Access and manually-provisioned applications.

ThrottleAsServer

Optional

Boolean

Set this parameter to false to throttle connections between the servers within the pool and trusted applications as clients. This places greater restrictions on the connections than the default True, which throttles connections as servers. Throttling a connection simply places restrictions on the number of transactions that can occur simultaneously.

TreatAsAuthenticated

Optional

Boolean

Determines whether authentication is required for trusted applications connecting to servers within the pool. Set this parameter to False if you want to require trusted applications to be authenticated. The default value of True allows the trusted applications to connect under the assumption they’ve already been authenticated.

VideoPortCount

Optional

UInt16

The number of ports available in the port range for video connections.

VideoPortStart

Optional

Uint16

The number of the first port in the port range available for video connections.

Force

Optional

SwitchParameter

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

WhatIf

Optional

SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Optional

SwitchParameter

Prompts you for confirmation before executing the command.

Input Types

Microsoft.Rtc.Management.Xds.DisplayExternalServer object. Accepts pipelined input of trusted application pool objects.

Return Types

This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer.

Example

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

Set-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -OutboundOnly $True

This example modifies the pool with the FQDN TrustPool.litwareinc.com. We use the Identity parameter to specify the FQDN of the pool we want to modify. This example modifies the OutboundOnly property of the pool by specifying a value of True ($True) for the parameter OutboundOnly. (The default value is False.)