Share via

Start-SCSMConnector

Module:
System.Center.Service.Manager Module

Initiates a synchronization of a Service Manager connector.

Syntax

Default (Default) 

Start-SCSMConnector
    [-Connector] <Connector[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Start-SCSMConnector cmdlet initiates a synchronization of a Service Manager connector. You cannot initiate synchronization for a connector that is currently disabled.

Examples

Example 1: Start a connector synchronization

PS C:\>Get-SCSMConnector -DisplayName MyAD | Start-SCSMConnector

This command gets the connector with name MyAD 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.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Connector

Specifies the connector for which this cmdlet initiates synchronization.

Parameter properties

Type:

Microsoft.EnterpriseManagement.ServiceManager.Sdk.Connectors.Connector[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Indicates that this cmdlet returns the connector that it synchronized. You can pass this object to other cmdlets.

Parameter properties

Type:System.Management.Automation.SwitchParameter
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

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

Microsoft.EnterpriseManagement.ServiceManager.Sdk.Connectors.Connector

You can pipe a connector to the Connector parameter.

Outputs

None.

This cmdlet does not generate any output.