<book_title> を検索 ...

Enterprise Vault™ PowerShell Cmdlet

Last Published: 2021-04-09

Product(s): Enterprise Vault (14.1)

Set-EVSMTPServerSettings

Set-EVSMTPServerSettings は指定されたサイト内のすべての Enterprise Vault SMTP サーバーの設定を更新します。-SiteID パラメータを使ってサイト ID を指定せず、Set-EVSMTPServerSettings でサイトを判別できない場合は、サイト ID を入力するよう求められます。

サイトの SMTP サーバー設定が存在しない場合、この cmdlet は失敗します。

Set-EVSMTPServerSettings は、スナップイン Symantec.EnterpriseVault.PowerShell.AdminAPI.dll によって提供されます。

構文

Set-EVSMTPServerSettings [[-SiteId] <String>] [-Port <Integer>] [-MaxMessageSize <Integer>] [-Authentication <Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION enumeration value>] [-AuthenticationCredentials <System.Management.Automation.PSCredential>] [-AuthenticationAllowPlainText <Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT enumeration value>] [-Tls <Symantec.EnterpriseVault.Admin._EV_SMTP_TLS enumeration value>] [-TlsCertificateFile <String>] [-TlsSecurePassphrase <System.Security.SecurseString>] [-SMTPConnectionControl <Symantec.EnterpriseVault.Admin.SMTPConnectionControlList>] [-MessageTracking <Boolean>] [-IncludeSubjectLineInLogs <Boolean>] [-DaysToKeepMessageTrackingLogs <Integer>] [<CommonParameters>]

パラメータ

表: Set-EVSMTPServerSettings パラメータ

パラメータ	説明
-SiteId	SMTP 設定が適用されるサイトの ID。
-Port	サイト内の SMTP サーバーによって使用されるポート番号。
-MaxMessageSize	SMTP サーバーが受け入れる最大メッセージサイズ (MB)。SMTP サーバーは指定されたサイズより大きいメッセージを拒否します。
-Authentication	この列挙値は、SMTP サーバーへの SMTP 接続の認証を有効にするかどうかを指定します。値 EV_SMTP_AUTHENTICATION_ENABLE が指定されている場合、SMTP サーバーに接続するホストはパラメータ -AuthenticationCredentials によって指定されるクレデンシャルを提供する必要があります。値 EV_SMTP_AUTHENTICATION_DISABLE が指定されている場合、-AuthenticationCredentials は必要ありません。使用する列挙について詳しくは、get-help about_SMTPEnumerations と入力してください。
-AuthenticationCredentials	サイト内にある SMTP サーバーの認証クレデンシャル。このパラメータは、-Authentication が EV_SMTP_AUTHENTICATION_ENABLE に設定されている場合のみ必要です。
-AuthenticationAllowPlainText	SMTP サーバーへの SMTP 接続でプレーンテキスト認証を有効にするかどうかを指定する列挙値。 -Authentication が EV_SMTP_AUTHENTICATION_DISABLE に設定されている場合、この値は常に EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER に設定されます。 EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLS が指定されている場合は、SMTP サーバーで -TLS を有効化する必要があります。有効化しない場合は、該当する例外メッセージが生成されます。使用する列挙について詳しくは、PowerShell プロンプトで get-help about_SMTPEnumerations と入力してください。
-Tls	この列挙値は、サイト内の SMTP サーバーへの暗号化された接続と暗号化されていない接続のサポートを指定します。暗号化された接続に対応するプロトコルは、TLS (Transport Layer Security) です。暗号化された接続がサポートされている場合は、パラメータ -TlsCertificateFile と -TlsSecurePassphrase の値を指定する必要があります。使用する列挙について詳しくは、get-help about_SMTPEnumerations と入力してください。メモ: サーバーレベルで接続のセキュリティ設定を行っている SMTP サーバーに、サイトレベルの TLS 設定を適用することはできません。このようなサーバーにサイトレベルの設定を適用するには、［コンピュータプロパティ］の［SMTP］タブで設定を編集する必要があります。
-TlsCertificateFile	SMTP サーバーへの暗号化された接続に使用する TLS 証明書ファイルのパス。このパラメータは、暗号化されていない接続のみがサポートされている場合は必要ありません。
-TlsSecurePassphrase	SMTP サーバーへの暗号化された接続に必要な TLS 証明書ファイルのセキュアパスフレーズ。このパラメータは、暗号化されていない接続のみがサポートされている場合は必要ありません。
-SMTPConnectionControl	SMTP サーバーに接続できるホストの一覧。SMTPConnectionControlList オブジェクトについて詳しくは、get-help about_SMTPConnectionControlList と入力してください。
-MessageTracking	サイト内のすべての SMTP サーバーでメッセージ追跡を有効にするかどうかを指定します。SMTP メッセージ追跡を有効にするには、$true に設定します。メッセージ追跡を無効にするには、$false に設定します。メッセージ追跡を有効にした場合、各 SMTP サーバーが受信したメッセージの詳細が Enterprise Vault によってログに記録されます。デフォルトでは、メッセージ追跡ログファイルは各 SMTP サーバーの Enterprise Vault プログラムフォルダの `Reports\SMTP\SMTPService` に格納されます。メッセージ追跡ログファイルの場所は、Set-EVSMTPMessageTrackingLogLocation cmdlet を使用して変更できます。
-IncludeSubjectLineInLogs	メッセージ追跡ログファイルおよび DTrace ログにメッセージの件名行を記録するかどうかを指定します。件名行をログに記録するには、$true に設定します。デフォルトでは、件名行はログに記録されません ($false)。
-DaysToKeepMessageTrackingLogs	サーバーに SMTP メッセージ追跡ログファイルを保存する日数を指定します。指定された日数より古いログファイルは削除されます。1 から 999 の範囲で値を入力します。デフォルト値は 30 です。

例

Set-EVSMTPServerSettings -SiteId 13E...example.com -Authentication EV_SMTP_AUTHENTICATION_ENABLE -AuthenticationCredentials (New-Object System.Management.Automation.PSCredential -ArgumentList "user@example.com", ("admin@123" | ConvertTo-SecureString -AsPlainText -Force)) -AuthenticationAllowPlainText EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLS -Tls EV_SMTP_TLS_ENCRYP TED_AND_UNENCRYPTED -TlsCertificateFile "C:\rsa.p12" -TlsSecurePassphrase ("admin@123" | ConvertTo-SecureString -AsPlainText -Force) -MessageTracking $true -IncludeSubjectLineInLogs $true -DaysToKeepMessageTrackingLogs 40
指定したサイト内のすべての SMTP サーバーの SMTP サーバー設定を更新します。SMTP サーバーは以前に設定したポートでリッスンし、認証の有効化、暗号化された接続と暗号化されていない接続の両方のサポート、メッセージ追跡の有効化、各メッセージの件名のログへの記録を行い、ログファイルを作成日から 40 日間保持します。
C:\PS> $xConnectionList = new-object Symantec.EnterpriseVault.Admin.SMTPConnectionControlList
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAME", "Test")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMESUFFIX", "smtp.example.com")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMEPATTERN", "as-[a-z0-9]*-[a-z0-9]*.example.Local")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4", "192.168.1.1")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4INCIDR", "192.168.1.1/24")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6", "0000:0000:0000:0000:0000:0000:0000:0001")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6INCIDR", "0000:0000:0000:0000:0000:0000:0000:0001/128")
C:\PS> Set-EVSMTPServerSettings -Port 25 -Authentication EV_SMTP_AUTHENTICATION_ENABLE -AuthenticationCredentials (New-Object System.Management.Automation.PSCredential -ArgumentList "user@example.com", ("admin@123" | ConvertTo-SecureString -AsPlainText -Force)) -AuthenticationAllowPlainText EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER -Tls EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED -TlsC ertificateFile "C:\rsa.p12" -TlsSecurePassphrase ("admin@123" | ConvertTo-SecureString -AsPlainText -Force) -SMTPConnectionControl $xConnectionList -MessageTracking $true -IncludeSubjectLineInLogs $true -DaysToKeepMessageTrackingLogs 45
C:\PS> Get-EVSMTPServerSettings
```
SiteId                       : 13E...example.com
Port                         : 25
MaxMessageSize               : 0
Authentication               : EV_SMTP_AUTHENTICATION_ENABLE
AuthenticationEmailAddress   : user@example.com
AuthenticationAllowPlainText : EV_SMTP_AUTHENTICATION
                               _ALLOWPLAINTEXT_NEVER
Tls                          : EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED
TlsCertificateInfo           : Symantec.EnterpriseVault.Admin
                               .TlsCertificate
SMTPConnectionControl        : Symantec.EnterpriseVault.Admin
                               .SMTPConnectionControlList
MessageTracking              : True
IncludeSubjectLineInLogs     : True
DaysToKeepMessageTrackingLogs: 45
```
このコマンドのシーケンスは、指定されたサイト内にあるすべての SMTP サーバーについて SMTP サーバー設定を更新します。SMTP サーバーはポート 25 でリッスンし、認証の有効化、テキスト形式の認証の不許可、暗号化された接続と暗号化されていない接続の両方のサポート、メッセージ追跡の有効化、各メッセージの件名のログへの記録を行い、ログファイルを作成日から 45 日間保持します。許可された接続が、異なるアドレス形式で SMTPConnectionControlList オブジェクトに追加されます。

出力

Set-EVSMTPServerSettings は Symantec.EnterpriseVault.Admin.SMTPServerSettings の種類のオブジェクトを返します。ここには、次の表に一覧表示されているプロパティが含まれています。

表: Symantec.EnterpriseVault.Admin.SMTPServerSettings プロパティ

名前	形式	説明
Authentication	オブジェクト	Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION 列挙値: 受信接続に認証が必要かどうかを指定します。列挙値について詳しくは、PowerShell プロンプトで get-help about_SMTPEnumerations と入力してください。
AuthenticationAllowPlainText	オブジェクト	Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT 列挙値: 受信接続にプレーンテキストの認証を許可するかどうかを指定します。認証が無効な場合、この値はデフォルトで EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER に設定されます。列挙値について詳しくは、PowerShell プロンプトで get-help about_SMTPEnumerations と入力してください。
AuthenticationEmailAddress	文字列	認証が有効な場合、認証ユーザーの ID。
DaysToKeepMessageTrackingLogs	整数	サーバーで SMTP メッセージの追跡ログファイルを保持する日数。指定された日数より古いログファイルは削除されます。
IncludeSubjectLineInLogs	ブール値	メッセージ追跡ログファイルと DTrace ログにメッセージの件名を記録するかどうかを指定します。メッセージの件名をログに記録する場合は $true を設定し、記録しない場合は $false を設定します。
MaxMessageSize	整数	最大 SMTP メッセージサイズ (MB)。
MessageTracking	ブール値	メッセージ追跡を有効にするかどうかを指定します。SMTP メッセージの追跡を有効にする場合は $true を設定し、無効にする場合は $false を設定します。
Port	整数	SMTP サーバーがリッスンするポート番号。
SiteId	文字列	SMTP サーバー設定が属しているサイトの ID。
SMTPConnectionControl	オブジェクト	Symantec.EnterpriseVault.Admin.SMTPConnectionControlList: SMTP サーバーへの許可された接続の一覧を提供します。許可された接続の一覧の管理について詳しくは、PowerShell プロンプトで get-help about_SMTPConnectionControlList と入力してください。
Tls	オブジェクト	Symantec.EnterpriseVault.Admin._EV_SMTP_TLS 列挙値: SMTP サーバーへの暗号化された接続および暗号化されていない接続のサポートを指定します。列挙値について詳しくは、PowerShell プロンプトで get-help about_SMTPEnumerations と入力してください。
TlsCertificateInfo	オブジェクト	Symantec.EnterpriseVault.Admin.TlsCertificate: SMTP 接続に使われる TLS 証明書の情報を提供します。 TlsCertificate オブジェクトについて詳しくは、PowerShell プロンプトで get-help about_TlsCertificate と入力してください。