Enterprise Vault™ Migrating Data Using the Simple Storage Service (S3) API
Simple Storage Service (S3) API server properties
After you select Simple Storage Service (S3) API as the secondary storage for a vault store partition, configure the properties for your S3-complaint cloud storage. Use the Advanced tab of the vault store partition properties page to configure the storage server properties.
Most of the configuration parameters are populated with their default values. You need to manually set the following parameters:
Secure access key ID
Shared secret
Bucket name
Table: S3-complaint cloud storage server properties
Option | Description | Default value |
|---|---|---|
Service host name | The fully qualified host name of the computer that hosts the S3 service. | |
Http port | The http port number on which the S3 service is configured. | 80 |
Https port | The https port number on which the S3 service is configured. | 443 |
Use SSL for control | When set to , Enterprise Vault uses the TLS 1.2 protocol to establish a secure connection to the S3 storage server. Note that the S3 API does not support self-signed certificates. | Yes |
Use SSL for data r/w | When set to , Enterprise Vault uses the TLS 1.2 protocol to establish a secure connection for read and write operations to the S3 storage server. | Yes |
Access Key ID | The secure access key ID, also known as the username, provided by the S3-complaint cloud storage vendor. | None |
Secret Access Key | The account shared secret, also known as the password, provided by the S3-complaint cloud storage vendor. | None |
Supported regions | The geographical regions that are supported by the cloud storage solution for storing data. Regions must be specified in the format identifer, displayname, servicehostname. Use semicolons to separate multiple region names. For example, us-west-1,US West,s3-us-west-1.amazonaws.com; eu-west-1,EU West,s3-eu-west-1.amazonaws.com. Note the following:
| |
| ||
Bucket name | The name of the bucket. The bucket name must be unique across all existing bucket names in the S3 storage solution. To ensure that you use a unique name you could prefix your bucket names with your company's name. There are other requirements that you need to take care of while naming the buckets. Check the appropriate storage solution documentation for bucket naming requirements and guidelines. | |
Bucket region | The geographical location where the bucket is created. | |
Bucket access type | Specifies whether the URL is virtual-hosted-style URL or path-style URL. In a virtual-hosted-style URL, the bucket name is part of the domain name in the URL. For example: http://bucket.s3.amazonaws.com. In a path-style URL, the bucket name is not part of the domain. For example: http://s3.amazonaws.com/bucket. | Virtual |
Write buffer size | The buffer size, in megabytes, Enterprise Vault uses for data uploads. Ensure that this value is greater than the Maximum collection file size setting on the Collections tab of the vault store partitions page. Set this option to zero (0) to disable the use of buffers. | 20 |
Read buffer size | The buffer size, in megabytes, Enterprise Vault uses for data downloads. | 20 |
Log level | The amount of detail to include in the log file. You can select from the following:
Note: If you choose , Enterprise Vault does not log cURL messages even if Log CURL messages is set to Yes. | Errors, Warnings |
Log CURL messages | Specifies whether to log cURL activity. cURL is a command line tool for sending or receiving files using URL syntax. Enterprise Vault uses the cURL library to transfer data to the S3 cloud. | No |
CURL connect timeout | The maximum amount of time, in seconds, the Enterprise Vault S3 API Migrator waits to connect to the S3 storage server. This only limits the connection phase, not the session time. | 300 |
CURL operation timeout | The maximum amount of time, in seconds, the Enterprise Vault S3 Migrator waits to transfer data to and retrieve data from the S3 storage server. | 900 |
CURL proxy type | The CURL proxy types. Proxy types are HTTP, SOCKS, SOCKS4, SOCKS5, SOCKS4A. | None |
CURL proxy IP | The CURL proxy IP. By default, no proxy is used. | <your_proxy_ip> |
CURL proxy port | The CURL proxy port number. | 0 |
User wait timeout | If an Enterprise Vault user's request to retrieve an archived item from the S3 storage server takes longer than normal, specifies the number of seconds after which to present the user with the following message: "The archived item is being retrieved from a slow device. Try again later." Enterprise Vault continues to retrieve the item in the background until the System wait timeout period has elapsed. Enterprise Vault then abandons the attempt to retrieve the item, and the user must submit the retrieval request again. The recommended value is 40 seconds. | 40 |
System wait timeout | If an attempt to retrieve an archived item from the S3 storage server takes an excessively long time, specifies the number of seconds after which to abandon the attempt and remove the requested item from the retrieval queue. The recommended value is 900 seconds. | 900 |
Recalled file cache period | The number of days, since the last accessed date, that Enterprise Vault should retain recalled files in the cache. The collection process deletes the recalled files when the cache period has elapsed. | 7 |
Migrate all files | If the value is set to Yes, Enterprise Vault forces all eligible files to be collected and migrated. Setting this value to Yes may cause Enterprise Vault to create a large number of collection files. If the value is set to No, Enterprise Vault may leave some saveset files uncollected and thus unmigrated. | No |