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

Add-HypervRestoreJobTemplate

Previous Next


vAPI Cmdlet details > Add-HypervRestoreJobTemplate

Add-HypervRestoreJobTemplate

Description

Adds a Hyper-V® restore job template. Users also have the option of running the job immediately after the template is created.

Syntax

Add-HypervRestoreJobTemplate [‑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

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 [<RestoreFlags>]: Restore flags. If not set, the job has no flags.
NotificationList [<List`1>]: Separate multiple email addresses with commas.
RunJobNow [<Boolean>]: 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.

--------------------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.

Related links

Add-BackupJobTemplate

Add-RdaRepository

Update-RestoreJobTemplate

Get-Job

Get-JobTemplate

Add-NFSRepository

Previous Next


vAPI Cmdlet details > Add-NFSRepository

Add-NFSRepository

Description

Adds a Network File Share repository to vRanger. The repository can be later used to store backup files from backup jobs.

Syntax

Add-NfsRepository [‑Server] <String> [‑ExportDirectory] <String> [‑TargetDirectory] <String> [‑Name] <String> [[‑Description] <String>] [[‑Overwrite][<Boolean>]] [[‑EnableEncryption] [<Boolean>]] [[‑EncryptionPassword] <String>] [[‑BlockSize] <Int>] [[‑EnableCompress] [<Boolean>]] [[‑ImportOption] [<String>]] [<CommonParameters>]

Parameters

Server <String>: The NFS Server FQDN or IP.
ExportDirectory <String>: The NFS Export Directory.
TargetDirectory <String>: The NFS Target Directory.
Name <String>: A friendly name describing this NFS server.
Description <String>: The Description describing the NFS server.
Overwrite [<Boolean>]: Whether to overwrite the existing repository if one exists.
EnableEncryption [<Boolean>]: Whether to enable encryption on backups on this repository.
EncryptionPassword <String>: The encryption Password.
ImportOption [<String>]: Whether to import the save points as read-write or read only. Possible options ReadOnly and ReadWrite.
<CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"

Examples

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

This command adds a repository on server myserver.dev.corp. Existing repositories at the location specified are overwritten.

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

This command adds a repository on server myserver.dev.corp. Enables encryption on backups of this repository. All backups to this repository are compressed.

Related links

Get-PhysicalMachineDiskMap

Add-DdbRepository

Add-NVSDRepository

Add-CIFSRepository

 

Add-NVSDRepository

Previous Next


vAPI Cmdlet details > Add-NVSDRepository

Add-NVSDRepository

Description

Adds a Quest NetVault SmartDisk repository to vRanger. The repository can be later used to store backup files from backup jobs.

Syntax

Add-NvsdRepository [‑Server] <String> [‑TargetDirectory] <String> [‑User] <String> [‑Password] <String> [‑Name] <String> [[‑Description] <String>] [[‑Overwrite] <Boolean>] [[‑ImportOption] <String>] [<CommonParameters>]

Parameters

Server <String>: The NetVault SmartDisk server FQDN or IP.
TargetDirectory [<String>]: The NetVault SmartDisk Target Directory.
User <String>: The NetVault SmartDisk user name.
Password <String>: The NetVault SmartDisk Password.
Name <String>: A friendly name describing this NetVault SmartDisk server.
Description <String>: The Description describing the NetVault SmartDisk server.
Overwrite [<Boolean>]: Whether to overwrite the existing repository if one exists.
ImportOption [<String>]: Whether to import the save points as read-write or read only. Possible options ReadOnly and ReadWrite.
<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 repository on server myserver pointing to a target directory named targetDirectoryName using the credentials provided. Existing repositories at the location specified are overwritten.

Related links

Get-PhysicalMachineDiskMap

Add-DdbRepository

Add-HypervCluster

Add-CIFSRepository

 

Add-PhysicalMachine

Previous Next


vAPI Cmdlet details > Add-PhysicalMachine

Add-PhysicalMachine

Description

Adds a physical machine to the inventory.

Syntax

Add-PhysicalMachine [‑DNSorIP] <String> [‑Username] <String> [‑Password] <String> [[‑Port] <Int>] [‑IsInstallAgent] <Boolean>] [[‑AgentLocation] <String>] [<CommonParameters>]

Parameters

DNSorIP <String>: The DNS or IP for the physical machine.
Username <String>: The user name to add the physical machine.
Password <String>: The password to add the physical machine.
Port [<Int>]: The port to add the physical machine.
IsInstallAgent [<Boolean>]: Install Agent on machine.
AgentLocation [<String>]: Agent installation location.
<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 replication job template.

Related links

Add-BackupGroupEntity

Get-InventoryEntities

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating