Enables you to modify configuration properties of one or more Application Servers. Application Servers host software programs, such as the Call Park application, that were developed using the Unified Communications API 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>] [-RgsSipPort <UInt16>] [-RgsWcfMtlsPort <UInt16>] [-VideoPortCount <UInt16>] [-VideoPortStart <UInt16>] [-WhatIf [<SwitchParameter>]] |
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". |
|
ApplicationDatabase |
Optional |
String |
Service location of the Application Server database. For example: -ApplicationDatabase "ApplicationDatabase:atl-cs-001.litwareinc.com". |
|
CaaSipPort |
Optional |
Integer |
SIP port used by the Conferencing Auto Attendant (CAA). CAA is used when connecting users to a dial-in conference. |
|
CasSipPort |
Optional |
Integer |
SIP port used by the Conferencing Announcement Server (CAS). CAS is used to play announcements ("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 (PDP). The PDP Server is used for bandwidth management. |
|
PdpTurnPort |
Optional |
Integer |
Turn traffic port used by the PDP Server. |
|
RgsSipPort |
Optional |
Integer |
SIP port used by the Response Group Service (RGS). The Response Group Service provides a way to direct incoming phone calls to a specific group of people, such as help desk employees. |
|
AudioPortStart |
Optional |
Integer |
First port in the range of ports allocated for sending and receiving audio traffic. For example –AudioPortStart 60000. |
|
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 600000 through 60099 will be used for audio traffic. |
|
AppSharingPortStart |
Optional |
Integer |
First port in the range of ports allocated for application sharing. For example –AppSharingPortStart 60000. |
|
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 600000 through 60099 will be used for application sharing. |
|
VideoPortStart |
Optional |
Integer |
First port in the range of ports allocated for sending and receiving video traffic. For example –VideoPortStart 60000. |
|
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 600000 through 60099 will be used for video traffic. |
|
AtsSipPort |
Optional |
Integer |
Port used for ATS SIP traffic. |
|
RgsWcfMtlsPort |
Optional |
Integer |
Port used for Windows Communication Foundation (WCF) Mutual Transport Security Layer (MTLS) traffic used by the Response Group application. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise 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. |
Detailed Description
Application Server hosts a number of Microsoft Communications Server “14” programs that are not part of the core server components; these programs include the response Group Service, the Conferencing Auto Attendant (CAA), and the Conferencing Announcement Service (CAS). Application Server takes these programs and fully integrates them into the Communications Server environment.
In addition to hosting Communications Server programs created by Microsoft, Application Server also makes it easy for other developers to deploy applications written for the Communications Server 2010 platform: deploying applications using Application Server is invariably faster, easier, and far less prone to error than having to write your own installation and deployment program. Application Server also provides other benefits beyond quick and easy deployment; for example, applications written for Application Server can take advantage of the monitoring tools and infrastructure built into Communications Server. Likewise, Application Server provides a process that can host the application, relieving developers of yet another concern. With Application Server, developers can focus on writing code as opposed to worrying about deployment and logistics.
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 Auto Attendant or the Conferencing Announcement Service.
Return Types
Set-CsApplicationServer does not return any values or objects. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayAplicationServer object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
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 Service on the Application Server ApplicationServer:atl-cs-001.litwareinc.com to 5074.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
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 ------------------------
| Copy Code |
|
|---|---|
Get-CsService -ApplicationServer | ForEach-Object {Set-CsApplicationServer -Identity $_.Identity -CasSipPort 5074}
|
|
In Example 3, the SIP port for the Conferencing Announcement Service is set to 5074 for all 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 collections and then uses Set-CsApplicationServer to set the Conferencing Announcement Service SIP port to 5074.