Remove-RASAgent

NAME

Remove-RASAgent

SYNOPSIS

Removes one or more RAS Agents.

SYNTAX

Remove-RASAgent [-InputObject] <RASAgentInfo[]> [<CommonParameters>] Remove-RASAgent [-InputObject] <RASAgentInfo[]> -Password <SecureString> -Username <string> [<CommonParameters>] Remove-RASAgent [-Server] <string> [[-SiteId] <uint>] [-Force <SwitchParameter>] [<CommonParameters>] Remove-RASAgent [-Server] <string> [[-SiteId] <uint>] -Password <SecureString> -Username <string> [-Force <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

Removes one or more RAS Agents.

PARAMETERS

-Server <string> The name of the RAS agent server. 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 in which to modify the specified server. 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

-Force <SwitchParameter> When 'Force' is passed, only the known info will be used and force the operation. If the parameter is omitted, the RAS Agent info is retrieved with the supplied info.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Username <string> An administrator account to remotely perform operation on the RAS 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 <RASAgentInfo[]> The RAS agent info. To obtain an RASAgentInfo object representing an RAS agent info list, use the Get-RASAgent 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 . 

INPUTS

RASAgentInfo[]

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Remove-RASAgent "server.company.dom" Removes the specified RAS Agent. The RAS agent will be remotely uninstalled using your RAS admin credentials. ---------- EXAMPLE 2 ---------- Remove-RASAgent "server.company.dom" -Username "myname" -Password $pass Removes the specified RAS Agent. The RAS agent will be remotely uninstalled from the server using the specified credentials. ---------- EXAMPLE 3 ---------- Get-RASAgent "server.company.dom" | Remove-RASAgent Removes the RAS agent represented by an object obtained from the pipeline output.