Get-SCUserRole

Get-SCUserRole

Gets a VMM user role.

Syntax

Parameter Set: Default
Get-SCUserRole [[-Name] <String> ] [-ID <Guid]> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-UserRoleProfile <Profile]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Get-SCUserRole cmdlet gets one or more Virtual Machine Manager (VMM) user roles. VMM uses role-based security to define the boundaries within which members of a given user role can operate and the set of allowed operations members of a user role can perform.

For information about creating user roles, type Get-Help New-SCUserRole -detailed.

For information about setting the properties of a user role, including the scope for delegated and read-only administrators and the scope and actions for self-service users, type Get-Help Set-SCUserRole -detailed.

Parameters

-ID<Guid]>

Specifies the numerical identifier as a globally unique identifier (GUID) for a specific object.

-Name<String>

Specifies the name of a VMM object.

-OnBehalfOfUser<System.String>

-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>

-UserRoleProfile<Profile]>

Specifies the type of profile to use as the basis for the user role. Valid values are:

-- DelegatedAdmin
-- ReadOnlyAdmin
-- SelfServiceUser

-VMMServer<ServerConnection>

Specifies a VMM server object.

<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.

• UserRole

Examples

Example 1: Get all VMM user roles

This command gets all VMM user role objects on VMMServer01 and displays information about each user role.

PS C:\> Get-SCUserRole -VMMServer "VMMServer01.Contoso.com"

Example 2: Get a specific user role by name

This command gets the user role object named Administrator, and then displays information about that user role.

PS C:\> Get-SCUserRole -Name "Administrator"

Example Example 3: Get a specific user role by UserRoleProfile.

This command gets the user role objects on VMMServer01 that have a UserRoleProfile value of SelfServiceUser, and then displays information about these users role.

PS C:\> Get-SCUserRole -VMMServer "VMMServer01.Contoso.com" -UserRoleProfile "SelfServiceUser"

Example Example 4.: Display properties and other information about user role objects.:

The first command gets all user role objects on VMMServer01, and then stores the objects in the $UserRoles variable.

The second command passes each user role object in $UserRoles to select, the alias for the Select-Object cmdlet, and then displays the name, user role profile, parent user role, and cloud for each user role.

The last command passes each user role in $UserRoles to the Get-Member cmdlet, which displays the .NET type for each user role and the methods and properties associated with each user role type.

PS C:\> $UserRoles = Get-SCUserRole -VMMServer "VMMServer01.Contoso.com"
PS C:\> $UserRoles | select Name, UserRoleProfile, ParentUserRole, Cloud
PS C:\> $UserRoles | Get-Member

Related topics

Grant-SCResource

New-SCUserRole

Remove-SCUserRole

Revoke-SCResource

Set-SCUserRole