vRanger 7.7.1 - User Guide

Add-RdaRepository

Add-RdaRepository

 

Description	Adds an RDA repository to vRanger. The repository can be later used to store backup files from backup jobs.
Syntax	Add-RdaRepository [‑Server] <String> [‑StorageUnit] <String> [‑User] <String> [‑Password] <String> [‑Name] <String> [[‑Description] <String>] [[‑Overwrite] <Boolean>] [[‑ImportOption] <String>] [<CommonParameters>]
Parameters	• Server <String>: The DR Series server FQDN or IP. • StorageUnit [<String>]: The RDA logical storage unit. • User <String>: The user name to access the DR Series server. • Password <String>: The Password to access the DR Series server. • Name <String>: A friendly name describing this DR Series 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	Add-RdaRepository ‑Server myserver ‑StorageUnit mystorage ‑User myname ‑Password mypassword ‑Name reponame ‑targetDirectory /targetDirectoryName ‑Overwrite 1 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-Repository Add-DdbRepository Add-CIFSRepository Add-NVSDRepository

Add-ReplicationJobTemplate

Add-ReplicationJobTemplate

 

Description	Adds a replication job template. You also have the option of running the job immediately after the template is created.
Syntax	Add-ReplicationJobTemplate [‑JobName] <String> [[‑JobDescription] <String>] [‑JobEntity] <VMEntity> [‑TargetHost] <HostEntity> [‑ReplicateName] <String> [‑Type] <String> [[‑TargetNetworks] <String>] [[‑PrimaryDatastore] <String>] [[‑TargetDatastores] <String>] [[‑JobSchedule] <Schedule>] [[‑TransportFailover] <String>] [[‑NotificationList] <String>] [‑Flags] <NoFlags | ReplicatePoweredOnOnly | CheckDestinationFreeSpace | UseCompression | UpdateNotes | EnableGuestQuiescing | EnableABM | AllFlags> [[‑RunJobNow] <Boolean>] [[‑IncludedDisk] <String>] [<CommonParameters>]
Parameters	• JobName <String>: Job name. • JobDescription [<String>]: Job description. • JobEntity <VMEntity>: VM entity on which the job runs. • TargetHost <HostEntity>: Target Host entity to which the VM is replicated. • ReplicateName [<String>]: Name of replicated VM. • Type <String>: Replication type. Valid types are Differential and Hybrid. • TargetNetworks [<String>]: Networks to use on the target host. Separate multiple values with commas. • PrimaryDatastore <String>: Primary Datastore on target host where the replicated VM is to be located. • TargetDatastores [<String>]: Datastores to use on the target host. Separate multiple values with commas. • JobSchedule <Schedule>: The recurrence schedule on which the job runs. • TransportFailover [<String>]: Transport Failover order separated by commas to be attempted until the task is successful. Valid types are VA-HotAdd and VA-Network. • NotificationList [<String>]: Email notification list for the job. Separate multiple email addresses with commas. • Flags <ReplicationFlags>: Replication flags: NoFlags, ReplicatePoweredOnOnly, CheckDestinationFreeSpace, UseCompression, UpdateNotes, EnableGuestQuiescing, AllFlags. Separate multiple flags with pipes (|). • RunJobNow [<Boolean>]: Whether to run the job immediately after the job template is created. • IncludedDisk [<String>]: List of disks to include in this job. All VM disks are replicated if none is specified. • <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-ReplicationJobTemplate ‑JobName vRepJob1 ‑JobEntity $vm ‑TargetHost $targethost ‑ReplicateName TestRep ‑Type Differential ‑Flags $flags ‑targetDatastores MyDatastore1, MyDatastore2 ‑PrimaryDatastore MyDatastore ‑targetnetworks VMNetwork ‑TransportFailover VA-HotAdd, VA-Network ‑RunJobNow 1 ‑includeddisk 0,2,4 This command adds a replication job template. --------------------EXAMPLE 2-------------------- Add-ReplicationJobTemplate ‑JobName vRepJob1 ‑JobEntity $vm ‑TargetHost $targethost ‑ReplicateName TestRep ‑Type Differential ‑Flags $flags ‑targetDatastores MyDatastore1, MyDatastore2 ‑PrimaryDatastore MyDatastore ‑targetnetworks VMNetwork ‑includeddisk 0,1,2 This command adds a replication job template. Because the RunJobNow flag is not specified, the job does not run immediately. Because no transport failover is specified, the default order of transport failovers is used.
Related links	Add-BackupJobTemplate Add-RestoreJobTemplate Update-ReplicationJobTemplate Get-Job Get-JobTemplate

Add-RestoreFromManifestJobTemplate

Add-RestoreFromManifestJobTemplate

 

Description	Adds a restore job template from a manifest file. The manifest file can be a vRanger manifest file or a Legacy vRanger manifest file. You also have the option of running the job immediately after the template is created.
Syntax	Add-RestorefromManifestJobTemplate [‑JobName] <String> [[‑JobDescription] <String>] [‑Username] <String> [‑Password] <String> [‑ManifestPath] <String> [[‑EncryptionPassword] <String>] [[‑JobSchedule] <Schedule>] [[‑Flags] <No Flags | ForceOverwrite | ForcePowerOn | UseFiber | PerformNetworkRestoreOnFailure | AllFlags>] [[‑NotificationList] <String>] [[‑RunJobNow] <Boolean>][[‑VMName] <String>] [[‑TargetHost] <String>][[‑PrimaryDatastore] <String>] [[‑SkipDisks] <String>] [[‑TargetDatastores] <String>] [[‑TargetNetworks] <String>] [[‑SkipAdapters] <String>][[‑TransportConfiguration] <TransportConfiguration>] [<CommonParameters>]
Parameters	• JobName <String>: Job name. • JobDescription [<String>]: Job description. • Username <String>: Username. • Password <String>: Password. • ManifestPath <String>: Path for the manifest file. • EncryptionPassword [<String>]: Encryption Password. • 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 [<String>]: 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. • PrimaryDatastore [<String>]: Datastore on target host where the restored VM is located. If not set, the original primary datastore is used when restoring to the original VM; otherwise the application randomly selects a datastore attached to the target host. • SkipDisks [<String>]: Sequence number — base 0 — of the disks to skip from the savepoint. Disks in savepoint are order by their SCSI controller number and disk number. Separate multiple numbers with commas. • TargetDatastores [<String>]: Datastores 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 original datastores are used when restoring to the original VM; otherwise the application randomly selects a datastore attached to the target host. • TargetNetworks [<String>]: 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; otherwise the application randomly selects a network attached to the target host. • SkipAdapters [<String>]: Sequence number — base 0 — of the adapters to skip in the restore job. Separate multiple numbers with commas. • TransportConfiguration [<TransportConfiguration>]: The transport configuration options to use for this 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-------------------- $skipdisks = '0' $skipnetworks = '0' Add-RestorefromManifestJobTemplate ‑jobname vapirestore_manifest ‑username user1 ‑password Password1 ‑VmName Test ‑manifestpath \\pathtomanifestfile\XYZ-FreeDos_501ec05f-6088-5a14-8ae5-483bef2e054f\XYZ-FreeDos_20100302_085918_22c5f3ee-9a09-47ae-8a70-dae9233e5776\XYZ-FreeDos_20100302_085918_F.Manifest.metadata ‑targethost $targethost.name ‑targetDatastores $targetds.name ‑PrimaryDatastore $targetds.name ‑targetnetworks $targetnw.name ‑Flags $flags ‑SkipDisks $skipdisks ‑Skipadapters $skipnetworks ‑RunJobNow 1 This command creates a restore job template from a manifest file that restores to the specified target host. It also specifies the datastore and network to use on the target host. The first disk (0) in the savepoint and first adapter of the VM are skipped by the restore job. --------------------EXAMPLE 2-------------------- Add-RestorefromManifestJobTemplate ‑jobname vapirestore_manifest ‑username user1 ‑password Password1 ‑VmName Test ‑manifestpath \\pathtomanifestfile\pintsize_20090724093457\pintsize.info ‑targethost $targethost.name ‑targetDatastores $targetds.name ‑PrimaryDatastore $targetds.name ‑targetnetworks $targetnw.name ‑Flags $flags ‑RunJobNow 1 This command creates a restore job template from a legacy manifest file that restores to the specified target host. It also specifies datastore and network to use on the target host. --------------------EXAMPLE 3-------------------- Add-RestorefromManifestJobTemplate ‑jobname vapirestore_manifest ‑username user1 ‑password Password1 ‑encryptionpassword encryptPwd ‑VmName Test ‑manifestpath \\pathtomanifestfile\XYZ-FreeDos_501ec05f-6088-5a14-8ae5-483bef2e054f\XYZ-FreeDos_20100302_085918_22c5f3ee-9a09-47ae-8a70-dae9233e5776\XYZ-FreeDos_20100302_085918_F.Manifest.metadata ‑targethost $targethost.name ‑targetDatastores $targetds.name ‑PrimaryDatastore $targetds.name ‑targetnetworks $targetnw.name ‑Flags $flags ‑RunJobNow 1 This command creates a restore job template from an encrypted savepoint in the manifest file that restores to the specified target host. It also specifies datastore and network to use on the target host.
Examples (continued)	--------------------EXAMPLE 4-------------------- $repo = get-repository |where{$_.name ‑eq 'local'} $targethost = get-inventoryentities ‑type EsxHost | where{$_.name ‑eq 'dev015.dev.eng.int'} $targetds = get-datastore $targethost | where{$_.Name ‑eq 'Dynamo-ISCSI'} $targetnw = get-network ‑host $targethost|where{$_.Name ‑eq 'Virtual Machine Network'} $flags = New-RestoreFlag ‑ForceOverwrite 1 Add-RestorefromManifestJobTemplate ‑jobname vapirestore_manifest ‑username user1 ‑password Password1 ‑VmName Test ‑manifestpath \\pathtomanifestfile\XYZ-FreeDos_501ec05f-6088-5a14-8ae5-483bef2e054f\XYZ-FreeDos_20100302_085918_22c5f3ee-9a09-47ae-8a70-dae9233e5776\XYZ-FreeDos_20100302_085918_F.Manifest.metadata ‑targethost $targethost.name ‑targetDatastores $targetds.name ‑PrimaryDatastore $targetds.name ‑targetnetworks $targetnw.name ‑Flags $flags ‑RunJobNow 1 This command creates a restore job template from a manifest file that restores to the specified target host. It also specifies datastore and network to use on the target host.
Related links	Add-RestoreJobTemplate

Add-RestoreJobTemplate

Add-RestoreJobTemplate

 

Description	Adds a restore job template. You also have the option of running the job immediately after the template is created.
Syntax	Add-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>] [[‑PrimaryDatastore] <String>] [[‑SkipDisks] <List`1>] [[‑TargetDatastores] <List`1>] [[‑TargetNetworks] <List`1>] [[‑SkipAdapters] <List`1>] [[‑TransportConfiguration] <TransportConfiguration>] [[‑PhysicalMachineIP] <String>] [[‑RestoreDiskMapping] <Hashtable>] [<CommonParameters>]
Parameters	• JobName <String>: Job name. • JobDescription [<String>]: Job description. • SavePoint <Savepoint>: Savepoint to restore. • JobSchedule [<Schedule>]: Schedule on which the job should run. If not set, the job runs on demand. • Flags [<RestoreFlags>]: Restore flags. If not set, NoFlag. Restore flags: NoFlags, AllFlags, ForceOverwrite, ForcePowerOn. Separate multiple flags with pipes (|). • NotificationList [<String>]: Email notification list for the job. 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. • PrimaryDatastore [<String>]: Datastore on target host where the restored VM is located. If not set, the original primary datastore is used when restoring to the original VM; otherwise the application randomly selects a datastore attached to the target host. • SkipDisks [<String>]: Sequence number — base 0 — of the disks to skip from the savepoint. Disks in savepoint are order by their SCSI controller number and disk number. Separate multiple numbers with commas. • TargetDatastores [<String>]: Datastores to use on the target host. Separate multiple values with commas. If only one is supplied, it is used for all disks on the V M. If not set, the original datastores are used when restoring to the original VM; otherwise the application randomly selects a data store attached to the target host. • TargetNetworks [<String>]: 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; otherwise the application randomly selects a network attached to the target host. • SkipAdapters [<String>]: Sequence number — base 0 — of the adapters to skip in the restore job. Separate multiple numbers with commas. • TransportConfiguration: The transport configuration options to use for this job. • PhysicalMachineIP [<String>]: Physical machine IP address when booted to restore CD to perform the restore to. It must be booted to the restore CD. • RestoreDiskMapping [<Hashtable>]: Which disk in the repository is mapped to corresponding disks in the physical machine. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- $repo = get-repository |where{$_.name ‑eq 'local'} $sp = get-repositorysavepoint $repo.id $mysp = ($sp)[0] $targethost = get-inventoryentities ‑type EsxHost | where{$_.name ‑eq 'dev015.dev.eng.int'} $targetds = get-datastore $targethost | where{$_.Name ‑eq 'Dynamo-ISCSI'} $targetnw = get-network ‑host $targethost|where{$_.Name ‑eq 'Virtual Machine Network'} $skipdisks = '0' Add-RestoreJobTemplate ‑jobname vapirestore_skipdisk ‑savepoint $mysp ‑targethost $targethost.name ‑targetDatastores $targetds.name ‑PrimaryDatastore $targetds.name ‑targetnetworks $targetnw.name ‑SkipDisks $skipdisks 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 2-------------------- $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 3-------------------- $repo = get-repository |where{$_.name ‑eq 'local'} $sp = get-repositorysavepoint $repo.id $mysp = ($sp)[0] $targethost = get-inventoryentities ‑type EsxHost | where{$_.name ‑eq 'dev015.dev.eng.int'} $targetds = get-datastore $targethost | where{$_.Name ‑eq 'Dynamo-ISCSI'} $targetnw = get-network ‑host $targethost|where{$_.Name ‑eq 'Virtual Machine Network'} Add-RestoreJobTemplate ‑jobname vapirestore_totaraget ‑savepoint $mysp ‑targethost $targethost.name ‑targetDatastores $targetds.name ‑PrimaryDatastore $targetds.name ‑targetnetworks $targetnw.name This command creates a restore job template that restores to the specified target host. It also specifies datastore and network to use on the target host.
Examples (continued)	--------------------EXAMPLE 4-------------------- $repo = get-repository |where{$_.name ‑eq 'local'} $sp = get-repositorysavepoint $repo.id $mysp = ($sp)[0] $targethost = get-inventoryentities ‑type EsxHost | where{$_.name ‑eq 'dev015.dev.eng.int'} $targetds = get-datastore $targethost | where{$_.Name ‑eq 'Dynamo-ISCSI'} $targetnw = get-network ‑host $targethost|where{$_.Name ‑eq 'Virtual Machine Network'} $skipnetworks = '0' Add-RestoreJobTemplate ‑jobname vapirestore_skipdisk ‑savepoint $mysp ‑targethost $targethost.name ‑targetDatastores $targetds.name ‑PrimaryDatastore $targetds.name ‑targetnetworks $targetnw.name ‑Skipadapters $skipnetworks 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. --------------------EXAMPLE 5-------------------- $myInv = Get-InventoryEntities ‑Type physicalMachine $myPM = $myInv | where { $_.OriginatingConnection ‑eq '10.6.51.178'}n# the physical machine must be booted to the restore CD for this to work. $myDiskMap = Get-PhysicalMachineDiskMap $myPM $myRepo = Get-Repository ‑Type nfs $sp = Get-RepositorySavePoint ‑Id $myRepo.Id $mySP = ($sp)[0] $myManifest = Get-SavepointManifest ‑Id $mySP.id # Get the mapped physical disks that are the target of the manifest file map entry when the job is run. # This cmdlet matches the disks by size. $myRestoreDiskMap = Get-RestoreDiskMap ‑ManifestFile $myManifest ‑PhysicalDiskMap $myDiskMap # the user can do something like: # $myRestoreDiskMap[$myManifest.FileMaps[0]] = $myDiskMap.PhysicalDisks[1] # if they want to manually change which disk gets written to by the restore. Add-RestoreJobTemplate ‑JobName Restore178fromNFS ‑physicalMachine $myPM ‑RestoreDiskMap $myRestoreDiskMap ‑SavePoint $mySP This command creates a restore job template that restores to the specified target physical machine. The restore disk map is a hashtable that has File Map entries from the savepoint as a key and Physical Disk Entities designating which disks should be restored to on the physical machine.
Related links	Add-BackupJobTemplate Add-PhysicalMachine Update-RestoreJobTemplate Get-Job Get-JobTemplate