Invoke-VDIProcessCmd

NAME

Invoke-VDIProcessCmd

SYNOPSIS

Sends a VDI Process command.

SYNTAX

Invoke-VDIProcessCmd [-VDIServer] <string> [[-SiteId] <uint>] -Command <VDIProcessCmd> {Kill} -Id <uint> -VDIGuestId <string> [<CommonParameters>]

Invoke-VDIProcessCmd [-VDIHostId] <uint> -Command <VDIProcessCmd> {Kill} -Id <uint> -VDIGuestId <string> [<CommonParameters>]

Invoke-VDIProcessCmd [-InputObject] <VDIServerAppInfo> -Command <VDIProcessCmd> {Kill} [<CommonParameters>]

DESCRIPTION

Sends a VDI session process command.

It will only fail with an error if the name or ID of the target VDIGuest Host server is invalid or command does not reach the destination.

If the process ID is invalid, the command will NOT fail.

Kill: sends a VDI kill application process command.

PARAMETERS


-VDIServer <string>
The name of an VDI Session Host server.

The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

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

-SiteId <uint>
Site ID from which to retrieve the server.

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

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

-VDIHostId <uint>
The ID of an VDI Session Host server.

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

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

-VDIGuestId <string>
VDI Guest ID.

To obtain the VDIGuestId, use the Get-VDIGuest command.

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

-Id <uint>
Process ID.

To obtain the VDI Process ID, use the Get-VDIHostStatus command with StatusLevel as Level3.

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

-InputObject <VDIServerAppInfo>
The VDIGuest Application info object.

To obtain an ServerAppInfo object representing an VDI Session application info, use the Get-VDIHostStatus command with StatusLevel as Level 3."

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

-Command <VDIProcessCmd>
Process command.

Accepted values: Kill.

Possible values: Kill

        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

VDIServerAppInfo

OUTPUTS

-none-

EXAMPLES


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

Invoke-VDIProcessCmd "server.company.dom" -VDIGuestId 42311235-09c5-ca15-337d-b9723015edf0 -Id 2536 -Command Kill

Invoke the VDI kill process command in the Licensing Server site (default) for the process with ID '2536'.

To obtain the Guest ID, use the Get-VDIGuest cmdlet.

To obtain the Process ID, use the Get-VDIHostStatus cmdlet with StatusLevel as Level3.

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

Invoke-VDIProcessCmd -VDIHostId 10 -VDIGuestId 42311235-09c5-ca15-337d-b9723015edf0 -Id 2536 -Command Kill

Invoke the VDI kill process command for the process with ID '2536' of the VDIHost Server with ID '10'.

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

To obtain the Guest ID, use the Get-VDIGuest cmdlet.

To obtain the process ID, use the Get-VDIHostStatus cmdlet with StatusLevel as Level3.

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

$VDISessionApp | Invoke-VDIProcessCmd -Command Kill

Invoke the VDI kill process command for the process, which is identified by an object obtained from the pipeline output.

To obtain the $VDISessionApp object, use the Get-VDIHostStatus cmdlet with StatusLevel as Level3.

RELATED LINKS