Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Archiving: Skype for Business
- Archiving: SMTP
- IMAP access
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
This cmdlet is only for use with the classification feature that was introduced in Enterprise Vault 12. This feature uses the Microsoft File Classification Infrastructure (FCI) to classify archived content. The cmdlet is not designed for use with the later, Veritas Information Classifier method of classification.
Import-EVClassificationFCIRules imports all the Enterprise Vault classification properties and rules from a file 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 Publish-EVClassificationFCIRules cmdlet. The difference is that Publish-EVClassificationFCIRules first exports the classification properties and rules to an XML file before it publishes them to the target servers; Import-EVClassificationFCIRules uses an existing XML file to perform the import part of the operation only.
Note the following:
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.
Install the Microsoft Data Classification Toolkit on the server where you run this cmdlet. You can download the toolkit from the following webpage:
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 import the classification properties and rules into 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.
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 Import-EVClassificationFCIRules (or Publish-EVClassificationFCIRules) to publish the classification properties and rules.
Import-EVClassificationFCIRules is provided by the snap-in
Import-EVClassificationFCIRules [-ImportRulesFile <String>] [-SiteId <String>] [-Servers <String>] [-TimeoutSecs <Integer>] [-Confirm <Boolean>]
Table: Import-EVClassificationFCIRules parameters
Specifies the file from which the cmdlet imports the classification properties and rules. The file must have a
Identifies the 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.
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 each server 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.
Sets the timeout value in seconds when the cmdlet stops or starts the Enterprise Vault Storage service on each of the target servers. The default is 300 seconds.
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.
When set to $true (the default value), causes the cmdlet to prompt you for confirmation before it imports the classification properties and rules. Set to $false to suppress the prompts.
Import-EVClassificationFCIRules -ImportRulesFile c:\Data\RulesFile.xml
Imports the classification properties and rules that are in the specified file into 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).
Import-EVClassificationFCIRules -ImportRulesFile c:\Data\RulesFile.xml -SiteId 13E...EV.example.com
Imports the classification properties and rules that are in the specified file into all the Enterprise Vault servers that are in the specified site.
Import-EVClassificationFCIRules -ImportRulesFile c:\Data\RulesFile.xml -Servers SERVER1,SERVER2.ABC.DEF.COM
Imports the classification properties and rules that are in the specified file into all the specified servers.
This cmdlet returns objects of type Symantec.EnterpriseVault.PowerShell.Commands.ServerInfo, which has the following default properties.
Table: Import-EVClassificationFCIRules properties
The name of the Enterprise Vault server.
The fully qualified domain name of the Enterprise Vault server.
The import result (Succeeded/Failed/DuplicateServer).
The error reason, if the import to the server was not successful.