vRanger 7.8 - User Guide

Cmdlet help

To get help on any of the vAPI cmdlets, use the Get-Help command. At the prompt, enter Get-Help command, where command is any of the preceding vAPI cmdlets.

 

vAPI Cmdlet details

 

IMPORTANT: For the most up-to-date help contents, see the cmdlet help. To get help on any of the vAPI cmdlets, use the Get-Help command. At the prompt, enter: Get-Help <command> ‑full where <command> is any of the following vAPI cmdlets.

Add-BackupGroupEntity

 

Description	Adds a new backup group to vRanger. New-BackupGroupMember cmdlet is used to add members to a backup group created using this cmdlet or the UI.
Syntax	Add-BackupGroupEntity [‑BackupGroupName] <String> [<CommonParameters>]
Parameters	• BackupGroupName <String>: The BackupGroup Name. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters" • Type [-Type]: This optional parameter specifies the type of backup group: VMware, HyperV, or Physical. If not specified, the default is VMware.
Examples	Add-BackupGroupEntity ‑BackupGroupName BG1
Related links	Remove-BackupGroupEntity New-BackupGroupMember Remove-BackupGroupMember Get-BackupGroupEntity

Add-BackupJobTemplate

 

Description	Adds a backup job. You also have the option of running the job immediately after the template is created.
Syntax	Add-BackupJobTemplate [‑JobName] <String> [[‑JobDescription] <String>] [‑JobEntity] <Entity> [[‑ExcludedVMList] <String>] [[‑IncludedDiskList] <String>] [‑TargetRepository] <Repository> [[‑JobSchedule] <Schedule>] [‑Flags] <NoFlags | BackupPoweredOnOnly | CheckDestinationFreeSpace | UseCompression | UpdateNotes | EnableGuestQuiescing | EnableABM | UseFiber | PerformNetworkBackupOnFailure | UseCataloging | AllFlags> [‑NumberOfSavePoints] <Int> [‑SpaceSavingTechnologyTypeFlag] <None | Incremental | Differential> [[‑SpaceSavingCountThreshold] <Int>] [[‑SpaceSavingPercentSizeThreshold] <Int>] [[‑NotificationList] <String>] [[‑RunJobNow] <Boolean>] [[‑TransportConfiguration] <TransportConfiguration>] [[‑FullBackupDays] <List`1>][<CommonParameters>]
Parameters	• JobName <String>: Job name. • JobDescription [<String>]: Job description. • JobEntity <Entity>: Inventory entity on which the job is going to run on — VMware® ESXi™ host, VirtualCenter, and so on. • ExcludedVMList [<String>]: List of VM universally unique identifiers (UUIDs) to exclude from this job. • IncludedDiskList [<String>]: List of virtual disks to include in this job. • TargetRepository <Repository>: Repository where the backups are to be stored. • JobSchedule [<Schedule>]: Schedule on which the job runs. • Flags <BackupFlags>: Backup flags. • NumberOfSavePoints <Int>: Max number of savepoints to store before older ones are removed. • SpaceSavingTechnologyTypeFlag <SpaceSavingTechnologyType>: Spacesaving technology to use: differential, incremental or none. • SpaceSavingCountThreshold [<Int>]: The number to save before performing a full backup. • SpaceSavingPercentSizeThreshold [<Int>]: The size to allow as a % of the VM hard disk file before performing a differential backup. • NotificationList [<String>]: Email notification list for the job. • RunJobNow [<Boolean>]: Whether to run the job now. • TransportConfiguration [<TransportConfiguration>]: The transport configuration options to use for this job. • FullBackupDays [<List '1>]: The days to perform a full backup. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Add-BackupJobTemplate ‑JobName myjob ‑JobEntity $inv ‑TargetRepository $repo ‑JobSchedule $s ‑Flags NoFlags ‑NumberOfSavePoints 3 ‑SpaceSavingTechnologyTypeFlag None This command adds a backup job template. Because the RunJobNow flag is not specified, the job does not run immediately.
Related links	Add-RestoreJobTemplate Add-PhysicalMachine Update-BackupJobTemplate Get-Job Get-JobTemplate