New-SCOMConfigurationItemConnector
New-SCOMConfigurationItemConnector
Creates an Operations Manager configuration item connector in Service Manager.
Syntax
Parameter Set: Default
New-SCOMConfigurationItemConnector [-DisplayName] <String> [[-Description] <String> ] -OperationsManagerServer <String> -SCOMCredential <PSCredential> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-Enable <Boolean> ] [-ManagementPack <String[]> ] [-PassThru] [-RunAsAccount <ManagementPackSecureReference> ] [-ScheduleDay <DaySchedule> ] [-ScheduleHour <Int32> ] [-SCSession <Connection[]> ] [-SyncNow] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The New-SCOMConfigurationItemConnector cmdlet creates an Operations Manager configuration item connector in Service Manager.
Parameters
-ComputerName<String[]>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
localhost |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Description<String>
Specifies a description 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>
Indicates whether this cmdlet enables or disables the connector.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
True |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ManagementPack<String[]>
Specifies the management pack in which to store the Operations Manager configuration item connector. You cannot specify a sealed management pack.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
the default management pack |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OperationsManagerServer<String>
Specifies the name of the Operations Manager server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PassThru
Indicates that this cmdlet returns the Operations Manager configuration item connector that it creates. 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 |
-RunAsAccount<ManagementPackSecureReference>
Specifies the Run As account to use during the synchronization of the connector.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
WorkFlow RunAsAccount |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SCOMCredential<PSCredential>
Specifies the credential to use when you connect to the Operations Manager server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an object that represents a 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 in which to synchronize the connector. Valid values are:
-- Daily
-- Sunday
-- Monday
-- Tuesday
-- Wednesday
-- Thursday
-- Friday
-- Saturday
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScheduleHour<Int32>
Specifies the hour at which the connector starts synchronization. The value must be a number from zero (0) to 23.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SyncNow
Initiates synchronization of the Operations Manager configuration item connector.
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: Create a configuration item connector
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 an Operations Manager configuration item connector to the database server named OpsMgrServer. This connector is configured to synchronize every day at 1:00 am.
PS C:\>$RunAsAccount = Get-SCSMRunAsAccount -DisplayName "Workflow"
PS C:\> New-SCOMConfigurationItemConnector -DisplayName "WOODGROVE OpsMgr CI CONNECTOR" -Description "Woodgrove Operations Manager CI connection" -OperationsManagerServer "OpsMgrServer" -Enable $True -ManagementPack "Microsoft.Windows.Server.2003","Microsoft.Windows.Library" -RunAsAccount $RunAsAccount -ScheduleHour 1