Edit

Share via

Disable-LocalUser

Module:
Microsoft.PowerShell.LocalAccounts Module

Disables a local user account.

Syntax

InputObject 

Disable-LocalUser
    [-InputObject] <LocalUser[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Default 

Disable-LocalUser
    [-Name] <String[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SecurityIdentifier 

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.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies an array of user accounts that this cmdlet disables. To obtain a user account, use the Get-LocalUser cmdlet.

Parameter properties

Type:

Microsoft.PowerShell.Commands.LocalUser[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies an array of names of the user accounts that this cmdlet disables.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-SID

Specifies an array of user accounts that this cmdlet disables.

Parameter properties

Type:

SecurityIdentifier[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SecurityIdentifier
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Management.Automation.SecurityAccountsManager.LocalUser

You can pipe a local user this cmdlet.

String

You can pipe a string to this cmdlet.

SecurityIdentifier

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.