Edit

Remove-CMUser

  • Reference
Module:
ConfigurationManager

Removes a user from Configuration Manager.

Syntax

Remove-CMUser
      [-Force]
      [-InputObject] <IResultObject>
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMUser
      [-Force]
      [-Name] <String>
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMUser
      [-Force]
      [-ResourceId] <Int32>
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-CMUser cmdlet removes user accounts from Configuration Manager.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Remove a user

PS XYZ:\> $User = Get-CMUser -CollectionName "All Users" -Name "Contoso\user01"
PS XYZ:\> Remove-CMUser -InputObject $User -Force

The first command gets the user object named user01 from the All Users collection and stores the object in the $User variable.

The second command removes the user account stored in $User. Specifying the Force parameter indicates that the user is not prompted before the user account is removed.

Example 2: Remove a user by using the pipeline

PS XYZ:\> Get-CMUser -CollectionName "All Users" -Name "Contoso\user02" | Remove-CMUser -Force

This command gets the user object named user02 from the All Users collection and uses the pipeline operator to pass the object to Remove-CMUser, which removes the user account. Specifying the Force parameter indicates that the user is not prompted before the user account is removed.

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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies a Configuration Manager user account object. To obtain a Configuration Manager user account object, use the Get-CMUser cmdlet.

Type:IResultObject
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of a user account.

Type:String
Aliases:UserName
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-ResourceId

Specifies the resource ID of a user account.

Type:Int32
Aliases:Id, UserId
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object