Get-SCOMRunAsProfile
Get-SCOMRunAsProfile
Gets Run As profiles.
Syntax
Parameter Set: Empty
Get-SCOMRunAsProfile [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromId
Get-SCOMRunAsProfile -Id <Guid[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromManagementPack
Get-SCOMRunAsProfile [-ManagementPack] <ManagementPack[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromRunAsProfileDisplayName
Get-SCOMRunAsProfile [-DisplayName] <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromRunAsProfileName
Get-SCOMRunAsProfile -Name <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Detailed Description
The Get-SCOMRunAsProfile cmdlet gets Run As profiles. A Run As profile is a group of associated Run As accounts that manages credentials and their distribution to different computers.
Parameters
-ComputerName<String[]>
Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. You can use NetBIOS names, IP addresses, or fully qualified domain names (FQDNs). To specify the local computer, type 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 a user account under which the management group connection runs. Specify a PSCredential object, such as one that the Get-Credential cmdlet returns, or a user name such as User01, Domain01\User01, or User@Domain.com. If you type a user name, the cmdlet prompts you for a password. For more information about credential objects, type "Get-Help Get-Credential".
This account must have access to the server that is specified in the ComputerName parameter 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 |
-DisplayName<String[]>
Specifies an array of display names for Run As profiles. The cmdlet takes each string in the array and looks for matches among the display names of the Run As profiles that this cmdlet works with. Values for this parameter vary depending on which localized management packs are imported into the management group and the locale of the user that runs Windows PowerShell.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-Id<Guid[]>
Specifies an array of IDs of Run As profiles. The cmdlet gets Run As profiles that have these IDs.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-ManagementPack<ManagementPack[]>
Specifies an array of management pack objects. The cmdlet gets the Run As profiles for the management pack objects in the array. To obtain management pack objects, use the Get-SCOMManagementPack cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of names of Run As profiles. The cmdlet takes each string in the array and looks for matches among the names of the Run As profiles that this cmdlet works with.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-SCSession<Connection[]>
Specifies an array of Connection objects. To get Connection objects, specify 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 |
<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.
- Microsoft.EnterpriseManagement.Configuration.MonitoringSecureReference
Examples
Example 1: Get Run As profiles by using a name
This command gets the Run As profiles that have names that begin with Microsoft.SystemCenter.
PS C:\> Get-SCOMRunAsProfile -Name "Microsoft.SystemCenter*"
Example 2: Get a Run As profile by using a display name
This command gets the Run As profile that has the display name Automatic Agent Management Account.
PS C:\> Get-SCOMRunAsProfile -DisplayName "Automatic Agent Management Account"
Example 3: Get a Run As profile by using an ID
This command gets the Run As profile that has the Id 7413b06b-a95b-4ae3-98f2-dac9ff76dabd.
PS C:\> Get-SCOMRunAsProfile -Id 7413b06b-a95b-4ae3-98f2-dac9ff76dabd
Example 4: Get all Run As profiles for a management pack
This command gets the management pack named System Center Core Library and uses the pipeline operator to pass that management pack object to the Get-SCOMRunAsProfile cmdlet. The cmdlet gets all Run As profiles for the management pack.
PS C:\> Get-SCOMManagementPack -DisplayName "System Center Core Library" | Get-SCOMRunAsProfile