Edit

Share via

Backup-CsPool

Module:
Skype for Business Server PowerShell

Creates a backup copy of the specified Skype for Business Server pool. This cmdlet was introduced in Lync Server 2013.

Syntax

Default (Default) 

Backup-CsPool
    -PoolFqdn <Fqdn>
    [-Category <BackupCategory>]
    [-Confirm]
    [-FailedOverPoolOnly]
    [-Force]
    [-FullBackup]
    [-LocalStore]
    [-Report <String>]
    [-RetryCount <Int32>]
    [-SteadyState]
    [-WaitTime <TimeSpan>]
    [-WhatIf]
    [<CommonParameters>]

Description

The Backup-CsPool cmdlet enables administrators to copy user data and conference data for a Registrar pool to a specified backup pool. If the primary pool should fail or otherwise become unavailable, users homed on that primary pool can then be "failed over" to the backup pool. Those users can then log on to Skype for Business Server via the backup pool and continue to use that pool until their home pool has been restored.

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 "Backup-CsPool"}

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

Examples

Example 1

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

The command shown in Example 1 backs up the pool atl-cs-001.litwareinc.com.

Example 2

Backup-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" -SteadyState

In Example 2, a "steady state" backup is done for the pool atl-cs-001.litwareinc.com.

Parameters

-Category

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

Enables you to select the Skype for Business Server modules that will be backed up; if this parameter is not present then all the modules will be backed up. Allowed values are:

  • CMS
  • UserData
  • RGS

Parameter properties

Type:BackupCategory
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

-Confirm

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

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FailedOverPoolOnly

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

When specified, backup will take place only if the pool is in a failed over state. If you use this parameter then you must also use the FullBackup parameter.

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

-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

-FullBackup

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

When present, backup will not begin until the backup service has reached its final state. You cannot use both the FullBackup parameter and the SteadyState parameter in the same 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 topology information 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 being backed up. For example:

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

-Report

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

File path for the log file created when the cmdlet runs. For example:

-Report "C:\Logs\BackupPool.html"

If this file already exists, it will be overwritten when you run the cmdlet.

By default, reports are written to the AppData\Local\Temp folder in your user profile.

Parameter properties

Type:String
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

-RetryCount

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

Maximum number of times Backup-CsPool will try to call the backup service before failing.

Parameter properties

Type:Int32
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

-SteadyState

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

When present, backup will not begin until the backup service has reached a steady state. A "steady state" occurs when the pool switches to read-only or failover/failback mode and no longer produces any new data that needs to be backed up.

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

-WaitTime

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

Amount of time (in seconds) that the cmdlet will wait before checking to see if the backup service is in either the full state or the steady state.

Parameter properties

Type:TimeSpan
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

-WhatIf

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

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

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

The Backup-CsPool cmdlet does not accept pipelined data.

Outputs

None