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. 

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

- 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. 

        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

- VDIHostPoolName <string>
The VDI Host Pool name. 

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

- 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. 

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

- VDIHostPoolId <uint>
The VDI Host Pool ID. 

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

- InputObject < VDIHostPool >
An object of type VDIHostPool identifying the target VDI Host Pool.

The object is obtained using the Get-RASVDIHostPool cmdlet. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        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

VDIHostPool

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