Options reference
The following sections contain detailed information about each of the client options that are used for IBM Spectrum Protect™ for Virtual Environments: Data Protection for Microsoft Hyper-V operations.
Information for each option includes the following information:
- a description
- a syntax diagram
- detailed descriptions of the parameters
- examples of using the option in the client options file (if applicable)
- examples of using the option on the command line (if applicable)
Options with a command-line example of Does not apply cannot be used with command line or scheduled commands.
- Dateformat
The dateformat option specifies the format you want to use to display or enter dates. - Detail
Use the detail option to display management class, file space, and backup information. - Domain.vmfull
The domain.vmfull option specifies the virtual machines (VMs) to include in your full virtual machine image backup operations. - Exclude.vmdisk
The EXCLUDE.VMDISK option excludes a virtual machine disk from backup operations. - Filelist
Use the filelist option to process a list of files. - Inactive
Use the inactive option to display both active and inactive objects. - Include.vm
This option overrides the management class that is specified on the vmmc option. - Include.vmdisk
The INCLUDE.VMDISK option includes a virtual machine (VM) disk in backup operations. If you do not specify one or more disk labels, all disks in the VM are backed up. - INCLUDE.VMSNAPSHOTATTEMPTS
Use the INCLUDE.VMSNAPSHOTATTEMPTS option to determine the total number of snapshot attempts to try for a virtual machine (VM) backup operation that fails due to snapshot failure. - Mode
Use the mode option to specify the backup mode to use when performing specific backup operations. - Mbobjrefreshthresh
The mbobjrefreshthresh (megablock object refresh threshold) option is a number defining a threshold. When the number of IBM Spectrum Protect objects that are needed to describe any 128 MB megablock exceeds this value, the entire megablock is refreshed and the objects that were used to represent this area, in previous backups, are expired. - Mbpctrefreshthresh
The mbpctrefreshthresh (megablock percentage refresh threshold) option is a number defining a threshold. When the number of IBM Spectrum Protect percentage of objects that are needed to describe any 128 MB megablock exceeds this value, the entire megablock is refreshed and the objects that were used to represent this area, in previous backups, are expired. - Noprompt
The noprompt option suppresses the confirmation prompt that is presented by the expire command. - Numberformat
The numberformat option specifies the format you want to use to display numbers. - Pick
The pick option creates a list of backup versions or archive copies that match the file specification you enter. - Pitdate
Use the pitdate option with the pittime option to establish a point in time to display or restore the latest version of your backups. - Pittime
Use the pittime option with the pitdate option to establish a point in time to display or restore the latest version of your backups. - Skipsystemexclude
Use the skipsystemexclude option to specify how to process exclude statements for certain operating system files that the IBM Spectrum Protect for Virtual Environments client skips by default. - Timeformat
The timeformat option specifies the format in which you want to display and enter system time. - Vmbackdir
The vmbackdir option specifies the temporary disk location where the client saves control files that are created during full VM backup and restore operations of Microsoft Hyper-V virtual machines. - Vmctlmc
This option specifies the management class to use when backing up virtual machine control files. - Vmmaxparallel
This option is used to configure parallel backups of several virtual machines, using a single instance of the backup-archive client. The vmmaxparallel option specifies the maximum number of virtual machines that can be backed up to the server, at any one time. - Vmmaxpersnapshot
Use the vmmaxpersnapshot option to specify the maximum number of virtual machines (VMs) to include in a Hyper-V snapshot. The VMs in the snapshot are backed up to the IBM Spectrum Protect server. - Vmmaxsnapshotretry
Use the vmmaxsnapshotretry option to specify the maximum number of times to retry a snapshot operation of a virtual machine (VM) if the initial snapshot fails with a recoverable condition. - Vmmc
Use the vmmc option to store virtual machine backups by using a management class other than the default management class. - Vmprocessvmwithphysdisks
Use the vmprocessvmwithphysdisks option to control whether Hyper-V RCT virtual machine (VM) backups are processed if the VM has one or more physical disks (pass-through disks) provisioned. - Vmskipphysdisks
Use the vmskipphysdisks option to restore configuration information for physical disks (pass-through disks) that are associated with a Hyper-V virtual machine (VM), if the logical unit numbers (LUNs) that are associated with the volumes on the physical disks are available.