Set-SCSMChannel

Sets the properties of the email notification channel in Service Manager.

Syntax

Set-SCSMChannel
   [-Enable <Boolean>]
   [-RetryInterval <Int32>]
   [-ReturnAddress <String>]
   [-SMTPServerList <Hashtable[]>]
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-SCSMChannel cmdlet sets the properties of the email notification channel in Service Manager. This cmdlet configures and enables email notifications that Service Manager sends to an SMTP server. Notification channels are the method by which Service Manager sends notification messages to users.

Examples

Example 1: Change the reply address of the channel

PS C:\>Set-SCSMChannel -ReturnAddress "Administrator@Woodgrove.com"

This command changes the replyTo address property of the email channel.

Example 2: Set the servers for the channel

PS C:\>Set-SCSMChannel -SMTPServerList @{ Server = "SMTPServer1"; Port = 25; Authentication = "Windows" },
    @{ Server = "SMTPServer2"; Port = 25; Authentication = "Windows" },
    @{ Server = "SMTPServer3"; Port = 25; Authentication = "Windows" }

This command sets the list of SMTP servers for the email channel.

Optional 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:String[]
Position:Named
Default value:Localhost
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value: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:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Enable

Indicates whether this cmdlet enables or disables the channel.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RetryInterval

Specifies how many seconds to wait before retrying to send email.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ReturnAddress

Specifies the return address when it sends an email notification.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SCSession

Specifies the object that represents the session to a Service Manager management server.

Type:Connection[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SMTPServerList

Specifies the list of SMTP servers that Service Manager uses to send email notifications. Service Manager uses the servers in the order in which they are listed. The list is an array of hash tables with the following allowed keys:

  • Server. The SMTP server to use. You must specify this key.
  • Port. The SMTP port to use. The default value is port 25.
  • Authentication. Valid values are Windows and Anonymous. The default value is Anonymous.
Type:Hashtable[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None.

You cannot pipe input to this cmdlet.

Outputs

None.

This cmdlet does not generate any output.