Topic Last Modified: 2014-02-05

Retrieves the backup service configuration settings for Lync Server 2013. 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

Get-CsBackupServiceConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Get-CsBackupServiceConfiguration [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]

Examples

Example 1

The command shown in Example 1 retrieves the backup service configuration information for Lync Server 2013. 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.

Copy Code
Get-CsBackupServiceConfiguration

Detailed Description

The backup service configuration settings are used to manage pool backups in Lync Server 2013. Note that Lync 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 Lync Server 2013 server role or from a remote instance of Windows PowerShell.

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-CsBackupServiceConfiguration"}

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

Parameters

Parameter Required Type Description

Filter

Optional

System.String

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".

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsIdentity

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

LocalStore

Optional

System.Management.Automation.SwitchParameter

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

Input Types

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

Return Types

The Get-CsBackupServiceConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object.

See Also