Chat now with support
Chat with Support

vRanger 7.7.1 - User Guide

Introduction Configuring vRanger
Configuring vRanger through the Startup Wizard Configuring vRanger manually Supplemental instructions: additional repository types
Using vRanger Backup Restore
Restoring a physical server Performing a full restore for VMware VMs Performing a full restore for Hyper-V® VMs Performing a full restore for VMware vApps Performing a full restore of a physical machine Performing an FLR on Windows Performing an FLR on Linux Restoring from manifest
Replicate VMs Reports Integrating and monitoring vRanger Using the vRanger Console vAPI Cmdlet details
Add-BackupJobTemplate Add-CIFSRepository Add-DdbReplicationRepository Add-DdbRepository Add-EsxHost Add-HypervCluster Add-HypervHost Add-HypervRestoreJobTemplate Add-NFSRepository Add-NVSDRepository Add-PhysicalMachine Add-RdaRepository Add-ReplicationJobTemplate Add-RestoreFromManifestJobTemplate Add-RestoreJobTemplate Add-VirtualAppforLinuxFLR Add-VirtualAppforLinuxFLRVA Add-VirtualCenter Disable-Job Dismount-LinuxVolume Enable-Job Get-AddressBook Get-BackupGroupEntity Get-CatalogSearchData Get-CatalogStatus Get-ConfigOption Get-Connection Get-CurrentTemplateVersionID Get-Datastore Get-GlobalTransportFailover Get-InventoryEntities Get-IsInventoryRefreshing Get-Job Get-JobTemplate Get-MonitorLog Get-Network Get-PhysicalMachineDiskMap Get-Repository Get-RepositoryJob Get-RepositorySavePoint Get-RestoreDiskMap Get-SavepointDisk Get-SavepointManifest Get-Savepoints Get-TransportFailover Get-VirtualApplianceConfig Get-VirtualApplianceDeploymentStatus Get-VirtualApplianceReconfigStatus Get-VirtualMachinesUnderInventory Get-VmDisk Get-VMDKVolume Install-VirtualAppliance Mount-LinuxVolume New-BackupFlag New-BackupGroupMember New-Daily Schedule New-EmailAddress New-IntervalSchedule New-MonthlySchedule New-ReplicationFlag New-RestoreFlag New-SMTPServer New-TransportConfiguration New-VirtualAppliance New-WeeklySchedule New-YearlySchedule Remove-AllMount Remove-BackupGroupEntity Remove-BackupGroupMember Remove-Catalog Remove-DdbStorageUnit Remove-JobTemplate Remove-LinuxVolume Remove-Repository Remove-SavePoint Remove-VirtualAppliance Remove-VirtualApplianceConfiguration Run-JobsNow Run-ReplicationFailover Run-ResumeReplicationFailover Run-TestReplicationFailover Set-Cataloging Set-CBTonVM Set-LinuxVolume Set-MountPath Set-Resources Stop-vRangerJob Update-BackupJobTemplate Update-GlobalTransportFailover Update-HypervRestoreJobTemplate Update-Inventory Update-ReplicationJobTemplate Update-RestoreJobTemplate Update-VirtualAppliance Update-VirtualApplianceConfiguration
About us

Get-CatalogSearchData

Previous Next


vAPI Cmdlet details > Get-CatalogSearchData

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

Gets the result set from the catalog database for matched search text. No repository or machine filtering is applied.

--------------------EXAMPLE 2--------------------

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

Previous Next


vAPI Cmdlet details > Get-CatalogStatus

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

Gets the active status of the catalog data for the associated savepoint.

Related links

Get-CatalogSearchData

Remove-Catalog

Set-Cataloging

Get-ConfigOption

Previous Next


vAPI Cmdlet details > Get-ConfigOption

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

Related links

Set-Resources

Set-Cataloging

Add-VirtualAppforLinuxFLR

Get-Connection

Previous Next


vAPI Cmdlet details > Get-Connection

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

This command gets a list of all Hyper-V host connections.

--------------------EXAMPLE 2--------------------

This command gets a list of all vRanger loaded connections.

--------------------EXAMPLE 3--------------------

This command returns a connection to the specified host.

--------------------EXAMPLE 4--------------------

This command gets a list of all ESXi host connections.

Related links

None

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating