Rapid Recovery PowerShell module cmdlets
This section describes the cmdlets and options available in the Rapid Recovery PowerShell Module. All cmdlets in the Rapid Recovery PowerShell Module support the following common parameters:
- Verbose
- Debug
- ErrorAction
- ErrorVariable
- WarningAction
- WarningVariable
- OutBuffer
- OutVariable
For more information, use Get-Help about_commonparameters
.
Add-EsxAutoProtectObjects
The Add-EsxAutoProtectObjects
cmdlet enables auto protection for specified objects on a vCenter or ESXi server.
Usage
The usage for the command is as follows:
Add-EsxAutoProtectObjects -core [host name] -user [user name] -password [password] -repository [name] -protectedserver [name | IP address] -autoprotect [object name collection]
Command Options
The following table describes the options available for the Add-EsxAutoProtectObjects
command:
Table 80: Add-EsxAutoProtectObjects command options
-? |
Display this help message. |
-core |
Optional. Remote Core host machine IP address (with an optional port number). By default the connection is made to the Core installed on the local machine. |
-user |
Optional. User name for the remote Core host machine. If you specify a user name, you also have to provide a password.
If none are provided, then the logged-on user's credentials will be used. |
-password |
Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a log on.
If none are provided, then the logged-on user's credentials will be used. |
-repository |
Required. The name of the repository that is associated with the Core that you want to use to protect the virtual machine.
Note: You must enclose the name in double quotes. |
-protectedserver |
Show jobs for a specific protected machine, indicated by IP address. |
-autoprotect |
Optional. This option lets you list the new virtual machines that you want to automatically protect. |
Example:
Put specific objects from a vCenter or ESXi server under auto-protection by the Core:
>Add-EsxAutoProtectObjects -protectedserver 10.10.8.150 -add -autoprotect "Folder1", "Folder2"
Add-EsxVirtualMachines
The Add-EsxVirtualMachines
cmdlet lets you add specific virtual machines (VMs) on vCenter or ESXi server under the protection of a Core.
Usage
The usage for the command is as follows:
Add-EsxVirtualMachines -core [host name] -user [user name] -password [password] -repository [name] -protectedserver [name | IP address] -virtualmachines [virtual machines collection | all]
Command Options
The following table describes the options available for the Add-EsxVirtualMachines
command:
Table 81: Add-EsxVirtualMachines command options
-? |
Display this help message. |
-core |
Optional. Remote Core host machine IP address (with an optional port number). By default the connection is made to the Core installed on the local machine. |
-user |
Optional. User name for the remote Core host machine. If you specify a user name, you also have to provide a password.
If none are provided, then the logged-on user's credentials will be used. |
-password |
Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a log on.
If none are provided, then the logged-on user's credentials will be used. |
-repository |
Required. The name of the repository that is associated with the Core that you want to use to store the data of the virtual machine.
NOTE: You must enclose the name in double quotes.
|
-protectedserver |
Use this option to edit the vCenter or ESXi objects for a specific protected machine. |
-virtualmachines |
A list of virtual machines each separate by a comma. |
Example:
Add two VMs from a vCenter or ESXi server under protection by the Core:
>Add-EsxVirtualMachines -repository "repository1" -protectedserver 10.10.10.10 -virtualmachines "vm1", "vm2"
Add-HyperVClusterSharedVirtualDisks
The Add-HyperVClusterSharedVirtualDisks
cmdlet lets you add shared Hyper-V virtual disks under the protection of a Core.
Usage
The usage for the command is as follows:
Add-HyperVClusterSharedVirtualDisks -core [host name] -user [user name] -password [password] -repository [name] -shareddisks [shared virtual disks name or path collection | all]
Command Options
The following table describes the options available for the Add-HyperVClusterSharedVirtualDisks
command:
Table 82: Add-HyperVClusterSharedVirtualDisks command options
-? |
Display this help message. |
-core |
Optional. Remote Core host machine IP address (with an optional port number). By default the connection is made to the Core installed on the local machine. |
-user |
Optional. User name for the remote Core host machine. If you specify a user name, you also have to provide a password.
If none are provided, then the logged-on user's credentials will be used. |
-password |
Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a log on.
If none are provided, then the logged-on user's credentials will be used. |
-repository |
Required. The name of the repository that is associated with the Core that you want to use to store the data of the virtual machine.
Note: You must enclose the name in double quotes. |
-protectedserver |
Use this option to edit the shared virtual disks for a specific protected machine. |
-shareddisks |
A list of shared disks each separate by a comma. |
Example:
Protect all of the shared virtual disks on a cluster:
>Add-HyperVClusterSharedVirtualDisks -protectedserver "HV-2012R2" -repository "Repository_10.10.55.133" -shareddisks "all"