Edit

Share via

Get-CsBackupServiceStatus

Module:
Skype for Business Server PowerShell

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

Syntax

Default (Default) 

Get-CsBackupServiceStatus
    -PoolFqdn <Fqdn>
    [-Category <BackupCategory>]
    [-Force]
    [<CommonParameters>]

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.

The functions carried out by the Get-CsBackupServiceStatus cmdlet are not available in the Skype for Business Server.

Examples

Example 1

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

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

Parameters

-Category

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

  • CMS
  • UserData
  • RGS

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

Parameter properties

Type:BackupCategory
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PoolFqdn

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

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

Parameter properties

Type:Fqdn
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object

Returns information about the backup service.