Syntax
Get-View [-VIObject] <VIObject[]> [-Property <String[]>] [<CommonParameters>]Related Commands
Online versionDetailed Description
Returns the vSphere .Net view objects that correspond to the specified search criteria. The cmdlet retrieves the vSphere .NET 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[] | Specify the IDs of the .NET 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). | true | false | |
| VIObject | VIObject[] | Specify the corresponding vSphere managed object of the .NET view object you want to retrieve. | true | true (ByValue) | |
| Filter | Hashtable | Specify 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. | false | false | |
| Property | String[] | Specify the properties of the view object you want to retrieve. If no value is given, all properties are shown. | false | false | |
| RelatedObject | ViewBaseMirroredObject[] | Specify view-related objects to retrieve their views. | true | true (ByValue) | |
| SearchRoot | ManagedObjectReference | Specify a starting point for the search (in the context of the inventory). | false | false | |
| Server | VIServer[] | 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. | false | false | |
| ViewType | Type | Specify the type of the view objects you want to retrieve. | true | false |
Return Type
VMware.Vim.ViewBase or VMware.Vim.EntityViewBaseNotes
Examples
-------------- Example 1 --------------
$vm = Get-View -ViewType VirtualMachine -Filter @{"Name" = "VM"}
$hostView = Get-View -ID $vm.Runtime.Host
$hostView.Summary.RuntimeGets 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-CloudServer CloudServer1 Connect-VIServer VIServer1 $cloudExternalNetworkView = Get-CloudExternalNetwork ExternalNetwork1 | Get-CloudView 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.