Invoke-RASVDIHost

NAME

Invoke-RASVDIHost

SYNOPSIS

The cmdlet invoke a command on an object of type VDI Host.

SYNTAX

Invoke-RASVDIHost [-ProviderId] <uint> [[-SiteId] <uint>] -Command {CancelSchedule} -Id <string> [-User <string>] [-VDITemplateId <uint>] [<CommonParameters>]

Invoke-RASVDIHost [-InputObject] <VDIHost> [[-SiteId] <uint>] -Command {CancelSchedule} [-User <string>] [-VDITemplateId <uint>] [<CommonParameters>]

Invoke-RASVDIHost [[-ProviderId] <uint>] [[-SiteId] <uint>] -Command {CancelSchedule} [-User <string>] [-VDITemplateId <uint>] [<CommonParameters>]

Invoke-RASVDIHost [-VMId] <string> [[-SiteId] <uint>] -Command {CancelSchedule} [-User <string>] [-VDITemplateId <uint>] [<CommonParameters>]

Invoke-RASVDIHost [-VDITemplateObj] <Template> [[-SiteId] <uint>] -Command {CancelSchedule} [-User <string>] [-VDITemplateId <uint>] [<CommonParameters>]

DESCRIPTION

The cmdlet invoke a command on an object of type VDI Host.

PARAMETERS

-ProviderId <uint> The ID of a Provider 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 desktop 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 desktop VM for which to retrieve the information.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VDITemplateId <uint> The ID of the VDI Template for which to retrieve the desktops of.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-User <string> The username assigned to Desktop.

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VMId <string> The ID of the VM for which to retrieve the information.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <VDIHost> The VDI Host info object.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-Command <VDICommand> Command.

Accepted values: CancelSchedule.

Possible values: CancelSchedule

        Required?                    true

        Position?                    named

        Default value                0

        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

-none-

EXAMPLES

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

Invoke-RASVDIHost -VMID "42311235-09c5-ca15-337d-b9723015edf0" -ProviderID 1 -Command CancelSchedule

Invokes CancelSchedule command on the VDI Host properties specified by the VMId and ProviderId. ---------- EXAMPLE 2 ----------

Invoke-RASVDIHost -ProviderID 1 -Command CancelSchedule

Invokes CancelSchedule command on all the VDI Hosts found within the Provider with Id 1.

RELATED LINKS

• Get-RASVDIHost

• New-RASVDIHost

• Remove-RASVDIHost