Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.4)
  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-EVFSAComputerSettings
    2.  
      Get-EVFSAFileServer
    3.  
      Get-EVFSAFolder
    4.  
      Get-EVFSASiteSettings
    5.  
      Get-EVFSAVolume
    6.  
      New-EVFSAFileServer
    7.  
      New-EVFSAFolder
    8.  
      New-EVFSAVolume
    9.  
      Remove-EVFSAFileServer
    10.  
      Remove-EVFSAFolder
    11.  
      Remove-EVFSAVolume
    12.  
      Set-EVFSAComputerSettings
    13.  
      Set-EVFSAFileServer
    14.  
      Set-EVFSAFolder
    15.  
      Set-EVFSASiteSettings
    16.  
      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-EVArchivePermission
    4.  
      Get-EVVaultStore
    5.  
      Get-EVVaultStorePartition
    6.  
      Remove-EVArchive
    7.  
      Remove-EVArchivePermission
    8.  
      Set-EVArchive
    9.  
      Set-EVArchivePermission
    10.  
      Start-PartitionRollover

Get-EVSMTPTarget

Get-EVSMTPTarget returns all the SMTP target addresses that are configured in the Enterprise Vault site. If you do not specify a site ID using the -SiteID parameter, and Get-EVSMTPTarget cannot determine the site, you are prompted to enter the site ID. If you specify the name of an SMTP target, then Get-EVSMTPTarget gets the properties of that target address. See the help for New-EVSMTPTarget for a description of the properties.

When you run New-EVSMTPTarget, Set-EVSMTPTarget, or Remove-EVSMTPTarget, Enterprise Vault updates the SMTP target information in the Enterprise Vault directory, and on each Enterprise Vault SMTP server in the site. If Enterprise Vault is unable to update the SMTP target on any of the SMTP servers, you can use the GetFailedEVServerList function to list the servers that Enterprise Vault could not update.

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

Syntax

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

Parameters

Table: Get-EVSMTPTarget parameters

Parameter

Description

-SiteId (required)

The ID of the site whose SMTP target you want to retrieve.

-Name

The address of the SMTP target to retrieve.

Examples
  • Get-EVSMTPTarget -SiteId 13E...example.com

    Returns all the SMTP targets that are configured in the Enterprise Vault site.

  • You can use the following sequence of commands to return information about the SMTP target JohnDoe@example.com:

    • $st = New-Object Symantec.EnterpriseVault.Admin.SMTPTarget

      Uses New-Object to create a new variable called $st to hold an SMTPTarget object.

    • $st.Name = "JohnDoe@example.com"

      Specifies JohnDoe@example.com as the target to be retrieved, using the Name parameter.

    • $st.Read()

      Retrieves information about the specified SMTP target into $st using the Read method.

    • $st

      Displays the target information contained in the $st variable. For example:

      Name                : JohnDoe@example.com
      PolicyName          : Default SMTP Policy
      PolicyId            : 138...example.com
      RetentionCategory   : Default Retention Category (From Plan)
      RetentionCategoryId : 100...example.com
      ArchivingEnabled    : true
      TargetArchives      : {exchangearchive}
      SiteId              : 13E...example.com
      TargetType          : SMTPMailboxJournaling
      

      In this case, the cmdlet 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. The retention category that Enterprise Vault applies to the archived items is the one that is defined in the retention plan.

    You can also display this information using either of the following commands:

    • Get-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com

    • Get-EVSMTPTarget 13E...example.com JohnDoe@example.com

  • You can use the following sequence of commands to return information about an SMTP target, and find the list of servers on which the target was not updated by any of New-EVSMTPTarget, Set-EVSMTPTarget, or Remove-EVSMTPTarget:

    • $st = Get-EVSMTPTarget 13E...example.com JohnDoe@example.com

      Retrieves the SMTP target into the $st variable.

    • $st

      Displays the target information held in $st. For example:

      Name                : JohnDoe@example.com
      PolicyName          : Default SMTP Policy
      PolicyId            : 138...example.com
      RetentionCategory   : Default Retention Category (From Plan)
      RetentionCategoryId : 100...example.com
      ArchivingEnabled    : true
      TargetArchives      : {exchangearchive}
      SiteId              : 13E...example.com
      TargetType          : SMTPMailboxJournaling
      
    • $st.TargetArchives

      Displays in tabular format the following details of the archives associated with the target in $st:

      Column title

      Example value

      Name

      JohnDoe@example.com

      ArchiveName

      exchangearchive

      ArchiveType

      ExchangeMailbox

      ArchiveId

      128D...com

      VaultStore

      Express Vault Store

      EVServerName

      ev.example.com

    • $st.GetFailedEVServerList()

      Displays the list of Enterprise Vault servers on which the target was not updated. For example:

      EV1101, EVSMTP11
Output

Get-EVSMTPTarget returns objects of the type Symantec.EnterpriseVault.Admin.SMTPTarget and Symantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation, which contain the properties listed in the following tables.

Table: Symantec.EnterpriseVault.Admin.SMTPTarget properties

Name

Type

Description

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.

TargetArchives

Object

Symantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation: Provides a list of archives that are associated with the SMTP target address. For more information on TargetArchives details, type get-help about_SmtpTargetArchiveInformation at the PowerShell prompt.

TargetType

Object

The type of the SMTP journaling configuration associated with the target.

Table: Symantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation properties

Name

Type

Description

ArchiveId

String

The ID of the archive associated with the SMTP target.

ArchiveName

String

The name of the archive associated with the SMTP target.

ArchiveType

Object

The type of the archive associated with the SMTP target.

EVServerName

String

The Enterprise Vault server that hosts the vault store.

Name

String

The SMTP target address.

VaultStoreName

String

The name of the vault store that contains the archive that is used for the SMTP target.

Related cmdlets