vRanger 7.8 - User Guide

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] <HypervRestoreJobTemplate> [[-JobName] <String>] [[-JobDescription] <String>] [[-SavePoint] <HypervSavePoint>] [-JobSchedule] <Schedule>] [[-Flags] <NoFlags | ForceOverwrite | ForcePowerOn | 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 <HypervRestoreJobTemplate>: Restore job template to update. • JobName <String>: Job name. • JobDescription [<String>]: Job description. • SavePoint <HypervSavePoint>: 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-------------------- $savepoint = Get-Repository |where{$_.name -eq 'local'}|Get-RepositorySavepoint |where{$_.VmUuid -eq '12312312312313'} Get-JobTemplate restore |where{$_.jobname -eq 'my restore job'}|Update-HypervRestoreJobTemplate -savepoint $savepoint   This command updates a restore job template to restore a different savepoint.
Related links	Add-RestoreJobTemplate Get-JobTemplate Get-Job

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

Update-ReplicationJobTemplate

 

Description	Updates a replication job template. You also have the option of running the job immediately after the template is updated.
Syntax	Update-ReplicationJobTemplate [‑JobTemplate] <ReplicationJobTemplate> [[‑JobName] <String>] [[‑JobDescription] <String>] [[‑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	• JobTemplate <ReplicationJobTemplate>: Replication job template to update. • JobName [<String>]: Job name. • JobDescription [<String>]: Job description. • 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 on which the replicated VM is 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 (|). • IncludedDisk [<Int>]: List of disks to include in this job. All VM disks are replicated if none is specified. • RunJobNow [<Boolean>]: Whether to run the job immediately after the job template is created. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	get-jobtemplate replication|where{$_.jobname ‑eq 'my first replication job'}|Update-ReplicationJobTemplate ‑JobName 'new name' This command updates a replication job template with a new name.
Related links	Add-PhysicalMachine Get-Job Get-JobTemplate

Update-RestoreJobTemplate

 

Description	Updates a restore job template. You also have the option of running the job immediately after the template is updated.
Syntax	Update-RestoreJobTemplate [‑JobTemplate] <RestoreJobTemplate> [[‑JobName] <String>] [[‑JobDescription] <String>] [[‑SavePoint] <Savepoint>] [[‑JobSchedule] <Schedule>] [[‑Flags] <NoFlags | 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	• JobTemplate <String>: The restore job template to update. • JobName [<String>]: Job name. • JobDescription [<String>]: Job description. • SavePoint [<Savepoint>]: Savepoint to restore. This parameter is not required if the restore job template contains only one savepoint. • VMName [<String>]: Name of the restored VM. If not set, the VM name in the savepoint is used. • JobSchedule [<Schedule>]: Schedule on which the job runs. 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 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-------------------- $temp = get-jobtemplate restore |where{$_.jobname ‑eq 'my restore job'} update-restorejobtemplate ‑jobtemplate $temp ‑jobname vapirestore This command updates a restore job template name. --------------------EXAMPLE 2-------------------- $savepoint = get-repository |where{$_.name ‑eq 'local'}|get-repositorysavepoint |where{$_.VMUUID ‑eq '12312312312313'} get-jobtemplate restore |where{$_.jobname ‑eq 'my restore job'}|update-restorejobtemplate ‑savepoint $savepoint This command updates a restore job template to restore a different savepoint.
Related links	Add-PhysicalMachine Get-Job Get-JobTemplate