vRanger 7.8 - User Guide

Set-Resources

 

Description	Sets values for vRanger resources.
Syntax	Set-Resources [[‑NumberTasksVRanger] <Int>] [[‑NumberTasksLUN] <Int>] [[‑NumberTasksHost] <Int>] [[‑NumberTasksRepository] <Int>] [[‑NumberTasksLocal] <Int>] [[‑Timeout] <Int>] [[‑MinimumSpaceHost] <Int>] [[‑NumberTasksVA] <Int>] [<CommonParameters>]
Parameters	• NumberTasksVRanger [<Int>]: Maximum number of tasks running on vRanger (>=1). • NumberTasksLUN [<Int>]: Maximum number of tasks running off a LUN — 1 to 5. • NumberTasksHost [<Int>]: Maximum number of tasks running on a host — 1 to 4. • NumberTasksRepository [<Int>]: Maximum number of tasks running per Repository — >=1. • NumberTasksLocal [<Int>]: Maximum number of tasks running locally — 1 to 20. • Timeout [<Int>]: Task Timeout in hours — 1 to 999. • MinimumSpaceHost [<Int>]: Minimum space needed on host (GBs). • NumberTasksVA [<Int>]: Maximum number of tasks running on a VA — 1 to 8. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Set-Resources ‑NumberTasksVRanger 10 ‑Timeout 2 Sets the maximum tasks run on vRanger and the Timeout for each task.
Related links	Get-ConfigOption

Stop-vRangerJob

 

Description	Cancels a running job.
Syntax	Stop-vRangerJob [‑JobID] <String> [<CommonParameters>]
Parameters	• JobID <String>: Job ID for which to cancel job. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Stop-vRangerJob ‑JobId 'F9C9E458-8E06-498D-8C2C-03CBE5515FD4' This command cancels the job if it is running and returns the success or failure message. --------------------EXAMPLE 2-------------------- $jobs = Get-Job | where {$_.JobState ‑eq 'Running'} Stop-vRangerJob $jobs[0].Id This command cancels the first running job in the list and returns the success or failure message.
Related links	Remove-VirtualApplianceConfiguration Get-Job

Update-BackupJobTemplate

 

Description	Updates a backup job template. You also have the option of running the job immediately after the template is updated.
Syntax	Update-BackupJobTemplate [‑JobTemplate] <BackupJobTemplate> [[‑JobName] <String>] [[‑JobDescription] <String>] [[‑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>] [<CommonParameters>]
Parameters	• JobTemplate <BackupJobTemplate>: Existing job template. • JobName [<String>]: Job name. • JobDescription [<String>]: Job description. • ExcludedVMList [<String>]: List of VMs 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 [<Nullable`1>]: Backup flags. • NumberOfSavePoints [<String>]: Max number of savepoints to store before older ones are removed. • SpaceSavingTechnologyTypeFlag [<String>]: Space saving technology to use: differential, incremental, or none. • SpaceSavingCountThreshold [<String>]: The number to save before performing a full backup. • SpaceSavingPercentSizeThreshold [<String>]: 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. • FullBackupSchedule [<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	get-jobtemplate backup |where{$_.jobname ‑eq 'my first backup job'}| Update-BackupJobTemplate ‑JobName 'modified by vapi' This command adds a backup job template. Because the RunJobNow flag is not specified, the job is not going to run immediately.
Related links	Add-BackupJobTemplate Get-Job Get-JobTemplate

Update-GlobalTransportFailover

 

Description	Updates the default Transport Failover order for replication jobs.
Syntax	Update-GlobalTransportFailover [‑TransportFailover] <String> [<CommonParameters>]
Parameters	• TransportFailover <String>: Transport Failover order separated by commas to be attempted until the task is successful. Valid types are VA-HotAdd and VA-Network. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Update-GlobalTransportFailover ‑TransportFailover VA‑Network This command updates the default Transport Failover order for replication jobs.
Related links	Get-GlobalTransportFailover Get-TransportFailover