Veritas Enterprise Vault™ Classification

Last Published:
Product(s): Enterprise Vault (12.1)
  1. About this guide
    1.  
      Introducing this guide
    2. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Getting started
    1.  
      About classification
    2.  
      Overview of the procedure for setting up classification
    3.  
      Prerequisites for classification
    4.  
      Roles-based administration (RBA) and the classification feature
    5. How Enterprise Vault caches the items that it submits for classification
      1.  
        Limits on the size of classification files
      2.  
        Checking the cache location on the Enterprise Vault storage servers
      3.  
        Configuring Enterprise Vault to keep the classification files in the cache folder
  3. Setting up the classification properties
    1.  
      About the Enterprise Vault classification properties
    2.  
      Setting up the Enterprise Vault classification properties manually
    3.  
      Checking the Folder Usage classification property
    4.  
      How classification property values and retention categories interact
    5.  
      Setting up new values for the Enterprise Vault classification properties
    6.  
      Points to note on setting retention categories
  4. Configuring your classification rules
    1.  
      About classification rules
    2.  
      About the example classification rules
    3.  
      Importing the example rule set
    4.  
      Creating or changing classification rules
    5.  
      Supported configuration parameters for rules that use the Veritas Information Classifier method
  5. Defining and applying classification policies
    1.  
      About classification policies
    2.  
      Defining classification policies
    3.  
      About the PowerShell cmdlets for working with classification policies
    4.  
      Associating classification policies with retention plans
    5.  
      About the PowerShell cmdlets for working with retention plans
    6.  
      Applying retention plans to your Enterprise Vault archives
  6. Running classification in test mode
    1.  
      About classification test mode
    2.  
      Implementing classification test mode
    3.  
      About the PowerShell cmdlets for running classification in test mode
    4.  
      Understanding the classification test mode reports
  7. Publishing classification properties and rules across your site
    1.  
      How to publish the classification properties and rules
  8. Appendix A. Enterprise Vault properties for use in classification rules
    1.  
      About the Enterprise Vault properties
    2.  
      System properties
    3.  
      Attachment properties
    4.  
      Custom Enterprise Vault properties
    5.  
      Custom Enterprise Vault properties for File System Archiving items
    6.  
      Custom Enterprise Vault properties for SharePoint items
    7.  
      Custom Enterprise Vault properties for Compliance Accelerator-processed items
    8.  
      Custom properties for use by policy management software
    9.  
      Custom properties for Enterprise Vault SMTP Archiving
  9. Appendix B. PowerShell cmdlets for use with classification
    1.  
      About the classification cmdlets
    2.  
      Get-EVClassificationPolicy
    3.  
      New-EVClassificationPolicy
    4.  
      Remove-EVClassificationPolicy
    5.  
      Set-EVClassificationPolicy
    6.  
      Import-EVClassificationRules
    7.  
      Publish-EVClassificationRules
    8.  
      Get-EVClassificationTags
    9.  
      Get-EVClassificationTestMode
    10.  
      Set-EVClassificationTestMode
  10. Appendix C. Troubleshooting and performance monitoring
    1.  
      Troubleshooting classification
    2.  
      Checking the classification performance counters

Publish-EVClassificationRules

Publish-EVClassificationRules exports all the Enterprise Vault classification properties and rules from a nominated server to an XML file in the specified location. Enterprise Vault then uses this file to import the classification properties and rules into the target servers. Before the cmdlet does this, it clears any existing properties and rules from those servers.

This cmdlet performs a similar function to the Import-EVClassificationRules cmdlet. However, Import-EVClassificationRules does not create the XML file that Enterprise Vault subsequently imports into the target servers; the cmdlet uses an existing XML file to perform the import part of the operation only.

Note the following:

  • You can run the cmdlet on a different server from the server on which you have configured the classification properties and rules.

  • To run this cmdlet, you must have the system administrator role on both the server where you run the cmdlet and on all the target servers.

  • You must install the Microsoft Data Classification Toolkit on the computer where you run this cmdlet. You can download the toolkit from the following webpage:

    http://www.microsoft.com/download/details.aspx?id=27123

  • If you do not run the cmdlet on an Enterprise Vault server, you must specify either the -SiteId or -Servers parameter. If you run the cmdlet on an Enterprise Vault server and omit these parameters, the cmdlet uses the site of the current server to publish to all the other Enterprise Vault servers in the site.

  • In a cluster configuration (either Windows Server Failover Clustering or Veritas Cluster Server), if you publish the classification properties and rules to one cluster node then all the other nodes are also updated. So, after a failover to another node, classification continues with the same rules as before.

  • In an Enterprise Vault Building Blocks environment, this cmdlet imports only to servers that are currently hosting Enterprise Vault tasks and services.

  • This cmdlet stops the Enterprise Vault Storage service on each target server and then, after it has imported the classification properties and rules, restarts the service.

    Note:

    Other methods for publishing the classification properties and rules do not automatically stop and then restart the Storage service, and this can lead to classification errors. For example, this is the case if you use the PowerShell cmdlets that come with the Microsoft Data Classification Toolkit. Therefore, we strongly recommend that you use Publish-EVClassificationRules (or Import-EVClassificationRules) to publish the classification properties and rules.

Publish-EVClassificationRules is provided by Symantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

Publish-EVClassificationRules [-StagingServer <string>] [-ExportRulesFile <string>] [-SiteId <string>] [-Servers <string>] [-TimeoutSecs <integer>] [-Confirm <Boolean>]

Parameters

Table: Publish-EVClassificationRules parameters

Parameter

Description

-StagingServer (required)

Specifies the name of the server on which you have configured the classification properties and rules and from which you now want to export them.

-ExportRulesFile (required)

Specifies the path to a file to which the cmdlet exports the classification properties and rules, before importing them into the target servers. The cmdlet creates the file locally, so you must specify a local path such as c:\Data\RulesFile.xml. Ensure that the file name has a .xml extension.

-SiteId

Identifies the Enterprise Vault site to which you want to publish the classification properties and rules.

If you set this parameter, you cannot set the -Servers parameter as well.

-Servers

Nominates the servers that will receive the set of classification properties and rules. Type the NETBIOS name, IP address, or fully-qualified domain name of one or more servers in a comma-separated list. To specify the local computer, type the computer name "localhost".

If you set this parameter, you cannot set the -SiteId parameter as well.

-TimeoutSecs

Sets the timeout value in seconds when stopping or starting the Enterprise Vault Storage service on each of the target servers. The default is 300 seconds.

Note:

If the cmdlet fails to restart a service within the specified period, check the state of the classification rules and Storage services on the failed servers. A server can be left without classification rules if the cmdlet clears the existing rules without also importing the new ones.

-Confirm

When set to $true (the default value), causes the cmdlet to prompt you for confirmation before it publishes the classification data. Set to $false to suppress the prompts.

Examples

  • Publish-EVClassificationRules -StagingServer SERVERXYZ -ExportRulesFile c:\Data\RulesFile.xml

    Exports the classification properties and rules from server SERVERXYZ to the specified local file. The cmdlet then publishes the properties and rules to all the Enterprise Vault servers that are in the current site (that is, the same site as the server on which you run the cmdlet).

  • Publish-EVClassificationRules -StagingServer SERVERXYZ -ExportRulesPath c:\Data\RulesFile.xml -SiteId 13E...EV.example.com

    Publishes the exported classification properties and rules to all the Enterprise Vault servers that are in the specified site.

  • Publish-EVClassificationRules -StagingServer SERVERXYZ -ExportRulesPath c:\Data\RulesFile.xml -Servers SERVER1,SERVER2.ABC.DEF.COM

    Publishes the exported classification properties and rules to the specified servers.

Output

This cmdlet returns objects of type Symantec.EnterpriseVault.PowerShell.Commands.ServerInfo, which has the following default properties.

Table: Publish-EVClassificationRules properties

Name

Type

Description

ServerName

String

The name of the Enterprise Vault server.

ServerFQDN

String

The fully qualified domain name of the Enterprise Vault server.

Result

String

The publish result (Succeeded/Failed/DuplicateServer).

ErrorMessage

String

The error reason, if the import to the server was not successful.

Related cmdlets