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

Creates a new server application. Server applications are applications that are hosted by Microsoft Communications Server 2010.

Syntax


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

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


New-CsServerApplication -Name <String> -Parent <String> -Uri <String> [-Confirm [<SwitchParameter>]] [-Critical <$true \| $false>] [-Enabled <$true \| $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-Priority <Int32>] [-ScriptName <String>] [-WhatIf [<SwitchParameter>]]

New-CsServerApplication -Name <String> -Parent <String> -Uri <String> [-Confirm [<SwitchParameter>]] [-Critical <$true | $false>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-Priority <Int32>] [-ScriptName <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Optional	Xds Identity	Unique identifier for the server application to be created. 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.
Parent	Required	String	Specifies the service that will host the new server application. If you use the -Identity parameter then you do not need to use either the -Parent or the -Name parameters; that’s because the application Identity effectively combines the values of the Parent and Name properties. However, you can omit -Identity by using -Parent and -Name instead. In that case, the -Parent parameter would need to look something like this: -Parent "service:Redmond-Registrar-1".
Name	Required	String	Friendly name for the service. If you use the -Identity parameter you do not need to include the Name parameter when creating a new service; instead, the Name property will be populated using the name portion of the application Identity. For example, if you create a new application with the Identity service:Redmond-Registrar-1/TestService the application will automatically be named TestService. The -Name parameter is required only if you use the -Parent parameter.
Uri	Required	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 2010 will not start unless the application in question can be started. If False, then Communications Server 2010 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.
InMemory	Optional	Switch Parameter	Creates an object reference without actually committing the object as a permanent change. If the output of the cmdlet is not assigned to a variable, the object will be lost and nothing will be created.
Force	Optional	Switch Parameter
WhatIf	Optional	Switch Parameter	Describes what would happen if you executed the command without actually executing the command.
Confirm	Optional		Prompts you for confirmation before executing the command.

Detailed Description

Server applications refer to the individual programs that run under Unified Communications Application Services (UCAS). Application Server makes it easy for developers to deploy applications written for 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 New-CsServerApplication cmdlet provides a way for administrators to configure new servers applications.

Return Types

New-CsServerApplication creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object.

Examples

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

	Copy Code
New-CsServerApplication -Identity service:Redmond-EdgeServer-1/EdgeMonitor -Uri http://www.litwareinc.com/edgemonitor -Critical $False

Example 1 creates a new server application with the Identity service:Redmond-EdgeServer-1/EdgeMonitor. In addition to specifying the Identity, the parameters -Uri and -Critical are included when calling New-CsServerApplication. These parameters are used to specify the application Uri and to indicate the application is not considered critical.

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

	Copy Code
$x = New-CsServerApplication -Identity service:Redmond-EdgeServer-1/EdgeMonitor -InMemory $x.Uri = "http://www.litwareinc.com/edgemonitor" $x.Critical = $False Set-CsServerApplication -Instance $x

The commands shown in Example 2 demonstrate how you can create a new server application that initially exists only in memory. To do this, the first command calls New-CsServerApplication along with two parameters: -Identity (which specifies the Identity for the application) and -InMemory, which indicates that the new application should be created in memory only. (Note that the resulting object is stored in the variable $x.) After this virtual server application has been created, commands 2 and 3 are used to modify the values of the Uri and Critical properties, respectively. Finally, command 4 is used to transform the virtual server application into an actual server applications applied to the service Redmond-EdgeServer-1. Note that this final command is mandatory. If you do not call Set-CsServerApplication no application will be configured for Redmond-EdgeServer-1, and the virtual application will disappear as soon as you terminate your Windows PowerShell session or delete the variable $x.