Get-CsService

Syntax

Get-CsService
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-Filter <String>]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-ApplicationDatabase]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-ApplicationServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-ArchivingDatabase]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-ArchivingServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-CentralManagement]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-CentralManagementDatabase]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-ConferencingServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-Director]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-EdgeServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-FileStore]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-ManagementServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-MediationServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-MonitoringServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-MonitoringDatabase]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-ProvisionServer]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-ProvisionDatabase]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-PstnGateway]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-Registrar]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-TrustedApplicationPool]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-UserDatabase]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-UserServer]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-WebServer]
   [<CommonParameters>]

Get-CsService
   [-BackupServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-LegalInterceptServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-PersistentChatComplianceDatabase]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-PersistentChatDatabase]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-PersistentChatServer]
   [-PoolFqdn <String>]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-WacServer]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-VideoGateway]
   [<CommonParameters>]

Get-CsService
   [-PoolFqdn <String>]
   [-VideoInteropServer]
   [<CommonParameters>]

Description

The capabilities found in Skype for Business Server are typically expressed as services or as server roles. For example, you can configure Skype for Business 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 Archiving Server server role. Services and server roles can be configured at the same time you install Skype for Business Server itself, or they can be configured after the software is up and running.

The Get-CsService cmdlet enables you to return information about the server roles and services running in your organization. Called without any additional parameters, the Get-CsService cmdlet 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. The following command, which tries to return information about both Archiving Servers and Monitoring Servers, will fail:

Get-CsService -ArchivingServer -MonitoringServer

If you need to return information for multiple server roles, you can use the Get-CsService cmdlet to return a complete collection of service data, and then pipe that data to the Where-Object cmdlet:

Get-CsService | Where-Object {$_.Role -eq "ArchivingServer" -or $_.Role -eq "MonitoringServer"}

Examples

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

Get-CsService

The command shown in Example 1 returns information about all the Skype for Business Server services and server roles currently running in your organization.

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

Get-CsService -ApplicationServer

Example 2 returns information only about the Application service. 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:

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

Get-CsService -PoolFqdn "atl-cs-001.litwareinc.com" | Select-Object Identity

Example 3 reports back the Identity for each service located on the pool atl-cs-001.litwareinc.com. To carry out this task, the command first calls the Get-CsService cmdlet and the PoolFqdn parameter to return only those services and server roles found on the pool atl-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 --------------------------

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 the Get-CsService cmdlet 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 site:Redmond.

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

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, the Get-CsService cmdlet is called in order to return a collection of all the services and server roles currently in use. This collection is then piped to the Where-Object cmdlet, which selects each item where the DependentServiceList property includes the string value "Registrar". The Where-Object cmdlet criteria is specified by using the -like operator and the wildcard value "Registrar".

Parameters

-ApplicationDatabase

-ApplicationServer

-ArchivingDatabase

-ArchivingServer

-BackupServer

-CentralManagement

-CentralManagementDatabase

-ConferencingServer

-Director

-EdgeServer

-FileStore

-Filter

-Identity

-LegalInterceptServer

-ManagementServer

-MediationServer

-MonitoringDatabase

-MonitoringServer

-PersistentChatComplianceDatabase

-PersistentChatDatabase

-PersistentChatServer

-PoolFqdn

-ProvisionDatabase

-ProvisionServer

-PstnGateway

-Registrar

-TrustedApplicationPool

-UserDatabase

-UserServer

-VideoGateway

-VideoInteropServer

-WacServer

-WebServer

Inputs

None

Outputs

The Get-CsService cmdlet returns different objects based on the parameters used when calling the cmdlet. For example, if you include the MonitoringDatabase parameter, the Get-CsService cmdlet returns instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase object. To determine the objects returned using other parameters, call the Get-CsService cmdlet using one of those parameters, and then pipe the returned object to the Get-Member cmdlet. For example:

Get-CsService -Registrar | Get-Member

Related Links

• Set-CsApplicationServer
• Set-CsArchivingServer
• Set-CsConferenceServer
• Set-CsDirector
• Set-CsEdgeServer
• Set-CsManagementServer
• Set-CsMediationServer
• Set-CsMonitoringServer
• Set-CsRegistrar
• Set-CsUserServer
• Set-CsWebServer