Set-SCSMChannel
Sets the properties of the email notification channel in Service Manager.
Syntax
Default (Default)
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.
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.
Parameter properties
| Type: | System.String[] |
| Default value: | Localhost |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | System.Management.Automation.PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Enable
Indicates whether this cmdlet enables or disables the channel.
Parameter properties
| Type: | System.Nullable`1[System.Boolean] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RetryInterval
Specifies how many seconds to wait before retrying to send email.
Parameter properties
| Type: | System.Nullable`1[System.Int32] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ReturnAddress
Specifies the return address when it sends an email notification.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SCSession
Specifies the object that represents the session to a Service Manager management server.
Parameter properties
| Type: | Microsoft.SystemCenter.Core.Connection.Connection[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | System.Collections.Hashtable[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None.
You cannot pipe input to this cmdlet.
Outputs
None.
This cmdlet does not generate any output.