Veritas Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Archiving: Skype for Business
- Archiving: SMTP
- Get-EVSMTPHoldingFolder
- Get-EVSMTPMessageTrackingLogLocation
- Get-EVSMTPPolicy
- Get-EVSMTPServerSettings
- Get-EVSMTPTarget
- New-EVSMTPPolicy
- New-EVSMTPServerSettings
- New-EVSMTPTarget
- Remove-EVSMTPPolicy
- Remove-EVSMTPTarget
- Set-EVSMTPMessageTrackingLogLocation
- Set-EVSMTPPolicy
- Set-EVSMTPServerSettings
- Set-EVSMTPTarget
- Sync-EVSMTPServerSettings
- Backup
- Classification
- Disable-EVClassification
- Get-EVClassificationFCITags
- Get-EVClassificationPolicy
- Get-EVClassificationStatus
- Get-EVClassificationTestMode
- Get-EVClassificationVICTags
- Import-EVClassificationFCIRules
- Initialize-EVClassificationVIC
- New-EVClassificationPolicy
- Publish-EVClassificationFCIRules
- Remove-EVClassificationPolicy
- Set-EVClassificationPolicy
- Set-EVClassificationTestMode
- Databases
- IMAP access
- Indexing
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
Set-EVSMTPTarget
Set-EVSMTPTarget sets or updates the specified properties of an existing SMTP target. If you do not specify a site ID using the -SiteID parameter, and Set-EVSMTPTarget cannot determine the site, you are prompted to enter the site ID.
Set-EVSMTPTarget sets the SMTP target information in the directory and on each Enterprise Vault SMTP server in the site.
Use -ArchivingEnabled $true to enable archiving for the target or -ArchivingEnabled $false to disable archiving.
If Set-EVSMTPTarget fails to update the SMTP settings on any of the Enterprise Vault SMTP servers, the GetFailedEVServerList function can list the servers that were not updated. See the help for Get-EVSMTPTarget for an example.
Set-EVSMTPTarget is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.
Set-EVSMTPTarget [-SiteId] <String> [-Name] <String> [-PolicyId <String>] [-PolicyName <String>] [-RetentionCategoryId <String>] [-RetentionCategory <String>] [-RetentionPlan <String>] [-ArchiveId <String>] [-ArchiveName <String>] [-ArchiveType <object>] [-ArchivingEnabled <Boolean>] [<CommonParameters>]
Table: Set-EVSMTPTarget parameters
Parameter | Description |
|---|---|
-SiteId (required) | The ID of the site in which you want update the SMTP target. |
-Name (required) | The SMTP address of the target. |
-PolicyId | The ID of an existing SMTP policy to be associated with the SMTP target. |
-PolicyName | The name of an existing SMTP policy to be associated with the SMTP target. |
-RetentionCategoryId | The ID of an existing retention category to be associated with the SMTP target. |
-RetentionCategory | The name of an existing retention category to be associated with the SMTP target. If you specify a retention category, you can use any archive type. |
-RetentionPlan | The name of an existing retention plan to be associated with the archive in which Enterprise Vault will archive the target's messages. The retention category that you have defined in the plan is assigned to the target's messages. If this archive already has a retention plan, Set-EVSMTPTarget keeps that plan instead of applying the new one. Note that you cannot do any of the following:
|
-ArchiveId | The ID of the archive in which Enterprise Vault will archive the target's messages. |
-ArchiveName | The name of the archive in which Enterprise Vault will archive the target's messages. |
-ArchiveType | The type of archive in which Enterprise Vault will archive the messages from the target. The valid archive types are:
In addition, the archive types that are output by Get-EVArchive are also valid:
|
-ArchivingEnabled | Set to $true to archive the target's messages (incoming and outgoing). Set to $false to disable archiving for the target. |
Set-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveName SMTPLocal -ArchiveType SMTP -ArchivingEnabled $true
Updates the SMTP target, "JohnDoe@example.com" with the properties specified.
Set-EVSMTPTarget 13E...example.com -Name JohnDoe@example.com -PolicyId 162...example.com -RetentionCategoryId 11B...example.com -ArchiveName SMTPLocal -ArchiveType SMTP -ArchivingEnabled $true
Updates the policy, retention category, and archive of the SMTP target, "JohnDoe@example.com", and enables archiving. The new policy and retention category are specified using ID values.
$archiveType = (Get-EVArchive -ArchiveName SMTPLocal).ArchiveType;
Set-EVSMTPTarget 13E...example.com -Name JohnDoe@example.com -PolicyId 162...example.com -RetentionCategoryId 11B...example.com -ArchiveName SMTPLocal -ArchiveType $archiveType -ArchivingEnabled $true
Uses Get-EVArchive to retrieve the archive type, then stores the value in a variable. Updates the policy, retention category, and archive of the SMTP target, "JohnDoe@example.com", and enables archiving. Uses the stored archive type value.
Set-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionPlan "Projects Retention Plan" -ArchiveName SMTPLocal -ArchiveType SMTP
Updates the policy, retention plan, and archive of the SMTP target, "JohnDoe@example.com".
Set-EVSMTPTarget returns an object of the type Symantec.EnterpriseVault.Admin.SMTPTarget, which contains the properties listed in the following table.
Table: Symantec.EnterpriseVault.Admin.SMTPTarget properties
Name | Type | Description |
|---|---|---|
ArchiveId | String | The ID of the archive that is associated with the SMTP target. |
ArchiveName | String | The name of the archive that is associated with the SMTP target. |
ArchiveType | Object | The type of the archive associated with the SMTP target. |
ArchivingEnabled | Boolean | $true if messages sent to or from the SMTP target are currently being archived, or $false if they are not. |
Name | String | The SMTP target address. |
PolicyId | String | The ID of the SMTP policy associated with the SMTP target. |
PolicyName | String | The SMTP policy associated with the SMTP target. |
RetentionCategory | String | The name of the retention category that Enterprise Vault applies to newly-archived items. If Enterprise Vault appends the words "(From Plan)" to the retention category name, a retention plan has been applied to the archive that is associated with the SMTP target. Enterprise Vault applies the retention category that is defined in the plan to the items. If you have not assigned a retention plan to the archive, the effective retention category is the one that is defined in the SMTP target properties. |
RetentionCategoryId | String | The ID of the retention category that Enterprise Vault applies to newly-archived items. As with RetentionCategory, this is dependent on whether you have assigned a retention plan to the archive in which Enterprise Vault stores the items. |
SiteId | String | The ID of the site to which the target belongs. |
VaultStoreName | String | The name of the vault store associated with the SMTP target. |
See Get-EVSMTPTarget.
See New-EVSMTPTarget.
See Remove-EVSMTPTarget.