Disable-LocalUser
Disables a local user account.
Syntax
Disable-LocalUser
[-InputObject] <LocalUser[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disable-LocalUser
[-Name] <String[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disable-LocalUser
[-SID] <SecurityIdentifier[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Disable-LocalUser
cmdlet disables local user accounts. When a user account is disabled, the
user cannot log on. When a user account is enabled, the user can log on.
Note
The Microsoft.PowerShell.LocalAccounts module is not available in 32-bit PowerShell on a 64-bit system.
Examples
Example 1: Disable an account by specifying a name
Disable-LocalUser -Name "Admin02"
This command disables the user account named Admin02.
Example 2: Disable an account by using the pipeline
Get-LocalUser Guest | Disable-LocalUser
This command gets the built-in Guest account by using Get-LocalUser
, and then passes it to the
current cmdlet by using the pipeline operator(|
). That cmdlet disables that account.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies an array of user accounts that this cmdlet disables. To obtain a user account, use the
Get-LocalUser
cmdlet.
Type: | Microsoft.PowerShell.Commands.LocalUser[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies an array of names of the user accounts that this cmdlet disables.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SID
Specifies an array of user accounts that this cmdlet disables.
Type: | SecurityIdentifier[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
System.Management.Automation.SecurityAccountsManager.LocalUser
You can pipe a local user this cmdlet.
You can pipe a string to this cmdlet.
You can pipe a SID to this cmdlet.
Outputs
None
This cmdlet returns no output.
Notes
Windows PowerShell includes the following aliases for Disable-LocalUser
:
dlu
The PrincipalSource property is a property on LocalUser, LocalGroup, and LocalPrincipal objects that describes the source of the object. The possible sources are as follows:
- Local
- Active Directory
- Microsoft Entra group
- Microsoft Account
PrincipalSource is supported only by Windows 10, Windows Server 2016, and later versions of the Windows operating system. For earlier versions, the property is blank.
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for