Share via


Get-SCSMEmailTemplate

Get-SCSMEmailTemplate

Retrieves email templates that are defined in Service Manager.

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. This cmdlet returns only objects of the class SMTP.

Parameters

-ComputerName<String[]>

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.

Aliases

none

Required?

false

Position?

named

Default Value

localhost

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

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.

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

  • Microsoft.EnterpriseManagement.ServiceManager.Sdk.Notifications.EmailTemplate

    This cmdlet returns email template objects.

Examples

Example 1: Get all templates

This command retrieves all email templates from Service Manager.

C:\PS>Get-SCSMEmailTemplate

Example 2: Display names and targeted classes

This command retrieves the email templates, and passes them to the Format-Table cmdlet. That cmdlet displays the display name and the targeted class for the templates. The results could be passed to the New-SCSMSubscription cmdlet.

C:\PS>Get-SCSMEmailTemplate | Format-Table -Property DisplayName,TargetClass -AutoScale

Format-Table

Get-SCSMEmailTemplateContent

New-SCSMEmailTemplate

New-SCSMSubscription

Remove-SCSMEmailTemplate

Update-SCSMEmailTemplate