New-SCOMAlertConnector
New-SCOMAlertConnector
Creates an Operations Manager alert connector in Service Manager.
Syntax
Parameter Set: Default
New-SCOMAlertConnector [-DisplayName] <String> [[-Description] <String> ] -OperationsManagerServer <String> -SCOMCredential <PSCredential> [-CloseAlert] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-Enable <Boolean> ] [-PassThru] [-PollIntervalInSeconds <Int32> ] [-ResolveIncident] [-Rules <AlertRule[]> ] [-RunAsAccount <ManagementPackSecureReference> ] [-SCSession <Connection[]> ] [-SyncNow] [-Template <ManagementPackObjectTemplate> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The New-SCOMAlertConnector cmdlet creates an Operations Manager alert connector in Service Manager.
Parameters
-CloseAlert
Specifies that Operations Manager closes alerts after they are resolved or closed in Service Manager.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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. 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 |
-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 alert 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 |
-PollIntervalInSeconds<Int32>
Specifies the polling interval, in seconds, for the Operations Manager alert connector.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ResolveIncident
Specifies that this cmdlet configures Service Manager to automatically resolve incidents after Operations Manager closes the associated alert.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Rules<AlertRule[]>
Specifies the rules which provide routing instructions for the alerts. The rules which provide routing instructions for the alerts.
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 connector synchronization.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
Operational System Account |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SCOMCredential<PSCredential>
Specifies the credential to use when connecting to Operations Manager.
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 |
-SyncNow
Starts a synchronization of the Operations Manager alert connector.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Template<ManagementPackObjectTemplate>
Specifies the default template to use when an alert does not match a rule.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
Operations Manager Incident Template |
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 an Operations Manager alert connector
The first command gets a Run As account for AdminRA by using the Get-SCSMRunAsAccount cmdlet. The command stores the result in the $RunAsAccount variable.
The second command prompts you for credentials by using the Get-Credential cmdlet, and then stores the credentials in the $Credential variable.
The final command creates an Operations Manager alert connector which has no rules, and which uses a default template.
PS C:\> $RunAsAccount = Get-SCSMRunAsAccount -UserName "AdminRA"
PS C:\> $Credential = Get-Credential
PS C:\> New-SCOMAlertConnector -DisplayName "SCOM ALERT CONNECTOR" -OperationsManagerServer "server.contoso.com" -SCOMCredential $Credential -RunAsAccount $RunAsAccount