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

Set-EVFSAComputerSettings

Set-EVFSAComputerSettings updates the Enterprise Vault server level settings that are configured for NetApp C-Mode server communication. If you do not specify a site ID using the -SiteId parameter, and Set-EVFSAComputerSettings cannot determine the site, you are prompted to enter the site ID.

If you use the -NetAppCModeUseSiteSettings parameter, Enterprise Vault uses the site-level settings that are configured for NetApp C-Mode server communication. Use Get-EVFSASiteSettings to see the values that are configured for these settings at the site-level.

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

Syntax

Set-EVFSAComputerSettings -SiteId <String> -ComputerNameAlternate <String> [-NetAppCModeServerTransportType <String>] [-NetAppCModeServerPort <Integer>] [-NetAppCModeServerCertVerification [<String>]] [-NetAppCModeUseSiteSettings [<Boolean>]] [<CommonParameters>]

Parameters

Table: Set-EVFSAComputerSettings parameters

Parameter

Description

-SiteId (required)

The ID of the site to which the Enterprise Vault server belongs.

-ComputerNameAlternate (required)

The alias for the Enterprise Vault server for which you want to retrieve the settings.

-NetAppCModeServerTransportType

The transport type that is used by the ONTAPI Management API to communicate with the NetApp C-Mode Vserver. The valid transport types are:

  • HTTP

  • HTTPS

Note that the values are not case-sensitive.

-NetAppCModeServerPort

The port number that the ONTAPI Management API should use to communicate with the NetApp C-Mode Vserver. The port number should be same as the one that is configured on the NetApp C-Mode Vserver. The valid range is from 1 through 65535.

-NetAppCModeServerCertVerification

Specifies whether the ONTAPI Management API should verify the server certificate that is issued to the NetApp C-Mode Vserver. To verify the server certificate, make sure that the certificate of the certificate issuing authority is in the cacert.pem file in the Enterprise Vault installation folder. The valid values are:

  • VerifyCertificate

  • VerifyCertificateButIgnoreHostnameMismatch

    Set this value if you want the ONTAPI Management API to verify the certificate, but ignore any mismatch that is found between the host name that is specified in the certificate and the host name of the management LIF.

  • DoNotVerifyCertificate

Note that the values are not case-sensitive.

-NetAppCModeUseSiteSettings

Specifies whether Enterprise Vault should use the site settings that are configured for NetApp C-Mode server communication such as server certificate validation, transport style, and port number.

Examples
  • Set-EVFSAComputerSettings -ComputerNameAlternate EVM -NetAppCModeServerTransportType HTTP -NetAppCModeServerPort 80 -NetAppCModeServerCertVerification DoNotVerifyCertificate

    Updates the settings that are configured for NetApp C-Mode server communication for the Enterprise Vault server 'EVM'. The transport type used is HTTP, the server listens on port 80, and the ONTAPI Management API ignores server certificate verification.

  • Set-EVFSAComputerSettings -ComputerNameAlternate EVM -NetAppCModeServerTransportType HTTPS -NetAppCModeServerPort 443 -NetAppCModeServerCertVerification VerifyCertificateButIgnoreHostnameMismatch -NetAppCModeUseSiteSettings $True

    WARNING: Enterprise Vault will use the values configured in the site settings for NetApp C-Mode server configuration because NetAppCModeUseSiteSettings is set to true.

    Updates the settings that are configured for NetApp C-Mode server communication for the Enterprise Vault server 'EVM'. Enterprise Vault will use the site-level settings that are configured for NetApp C-Mode server communication because NetAppCModeUseSiteSettings is set to $true.

Output

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

Table: Set-EVFSAComputerSettings properties

Name

Type

Description

SiteId

String

The ID of the site to which the Enterprise Vault server belongs.

ComputerNameAlternate

String

The alias for the Enterprise Vault server to which these settings belong.

NetAppCModeServerTransportType

String

The transport type that is used by the ONTAPI Management API to communicate with the NetApp C-Mode Vserver.

NetAppCModeServerPort

Integer

The port number that the ONTAPI Management API uses to communicate with the NetApp C-Mode Vserver.

NetAppCModeServerCertVerification

String

Specifies whether the ONTAPI Management API should verify the server certificate that is issued to the NetApp C-Mode Vserver.

NetAppCModeUseSiteSettings

Boolean

Specifies whether Enterprise Vault should use the site settings that are configured for NetApp C-Mode server communication such as server certificate validation, transport style, and port number.