New-SCCMConnector
New-SCCMConnector
Creates a new Configuration Manager connector in Service Manager.
Syntax
Parameter Set: Default
New-SCCMConnector [-DisplayName] <String> [[-Description] <String> ] -DatabaseName <String> -DatabaseServer <String> -SCCMCredential <PSCredential> [-Collections <String[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-Enable <Boolean> ] [-PassThru] [-RunAsAccount <ManagementPackSecureReference> ] [-ScheduleDay <DaySchedule> ] [-ScheduleHour <Int32> ] [-SCSession <Connection[]> ] [-SolutionManagementPack <ManagementPack[]> ] [-SyncNow] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The New-SCCMConnector cmdlet creates a new Configuration Manager connector in Service Manager.
Parameters
-Collections<String[]>
Specifies the name of the Configuration Manager collections to synchronize.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
All Collections |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String[]>
Specifies the name of the computer on which the System Center Data Access service runs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
localhost |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the credentials to use when you connect to the Service Manager management server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-DatabaseName<String>
Specifies the name of the Configuration Manager database.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DatabaseServer<String>
Specifies the name of the Configuration Manager database server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Description<String>
Provides the unique descriptive text for the connector.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DisplayName<String>
Specifies the name of the connector.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Enable<Boolean>
Enables or disables the connector.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
True |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object that represents the new Configuration Manager connector. This output object can be passed to other cmdlets.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsAccount<ManagementPackSecureReference>
Specifies the Run As account that the connector will use when it runs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
Operational System Account |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SCCMCredential<PSCredential>
Specifies the credential to use when you connect to the Configuration Manager server to validate the collections that have to be synchronized.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-ScheduleDay<DaySchedule>
Specifies the day of the week on which the connector will synchronize. Allowed values are All, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
All |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScheduleHour<Int32>
Specifies the hour at which the connector will start synchronization. The value must be a number between 0-23.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
2 |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SolutionManagementPack<ManagementPack[]>
Specifies the SolutionName for the SCCMConnector
cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SyncNow
Starts a Connection Manager connector synchronization.
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.
None.
You cannot pipe input to this cmdlet.
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 --------------------------
This 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..
PS C:\> $RA = Get-SCSMRunAsAccount Workflow
PS C:\>$arguments = @{
>> DisplayName = "WOODGROVE CM CONNECTOR"
>> Description = "Descriptive text for my configuration manager connector"
>> RunAsAccount = $RA
>> Enable = $true
>> DatabaseServer = "CMServer"
>> DatabaseName = "SMS_DFD"
>> Collections = "SCCMDF"
>> ScheduleDay = "Sunday"
>> ScheduleHour = 3
>> }
PS C:\>New-SCCMConnector @arguments