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

Modifies the property values of an existing server application. Server applications are applications that are hosted by Microsoft Communications Server 2010.

Syntax


Set-CsServerApplication [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Critical <$true \| $false>] [-Enabled <$true \| $false>] [-Force <SwitchParameter>] [-Priority <Int32>] [-ScriptName <String>] [-Uri <String>] [-WhatIf [<SwitchParameter>]]

Set-CsServerApplication [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Critical <$true | $false>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-Priority <Int32>] [-ScriptName <String>] [-Uri <String>] [-WhatIf [<SwitchParameter>]]


Set-CsServerApplication [-Confirm [<SwitchParameter>]] [-Critical <$true \| $false>] [-Enabled <$true \| $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Priority <Int32>] [-ScriptName <String>] [-Uri <String>] [-WhatIf [<SwitchParameter>]]

Set-CsServerApplication [-Confirm [<SwitchParameter>]] [-Critical <$true | $false>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Priority <Int32>] [-ScriptName <String>] [-Uri <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Optional	Xds Identity	Unique identifier for the server application to be modified. 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:Redmond-Registrar-1/QoEAgent.
Instance	Optional	ServerApplication.Application object	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
Uri	Optional	String	Unique URI for the application. For example, the QoEAgent application has the URI http://www.microsoft.com/LCS/QoEAgent.
Enabled	Optional	Boolean	Set this value to True to enable the application. Set the value to false to disable the application.
Critical	Optional	Boolean	If set to True, then Communications Server will not start unless the application in question can be started. If False, then Communications Server will start regardless of whether or not the application can be started.
ScriptName	Optional	String	Path to the MSPL script used by the application (if applicable). MSPL is short for Microsoft SIP Processing Language, a scripting language used for filtering and routing SIP messages.
Priority	Optional	Integer	Indicates the order of execution for server applications. The application with priority 0 is started first; the application with priority 1 is started second; and so on. Note that each service that hosts a server application has its own unique set of priorities. For example, the Registrar service might host three applications with corresponding priorities 0, 1, and 2. Similarly, the Edge Server service might have 4 applications; these applications will have the priorities 0, 1, 2, and 3. If you do not specify a priority then the application will automatically be added to the bottom of the priority list. If you add or remove an application the priorities of the other applications will be adjusted accordingly. For example, if you delete an application that has a priority of 0 then the application that previously had the priority 1 will automatically have its priority set to 0.
Force	Optional	Switch Parameter
Confirm	Optional	Switch Parameter	Prompts you for confirmation before executing the command.
WhatIf	Optional	Switch Parameter	Describes what would happen if you executed the command without actually 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 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-CsServerApplication cmdlet provides a way for administrators to modify the property values of any application running as part of the Communications Server Application Server.

Return Types

Set-CsServerApplication does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.ServerApplication.application object.

Examples

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

	Copy Code
Set-CsServerApplication -Identity Service:Redmond-Registrar-1/ExumRouting -Enabled $False

The command shown in Example 1 enables the server application that has the Identity Service:Redmond-Registrar-1/ExumRouting. Because Identities must be unique, this command will only enable a single server application.

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

	Copy Code
Get-CsServerApplication \| Where-Object {$_.Enabled -eq $False} \| Set-CsServerApplication -Enabled $True

The preceding command enables all the server applications that are currently disabled. To do this, 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 the Where-Object, which picks out only those applications where the Enabled property is equal to (-eq) False ($False); by definition, those are the disabled applications. In turn, that filtered collection is piped to Set-CsServerApplication, which takes each item in the collection and sets the Enabled property to True.