Get-VDIHostStatus

NAME

Get-VDIHostStatus

SYNOPSIS

Retrieves the VDI Host status information.

SYNTAX

Get-VDIHostStatus [[-Server] <string>] [[-SiteId] <uint>] [-StatusLevel <StatusLevel> {Level1 | Level2 | Level3}] [<CommonParameters>]

Get-VDIHostStatus [[-Id] <uint>] [-StatusLevel <StatusLevel> {Level1 | Level2 | Level3}] [<CommonParameters>]

Get-VDIHostStatus [[-InputObject] <VDIHost>] [-StatusLevel <StatusLevel> {Level1 | Level2 | Level3}] [<CommonParameters>]

DESCRIPTION

Retrieves the VDI Host status information and optionally guest VM and application info.

PARAMETERS


-Server <string>
The name of the VDI Host server for which to retrieve the information.

This must be the actual server name used in the RAS farm. 

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

-SiteId <uint>
Site ID from which to retrieve the specified VDI Host server 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 <uint>
The ID of the VDI Host server. To obtain the ID, use the Get-VDIHost cmdlet. 

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

-InputObject <VDIHost>
An object of type VDIHost representing a VDI Host server for which to retrieve the information.

To obtain the object, use the Get-VDIHost cmdlet. 

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

-StatusLevel <StatusLevel>
Specifies the level of detail that should be returned.

Acceptable values: Level1 (VDI Host status information only), Level2 (VDI Host status and Guest VM info), Level3 (VDI Host status, Guest VMs, Applications).

Possible values: Level1, Level2, Level3 

        Required?                    false
        Position?                    named
        Default value                Level1
        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

VDIHost

OUTPUTS

VDIHostSysInfo

EXAMPLES


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

Get-VDIHostStatus -Id 15

Retrieves the VDI Host status information for the VDI Host server with ID 15.

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

Get-VDIHostStatus -Server MyHost -StatusLevel Level2

Retrieves the VDI Host status and the guest VM information for the server named "MyHost".

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

Get-VDIHostStatus -InputObject $VDIHost -StatusLevel Level3

Retrieves the VDI Host status, guest VM, and application information for the server represented by the $VDIHost object.

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

Get-VDIHost -Id 15 | Get-VDIHostStatus -StatusLevel Level1

Retrieves the VDI Host status information for the server represented by the object obtained from the pipeline output.

RELATED LINKS