Remove-CMAdministrativeUser

Remove-CMAdministrativeUser

Removes Configuration Manager administrative users.

Syntax

Parameter Set: SearchByIdMandatory
Remove-CMAdministrativeUser -Id <String[]> [-Force] [-RoleName <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByNameMandatory
Remove-CMAdministrativeUser -Name <String[]> [-Force] [-RoleName <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByValueMandatory
Remove-CMAdministrativeUser -InputObject <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-CMAdministrativeUser cmdlet removes one or more Microsoft System Center 2012 SP1 Configuration Manager administrative users. When you remove an administrative user, System Center 2012 Configuration Manager revokes the access of the administrative user to manage Configuration Manager.

Parameters

-Force

Forces the command to run without asking for user confirmation.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Id<String[]>

Specifies an array of IDs for administrative users.

Aliases

AdminId

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<IResultObject>

Specifies a CMAdministrativeUser object. To obtain a CMAdministrativeUser object, use the Get-CMAdministrativeUser cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of administrative user names in the form of <domain>\<user>.

Aliases

DisplayName

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

-RoleName<String[]>

Specifies an array of names of security roles. The acceptable values for this parameter are:

-- Application Administrator
-- Application Author
-- Application Deployment Manager
-- Asset Manager
-- Compliance Settings Manager
-- Discovery Operator
-- Endpoint Protection Manager
-- Full Administrator
-- Infrastructure Administrator
-- Operating System Deployment Manager
-- Operations Administrator
-- Read-only Analyst
-- Remote Tools Operator
-- Security Administrator
-- Software Update Manager
-- custom-defined security roles

Aliases

RoleNames

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Remove an administrative user by using a wildcard character

This command removes administrative users who have the first name Evan.

PS C:\> Remove-CMAdministrativeUser -Name "Evan*"

Example 2: Remove an administrative user by using an ID

This command removes the administrative user who has the ID 16777225.

PS C:\> Remove-CMAdministrativeUser -Id "16777225"

Example 3: Remove an administrative user by using an object variable

The first command gets administrative users who have the name Evan, and then stores them in the $AdminUser variable.

The second command removes the administrative users stored in $AdminUser.

PS C:\> $AdminUser = Get-CMAdministrativeUser -Name "Evan*"
PS C:\> Remove-CMAdministrativeUser -InputObject $AdminUser

Get-CMAdministrativeUser

New-CMAdministrativeUser