external help file | Module Name | ms.date | schema | title |
---|---|---|---|---|
AdminUI.PS.dll-Help.xml |
ConfigurationManager |
12/21/2021 |
2.0.0 |
Remove-CMAdministrativeUser |
Remove an administrative user.
Remove-CMAdministrativeUser [-Force] -InputObject <IResultObject> [-DisableWildcardHandling]
[-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-CMAdministrativeUser [-Force] -Name <String> [-DisableWildcardHandling] [-ForceWildcardHandling]
[-WhatIf] [-Confirm] [<CommonParameters>]
Remove-CMAdministrativeUser [-Force] -Id <String> [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
[-Confirm] [<CommonParameters>]
Use this cmdlet to remove a Configuration Manager administrative user. An administrative user in Configuration Manager defines a local or domain user or group. When you remove an administrative user, Configuration Manager revokes the access of the administrative user to manage Configuration Manager. For more information about security roles, see Fundamentals of role-based administration in Configuration Manager.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
This command gets the administrative user object named Admin1. It uses the pipeline operator to pass the object to Remove-CMAdministrativeUser, which removes the administrative user. With the Force parameter, you're not prompted for confirmation before it runs.
Get-CMAdministrativeUser -Name "contoso\admin1" | Remove-CMAdministrativeUser -Force
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Forces the command to run without asking for user confirmation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify the ID of the administrative user to remove. This value is the AdminID
property. It's an integer value, for example 16777234
.
Type: String
Parameter Sets: SearchByIdMandatory
Aliases: AdminId
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify an administrative user object to remove. To get this object, use the Get-CMAdministrativeUser cmdlet.
Type: IResultObject
Parameter Sets: SearchByValueMandatory
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specify the name of the administrative user to remove. For example, domain\username
or domain\groupname
You can use wildcard characters:
*
: Multiple characters?
: Single character
Type: String
Parameter Sets: SearchByName
Aliases: DisplayName, LogonName, UserName
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Remove-CMSecurityRoleFromAdministrativeUser