vRanger 7.6.3 - User Guide

Install-VirtualAppliance

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

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

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

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