Share via

Get-SCSMChannel

  • Reference
Module:
System.Center.Service.Manager

Retrieves the email notification channels that are defined in Service Manager.

Syntax

Get-SCSMChannel
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [<CommonParameters>]

Description

The Get-SCSMChannel cmdlet retrieves the email notification channels that are defined in Service Manager. The object returned includes the retry interval in seconds, the return address of the email, the status of the channel, and the list of Simple Mail Transfer Protocol (SMTP) servers.

Examples

Example 1: Get settings for the notifications channel

PS C:\>Get-SCSMChannel
DisplayName          : E-Mail Notification Channel
IsEnabled            : False
RetryIntervalSeconds : 30
ReturnAddress        : pfuller@Consoto.com

This command retrieves the settings for the email Notification channel.

Example 2: Get servers for the email notification channel

PS C:\>$EmailChannel = Get-SCSMChannel
PS C:\> $EmailChannel.ConfigurationSources | Format-Table -AutoSize
SequenceNumber Server        PortNumber Authentication
-------------- ------        ---------- --------------
0              SMTPServer1   25          WindowsIntegrated
1              SMTPServer2   25          WindowsIntegrated
2              SMTPServer3   25          WindowsIntegrated

The first command retrieves the settings for the email notification channel, and then stores them in the $EmailChannel variable.

The second command uses standard dot syntax to display the ConfigruationSources property of $EmailChannel. The command uses Format-Table to format the results.

Parameters

-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

-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

-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

Inputs

None.

You cannot pipe input to this cmdlet.

Outputs

System.NotificationChannel.SMTP.Projection

The output of this cmdlet is the SCSMChannel object that contains the SMTP settings for the email notification channel.