<book_title> を検索 ...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2024-03-04

Product(s): Enterprise Vault (15.0)

Set-EVSMTPTarget

Set-EVSMTPTarget は、既存の SMTP ターゲットの指定されたプロパティを設定または更新します。-SiteID パラメータを使ってサイト ID を指定しない場合で、Set-EVSMTPTarget がサイトを判別できない場合、サイト ID を入力するよう求められます。

Set-EVSMTPTarget は、ディレクトリと、サイト内の各 Enterprise Vault SMTP サーバーで SMTP ターゲット情報を設定します。

ターゲットのアーカイブを有効にするには -ArchivingEnabled $true を、アーカイブを無効にするには -ArchivingEnabled $false を使用します。

Set-EVSMTPTarget がいずれかの Enterprise Vault SMTP サーバー上の SMTP 設定を更新できない場合、GetFailedEVServerList 機能で更新されなかったサーバーを一覧表示できます。例については、Get-EVSMTPTarget のヘルプを参照してください。

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

構文

Set-EVSMTPTarget [-SiteId] <String> [-Name] <String> [-PolicyId <String>] [-PolicyName <String>] [-RetentionCategoryId <String>] [-RetentionCategory <String>] [-RetentionPlan <String>] [-Force <Boolean>] [-ArchiveId <String>] [-ArchiveName <String>] [-ArchiveType <object>] [-ArchivingEnabled <Boolean>] [<CommonParameters>]

Set-EVSMTPTarget [-SiteId] <String> [-Name] <String> [-PolicyId <String>] [-PolicyName <String>] [-RetentionCategoryId <String>] [-RetentionCategory <String>] [-RetentionPlan <String>] [-Force <Boolean>] [-ArchiveIds <Symantec.EnterpriseVault.Admin.SMTPTargetArchiveIDs>] [-ArchiveNames <Symantec.EnterpriseVault.Admin.SMTPTargetArchiveNames>] [-ArchiveType <object>] [-ArchivingEnabled <Boolean>] [<CommonParameters>]

パラメータ

表: Set-EVSMTPTarget パラメータ

パラメータ	説明
-SiteId (必須)	SMTP ターゲットを更新するサイトの ID。
-Name (必須)	ターゲットの SMTP アドレス。
-PolicyId	SMTP ターゲットに関連付けされる既存の SMTP ポリシーの ID。
-PolicyName	SMTP ターゲットに関連付けされる既存の SMTP ポリシーの名前。
-RetentionCategoryId	SMTP ターゲットに関連付けされる既存の保持カテゴリの ID。
-RetentionCategory	SMTP ターゲットに関連付けされる既存の保持カテゴリの名前。保持カテゴリを指定する場合は、任意のアーカイブの種類を使うことができます。
-RetentionPlan	Enterprise Vault がターゲットのメッセージを保管するアーカイブに関連付けされる既存の保持計画の名前。この計画で定義した保持カテゴリはターゲットのメッセージに割り当てられます。次の点に注意してください。ターゲットのアーカイブが他のアーカイブに関連付けられている可能性のある 1 つ以上のターゲットに関連付けられている場合、このコマンドは影響を受けるすべてのアーカイブの保持計画を更新します。 SMTP ジャーナルおよび SMTP グループジャーナルターゲットについては、関連付けられているアーカイブにすでに保持計画が適用されている場合、保持設定は変更できません。保持設定を変更する場合は、アーカイブのプロパティを編集する必要があります。 SMTP メールボックスジャーナルターゲットについては、このコマンドにより、関連付けられているアーカイブの保持計画が更新されます。保持カテゴリと保持計画の両方を指定することはできません。
-Force	確認メッセージを表示することなく、-RetentionPlan で指定される保持計画を適用します。
-ArchiveId -ArchiveName	ArchiveId または ArchiveName のいずれかを使用して、Enterprise Vault がターゲットのメッセージをアーカイブするアーカイブを指定します。次の点に注意してください。アーカイブ ID とアーカイブ名の両方を指定することはできません。アーカイブの一覧を SMTP ジャーナルまたは SMTP グループジャーナルのターゲットに関連付けている場合、Set-EVSMTPTarget は、指定したアーカイブで既存のアーカイブの一覧を上書きします。複数のアーカイブを SMTP ジャーナルまたは SMTP グループジャーナルのターゲットに関連付けるには、ArchiveIds または ArchiveNames を使用します。
-ArchiveIds -ArchiveNames	ArchiveIds または ArchiveNames のいずれかを使用して、複数のアーカイブを SMTP ジャーナルまたは SMTP グループジャーナルのターゲットに関連付けます。SMTPTargetArchiveIDs オブジェクトについて詳しくは、get-help about_SMTPTargetArchiveIDs と入力します。次の点に注意してください。アーカイブ ID とアーカイブ名の両方を指定することはできません。ターゲットに関連付けられているすべてのアーカイブで、保持設定が同じになっている必要があります。 Set-EVSMTPTarget は既存のアーカイブの一覧を上書きします。Get-EVSMTPTarget を使用して、関連付けられたアーカイブの一覧を取得し、この情報を使用して Set-EVSMTPTarget でターゲットを更新します。 1 つのアーカイブを SMTP ジャーナルまたは SMTP グループジャーナルのターゲットに関連付けるには、ArchiveId または ArchiveName を使用します。これらのパラメータを使用して、SMTP メールボックスジャーナルのターゲットを更新することはできません。
-ArchiveType (アーカイブを更新する場合は必須)	Enterprise Vault がターゲットからメッセージをアーカイブ化するアーカイブの種類。ここで指定できる値は、New-EVSMTPTarget cmdlet を使用してこのターゲットを作成したときに -TargetType で指定した値によって決まります。-TargetType が SMTPJournaling または SMTPGroupJournaling の場合は、1 つまたは複数のアーカイブの種類を指定することができます。有効なアーカイブの種類は次のとおりです。 DominoJournal ExchangeJournal Shared SMTP -TargetType が SMTPMailboxJournaling の場合は、次のアーカイブの種類のいずれかを指定することができます。 ExchangeMailbox InternetMail
-ArchivingEnabled	ターゲットのメッセージ (受信と送信) をアーカイブするには、$true に設定します。ターゲットのアーカイブを無効にするには、$false に設定します。

例

Set-EVSMTPTarget 13E9...EV1004.example.com -Name JohnDoe@example.com -PolicyId 162D...EV1004.example.com -RetentionCategoryId 11B6...EV1004.example.com -ArchiveName SMTPLocalPublic -ArchiveType InternetMail -ArchivingEnabled $true
指定されたプロパティで SMTP ターゲット「JohnDoe@example.com」を更新します。
C:\PS> $archNames = new-object Symantec.EnterpriseVault.Admin.SMTPTargetArchiveNames
C:\PS> $archNames.Add("Archive1")
C:\PS> $archNames.Add("Archive2")
Set-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name SMTPjournal@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveNames $archNames -ArchiveType ExchangeJournal -ArchivingEnabled $true
指定されたプロパティで SMTP ターゲット「SMTPjournal@example.com」を更新し、指定したアーカイブを SMTP ターゲットに関連付けます。
$archIds = new-object Symantec.EnterpriseVault.Admin.SMTPTargetArchiveIDs
C:\PS> $archIds.Add("12DB...110000MW-EV-1-A")
C:\PS> $archIds.Add("15E1...210000MW-EV-1-A")
C:\PS> $archIds.Add("132C...410000MW-EV-1-A")
Set-EVSMTPTarget 13E9...EV1004.example.com -Name sales@example.com -PolicyId 162D...EV1004.example.com -RetentionCategoryId 11B6...EV1004.example.com -ArchiveIDs $archIds -ArchiveType "Shared" -ArchivingEnabled $true
SMTP ターゲット sales@example.com の次の設定の詳細を更新します。
- ポリシー (ID の値を使用)
- 保持カテゴリ (ID の値を使用)
- アーカイブの一覧
- このターゲットのメッセージに対して許可されるアーカイブの種類
- ターゲットのメッセージに対するアーカイブの有効化
C:\PS> $target = Get-EVSMTPTarget -Name SMTPjournal2@example.com
Get-EVSMTPTarget の出力を $target という名前のオブジェクトに返します。
C:\PS> $archNames = $target.TargetArchives.ArchiveNames
このターゲットに関連付けられているアーカイブ名の一覧を、$archNames という名前のオブジェクトに返します。
C:\PS> $archNames.Remove("Archive1")
一覧から「Archive1」を削除します。
C:\PS> $archNames.Add("SharedArchive1")
一覧に「SharedArchive1」を追加します。
C:\PS> $archType = $target.TargetArchives.ArchiveType
このターゲットのメッセージに許可されるアーカイブの種類に関する情報を、$archType という名前のオブジェクトに返します。
C:\PS> $archType = $archType.ToString() + ", Shared"
アーカイブの種類「Shared」を追加します。
C:\PS> Set-EVSMTPTarget -Name SMTPjournal2@example.com -PolicyId 162D...EV1004.example.com -RetentionCategoryId 11B6...EV1004.example.com -ArchiveType $archType -ArchiveNames $archNames
SMTP ターゲット SMTPjournal2@example.com の次の設定の詳細を更新します。
- ポリシー (ID の値を使用)
- 保持カテゴリ (ID の値を使用)
- アーカイブの一覧 ($archNames オブジェクトを使用)
- このターゲットのメッセージに対して許可されるアーカイブの種類 ($archType オブジェクトを使用)
C:\PS> $target = Get-EVSMTPTarget -Name marketing@example.com
Get-EVSMTPTarget の出力を $target という名前のオブジェクトに返します。
C:\PS> $archIds = $target.TargetArchives.ArchiveIDs
このターゲットに関連付けられているアーカイブ名の一覧を、$archIds という名前のオブジェクトに返します。
C:\PS> $archIds.Remove("184D...110000MW-SQL-EV-2-A")
一覧から「184D...110000MW-SQL-EV-2-A」を削除します。
C:\PS> $archIds.Add("162D....110000MW-SQL-EV-2-A")
一覧に「162D....110000MW-SQL-EV-2-A」を追加します。
C:\PS> $archType = $target.TargetArchives.ArchiveType
このターゲットのメッセージに許可されるアーカイブの種類に関する情報を、$archType という名前のオブジェクトに返します。
C:\PS> $archType = $archType.ToString() + ", Shared"
アーカイブの種類「Shared」を追加します。
C:\PS> Set-EVSMTPTarget -Name marketing@example.com -PolicyId 162D...EV1004.example.com -RetentionCategoryId 11B6...EV1004.example.com -ArchiveType $archType -ArchiveIDs $archIds
SMTP ターゲット marketing@example.com の次の設定の詳細を更新します。
- ポリシー (ID の値を使用)
- 保持カテゴリ (ID の値を使用)
- アーカイブの一覧 ($archIds オブジェクトを使用)
- このターゲットのメッセージに対して許可されるアーカイブの種類 ($archType オブジェクトを使用)
Set-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionPlan "Projects Retention Plan" -ArchiveId EA7...example.com -ArchiveType SMTP
警告: ターゲットのアーカイブは、他のアーカイブに関連付けられている 1 つ以上のターゲットに関連付けられています。このアーカイブの保持設定を変更すると、一覧表示されているアーカイブの保持設定が変更されます。
Express Vault Store\A1
Express Vault Store\A2
Express Vault Store\A3
Confirm Do you want to continue? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
ポリシー、保持計画、および SMTP ターゲット「JohnDoe@example.com」のアーカイブを更新します。ターゲットのアーカイブが他のアーカイブに関連付けられている 1 つ以上のターゲットに関連付けられている場合、このコマンドはまずアーカイブの一覧を表示し、続行の確認メッセージを表示します。「はい (Y)」を選択すると、コマンドは「Projects Retention Plan」と呼ばれる保持計画を一覧表示したアーカイブに適用します。「N」または「S」を選択すると、コマンドは変更を適用せずに終了します。
Set-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -RetentionPlan "RtnForManagers" - Force
保持計画「RtnForManagers」を「JohnDoe@example.com」に適用します。このターゲットのアーカイブが他のアーカイブに関連付けられている 1 つ以上のターゲットに関連付けられている場合、このコマンドは確認メッセージを表示することなく、これらのアーカイブの保持設定を更新します。

出力

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

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

名前	種類	説明
ArchivingEnabled	Boolean	現在アーカイブされている SMTP ターゲットによってメッセージが送信または受信される場合は $true、そうでない場合は $false。
Name	文字列	SMTP ターゲットのアドレス。
PolicyId	文字列	SMTP ターゲットに関連付けされた SMTP ポリシーの ID。
PolicyName	文字列	SMTP ターゲットに関連付けされた SMTP ポリシー。
RetentionCategory	文字列	Enterprise Vault が新しくアーカイブされたアイテムに割り当てる保持カテゴリの名前。 Enterprise Vault が「(From Plan)」という語句を保持カテゴリ名に追加した場合、保持計画は SMTP ターゲットに関連付けされたアーカイブに適用されています。Enterprise Vault は保持計画で定義された保持カテゴリをアイテムに適用します。アーカイブに保持計画を割り当てていない場合、有効な保持カテゴリは、SMTP ターゲットのプロパティで定義された保持カテゴリになります。
RetentionCategoryId	文字列	Enterprise Vault が新しくアーカイブされたアイテムに割り当てる保持カテゴリの ID。 RetentionCategory と同様に、Enterprise Vault がアイテムを格納するアーカイブに保持計画が割り当てられているかどうかによって変わります。
SiteId	文字列	ターゲットが属しているサイトの ID。
TargetArchives	オブジェクト	Symantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation: SMTP ターゲットアドレスに関連付けられたアーカイブの一覧を提供します。TargetArchives について詳しくは、PowerShell プロンプトで get-help about_SmtpTargetArchiveInformation と入力してください。
TargetType	オブジェクト	ターゲットに関連付けられている SMTP ジャーナル設定の種類。

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

名前	種類	説明
ArchiveId	文字列	SMTP ターゲットに関連付けされたアーカイブの ID。
ArchiveName	文字列	SMTP ターゲットに関連付けされたアーカイブの名前。
ArchiveType	オブジェクト	SMTP ターゲットに関連付けられているアーカイブの種類。
EVServerName	文字列	ボルトストアをホストする Enterprise Vault サーバー。
Name	文字列	SMTP ターゲットのアドレス。
VaultStoreName	文字列	SMTP ターゲットに使用されるアーカイブを含んでいるボルトストアの名前。