Get-CsServerApplication [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]

Get-CsServerApplication [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

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 Get-CsServerApplication cmdlet provides a way for administrators to return information about any (or all) of the applications running as part of the Communications Server Application Server.

Get-CsServerApplication returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.ServerApplication.Application object.

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

	Copy Code
Get-CsServerApplication

The command shown in Example 1 returns information about all the server applications currently in use in the organization. This is done by calling Get-CsServerApplication without any parameters.

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

	Copy Code
Get-CsServerApplication -Identity service:EdgeServer:atl-edge-001.litwareinc.com

In Example 2, information is returned for all the server applications running on the service EdgeServer:atl-edge-001.litwareinc.com.

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

	Copy Code
Get-CsServerApplication -Identity service: Registrar:atl-cs-001.litwareinc.com/ExumRouting

Example 3 returns information for a single server application: the application that has the Identity Registrar:atl-cs-001.litwareinc.com.

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

	Copy Code
Get-CsServerApplication -Filter "service:*:atl-cs-001.litwareinc.com*"

The preceding command returns all the server applications configured for use in the pool atl-cs-001.litwareinc.com. This is done by using the -Filter parameter and the filter value "service:*:atl-cs-001.litwareinc.com*". The filter value limits the returned data to applications who have an Identity that begins with the characters "service:" and include the characters ":atl-cs-001.litwareinc.com".

-------------------------- Example 5 ------------------------

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

In Example 5, information is returned for all the server applications that are currently disabled. To carry out this task the command first calls Get-CsServerApplication to return a collection of all the server applications configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those applications where the Enabled property is equal to (-eq) false ($False).

-------------------------- Example 6 ------------------------

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

Example 6 is a variation of the command shown in Example 5. In Example 6, information is returned for all the server applications that are both marked as critical and are currently disabled. To do this, the command first calls Get-CsServerApplication without any parameters; that returns a collection of all the server applications configured for use. This collection is then piped to Where-Object, which picks out only those applications that meet two criteria: 1) the Critical property must be equal to (-eq) True ($True); and, 2) the Enabled property must be equal to false ($False). The -and operator ensures that only objects that meet both criteria will be returned.

-------------------------- Example 7 ------------------------

	Copy Code
Get-CsServerApplication | Where-Object {$_.Uri -like "*routing*"}

In Example 7, information is returned for any server application that has the string value "routing" somewhere in its Uri. This task is accomplished by first using Get-CsServerApplication to retrieve all the server applications currently in use. The resulting collection is then piped to Where-Object, which selects only those applications in which the Uri property includes (-like) the wildcard "*routing*".

-------------------------- Example 8 ------------------------

	Copy Code
Get-CsServerApplication | Where-Object {$_.ScriptName -ne $Null}

The preceding command returns information for all the server applications that have been assigned a script. To do this, the command first retrieves a collection of all the server applications currently in use; this information is retrieved by calling Get-CsServerApplication without any parameters. The complete collection of server applications is then piped to the Where-Object cmdlet, which selects only those applications where the ScriptName property is not equal to (-ne) a null value ($Null). If the ScriptName property is not equal to a null value that means that a script has been assigned to that application.