Topic Last Modified: 2013-12-13

Returns information about the current state of the backup service for a specified pool. This cmdlet was introduced in Lync Server 2013.

Syntax

Get-CsBackupServiceStatus -PoolFqdn <Fqdn> [-Category <UserData | CMS>] [-Force <SwitchParameter>]

Examples

Example 1

The preceding command returns the backup service status for the pool atl-cs-001.litwareinc.com.

Copy Code
Get-CsBackupServiceStatus -PoolFqdn "atl-cs-001.litwareinc.com"

Detailed Description

The Get-CsBackupServiceStatus cmdlet enables administrators to verify that the backup service for a specified Registrar pool has been configured and is working properly. Note that, by default, only users who belong to the RTCUniversalServerAdmins group are allowed to run this cmdlet and check the backup status for a pool. To provide additional groups with permission to run the cmdlet, use the Set-CsBackupServiceConfiguration cmdlet to add those groups to the AuthorizedUniversalGroups property.

To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell command-line interface prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsBackupServiceStatus"}

Lync Server Control Panel: The functions carried out by the Get-CsBackupServiceStatus cmdlet are not available in the Lync Server Control Panel.

Parameters

Parameter Required Type Description

PoolFqdn

Required

Microsoft.Rtc.Management.Deploy.Fqdn

Fully qualified domain name of the pool whose backup service status is being checked. For example:

-PoolFqdn "atl-cs-001.litwareinc.com"

Category

Optional

Microsoft.Rtc.Management.Hadr.BackupService.BackupCategory

Type of backup whose status is being checked. Allowed values are:

* CMS

* UserData

If this parameter is not specified then both backup types will be checked.

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

Input Types

None. The Get-CsBackupServiceStatus cmdlet does not accept pipelined input.

Return Types

Returns information about the backup service.

See Also