New-VBRSureBackupVM
Short Description
Defines VMs to add to application groups.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRSureBackupVM -VM <CObjectInJob> [-Role <VBRSureBackupRole[]> {DNSServer | GlobalCatalog | MailServer | SQLServer | WebServer | DomainControllerAuthoritative | DomainControllerNonAuthoritative | VBO}] [-TestScript <VBRSureBackupTestScript[]>] [-StartupOptions <VBRSureBackupStartupOptions>] [-Credentials <CCredentials>][<CommonParameters>] |
Detailed Description
This cmdlet creates the VBRSureBackupVM object that defines VMs that you want to add to the application group.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
VM | Specifies VMs from a job. The cmdlet will add these VMs to the application group. | Accepts the CObjectInJob object. To get this object, run the Get-VBRJobObject cmdlet. | True | Named | True (ByValue, |
Role | Specifies a role of VMs that you want to add to the application group. The cmdlet will assign the specified role to VMs. You can specify either of the following roles:
| VBRSureBackupRole[] | False | Named | False |
TestScript | Specifies a script for VMs that you want to add to the application group. Veeam Backup & Replication will run this script to verify the role of VMs. | Accepts the VBRSureBackupTestScript[] object. To get this object, run the New-VBRSureBackupTestScript cmdlet. | False | Named | False |
StartupOptions | Specifies startup settings for VMs that you want to add to the application group. Veeam Backup & Replication will apply these startup options to VMs. | Accepts the VBRSureBackupStartupOptions object. To get this object, run the New-VBRSureBackupStartupOptions cmdlet. | False | Named | False |
Credentials | Specifies credentials to access VMs and run verification scripts. If you do not specify this parameter, the cmdlet will use the account under which Veeam Backup & Replication is currently running. | CCredentials | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VBRSureBackupVM object that defines VMs that you want to add to the application group.
Examples
Example 1. Defining VM and VM Roles to add to Application Group
This example shows how to define the Winsrv2047 VM to add to the application group. The cmdlet will assign the mail server role to the Winsrv2047 VM.
Perform the following steps:
|
Example 2. Defining Verification Script for VM
This example shows how to define the Winsrv2047 VM to add to the application group. The cmdlet will define the Winsrv2047 VM with the following settings:
Perform the following steps:
|
Example 3. Defining Startup settings of VMs
This example shows how to define the Winsrv2047 VM to add to the application group. The cmdlet will define the Winsrv2047 VM with the following settings:
Perform the following steps:
|
Related Commands