Share via

  • Article

Set-CsTrustedApplication

 

Topic Last Modified: 2012-03-26

Modifies the settings for a trusted application.

Syntax

Set-CsTrustedApplication [-Identity <ExternalApplicationIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Port <Int32>] [-WhatIf [<SwitchParameter>]]

Detailed Description

A trusted application is an application developed by a third party that is given trusted status to run as part of Microsoft Lync Server 2010 but that is not a built-in part of the product. This cmdlet allows you to modify the port number that the external service that runs the application is using.

When you use this cmdlet to modify a trusted application, you must supply a value for the Identity parameter. The Identity is the fully qualified domain name (FQDN) of the pool on which the application is homed followed by a slash (/) followed by the application ID. For example, TrustPool.litwareinc.com/tapp2, where TrustPool.litwareinc.com is the pool FQDN and tapp2 is the application ID. Note that if you view an existing application by calling Get-CsTrustedApplication, you’ll see an ID that looks more like this: TrustPool.litwareinc.com/urn:application:tapp2. Notice the prefix urn:application: before the application name (tapp2). While this prefix is part of the Identity, it’s not required when you specify the value for the Identity parameter.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsTrustedApplication 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 –matches "Set-CsTrustedApplication\b"}

Parameters

Parameter Required Type Description

Identity

Optional

ExternalApplicationIdentity

The unique identifier of the trusted application you want to modify. Identity values must be entered in the format <pool FQDN>/<application ID>, where pool FQDN is the FQDN of the pool on which the application resides, and application ID is the name of the application.

Port

Optional

Int32

The port number on which the application will run.

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.DisplayTrustedApplication object. Accepts pipelined input of trusted application objects.

Return Types

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

Example

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

Set-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 -Port 6200

This example modifies the port for the trusted application with the Identity TrustPool.litwareinc.com/tapp2 to port 6200. This is accomplished by passing the Set-CsTrustedApplication cmdlet an Identity of TrustPool.litwareinc.com/tapp2. This Identity consists of the name of the pool on which the application resides followed by the name (or ID) of the application. We then include the Port parameter, giving it a value of 6200 to modify that value.