Backup-CsPool
Creates a backup copy of the specified Skype for Business Server pool. This cmdlet was introduced in Lync Server 2013.
Syntax
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" -SteadyStateIn Example 2, a "steady state" backup is done for the pool atl-cs-001.litwareinc.com.
Parameters
-Category
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
| Type: | BackupCategory |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-FailedOverPoolOnly
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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Force
Suppresses the display of any non-fatal error message that might occur when running the command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-FullBackup
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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-LocalStore
Retrieves the topology information from the local replica of the Central Management store rather than from the Central Management store itself.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-PoolFqdn
Fully qualified domain name of the pool being backed up. For example:
-SourcePoolFqdn "atl-cs-001.litwareinc.com"
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Report
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-RetryCount
Maximum number of times Backup-CsPool will try to call the backup service before failing.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-SteadyState
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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-WaitTime
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.
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
None.
The Backup-CsPool cmdlet does not accept pipelined data.
Outputs
None.