Share via

Get-SCOMRunAsDistribution

  • Reference
Module:
OperationsManager

Gets the distribution policy of an Operations Manager Run As account.

Syntax

Get-SCOMRunAsDistribution
   [-RunAsAccount] <SecureData[]>
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [<CommonParameters>]

Description

The Get-SCOMRunAsDistribution cmdlet gets the distribution policy of a System Center 2016 - Operations Manager Run As account. Distribution policies determine which computers receive a Run As account credential.

Due to the default formatting behavior of Windows PowerShell, the console does not always display the list of approved distribution computers. To see the full list, save the output of this cmdlet to a variable, then inspect the SecureDistribution property of the SCOMRunAsDistribution object that is stored in the variable.

Examples

Example 1: Get the distribution policy for an account

PS C:\>Get-SCOMRunAsAccount "Contoso\Administrator" | Get-SCOMRunAsDistribution

This command displays the distribution policy for the Contoso\Administrator account.

Example 2: Get systems approved for distribution in a distribution policy

PS C:\>Get-SCOMRunAsAccount "Contoso\Administrator" | Get-SCOMRunAsDistribution | Tee-Object -Variable Distribution
PS C:\> $Distribution.SecureDistribution

This example displays the distribution policy for an account and lists the systems that are approved for distribution.

The first command gets the Contoso\Administrator account and passes that account to the Get-SCOMRunAsDistribution by using the pipeline operator. The command uses the pipeline operator to pass the distribution policy to the Tee-Object cmdlet, which displays it to the console, as well as saving it in the $Distribution variable. For more information, type Get-Help Tee-Object.

The second command displays the systems approved for distribution.

Parameters

-ComputerName

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 System Center Data Access service must be started on the computer. If you do not specify a computer, the cmdlet uses the computer for the current management group connection.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

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.

If you specify a computer in the ComputerName parameter, use an account that has access to that computer. The default is the current user.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsAccount

Specifies an array of SecureData objects that represent Run As accounts. To obtain a SecureData object, use the Get-SCOMRunAsAccount cmdlet. This account cannot be part of a Run As profile.

Type:SecureData[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SCSession

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

If this parameter is not specified, 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.

Type:Connection[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False