Start-OBRegistration
Start-OBRegistration
Registers the current computer to .
Syntax
Parameter Set: Default
Start-OBRegistration [-RecoveryService] <CBServiceResource> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-OBRegistration cmdlet registers the server to . The cmdlet registers the server by uploading a backup certificate to the vault. You can use the Get-OBCertificateListFromLocalStore cmdlet to get the list of certificates from the local computer certificate store.
This cmdlet supports the WhatIf and the Confirm parameters. The cmdlet prompts 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. Specify –Confirm:$FALSE
to override the prompt.
Parameters
-RecoveryService<CBServiceResource>
Specifies a recovery agent.
Aliases |
none |
Required? |
true |
Position? |
2 |
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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: Registers a server
This example starts a computer registration.
The first command gets the list of certificates from the local computer certificate store, and stores the result in the $Cert variable.
PS C:\> $Cert = Get-OBCertificateListFromLocalStore
The second command gets the list of backup vaults that can you use to register the current computer for the fifth certificate stored in $Cert. The command stores the result in the $Item variable.
PS C:\> $Item = Get-OBRecoveryService –Certificate $Cert[4]
The third command registers the current computer by using the first certificate stored in $Item.
PS C:\> Start-OBRegistration -RecoveryService $Item[0]