Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-SCSMUserRole

Updated: November 1, 2013

Applies To: System Center 2012 - Service Manager, System Center 2012 R2 Service Manager, System Center 2012 SP1 - Service Manager

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.


Aliases

none

Required?

false

Position?

named

Default Value

localhost

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-DisplayName<String[]>

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


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Id<Guid[]>

Specifies the ID of the user role to retrieve.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

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


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-SCSession<Connection[]>

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


Aliases

none

Required?

false

Position?

named

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.

  • 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
Name                          Description                   LastModified                  LastModifiedBy
---- ----------- ------------ --------------
ChangeManagers The Service Manager Change... 6/14/2010 5:14:16 AM
IncidentResolvers The Service Manager Incide... 6/14/2010 5:14:16 AM
ActivityImplementers The Service Manager Activi... 6/14/2010 5:14:15 AM
Workflows The Service Manager Workfl... 6/14/2010 5:14:16 AM
Administrators The Service Manager Admini... 6/14/2010 5:14:16 AM
ProblemAnalysts The Service Manager Proble... 6/14/2010 5:14:16 AM
AdvancedOperators The Service Manager Advanc... 6/14/2010 5:14:16 AM
Authors The Service Manager Author... 6/14/2010 5:14:16 AM
ChangeInitiators The Service Manager Change... 6/14/2010 5:14:16 AM
ReadOnlyOperators The Service Manager Read-O... 6/14/2010 5:14:16 AM
EndUsers The Service Manager End Us... 6/14/2010 5:14:16 AM

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

This command retrieves the Administrators user role.


PS C:\>Get-SCSMUserRole Administrators
Name                          Description                   LastModified                  LastModifiedBy
---- ----------- ------------ --------------
Administrators The Service Manager Admini... 6/14/2010 5:14:16 AM

-------------------------- 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
Name                          Description                   LastModified                  LastModifiedBy
---- ----------- ------------ --------------
Administrators The Service Manager Admini... 6/14/2010 5:14:16 AM

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

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


PS C:\>$role = Get-SCSMUserRole -Name CustomRole
PS C:\> $role
DisplayName                   Description                    LastModified                  LastModifiedBy
----------- ----------- ------------ --------------
CustomRole Custom Description 8/6/2010 12:23:46 AM WOODGROVE\Administrator
PS C:\> $Role.Classes
PS C:\> $r.Classes
Abstract Name                                                                DisplayName
-------- ---- -----------
True Microsoft.SystemCenter.ServiceDesigner.Messaging.Storage Storage
True Microsoft.SystemCenter.ServiceDesigner.ServiceComponentGroup Distributed Application Component
False Microsoft.SystemCenter.StorageDevicesGroup Storage Devices Group
True Microsoft.SystemCenter.ServiceDesigner.WebApplication Line of Business Web Application
True Microsoft.SystemCenter.ConfigItemGroup All Groups
False System.WorkItem.Incident Incident
True Microsoft.SystemCenter.ServiceDesigner.Messaging Messaging
True Microsoft.SystemCenter.InstanceGroup All Instance Groups
True Microsoft.SystemCenter.ServiceDesigner.WebApplication.WebSiteGroup Web Application Web Sites
True Microsoft.SystemCenter.ServiceDesigner.WebApplication.DatabaseGroup Web Application Databases
True Microsoft.SystemCenter.ServiceDesigner.GenericService Blank
True Microsoft.SystemCenter.ServiceDesigner.Service User Created Distributed Application
False Microsoft.SystemCenter.BusinessService Business Service

Related topics

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.