Share via

New-SCCMConnector

  • Reference
Module:
System.Center.Service.Manager

Creates a new Configuration Manager connector in Service Manager.

Syntax

New-SCCMConnector
   -SCCMCredential <PSCredential>
   [-Collections <String[]>]
   -DatabaseName <String>
   -DatabaseServer <String>
   [[-Description] <String>]
   [-Enable <Boolean>]
   [-DisplayName] <String>
   [-PassThru]
   [-RunAsAccount <ManagementPackSecureReference>]
   [-ScheduleDay <DaySchedule>]
   [-ScheduleHour <Int32>]
   [-SolutionManagementPack <ManagementPack[]>]
   [-SyncNow]
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-SCCMConnector cmdlet creates a Configuration Manager connector in Service Manager.

Examples

Example 1: Create a connector

PS C:\>$RunAsAccount = Get-SCSMRunAsAccount -DisplayName "Workflow Account"
PS C:\> New-SCCMConnector -DisplayName "WOODGROVE CM CONNECTOR" -Description "Woodgrove Configuration Manager connection" -DatabaseName "SMS_DFD" -DatabaseServer "CMServer" -Collections "SCCMDF" -RunAsAccount $RunAsAccount -ScheduleDay Sunday -ScheduleHour 3

The first command gets a Run As account for Workflow Account by using the Get-SCSMRunAsAccount cmdlet. The command stores the result in the $RunAsAccount variable.

The second command creates a Configuration Manager connector to the database server CMServer. The new connector is configured to synchronize every Sunday at 3:00 A.M.

Parameters

-Collections

Specifies the name of the Configuration Manager collections to synchronize.

Type:System.String[]
Position:Named
Default value:All Collections
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies the name of the computer on which the System Center Data Access service runs. The user account that is specified in the Credential parameter must have access rights to the specified computer.

Type:System.String[]
Position:Named
Default value:Localhost
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:System.Management.Automation.SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies the credentials that this cmdlet uses to connect to the server on which the System Center Data Access service runs. The specified user account must have access rights to that server.

Type:System.Management.Automation.PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DatabaseName

Specifies the name of the Configuration Manager database.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DatabaseServer

Specifies the name of the Configuration Manager database server.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the connector.

Type:System.String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

Specifies the name of the connector.

Type:System.String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Enable

Indicates whether this cmdlet enables or disables the connector.

Type:System.Boolean
Position:Named
Default value:True
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsAccount

Specifies the Run As account that the connector uses when it runs.

Type:Microsoft.EnterpriseManagement.Configuration.ManagementPackSecureReference
Position:Named
Default value:Operational System Account
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SCCMCredential

Specifies the credential to use when you connect to the Configuration Manager server to validate the collections that the connector synchronizes.

Type:System.Management.Automation.PSCredential
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ScheduleDay

Specifies the day of the week on which the connector synchronizes. Valid values are:

  • Daily
  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
Type:Microsoft.EnterpriseManagement.ServiceManager.Sdk.Connectors.DaySchedule
Accepted values:Daily, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
Position:Named
Default value:All
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScheduleHour

Specifies the hour at which the connector starts synchronization. The value must be a number between 0-23.

Type:System.Int32
Position:Named
Default value:2
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SCSession

Specifies an object that represents the session to a Service Manager management server.

Type:Microsoft.SystemCenter.Core.Connection.Connection[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SolutionManagementPack

Specifies the solution name.

Type:Microsoft.EnterpriseManagement.Configuration.ManagementPack[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SyncNow

Indicates that this cmdlet starts a Connection Manager connector synchronization.

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:System.Management.Automation.SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None.

You cannot pipe input to this cmdlet.

Outputs

None.

This cmdlet does not generate any output.