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

New-EVClassificationPolicy

New-EVClassificationPolicy creates an Enterprise Vault classification policy for a site.

New-EVClassificationPolicy is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Syntax

New-EVClassificationPolicy [[-SiteId] <String>] [-Name] <String> [-Description <String>] [-DuringArchivingIndexing <Boolean>] [-DetermineRC <Boolean>] [-RCDuringDeletion <Boolean>] [-RCDuringExpiry <Boolean>] [-PreventRCDuringMove <Boolean>] [-AllowRCOnRecTypeChange <Boolean>] [<CommonParameters>]

Parameters

Table: New-EVClassificationPolicy parameters

Parameter

Description

-SiteId

The ID of the site for which to create the Enterprise Vault classification policy. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then New-EVClassificationPolicy prompts you to enter the required ID.

You can use Get-EVSite to obtain the site ID.

-Name (required)

The name of the Enterprise Vault classification policy. The name must be unique, and it can contain up to 40 alphanumeric or space characters.

-Description

The description to set for the Enterprise Vault classification policy. The description can contain up to 127 alphanumeric, space, or special characters.

-DuringArchivingIndexing

Specifies whether Enterprise Vault should classify items during archiving/indexing ($true) or not ($false). The default is $true.

This setting also determines whether Enterprise Vault reclassifies items when you rebuild the indexes. Note that if you have chosen to archive classified items to smart partitions, reclassifying the items does not cause them to move from one smart partition to another. These items remain on the smart partition to which Enterprise Vault originally archived them.

For example, suppose that you have associated the classification tag "PII" with one smart partition and the tag "Credit-Card" with another smart partition. An item that Enterprise Vault archived to the partition that is associated with the "PII" tag remains on this partition, even if Enterprise Vault subsequently reclassifies the item with the "Credit-Card" tag.

-DetermineRC

Specifies whether to allow the classification feature to update the retention categories of items ($true) or not ($false). The default is $true.

-RCDuringDeletion

When DetermineRC is $true, specifies whether to enable classification on user deletion ($true) or not ($false). The default is $false.

You cannot set RCDuringDeletion to $true when DetermineRC is set to $false.

-RCDuringExpiry

When DetermineRC is $true, specifies whether to enable classification on automatic expiry ($true) or not ($false). The default is $false.

Note the following:

  • You cannot set RCDuringExpiry to $true when DetermineRC is set to $false.

  • You must set RCDuringExpiry to $true when DuringArchivingIndexing is $false and DetermineRC is $true.

-PreventRCDuringMove

When DetermineRC is $true, specifies whether to prevent Enterprise Vault from updating the retention categories of archived items when users perform actions that could potentially update these retention categories. For example, users may move archived items between folders to which you have applied different retention categories, or change the retention categories of items in Enterprise Vault Search, if permitted. Both actions can cause the retention categories of the items to change, potentially overriding the retention categories that the classification feature has set.

The default for PreventRCDuringMove is $false. Enterprise Vault allows user actions to update the retention categories of items, subject to site archive settings.

-AllowRCOnRecTypeChange

For use in environments where you use the Enterprise Vault records management feature to mark selected items as records.

When PreventRCDuringMove is $true (prevent user actions from updating retention categories), AllowRCOnRecTypeChange specifies whether to allow these updates in instances where this also causes the record types of the items to change. The default for AllowRCOnRecTypeChange is $true.

When PreventRCDuringMove is $false, AllowRCOnRecTypeChange has no effect.

Examples
  • New-EVClassificationPolicy -SiteId 13E...EV.example.com -Name "Classification policy" -Description "Classification policy created using PowerShell"

    Creates an Enterprise Vault classification policy that is named "Classification policy" in the specified Enterprise Vault site. The new policy has the description "Classification policy created using PowerShell".

  • New-EVClassificationPolicy -Name "Classification policy" -DuringArchivingIndexing $true -DetermineRC $false

    Creates an Enterprise Vault classification policy that is named "Classification policy". This policy does classify items during archiving/indexing but does not use classification to determine their retention categories.

  • New-EVClassificationPolicy -Name "Classification policy" -PreventRCDuringMove $true

    Creates an Enterprise Vault classification policy to classify items during archiving/indexing and allow the classification feature to update the retention categories of items. The policy prevents Enterprise Vault from updating the retention categories of items when users perform actions that could potentially update these retention categories, except when this will change the record type of the items.

Output

This cmdlet returns an object of type Symantec.EnterpriseVault.Admin.ClassificationPolicy, which has the following properties.

Table: New-EVClassificationPolicy properties

Name

Type

Description

Name

String

The name of the Enterprise Vault classification policy.

EntryId

String

The directory entry ID of the Enterprise Vault classification policy.

IsADefaultPolicy

Boolean

Whether the Enterprise Vault classification policy is a default policy.

DuringArchivingIndexing

Boolean

Whether to classify items during archiving/indexing, and reclassify them during an index rebuild.

DetermineRC

Boolean

Whether classification is used to determine the retention category.

RCDuringDeletion

Boolean

Whether items are classified during user deletion.

RCDuringExpiry

Boolean

Whether items are classified during automatic expiry.

PreventRCDuringMove

Boolean

Whether to prevent Enterprise Vault from updating the retention categories of archived items when users perform actions that could potentially update these retention categories. For example, users may move archived items between folders to which you have applied different retention categories, or change the retention categories of items in Enterprise Vault Search, if permitted. Both actions can cause the retention categories of the items to change.

AllowRCOnRecTypeChange

Boolean

Whether to allow user actions to update retention categories in instances where this also causes the record types of the items to change (for example, from Temporary to Permanent).

Description

String

The description of the Enterprise Vault classification policy.

SiteId

String

The site ID to which the Enterprise Vault classification policy belongs.

Identity

Number

The identity number of the Enterprise Vault classification policy.

Related cmdlets