vSphere PowerCLI Reference

Get-View

Synopsis

Returns the vSphere View objects that correspond to the specified search criteria.

Syntax

Get-View [-VIObject] <VIObject[]> [-Property <String[]>] [<CommonParameters>]
Get-View [-Server <VIServer[]>] [-Id] <ManagedObjectReference[]> [-Property <String[]>] [<CommonParameters>]
Get-View [-Server <VIServer[]>] [-SearchRoot <ManagedObjectReference>] -ViewType <Type> [-Filter <Hashtable>] [-Property <String[]>] [<CommonParameters>]
Get-View [-Property <String[]>] -RelatedObject <ViewBaseMirroredObject[]> [<CommonParameters>]

Related Commands

Online version
Get-VIObjectByVIView

Detailed Description

Returns the vSphere View objects that correspond to the specified search criteria. The cmdlet retrieves the vSphere View objects specified by their IDs or by their corresponding vSphere inventory objects (VIObject). A View object ID is a <type>-<value> string. For objects with constant names such as AlarmManager and ServiceInstance, the ID format is <type> (see the examples).

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
IdManagedObjectReference[]Specify the IDs of the View objects you want to retrieve. A view object ID is a <type>-<value> string. For objects with constant names such as AlarmManager and ServiceInstance, the ID format is <type> (see the examples).truefalse
VIObjectVIObject[]Specify the vSphere managed object that corresponds to the View object you want to retrieve.

When you pass VIServer, Get-View returns ServiceInstance. When the retrieved View object is a ServiceInstance, you cannot convert it to a VIObject with Get-VIObjectByVIView.
truetrue (ByValue)
FilterHashtableSpecify a hash of <name>-<value> pairs, where <name> represents the property value to test, and <value> represents a pattern the property must match. If more than one pair is present, all the patterns must match.falsefalse
PropertyString[]Specify the properties of the view object you want to retrieve. If no value is given, all properties are shown.falsefalse
RelatedObjectViewBaseMirroredObject[]Specify view-related objects to retrieve their views.truetrue (ByValue)
SearchRootManagedObjectReferenceSpecify a starting point for the search (in the context of the inventory).falsefalse
ServerVIServer[]Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
ViewTypeTypeSpecify the type of the View objects you want to retrieve.truefalse

Return Type

VMware.Vim.ViewBase or VMware.Vim.EntityViewBase

Notes

Examples

-------------- Example 1 --------------

$vm = Get-View -ViewType VirtualMachine -Filter @{"Name" = "VM"}

$hostView = Get-View -ID $vm.Runtime.Host

$hostView.Summary.Runtime

Gets the VM virtual machine using a filter by name, populates the view object and retrieves the runtime information.

-------------- Example 2 --------------

$folder = Get-Folder Folder | Get-View

Get-View -SearchRoot $folder.MoRef -ViewType "VirtualMachine"

Gets the view objects of virtual machines by specifying the root folder - MoRef.

-------------- Example 3 --------------

$folder = Get-Folder VM

$folderView = Get-View $folder -Property "[VirtualMachine]ChildEntity.Network.*"

$folderView.LinkedView.ChildEntity[0].LinkedView.Network

Gets the view of a folder by specifying for the Property parameter a property path, which leads to the networks of the virtual machines in the specified folder. Retrieves the first of the returned networks.

-------------- Example 4 --------------

Connect-CIServer CloudServer1

Connect-VIServer VIServer1

$cloudExternalNetworkView = Get-ExternalNetwork ExternalNetwork1 | Get-CIView

Get-View -RelatedObject $cloudExternalNetworkView

Gets the view of a vSphere object related to the specified Cloud object. In this case, gets the vSphere port group for the cloud external network.


Copyright © 1998 - 2012 VMware, Inc. All rights reserved.