Edit

Share via


Get-CsPoolBackupRelationship

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

Syntax

Default (Default)

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

Description

The Get-CsPoolBackupRelationship cmdlet returns the fully qualified domain name of the backup pool associated with a Registrar 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 Skype for Business Server Topology Builder.

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

Examples

Example 1

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

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

Parameters

-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

-LocalStore

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

Retrieves the backup relationship 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

-PoolFqdn

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

Fully qualified domain name of the pool whose backup relationship 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

Microsoft.Rtc.Management.Hadr.BackupService.BackupRelation