Edit

Share via


Get-CsBackupServiceConfiguration

Retrieves the backup service configuration settings for Skype for Business Server. These settings include information about the maximum number of simultaneous Windows Communication Framework calls that can be made to the backup service, as well as the backup service synchronization interval. This cmdlet was introduced in Lync Server 2013.

Syntax

Filter

Get-CsBackupServiceConfiguration
    [-Filter <String>]
    [-LocalStore]
    [<CommonParameters>]

Identity

Get-CsBackupServiceConfiguration
    [[-Identity] <XdsIdentity>]
    [-LocalStore]
    [<CommonParameters>]

Description

The backup service configuration settings are used to manage pool backups in Skype for Business Server. Note that Skype for Business Server allows only for a single, global collection of backup configuration settings. Among other things, that means that all your pools must be backed up using the same synchronization schedule, and that users and groups authorized to backup Pool A are also allowed to backup Pools B, C, D, and E.

Get-CsBackupServiceConfiguration can be run from any computer running a Skype for Business Server server role or from a remote instance of Windows PowerShell.

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

Examples

Example 1

Get-CsBackupServiceConfiguration

The command shown in Example 1 retrieves the backup service configuration information for Skype for Business Server. Because there is only a single, global set of backup service configuration settings you do not need to include the Identity parameter when running this command.

Parameters

-Filter

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

Enables you to use wildcard values when referencing a collection of backup service configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings:

-Filter "g*"

The preceding syntax returns all the conference backup service configuration settings that have an Identity that begins with the letter "g".

Parameter properties

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

Parameter sets

Filter
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

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

Unique Identity of the backup service configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsBackupServiceConfiguration cmdlet. You can, however, use the following syntax to reference the global settings:

-Identity global

Parameter properties

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

Parameter sets

Identity
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocalStore

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

Retrieves the backup service configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

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

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

Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration