Add-SCOMRunAsProfile

Add-SCOMRunAsProfile

Adds a Run As profile.

Syntax

Parameter Set: Empty
Add-SCOMRunAsProfile [-Name] <String> [[-DisplayName] <String> ] [[-Description] <String> ] [[-Comment] <String> ] [[-Guid] <Guid> ] -ManagementPack <ManagementPack[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Add-SCOMRunAsProfile cmdlet adds a Run As profile. A Run As profile is a group of associated Run As accounts that help manage credentials and their distribution to different computers.

Parameters

-Comment<String>

Specifies an administrative comment for the profile.

Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name (FQDN). To specify the local computer, specify the computer name, localhost, or a dot (.).

The computer must run the System Center Data Access service.

If you do not specify this parameter, the default is the computer for the current management group connection.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies the user account under which the management group connection runs. Specify a PSCredential object, such as one that the Get-Credential cmdlet returns, for this parameter. For more information about credential objects, type Get-Help Get-Credential.

This account must have access to the server that the ComputerName parameter specifies, if that parameter appears.

If you do not specify this parameter, the default is the account for the current user.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Description<String>

Specifies a description of the Run As profile. If this parameter is not specified, the default description is the description specified in the DisplayName parameter.

Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-DisplayName<String>

Specifies the display name of the Run As profile. If this parameter is not specified, the default display name is the name specified in the Name parameter.

Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Guid<Guid>

Specifies a globally unique identifier (GUID) to identify the Run As profile. If this parameter is not specified, the cmdlet generates a new GUID.

Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ManagementPack<ManagementPack[]>

Specifies an array of ManagementPack objects. The cmdlet saves the RunAs profile in these management packs. To obtain a ManagementPack object, use the Get-SCOMManagementPack cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the Run As profile.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SCSession<Connection[]>

Specifies an array of Connection objects. To get Connection objects, use the Get-SCOMManagementGroupConnection cmdlet.

If this parameter does not appear, the cmdlet uses the active persistent connection to a management group. Use the SCSession parameter to specify a different persistent connection. You can create a temporary connection to a management group by using the ComputerName and Credential parameters. For more information, type Get-Help about_OpsMgr_Connections.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

Examples

Example 1: Add a Run As profile to a management pack

This example adds a Run As profile to a management pack.

The first command gets the management packs that have names that end with DefaultUser and stores those management packs in the variable named $Mp.

The second command creates the Run As profile named Contoso.MonitoringProfile and adds the management packs stored in $Mp to it.

PS C:\> $Mp = Get-SCOMManagementPack -Name "*DefaultUser"
PS C:\> Add-SCOMRunAsProfile -Name "Contoso.MonitoringProfile" -ManagementPack $Mp

Get-SCOMManagementGroupConnection

Get-SCOMRunAsProfile

Remove-SCOMRunAsProfile

Set-SCOMRunAsProfile

Get-Credential

Get-SCOMManagementPack