Edit-ScheduledArchive
The Edit-ScheduledArchive command lets you use PowerShell to make changes to an existing scheduled archive.
Usage
The usage for the command is as follows:
Edit-ScheduledArchive -core [host name] -user [login] -password [password] -all | -protectedserver [name | IP address | "[name1 | IP address1]" "[name2 | IP address2]"] -path [location] -cloudaccountname [name] -cloudcontainer [name] -recycleaction [type] -scheduletype [type] -dayofweek [name] -dayofmonth [number] -time [time] -initialpause -id [id]
Command Options
The following table describes the options available for the Edit-ScheduledArchive command:
Table 91: Edit-ScheduledArchive 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. |
-protectedserver |
The protected machine with recovery points that you want to archive. You can specify multiple machine names enclosed in double quotes and separated by commas. |
-all |
Archive recovery points for all protected machines. |
-path |
The path to where to save the archived data. For example:
- Local machine: "d:\work\archive"
- Network path: "\\servername\sharename"
- Folder in a cloud account: "Folder Name"
Note: The number of symbols should not be greater than 100 for local and network locations, and should not be greater than 150 for a cloud location. |
-cloudaccountname |
Optional. Use only for cloud archiving. The name of the cloud account where you want to save the archive. |
-cloudcontainer |
Optional. Use only for cloud archiving. The name of the cloud container in the chosen cloud account, where the archive will be saved. When you use this option, you should also specify the "-cloudaccountname" parameter. |
-recycleaction |
The type of recycle action. Specified by using one of the following four values:
- "replacethiscore" - Overwrites any pre-existing archived data pertaining to this Core, but leaves the data for other Cores intact.
- "erasecompletely" - Clears all archived data from the directory before writing the new archive.
- "incremental" - Lets you add recovery points to an existing archive. It compares recovery points to avoid duplicating data that already exists in the archive.
|
-scheduletype |
Type of schedule interval. Specified the option with one of the following four values:
- "daily" - For a daily automatically created archive.
- "weekly" - For a weekly automatically created archive. You must specify the "-dayofweek" parameter.
- "monthly" - For a monthly automatically created archive. You must specify the "-dayofmonth" parameter. If a month does not have the day specified—for example, "31"—then the archive will not occur for that month.
- "lastdayofmonth" - For automatically creating an archive on the last day of each month.
|
-dayofweek |
Use only for the "weekly" option of the "-scheduletype" parameter. The day of the week on which to automatically create the archive (for example, "Monday"). |
-dayofmonth |
Use only for the "month" option of the "-scheduletype" parameter. The day (number) of the month on which to automatically create the archive (for example, "15"). |
-time |
The hour of the day when you want to create an archive. |
-initialpause |
Optional. Specify this option if you want to initially pause archiving after you configure the archiving schedule. |
-id |
The identifier of the scheduled archive that you want to edit. |
Example:
Edit a scheduled archive on the local Core:
>Edit-ScheduledArchive -protectedserver protectedserver1 -path d:\work\archive -cloudaccountname cloud1 -cloudcontainer cloudarchives -recycleaction incremental -scheduletype daily -time 12:00 AM -initialpause -i
d archiveid
Edit-VBVirtualStandby
The Edit-VBVirtualStandby command lets you use PowerShell to make changes to an existing virtual export to a VirtualBox virtual machine (VM).
Usage
The usage for the command is as follows:
Edit-VBVirtualStandby [-TargetPath <String>] [-PathUserName <String>] [-PathPassword <String>] [-LinuxHostName <String>] [-HostPort <UInt32>] [-AccountUserName <String>] [-AccountPassword <String>] [-ProtectedServer <String>] [-Volumes <String[]>] [-VMName <String>] [-UseSourceRam] [-Ram <String>] [-User <String>] [-Core <String>] [-Password <String>] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-ErrorVariable <String>] [-WarningVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>]
Command Options
The following table describes the options available for the Edit-VBVirtualStandby command:
Table 92: Edit-VBVirtualStandby 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. |
-protectedserver |
Show jobs for a specific protected machine, indicated by IP address. |
-all |
Show all jobs, including those performed by the Core and all protected servers. |
-number |
Optional. Determine how many records to display. available values are:
all (display all jobs); l[number] or [number] (fetches ## most recent jobs sorted by execution and time); f[number] (displays first ## recovery jobs sorted by execution and time). By default, the 20 most recent jobs are shown. |
-jobtype |
Optional. Specifies the job type filter. Available values are: 'transfer' (data transfer), 'repository' (repository maintenance), 'replication' (local and remote replications), 'backup' (backup and restore), 'bootcdbuilder' (create boot CDs), 'diagnostics' (upload logs), 'exchange' (Exchange Server files check), 'export' (recovery point export), 'pushinstall' (deploy agents), 'rollback' (restoring from a recovery point), 'rollup' (recovery point rollups), 'sqlattach' (agent attachability checks), and 'mount' (mount repository). By default, all jobs of the specified type are returned. |
-time |
Optional. Filter output by date and time for the job started. Available types of input include:
#d or DD (where # is a number for the period of time of days before now until now)
#h or #H (where # is number for the period of hours before now until now)
“time date 1”, “time date 2” (to show a custom range of time from a specific date appearing before the comma to a specific date following the comma). |
Example:
Lists all active jobs on the local Core:
>Get-activejobs –all
Edit-VMVirtualStandby
The Edit-VMVirtualStandby command lets you use PowerShell to make changes to an existing virtual export to a VMware Workstation virtual machine (VM).
Usage
The usage for the command is as follows:
Edit-VMVirtualStandby [-TargetPath <String>] [-PathUserName <String>] [-PathPassword <String>] [-ProtectedServer <S
tring>] [-Volumes <String[]>] [-VMName <String>] [-UseSourceRam] [-Ram <String>] [-User <String>] [-Core <String>]
[-Password <String>] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-Er
rorVariable <String>] [-WarningVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>]
Command Options
The following table describes the options available for the Edit-VMVirtualStandby command:
Table 93: Edit-VMVirtualStandby 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. |
-targetpath |
The local or network path (or Linux path, only for VirtualBox export) to the folder for storing the virtual machine files. |
-pathusername |
The credentials for the target path when it is located on a network share and you specified it with the -targetpath option. |
-pathpassword |
The password for the target path when it is located on a network share and you specified it with the -targetpath option. |
-protectedserver |
The protected machine with recovery points that you want to export, indicated by IP address. |
-volumes |
Optional. A list of volume names that you want to export. When not specified, all volumes export. Values must be separated by a comma. Do not use trailing slashes in volume names. For example: C, F, E. |
-vmname |
The Windows name of the virtual machine. |
-ram |
Use this option to allocate a specific amount of RAM on the virtual server. |
-usesourceram |
Optional. Allocate all of the amount of RAM on the target virtual server that is used on the source virtual server. |
Example:
Edit a specific amount of RAM on the existing Virtual Standby:
>Edit-VMVirtualStandby -targetpath "\\servername\sharename" -pathusername "login" -pathpassword "password" -protectedserver 10.10.11.245 -vmname "name" -ram 2048
Edit the list of volume names to be exported to the existing Virtual Standby:
>Edit-VMVirtualStandby -targetpath "\\servername\sharename" -pathusername "login" -pathpassword "password" -protectedserver 10.10.11.245 -vmname "name" -volumes C,F
Enable-HyperVAutoProtection
The Enable-HyperVAutoProtection cmdlet lets you enable the auto-protection of new virtual machines (VMs) on a Hyper-V host.
Usage
The usage for the command is as follows:
Enable-HyperVAutoProtection -core [host name] -user [user name] -password [password] -repository [name] -protectedserver [name | IP address]
Command Options
The following table describes the options available for the Enable-HyperVAutoProtection command:
Table 94: Enable-HyperVAutoProtection 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 protect virtual machines. |
Example:
Enable auto-protection of new VMs on a Hyper-V host:
>Enable-HyperVAutoProtection -protectedserver 10.10.1.1 -repository "Repository 1"
