Get-SCSMConnector

Retrieves connectors that are defined in Service Manager.

Syntax

Get-SCSMConnector
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Get-SCSMConnector
   [-DisplayName] <String[]>
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Get-SCSMConnector
   [-Name] <String[]>
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Get-SCSMConnector
   [-Id] <Guid[]>
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [<CommonParameters>]

Description

The Get-SCSMConnector cmdlet retrieves connectors that are defined in Service Manager. If you do not specify the Name parameter, this cmdlet gets all connectors. For each returned connector, the cmdlet displays type, name, and status information.

Examples

Example 1: Get all connectors

C:\PS>Get-SCSMConnector
Enabled              DisplayName            DataProviderName
-------              -----------            ----------------
False                SCSM Connector         SmsConnector
True                 AD Connector           ADConnector
False                AD Connector 2         ADConnector

This command retrieves all connectors and for each connector displays its status, display name, and its data provider.

Example 2: Get a specific connector

C:\PS>Get-SCSMConnector -DisplayName "SCSM*"
Enabled  DisplayName        DataProviderName
-------  -----------        ----------------
False    SCSM Connector     SmsConnector

This command retrieves all connectors whose DisplayName matches the string SCSM.

Required Parameters

-DisplayName

Specifies the display name of the connector to retrieve.

Type:String[]
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Id

Specifies the ID of the connector to retrieve.

Type:Guid[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies the name of the connector to retrieve. You can specify a regular expression.

Type:String[]
Position:0
Default value:.*
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-ComputerName

Specifies the name of the computer on which the Service Manager SDK Service runs. The user account that is defined in the Credential parameter must have access rights to the specified computer.

Type:String[]
Position:Named
Default value:Localhost
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Represents a user with the credentials to interact with Service Manager. If not properly specified, the cmdlet returns a terminating error.

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

Specifies an object that represents the session to a Service Manager management server.

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

Inputs

System.String

You can pipe a name to the Name parameter.

Inputs

System.Guid

You can pipe a GUID to the Id parameter.

Outputs

Microsoft.EnterpriseManagement.ServiceManager.Sdk.Connectors.ADConnector

This cmdlet retrieves connector objects that include the information that describes each connector and its properties.