.png)
Start-OBUnregistration
Updated: August 15, 2012
Applies To: Windows Server 2012
Start-OBUnregistration
Syntax
Parameter Set: Default Start-OBUnregistration [[-Server] <CBBackupServer> ] [-Credential] <PSCredential> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-OBUnregistration cmdlet unregisters the current computer with Windows Azure Online Backup. The recovery points for this server would be cleaned up and all the backed up data would be deleted. The valid credentials (username and password) are required to authenticate the operation.
This cmdlet supports WhatIf and Confirm parameters with a high impact. The high impact signifies that the cmdlet will prompt the user for confirmation by default. The WhatIf parameter gives a verbose description of what the cmdlet does without performing any operation. The Confirm parameter specifies whether the cmdlet should prompt the user. Using –Confirm:$FALSE will override the prompt.
To use Windows Azure Online Backup (OB) cmdlets, the user must be a member of the Administrators group or Backup Operators group.
Parameters
-Credential<PSCredential>
Specifies the username and password used for authentication to perform the operation.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
2 |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByValue) |
|
Accept Wildcard Characters? |
false |
-Server<CBBackupServer>
Specifies the server which needs be unregistered.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByValue) |
|
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
false |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
false |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example unregisters a computer.
PS C:\> $pwd = ConvertTo-SecureString -String Notag00dpa55word -AsPlainText –Force
PS C:\> New-Object -TypeName System.Management.Automation.PsCredential -ArgumentList contoso\johnj99, $pwd | Start-OBUnRegistration
Related topics
