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

Set-EVSMTPServerSettings

Set-EVSMTPServerSettings updates the settings for all Enterprise Vault SMTP servers in the specified site. If you do not specify a site ID using the -SiteID parameter, and Set-EVSMTPServerSettings cannot determine the site, you are prompted to enter the site ID.

This cmdlet fails if SMTP server settings for site do not exist.

Set-EVSMTPServerSettings is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Syntax

Set-EVSMTPServerSettings [[-SiteId] <String>] [-Port <Integer>] [-MaxMessageSize <Integer>] [-Authentication <Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION enumeration value>] [-AuthenticationCredentials <System.Management.Automation.PSCredential>] [-AuthenticationAllowPlainText <Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT enumeration value>] [-Tls <Symantec.EnterpriseVault.Admin._EV_SMTP_TLS enumeration value>] [-TlsCertificateFile <String>] [-TlsSecurePassphrase <System.Security.SecurseString>] [-SMTPConnectionControl <Symantec.EnterpriseVault.Admin.SMTPConnectionControlList>] [-MessageTracking <Boolean>] [-IncludeSubjectLineInLogs <Boolean>] [-DaysToKeepMessageTrackingLogs <Integer>] [<CommonParameters>]

Parameters

Table: Set-EVSMTPServerSettings parameters

Parameter

Description

-SiteId

The ID of the site to which the SMTP settings apply.

-Port

The port number to be used by the SMTP servers in the site.

-MaxMessageSize

The maximum message size that the SMTP servers will accept (in MB). The SMTP servers will reject messages that are larger than the specified size.

-Authentication

The enumeration value specifies whether authentication is enabled for SMTP connections to the SMTP servers. If the value EV_SMTP_AUTHENTICATION_ENABLE is specified, hosts that connect to the SMTP servers must supply the credentials specified by the parameter -AuthenticationCredentials. If the value EV_SMTP_AUTHENTICATION_DISABLE is specified, then -AuthenticationCredentials is not required. For details of the enumerations used, type get-help about_SMTPEnumerations.

-AuthenticationCredentials

The Authentication credentials of SMTP servers in the site. This parameter is only required if -Authentication is set to EV_SMTP_AUTHENTICATION_ENABLE.

-AuthenticationAllowPlainText

Enumeration value that specifies whether plain text authentication is enabled for SMTP connections to the SMTP servers.

If -Authentication is set to EV_SMTP_AUTHENTICATION_DISABLE, this value is always set to EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER.

If EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLS is specified, then -TLS must be enabled on the SMTP servers or an appropriate exception message is generated.

For details of the enumerations used, type get-help about_SMTPEnumerations at the PowerShell prompt.

-Tls

The enumeration value specifies the support for encrypted and unencrypted connections to the SMTP servers. The protocol supported for encrypted connect ions is Transport Layer Security (TLS). If encrypted connections are supported, then you must specify values for the parameters -TlsCertificateFile and -TlsSecurePassphrase. For details of the enumerations used, type get-help about_SMTPEnumerations.

-TlsCertificateFile

The path of the TLS certificate file to use for encrypted connections to the SMTP servers. This parameter is not required if only unencrypted connections are supported.

-TlsSecurePassphrase

The TLS certificate file secure passphrase required for encrypted connections to the SMTP servers. This parameter is not required if only unencrypted connections are supported.

-SMTPConnectionControl

A list of hosts that can connect to the SMTP servers. For details of SMTPConnectionControlList object, type get-help about_SMTPConnectionControlList.

-MessageTracking

Specifies whether message tracking is enabled for all the SMTP servers in the site. Set to $true to enable SMTP message tracking. Set to $false to disable message tracking. When message tracking is enabled, Enterprise Vault logs the details of messages that each SMTP server receives. By default, the message tracking log file is stored in Reports\SMTP\SMTPService in the Enterprise Vault program folder on each SMTP server. You can use Set-EVSMTPMessageTrackingLogLocation cmdlet to change the location of the message tracking log file.

-IncludeSubjectLineInLogs

Specifies whether to log the subject line of the message in the message tracking log file and the DTrace logs. Set to $true to log the subject line. The default is not to log the subject line ($false).

-DaysToKeepMessageTrackingLogs

Specifies the number of days to keep the SMTP message tracking log files on the server. Log files that are older than the specified number of days are deleted. Enter a value in the range 1 to 999. The default value is 30.

Examples
  • Set-EVSMTPServerSettings -SiteId 13E...example.com -Authentication EV_SMTP_AUTHENTICATION_ENABLE -AuthenticationCredentials (New-Object System.Management.Automation.PSCredential -ArgumentList "user@example.com", ("admin@123" | ConvertTo-SecureString -AsPlainText -Force)) -AuthenticationAllowPlainText EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLS -Tls EV_SMTP_TLS_ENCRYP TED_AND_UNENCRYPTED -TlsCertificateFile "C:\rsa.p12" -TlsSecurePassphrase ("admin@123" | ConvertTo-SecureString -AsPlainText -Force) -MessageTracking $true -IncludeSubjectLineInLogs $true -DaysToKeepMessageTrackingLogs 40

    Updates the SMTP server settings for all SMTP servers in the specified site. The SMTP servers continue to listen on the port previously configured, authentication is enabled, both encrypted and unencrypted connections are supported, message tracking is enabled, the subject line of each message is logged, and the log file is retained for 40 days from the date when the file was created.

  • C:\PS> $xConnectionList = new-object Symantec.EnterpriseVault.Admin.SMTPConnectionControlList

    C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAME", "Test")

    C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMESUFFIX", "smtp.example.com")

    C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMEPATTERN", "as-[a-z0-9]*-[a-z0-9]*.example.Local")

    C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4", "192.168.1.1")

    C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4INCIDR", "192.168.1.1/24")

    C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6", "0000:0000:0000:0000:0000:0000:0000:0001")

    C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6INCIDR", "0000:0000:0000:0000:0000:0000:0000:0001/128")

    C:\PS> Set-EVSMTPServerSettings -Port 25 -Authentication EV_SMTP_AUTHENTICATION_ENABLE -AuthenticationCredentials (New-Object System.Management.Automation.PSCredential -ArgumentList "user@example.com", ("admin@123" | ConvertTo-SecureString -AsPlainText -Force)) -AuthenticationAllowPlainText EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER -Tls EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED -TlsC ertificateFile "C:\rsa.p12" -TlsSecurePassphrase ("admin@123" | ConvertTo-SecureString -AsPlainText -Force) -SMTPConnectionControl $xConnectionList -MessageTracking $true -IncludeSubjectLineInLogs $true -DaysToKeepMessageTrackingLogs 45

    C:\PS> Get-EVSMTPServerSettings

    SiteId                       : 13E...example.com
    Port                         : 25
    MaxMessageSize               : 0
    Authentication               : EV_SMTP_AUTHENTICATION_ENABLE
    AuthenticationEmailAddress   : user@example.com
    AuthenticationAllowPlainText : EV_SMTP_AUTHENTICATION
                                   _ALLOWPLAINTEXT_NEVER
    Tls                          : EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED
    TlsCertificateInfo           : Symantec.EnterpriseVault.Admin
                                   .TlsCertificate
    SMTPConnectionControl        : Symantec.EnterpriseVault.Admin
                                   .SMTPConnectionControlList
    MessageTracking              : True
    IncludeSubjectLineInLogs     : True
    DaysToKeepMessageTrackingLogs: 45

    This sequence of commands updates SMTP server settings for all SMTP servers in the specified site. The SMTP servers listen on port 25, authentication is enabled, plain text authentication is not allowed, both encrypted and unencrypted connections are supported, message tracking is enabled, the subject line of each message is logged, and the log file is retained for 45 days from the date when the file was created. The allowed connections are added to the SMTPConnectionControlList object using different address formats.

Output

Set-EVSMTPServerSettings returns an object of the type Symantec.EnterpriseVault.Admin.SMTPServerSettings, which contains the properties listed in the following table.

Table: Symantec.EnterpriseVault.Admin.SMTPServerSettings properties

Name

Type

Description

Authentication

Object

Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION enumeration value: Specifies whether authentication is required for incoming connections. For details of the enumeration values, type get-help about_SMTPEnumerations at the PowerShell prompt.

AuthenticationAllowPlainText

Object

Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT enumeration value: Specifies whether plain text authentication is allowed for incoming connections.

If authentication is disabled this value defaults to EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER.

For details of the enumeration values, type get-help about_SMTPEnumerations at the PowerShell prompt.

AuthenticationEmailAddress

String

The identity of the authentication user, if authentication is enabled.

DaysToKeepMessageTrackingLogs

Integer

The number of days to keep the SMTP message tracking log files on the server. Log files that are older than the specified number of days are deleted.

IncludeSubjectLineInLogs

Boolean

Specifies whether the subject line of the message is logged in the message tracking log file and the DTrace logs. $true if the subject line is included in the logs, or $false if the subject line is not logged.

MaxMessageSize

Integer

Maximum SMTP message size (in MB).

MessageTracking

Boolean

Specifies whether message tracking is enabled. $true if SMTP message tracking is enabled, or $false if message tracking is disabled.

Port

Integer

The port number on which the SMTP servers listen.

SiteId

String

The ID of the site to which the SMTP server settings belong.

SMTPConnectionControl

Object

Symantec.EnterpriseVault.Admin.SMTPConnectionControlList: Provides a list of allowed connections to the SMTP servers. For more information on managing the list of allowed connections, type get-help about_SMTPConnectionControlList at the PowerShell prompt.

Tls

Object

Symantec.EnterpriseVault.Admin._EV_SMTP_TLS enumeration value: Enumeration value that specifies the support for encrypted and unencrypted connections to the SMTP servers. For details of the enumeration values, type get-help about_SMTPEnumerations at the PowerShell prompt.

TlsCertificateInfo

Object

Symantec.EnterpriseVault.Admin.TlsCertificate: Provides information about the TLS certificate used for SMTP connections.

For more information on the TlsCertificate object, type get-help about_TlsCertificate at the PowerShell prompt.

Related cmdlets