Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.1)
  1. Introducing the Enterprise Vault PowerShell cmdlets
    1.  
      What's new in Enterprise Vault 12.1
    2.  
      About the Enterprise Vault Management Shell
    3.  
      Importing modules
    4.  
      Getting Help for Enterprise Vault PowerShell cmdlets
    5.  
      Rules for PowerShell strings
    6. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Archiving: Exchange
    1.  
      Add-EVPstComputer
    2.  
      Add-EVPstFile
    3.  
      Remove-EVExchangeFolderPolicy
  3. Archiving: FSA
    1.  
      Get-EVFSAFileServer
    2.  
      Get-EVFSAFolder
    3.  
      Get-EVFSAVolume
    4.  
      New-EVFSAFileServer
    5.  
      New-EVFSAFolder
    6.  
      New-EVFSAVolume
    7.  
      Remove-EVFSAFileServer
    8.  
      Remove-EVFSAFolder
    9.  
      Remove-EVFSAVolume
    10.  
      Set-EVFSAFileServer
    11.  
      Set-EVFSAFolder
    12.  
      Set-EVFSAVolume
  4. Archiving: SMTP
    1.  
      Get-EVSMTPHoldingFolder
    2.  
      Get-EVSMTPPolicy
    3.  
      Get-EVSMTPServerSettings
    4.  
      Get-EVSMTPTarget
    5.  
      New-EVSMTPPolicy
    6.  
      New-EVSMTPServerSettings
    7.  
      New-EVSMTPTarget
    8.  
      Remove-EVSMTPPolicy
    9.  
      Remove-EVSMTPTarget
    10.  
      Set-EVSMTPPolicy
    11.  
      Set-EVSMTPServerSettings
    12.  
      Set-EVSMTPTarget
    13.  
      Sync-EVSMTPServerSettings
  5. Backup
    1.  
      Clear-IndexLocationBackupMode
    2.  
      Clear-VaultStoreBackupMode
    3.  
      Get-IndexLocationBackupMode
    4.  
      Get-VaultStoreBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Set-VaultStoreBackupMode
  6. Classification
    1.  
      Get-EVClassificationPolicy
    2.  
      Get-EVClassificationTags
    3.  
      Get-EVClassificationTestMode
    4.  
      Import-EVClassificationRules
    5.  
      New-EVClassificationPolicy
    6.  
      Publish-EVClassificationRules
    7.  
      Remove-EVClassificationPolicy
    8.  
      Set-EVClassificationPolicy
    9.  
      Set-EVClassificationTestMode
  7. Databases
    1.  
      Get-EVDatabase
    2.  
      Get-EVDatabaseDetail
    3.  
      Get-EVDatabaseFileInfo
    4.  
      Get-EVStorageDatabase
    5.  
      Set-EVDatabaseDetail
    6.  
      Start-EVDatabaseUpgrade
  8. IMAP access
    1.  
      Get-EVIMAPUsers
    2.  
      Get-EVIMAPUserSettings
    3.  
      Set-EVIMAPServerDisabled
    4.  
      Set-EVIMAPServerEnabled
  9. Indexing
    1.  
      Get-EVIndexLocation
    2.  
      Get-EVMDSStatus
    3.  
      Get-IndexServerForIndexLocation
    4.  
      New-EVMDSBuildTask
    5.  
      Set-IndexMetadataSyncLevel
  10. Records management
    1.  
      Export-EVNARAArchive
    2.  
      Get-EVRecordSettings
  11. Retention plans
    1.  
      Get-EVRetentionPlan
    2.  
      New-EVRetentionPlan
    3.  
      Remove-EVRetentionPlan
    4.  
      Set-EVRetentionPlan
  12. Roles-based administration
    1.  
      Add-EVRBARoleMember
    2.  
      Get-EVRBAAzStoreXml
    3.  
      Get-EVRBARole
    4.  
      Get-EVRBARoleMember
    5.  
      Remove-EVRBARoleMember
    6.  
      Set-EVRBAAzStoreXml
  13. Sites and servers
    1.  
      Get-EVComputers
    2.  
      Get-EVFileLocation
    3.  
      Get-EVIISWebsite
    4.  
      Get-EVServer
    5.  
      Get-EVSite
  14. Tasks and services
    1.  
      Get-EVDependencyService
    2.  
      Get-EVDependencyServiceState
    3.  
      Get-EVService
    4.  
      Get-EVServiceState
    5.  
      Get-EVTask
    6.  
      Get-EVTaskState
  15. Vault stores and archives
    1.  
      Export-EVArchive
    2.  
      Get-EVArchive
    3.  
      Get-EVVaultStore
    4.  
      Get-EVVaultStorePartition
    5.  
      Set-EVArchive
    6.  
      Start-PartitionRollover

New-EVSMTPPolicy

New-EVSMTPPolicy creates a new SMTP policy with the specified name, description, and X-Header list. If you do not specify a site ID using the -SiteID parameter, and New-EVSMTPPolicy cannot determine the site, you are prompted to enter the site ID. New-EVSMTPPolicy fails if you specify a policy name that already exists.

New-EVSMTPPolicy is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

New-EVSMTPPolicy [-SiteId] <string> [-Name] <string> [-Description <string>] [-XHeaders <Symantec.EnterpriseVault.Admin.SMTPXHeaders>] [<CommonParameters>]

Parameters

Table: New-EVSMTPPolicy parameters

Parameter

Description

-SiteId (required)

The ID of the site to which you want to add the new SMTP policy.

-Name (required)

The name of the new SMTP policy.

-Description

The description for the new SMTP policy.

-XHeaders

The X-Headers to add to the new SMTP policy.

For more information about the management of X-Header lists, type get-help about_SMTPXHeaders at the PowerShell prompt.

Examples
  • New-EVSMTPPolicy -SiteId 13E...example.com -Name "SMTP policy" -Description "SMTP policy created using PowerShell"

    Creates a new SMTP policy called "SMTP policy", with the description "SMTP policy created using PowerShell".

  • You can use the following sequence of commands to create an X-Headers object, add two X-Headers to the object, then create a new SMTP policy:

    • $xheaders = New-Object Symantec.EnterpriseVault.Admin.SMTPXHeaders

      Creates an X-Headers object.

    • $xheaders.Add('x-code1')

      $xheaders.Add('x-code2')

      These commands add X-Headers "x-code1" and "x-code2" to the X-Headers object.

    • New-EVSMTPPolicy -Name "SMTP policy" -XHeaders $xheaders

      Creates a new SMTP policy called "SMTP policy", adds the new X-Headers to it, and produces the following output:

      SiteId           : 13E...example.com
      EntryId          : 11E...example.com
      IsADefaultPolicy : False
      XHeaders         : Symantec.EnterpriseVault.Admin.SMTPXHeaders
      Name             : SMTP policy
      Description      :
Output

New-EVSMTPPolicy returns an object of the type Symantec.EnterpriseVault.Admin.SMTPPolicy, which contains the properties listed in the following table.

Table: Symantec.EnterpriseVault.Admin.SMTPPolicy properties

Name

Type

Description

Description

String

The description of the SMTP policy.

EntryId

String

The directory entry ID of the SMTP policy.

IsADefaultPolicy

Boolean

$true if the SMTP policy is a default policy, or $false if it is not.

Name

String

The name of the SMTP policy.

SiteId

String

The site ID to which the SMTP policy belongs.

XHeaders

Object

Symantec.EnterpriseVault.Admin.SMTPXHeaders: Provides a list of X-Headers associated with the SMTP policy. For more information on X-Header lists, type get-help about_SMTPXHeaders at the PowerShell prompt.

Related cmdlets