Remove-RASFarm.md

NAME

Remove-RASFarm

SYNOPSIS

Removes a deployed RAS farm from a remote server.

SYNTAX

Remove-RASFarm [Username] (string) [Password] (SecureString) [(CommonParameters)]

DESCRIPTION

This command will remove the following features: Redundancy, Gateway, Console, and Powershell previously installed by New-RASFarm. A new RAS session with administrative permissions is required. Remove-RASFarm does not need the -Server parameter because it retrieves the server address from the currently connected session. For this reason, before running Remove-RASFarm, New-RASSession has to be run first!

PARAMETERS

Username (string)

Remote machine username.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Password (SecureString)

Remote machine password.

        Required?                    true

        Position?                    1

        Default value                

        Accept pipeline input?       false

        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

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Remove-RASFarm

Removes a farm from a remote server. Uses cached credentials from the current RAS session.

If the user is an Administrator, no remote credentials are needed.

When using Remove-RASFarm without specifying credentials, cached credentials from the current active session will be used. The farm for which the session is active will be removed. Make sure you are connected to the correct farm when running Remove-RASFarm. **---------- EXAMPLE 2 ----------

Remove-RASFarm -Username Administrator -Password $SecretPassword .

Removes the farm using the specified credentials.

RELATED LINKS

• New-RASFarm