Export (0) Print
Expand All
Expand Minimize

Set-CsTrustedApplicationEndpoint

 

Topic Last Modified: 2013-02-21

Modifies an existing endpoint contact for a trusted application. This cmdlet was introduced in Lync Server 2010.

Set-CsTrustedApplicationEndpoint -Identity <UserIdParameter> [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DisplayNumber <String>] [-Enabled <$true | $false>] [-EnabledForFederation <$true | $false>] [-EnterpriseVoiceEnabled <$true | $false>] [-ExchangeArchivingPolicy <Uninitialized | UseLyncArchivingPolicy | NoArchiving | ArchivingToExchange>] [-LineURI <String>] [-PassThru <SwitchParameter>] [-PrimaryLanguage <String>] [-SecondaryLanguages <MultiValuedProperty>] [-SipAddress <String>] [-Type <String>] [-WhatIf [<SwitchParameter>]]

This example modifies the application endpoint contact object with the SIP address endpoint1@litwareinc.com. Notice that the Identity value begins with the string sip: followed by the SIP address. The next parameter, DisplayName, is given a value of “Endpoint 1”, which changes the display name of the contact to that value.

Set-CsTrustedApplicationEndpoint -Identity "sip:endpoint1@litwareinc.com" -DisplayName "Endpoint 1"

This example modifies the display number of the endpoint application with the display name Endpoint 1. The command begins with a call to the Get-CsTrustedApplicationEndpoint cmdlet with an Identity of Endpoint 1. This retrieves the endpoint contact object with that display name. This object is then piped to the Set-CsTrustedApplicationEndpoint cmdlet, which modifies the DisplayNumber to the value, in this case, (425)555-1212.

Get-CsTrustedApplicationEndpoint -Identity "Endpoint 1" | Set-CsTrustedApplicationEndpoint -DisplayNumber "(425)555-1212"

A trusted application endpoint is an Active Directory contact object that enables routing of calls to a trusted application. This cmdlet modifies an existing endpoint contact object in Active Directory Domain Services.

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

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.AD.UserIdParameter

The Identity (the distinguished name) or the SIP address of the application endpoint to be modified.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

DisplayName

Optional

System.String

The display name of the endpoint contact object.

DisplayNumber

Optional

System.String

The telephone number of the contact as it will appear in the Address Book.

Enabled

Optional

System.Boolean

Determines whether the contact is enabled for Lync Server.

Default: True

EnabledForFederation

Optional

System.Boolean

Determines whether federated users have access to this contact.

Default: False

EnterpriseVoiceEnabled

Optional

System.Boolean

Determines whether the contact is enabled for Enterprise Voice.

Default: True

ExchangeArchivingPolicy

Optional

Microsoft.Rtc.Management.ADConnect.Core.ExchangeArchivingPolicyOptionsEnum

Indicates where the contact's instant messaging sessions are archived. Allowed values are:

* Uninitialized

* UseLyncArchivingPolicy

* ArchivingToExchange

* NoArchiving

LineURI

Optional

System.String

The phone number of the contact. Must be in the format TEL:<number>, for example TEL:+14255551212.

PassThru

Optional

System.Management.Automation.SwitchParameter

Including this parameter will cause the cmdlet to not only modify the contact object but will return the new object as output.

PrimaryLanguage

Optional

System.String

The primary language used for the trusted application. The language must be configured using a valid language code, such as en-US (U.S. English), fr-FR (French), etc.

SecondaryLanguages

Optional

Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty

A collection of languages that can also be used for trusted applications. Values must be configured as a comma-separated values list of language codes. For example, the following syntax sets French Canadian and French as secondary languages: -SecondaryLanguages "fr-CA","fr-FR".

SipAddress

Optional

System.String

You cannot modify the SIP address of a contact. The SIP address is assigned when the application endpoint is created.

Type

Optional

System.String

This parameter is not used with this cmdlet.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object. Accepts pipelined input of trusted application endpoint objects.

This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft