Remove-RASVDIHostPoolMember
NAME
Remove-RASVDIHostPoolMember
SYNOPSIS
Removes a VDI Host Pool Member from a VDI Host Pool.
SYNTAX
Remove-RASVDIHostPoolMember [-VDIHostPoolId] <uint> -Id <uint> [-NoUninstall <SwitchParameter>] [<CommonParameters>]
Remove-RASVDIHostPoolMember -Id <uint> -Password <SecureString> -Username <string> [<CommonParameters>]
Remove-RASVDIHostPoolMember [-InputObject] <VDIHostPool> -Id <uint> [-NoUninstall <SwitchParameter>] [<CommonParameters>]
Remove-RASVDIHostPoolMember -Id <uint> -Password <SecureString> -Username <string> [<CommonParameters>]
Remove-RASVDIHostPoolMember [-VDIHostPoolName] <string> [[-SiteId] <uint>] -Id <uint> [-NoUninstall <SwitchParameter>] [<CommonParameters>]
Remove-RASVDIHostPoolMember -Id <uint> -Password <SecureString> -Username <string> [<CommonParameters>]
DESCRIPTION
Removes a VDI Host Pool Member from a VDI Host Pool.
PARAMETERS
-Id <uint> The VDI Host Pool Member ID.
-NoUninstall <SwitchParameter> Specifies not to uninstall the RAS Guest Agent on the vm.
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.
-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.
-Password <SecureString> The password of the account specified in the Username parameter.
-VDIHostPoolName <string> The VDI Host Pool name.
-SiteId <uint> Site ID where the VDI Host Pool is located.
If the parameter is omitted, the site ID of the Licensing Server will be used.
-VDIHostPoolId <uint> The VDI Host Pool ID.
-InputObject <VDIHostPool> An object of type VDIHostPool identifying the target VDI Host Pool.
The object is obtained using the Get-RASVDIHostPool cmdlet.
<CommonParameters>
INPUTS
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Remove-RASVDIHostPoolMember -VDIHostPoolId 10 -Id 1
Removes the specified VDI host pool member from the specified VDI host pool.
RELATED LINKS
Last updated