Get-VM

Get-VM

Retrieves VM list from a VDI host in real-time.

Get-VM [[-VDIHostId] <uint>] [[-SiteId] <uint>] [<CommonParameters>]

Get-VM [-VDIHostId] <uint> [[-SiteId] <uint>] -Id <string> [<CommonParameters>]

Retrieves virtual machine information from VDI host servers.

It returns an array of objects of type VM, each containing properties of a virtual machine.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

Note: the returned object contains only the major properties of a Virtual Machine; it does not include all of the settings supported in RAS.

-VDIHostId <uint>
The name of the VDI Host server.

The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint>
The site ID from which to retrieve VM information.

If the parameter is omitted, the site ID of the Licensing Server will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <string>
The virtual machine UUID (universally unique identifier). UUID is assigned to a virtual machine by the hypervisor.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

VM

---------- EXAMPLE 1 ----------

Get-VM 2 | Format-List

Retrieves a list of virtual machines from the specified VDI host in the Licensing Server site.

To get the info from a specific site, use the -SiteId parameter.

The Format-List cmdlet formats the display output to include the complete list of returned VM properties.

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

Get-VM -VDIHostId 2 -SiteId 2

Retrieves a list of virtual machines from the specified VDI host in the specified site.

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

Get-VM | Format-List

Retrieves a list of all available virtual machines from the Licensing Server site.

To get the info from a specific site, specify the -SiteId parameter.

The Format-List cmdlet formats the display output to include the complete list of VM returned properties.

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

Get-VM -VDIHostId 2 -Id 42311235-09c5-ca15-337d-b9723015edf0

Retrieves information about a virtual machine specified by ID from the specified VDI host server from the Licensing Server site.