All pages
Powered by GitBook
1 of 1

Loading...

Get-RASVDIHostStatus.md

NAME

Get-RASVDIHostStatus

SYNOPSIS

Retrieves the list of, or a specific, host status.

SYNTAX

**Get-RASVDIHostStatus [] (uint) [[-] (uint)] - (string) [- {Level1 | Level2 | Level3}] [ (string)] [()]

**Get-RASVDIHostStatus [-] () [] (uint) [[-] (uint)] [- {Level1 | Level2 | Level3}] [ (string)] [()]

**Get-RASVDIHostStatus [[-] (uint)] [[-] (uint)] [- {Level1 | Level2 | Level3}] [ (string)] [()]

DESCRIPTION

Retrieves the list of, or a specific, host status.

PARAMETERS

ProviderId (uint)

The ID of a Provider server from which to obtain the Host vm list.

SiteId (uint)

Site ID from which to retrieve the Host VM list.

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

HostId (string)

The ID of the Host vm. To obtain the ID, use the Get-RASVDIHost cmdlet.

InputObject ()

An object of type VDIHost representing a Host vm for which to retrieve the information.

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

User (string)

The username assigned to Host.

If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.

StatusLevel ()

Specifies the level of detail that should be returned.

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

Possible values: Level1, Level2, Level3

(CommonParameters)

INPUTS

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASVDIHostStatus | Format-List

Retrieves the list of host statuses. **---------- EXAMPLE 2 ----------

Get-RASVDIHostStatus -ProviderId 1

Retrieves the list of host statuses from the specified Provider server. **---------- EXAMPLE 3 ----------

Get-RASVDIHostStatus -ProviderId 1 -SiteId 1

Retrieves the list of host statuses from the specified Provider server from the specified site. **---------- EXAMPLE 4 ----------

Get-RASVDIHostStatus -ProviderId 1 -SiteId 1 -HostId "" | Format-List

Retrieves the specified host status from the specified Provider server from the pecified site.

RELATED LINKS

ProviderId
SiteId
HostId
StatusLevel
User
CommonParameters
InputObject
VDIHost
ProviderId
SiteId
StatusLevel
User
CommonParameters
ProviderId
SiteId
StatusLevel
User
CommonParameters
VDIHost
StatusLevel
VDIHost
VDIHostSysInfo
Get-RASVDIHost
Remove-RASVDIHost
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                Level1

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation.