Get-SCSMConnector
Retrieves connectors that are defined in Service Manager.
Syntax
Empty (Default)
Get-SCSMConnector
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[<CommonParameters>]
FromEMODisplayNameParameterSetName
Get-SCSMConnector
[-DisplayName] <String[]>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[<CommonParameters>]
FromEMONameParameterSetName
Get-SCSMConnector
[-Name] <String[]>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[<CommonParameters>]
FromEMOIdParameterSetName
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.
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.
Parameter properties
| Type: | System.String[] |
| Default value: | Localhost |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Represents a user with the credentials to interact with Service Manager. If not properly specified, the cmdlet returns a terminating error.
Parameter properties
| Type: | System.Management.Automation.PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisplayName
Specifies the display name of the connector to retrieve.
Parameter properties
| Type: | System.String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromEMODisplayNameParameterSetName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
Specifies the ID of the connector to retrieve.
Parameter properties
| Type: | System.Guid[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromEMOIdParameterSetName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the connector to retrieve. You can specify a regular expression.
Parameter properties
| Type: | System.String[] |
| Default value: | .* |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromEMONameParameterSetName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SCSession
Specifies an object that represents the session to a Service Manager management server.
Parameter properties
| Type: | Microsoft.SystemCenter.Core.Connection.Connection[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
System.String
You can pipe a name to the Name parameter.
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.