Set-CsApplicationServer
Topic Last Modified: 2012-03-27
Enables you to modify configuration properties of one or more servers running the Application service. These servers (also known as Application Servers) host software programs, such as the Call Park application, that were developed using the Microsoft Unified Communications Managed API (UCMA) set.
Syntax
Set-CsApplicationServer [-Identity <XdsGlobalRelativeIdentity>] [-ApplicationDatabase <String>] [-AppSharingPortCount <UInt16>] [-AppSharingPortStart <UInt16>] [-AtsSipPort <UInt16>] [-AudioPortCount <UInt16>] [-AudioPortStart <UInt16>] [-CaaSipPort <UInt16>] [-CasSipPort <UInt16>] [-Confirm [<SwitchParameter>]] [-CpsSipPort <UInt16>] [-Force <SwitchParameter>] [-PdpSipPort <UInt16>] [-PdpTurnPort <UInt16>] [-Registrar <String>] [-RgsSipPort <UInt16>] [-RgsWcfMtlsPort <UInt16>] [-VideoPortCount <UInt16>] [-VideoPortStart <UInt16>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Application service hosts a number of Microsoft Lync Server 2010 programs that are not part of the core server components; these programs include the Response Group application, the Conferencing Attendant application, and the Conferencing Announcement application. The Application service takes these programs and fully integrates them into the Lync Server 2010 environment.
The Set-CsApplicationServer cmdlet enables administrators to modify the configuration settings for any (or all) of the Application Servers deployed in their organization. For example, you can modify the ports used for audio, video, or application sharing traffic, or assign new values to ports used by individual applications such as the Conferencing Attendant application or the Conferencing Announcement application. Note that any time you change ports you will then need to restart the corresponding service.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsApplicationServer 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-CsApplicationServer"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Xds Identity |
Service location of the Application Server to be modified. For example: -Identity "ApplicationServer:atl-cs-001.litwareinc.com". Note that you can leave off the prefix "ApplicationServer:" when specifying an Application server. For example: -Identity "atl-cs-001.litwareinc.com". |
ApplicationDatabase |
Optional |
String |
Service location of the Application database. For example: -ApplicationDatabase "ApplicationDatabase:atl-cs-001.litwareinc.com". |
AppSharingPortCount |
Optional |
Integer |
Total number of ports allocated for application sharing. The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100 then ports 60000 through 60099 will be used for application sharing. |
AppSharingPortStart |
Optional |
Integer |
First port in the range of ports allocated for application sharing. For example: –AppSharingPortStart 60000. |
AtsSipPort |
Optional |
Integer |
Port used for the Audio Test service. |
AudioPortCount |
Optional |
Integer |
Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 will be used for audio traffic. |
AudioPortStart |
Optional |
Integer |
First port in the range of ports allocated for sending and receiving audio traffic. For example: –AudioPortStart 60000. |
CaaSipPort |
Optional |
Integer |
SIP port used by the Conferencing Attendant application, used when connecting users to a dial-in conference. |
CasSipPort |
Optional |
Integer |
SIP port used by the Conferencing Announcement application, used to play announcements (for example, "Ken Myer is now exiting") during a conference. |
CpsSipPort |
Optional |
Integer |
SIP port used by the Call Park service. The Call Park service enables you to place a call on hold from one telephone, then have that call retrieved from a different phone. |
PdpSipPort |
Optional |
Integer |
SIP port used by the Policy Decision Point Server. The Policy Decision Point Server is used for bandwidth management. |
PdpTurnPort |
Optional |
Integer |
Turn traffic port used by the Policy Decision Point Server. |
Registrar |
Optional |
String |
Fully qualified domain name of the Registrar associated with the Policy Decision Point Server. |
RgsSipPort |
Optional |
Integer |
SIP port used by the Response Group application. The Response Group application provides a way to direct incoming phone calls to a specific group of people, such as an organization’s support team. |
RgsWcfMtlsPort |
Optional |
Integer |
Port used for Windows Communication Foundation (WCF) mutual TLS (MTLS) traffic used by the Response Group application. |
VideoPortCount |
Optional |
Integer |
Total number of ports allocated for sending and receiving video traffic. The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic. |
VideoPortStart |
Optional |
Integer |
First port in the range of ports allocated for sending and receiving video traffic. For example –VideoPortStart 60000. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Input Types
None. Set-CsApplicationServer does not accept pipelined input.
Return Types
Set-CsApplicationServer does not return any values or objects. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayApplicationServer object.
Example
-------------------------- Example 1 ------------------------
Set-CsApplicationServer -Identity "ApplicationServer:atl-cs-001.litwareinc.com" -CasSipPort 5074
The command shown in Example 1 configures the SIP port for the Conferencing Announcement application on the Application Server ApplicationServer:atl-cs-001.litwareinc.com to 5074.
-------------------------- Example 2 ------------------------
Set-CsApplicationServer -Identity "ApplicationServer:atl-cs-001.litwareinc.com" -AudioPortStart 49500 -AudioPortCount 5500
The preceding command configures audio ports for the Application Server ApplicationServer:atl-cs-001.litwareinc.com. In this example, the starting audio port is set to 49500 and a total of 5500 ports are set aside for audio traffic.
-------------------------- Example 3 ------------------------
Get-CsService -ApplicationServer | ForEach-Object {Set-CsApplicationServer -Identity $_.Identity -CasSipPort 5074}
In Example 3, the SIP port for the Conferencing Announcement application is set to 5074 for all of the Application Servers in the organization. To do this, the command first uses Get-CsService to return a collection of all the Application Servers currently in use. This collection is then piped to the ForEach-Object cmdlet, which takes each server in the collection, and uses Set-CsApplicationServer to set the Conferencing Announcement application SIP port to 5074.