Remove-VDIGuest

NAME

Remove-VDIGuest

SYNOPSIS

Removes a RAS Guest Agent from a guest VM.

SYNTAX

Remove-VDIGuest [-VDIHostId] <uint> [-Id] <string> [-NoUninstall <SwitchParameter>] [<CommonParameters>]

Remove-VDIGuest [-VDIHostId] <uint> [-Id] <string> -Password <SecureString> -Username <string> [<CommonParameters>]

Remove-VDIGuest [-InputObject] <VDIGuest> [-NoUninstall <SwitchParameter>] [<CommonParameters>]

Remove-VDIGuest [-InputObject] <VDIGuest> -Password <SecureString> -Username <string> [<CommonParameters>]

DESCRIPTION

Removes a RAS Guest Agent from a guest VM, thus making it a plain VM, not a guest VM recognized by Parallels RAS.

PARAMETERS


-VDIHostId <uint>
The ID of the VDI Host server where the target guest VM resides.

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

-Id <string>
The ID of the target guest VM.

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

-InputObject <VDIGuest>
An object of type VDIGuest representing the target guest VM.

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

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

-NoUninstall <SwitchParameter>
If this parameter is included, the VDI Guest agent will NOT be uninstalled from the server.

To uninstall the agent, omit this parameter.

When uninstalling the agent, your RAS admin credentials will be used by default.

You can specify different credentials if needed using the Username and Password parameters.

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

-Username <string>
An administrator account to remotely uninstall the RAS Guest Agent from the VM.

If this parameter is omitted, your RAS admin username and password will be used by default.

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

-Password <SecureString>
The password of the account specified in the Username parameter.

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

VDIGuest

OUTPUTS

-none-

EXAMPLES


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

Remove-VDIGuest -VDIHostId 3 -Id 42311235-09c5-ca15-337d-b9723015edf0

Removes the RAS Guest Agent from a VM specified by VDI Host ID and the VM Id.

The agent will be remotely uninstalled from the server using the specified credentials.

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

Remove-VDIGuest $VDIGuest -NoUninstall

Removes RAS Guest Agent from a VM specified by the $VDIGuest variable, which is an object of type VDIGuest.

The object is obtained using the Get-VDIGuest cmdlet.

The RAS Guest Agent will NOT be uninstalled from the server.

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

Get-VDIGuest -VDIHostId 3 -Id 42311235-09c5-ca15-337d-b9723015edf0 | Remove-VDIGuest

Removes the RAS Guest Agent from a VM represented by a VDIGuest object obtained from the pipeline output.

The agent will be remotely uninstalled from the VM using the specified credentials.

RELATED LINKS