Remove-RASAdminAccount

NAME

Remove-RASAdminAccount

SYNOPSIS

Removes an administrator account from the farm.

SYNTAX

Remove-RASAdminAccount [-Id] <uint> [-ForceDelete <SwitchParameter>] [<CommonParameters>] Remove-RASAdminAccount [-InputObject] <AdminAccount> [-ForceDelete <SwitchParameter>] [<CommonParameters>] Remove-RASAdminAccount [-Name] <string> [-ForceDelete <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

Removes an administrator account from the Parallels RAS farm.

PARAMETERS

-Name <string> The user name of an administrator to remove from the farm.

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

-Id <uint> The ID of an administrator to remove from the farm. To obtain the ID, use the Get-RASAdminAccount cmdlet.

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

-InputObject <AdminAccount> An object representing a Parallels RAS administrator to remove from the farm. To obtain the object, use the Get-RASAdminAccount command."

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

-ForceDelete <SwitchParameter> Force the administrator deletion. If supplied, any logged on sessions owned by this administrator will be logged off and then the administrator will be deleted.

        Required?                    false
        Position?                    named
        Default value                False
        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 . 

INPUTS

AdminAccount

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Remove-RASAdminAccount "Jane" Removes the specified administrator account from the farm. ---------- EXAMPLE 2 ---------- Remove-RASAdminAccount -Id 10 Removes a RAS farm administrator account specified by ID. To obtain the ID, use the Get-RASAdminAccount cmdlet. ---------- EXAMPLE 3 ---------- Get-RASAdminAccount -Id 10 | Remove-RASAdminAccount Removes a RAS farm administrator account identified by an object obtained from the pipeline output.

Last updated

© 2024 Parallels International GmbH. All rights reserved.