Invoke-RASVDIHost.md
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.
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.
Id (string)
The ID of a desktop VM for which to retrieve the information.
VDITemplateObj (Template)
The VDI Template for which to retrieve the desktops of.
VDITemplateId (uint)
The ID of the VDI Template for which to retrieve the desktops of.
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.
VMId (string)
The ID of the VM for which to retrieve the information.
InputObject (VDIHost)
The VDI Host info object.
Command (VDICommand)
Command.
Accepted values: CancelSchedule.
Possible values: CancelSchedule
(CommonParameters)
INPUTS
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
Last updated