Get-SCSMUserRole

Get-SCSMUserRole

Retrieves user roles that are defined in Service Manager.

Syntax

Parameter Set: FromDisplayName
Get-SCSMUserRole [[-DisplayName] <String[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromId
Get-SCSMUserRole [-Id] <Guid[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromName
Get-SCSMUserRole [-Name] <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Detailed Description

The Get-SCSMUserRole cmdlet retrieves user role profiles that are defined in Service Manager. You can then use this list to add users to one of the user role profiles. Optionally, you can provide a regular expression to search for a specific user role profile.

Parameters

-ComputerName<String[]>

Specifies the name of the computer that contains an instance of Service Manager from which to retrieve user roles.

-Credential<PSCredential>

Specifies the credential to use when you are connecting to the Service Manager management server.

-DisplayName<String[]>

Specifies the display name of the user role to retrieve. This can be a regular expression.

-Id<Guid[]>

Specifies the ID of the user role to retrieve.

-Name<String[]>

Specifies the name of the user role to retrieve. This can be a regular expression

-SCSession<Connection[]>

Specifies an object that represents a session to a Service Manager management server.

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

• System.String

  You can pipe a name to the DisplayName parameter of the Get-SCSMUserRole cmdlet.

• System.Guid

  You can pipe a GUID to the Id parameter of the Get-SCSMUserRole cmdlet.

Outputs

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

• Microsoft.EnterpriseManagement.ServiceManager.Sdk.UserRoles.Role

  The UserRole object provides the information about the Service Manager User Roles. This object can be used in conjunction with the Set-SCSMUser cmdlet to add a user to a user role.

Examples

-------------------------- EXAMPLE 1 --------------------------

This command retrieves the list of user roles from the local system.

PS C:\>Get-SCSMUserRole

-------------------------- EXAMPLE 2 --------------------------

This command retrieves the Administrators user role.

PS C:\>Get-SCSMUserRole Administrators

-------------------------- EXAMPLE 3 --------------------------

This command retrieves the Administrators user role from the Service Manager instance that is running on the computer WIN-752HJBSX24M.

PS C:\>Get-SCSMUserRole -Name Administrators -computerName WIN-752HJBSX24M

-------------------------- EXAMPLE 4 --------------------------

This command displays the available classes of a particular user role.

PS C:\>$role = Get-SCSMUserRole -Name CustomRole
PS C:\>$role

PS C:\> $Role.Classes
PS C:\>$r.Classes

Related topics

New-SCSMUserRole

Remove-SCSMUserRole

Update-SCSMUserRole