Get-SCSMConnector
Get-SCSMConnector
Retrieves connectors that are defined in Service Manager.
Syntax
Parameter Set: FromEMODisplayNameParameterSetName
Get-SCSMConnector [-DisplayName] <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromEMOIdParameterSetName
Get-SCSMConnector [-Id] <Guid[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromEMONameParameterSetName
Get-SCSMConnector [-Name] <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Detailed 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.
Parameters
-ComputerName<String[]>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
localhost |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Represents a user with the credentials to interact with Service Manager. If not properly specified, the cmdlet returns a terminating error.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-DisplayName<String[]>
Specifies the display name of the connector to retrieve.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Id<Guid[]>
Specifies the ID of the connector to retrieve.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the name of the connector to retrieve. You can specify a regular expression.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
.* |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an object that represents the session to a Service Manager management server.
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
System.String
You can pipe a name to the Name parameter.
System.Guid
You can pipe a GUID to the Id parameter.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.EnterpriseManagement.ServiceManager.Sdk.Connectors.ADConnector
This cmdlet retrieves connector objects that include the information that describes each connector and its properties.
Examples
Example 1: Get all connectors
This command retrieves all connectors and for each connector displays its status, display name, and its data provider.
C:\PS>Get-SCSMConnector
Example 2: Get a specific connector
This command retrieves all connectors whose DisplayName matches the string SCSM.
C:\PS>Get-SCSMConnector -DisplayName "SCSM*"