NAME
Remove-Computer
SYNOPSIS
Remove the local computer from a workgroup or domain.
SYNTAX
Remove-Computer [[-Credential] <PSCredential>] [-Force] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-Computer cmdlet removes the local computer from its current workgroup or domain.
When you remove a computer from a domain, Remove-Computer also disables the computer’s domain account.
When the computer is in a domain, you must provide credentials, even when they are the credentials of the current user, and you must restart the computer to make the change effective.
To get the results of the command, use the Verbose and PassThru parameters.
PARAMETERS
-Credential <PSCredential>
Specifies a user account that has permission to perform this action. The default is the current user.
Type a user name, such as “User01” or “Domain01\User01”, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.
To remove a computer from a domain, you must use the Credential parameter, even when you are using the credentials of the current user.
Required? false
Position? 2
Default value The credentials of the current user
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns the results of the command. Otherwise, this cmdlet does not generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before executing the command.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Describes what would happen if you executed the command without actually executing the command.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
“Get-Help about_CommonParameters“.
INPUTS
None
You cannot pipe input to this cmdlet
OUTPUTS
Microsoft.PowerShell.Commands.ComputerChangeInfo
When you use the PassThru parameter, Remove-Computer returns a ComputerChangeInfo object. Otherwise, this cmdlet does not generate any output.
NOTES
————————– EXAMPLE 1 ————————–
C:\PS>Remove-Computer
Description
———–
This command removes the computer from a workgroup.
————————– EXAMPLE 2 ————————–
C:\PS>Remove-Computer -Credential domain01\admin01 -PassThru -Verbose; Restart-Computer
Description
———–
These commands remove the local computer from the domain to which it is joined.
The first command removes the computer from the domain. The command uses the Credential parameter to supply the credentials of a domain administrator. It uses the PassThru parameter and the Verbose common parameter to display information about the success or failure of the command.
The second command uses the Restart-Computer cmdlet to restart the computer, which is required to complete the remove operation.
The semi-colon (;) separates the two commands.
RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=135246
Add-Computer
Checkpoint-Computer
Remove-Computer
Restart-Computer
Restore-Computer
Stop-Computer
Test-Connection