Remove-VDIHost

NAME

Remove-VDIHost

SYNOPSIS

Removes a VDI Host server from a site.

SYNTAX

Remove-VDIHost [-Server] <string> [[-SiteId] <uint>] [-NoUninstall <SwitchParameter>] [-VDIAgentOStype <RASAgentOSType> {Win32 | Win64 | Appliance}] [<CommonParameters>]

Remove-VDIHost [-Server] <string> [[-SiteId] <uint>] -Password <SecureString> -Username <string> [-VDIAgentOStype <RASAgentOSType> {Win32 | Win64 | Appliance}] [<CommonParameters>]

Remove-VDIHost [-Id] <uint> [-NoUninstall <SwitchParameter>] [-VDIAgentOStype <RASAgentOSType> {Win32 | Win64 | Appliance}] [<CommonParameters>]

Remove-VDIHost [-Id] <uint> -Password <SecureString> -Username <string> [-VDIAgentOStype <RASAgentOSType> {Win32 | Win64 | Appliance}] [<CommonParameters>]

Remove-VDIHost [-InputObject] <VDIHost> [-NoUninstall <SwitchParameter>] [-VDIAgentOStype <RASAgentOSType> {Win32 | Win64 | Appliance}] [<CommonParameters>]

Remove-VDIHost [-InputObject] <VDIHost> -Password <SecureString> -Username <string> [-VDIAgentOStype <RASAgentOSType> {Win32 | Win64 | Appliance}] [<CommonParameters>]

DESCRIPTION

Removes a VDI Host server from a site.

The RAS VDI Agent will be uninstalled from the server by default. You can optionally keep it by including the -NoUninstall parameter.

PARAMETERS


-Server <string>
The name of a VDI Host server to remove from a site.

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

-Id <uint>
The ID of a VDI Host server to remove from the site.

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

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

-NoUninstall <SwitchParameter>
If the NoUninstall 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

-VDIAgentOStype <RASAgentOSType>
OS type of the server where the RAS VDI Agent is running.

Possible values: Win32, Win64, Appliance 

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

-Username <string>
An administrator account to remotely uninstall the VDI Host agent from the server.

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

-InputObject <VDIHost>
An object representing the VDI Host server to remove from a site.

To obtain the object, use the Get-VDIHost command." 

        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

VDIHost

OUTPUTS

-none-

EXAMPLES


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

Remove-VDIHost "server.company.dom"

Removes the specified VDI Host server from the Licensing Server site (default).

The RAS VDI Agent will be remotely uninstalled using your RAS admin credentials.

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

Remove-VDIHost -Id 10 -Username "myname" -Password $pass

Removes a VDI Host server specified by ID. To obtain the ID, use the Get-VDIHost cmdlet.

The RAS VDI Agent will be remotely uninstalled from the server using the specified credentials.

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

Remove-VDIHost "server.company.dom" -NoUninstall

Removes the specified VDI Host server from the Licensing Server site (default).

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

---------- EXAMPLE 4 ----------

Get-VDIHost -Id 10 | Remove-VDIHost

Removes the VDI Host server represented by an object obtained from the pipeline output.

RELATED LINKS