Enterprise Vault™ PowerShell Cmdlets

Rebuild

To completely rebuild index volumes. It also upgrades 32-bit and 64-bit index volumes to Elasticsearch, if necessary. The old index volumes remain searchable during the rebuild to avoid any impact on users.

Synchronize

To synchronize index volumes and fix the known issues. The Synchronize task attempts to index items that were not indexed previously and are reported as missing items in the Index Volume Brower.

Verify

To check that index volumes are accessible and healthy. You can apply verification level as Complete verification or Basic verification. The Basic verification checks index volumes for critical issues. The Complete verification checks for critical issues, and also runs an item-level verification to check for items that are indexed but not present in the archive, and items that are archived but not indexed.

Upgrade

To upgrade the archives that have 32-bit and 64-bit index volumes to use Elasticsearch index volumes. The old indexes remain available during the upgrade so that user searches are unaffected. Note: Before you upgrade an index volume, execute Synchronize on the same index volume to fix issues that have been identified already.

-SiteId

String

The ID of the Enterprise Vault site for which you want to submit the index sub task. You can use Get-EVSite to obtain the site ID.

-Type (required)

INDEXING_SUBTASK_TYPE

Possible values: Rebuild, Synchronize, Verify, or Upgrade

The type of indexing subtask you want to perform.

-Name

String

The name for the indexing subtask. You can give any custom name where allowed characters are alpha-numeric, hyphen (-), underscore (_), space, colon (:), brackets ([]). If you do not specify this parameter, then the cmdlet will automatically generate a unique name.

-ArchiveIDs

List<String>

The list of IDs of the archives on which the indexing subtask will be performed. Each value must follow the EV GUID format. You can use Get-EVArchive to obtain the list of available IDs.

-IndexVolumeIDs

List<int>

The list of IDs of the index volumes on which the indexing subtask will be performed. Each value must be of integer type. You can use Get-EVIndexVolume to obtain the list of available IDs.

-IgnoreFailedItems

SwitchParameter

Default value: $false

This parameter can be specified only if Type is mentioned as Upgrade or Rebuild. If specified, the cmdlet ignores any errors and completes the subtasks. Otherwise, by default, the cmdlet waits for the user interaction to complete the task in case of errors.

-SiteId

String

The ID of the Enterprise Vault site for which you want to submit the index sub task. You can use Get-EVSite to obtain the site ID.

-Type (required)

INDEXING_SUBTASK_TYPE

Possible values: Rebuild, Synchronize, Verify, or Upgrade

The type of indexing subtask you want to perform.

-Name

String

The name for the indexing subtask. You can give any custom name where allowed characters are alpha-numeric, hyphen (-), underscore (_), space, colon (:), brackets ([]). If you do not specify this parameter, the cmdlet will automatically generate a unique name.

-IndexVolumeIDs

List<int>

The list of IDs of the index volumes on which the indexing subtask will be performed. Each value must be of integer type. You can use Get-EVIndexVolume to obtain the list of available IDs.

-SiteId

String

The ID of the Enterprise Vault site for which you want to submit the index sub task. You can use Get-EVSite to obtain the site ID.

-Type (required)

INDEXING_SUBTASK_TYPE

Possible values: Rebuild, Synchronize, Verify, or Upgrade.

The type of indexing subtask you want to perform.

-Name

String

The name for the indexing subtask. You can give any custom name where allowed characters are alpha-numeric, hyphen (-), underscore (_), space, colon (:), brackets ([]). If you do not specify this parameter, then the cmdlet will automatically generate a unique name.

-IndexLocationIDs

List<String>

The list of IDs of the index locations on which the indexing subtask will be performed. Each value must follow the EV GUID format. You can use Get-EVIndexLocation to obtain the list of available IDs.

-ArchiveIDs

List<String>

The list of IDs of the archives on which the indexing subtask will be performed. Each value must follow the EV GUID format. You can use Get-EVArchive to obtain the list of available IDs.

-IndexVolumeIDs

List<int>

The list of IDs of the index volumes on which the indexing subtask will be performed. Each value must be of integer type. You can use Get-EVIndexVolume to obtain the list of available IDs.

-VerificationLevel

VERIFICATION_LEVEL

Possible values: Complete, Basic

Type of verification level you want to apply on archives, index volumes, or index locations. The Verification Level should be either Complete or Basic. The Complete verification level checks that the index volume is accessible and healthy, and completes an item-level verification of the index volume. It identifies items that exist in the archive but are not indexed, and items that are indexed but are no longer in the archive. The Basic verification level checks that the index volume is accessible and healthy.

-AutoSynchronize

SwitchParameter

If specified, creates a synchronization task automatically for each index volume in which there are errors. It can be specified only if the Type is mentioned as Verify and the Verification Level is set to Complete.

-IncludeContentMissingDetails

SwitchParameter

Specify if you want each item that is missing content to be logged individually. It can be specified only if the Type is mentioned as Verify and the Verification Level is set to Complete.

-SiteId

String

The ID of the Enterprise Vault site for which you want to submit the index sub task. You can use Get-EVSite to obtain the site ID.

-Type (required)

INDEXING_SUBTASK_TYPE

Possible values: Rebuild, Synchronize, Verify, or Upgrade

The type of indexing subtask you want to perform.

-Name

String

The name for the indexing subtask. You can give any custom name where allowed characters are alpha-numeric, hyphen (-), underscore (_), space, colon (:), brackets ([]). If you do not specify this parameter, then the cmdlet will automatically generate a unique name.

-ArchiveIDs

List<String>

The list of IDs of the archives on which the indexing subtask is to be performed. Each value must follow EV GUID format. You can use Get-EVArchive to obtain the list of available IDs.

-IgnoreFailedItems

SwitchParameter

Default value: $false

It can be specified if Type is mentioned as Upgrade or Rebuild. If specified, the cmdlet ignores any errors and completes the subtasks. Otherwise, by default the cmdlet waits for the user interaction to complete the task in case of errors.