[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Removes an existing server application. Server applications are applications that are hosted by Microsoft Communications Server 2010.


Remove-CsServerApplication -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description



Xds Identity

Unique identifier for the server application to be removed. Server application Identities are composed of the service where the application is hosted plus the application name. For example, the server application named QoEAgent might have an Identity similar to this: service:Registrar:atl-cs-001.litwareinc.com/QoEAgent.



Switch Parameter



Switch Parameter

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



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Server applications refer to the individual programs that run under Microsoft Communications Server’s Application Server (commonly referred to as UCAS: Unified Communications Application Server). Application Server makes it easy for developers to deploy applications written for the Microsoft 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 Microsoft 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 Remove-CsServerApplication cmdlet provides a way for administrators to remove any application running as part of the Communications Server Application Server. Note that deleting a server application is not the same thing as uninstalling that application. When you run Remove-CsServerApplication the application no longer runs under Microsoft Communications Server. However, the software itself is not uninstalled, and the application can be re-enabled by running the New-CsServerApplication.

Return Types

Remove-CsServerApplication deles existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object.


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

Copy Code
Remove-CsServerApplication -Identity "service:EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor"

In Example 1, the server application that has the Identity service:Redmond-EdgeServer-1/EdgeMonitor is removed. Because Identities must be unique, this command will never delete more than a single application.

-------------------------- Example 2 ------------------------

Copy Code
Get-CsServerApplication | Where-Object {$_.Name -eq "EdgeMonitor"} | Remove-CsServerApplication

The command shown in Example 2 is a variation of the command shown in Example 1. This time, however, the command uses the Name property (rather than the object GUID) to identify the server application to be removed. The command starts off by using Get-CsServerApplication to return a collection of all the server applications currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out the application where the Name is equal to (-eq) EdgeMonitor. That single application is then piped to, and removed by, the Remove-CsServerApplication cmdlet.

-------------------------- Example 3 ------------------------

Copy Code
Get-CsServerApplication | Where-Object {$_.Critical -eq $False} | Remove-CsServerApplication

In Example 3, all the non-critical server applications are removed. To carry out this task, the command first calls Get-CsServerApplication in order to return a collection of all the server applications currently in use in the organization. This collection is then piped to Where-Object, which picks all the applications where the Critical property is equal to (-eq) False ($False). This filtered collection is then piped to Remove-CsServerApplication, which deletes each item in the collection.

-------------------------- Example 4 ------------------------

Copy Code
Get-CsServerApplication -Identity service:EdgeServer:atl-cs-001.litwareinc.com | Remove-CsServerApplication

The preceding command deletes all the server applications that have been configured for use by the service Redmond-EdgeServer-1. To do this, Get-CsServerApplication is used along with the Identity service:Redmond-EdgeServer-1; that command returns all the applications that have an Identity that begins with the characters "Redmond-EdgeServer-1". In turn, that collection is piped to Remove-CsServerApplication, which then deletes each application from the Redmond-EdgeServer-1 service.