Get-SCSMEmailTemplate
Updated: January 14, 2013
Applies To: System Center 2012 - Service Manager, System Center 2012 SP1 - Service Manager
Get-SCSMEmailTemplate
Syntax
Parameter Set: Default Get-SCSMEmailTemplate [[-DisplayName] <String> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-Description <String> ] [-ManagementPack <ManagementPack> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Detailed Description
The Get-SCSMEmailTemplate cmdlet retrieves Email templates that are defined in Service Manager. The type of the returned object is ManagementPackObjectTemplate, and only objects of the class SMTP are returned.
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 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.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-Description<String>
Specifies the description of the Email template to retrieve.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-DisplayName<String>
Specifies the display name of the Email template to retrieve.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ManagementPack<ManagementPack>
Specifies the management packs in which Email templates to retrieve are defined.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
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.
-
Microsoft.EnterpriseManagement.ServiceManager.Sdk.Notifications.EmailTemplate
This cmdlet returns email template objects.
Examples
------------------------- EXAMPLE 1 --------------------------
This command retrieves all Email templates from Service Manager.
C:\PS>Get-SCSMEmailTemplate
DisplayName Description ManagementPack TimeAdded LastModified
----------- ----------- -------------- --------- ------------
Assigned To User Not Use for notification Service Manager Inci 12/2/2010 12:22:15 A 12/3/2010 12:56:15 A
ification Template s sent to the user w dent Management Conf M M
ho is assigned the i iguration Library
ncident
End User Notificatio Use for notification Service Manager Inci 12/2/2010 12:22:15 A 12/3/2010 12:01:50 A
n Template s sent to end users dent Management Conf M M
iguration Library
Assigned To User Not Use for notification Service Manager Chan 12/2/2010 12:21:55 A 12/2/2010 12:21:55 A
ification Template s sent to the user w ge Management Config M M
ho is assigned the c uration Library
hange request
Escalation Notificat Use for notification Service Manager Inci 12/2/2010 12:22:15 A 12/3/2010 12:01:50 A
ion Template s sent when an incid dent Management Conf M M
ent is escalated iguration Library
------------------------- EXAMPLE 2 --------------------------
This command retrieves and then displays the DisplayName and the targeted class of the specified template, which can then be piped to the New-SCSMSubscription cmdlet.
C:\PS>Get-SCSMEmailTemplate|format-table DisplayName,TargetClass -au
DisplayName TargetClass
----------- -----------
Assigned To User Notification Template System.WorkItem.Incident
End User Notification Template System.WorkItem.Incident
Assigned To User Notification Template System.WorkItem.ChangeRequest
Escalation Notification Template System.WorkItem.Incident
Printer Email Template Microsoft.AD.Printer
