vRanger 7.8.1 - User Guide

Replication

Replication

 

Add-PhysicalMachine	Run-ReplicationFailover
Get-GlobalTransportFailover	Run-ResumeReplicationFailover
Get-MonitorLog	Run-TestReplicationFailover
Get-TransportFailover	Update-GlobalTransportFailover
New-ReplicationFlag	Update-ReplicationJobTemplate

Cmdlet help

Cmdlet help

To get help on any of the vAPI cmdlets, use the Get-Help command. At the prompt, enter Get-Help command, where command is any of the preceding vAPI cmdlets.

 

vAPI Cmdlet details

 

IMPORTANT: For the most up-to-date help contents, see the cmdlet help. To get help on any of the vAPI cmdlets, use the Get-Help command. At the prompt, enter: Get-Help <command> ‑full where <command> is any of the following vAPI cmdlets.

Add-BackupGroupEntity

 

Description	Adds a new backup group to vRanger. New-BackupGroupMember cmdlet is used to add members to a backup group created using this cmdlet or the UI.
Syntax	Add-BackupGroupEntity [‑BackupGroupName] <String> [<CommonParameters>]
Parameters	• BackupGroupName <String>: The BackupGroup Name. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters" • Type [-Type]: This optional parameter specifies the type of backup group: VMware, HyperV, or Physical. If not specified, the default is VMware.
Examples	Add-BackupGroupEntity ‑BackupGroupName BG1
Related links	Remove-BackupGroupEntity New-BackupGroupMember Remove-BackupGroupMember Get-BackupGroupEntity

Add-BackupJobTemplate

 

Description	Adds a backup job. You also have the option of running the job immediately after the template is created.
Syntax	Add-BackupJobTemplate [‑JobName] <String> [[‑JobDescription] <String>] [‑JobEntity] <Entity> [[‑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>] [[‑FullBackupDays] <List`1>][<CommonParameters>]
Parameters	• JobName <String>: Job name. • JobDescription [<String>]: Job description. • JobEntity <Entity>: Inventory entity on which the job is going to run on — VMware® ESXi™ host, VirtualCenter, and so on. • ExcludedVMList [<String>]: List of VM universally unique identifiers (UUIDs) 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 <BackupFlags>: Backup flags. • NumberOfSavePoints <Int>: Max number of savepoints to store before older ones are removed. • SpaceSavingTechnologyTypeFlag <SpaceSavingTechnologyType>: Spacesaving technology to use: differential, incremental or none. • SpaceSavingCountThreshold [<Int>]: The number to save before performing a full backup. • SpaceSavingPercentSizeThreshold [<Int>]: 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. • FullBackupDays [<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	Add-BackupJobTemplate ‑JobName myjob ‑JobEntity $inv ‑TargetRepository $repo ‑JobSchedule $s ‑Flags NoFlags ‑NumberOfSavePoints 3 ‑SpaceSavingTechnologyTypeFlag None This command adds a backup job template. Because the RunJobNow flag is not specified, the job does not run immediately.
Related links	Add-RestoreJobTemplate Add-PhysicalMachine Update-BackupJobTemplate Get-Job Get-JobTemplate

Add-CIFSRepository

 

Description	Adds a CIFS repository to vRanger. The repository can be later used to store backup files from backup jobs.
Syntax	Add-CifsRepository [‑Server] <String> [‑ShareName] <String> [[‑TargetDirectory] <String>] [‑DomainName] <String> [‑User] <String> [‑Password] <String> [‑Name] <String> [[‑Description] <String>] [[‑Overwrite] <Boolean>] [[‑EnableEncryption] <Boolean>] [[‑EncryptionPassword] <String>] [[‑ImportOption] <String>] [<CommonParameters>]
Parameters	• Server <String>: The CIFS Server FQDN or IP. • ShareName <String>: Name of the file-system share the repository is on. • TargetDirectory [<String>]: The CIFS target directory. • DomainName <String>: Name of the domain. • User <String>: The CIFS user name. • Password <String>: The CIFS password. • Name <String>: A friendly name describing this CIFS server. • Description [<String>]: The description of the CIFS server. • Overwrite [<Boolean>]: Whether to overwrite the existing repository if one exists. • EnableEncryption [<Boolean>]: Whether to enable encryption. • EncryptionPassword [<String>]: The encryption Password. • ImportOption [<String>]: Whether to import the save points as read-write or read-only. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Add-CifsRepository ‑Server myserver.dev.corp ‑Sharename myshare ‑TargetDirectory myrepo ‑User myname ‑Password mypassword ‑Name myCifs Repo ‑Overwrite 1 This command adds a repository on server myserver.dev.corp pointing to a share named myshare using the credentials provided. Existing repositories at the location specified are overwritten.
Related links	Get-PhysicalMachineDiskMap Add-DdbRepository Add-HypervCluster Add-NVSDRepository

Add-DdbReplicationRepository

 

Description	Adds an EMC® Data Domain® Boost (DD Boost™) replication repository to vRanger.
Syntax	Add-DdbReplicationRepository [‑Server] <String> [StorageUnit] <String> [‑User] <String> [‑Password] <String> [‑Name] <String> [[‑Description] <String>][‑RepositoryId] <String> [<CommonParameters>]
Parameters	• Server <String>: The DD Boost server FQDN or IP. • StorageUnit <String>: The DD Boost storage unit. • User <String>: The user name to access the DD Boost server. • Password <String>: The password to access the DD Boost server. • Name <String>: A friendly name describing this DD Boost server. • Description [<String>]: The description of the DD Boost server. • RepositoryId <String>: Repository ID in GUID. • <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-DdbReplicationRepository ‑Server myserver.dev.corp ‑StorageUnit mystorage ‑User myname ‑Password mypassword ‑Name myDDB Repo ‑RepositoryId 82E8A98A-1165-4ABE-966B-0E0AEF260620 This command configures a replication repository for repository identified by ID 82E8A98A-1165-4ABE-966B-0E0AEF260620 on server myserver.dev.corp pointing to a storage unit named mystorage using the credentials provided.
Related links	Get-Repository Add-DdbRepository

Add-DdbRepository

 

Description	Adds an EMC Data Domain Boost (DDB) repository to vRanger. The repository can be later used to store backup files from backup jobs.
Syntax	Add-DdbRepository [‑Server] <String> [‑StorageUnit] <String> [‑User] <String> [‑Password] <String> [‑Name] <String> [[‑Description] <String>] [[‑Overwrite] <Boolean>] [[‑ImportOption] <String>] [<CommonParameters>]
Parameters	• Server <String>: The EMC® Data Domain® Boost (DD Boost™) server FQDN or IP. • StorageUnit <String>: The DD Boost storage unit. • User <String>: The user name to access the DD Boost server. • Password <String>: The password to access the DD Boost server. • Name <String>: A friendly name describing this DD Boost server. • Description [<String>]: The description of the DD Boost 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. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Add-DdbRepository ‑Server myserver.dev.corp ‑StorageUnit mystorage ‑User myname ‑Password mypassword ‑Name myDDB Repo ‑Overwrite 1 This command adds a repository on server myserver.dev.corp pointing to a storage unit named mystorage using the credentials provided. Existing repositories at the location specified are overwritten.
Related links	Get-PhysicalMachineDiskMap Add-CIFSRepository Add-HypervCluster Add-NVSDRepository

Add-EsxHost

 

Description	Adds a VMware® ESXi™ host to the inventory.
Syntax	Add-EsxHost [‑DNSorIP] <String> [‑Username] <String> [‑RootPassword] <String> [[‑UserPassword] <String>] [[‑Port] <Int>] [[‑AddUser] <Boolean>] [<CommonParameters>]
Parameters	• DNSorIP <String>: The DNS or IP for the VMware® ESXi™ host. • Username <String>: The user name for the ESXi host. • RootPassword <String>: The root password for the ESXi host. • UserPassword [<String>]: The user password for the ESXi host. • Port [<Int>]: The SSH Port for the ESXi host. • AddUser [<Boolean>]: Add user if the user does not exist. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Add-EsxHost ‑DNSorIP 10.6.20.20 ‑Username root ‑RootPassword p@ssw0rd This command adds an ESXi host to the inventory.
Related links	Add-VirtualCenter Get-InventoryEntity

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

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	Add-NvsdRepository -Server myserver.dev.corp -TargetDirectory myrepo -User myname -Password mypassword -Name myNVSD Repo -Overwrite 1   This command adds a repository on server myserver.dev.corp pointing to target directory named myrepo using the credentials provided. Existing repositories at the location specified will be overwritten.
Related links	Get-Repository Add-NFSRepository Add-DdbRepository Add-CIFSRepository Add-RdaRepository

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	Add-PhysicalMachine ‑DNSorIP 10.6.20.20 ‑Username user1 ‑Password p@ssw0rd This command adds a replication job template.
Related links	Add-BackupGroupEntity Get-InventoryEntity

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.dev.corp -StorageUnit mystorage -User myname -Password mypassword -Name myRDARepo -Overwrite 1   This command adds a repository on server myserver.dev.corp pointing to storage unit named mystorage using the credentials provided. Existing repositories at the location specified will be overwritten.
Related links	Get-Repository Add-DdbRepository Add-CIFSRepository Add-NVSDRepository

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 VM Network -includeddisk 0,1,2   This command adds a replication job template. Since the RunJobNow flag is not specified the job will not be run immediately. Since no transport failover is specified the default order of transport failovers will be used. ------------------EXAMPLE 2-----------------------   Add-ReplicationJobTemplate -JobName vRepJob1 -JobEntity $vm -TargetHost $targethost -ReplicateName TestRep -Type Differential -Flags $flags -targetDatastores MyDatastore1, MyDatastore2 -PrimaryDatastore MyDatastore -targetnetworks VM Network -TransportFailover VA-HotAdd, VA-Network -RunJobNow 1 -includeddisk 0,2,4   This command adds a replication job template.
Related links	Add-BackupJobTemplate Add-RestoreJobTemplate Update-ReplicationJobTemplate Get-Job Get-JobTemplate

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

 

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

Add-VirtualAppforLinuxFLR

 

Description	This command is obsolete and has been replaced with Add-VirtualAppforLinuxFLRVA.
Related links	Add-VirtualAppforLinuxFLRVA

Add-VirtualAppforLinuxFLRVA

 

Description	Adds a VA to perform Linux® FLR.
Syntax	Add-VirtualAppforLinuxFLRVA [‑VirtualApplianceUUID] <String> [<CommonParameters>]
Parameters	• VirtualApplianceUUID <String>: VA UUID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Add-VirtualAppforLinuxFLRVA ‑VirtualApplianceUUID 564d8ab2-6c7f-5915-0a94-b224b5a71570
Related links	None

Add-VirtualCenter

 

Description	Adds a VirtualCenter to the inventory.
Syntax	Add-VirtualCenter [‑DNSorIP] <String> [‑Username] <String> [‑UserPassword] <String> [[‑Port] [<Int>]] [<CommonParameters>]
Parameters	• DNSorIP <String>: The DNS or IP for the VirtualCenter. • Username <String>: The user name for the VirtualCenter. • UserPassword <String>: The password for the VirtualCenter. • Port [<Int>]: The SDK Port for the VirtualCenter. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Add-VirtualCenter ‑DNSorIP 10.6.20.20 ‑Username administrator ‑RootPassword p@ssw0rd This command adds a VirtualCenter to the inventory.
Related links	Add-DdbRepository Get-InventoryEntity

Disable-Job

 

Description	Disables enabled jobs.
Syntax	Disable-Job [‑JobTemplateIDs] <GUID[]> [<CommonParameters>]
Parameters	• JobTemplateIDs <GUID[]>: Job template IDs for which to enable jobs. Disable multiple jobs by passing in comma-separated job template IDs. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Disable-Job ‑JobTemplateId 'F9C9E458-8E06-498D-8C2C-03CBE5515FD4' This command disables the job if it is enabled and returns the job template entity. --------------------EXAMPLE 2-------------------- $jobs = Get-JobTemplate | where {$_.IsEnabled ‑eq 1} Disable-Job $jobs[0].Id This command disables the first enabled job in the list and returns the job template entity.
Related links	Enable-Job Remove-VirtualApplianceConfiguration Get-JobTemplate Remove-JobTemplate

Dismount-LinuxVolume

 

Description	Unmounts VAR disk from the Linux® FLR VA.
Syntax	Dismount-LinuxVolume [<CommonParameters>]
Parameters	<CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Dismount-LinuxVolume
Related links	Mount-LinuxVolume

Enable-Job

 

Description	Enables disabled jobs.
Syntax	Enable-Job [‑JobTemplateIDs] <GUID[]> [<CommonParameters>]
Parameters	• JobTemplateIDs <GUID[]>: Job template IDs for which to enable jobs. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Enable-Job ‑JobTemplateId 'F9C9E458-8E06-498D-8C2C-03CBE5515FD4' This command enables the job if it is disabled and returns the job template entity. --------------------EXAMPLE 2-------------------- $jobs = Get-JobTemplate | where {$_.IsEnabled ‑eq 0} Enable-Job $jobs[0].Id This command enables the first disabled job in the list and returns the job template entity.
Related links	Disable-Job Remove-VirtualApplianceConfiguration Get-JobTemplate Remove-JobTemplate

Get-AddressBook

 

Description	Gets a list of email addresses from the address book.
Syntax	Get-Addressbook [<CommonParameters>]
Parameters	<CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-Addressbook
Related links	New-EmailAddress

Get-BackupGroupEntity

 

Description	Returns a list of backup group entities.
Syntax	Get-BackupGroupEntity [<CommonParameters>]
Parameters	<CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Get-BackupGroupEntity This command gets a list of all backup group entities. --------------------EXAMPLE 2-------------------- Get-BackupGroupEntity | where{$_.Name ‑eq 'BackupGroupName'} This command gets a list of backup groups by name.
Related links	None

Get-CatalogSearchData

 

Description	Returns the list of results for the matched search string, repositories, and VMs.
Syntax	Get-CatalogSearchData [‑SearchText] <String> [[‑RepositoryList] [<String>]] [[‑VMList] [‑Type] <Entity>] [<CommonParameters>]
Parameters	• SearchText <String>: Search string. • RepositoryList [<Repository[]>]: Filter by Repositories. If not specified, all repositories are searched. • VMList [<Entity[]>]: Filter by entities. If not specified, all entities are searched. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Get-CatalogSearchdata ‑SearchText abcd Gets the result set from the catalog database for matched search text. No repository or machine filtering is applied. --------------------EXAMPLE 2-------------------- $repo = Get-Repository | where {$_.Name ‑eq 'Repo1'} $vmList = Get-InventoryEntities ‑Type VirtualMachine | {$_.Name ‑eq 'VM1'} Get-CatalogSearchdata ‑SearchText abcd ‑RepositoryList $repo ‑VMList $vm Gets the result set from the catalog database for matched search text file read by repository and machine.
Related links	Remove-Catalog Get-CatalogStatus Set-Cataloging

Get-CatalogStatus

 

Description	Gets the active status of Catalog for a list of savepoints.
Syntax	Get-CatalogStatus [‑Savepoints] <GUID[]> [<CommonParameters>]
Parameters	• Savepoints <GUID[]>: List of Savepoint IDs. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-CatalogStatus ‑Savepoints 5a62765e-6a04-4df4-af54-46e5a38ad876 Gets the active status of the catalog data for the associated savepoint.
Related links	Get-CatalogSearchData Remove-Catalog Set-Cataloging

Get-ConfigOption

 

Description	Returns the config option values for a specified type.
Syntax	Get-Configoption [‑Type] <String> [<CommonParameters>]
Parameters	• Type <String>: Valid types are Database, Email, Resources, Timeout, General, LinuxFLR, and Cataloging. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-Configoption ‑Type Resources
Related links	Set-Resources Set-Cataloging Add-VirtualAppforLinuxFLR

Get-Connection

 

Description	Returns connection objects to Hosts or VirtualCenters. Without parameters, it returns all configured connections in vRanger. You can also get connections by name or type. Using the two parameters in the same command return an error.
Syntax	Get-Connection [[‑Name] [<String>]] [[‑Type] [<String>]] [<CommonParameters>]
Parameters	• Name [<String>]: The name or IP address of the VMware® ESXi™ host, VMware® vCenter™, Hyper-V® host, or Hyper-V cluster. • Type [<String>]: Connection type: EsxHost, VirtualCenter, HypervHost, HypervCluster, or All. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: “get-help about_commonparameters”
Examples	--------------------EXAMPLE 1-------------------- Get-Connection ‑type HypervHost This command gets a list of all Hyper-V host connections. --------------------EXAMPLE 2-------------------- Get-Connection This command gets a list of all vRanger loaded connections. --------------------EXAMPLE 3-------------------- Get-Connection ‑Name myhost.dev.corp This command returns a connection to the specified host. --------------------EXAMPLE 4-------------------- Get-Connection ‑type EsxHost This command gets a list of all ESXi host connections.
Related links	None

Get-CurrentTemplateVersionID

 

Description	Returns the current template version ID of a job template based on a historic template version ID. A new template version ID is assigned to the job template when it is modified.
Syntax	Get-CurrentTemplateVersionID [‑TemplateVersionID] [<String>] [<CommonParameters>]
Parameters	• TemplateVersionID <GUID>: Template version ID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-CurrentTemplateVersionID 6baedeed-227a-4350-ba3f-470f9e90dc07 This command returns the current template version ID of the job template referenced by the input template version ID.
Related links	Get-Job Get-JobTemplate

Get-Datastore

 

Description	Returns all datastores associated with the specified host.
Syntax	Get-Datastore [‑Host] <HostEntity> [<CommonParameters>]
Parameters	• Host <HostEntity>: The host object. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-Datastore ‑Host $host This command returns a list of datastores associated with the host.
Related links	Get-MonitorLog

Get-GlobalTransportFailover

 

Description	Gets the default Transport Failover order for replication jobs.
Syntax	Get-GlobalTransportFailover [<CommonParameters>]
Parameters	<CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-GlobalTransportFailover This command gets the default Transport Failover order for replication jobs.
Related links	Update-GlobalTransportFailover Get-TransportFailover

Get-InventoryEntity

 

Description	Returns a list of inventory entities based on the input repository type. The command returns all inventory entities if no type is provided. You can also get inventory entities by type. There is a performance delay if all types are requested or no type is specified.
Syntax	Get-InventoryEntity [[‑Type] <String>] [[‑Block] <Boolean>] [[‑Thin] <Boolean>][<CommonParameters>]
Parameters	• Type [<String>]: Inventory entity type: All, ClusterComputeResource, ComputeResource, DataCenter, EsxHost, Folder, HypervCluster, HypervHost, HypervVirtualMachine, ResourcePool, VirtualCenter, VirtualMachine, VirtualApp, PhysicalMachine. • Block [<Boolean>]: If set to true, the call blocks if inventory is being refreshed until it is done. Possible timeout might occur on large inventory sets. • Thin [<Boolean>]: If set to true, the call returns thin inventory objects. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Get-InventoryEntity‑ Type HypervHost This command gets a list of all inventory entities. --------------------EXAMPLE 2-------------------- Get-InventoryEntity ‑Type EsxHost This command gets a list of all loaded VMware® ESXi™ host entities. --------------------EXAMPLE 3-------------------- Get-InventoryEntity This command gets a list of all inventory entities.
Related links	None

Get-IsInventoryRefreshing

 

Description	Returns “true” or “false” based on whether the inventory is refreshing at the time the cmdlet is run.
Syntax	Get-IsInventoryRefreshing [[‑Type] <String>] [<CommonParameters>]
Parameters	• Type [<String>]: Inventory entity type to check: All, VMware, Hyper-V • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Get-IsInventoryRefreshing ‑Type Hyperv This command returns true if Hyper-V is refreshing. --------------------EXAMPLE 2-------------------- Get-IsInventoryRefreshing This command returns true if any inventory entity is refreshing. --------------------EXAMPLE 3-------------------- Get-IsInventoryRefreshing ‑Type VMware This command returns true if VMware is refreshing.
Related links	None

Get-Job

 

Description	Returns jobs. Without parameters, Get-Job returns all past and current jobs. You can also get jobs by JobState within a time span or JobTemplateIDs. If JobTemplateIDs are specified, no other parameters can be used.
Syntax	Get-Job [[‑StartTime] [<String>]] [[‑EndTime] [<String>]] [[‑JobState] [<String>]] [[‑JobTemplateIDs] [<String>]] [<CommonParameters>]
Parameters	• EndTime [<String>]: End time of time period. • StartTime [<String>]: Start time of time period. • JobState [<String>]: Job state: Queued, Running, Completed or All. • JobTemplateIDs [<String>]: Job template IDs for which to retrieve jobs. Separate multiple IDs with commas. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Get-Job This command returns jobs in all states. --------------------EXAMPLE 2-------------------- Get-Job ‑JobState Running This command returns all running jobs. --------------------EXAMPLE 3-------------------- Get-Job ‑starttime 2009-03-30 ‑endtime 2009-03-31 ‑JobState Completed This command returns completed jobs that started during the specified time span. --------------------EXAMPLE 4-------------------- Get-Job -JobTemplateIDs d7ebc5c4-7916-44c4-a0c2-2412999735f3,d7ebc5c4-7916-44c4-a0c2-2412990005f3 This command returns jobs based on the specified template ID.
Related links	Get-JobTemplate

Get-JobTemplate

 

Description	Returns a list of all jobs, on demand and scheduled (job templates). Without parameters, the command returns all job templates. You can also get job templates by Type or Inventory IDs.
Syntax	Get-JobTemplate [[‑Type] <String>] [[‑InventoryIds] <String[]>] [[‑Thin] <Boolean>] [[‑ID] <String>] [‑VersionID] <String>] [<CommonParameters>]
Parameters	• Type [<String>]: Specifies the type of job template to retrieve: Backup, Restore, or All. • InventoryIds [<String>]: The inventory nodes’ virtualization object ref IDs. Separate multiple IDs with commas. • Thin [<Boolean>]: Whether to return a thin version of job templates. Returning thin objects can speed up commands and avoid performance-related errors. By default, full objects are returned. • ID [<String>]: Job template ID. • VersionID [<String>]: Job template version ID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Get-JobTemplate This command gets a list of all job templates. --------------------EXAMPLE 2-------------------- Get-JobTemplate ‑type Backup This command gets a list of all backup jobs. --------------------EXAMPLE 3-------------------- Get-JobTemplate ‑InventoryIds d7ebc5c4-7916-44c4-a0c2-2412999735f3,d7ebc5c4-7916-44c4-a0c2-24 12990005f3 ‑Type Backup This command returns backup job templates in the specified inventories.
Related links	Get-Job

Get-MonitorLog

 

Description	Displays the vRanger Windows® error events.
Syntax	Get-MonitorLog [[‑EventId] <Int32>] [[‑StartDateTime] <DateTime>] [[‑EndDateTime] <DateTime>] [‑Verbose] [‑Debug] [‑ErrorAction <ActionPreference>] [‑WarningAction <ActionPreference>] [‑ErrorVariable <String>] [‑WarningVariable <String>] [‑OutVariable <String>] [‑OutBuffer <Int32>] [‑WhatIf] [‑Confirm]
Parameters	• EventId <Int32>: Filter by event ID. • StartDateTime <DateTime>: Filter based on the start time. • EndDateTime <DateTime>: Filter based on the end time.
Examples	get-monitorlog ‑eventid 1000
Related links	None

Get-Network

 

Description	Returns all networks associated with the host specified.
Syntax	Get-Network [‑Host] <HostEntity> [<CommonParameters>]
Parameters	• Host <HostEntity>: The host object. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-Network ‑Host $host This command returns a list of networks associated with the host.
Related links	Get-Datastore

Get-PhysicalMachineDiskMap

 

Description	Creates a Physical Machine disk map to be used in AddRestoreJobTemplate.
Syntax	Get-PhysicalMachineDiskMap [‑RestoreCDIP] <String> [<CommonParameters>]
Parameters	• RestoreCDIP <String>: The physical machine IP address as shown when it is booted to the restore CD. • <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	GetPhysicalMachineDiskMap ‑RestoreCDIP $IP Creates a Physical Machine disk map to be used in AddRestoreJobTemplate.
Related links	Get-InventoryEntity Add-RestoreJobTemplate

Get-Repository

 

Description	Returns repositories configured in vRanger. Without parameters, "Get-Repository" gets all repositories configured in vRanger. You can also get repositories by Name or Type. Using the two parameters in the same command returns an error.
Syntax	Get-Repository [[‑Id] [<String>]] [[‑Type] <String>] [<CommonParameters>]
Parameters	• Type <String>: Specifies the type of repository to retrieve: CIFS, NFS, NVSD, DDB, or ALL. • Id <String>: Repository ID in GUID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Get-Repository This command gets a list of all vRanger repositories. --------------------EXAMPLE 2-------------------- Get-Repository ‑id 034538e5-58a7-4d28-89c9-3249b620064a This command a repository with the specified ID. --------------------EXAMPLE 3-------------------- Get-Repository ‑type CIFS This command gets a list of all CIFS repositories.
Related links	Add-CIFSRepository Add-DdbRepository Add-HypervCluster Remove-Repository

Get-RepositoryJob

 

Description	Returns a list of associated jobs based on the input repository ID.
Syntax	Get-RepositoryJob [‑RepositoryId] <String> [<CommonParameters>]
Parameters	• RepositoryId <String>: Repository ID in GUID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-RepositoryJob ‑RepositoryId 034538e5-58a7-4d28-89c9-3249b620064a This command returns a list of jobs associated with the repository with the specified ID.
Related links	Get-Job Get-JobTemplate

Get-RepositorySavePoint

 

Description	Returns a list of savepoints in the repository. All savepoints in the repository are returned if no time parameter is specified.
Syntax	Get-RepositorySavePoint [‑Id] <String> [[‑StartTime] [<String>]] [[‑EndTime] [<String>]] [<CommonParameters>]
Parameters	• Id <String>: The repository ID to retrieve information for. • StartTime [<String>]: Start time of timespan during which the savepoints are complete. • EndTime [<String>]: End time of timespan during which the savepoints are completed. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-RepositorySavePoint ‑Id 034538e5-58a7-4d28-89c9-3249b620064a This command returns a list of savepoints associated with the repository with the specified ID.
Related links	None

Get-RestoreDiskMap

 

Description	Creates a Hashtable that represents a matching of file map entries from the savepoint with the disks from a physical machine — a RestoreDiskMap.
Syntax	Get-RestoreDiskMap [‑PhysicalDiskMap] <PhysicalDiskMap> [‑ManifestFile] <ManifestFile> [<CommonParameters>]
Parameters	• PhysicalDiskMap <PhysicalDiskMap>: The physical machine disk map. • ManifestFile <ManifestFile>: The manifest from the savepoint that contains file map entries for the disks backed up. • <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	Get-RestoreDiskMap ‑PhysicalDiskMap $physicaldiskMap ‑ManifiestFile $manifestFile This command matches the file map entries to the disks in a physical machine by size and returns a hash map that you can manipulate by code.
Related links	Add-BackupJobTemplate Get-InventoryEntity

Get-SavepointDisk

 

Description	Returns the VM disks that the savepoint contains.
Syntax	Get-SavepointDisk [‑Id] <String> [<CommonParameters>]
Parameters	• Id <String>: Savepoint ID in GUID format. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-SavePointDisk 91d27db5-4562-4456-918d-b0dc587e0e7f This command returns all disks that have been backed up into the savepoint specified.
Related links	Get-VMDKVolume

Get-SavepointManifest

 

Description	Returns manifest of the savepoint.
Syntax	Get-SavePointManifest [‑ID] <ID> [<CommonParameters>]
Parameters	• ID <ID>: The Savepoint ID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-SavePointManifest $id This command returns the savepoint manifest object.
Related links	Get-RepositorySavePoint Get-VMDKVolume

Get-Savepoints

 

Description	Returns a list of savepoints for a specified BackupJobTemplateID.
Syntax	Get-SavePoints [‑BackupJobTemplateID] <GUID> [<CommonParameters>]
Parameters	• BackupJobTemplateID <GUID>: The backup job template ID to retrieve savepoints for. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-SavePoints ‑BackupJobTemplateID 034538e2-58a7-4d28-89c9-3249b620064a This command returns a list of savepoints associated with the backup template with the specified ID.
Related links	Get-Job Get-JobTemplate

Get-TransportFailover

 

Description	Gets the Transport Failover order for replication jobs by TemplateVersion ID.
Syntax	Get-TransportFailover [‑TemplateVersionID] <String> [<CommonParameters>]
Parameters	• TemplateVersionID <String>: Template version ID for job. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$jobtemplates = Get-JobTemplate ‑Type Replication $template = $jobtemplates[0] Get-TransportFailover ‑TemplateVersionID $template.TemplateVersionId Gets the Transport Failover order for replication jobs by TemplateVersion ID.
Related links	Get-GlobalTransportFailover Update-GlobalTransportFailover

Get-VirtualApplianceConfig

 

Description	Gets the VirtualApplianceConfig configuration from vRanger.
Syntax	Get-VirtualApplianceConfig [[‑VAName] [<String>]] [[‑HostName] [<String>]][<CommonParameters>]
Parameters	• VAName [<String>]: The VA Name. • HostName [<String>]: The host name where the VA resides. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- $va = Get-VirtualApplianceConfig This command gets all the VA entities. --------------------EXAMPLE 2-------------------- $va = Get-VirtualApplianceConfig ‑VAName ABC-Vzva-1.1.1 This command gets the VA entity for the VA specified. --------------------EXAMPLE 3-------------------- $va = Get-VirtualApplianceConfig ‑HostName xyz.dev.eng.int This command gets the VA entities for the Host specified.
Related links	New-VirtualAppliance Update-VirtualAppliance Remove-VirtualAppliance

Get-VirtualApplianceDeploymentStatus

 

Description	Gets the status of the re-configuration of VA in progress.
Syntax	Get-VirtualApplianceDeploymentStatus [‑DeploymentId] <GUID> [<CommonParameters>]
Parameters	• ID <GUID>: Deployment ID for VA. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-VirtualApplianceReconfigStatus ‑Id $deploymentID This command gets the status of the VA re-configuration.
Related links	Update-VirtualAppliance New-VirtualAppliance

Get-VirtualApplianceReconfigStatus

 

Description	Gets the status of the deployment of VA in progress.
Syntax	Get-VirtualApplianceDeploymentStatus [‑DeploymentId] <GUID> [<CommonParameters>]
Parameters	• DeploymentId <GUID>: Deployment ID for VA. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-VirtualApplianceDeploymentStatus ‑Id $deploymentID This command gets the status of the VA deployment in progress.
Related links	Update-VirtualAppliance New-VirtualAppliance

Get-VirtualMachinesUnderInventory

 

Description	Gets the child VM entities of the entity — host, cluster, and so on — provided.
Syntax	Get-VirtualMachinesUnderInventory [[‑InventoryEntityMoRefId] [<String>]] [<CommonParameters>]
Parameters	• InventoryEntityMoRefId [<String>]: The MoRef ID of the parent inventory entity. • Thin [<Boolean>]: If set to true, the call returns thin inventory objects. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-VirtualMachinesUnderInventoryEntity ‑InventoryEntityMoRefId host-16641 The managed object reference ID of an inventory entity node such as a VMware® ESXi™ host or resource folder.
Related links	Add-BackupGroupEntity Get-BackupGroupEntity Get-InventoryEntity

Get-VmDisk

 

Description	Returns a list of VmDisks for the VM list in the same order of the input.
Syntax	Get-VmDisk [‑VMList] <VMEntity[]>] [<CommonParameters>]
Parameters	• VMList <VMEntity[]>: A list of VM entities to retrieve disk information for. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-VmDisk ‑VMList $mylist This command gets a list of VMDisks objects for the input VM list.
Related links	None

Get-VMDKVolume

 

Description	Returns all volumes on a certain VM disk.
Syntax	Get-VMDKVolume [‑VmdkID] <String> [‑Repository] <Repository> [‑RepositoryPassword] <String> [SavepointManifest] <ManifestFile> [<CommonParameters>]
Parameters	• VmdkID <String>: UUID of the VMDK. • Repository <Repository>: Repository in which the savepoint resides in. • RepositoryPassword <String>: Repository password. • SavepointManifest <ManifestFile>: The savepoint manifest object. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Get-VMDKVolume ‑vmdkid $diskid ‑repository $repo ‑repositorypassword Password ‑savepointmanifest $manifest This command returns all volumes of the specified VMDK.
Related links	None

Install-VirtualAppliance

 

Description	Deploys a new VA for vRanger.
Syntax	Install-VirtualAppliance [‑VAName] <String> [‑SelectedHost] <HostEntity> [‑OVFLocation] <String> [‑DownloadOVF] <Boolean> [[‑IPAddressOverride] <String>] [[‑ClusterDefault] <Boolean>] [‑CPUAllocation] <Int32> [‑MemorySizeInMB] <Int64> [‑VADatastore] <Datastore> [‑NetworkEntity] <Network> [[‑ScratchDiskDatastore] <Datastore>] [[‑ScratchDiskSizeInKB] <Int64>] [[‑NewPassword] <String>] [[‑UseVAForLFLR] <Boolean>] [[‑PowerOnVA] <Boolean>] [[‑VADeployStatus] <Boolean>] [[‑UseDHCP] <Boolean>] [[‑NetMask] <String>] [[‑StaticIP] <String>] [[‑GateWay] <String>] [[‑UseStaticDNS] <Boolean>] [[‑PrimaryDNS] <String>] [[‑SecondaryDNS] <String>] [[‑Domain] <String>] [[‑Search] <String>] [<CommonParameters>]
Parameters	• VAName <String>: The VA name. • SelectedHost <HostEntity>: The host to associate the VA with. • OVFLocation <String>: The path to the local OVF. • DownloadOVF <Boolean>: Should the OVF be downloaded? • IPAddressOverride [<String>]: IP Address to use for the VA instead of the one retrieved from the VirtualCenter API. • ClusterDefault [<Boolean>]: If the selected host belongs to a cluster, share the VA among all hosts in the cluster. • CPUAllocation <Int>: Allocate CPU. • MemorySizeInMB <Int>: Assign memory in MB. • VADatastore <Datastore>: Select a datastore for the VA. • NetworkEntity <Network>: Select a network for the VA. • ScratchDiskDatastore [<Datastore>]: Select a datastore for the scratch disk. • ScratchDiskSizeInKB [<Int>]: Assign scratch disk in KB. • NewPassword [<String>]: New password for the VA; if this word is not mentioned, Original password (vzroot1) is used. • UseVAForLFLR [<Boolean>]: Use VA for Linux® FLR. • PowerOnVA [<Boolean>]: Power on VA after deployment complete. • VADeployStatus [<Boolean>]: Retrieves VA deployment status if set to true. Defaults to false if the parameter is not passed in. • UseDHCP [<Boolean>]: Specify use of DHCP to set IP address. If false, StaticIP, NetMask, Gateway, and PrimaryDNS must be specified. • NetMask [<String>]: Netmask for use with the VA’s static IP address. Required if UseDHCP is false. • StaticIP [<String>]: Static IP Address for the VA. Required if UseStaticIP is true. • GateWay [<String>]: Optional gateway address for VA. • UseStaticDNS [<Boolean>]: Specify use of a static DNS setup. If true, PrimaryDNS must be specified. • PrimaryDNS [<String>]: Mandatory address of primary DNS server for VA. Required if UseStaticDNS is true. • SecondaryDNS [<String>]: Optional address of secondary DNS server for VA. • Domain [<String>]: Optional Local domain name for DNS resolver on VA. For more information, see the Linux manual (man) page for resolv.conf. • Search [<String>]: Optional Search list for host name lookup for DNS on VA. For more information, see the Linux man page for resolv.conf. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$myhost = Get-InventoryEntities ‑Type esxhost | where{$_.Name ‑eq 'dev-pool001.dev.eng.int'} $ds=Get-Datastore $myhost | where{$_.Name ‑like 'Local*'} $nw=Get-Network ‑Host $myhost Install-VirtualAppliance ‑VAName kk-TestVASTaticIP ‑SelectedHost $myhost ‑OVFLocation 'X:\Development\Vzva\vzva-1.8.0.ova' ‑DownloadOVF 0 ‑CPUAllocation 1 ‑MemorySizeInMB 512 ‑VADatastore $ds ‑NetworkEntity $nw ‑PowerOnVA 1 ‑VADeployStatus 1 ‑UseDHCP 0 ‑staticIP 10.6.51.159 ‑NetMask 255.255.254.0 ‑Gateway 10.6.50.2 ‑UseStaticDNS 1 ‑PrimaryDNS 10.6.30.10 This command deploys a new VA configuration to vRanger using a locally saved OVF and retrieves the status of the currently deploying VA in progress. Default for VADeployStatus is false.
Related links	Get-VirtualApplianceConfig Remove-VirtualAppliance Update-VirtualAppliance

Mount-LinuxVolume

 

Description	Mounts a volume from the specified manifest FileMaps.
Syntax	Mount-LinuxVolume [‑ManifestFileMaps] <FileMapEntryLine[]> [‑Repository] <Repository> [‑RepositoryPassword] <String> [<CommonParameters>]
Parameters	• ManifestFileMaps <FileMapEntryLine[]>: The savepoint manifest file map. • Repository <Repository>: The repository containing the VAR. • RepositoryPassword <String>: The password to the repository. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$path = Mount-LinuxVolume ‑repositorypassword xxxxxxxx ‑manifestfilemap [filemap] ‑repository [repo]
Related links	Dismount-LinuxVolume

New-BackupFlag

 

Description	Creates a new backup flag for later use.
Syntax	New-BackupFlag [[‑BackupPoweredOnOnly] <Boolean>] [[‑CheckDestinationFreeSpace] <Boolean>] [[‑UseCompression] <Boolean>] [[‑UpdateNotes] <Boolean>] [[‑EnableGuestQuiescing] <Boolean>] [[‑EnableABM] <Boolean>] [[PerformNetworkBackupOnFailure] <Boolean>] [[‑UseFiber] <Boolean>] [[‑UseCataloging] <Boolean>] [[‑LanFree] <Boolean>] [[‑AllFlags] <Boolean>] [<CommonParameters>]
Parameters	• BackupPoweredOnOnly [<Boolean>]: Whether to back up only VMs that are powered on. • CheckDestinationFreeSpace [<Boolean>]: Whether to check repository free space before backup. • UseCompression [<Boolean>]: Whether to use compression for backup. • UpdateNotes [<Boolean>]: Whether to update notes on VM after backup. • EnableGuestQuiescing [<Boolean>]: Whether guest quiescing is enabled. • EnableABM [<Boolean>]: Whether ABM is enabled. • PerformNetworkBackupOnFailure [<Boolean>]: [Deprecated] Formerly, whether to perform the backup using the network if there is a problem during the fiber or iSCSI backup. • UseFiber [<Boolean>]: [Deprecated] Formerly, whether to use fiber or iSCSI to perform this backup. Currently, whether to perform a LAN-free backup. Use LanFree instead. • UseCataloging [<Boolean>]: Whether to use cataloging to perform this backup. • EnableVSSApplicationLevelQuiescing [<Boolean>]: Whether to enable VSS Application Level Quiescing for this backup. • EnableVSSLogTruncation [<Boolean>]: Whether to enable VSS log truncation for this backup. • LanFree [<Boolean>]: Whether to perform a LAN-free backup. • AllFlags [<Boolean>]: Whether to use all available flags for the backup. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- New-BackupFlag This command returns a new BackupFlags object with the value of NoFlags. --------------------EXAMPLE 2-------------------- New-BackupFlag ‑EnableGuestQuiescing 1 ‑EnableABM 1 This command returns a new BackupFlags object with the values of EnableGuestQuiescing and EnableABM. --------------------EXAMPLE 3-------------------- New-BackupFlag ‑AllFlags 1 This command returns a new BackupFlags object with all flags set to on.
Related links	Add-BackupJobTemplate

New-BackupGroupMember

 

Description	Adds members to a backup group created using Add-BackupGroupEntity cmdlet or UI. You can add any inventory item as a member.
Syntax	New-BackupGroupMember [‑BackupGroupId] <GUID> [‑MemberEntity] <Entity> [<CommonParameters>]
Parameters	• BackupGroupId <GUID>: The backup group ID. • MemberEntity <Entity>: Inventory entity to add to backup group. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$inventoryEntity = Get-InventoryEntity ‑type virtualmachine | where {$_.Name ‑eq 'VMNAMEHERE'} New-BackupGroupMember 8c40f593-6608-45ef-b2c9-a2594aac2338 $inventoryEntity
Related links	None

New-Daily Schedule

 

Description	Returns a Schedule object. The schedule provides a template daily schedule that can be further customized before use.
Syntax	New-DailySchedule [‑WeekdayOnly] <Boolean> [‑StartTime] <String> [<CommonParameters>]
Parameters	• WeekdayOnly <Boolean>: Whether to run the job only on weekdays. • StartTime <String>: Job start time. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	New-DailySchedule ‑WeekdayOnly 1 ‑StartTime "2009-03-31 12:00:00AM" This command returns a daily job schedule that runs weekdays at midnight.
Related links	None

New-EmailAddress

 

Description	Adds an email address to the address book.
Syntax	New-EmailAddress [‑Name] <String> [‑Email] <String> [<CommonParameters>]
Parameters	• Name <String>: Name of person. • Email <String>: Email address. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	New-EmailAddress ‑Name Employee1 ‑Email firstname.lastname@company.com
Related links	Get-AddressBook

New-IntervalSchedule

 

Description	Returns an interval schedule object.
Syntax	New-IntervalSchedule [[‑IntervalDays] <Int>] [[‑IntervalHours] [<Int>]][‑IntervalMinutes] <Int> [‑StartTime] <String> [[‑RangeEndDate] <String>] [[‑RangeByOccurrence] <Int>] [<CommonParameters>]
Parameters	• IntervalDays <Int>: Number of days to use for interval schedule — the default is 0. • IntervalHours <Int>: Number of hours to use for interval schedule — the default is 0. • IntervalMinutes <Int>: Number of minutes to use for interval schedule — the default is 0. • StartTime <String>: Job start time. • RangeEndDate <String>: Range end date. • RangeByOccurrence <Int>: The maximum number of times a job is run. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- New-IntervalSchedule ‑StartTime 2009-03-31 ‑IntervalHours 1 This command returns an interval job schedule that runs every hour. --------------------EXAMPLE 2-------------------- New-IntervalSchedule ‑StartTime 2009-03-31 ‑IntervalMinutes 30 ‑RangeEndDate 2010-12-31 This command returns an interval job schedule that runs every 30 minutes until 2010-12-31. --------------------EXAMPLE 3-------------------- New-IntervalSchedule ‑StartTime 2009-03-31 ‑IntervalHours 1 ‑ intervalMinutes 30 ‑RangeByOccurrence10 This command returns an interval job schedule that runs every hour and half; the job is run 10 times at this interval.
Related links	New-Daily Schedule New-WeeklySchedule New-MonthlySchedule New-YearlySchedule

New-MonthlySchedule

 

Description	Returns a Schedule object. The schedule provides a template monthly schedule that can be further customized before use.
Syntax	New-MonthlySchedule [‑ExecutionDayOfMonth] <Int> [‑StartTime] <String> [<CommonParameters>]
Parameters	• ExecutionDayOfMonth <Int>: Day of month on which the job runs — 1 to 31. • StartTime <String>: Job start time. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	New-MonthlySchedule ‑ExecutionDayOfMonth 1 ‑StartTime "2009-03-31 12:00:00AM" This command returns weekly job schedule that runs on the first of every month at midnight.
Related links	New-Daily Schedule New-WeeklySchedule New-YearlySchedule New-IntervalSchedule

New-ReplicationFlag

 

Description	Helps you create a ReplicationFlags Enum object. Without parameters, the command returns NoFlags. You can pass in boolean parameters to specify which flags you want on.
Syntax	New-ReplicationFlag [[‑CheckDestinationFreeSpace] [<Boolean>]] [[‑UpdateNotes] [<Boolean>]] [[‑EnableGuestQuiescing] [<Boolean>]] [[‑EnableABM] [<Boolean>]] [[‑AllFlags] [<Boolean>]] [<CommonParameters>]
Parameters	• CheckDestinationFreeSpace [<Boolean>]: Whether to check repository free space before replication. • UpdateNotes [<Boolean>]: Whether to update notes on VM after replication. • EnableGuestQuiescing [<Boolean>]: Whether guest quiescing is enabled. • EnableABM [<Boolean>]: Whether ABM is enabled. • AllFlags [<Boolean>]: Whether to use all available flags for the replication. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- NewReplicationFlag This command returns a new ReplicationFlags object with the value of NoFlags. --------------------EXAMPLE 2-------------------- New-ReplicationFlag ‑EnableGuestQuiescing 1 ‑EnableABM 1 This command returns a new ReplicationFlags object with the values of EnableGuestQuiescing and EnableABM. --------------------EXAMPLE 3-------------------- New-ReplicationFlag ‑AllFlags 1 This command returns a new ReplicationFlags object with all flags set to on.
Related links	Add-PhysicalMachine

New-RestoreFlag

 

Description	Helps you create a RestoreFlags Enum object. Without parameters, the command returns NoFlags. You can pass in boolean parameters to specify which flags you want on.
Syntax	New-RestoreFlag [[‑ForceOverwrite] <Boolean>] [[‑ForcePowerOn] <Boolean>] [[‑UseFiber] <Boolean>] [[‑PerformNetworkRestoreOnFailure] <Boolean>] [[‑LanFree] <Boolean>] [[‑AllFlags] <Boolean>] [<CommonParameters>]
Parameters	• ForceOverwrite [<Boolean>]: Whether to force overwrite of existing VM with same name. • ForcePowerOn [<Boolean>]: Whether to power on the VM for restore. • UseFiber [<Boolean>]: [Deprecated] Formerly, whether to use fiber or iSCSI to perform this restore. Currently, whether to perform a LAN-free restore. Use LanFree instead. • PerformNetworkRestoreOnFailure [<Boolean>]: [Deprecated] Formerly, whether to perform a network restore on a LAN-free restore failure. • LanFree [<Boolean>]: Whether to perform a LAN-free restore. • AllFlags [<Boolean>]: Whether to use all available flags for the restore. • AddHypervVirtualMachineToCluster [<Boolean>]: Whether to add the restored Hyper-V® VM to the cluster. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- New-RestoreFlag This command runs RestoreFlags with the value of NoFlags. --------------------EXAMPLE 2-------------------- New-RestoreFlag ‑ForcePowerOn 1 ‑UseCompression 0 This command runs RestoreFlags with the values of ForcePowerOn. --------------------EXAMPLE 3-------------------- New-RestoreFlag ‑AllFlags 1 This command runs RestoreFlags with all flags set to on.
Related links	None

New-SMTPServer

 

Description	Adds an SMTP Server.
Syntax	New-SMTPServer [‑SMTPServer] <String> [‑Port] <Int> [‑FromEmail] <String> [<CommonParameters>]
Parameters	• SMTPServer <String>: SMTP server address. • Port <Int>: Port number for SMTP server. • FromEmail <String>: Email address for sent email messages. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	New-SMTPServer ‑SMTPServer company.smtp.com ‑Port 22 ‑FromEmail support@company.com
Related links	None

New-TransportConfiguration

 

Description	Helps you create a TransportConfiguration object. Without parameters, the command returns the default Automatic configuration. You can pass in boolean parameters to specify which settings you want on.
Syntax	New-TransportConfiguration [‑AutoSelectTransport] <Boolean> [‑RunLocal] <Boolean>[‑UseAdvancedTransport] <Boolean> [‑UseLanTransport] <Boolean> [[‑UseSsLforLan] <Boolean>] [<CommonParameters>]
Parameters	• AutoSelectTransport <Boolean>: The service determines which transport type to use at run-time. • RunLocal <Boolean>: Whether to run the job on the local machine vs the VA. • UseAdvancedTransport <Boolean>: Whether the job should attempt to use an advanced transport (SAN/HotAdd) first. • UseLanTransport <Boolean>: Whether the job should attempt to use a network transport. • UseSsLforLan [<Boolean>]: Whether the job should use an encrypted connection when attempting a network transport. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- New-BackupFlag ‑RunLocal 1 ‑UseAdvancedTransport 1 UseLANTransport 0 This command returns a new transport configuration object with the values of RunLocal, UseAdvancedTransport. --------------------EXAMPLE 2-------------------- New-TransportConfiguration This command returns a new transport configuration object with the configuration set to Automatic.
Related links	Add-BackupJobTemplate Add-RestoreJobTemplate

New-VirtualAppliance

 

Description	Configures a VA for vRanger.
Syntax	New-VirtualAppliance [‑VAEntity] <Entity> [‑RootPassword] <String> [[‑IPAddressOverride] <String>] [[‑ClusterDefault] <Boolean>] [<CommonParameters>]
Parameters	• VAEntity <Entity>: The VM Entity where the VA is deployed. • RootPassword <String>: Root Password for the VA. • IPAddressOverride <String>: New IP Address for the VA • ClusterDefault [<Boolean>]: Share the VA among all hosts in the cluster. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$va = Get-InventoryEntities ‑Type VirtualMachine | where {$_.Name ‑eq 'ABC-Vzva-1.1.1'} New-VirtualAppliance ‑VAEntity $va ‑IPAddressOverride 10.6.50.19 ‑RootPassword vzroot1 This command adds a VA configuration to vRanger.
Related links	Update-VirtualAppliance Remove-VirtualAppliance Get-VirtualApplianceConfig

New-WeeklySchedule

 

Description	Returns a Schedule object. The schedule provides a template weekly schedule that can be further customized before use.
Syntax	New-WeeklySchedule [‑ExecutionDays] <String> [‑StartTime] <String> [<CommonParameters>]
Parameters	• ExecutionDays <String>: Days of the week on which the job runs: Monday, Tuesday, and so on. Separate multiple days with commas. • StartTime <String>: Job start time. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- New-WeeklySchedule ‑ExecutionDays "Monday" ‑StartTime "2009-03-31 12:00:00AM" This command returns weekly job schedule that runs on Mondays at midnight. --------------------EXAMPLE 2-------------------- New-WeeklySchedule ‑ExecutionDays "Monday,Tuesday" ‑StartTime "2009-03-31 12:00:00AM" This command returns weekly job schedule that runs on Mondays and Tuesdays at midnight.
Related links	None

New-YearlySchedule

 

Description	Returns a Schedule object. The schedule provides a template yearly schedule that can be further customized before use.
Syntax	New-YearlySchedule [‑ExecutionMonth] <Int> [‑ExecutionDayOfMonth] <Int> [‑StartTime] <String> [<CommonParameters>]
Parameters	• ExecutionMonth <Int>: Month in which the job runs — 1 to 12. • ExecutionDayOfMonth <Int>: Day of month on which the job runs — 1 to 31. • StartTime <String>: Job start time. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	New-YearlySchedule ‑ExecutionMonth 1 ‑ExecutionDayOfMonth 1 ‑StartTime "2009-03-31 12:00:00AM" This command returns weekly job schedule that runs on the January 1 each year at midnight.
Related links	None

Remove-AllMount

 

Description	Removes all previously mounted paths. This operation should be performed as a cleanup step after all needed content is retrieved from the mounted path.
Syntax	Remove-Allmount [<CommonParameters>]
Parameters	<CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Remove-AllMount This command removes all mounted paths.
Related links	None

Remove-BackupGroupEntity

 

Description	Deletes a backup group from vRanger. Remove-BackupGroupMember cmdlet is used to remove members from a backup Group created using this cmdlet or UI.
Syntax	Remove-BackupGroupEntity [‑BackupGroupId] <GUID> [<CommonParameters>]
Parameters	• BackupGroupId <GUID>: The BackupGroup ID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$bg = Get-BackupGroupEntity | where {$_.Name ‑eq 'BG1'} Remove-BackupGroupEntity ‑BackupGroupId $bg.Id
Related links	None

Remove-BackupGroupMember

 

Description	Removes members from a backup group.
Syntax	Remove-BackupGroupMember [‑BackupGroupId] <GUID> [‑MemberEntity] <Entity> [<CommonParameters>]
Parameters	• BackupGroupId <GUID>: The BackupGroup ID. • MemberEntity <Entity>: Inventory entity to remove from backup group. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$vm = Get-InventoryEntities | where {$_.Name ‑eq 'myVM'} Remove-BackupGroupMember ‑BackupGroupId 5a62765e-6a04-4df4-af54 ‑46e5a38ad876 ‑MemberEntity $vm
Related links	None

Remove-Catalog

 

Description	Deletes the catalog data from the database for a list of savepoints.
Syntax	Remove-Catalog [‑Savepoints] <GUID[]> [<CommonParameters>]
Parameters	• Savepoints <GUID[]>: List of savepoint IDs. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Remove-Catalog ‑Savepoints 5a62765e-6a04-4df4-af54-46e5a38ad876 Removes the catalog data associated with the savepoint from the database.
Related links	Get-CatalogSearchData Get-CatalogStatus Set-Cataloging

Remove-DdbStorageUnit

 

Description	Removes the EMC® Data Domain® Boost (DD Boost™) repository from vRanger and deletes all savepoints in the repository from the disk. The storage unit is also removed from the DD Boost device.
Syntax	Remove-DdbStorageUnit [‑Repository] <Repository> [‑Password] <String> [<CommonParameters>]
Parameters	• Repository <Repository>: The DD Boost repository entity to remove. • Password <String>: Password for DD Boost user. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Remove-DdbStorageUnit ‑Repository $repo ‑Password Password123 This command removes the repository from vRanger and deletes all associated savepoints from the disk. The storage unit is also removed from the DD Boost device.
Related links	Remove-Repository

Remove-JobTemplate

 

Description	Removes a job template from vRanger.
Syntax	Remove-JobTemplate [‑Id] <String> [<CommonParameters>]
Parameters	• ID <String>: The job template ID in GUID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Remove-JobTemplate ‑Id $guid This command removes the job template with the specified ID from vRanger.
Related links	Add-BackupGroupEntity Add-RestoreJobTemplate Get-JobTemplate

Remove-LinuxVolume

 

Description	This command is obsolete and has been replaced with Dismount-LinuxVolume.
Related links	Dismount-LinuxVolume

Remove-Repository

 

Description	Removes a repository from vRanger. Optionally, all savepoints in the repository can be deleted from the disk.
Syntax	Remove-Repository [‑Id] <String> [[‑RemoveSavePoints] [<Boolean>]] [<CommonParameters>]
Parameters	• ID <String>: The repository ID in GUID. • RemoveSavePoints [<Boolean>]: Whether to remove all savepoints in the repositories. 0 or 1. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	--------------------EXAMPLE 1-------------------- Remove-Repository ‑Id $guid This command removes the repository with the specified ID from vRanger. All savepoints associated with the repository remain un-touched. --------------------EXAMPLE 2-------------------- Remove-Repository ‑Id $guid ‑RemoveSavePoints 1 This command removes the repository with the specified ID from vRanger. All savepoint files in the repository are removed from disk as well.
Related links	Add-CIFSRepository Add-VirtualAppforLinuxFLR Add-HypervCluster Add-NVSDRepository Get-PhysicalMachineDiskMap

Remove-SavePoint

 

Description	Removes savepoints. If any of the specified savepoints has descendant savepoints, those savepoints are also removed.
Syntax	Remove-SavePoint [‑SavePointsToRemove] <SavePointList> [<CommonParameters>]
Parameters	• SavePointsToRemove <SavePointList>: The list of savepoints to remove. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Remove-SavePoint ‑SavePointsToRemove $splist This command removes the list of savepoints specified.
Related links	Get-RepositorySavePoint Remove-Repository

Remove-VirtualAppliance

 

Description	Removes the VA configuration from vRanger.
Syntax	Remove-VirtualAppliance [‑VAId] <String> [<CommonParameters>]
Parameters	• VAId <String>: The VA ID for the VA. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$va = Get-VirtualApplianceConfig ‑VAName KRN-Vzva-1.1.1 Remove-VirtualAppliance ‑VAId $va.VirtualApplianceID This command removed a VA configuration.
Related links	New-VirtualAppliance Update-VirtualAppliance Get-VirtualApplianceConfig

Remove-VirtualApplianceConfiguration

 

Description	Removes the VA configuration from vRanger with an option to delete the VA from host.
Syntax	Remove-VirtualApplianceConfiguration [‑VAId] <String> [[‑DeleteVM] <Boolean>] [<CommonParameters>]
Parameters	• VAId <String>: VA entity. • DeleteVM [<Boolean>]: Delete VA from host. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$va = Get-VirtualApplianceConfig ‑VAName KRN-Vzva-1.1.1 Remove-VirtualAppliance ‑VAId $va.VirtualApplianceID ‑DeleteVM 1 This command removes a VA configuration from vRanger and also deletes the VM from Host.
Related links	New-VirtualAppliance Update-VirtualAppliance Get-VirtualApplianceConfig

Run-JobsNow

 

Description	Runs jobs specified by their template IDs. Use the Get-JobTemplate cmdlet to view the template IDs of configured job templates.
Syntax	Run-JobsNow [‑TemplateIds] <String> [<CommonParameters>]
Parameters	• TemplateIds <String>: The job template IDs. Separate multiple IDs with commas. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Run-JobsNow d7ebc5c4-7916-44c4-a0c2-2412999735f3,d7ebc5c4-7916-44c4-a0c2-2412990005f3 This command runs jobs specified by their templates.
Related links	Add-BackupGroupEntity Add-RestoreJobTemplate Get-Job Get-JobTemplate

Run-ReplicationFailover

 

Description	Fails over the replication pass to the replica.
Syntax	Run-ReplicationFailover [‑TemplateId] <String> [[‑Sync] [<String>]] [<CommonParameters>]
Parameters	• TemplateId <String>: Replication job template ID. • Sync [<Boolean>]: Whether to sync replica before failing over. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Run-ReplicationFailover ‑TemplateID d7ebc5c4-7916-44c4-a0c2-2412999735f3,d7ebc5c4-7916-44c4-a0c2-2412990005f3 This command runs replication failover based on the job template ID.
Related links	Run-TestReplicationFailover Run-ResumeReplicationFailover

Run-ResumeReplicationFailover

 

Description	Resumes test replication failover based on the test replication task ID.
Syntax	Run-ResumeReplicationFailover [‑TaskId] <String> [<CommonParameters>]
Parameters	• TaskID <String>: Replication test failover task ID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Run-ResumeReplicationFailover ‑TaskID d7ebc5c4-7916-44c4-a0c2-2412999735f3,d7ebc5c4-7916-44c4-a0c2-2412990005f3
Related links	Run-TestReplicationFailover Run-ReplicationFailover

Run-TestReplicationFailover

 

Description	Runs test replication failover based on the replication job’s template version ID.
Syntax	Run-TestReplicationFailover [‑TemplateVersionId] <GUID> [[‑EnableNetwork] <Boolean>] [<CommonParameters>]
Parameters	• TemplateVersionID <String>: Replication job template version ID. • EnableNetwork [<Boolean>]: Let replica network be enabled during a test failover. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Run-TestReplicationFailover ‑TemplateVersionId d7ebc5c4-7916-44c4-a0c2-2412999735f3,d7ebc5c4-7916-44c4-a0c2-2412990005f3 This command runs test failover on a replication job.
Related links	Run-ResumeReplicationFailover Run-ReplicationFailover

Set-Cataloging

 

Description	Enables or disables global cataloging flag.
Syntax	Set-Cataloging [‑Catalog] <Boolean> [<CommonParameters>]
Parameters	• Catalog <Boolean>: Boolean value to enable or disable global cataloging. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Set-Cataloging ‑Catalog 1
Related links	Remove-Catalog Get-CatalogSearchData Get-CatalogSearchData

Set-CBTonVM

 

Description	Enables or disables CBT for VMs if it is supported.
Syntax	Set-CBTonVM [‑VM] <VMEntity> [‑CBT] [<Boolean>] [<CommonParameters>]
Parameters	• VM <VMEntity>: VM for which to enable CBT. • CBT [<Boolean>]: Enable or disable CBT. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$vm = Get-InventoryEntities ‑type virtualmachine | where{$_.Name ‑eq 'xyz'} Set-CBTonVM ‑VM $vm ‑CBT 1 This command enables CBT on the VM xyz if it is supported on the VMware® ESXi™ host.
Related links	None

Set-LinuxVolume

 

Description	This command is obsolete and has been replaced with Mount-LinuxVolume.
Related links	Mount-LinuxVolume

Set-MountPath

 

Description	Sets mount path for a volume. After this operation, the specified volume is mounted to the path specified.
Syntax	Set-MountPath [‑Volume] <Volume> [‑Path] <String> [<CommonParameters>]
Parameters	• Volume <Volume>: The volume to mount. • Path <String>: The path to which the volume should be mounted to. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Set-MountPath ‑volume $v ‑path 'E:\' This command mounts the specified volume in the savepoint to the E:\ drive.
Related links	Get-PhysicalMachineDiskMap Get-RepositorySavePoint Get-RestoreDiskMap Get-VMDKVolume Remove-AllMount

Set-Resources

 

Description	Sets values for vRanger resources.
Syntax	Set-Resources [[‑NumberTasksVRanger] <Int>] [[‑NumberTasksLUN] <Int>] [[‑NumberTasksHost] <Int>] [[‑NumberTasksRepository] <Int>] [[‑NumberTasksLocal] <Int>] [[‑Timeout] <Int>] [[‑MinimumSpaceHost] <Int>] [[‑NumberTasksVA] <Int>] [<CommonParameters>]
Parameters	• NumberTasksVRanger [<Int>]: Maximum number of tasks running on vRanger (>=1). • NumberTasksLUN [<Int>]: Maximum number of tasks running off a LUN — 1 to 5. • NumberTasksHost [<Int>]: Maximum number of tasks running on a host — 1 to 4. • NumberTasksRepository [<Int>]: Maximum number of tasks running per Repository — >=1. • NumberTasksLocal [<Int>]: Maximum number of tasks running locally — 1 to 20. • Timeout [<Int>]: Task Timeout in hours — 1 to 999. • MinimumSpaceHost [<Int>]: Minimum space needed on host (GBs). • NumberTasksVA [<Int>]: Maximum number of tasks running on a VA — 1 to 8. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Set-Resources ‑NumberTasksVRanger 10 ‑Timeout 2 Sets the maximum tasks run on vRanger and the Timeout for each task.
Related links	Get-ConfigOption

Stop-vRangerJob

 

Description	Cancels a running job.
Syntax	Stop-vRangerJob [‑JobID] <String> [<CommonParameters>]
Parameters	• JobID <String>: Job ID for which to cancel 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-------------------- Stop-vRangerJob ‑JobId 'F9C9E458-8E06-498D-8C2C-03CBE5515FD4' This command cancels the job if it is running and returns the success or failure message. --------------------EXAMPLE 2-------------------- $jobs = Get-Job | where {$_.JobState ‑eq 'Running'} Stop-vRangerJob $jobs[0].Id This command cancels the first running job in the list and returns the success or failure message.
Related links	Remove-VirtualApplianceConfiguration Get-Job

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	get-jobtemplate backup |where{$_.jobname ‑eq 'my first backup job'}| Update-BackupJobTemplate ‑JobName 'modified by vapi' 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

 

Description	Updates the default Transport Failover order for replication jobs.
Syntax	Update-GlobalTransportFailover [‑TransportFailover] <String> [<CommonParameters>]
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	Update-GlobalTransportFailover ‑TransportFailover VA‑Network This command updates the default Transport Failover order for replication jobs.
Related links	Get-GlobalTransportFailover Get-TransportFailover

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	Update-Inventory 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

Update-VirtualAppliance

 

Description	This command is obsolete. Use Update-VirtualApplianceConfiguration instead.
Related links	New-VirtualAppliance Remove-VirtualAppliance Get-VirtualApplianceConfig

Update-VirtualApplianceConfiguration

 

Description	Updates the VA configuration from vRanger.
Syntax	Update-VirtualApplianceConfiguration [‑VirtualApplianceEntity] <VirtualApplianceConfig> [‑IPAddressOverride] <String>] [[‑ClusterDefault] <Boolean>][[‑CPUAllocation] <Int>] [[‑MemorySizeInMB] <Int>] [[‑ScratchDiskDatastore] <Datastore>] [[‑ScratchDiskSizeInKB] <Int>] [‑NewPassword] <String>][[‑UseVAForLFLR] <Boolean>] [[‑DeleteScratchDisk] <Boolean>] [[‑VAReconfigurationStatus] <Boolean>] [<CommonParameters>]
Parameters	• VirtualApplianceEntity <VirtualApplianceConfig>: The VM Entity to reconfigure. • IPAddressOverride [<String>]: IP Address to use for the VA instead of the one retrieved from the VMware® vCenter™ API. • ClusterDefault [<Boolean>]: If the selected host belongs to a cluster, share the VA among all hosts in the cluster. • CPUAllocation [<Int>]: Allocate CPU. • MemorySizeInMB [<Int>]: Assign memory in MB. • ScratchDiskDatastore [<Datastore>]: Select a datastore for the scratch disk. • ScratchDiskSizeInKB [<Int>]: Assign scratch disk in KB. • NewPassword [<String>]: New password for the VA, if this word is not specified, the password remains unchanged. • UseVAForLFLR [<Boolean>]: Use VA for Linux® FLR. • DeleteScratchDisk [<Boolean>]: If set to true, deletes the scratch disk — the default is false. • VAReconfigurationStatus [<Boolean>]: Retrieves VA deployment status if set to true. If the parameter is not passed in, the default is false. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug,‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	$va = Get-VirtualApplianceConfig ‑VAName KRN-Vzva-1.1.1 Update-VirtualApplianceConfiguration ‑VirtualApplianceEntity $va ‑CPUAllocation 2 ‑VAReconfigurationStatus 1 This command updates the VA configuration and sets CPUAllocation to 2. Setting VAConfigurationStatus to true retrieves the status of the VA reconfiguration in progress. Default is false.
Related links	New-VirtualAppliance Remove-VirtualAppliance Get-VirtualApplianceConfig