Returns information about the services and service roles being used in your Microsoft Communications Server 2010 infrastructure. A service is an instance of a role that has been deployed in a Microsoft Communications Server pool. For example, you might have a UCAS pool: a set of computers all running the Unified Communications Application Server service.
Syntax
Get-CsService [-Identity <XdsGlobalRelativeIdentity>] [-PoolFqdn <String>] |
Get-CsService [-Filter <String>] [-PoolFqdn <String>] |
Get-CsService [-ApplicationServer <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-ApplicationDatabase <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-ArchivingServer <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-ArchivingDatabase <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-CentralManagement <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-CentralManagementDatabase <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-ConferenceServer <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-Director <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-EdgeServer <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-PoolFqdn <String>] [-TrustedApplicationPool <SwitchParameter>] |
Get-CsService [-FileStore <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-ManagementServer <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-MediationServer <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-MonitoringServer <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-MonitoringDatabase <SwitchParameter>] [-PoolFqdn <String>] |
Get-CsService [-PoolFqdn <String>] [-PstnGateway <SwitchParameter>] |
Get-CsService [-PoolFqdn <String>] [-ProvisionServer <SwitchParameter>] |
Get-CsService [-PoolFqdn <String>] [-ProvisionDatabase <SwitchParameter>] |
Get-CsService [-PoolFqdn <String>] [-Registrar <SwitchParameter>] |
Get-CsService [-PoolFqdn <String>] [-UserServer <SwitchParameter>] |
Get-CsService [-PoolFqdn <String>] [-UserDatabase <SwitchParameter>] |
Get-CsService [-PoolFqdn <String>] [-WebServer <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Unique identifier of the specific service or server role to be returned. For example: -Identity Redmond-Registrar-1. |
|
Filter |
Optional |
String |
Enables you to use wildcards to specify the service (or services) to be returned. For example, this command returns all the services and server roles found on the Redmond site: -Filter "Redmond-*". You cannot use both the –Identity and the –Filter parameters in the same command. |
|
PoolFqdn |
Optional |
String |
Fully qualified domain name of the pool hosting the service or server role. If you use just the –PoolFqdn parameter, without specifying a service-specific parameter, then all the services and server roles found on that pool will be returned.. |
|
ApplicationServer |
Optional |
Switch Parameter |
Returns information about the Application Servers used in your organization. Application Servers provide a way to run custom applications created using the Unified Communications Server APIs. |
|
ApplicationDatabase |
Optional |
Switch Parameter |
Returns information about the application databases used in your organization. Application databases are used by Application Servers, |
|
ArchivingServer |
Optional |
Switch Parameter |
Returns information about the Archiving Servers used in your organization. Archiving Servers enable you to save the transcripts of instant message sessions. |
|
ArchivingDatabase |
Optional |
Switch Parameter |
Returns information about the archiving databases used in your organization. Archiving databases store transcripts of instant message sessions. |
|
CentralManagement |
Optional |
Switch Parameter |
Returns information about the Central Management roles used in your organization. Central Management Servers are roughly-equivalent to the front-end servers used in Office Communications Server 2007 R2. |
|
CentralManagementDatabase |
Optional |
Switch Parameter |
Returns information about the Central Management database used in your organization. The Central Management database maintains configuration information for Microsoft Communications Server. |
|
ConferenceServer |
Optional |
Switch Parameter |
Returns information about the Conference Servers used in your organization. Conference Servers are used to conduct online meetings and conferences. |
|
Director |
Optional |
Switch Parameter |
Returns information about the Directors used in your organization. Directors are empowered to handle user requests and user authentication, but do not house user accounts. Directors are typically used to handle requests from external users. |
|
EdgeServer |
Optional |
Switch Parameter |
Returns information about the Edge Servers used in your organization. Edge Servers provide connectivity between your internal network and the Internet. |
|
ExternalServer |
Optional |
Switch Parameter |
Returns information about the External Servers used in your organization. External Servers enable users to log on to Microsoft Communicator from outside the internal network. |
|
FileStore |
Optional |
Switch Parameter |
Returns information about the File Stores used in your organization. The File store is used to maintain Communications Server files, such as audio files used by the Announcement service. |
|
ManagementServer |
Optional |
Switch Parameter |
Returns information about the Management Servers used in your organization. Management Servers are used to send configuration data to computers running Microsoft Communications Server components. The first Communications Server computer in a site is assigned the role of Management Server. |
|
MediationServer |
Optional |
Switch Parameter |
Returns information about the Mediation Servers used in your organization. Mediation Servers help provide a bridge between your Enterprise Voice network and the Public Switched Telephone Network. |
|
MonitoringServer |
Optional |
Switch Parameter |
Returns information about the Monitoring Servers used in your organization. Monitoring Servers are used to track Enterprise Voice phone usage and call quality. |
|
MonitoringDatabase |
Optional |
Switch Parameter |
Returns information about the monitoring databases used in your organization. Monitoring databases store Enterprise Voice phone usage and call quality information. |
|
PstnGateway |
Optional |
Switch Parameter |
Returns information about the PSTN (Public Switched Telephone Network) gateways used in your organization. PSTN gateways translate signals from Enterprise Voice devices to signals that can be understood by PSTN devices, and voice-versa. |
|
ProvisionServer |
Optional |
Switch Parameter |
Returns information about the Provision Server used in your organization. Provision Servers are used to manage Communications Server certificates. |
|
ProvisionDatabase |
Optional |
Switch Parameter |
Returns information about the provision databases used in your organization. Provision databases maintain information about Communications Server certificates. |
|
Registrar |
Optional |
Switch Parameter |
Returns information about the Registrars used in your organization. Registrars are used to authenticate users and to keep track of a user’s current status. |
|
UserServer |
Optional |
Switch Parameter |
Returns information about the User Servers used in your organization. User Servers provide such things as user replication, in-band provisioning, presence publication and notification, and contact card exchange. |
|
UserDatabase |
Optional |
Switch Parameter |
Returns information about the user databases used in your organization. User databases store data needed by User Servers. |
|
WebServer |
Optional |
Switch Parameter |
Returns information about the Web Servers used in your organization. Web servers host Web-based applications such as the Address Book Service. |
Detailed Description
The capabilities inherent in Microsoft Communications Server are typically expressed as services or as server roles. For example, you can configure Communications Server to automatically save a transcript of every instant messaging session that takes place in your organization. In order to do this, you must install the Arching Server server role. Services and server roles can be configured at the same time you install Communications Server itself, or they can be configured after the software is up and running.
The Get-CsService role enables you to return information about the Communications Server and services running in your organization. Called without any additional parameters, Get-CsService returns detailed information about all your services and server roles. Alternatively, you can limit the returned data to a specified pool by using the –PoolFqdn parameter. In addition, you can use any number of "switch parameters" to limit the returned data to a specific type of service. (A switch parameter is a parameter that does not require a parameter value.) For example, this command returns information about all your Archiving Servers: Get-CsService –ArchivingServer.
Note that you can only use one such switch parameter per command. This command, which tries to return information about both Archiving Servers and Monitoring Servers, will fail: Get-CsService –ArchivingServer –MonitoringServer. To return information for multiple server roles you must first use Get-CsService to return a complete collection of service data, then pipe that data to the Where-Object cmdlet:
Get-CsService | Where-Object {$_.Role –eq "ArchivingServer" –or $_.Role –eq "MonitoringServer"}
Return Types
Get-CsService returns different objects based on the parameters used when calling the cmdlet. For example, if you include the -MonitoringDatabase parameter Get-CsService returns instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase object. To determine the objects returned using other parameters, call Get-CsService using one of those parameters and then pipe the returned object to the Get-Member cmdlet. For example: Get-CsService -Registrar | Get-Member.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsService |
|
The command shown in Example 1 returns information about all the Communications Server 2010 services and server roles currently running in your organization. This information is returned simply by calling Get-CsService without any additional parameters.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsService -ApplicationServer |
|
Example 2 returns information only about the application servers currently used in your organization. You can return information for other services/server roles simply by using the appropriate parameter. For example, this command returns information about the file store: Get-CsService -FileStore. Note, however, that you can only specify one service type at a time; this command will fail because it includes two service type parameters: Get-CsService -FileStore -ApplicationServer. To return information about multiple services/server roles use the Where-Object cmdlet: Get-CsService | Where-Object {$_.Role -eq "ApplicationServer" -or $_.Role -eq "FileStore"}.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsService -PoolFqdn "redmond-cs-001.litwareinc.com" | Select-Object Identity |
|
The preceding command reports back the Identity for each service located on the pool Redmond-cs-001.litwareinc.com. To carry out this task, the command first calls Get-CsService and the –PoolFqdn parameter to return only those services and server roles found on the pool Redmond-cs-001.litwareinc.com. This collection is then piped to the Select-Object cmdlet, which reports back the Identity of each item in the collection.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsService | Where-Object {$_.SiteID -eq "site:Redmond"}
|
|
In Example 4, information is returned for all the services/server roles found on the Redmond site. This is done by first calling Get-CsService, without any parameters, in order to return a collection of all the services and server roles currently in use in the organization. This data is then piped to the Where-Object cmdlet, which picks out only those items where the SiteID property is equal to (-eq) site:Redmond.
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
Get-CsService | Where-Object {$_.DependentServiceList -like "*Registrar*"}
|
|
The command shown in Example 5 returns information about all the services that list the Registrar as a dependent service. To do this, get-CsService is called in order to return a collection of all the services and server roles currently in use. This collection is then piped to Where-Object, which selects each item where the DependentServiceList properties includes the string value "Registrar". The Where-Object criteria is specified by using the -like operator and the wildcard value "*Registrar*".