Topic Last Modified: 2013-03-07

Returns information about the backup pool associated with a Lync Online pool. This cmdlet was introduced in Lync Server 2013.

Syntax

Get-CsPoolBackupRelationship -PoolFqdn <Fqdn> [-Force <SwitchParameter>] [-LocalStore <SwitchParameter>]

Examples

Example 1

The command shown in Example returns information about the backup relationship assigned to the pool atl-cs-001.litwareinc.com.

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

Detailed Description

The Get-CsPoolBackupRelationship cmdlet returns the fully qualified domain name of the backup pool associated with a Registar pool. Note that this is read-only information: there is no corresponding Set-CsPoolBackupRelationship cmdlet that lets you use the Windows PowerShell command-line interface to create a backup association. Instead, backup pools must be assigned using Lync Server Topology Builder.

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 prompt:

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

Lync Server Control Panel: The functions carried out by the Get-CsPoolBackupRelationship 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 relationship is being checked. For example:

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

Force

Optional

System.Management.Automation.SwitchParameter

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

LocalStore

Optional

System.Management.Automation.SwitchParameter

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

Input Types

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

Return Types

The Get-CsPoolBackupRelationship cmdlet returns instances of the Microsoft.Rtc.Management.Hadr.BackupService.BackupRelation object.