Remove-RASProvider
NAME
Remove-RASProvider
SYNOPSIS
Removes a Provider server from a site.
SYNTAX
Remove-RASProvider [-Id] <uint> [-NoUninstall <SwitchParameter>] [<CommonParameters>]
Remove-RASProvider [-Id] <uint> -Password <SecureString> -Username <string> [<CommonParameters>]
Remove-RASProvider [-InputObject] <Provider> [-NoUninstall <SwitchParameter>] [<CommonParameters>]
Remove-RASProvider [-InputObject] <Provider> -Password <SecureString> -Username <string> [<CommonParameters>]
Remove-RASProvider [-Name] <string> [[-SiteId] <uint>] [-NoUninstall <SwitchParameter>] [<CommonParameters>]
Remove-RASProvider [-Name] <string> [[-SiteId] <uint>] -Password <SecureString> -Username <string> [<CommonParameters>]
DESCRIPTION
Removes a Provider 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
-Name <string> The name of a Provider 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.
-SiteId <uint> Site ID from which to remove the server.
If the parameter is omitted, the Licensing Server site ID will be used.
-Id <uint> The ID of a Provider server to remove from the site.
To obtain the ID, use the Get-RASProvider cmdlet.
-NoUninstall <SwitchParameter> If the NoUninstall parameter is included, the VDI 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.
-Username <string> An administrator account to remotely uninstall the VDI agent from the server.
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.
-InputObject <Provider> An object representing the Provider server to remove from a site.
To obtain the object, use the Get-RASProvider command."
<CommonParameters>
INPUTS
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Remove-RASProvider "server.company.dom"
Removes the specified Provider server from the Licensing Server site (default).
The RAS VDI Agent will be remotely uninstalled using your RAS admin credentials. ---------- EXAMPLE 2 ----------
Remove-RASProvider -Id 10 -Username "myname" -Password $pass
Removes a Provider server specified by ID. To obtain the ID, use the Get-Provider cmdlet.
The RAS VDI Agent will be remotely uninstalled from the server using the specified credentials. ---------- EXAMPLE 3 ----------
Remove-RASProvider "server.company.dom" -NoUninstall
Removes the specified Provider server from the Licensing Server site (default).
The RAS VDI Agent will not be uninstalled from the server. ---------- EXAMPLE 4 ----------
Get-RASProvider -Id 10 | Remove-Provider
Removes the Provider server represented by an object obtained from the pipeline output.
RELATED LINKS
Last updated