Chat now with support
Chat with Support

vRanger 7.7.1 - User Guide

Introduction Configuring vRanger
Configuring vRanger through the Startup Wizard Configuring vRanger manually Supplemental instructions: additional repository types
Using vRanger Backup Restore
Restoring a physical server Performing a full restore for VMware VMs Performing a full restore for Hyper-V® VMs Performing a full restore for VMware vApps Performing a full restore of a physical machine Performing an FLR on Windows Performing an FLR on Linux Restoring from manifest
Replicate VMs Reports Integrating and monitoring vRanger Using the vRanger Console vAPI Cmdlet details
Add-BackupJobTemplate Add-CIFSRepository Add-DdbReplicationRepository Add-DdbRepository Add-EsxHost Add-HypervCluster Add-HypervHost Add-HypervRestoreJobTemplate Add-NFSRepository Add-NVSDRepository Add-PhysicalMachine Add-RdaRepository Add-ReplicationJobTemplate Add-RestoreFromManifestJobTemplate Add-RestoreJobTemplate Add-VirtualAppforLinuxFLR Add-VirtualAppforLinuxFLRVA Add-VirtualCenter Disable-Job Dismount-LinuxVolume Enable-Job Get-AddressBook Get-BackupGroupEntity Get-CatalogSearchData Get-CatalogStatus Get-ConfigOption Get-Connection Get-CurrentTemplateVersionID Get-Datastore Get-GlobalTransportFailover Get-InventoryEntities Get-IsInventoryRefreshing Get-Job Get-JobTemplate Get-MonitorLog Get-Network Get-PhysicalMachineDiskMap Get-Repository Get-RepositoryJob Get-RepositorySavePoint Get-RestoreDiskMap Get-SavepointDisk Get-SavepointManifest Get-Savepoints Get-TransportFailover Get-VirtualApplianceConfig Get-VirtualApplianceDeploymentStatus Get-VirtualApplianceReconfigStatus Get-VirtualMachinesUnderInventory Get-VmDisk Get-VMDKVolume Install-VirtualAppliance Mount-LinuxVolume New-BackupFlag New-BackupGroupMember New-Daily Schedule New-EmailAddress New-IntervalSchedule New-MonthlySchedule New-ReplicationFlag New-RestoreFlag New-SMTPServer New-TransportConfiguration New-VirtualAppliance New-WeeklySchedule New-YearlySchedule Remove-AllMount Remove-BackupGroupEntity Remove-BackupGroupMember Remove-Catalog Remove-DdbStorageUnit Remove-JobTemplate Remove-LinuxVolume Remove-Repository Remove-SavePoint Remove-VirtualAppliance Remove-VirtualApplianceConfiguration Run-JobsNow Run-ReplicationFailover Run-ResumeReplicationFailover Run-TestReplicationFailover Set-Cataloging Set-CBTonVM Set-LinuxVolume Set-MountPath Set-Resources Stop-vRangerJob Update-BackupJobTemplate Update-GlobalTransportFailover Update-HypervRestoreJobTemplate Update-Inventory Update-ReplicationJobTemplate Update-RestoreJobTemplate Update-VirtualAppliance Update-VirtualApplianceConfiguration
About us

Update-BackupJobTemplate

Previous Next


vAPI Cmdlet details > Update-BackupJobTemplate

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

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

Previous Next


vAPI Cmdlet details > Update-GlobalTransportFailover

Update-GlobalTransportFailover

Description

Updates the default Transport Failover order for replication jobs.

Syntax

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

This command updates the default Transport Failover order for replication jobs.

Related links

Get-GlobalTransportFailover

Get-TransportFailover

Update-HypervRestoreJobTemplate

Previous Next


vAPI Cmdlet details > Update-HypervRestoreJobTemplate

Update-HypervRestoreJobTemplate

Description

Updates a restore job template. You also have the option of running the job immediately after the template is updated.

Syntax

Update-HypervRestoreJobTemplate [‑JobTemplate] <RestoreJobTemplate> [‑JobName] <String> [[‑JobDescription] <String>] [‑SavePoint] <Savepoint> [[‑JobSchedule] <Schedule>] [[‑Flags] <NoFlags | ForceOverwrite | ForcePowerOn | UseFiber | PerformNetworkRestoreOnFailure | AddHypervVirtualMachineToCluster | AllFlags>] [[‑NotificationList] <List`1>] [[‑RunJobNow] <Boolean>] [[‑VMName] <String>] [[‑TargetHost] <String>] [[‑VmLocation] <String>] [[‑SkipDisks] <List`1>] [[‑DiskLocations] <List`1>] [[‑TargetNetworks] <List`1>] [[‑SkipAdapters] <List`1>] [<CommonParameters>]

Parameters

JobTemplate <RestoreJobTemplate>: Restore job template to update.
JobName <String>: Job name.
JobDescription [<String>]: Job description.
SavePoint <Savepoint>: Savepoint to restore.
JobSchedule [<Schedule>]: Schedule on which the job runs. If not set, the job runs on demand.
Flags [<Nullable`1>]: Restore flags. If not set, the job has no flags.
NotificationList [<List`1>]: Separate multiple email addresses with commas.
RunJobNow [<Nullable`1>]: Whether to run the job now. If not set, the job does not run immediately after creation of the template.
VMName [<String>]: Name of the restored VM. If not set, the VM name in the savepoint is used.
TargetHost [<String>]: Fully qualified domain name or IP address of the target host.
VmLocation [<String>]: Location on target host where the restored VM is located. If not set, the default for the host is used.
SkipDisks [<List`1>]: Sequence number — base 0 — of the disks to skip from the savepoint. Separate multiple numbers with commas.
DiskLocations [<List`1>]: Disk locations to use on the target host. Separate multiple values with commas. If only one is supplied, it is used for all disks on the VM If not set, the default disk location for the host is used for all disks.
TargetNetworks [<List`1>]: Networks to use on the target host. Separate multiple values with commas. If only one network name is provided, it is used for all adapters on the VM. If not set, the original networks are used when restoring to the original VM.
SkipAdapters [<List`1>]: Sequence number — base 0 — of the adapters to skip in the restore job. Separate multiple numbers with commas.
<CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, ‑WarningAction, ‑WarningVariable, ‑OutBuffer, and ‑OutVariable. For more information, type: "get-help about_commonparameters"

Examples

--------------------EXAMPLE 1--------------------

This command creates a restore job template that restores to the original VM in the savepoint. The job runs on-demand.

--------------------EXAMPLE 2--------------------

This command creates a restore job template that restores to the specified target host. It also specifies disk location, vm location, and the network to use on the target host.

Examples (continued)

--------------------EXAMPLE 3--------------------

This command creates a restore job template that restores to the specified target host. The first disk (0) in the savepoint is skipped by the restore job.

--------------------EXAMPLE 4--------------------

This command creates a restore job template that restores to the specified target host. The first adapter of the VM in the savepoint is skipped by the restore job.

Related links

Add-BackupJobTemplate

Add-RdaRepository

Update-RestoreJobTemplate

Get-Job

Get-JobTemplate

Update-Inventory

Previous Next


vAPI Cmdlet details > Update-Inventory

Update-Inventory

Description

Refreshes the inventory.

Syntax

Update-Inventory [<CommonParameters>]

Parameters

<CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"

Examples

This command refreshes the inventory.

Related links

None

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating