Share via


Get-SCOMGatewayManagementServer

Gets the gateway management servers in a management group.

Syntax

Get-SCOMGatewayManagementServer
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Get-SCOMGatewayManagementServer
   [[-Name] <String[]>]
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [<CommonParameters>]

Description

The Get-SCOMGatewayManagementServer cmdlet gets the gateway management servers in a management group.

By default, this 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.

Examples

Example 1: Get gateway management servers by using names

PS C:\>Get-SCOMGatewayManagementServer -Name "Server01.ContosoPartner.com","*.Contoso.com"

This command gets the gateway management server named Server01.ContosoPartner.com and all gateway management servers that are in the Contoso.com ___domain.

Example 2: Get gateway management servers for a different management group

PS C:\>Get-SCOMGatewayManagementServer -ComputerName "Server01.Contoso.com"

This command gets the gateway management servers for a management group that the server Server01.Contoso.com belongs to. Because the command does not include the Credential parameter, the current user must have access rights for Server01.Contoso.com.

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 running 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 a PSCredential object for the management group connection. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, 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

-Name

Specifies an array of names for gateway management servers. You can use wildcards.

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

-SCSession

Specifies an array of Connection objects. To obtain a Connection object, use the Get-SCOMManagementGroupConnection cmdlet.

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