Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This script helps you to register your on-premises Windows server or client machine with a Recovery Services vault.
Sample script
<#
.SYNOPSIS
Registers MARS agent
.DESCRIPTION
Registers MARS agent
.ROLE
Administrators
#>
param (
[Parameter(Mandatory = $true)]
[String]
$vaultcredPath,
[Parameter(Mandatory = $true)]
[String]
$passphrase
)
Set-StrictMode -Version 5.0
$env:PSModulePath = (Get-ItemProperty -Path 'HKLM:\System\CurrentControlSet\Control\Session Manager\Environment' -Name PSModulePath).PSModulePath
Import-Module MSOnlineBackup
$ErrorActionPreference = "Stop"
Try {
$date = Get-Date
Start-OBRegistration -VaultCredentials $vaultcredPath -Confirm:$false
$securePassphrase = ConvertTo-SecureString -String $passphrase -AsPlainText -Force
Set-OBMachineSetting -EncryptionPassphrase $securePassphrase -SecurityPIN " "
}
Catch {
if ($error[0].ErrorDetails) {
throw $error[0].ErrorDetails
}
throw $error[0]
}
Run the script
To run the PowerShell Script for registering an on-premises Windows server/ a client machine, follow these steps:
- Save the preceding script on your machine with a name of your choice and
.ps1
extension. - Run the script by providing the following parameters:
$vaultcredPath
- Complete Path of downloaded vault credential file$passphrase
- Plain text string converted into secure string using ConvertTo-SecureString cmdlet.
Note
You also need to provide the Security PIN generated from the Azure portal. To generate the PIN, go to the Recovery Services vault > Settings -> Properties -> Security PIN, and then select Generate.
Next steps
Learn more about how to use PowerShell to deploy and manage on-premises backups using MARS agent.