Invoke-CsPoolFailBack
Invokes the failback process for a Skype for Business Server pool. Failback is used after a pool has failed over and the users of that pool have been "failed over" to a backup pool. (That simply means users who were signed on to the failed pool are automatically signed on to the backup pool.) When the failed pool has been restored, the fail back process signs the failed-over users back to their original pool. This cmdlet was introduced in Lync Server 2013.
Syntax
Default (Default)
Invoke-CsPoolFailBack
-PoolFqdn <Fqdn>
[-Confirm]
[-DisasterMode]
[-Force]
[-WaitTime <TimeSpan>]
[-WhatIf]
[-DatabaseCommandTimeoutInSeconds <Int32>]
[-SkipDataVerification]
[<CommonParameters>]
Description
The pool failover process provides a way for administrators to quickly restore service to users if the Registrar pool they have logged on to should suddenly become unavailable. If a pool fails, users will automatically be signed off from Skype for Business Server; if they immediately try to log back on, they will be redirected to their specified backup pool.
To restore service to these users, administrators can run the Invoke-CsPoolFailOver cmdlet against the pool that is not currently available. Doing this will allow users to sign on to Skype for Business Server using the designated backup pool, and give these users access to all Skype for Business Server services and functionality. Note that users will not be rehomed on the backup pool; they will simply be allowed to log on and make use of that pool until their home pool has been restored. For example, if Pool A fails, users will be able to log on to Pool B (with complete functionality) until Pool A has been restored.
When the failed pool is once more up and running, administrators can then run the Invoke-CsPoolFailBack cmdlet in order to "fail back" users of that pool. If a user is currently logged on to the backup pool then he or she will be redirected back to their home pool after service has been restored.
Skype for Business Server Control Panel: The functions carried out by the Invoke-CsPoolFailback cmdlet are not available in the Skype for Business Server Control Panel.
Examples
Example 1
Invoke-CsPoolFailback -PoolFqdn "atl-cs-001.litwareinc.com"
In Example 1, failback is invoked for the pool atl-cs-001.litwareinc.com.
Parameters
-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 |
-DatabaseCommandTimeoutInSeconds
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
The amount of time, in seconds, to wait for database commands to time out.
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 |
-DisasterMode
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Enables administrators to invoke pool failback even if the backup pool is currently unavailable. When you use this parameter, data generated by the failed-over users on the backup pool will be lost.
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 arise 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 |
-PoolFqdn
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Fully qualified domain name of the pool being failed back. For example:
-PoolFqdn "atl-cs-001.litwareinc.com"
The pool FQDN used during failback must be the same FQDN used during failover.
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 |
-SkipDataVerification
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
When included in a command, Invoke-CsPoolFailover will proceed with the failover operation without first verifying data integrity.
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
Specifies the maximum amount of time the cmdlet should wait before synching data. Time values must be express using the format hours:minutes:seconds; for example, the following syntax sets the wait time to 1 minute and 30 seconds (00 hours:01:minutes:30 seconds):
00:01:30
The default value is 15 seconds.
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 Invoke-CsPoolFailBack cmdlet does not accept pipelined input.