vRanger 7.8 - User Guide

Add-HypervCluster

 

Description	Adds a Hyper-V® Cluster to the inventory.
Syntax	Add-HypervCluster [‑DNSorIP] <String> [‑Username] <String> [‑Password] <String> [[‑Port] <Int32>] [[‑IsInstallAgent] <Boolean>] [<CommonParameters>]
Parameters	• DNSorIP <String>: The DNS or IP for the Hyper-V cluster. • Username <String>: The user name to add the Hyper-V cluster. • Password <String>: The password to add the Hyper-V cluster. • Port [<Int32>]: The port to add the Hyper-V cluster. • IsInstallAgent [<Boolean>]: Install agent on cluster. • <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	Add-HypervCluster ‑DNSorIP 10.6.20.20 ‑Username user1 ‑Password p@ssw0rd This command adds a Hyper-V cluster to the inventory.
Related links	Add-BackupJobTemplate Get-InventoryEntity

Add-HypervHost

 

Description	Adds a Hyper-V® host to the inventory.
Syntax	Add-HypervHost [‑DNSorIP] <String> [‑Username] <String> [‑Password] <String> [[‑Port] <Int32>] [[‑IsInstallAgent] <Boolean>] [<CommonParameters>]
Parameters	• DNSorIP <String>: The DNS or IP for the Hyper-V host. • Username <String>: The user name to add the Hyper-V host. • Password <String>: The password to add the Hyper-V host. • Port [<Int32>]: The port to add the Hyper-V host. • IsInstallAgent [<Boolean>]: Install agent on host. • <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	Add-HypervHost ‑DNSorIP 10.6.20.20 ‑Username user1 ‑Password p@ssw0rd This command adds a Hyper-V host to the inventory.
Related links	Add-BackupJobTemplate Get-InventoryEntity

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-------------------- $repo = get-repository |where{$_.name ‑eq 'local'} $spList = get-repositorysavepoint $repo.id $mysp = ($spList)[1] Add-RestoreJobTemplate ‑Jobname vapirestore ‑Savepoint $mysp This command creates a restore job template that restores to the original VM in the savepoint. The job runs on demand. --------------------EXAMPLE 2-------------------- $repo = get-repository |where{$_.name ‑eq 'local'} $sp = get-repositorysavepoint $repo.id $mysp = ($sp)[0] $targethost = get-inventoryentities ‑type HypervHost | where{$_.name ‑eq 'dev 015.dev.eng.int'} $targetDiskLocation = 'c:\hyper-virtual hard disks $targetnw = get-network ‑host $targethost|where{$_.Name ‑eq 'Virtual Machine Network'} Add-RestoreJobTemplate ‑jobname vapirestore_totaraget ‑savepoint $mysp ‑targethost $targethost.name ‑DiskLocations $targetDiskLocation ‑VmLocation 'c:\hyper-v\configuration' ‑targetnetworks $targetnw.name 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-------------------- $repo = get-repository |where{$_.name ‑eq 'local'} $sp = get-repositorysavepoint $repo.id $mysp = ($sp)[0] $targethost = get-inventoryentities ‑type HypervHost | where{$_.name ‑eq 'dev015.dev.eng.int'} $targetDiskLocation = 'c:\hyper-virtual hard disks $targetnw = get-network ‑host $targethost|where{$_.Name ‑eq 'Virtual Machine Network'} $skipdisks = '0' Add-RestoreJobTemplate ‑jobname vapirestore_skipdisk ‑savepoint $mysp ‑targethost $targethost.name ‑DiskLocations $targetDiskLocation ‑VmLocation 'c:\hyper-v\configuration' ‑targetnetworks $targetnw.name ‑SkipDisks $skipdisk s 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

.

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-------------------- Add-NfsRepository ‑Server myserver.dev.corp ‑ExportDirectory /vol/vol1 ‑TargetDirectory /test ‑Name MyNFSRepo ‑Overwrite 1 This command adds a repository on server myserver.dev.corp. Existing repositories at the location specified are overwritten. --------------------EXAMPLE 2-------------------- Add-NfsRepository ‑Server myserver.dev.corp ‑ExportDirectory /vol/vol1 ‑TargetDirectory /test ‑Name MyNFSRepo ‑EnableEncryption 1 ‑EncryptionPassword myPassword ‑EnableCompress 1 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