Get-SCOMConnector

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-SCOMConnector

Gets the specified connectors.

Syntax

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

Parameter Set: FromConnectorDisplayName
Get-SCOMConnector [[-DisplayName] <String> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

Parameter Set: FromConnectorId
Get-SCOMConnector [[-Id] <Guid> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-SCSession <Connection> ] [ <CommonParameters>]

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

Detailed Description

The Get-SCOMConnector cmdlet gets the specified connectors.

Parameters

-ComputerName<String>

Specifies the name of a computer to establish a connection with. The computer must be running the System Center Data Access Service. The default value is the computer for the current management group connection. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name. To specify the local computer, type the computer name, "localhost", or a dot (.).

-Credential<PSCredential>

Specifies a user account under which the management group connection will run. The default is the current user. Type a user name, such as "User01", "Domain01\User01", or "User@Domain.com", or enter a PSCredential object, such as one returned by the Get-Credential cmdlet. When you type a user name, you will be prompted for a password. For more information, type Get-Help Get-Credential.

-DisplayName<String>

Specifies the display name of an object. This parameter takes one or more strings and will look for matches in the DisplayName property of the given objects that this cmdlet works with. DisplayName values may vary depending on which localized management packs are imported into the management group and the locale of the user running Windows PowerShell.

-Id<Guid>

Retrieves the connector with the specified GUID. The Id is stored in the Id property of the object that represents an SCOM connector. To get the Id of a connector, type "Get-SCOMConnector | Format-Table Name, Id".

-Name<String>

Specifies the name of an object.

This parameter takes one or more strings and will look for matches in the Name property of the given objects that this cmdlet works with.

-SCSession<Connection>

Specifies a connection to a management server. The default is the current management group connection. Specify a Management group connection object, such as one returned by the Get-SCOMManagementGroupConnection cmdlet.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

This command gets all connectors that have a display name beginning with "Connector".

PS C:\>Get-SCOMConnector -DisplayName Connector*

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

This command gets all connectors that have a name that begins with "Operations Manager".

PS C:\>Get-SCOMConnector -Name "Operations Manager*"

-------------------------- EXAMPLE 3 --------------------------

Description

-----------

This command gets the connector with the Id of 7413b06b-a95b-4ae3-98f2-dac9ff76dabd.

PS C:\>Get-SCOMConnector -Id 7413b06b-a95b-4ae3-98f2-dac9ff76dabd