< Back
Disable-LocalUser
Post
NAME Disable-LocalUser
SYNOPSIS
Disables a local user account.
SYNTAX
Disable-LocalUser [-InputObject] <LocalUser[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Disable-LocalUser [-Name] <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Disable-LocalUser [-SID] <SecurityIdentifier[]> [-Confirm] [-WhatIf] [<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.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <LocalUser[]>
Specifies an array of user accounts that this cmdlet disables. To obtain a user account, use the Get-LocalUser cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String[]>
Specifies an array of names of the user accounts that this cmdlet disables.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SID <SecurityIdentifier[]>
Specifies an array of user accounts that this cmdlet disables.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.SecurityAccountsManager.LocalUser, System.String, System.Security.Principal.SecurityIdentifier
You can pipe a local user, a string, or a SID to this cmdlet.
OUTPUTS
None
This cmdlet does not generate any output.
NOTES
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
- Azure Active Directory 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.
Example 1: Disable an account by specifying a name
PS C:\\>Disable-LocalUser -Name "Admin02"
This command disables the user account named Admin02.
Example 2: Disable an account by using the pipeline
PS C:\\>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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822508
Enable-LocalUser
Get-LocalUser
New-LocalUser
Remove-LocalUser
Rename-LocalUser
Set-LocalUser
SYNOPSIS
Disables a local user account.
SYNTAX
Disable-LocalUser [-InputObject] <LocalUser[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Disable-LocalUser [-Name] <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Disable-LocalUser [-SID] <SecurityIdentifier[]> [-Confirm] [-WhatIf] [<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.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <LocalUser[]>
Specifies an array of user accounts that this cmdlet disables. To obtain a user account, use the Get-LocalUser cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String[]>
Specifies an array of names of the user accounts that this cmdlet disables.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SID <SecurityIdentifier[]>
Specifies an array of user accounts that this cmdlet disables.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.SecurityAccountsManager.LocalUser, System.String, System.Security.Principal.SecurityIdentifier
You can pipe a local user, a string, or a SID to this cmdlet.
OUTPUTS
None
This cmdlet does not generate any output.
NOTES
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
- Azure Active Directory 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.
Example 1: Disable an account by specifying a name
PS C:\\>Disable-LocalUser -Name "Admin02"
This command disables the user account named Admin02.
Example 2: Disable an account by using the pipeline
PS C:\\>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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822508
Enable-LocalUser
Get-LocalUser
New-LocalUser
Remove-LocalUser
Rename-LocalUser
Set-LocalUser