.png)
Get-SCSMChannel
Updated: January 14, 2013
Applies To: System Center 2012 - Service Manager, System Center 2012 SP1 - Service Manager
Get-SCSMChannel
Syntax
Parameter Set: Default Get-SCSMChannel [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Detailed 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.
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.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
localhost |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the credentials to use when connecting to the server on which the System Center Data Access service is running. The provided user account must have access to that server.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an object that represents the session to a Service Manager management server.
|
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.
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.
-
System.NotificationChannel.SMTP.Projection
The output of this cmdlet is the SCSMChannel object that contains the SMTP settings for the Email Notification channel.
Examples
-------------------------- EXAMPLE 1 --------------------------
This command retrieves the settings for the Email Notification channel.
PS C:\>Get-SCSMChannel
DisplayName : E-Mail Notification Channel
IsEnabled : False
RetryIntervalSeconds : 30
ReturnAddress : potten@Woodgrove.com
-------------------------- EXAMPLE 2 --------------------------
This command retrieves the list of the Email servers for the Email Notification channel.
PS C:\>$emailChannel = Get-SCSMChannel PS C:\>$emailChannel.ConfigurationSources|format-table -au
SequenceNumber Server PortNumber Authentication
-------------- ------ ---------- --------------
0 SMTPServer1 25 WindowsIntegrated
1 SMTPServer2 25 WindowsIntegrated
2 SMTPServer3 25 WindowsIntegrated
