Export (0) Print
Expand All
Expand Minimize

Get-SCOMGatewayManagementServer

Updated: January 26, 2014

Applies To: System Center 2012 R2 Operations Manager

Get-SCOMGatewayManagementServer

Gets the gateway management servers in a management group.

Syntax

Parameter Set: Empty
Get-SCOMGatewayManagementServer [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromGatewayManagementServerNames
Get-SCOMGatewayManagementServer [[-Name] <String[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]




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

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


Aliases

none

Required?

false

Position?

named

Default Value

localhost

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

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


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

true

-SCSession<Connection[]>

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


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.

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: Get gateway management servers by using names

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


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

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

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.


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

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft