Remove-RASVDIHost
NAME
Remove-RASVDIHost
SYNOPSIS
Removes a RAS Guest Agent from a host VM.
SYNTAX
Remove-RASVDIHost [-ProviderId] <uint> [-Id] <string> [-NoUninstall <SwitchParameter>] [<CommonParameters>]
Remove-RASVDIHost [-ProviderId] <uint> [-Id] <string> -Password <SecureString> -Username <string> [<CommonParameters>]
Remove-RASVDIHost [-InputObject] <VDIHost> [-NoUninstall <SwitchParameter>] [<CommonParameters>]
Remove-RASVDIHost [-InputObject] <VDIHost> -Password <SecureString> -Username <string> [<CommonParameters>]
DESCRIPTION
Removes a RAS Guest Agent from a host VM, thus making it a plain VM, not a host VM recognized by Parallels RAS.
PARAMETERS
-ProviderId <uint> The ID of the Provider server where the target desktop VM resides.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false-Id <string> The ID of the target desktop VM.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false-InputObject <VDIHost> An object of type VDIHost representing the target desktop VM.
To obtain the object, use the Get-RASVDIHost 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 Host 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
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Remove-RASVDIHost -ProviderId 3 -Id 42311235-09c5-ca15-337d-b9723015edf0
Removes the RAS Guest Agent from a VM specified by Provider ID and the VM Id.
The agent will be remotely uninstalled from the server using the specified credentials. ---------- EXAMPLE 2 ----------
Remove-RASVDIHost $VDIHost -NoUninstall
Removes RAS Guest Agent from a VM specified by the $VDIHost variable, which is an object of type VDIHost.
The object is obtained using the Get-RASVDIHost cmdlet.
The RAS Guest Agent will not be uninstalled from the server. ---------- EXAMPLE 3 ----------
Get-RASVDIHost -ProviderId 3 -Id 42311235-09c5-ca15-337d-b9723015edf0 | Remove-RASVDIHost
Removes the RAS Guest Agent from a VM represented by a VDIHost object obtained from the pipeline output.
The agent will be remotely uninstalled from the VM using the specified credentials.
RELATED LINKS
Last updated