Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.3)
  1. Introducing the Enterprise Vault PowerShell cmdlets
    1.  
      About the Enterprise Vault Management Shell
    2.  
      Getting Help for Enterprise Vault PowerShell cmdlets
    3.  
      Rules for PowerShell strings
    4. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Archiving: Exchange
    1.  
      Add-EVPstComputer
    2.  
      Add-EVPstFile
    3.  
      Get-EVExchangeMailboxPolicy
    4.  
      New-EVExchangeMailboxPolicy
    5.  
      Remove-EVExchangeFolderPolicy
    6.  
      Remove-EVExchangeMailboxPolicy
    7.  
      Set-EVExchangeMailboxPolicy
  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: Skype for Business
    1.  
      Get-EVSkypeForBusinessTarget
    2.  
      New-EVSkypeForBusinessTarget
    3.  
      Remove-EVSkypeForBusinessTarget
    4.  
      Set-EVSkypeForBusinessTarget
  5. Archiving: SMTP
    1.  
      Get-EVSMTPHoldingFolder
    2.  
      Get-EVSMTPMessageTrackingLogLocation
    3.  
      Get-EVSMTPPolicy
    4.  
      Get-EVSMTPServerSettings
    5.  
      Get-EVSMTPTarget
    6.  
      New-EVSMTPPolicy
    7.  
      New-EVSMTPServerSettings
    8.  
      New-EVSMTPTarget
    9.  
      Remove-EVSMTPPolicy
    10.  
      Remove-EVSMTPTarget
    11.  
      Set-EVSMTPMessageTrackingLogLocation
    12.  
      Set-EVSMTPPolicy
    13.  
      Set-EVSMTPServerSettings
    14.  
      Set-EVSMTPTarget
    15.  
      Sync-EVSMTPServerSettings
  6. Backup
    1.  
      Clear-IndexLocationBackupMode
    2.  
      Clear-VaultStoreBackupMode
    3.  
      Get-IndexLocationBackupMode
    4.  
      Get-VaultStoreBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Set-VaultStoreBackupMode
  7. Classification
    1.  
      Disable-EVClassification
    2.  
      Get-EVClassificationFCITags
    3.  
      Get-EVClassificationPolicy
    4.  
      Get-EVClassificationStatus
    5.  
      Get-EVClassificationTestMode
    6.  
      Get-EVClassificationVICTags
    7.  
      Import-EVClassificationFCIRules
    8.  
      Initialize-EVClassificationVIC
    9.  
      New-EVClassificationPolicy
    10.  
      Publish-EVClassificationFCIRules
    11.  
      Remove-EVClassificationPolicy
    12.  
      Set-EVClassificationPolicy
    13.  
      Set-EVClassificationTestMode
  8. Databases
    1.  
      Get-EVDatabase
    2.  
      Get-EVDatabaseDetail
    3.  
      Get-EVDatabaseFileInfo
    4.  
      Get-EVStorageDatabase
    5.  
      Set-EVDatabaseDetail
    6.  
      Start-EVDatabaseUpgrade
  9. IMAP access
    1.  
      Get-EVIMAPUsers
    2.  
      Get-EVIMAPUserSettings
    3.  
      Set-EVIMAPServerDisabled
    4.  
      Set-EVIMAPServerEnabled
  10. Indexing
    1.  
      Get-EVIndexLocation
    2.  
      Get-EVMDSStatus
    3.  
      Get-IndexServerForIndexLocation
    4.  
      New-EVMDSBuildTask
    5.  
      Set-IndexMetadataSyncLevel
  11. Records management
    1.  
      Export-EVNARAArchive
    2.  
      Get-EVRecordSettings
  12. Retention plans
    1.  
      Get-EVRetentionPlan
    2.  
      New-EVRetentionPlan
    3.  
      Remove-EVRetentionPlan
    4.  
      Set-EVRetentionPlan
  13. Roles-based administration
    1.  
      Add-EVRBARoleMember
    2.  
      Get-EVRBAAzStoreXml
    3.  
      Get-EVRBARole
    4.  
      Get-EVRBARoleMember
    5.  
      Remove-EVRBARoleMember
    6.  
      Set-EVRBAAzStoreXml
  14. Sites and servers
    1.  
      Get-EVComputers
    2.  
      Get-EVFileLocation
    3.  
      Get-EVIISWebsite
    4.  
      Get-EVServer
    5.  
      Get-EVSite
    6.  
      Get-EVSiteInfo
  15. Tasks and services
    1.  
      Get-EVDependencyService
    2.  
      Get-EVDependencyServiceState
    3.  
      Get-EVService
    4.  
      Get-EVServiceState
    5.  
      Get-EVTask
    6.  
      Get-EVTaskState
  16. Vault stores and archives
    1.  
      Export-EVArchive
    2.  
      Get-EVArchive
    3.  
      Get-EVVaultStore
    4.  
      Get-EVVaultStorePartition
    5.  
      Remove-EVArchive
    6.  
      Set-EVArchive
    7.  
      Start-PartitionRollover

Get-EVSMTPPolicy

Get-EVSMTPPolicy retrieves details of all the SMTP policies for the Enterprise Vault site you specify. If you do not specify a site ID using the -SiteID parameter, and Get-EVSMTPPolicy cannot determine the site, you are prompted to enter the site ID. You can also retrieve the properties of a specific policy using the -Name parameter.

Get-EVSMTPPolicy is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Syntax

Get-EVSMTPPolicy [-SiteId] <String> [[-Name] <String>] [<CommonParameters>]

Parameters

Table: Get-EVSMTPPolicy parameters

Parameter

Description

-SiteId (required)

The ID of the site whose policies you want to retrieve.

-Name

The name of the SMTP policy you want to retrieve.

Examples

  • Get-EVSMTPPolicy -SiteId 13E...example.com

    Retrieves all the SMTP policies configured in the specified Enterprise Vault site.

  • Get-EVSMTPPolicy -SiteId 13E...example.com -Name "SMTP policy"

    Or:

    Get-EVSMTPPolicy "SMTP policy"

    Retrieves the properties of the SMTP policy, "SMTP policy". For example:

    SiteId           : 13E...example.com
Name             : SMTP policy
Description      : SMTP policy
IsADefaultPolicy : True
EntryId          : 125...example.com

  • You can use the following sequence of commands to view the properties of an SMTP policy and its X-Header details:

    • $sp = Get-EVSMTPPolicy 13E...example.com "SMTP policy"

      Retrieves the SMTP policy into the $sp variable.

    • $sp

      Displays the information contained in the $sp variable. For example:

      SiteId           : 13E...example.com
Name             : SMTP policy
Description      :
IsADefaultPolicy : False
EntryId          : 170...example.com

    • $sp.XHeaders

      Displays X-Headers. For example:

      HeadersList
-----------
{x-sender}

    • $sp.XHeaders.HeadersList

      Displays a detailed listing of X-Headers. For example:

      Name      ValueType  Searchable  Retrievable
----      ---------  ----------  -----------
x-sender          0           0            0

  • You can use the following sequence of commands to list the SMTP targets associated with the specified SMTP policy:

    • $sp = Get-EVSMTPPolicy 13E...example.com "SMTP policy"

      Retrieves the SMTP policy into the $sp variable.

    • $sp.GetTargets()

      Lists all the SMTP targets associated with the policy. For example:

      user1@example.com
user2@example.com
user3@example.com
Output

Get-EVSMTPPolicy returns objects 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