## PowerCLI Reference

# Get-View

## Synopsis

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

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

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
Id | ManagedObjectReference[] | Specifies 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). Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | true | false
VIObject | VIObject[] | Specifies 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. | true | true (ByValue)
Filter | Hashtable | Specifies a hash of <name>-<value> pairs, where <name> represents the property value to test, and <value> represents a regex pattern the property must match. If more than one pair is present, all the patterns must match. | false | false
Property | String[] | Specifies the properties of the view object you want to retrieve. If no value is given, all properties are shown. | false | false
RelatedObject | ViewBaseMirroredObject[] | Specifies view-related objects to retrieve their views. | true | true (ByValue)
SearchRoot | ManagedObjectReference | Specifies a starting point for the search (in the context of the inventory). | false | false
Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | false
ViewType | Type | Specifies the type of the View objects you want to retrieve. This parameter accepts ClusterComputeResource, ComputeResource, Datacenter,Datastore, DistributedVirtualPortgroup, DistributedVirtualSwitch, Folder, HostSystem, Network, OpaqueNetwork, ResourcePool,StoragePod, VirtualApp, VirtualMachine, and VmwareDistributedVirtualSwitch values. | true | false

Return Type

Zero or more ViewBase objects

Notes

Examples

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

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

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

    $vmhostView.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 © VMware, Inc. All rights reserved.