FPSP 2010のForefront管理シェルで使用できるコマンドレット (Set-FsspNotificationOptions) について

スポンサーリンク

Forefront Protection 2010 for SharePoint (FPSP 2010) のForefront管理シェルは、PowerShellを用いたコマンドラインインタフェースです。

Forefront管理シェルは、FPSP 2010の管理を目的として様々なコマンドレットが用意されていますが、 オンライン上では説明のみで詳細なコマンド オプション情報については公開されていないようです。

このヘルプ情報について、オンライン上で日本語として確認したいと思い、本ブログ上で纏めたいと思います (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集したものとなります)。

この記事では、「Set-FsspNotificationOptions」コマンドレットについて記載します (他のコマンドレットについては、「FPSP 2010のForefront管理シェルで使用できるコマンドレットについて」を参照)。

■名前

Set-FsspNotificationOptions

■概要

電子メール通知を送信するためのSMTP設定を設定します。

■構文

Set-FsspNotificationOptions [-EnableSharePointSmtp <Boolean>]
     [-RequireTls <Boolean>] [-SmtpPassword <string>] [-SmtpPort <UInt16>]
     [-SmtpServer <string>] [-SmtpUsername <string>] [<CommonParameters>]

■説明

■パラメーター

-EnableSharePointSmtp <Boolean>
電子メール通知を送信するために、SharePointのSMTP設定を使用するかどうかを指定します。省略可能です。指定可能な値は$falseおよび$trueです。 既定値の$trueは、電子メール通知の送信時に、SharePointのSMTP設定が使用されることを意味します。独自の設定を入力する場合は、値を$falseに変更してください。

必須false
位置named
既定値$true
パイプライン入力を許可するtrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-RequireTls <Boolean>
トランスポート層セキュリティ (TLS) がSMTPサーバーで必要かどうかを指定します。これは、-SmtpServerパラメータを使用して指定されます。省略可能です。指定可能な値は$falseおよび$trueです。既定値の$falseは、TLSがSMTPサーバーで必要ないことを意味します。

注意: -EnableSharePointSmtpを$falseに設定した場合にのみ、この設定を使用します。

必須false
位置named
既定値false
パイプライン入力を許可するtrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-SmtpPassword <string>
SMTPサーバーへのアクセスを許可する -SmtpUsernameパラメータに関連付けられるパスワードを指定します。省略可能です。値は128文字以下の文字列で指定し、スペースを含めることはできません。また、引用符で囲む必要があります。既定では空白です。セキュリティ上の理由から、入力した値は暗号化されます。

注意: -EnableSharePointSmtpを$falseに設定した場合にのみ、この設定を使用します。

必須false
位置named
既定値Empty string
パイプライン入力を許可するtrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-SmtpPort <UInt16>
SMTPサーバー ポートを指定します。省略可能です。指定可能な値の範囲は、1~65535の自然数です。既定値は25です。

注意: -EnableSharePointSmtpを$falseに設定した場合にのみ、この設定を使用します。

必須false
位置named
既定値25
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-SmtpServer <string>
SMTPサーバー アドレスを指定します。省略可能です。これは、IPアドレスまたは完全修飾ドメイン名のいずれかにすることができます。スペースを含めることはできません。また、引用符で囲む必要があります。既定値はありません。

注意: -EnableSharePointSmtpを$falseに設定した場合にのみ、この設定を使用します。

必須false
位置named
既定値Blank
パイプライン入力を許可するtrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-SmtpUsername <string>
-SmtpServerパラメータに指定されたSMTPサーバーへのアクセス権があるユーザー名を指定します。省略可能です。値は128文字以下の文字列で指定し、スペースを含めることはできません。また、引用符で囲む必要があります。既定では空白です。パスワードが必要な場合は、 -SmtpPasswordパラメータを使用して入力してください。 (パスワードは暗号化され、Get-FsspNotificationOptionsコマンドレットでは表示されません。)

注意: -EnableSharePointSmtpを$falseに設定した場合にのみ、この設定を使用します。

必須false
位置named
既定値Empty string
パイプライン入力を許可するtrue (ByPropertyName)
ワイルドカード文字を許可するfalse

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: VerboseDebugErrorActionErrorVariableWarningActionWarningVariableOutBuffer、およびOutVariable。詳細については、「get-help about_commonparameters」と入力してヘルプを参照してください。

■入力

■出力

■メモ

■例

例1

 Set-FsspNotificationOptions -EnableSharePointSmtp $false -RequireTls $true -SmtpPort 79 -SmtpServer 172.16.218.43 -SmtpUsername &quot;ourSMTPdomainTrustedUser123&quot; -SmtpPassword &quot;SecRetPaSsword9343&quot; 

例1:説明

電子メール通知を送信するためのSharePointのSMTP設定を上書きします。

コマンドが正常に完了した場合は、何も出力されません。

例2

 Set-FsspNotificationOptions -EnableSharePointSmtp $true 

例2:説明

SharePointのSMTP設定を使用します。これは既定値であるため、以前独自の設定を使用することを指定している場合にのみ、実行します。

コマンドが正常に完了した場合は、何も出力されません。

■関連するリンク

  • Get-FsspNotificationOptions
  • Get-FsspNotification
  • Set-FsspNotification

[参考]