Get-VDIGuest

NAME

Get-VDIGuest

SYNOPSIS

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

SYNTAX

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

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

Get-VDIGuest [-VDITemplateObj] <VDITemplate> [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the list of guest VMs from one or multiple VDI host servers.

Returns an array of objects of type VDIGuest, each containing properties of a guest VM.

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 guest VM; it does not include all of the settings supported in RAS.

PARAMETERS


-VDIHostId <uint>
The ID of a VDI Host server from which to obtain the VM list. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID from which to retrieve the guest VM list.

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 ID of a guest VM for which to retrieve the information. 

        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VDITemplateObj <VDITemplate>
The VDI Template for which to retrieve the guests of. 

        Required?                    true
        Position?                    0
        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.

INPUTS

-none-

OUTPUTS

VDIGuest

EXAMPLES


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

Get-VDIGuest 2 | Format-List

Retrieves the list of guest VMs from the specified VDI Host server 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 the returned properties.

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

Get-VDIGuest -VDIHostId 2 -SiteId 2

Retrieves the list of guest VMs from the specified VDI Host server from the specified site.

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

Get-VDIGuest | Format-List

Retrieves the complete list of guest VMs residing on all available VDI Host servers in 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 the returned properties.

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

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

Retrieves the information about a specified guest VM residing on the specified VDI Host server.

---------- EXAMPLE 5 ----------

Get-VDIGuest -VDITemplateObj $TempObj

Retrieves the information about the VDI guests created from the specified VDI template.

RELATED LINKS