Get-View

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 - string. For objects with constant names such as AlarmManager and ServiceInstance, the ID format is (see the examples).

Syntax

-VIObject  <VIObject[]>
[-Property  <String[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VIObject
VIObject[] named
  • pipeline
  • Specifies the vSphere managed object that corresponds to the View object you want to retrieve.
    optional
    Property
    String[] named Specifies the properties of the view object you want to retrieve. If no value is given, all properties are shown.

    -ViewType  <Type>
    [-Filter  <Hashtable>]
    [-Property  <String[]>]
    [-SearchRoot  <ManagedObjectReference>]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    ViewType
    Type named 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.
    optional
    Filter
    Hashtable named Specifies a hash of - pairs, where represents the property value to test, and represents a regex pattern the property must match. If more than one pair is present, all the patterns must match.
    optional
    Property
    String[] named Specifies the properties of the view object you want to retrieve. If no value is given, all properties are shown.
    optional
    SearchRoot
    ManagedObjectReference named Specifies a starting point for the search (in the context of the inventory).
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.

    -Id  <ManagedObjectReference[]>
    [-Property  <String[]>]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    ManagedObjectReference[] named
  • wildcards
  • Specifies the IDs of the View objects you want to retrieve. A view object ID is a - string. For objects with constant names such as AlarmManager and ServiceInstance, the ID format is (see the examples).
    optional
    Property
    String[] named Specifies the properties of the view object you want to retrieve. If no value is given, all properties are shown.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.

    -RelatedObject  <ViewBaseMirroredObject[]>
    [-Property  <String[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    RelatedObject
    ViewBaseMirroredObject[] named
  • pipeline
  • Specifies view-related objects to retrieve their views.
    optional
    Property
    String[] named Specifies the properties of the view object you want to retrieve. If no value is given, all properties are shown.

    Output

    VMware.Vim.ViewBase

    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.

    Related Commands

    Feedback

    Was this page helpful?