Share via


New-SCSMUserRole

Creates a new user role in Service Manager.

Syntax

Default (Default)

New-SCSMUserRole
    [-UserRoleType] <UserRoleTypeEnum>
    -DisplayName <String>
    [-Description <String>]
    [-Class <ManagementPackClass[]>]
    [-Group <EnterpriseManagementObject[]>]
    [-CatalogGroup <EnterpriseManagementObject[]>]
    [-Queue <EnterpriseManagementObject[]>]
    [-Task <ManagementPackConsoleTask[]>]
    [-View <ManagementPackView[]>]
    [-FormTemplate <ManagementPackObjectTemplate[]>]
    [-User <String[]>]
    [-PassThru]
    [-SCSession <Connection[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-SCSMUserRole cmdlet creates a user role in Service Manager.

Examples

Example 1: Create a user role with all access

PS C:\>New-SCSMUserRole -UserRoleType ActivityImplementer -DisplayName "Role for implementers" -User "WOODGROVE\Domain Admins"

This command creates a user role which has access to all management packs, queues, groups, tasks, views, and templates. The members of the user role are Domain Admins.

Example 2: Create a read-only role for forms and views

PS C:\>New-SCSMUserRole -UserRoleType ReadOnlyOperator -DisplayName "restricted role" -Group @() -Queue @() -Task @() -User "WOODGROVE\Patti Fuller"

This command creates a read-only operator role which has access only to forms and views. The only member in the new role is Patti Fuller.

Parameters

-CatalogGroup

Specifies the Catalog Item groups that are available to members of this user role to scope access to only specific groups of catalog items. Catalog items in groups that are not specified are not available to members in this role.

Specify All to allow access to all groups. If you do not specify any value, no Catalog Item groups are available.

Parameter properties

Type:

Microsoft.EnterpriseManagement.Common.EnterpriseManagementObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Class

Specifies the instances of management pack classes to which the user role has access. This is only applicable to the Author role.

Parameter properties

Type:

Microsoft.EnterpriseManagement.Configuration.ManagementPackClass[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ComputerName

Specifies the name of the computer on which the System Center Data Access service runs. The user account that is specified in the Credential parameter must have access rights to the specified computer.

Parameter properties

Type:

System.String[]

Default value:Localhost
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

Specifies the credentials that this cmdlet uses to connect to the server on which the System Center Data Access service runs. The specified user account must have access rights to that server.

Parameter properties

Type:System.Management.Automation.PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for the user role.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

Specifies the name of the user role.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FormTemplate

Specifies the form templates that are available to the users in this user role. Forms that are not specified are not available to users in this role. Specify None to make no templates available. Specify All to make all templates available.

Parameter properties

Type:

Microsoft.EnterpriseManagement.Configuration.ManagementPackObjectTemplate[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Group

Specifies the groups that are available to members of this user role, to scope access to only specific groups of configuration items. Configuration items in groups that are not specified are not available to members in this role. Specify All to allow access to all groups. If you do not specify any value, no groups are available.

Parameter properties

Type:

Microsoft.EnterpriseManagement.Common.EnterpriseManagementObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Indicates that this cmdlet returns the user role that it creates. You can pass this object to other cmdlets.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Queue

Specifies the queues that are available to members of this user role, to scope access to only specific queues of work items. Work items in queues that are not specified are not available to members in this user role. Specify All to allow access to all queues. If you do not specify any value, no queues are available.

Parameter properties

Type:

Microsoft.EnterpriseManagement.Common.EnterpriseManagementObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SCSession

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

Parameter properties

Type:

Microsoft.SystemCenter.Core.Connection.Connection[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Task

Specifies a management pack console task. Specify this parameter only if the ManagementPack property is not $Null. The value All means that all elements are accessible, and the value None means that no elements are accessible.

Parameter properties

Type:

Microsoft.EnterpriseManagement.Configuration.ManagementPackConsoleTask[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-User

Specifies the users that will be members of the new user role.

Parameter properties

Type:

System.String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserRoleType

Specifies the type of user role to create. Valid values are:

  • ActivityImplementers
  • Administrators
  • AdvancedOperators
  • Authors
  • ChangeInitiators
  • ChangeManagers
  • EndUsers
  • IncidentResolvers
  • ProblemAnalysts
  • ReadOnlyOperators
  • Workflows

Parameter properties

Type:Microsoft.EnterpriseManagement.ServiceManager.Sdk.UserRoles.UserRoleTypeEnum
Default value:None
Accepted values:ActivityImplementer, AdvancedOperator, Author, ChangeInitiator, ChangeManager, EndUser, IncidentResolver, ProblemAnalyst, ReadOnlyOperator, ReleaseManager, ServiceRequestAnalyst
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-View

Specifies the views that are available to members of this user role, to scope access to only specific views. Views that are not specified are not available to members in this role. Specify All to allow access to all views. If you do not specify any value, no views are available.

Parameter properties

Type:

Microsoft.EnterpriseManagement.Configuration.ManagementPackView[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None.

You cannot pipe input to this cmdlet.

Outputs

None.

This cmdlet does not generate any output.