Set-SCSMChannel

Set-SCSMChannel

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

Syntax

Parameter Set: Default
Set-SCSMChannel [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-Enable <Null> ] [-RetryInterval <Null> ] [-ReturnAddress <String> ] [-SCSession <Connection[]> ] [-SMTPServerList <Hashtable[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

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

Parameters

-ComputerName<String[]>

Specifies the name of the computer on which the System Center Data Access service is running. The user account that is defined in the Credential parameter must have access rights to the specified computer.

-Credential<PSCredential>

Specifies the credentials to use when you connect to the server on which the System Center Data Access service is running. The provided user account must have access to that server. The default value for this parameter is the user account of the current context.

-Enable<Null>

Enables or disables the channel.

-RetryInterval<Null>

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

-ReturnAddress<String>

Specifies the return email address when sending an email notification.

-SCSession<Connection[]>

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

-SMTPServerList<Hashtable[]>

The list of SMTP servers that will be used to send email notifications. The servers will be used in the order that they are listed. The list is an array of hash tables with the following allowed keys:

Server = The SMTP server to use. Server must be provided. If Server is not provided or is not valid, a terminating error is generated.
Port = The SMTP port to use. Default value is port 25.
Authentication = Must be either 'Windows' or 'Anonymous'. Default value is 'Anonymous'.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<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 --------------------------

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

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

-------------------------- EXAMPLE 2 --------------------------

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

PS C:\>Set-SCSMChannel -SMTPServerList @{

       Server = "SMTPServer1"; Port = 25; Authentication = "Windows" },

    @{ Server = "SMTPServer2"; Port = 25; Authentication = "Windows" },

    @{ Server = "SMTPServer3"; Port = 25; Authentication = "Windows" }

Related topics

Get-SCSMChannel