Get-SCSMConnector
Get-SCSMConnector
Gets the connectors that are currently installed on the Service Manager server.
Syntax
Parameter Set: Default
Get-SCSMConnector [[-Name] <String[]> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Detailed Description
This cmdlet retrieves the connectors that are currently installed on the system. If the Name parameter is omitted, then all connectors are retrieved. If the Name parameter is specified, the specified value is interpreted as a regular expression. All connectors whose Name or DisplayName property matches the regular expression are returned. 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 is running. The default value is "localhost". 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? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the credentials to use when you connect to the server on which the Service Manager SDK Service is running. The provided user account must have access to that server. The default value for this parameter is the user account of the current context.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the name of the connector. This can be a regular expression.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
.* |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Automation.Management.PSCustomObject
The connector object contains the information that describes the connector and its properties.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This command returns the list of connectors, including their state and data providers.
C:\PS>Get-SCSMConnector
Enabled DisplayName DataProviderName
------- ----------- ----------------
False SCSM Connector SmsConnector
True AD Connector ADConnector
False AD Connector 2 ADConnector
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This command returns the list of connectors whose Name or DisplayName property matches the "SCSM" string.
C:\PS>Get-SCSMConnector SCSM
Enabled DisplayName DataProviderName
------- ----------- ----------------
False SCSM Connector SmsConnector
Related topics
Getting Started with Service Manager Cmdlets for Windows PowerShell