Set-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

Set-CsBackupServiceConfiguration
   [[-Identity] <XdsIdentity>]
   [-AuthorizedLocalAccounts <String>]
   [-AuthorizedUniversalGroups <String>]
   [-Confirm]
   [-Force]
   [-MaxBatchesPerCmsSync <Int32>]
   [-MaxBatchesPerUserStoreSync <Int32>]
   [-MaxConcurrentCalls <Int32>]
   [-MaxDataConfPackageSizeKB <Int32>]
   [-SyncInterval <TimeSpan>]
   [-WhatIf]
   [-MaxHighPriQueuePercentagePerUserStoreSync <Int32>]
   [<CommonParameters>]
Set-CsBackupServiceConfiguration
   [-AuthorizedLocalAccounts <String>]
   [-AuthorizedUniversalGroups <String>]
   [-Confirm]
   [-Force]
   [-Instance <PSObject>]
   [-MaxBatchesPerCmsSync <Int32>]
   [-MaxBatchesPerUserStoreSync <Int32>]
   [-MaxConcurrentCalls <Int32>]
   [-MaxDataConfPackageSizeKB <Int32>]
   [-SyncInterval <TimeSpan>]
   [-WhatIf]
   [-MaxHighPriQueuePercentagePerUserStoreSync <Int32>]
   [<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.

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

Examples

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

Set-CsBackupServiceConfiguration -Identity "global" -AuthorizedUniversalGroups "Schema Admins"

The command shown in Example 1 assigns the Active Directory security group Schema Admins to the AuthorizedUniversalGroups property for the global collection of backup service settings.

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

Set-CsBackupServiceConfiguration -Identity "global" -MaxConcurrentCalls 12

In Example 2, the MaxConcurrentCalls property of the global collection of backup service settings is set to 12.

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

Set-CsBackupServiceConfiguration -Identity "global" -SyncInterval "00:10:00"

Example 3 modifies the SyncInterval property of the global collection of backup service settings. In this example, SyncInterval is set to 10 minutes: 00 hours : 10 minutes : 00 seconds.

Optional Parameters

-AuthorizedLocalAccounts

Names of the local users/local groups that are authorized to run the backup service. The default value is Network Service.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-AuthorizedUniversalGroups

Names of the universal groups authorized to run the backup service. The default value is Schema admins.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-Identity

Unique identifier for 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 Set-CsBackupServiceConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings:

-Identity global

Type:XdsIdentity
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-Instance

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

Type:PSObject
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-MaxBatchesPerCmsSync

Maximum number of batches that the CMS backup module will export during each export cycle. The default value is 500.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-MaxBatchesPerUserStoreSync

Maximum number of batches that the User Store backup module will export during each export cycle. The default value is 500.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-MaxConcurrentCalls

The maximum number of Windows Communication Foundation (WCF) calls that can be made to the backup service at the same time. The default value is 10.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-MaxDataConfPackageSizeKB

Maximum size of the data package (in kilobytes) that the Data Conference module will export during each export cycle. The default value is 102400.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-MaxHighPriQueuePercentagePerUserStoreSync

PARAMVALUE: Int32

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015
-SyncInterval

Specifies the amount of time that the service waits before synchronizing a pool with its backup pool. The default value is 2 minutes (00:02:00, or 00 hours, 02 minutes, 00 seconds). The SyncInterval can be configured to any value between 5 seconds (00:00:05) and 3 hours (03:00:00), inclusive.

Type:TimeSpan
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015

Inputs

The Set-CsBackupServiceConfiguration cmdlet accepts piped instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object.

Outputs

None. Instead, the Set-CsBackupServiceConfiguration cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object.