Start-SCSMConnector
Start-SCSMConnector
Initiates a synchronization of a Service Manager connector.
Syntax
Parameter Set: Default
Start-SCSMConnector [-Connector] <Connector[]> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-SCSMConnector cmdlet initiates a synchronization of a Service Manager connector. You cannot initiate synchronization for a connector that is currently disabled.
Parameters
-Connector<Connector[]>
Specifies the connector for which this cmdlet initiates synchronization.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-PassThru
Indicates that this cmdlet returns the connector that it synchronized. You can pass this object to other cmdlets.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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 (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.
Microsoft.EnterpriseManagement.ServiceManager.Sdk.Connectors.Connector
You can pipe a connector to the Connector parameter.
Outputs
The output type is the type of the objects that the cmdlet emits.
None.
This cmdlet does not generate any output.
Examples
Example 1: Start a connector synchronization
This command gets the connector by using the Get-SCSMConnector cmdlet. The command passes that result to the current cmdlet by using the pipeline operator. That cmdlet starts synchronization for that connector.
PS C:\>Get-SCSMConnector | Start-SCSMConnector