See Also
Topic Last Modified: 2014-02-04
Creates a backup copy of the specified Lync Server 2013 pool. This cmdlet was introduced in Lync Server 2013.
Syntax
Backup-CsPool -PoolFqdn <Fqdn> [-Category
<UserData | CMS>] [-Confirm [<SwitchParameter>]]
[-FailedOverPoolOnly <SwitchParameter>] [-Force
<SwitchParameter>] [-FullBackup <SwitchParameter>]
[-LocalStore <SwitchParameter>] [-Report <String>]
[-RetryCount <Int32>] [-SteadyState <SwitchParameter>]
[-WaitTime <TimeSpan>] [-WhatIf
[<SwitchParameter>]]
|
Examples
Example 1
The command shown in Example 1 backs up the pool atl-cs-001.litwareinc.com.
 Copy Code |
|
|---|---|
Backup-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" |
|
Example 2
In Example 2, a "steady state" backup is done for the pool atl-cs-001.litwareinc.com.
| Copy Code |
|
|---|---|
Backup-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" -SteadyState |
|
Detailed 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 Lync 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 command-line interface prompt:Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Backup-CsPool"}
Lync Server Control Panel: The functions carried out by the Backup-CsPool 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 being backed up. For example: -SourcePoolFqdn "atl-cs-001.litwareinc.com" |
|
Category |
Optional |
Microsoft.Rtc.Management.Hadr.BackupService.BackupCategory |
Enables you to select the Lync 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 |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
|
FailedOverPoolOnly |
Optional |
System.Management.Automation.SwitchParameter |
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. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
|
FullBackup |
Optional |
System.Management.Automation.SwitchParameter |
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. |
|
LocalStore |
Optional |
System.Management.Automation.SwitchParameter |
Retrieves the topology information from the local replica of the Central Management store rather than from the Central Management store itself. |
|
Report |
Optional |
System.String |
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. |
|
RetryCount |
Optional |
System.Int32 |
Maximum number of times Backup-CsPool will try to call the backup service before failing. |
|
SteadyState |
Optional |
System.Management.Automation.SwitchParameter |
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. |
|
WaitTime |
Optional |
System.TimeSpan |
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. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
None. The Backup-CsPool cmdlet does not accept pipelined data.
Return Types
None.
