Export (0) Print
Expand All
Expand Minimize

Remove-CsServerApplication

 

Topic Last Modified: 2013-02-21

Removes an existing server application. Server applications are applications that are hosted by Lync Server. This cmdlet was introduced in Lync Server 2010.

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

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

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

In Example 2, all the non-critical server applications are removed. To carry out this task, the command first calls the Get-CsServerApplication cmdlet in order 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 all the applications where the Critical property is equal to False. This filtered collection is then piped to the Remove-CsServerApplication cmdlet, which deletes each item in the collection.

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

Example 3 deletes all the server applications that have been configured for use by the service EdgeServer:atl-cs-001.litwareinc.com. To do this, the Get-CsServerApplication cmdlet is used along with the Filter parameter; the filter value "service:EdgeServer:atl-cs-001.litwareinc.com/*" returns all the applications that have an Identity that begins with the characters "service:EdgeServer:atl-cs-001.litwareinc.com/". In turn, that collection is piped to the Remove-CsServerApplication cmdlet , which deletes each application from the EdgeServer:atl-cs-001.litwareinc.com.

Get-CsServerApplication -Filter "service:EdgeServer:atl-cs-001.litwareinc.com/*" | Remove-CsServerApplication

Server applications refer to the individual programs that run under Lync Server. The Remove-CsServerApplication cmdlet provides a way for administrators to remove any application running as part of Lync Server. Note that deleting a server application is not the same thing as uninstalling that application. When you run the Remove-CsServerApplication cmdlet, the application no longer runs under Lync Server. However, the software itself is not uninstalled, and the application can be re-enabled by running the New-CsServerApplication cmdlet.

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

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.XdsIdentity

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.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object. The Remove-CsServerApplication cmdlet accepts pipelined instances of the server application object.

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

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