Remove-SCUserRole

Applies To: System Center 2012 - Virtual Machine Manager

Remove-SCUserRole

Removes an existing user role.

Syntax

Parameter Set: Default
Remove-SCUserRole [-UserRole] <UserRole> [-JobGroup <Guid> ] [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]

Detailed Description

The Remove-SCUserRole cmdlet removes an existing user role from System Center Virtual Machine Manager (VMM). You can remove the following roles: Delegated Administrator, Read-Only Administrator, or Self-Service User. Howerver, you cannot remove the Administrator role.

For more information about Remove-SCUserRole, type "Get-Help Remove-SCUserRole -online".

Parameters

-JobGroup<Guid>

Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserRole<UserRole>

Specifies a user role object.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

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

1: Remove the specified user role.

The first command gets the user role object named ContosoDelegatedAdmin and stores the object in the $UserRole variable.

The second command removes the "Contoso Admin" user role from the VMM database.

PS C:\> $UserRole = Get-SCUserRole -Name "ContosoDelegatedAdmin"
PS C:\> Remove-SCUserRole -UserRole $UserRole

Get-SCUserRole

New-SCUserRole

Set-SCUserRole