Get-SCOMNotificationChannel
Get-SCOMNotificationChannel
Retrieves notification channels for the management group.
Syntax
Parameter Set: Empty
Get-SCOMNotificationChannel [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromDisplayName
Get-SCOMNotificationChannel [-DisplayName] <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Detailed Description
The Get-SCOMNotificationChannel cmdlet retrieves the notification channels for the management group. Notification channels inform administrators of an alert, or they run automation in response to an alert. A notification channel uses a delivery mechanism in System Center 2012 – Operations Manager, such as email, instant message, Short Message Service, or command, to deliver notifications.
Parameters
-ComputerName<String[]>
Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. You can use NetBIOS names, IP addresses, or fully qualified domain names (FQDNs). To specify the local computer, type the computer name, localhost, or a dot (.).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies a PSCredential object for the management group connection. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type "Get-Help Get-Credential". If you specify a computer in the ComputerName parameter, use an account that has access to that computer. The default is the current user.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-DisplayName<String[]>
Specifies the display name of a channel.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an array of Connection objects. To obtain a Connection object, use the Get-SCManagementGroupConnection cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Get all notification channels
This command gets all notification channels.
PS C:\> Get-SCOMNotificationChannel
Example 2: Get notification channels by using a display name
This command gets the notification channel named Email channel.
PS C:\> Get-SCOMNotificationChannel -DisplayName "Email channel"
Example 3:Get notification channels by using a name
This command gets the notification channel named MyCustomChannel.
PS C:\> Get-SCOMNotificationChannel -DisplayName "MyCustomChannel"