Remove-RDS

NAME

Remove-RDS

SYNOPSIS

Removes an RD Session Host server from a site.

SYNTAX

Remove-RDS [-Server] <string> [[-SiteId] <uint>] [-NoUninstall <SwitchParameter>] [<CommonParameters>]

Remove-RDS [-Server] <string> [[-SiteId] <uint>] -Password <SecureString> -Username <string> [<CommonParameters>]

Remove-RDS [-Id] <uint> [-NoUninstall <SwitchParameter>] [<CommonParameters>]

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

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

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

DESCRIPTION

Removes an RD Session Host server from a site.

The RD Session Host 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 an RD Session 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 an RD Session Host server to remove from the site.

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

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

-NoUninstall <SwitchParameter>
If this parameter is included, the RD Session 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 RD Session 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 <RDS>
The RD Session Host server to remove from a site.

To obtain an RDS object representing an RD Session Host server, use the Get-RDS 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

RDS

OUTPUTS

-none-

EXAMPLES


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

Remove-RDS "server.company.dom"

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

The RD Session Host agent will be remotely uninstalled using your RAS admin credentials.

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

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

Removes an RD Session Host server specified by ID. To obtain the ID, use the Get-RDS cmdlet.

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

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

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

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

The RD Session Host agent will NOT be uninstalled from the server.

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

Get-RDS -Id 10 | Remove-RDS

Removes the RD Session Host server, which is identified by an object obtained from the pipeline output.

RELATED LINKS