Pvcl_cloud configuration settings reference

pvcl_cloud is the HSTS service that is used to connect and write to Cloud Object Storage.

The following tables describe the pvcl_cloud options that can be set in the aspera.conf file. These values can be added by using the asconfigurator utility or can be added manually. Examples of both methods are provided in the following tables:

Browse behavior and permissions

Table 1. List of configuration settings
Details Examples
Setting
pvcl_browse_directory_permission

Description
When listing directories in cloud storage, you can define which permission details are returned. When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
  • Permissions value: 0755.
  • Type: Octal Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_browse_directory_permission,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_browse_directory_permission><value></pvcl_browse_directory_permission>
    </pvcl>
</default>
Setting
pvcl_browse_file_permission

Description
In cloud storage, the permissions do not exist, but you can specify which permissions are returned for a file when listing the storage. When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
  • Permissions value: 0644.
  • Type: Octal Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_browse_file_permission,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_browse_file_permission><value></pvcl_browse_file_permission>
    </pvcl>
</default>
Setting
pvcl_browse_file_readable_permission

Description
In cloud storage, the permissions do not exist, but you can specify which permissions are returned for a read-only file when listing the storage.
When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
  • Permissions Default value: 0444.
  • Type: Octal Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_browse_file_readable_permission,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_browse_file_readable_permission><value></pvcl_browse_file_readable_permission>
    </pvcl>
</default>
Setting
pvcl_browse_file_writable_permission

Description
In cloud storage, permissions do not exist, but you can specify which permissions are returned for a writable-only file when listing the storage, for example: S3 Glacier file.
When set to "undefined", pvcl_cloud relies on the predefined value for the the storage.
Supported Cloud Storage
  • Amazon AWS S3,
Values and type
  • Default value: undefined
  • Permissions value: 0222.
  • Type: Octal Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_browse_file_readable_permission,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_browse_file_readable_permission><value></pvcl_browse_file_readable_permission>
    </pvcl>
</default>
Setting
pvcl_browse_mkdir_allowed

Description
The creation of explicit directories is allowed and enabled.
When disabled, mkdir is returned without an empty object that represents the creation of the directory.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: true
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_browse_mkdir_allowed,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_browse_mkdir_allowed><value></pvcl_browse_mkdir_allowed>
    </pvcl>
</default>
Setting
pvcl_browse_partial_include_details

Description
Files being transferred are not listed or visible as a file until the transfer is complete.
This applies to S3 when a multipart upload is used. If an ls or list operation returns the file in the result, details such as size and last modification time are included only if this property is set to true.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: false
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_browse_partial_include_details,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_browse_partial_include_details><value></pvcl_browse_partial_include_details>
    </pvcl>
</default>
Setting
pvcl_browse_partial_included

Description
Files being transferred are not listed or visible as a file until the transfer is complete. This is the case for S3 when a multipart upload is used. These files are returned in the result of a ls or list operation only if this property is true.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage.
Values and type
  • Default value: true
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_browse_partial_included,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_browse_partial_included><value></pvcl_browse_partial_included>
    </pvcl>
</default>
Setting
pvcl_browse_partial_extension

Description
Files being transferred are not listed or visible as a file until the transfer is complete.
This is the case for S3 when a multipart upload is used. These files are represented in the result of a ls or list operation with the specified extension.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: "partial"
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_browse_partial_extension,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_browse_partial_extension><value></pvcl_browse_partial_extension>
    </pvcl>
</default>
Setting
pvcl_s3fox_directory_supported

Description
Support for s3Fox native S3 folders. By using this option, the folder is named foo_$folder$.
  • Files inside the folder are named: foo/bar,foo/bass.
  • Subfolder: foo/baz_$folder$.

Supported Cloud Storage
  • Amazon AWS S3.
Values and type
  • Default value: false
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_s3fox_directory_supported,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_s3fox_directory_supported><value></pvcl_s3fox_directory_supported>
    </pvcl>
</default>
Setting
pvcl_symlink_supported

Description
Defines whether symbolic link support is wanted. In cloud storage, symbolic links are not natively supported so pvcl_cloud provides a way to simulate a symbolic link.
A symbolic link is a file with the extension .asp-trapd-lnk, which contains the path to the target file or directory

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: false
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_symlink_supported,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_symlink_supported><value></pvcl_symlink_supported>
    </pvcl>
</default>

Upload and download behavior and limits

Table 2. List of configuration settings
Details Details
Setting
pvcl_check_dir_before_upload

Description
In cloud storage, it is possible to have a directory and an object with the same name.
The directory name must have a slash (/) at the end. For example,
  • Directory: dir/myname/
  • Object: dir/myname.
When set to true, pvcl_cloud fails the transfer if a directory with the same name as the source file exists.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: true
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_check_dir_before_upload,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_check_dir_before_upload><value></pvcl_check_dir_before_upload>
    </pvcl>
</default>
Setting
pvcl_delete_before_upload

Description
Enable or disable deleting files before upload. If enabled, objects or multipart uploads and their related parts, are deleted.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: true
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_delete_before_upload,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_delete_before_upload><value></pvcl_delete_before_upload>
    </pvcl>
</default>
Setting
pvcl_max_file_size

Description
The storage defines the maximum supported file size.
When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
    • Microsoft Azure: The maximum size is 5 TB.
    • IBM Cloud Storage: The maximum size is 10 TB.
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_max_file_size,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_max_file_size><value></pvcl_max_file_size>
    </pvcl>
</default>
Setting
pvcl_max_part_count

Description
Maximum number of parts of a multipart upload.
When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
    • IBM Cloud Storage: The maximum number of parts is 10,000.
    • Google Cloud Storage: The maximum number of parts is 1024.
    • Microsoft Azure: No limits apply.
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_max_part_count,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_max_part_count><value></pvcl_max_part_count>
    </pvcl>
</default>
Setting
pvcl_max_part_size

Description
Maximum size of a part (multipart uploads).
When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
    • The maximum size is 5 GB.
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_max_part_size,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_max_part_size><value></pvcl_max_part_size>
    </pvcl>
</default>
Setting
pvcl_min_part_size

Description
Minimum size of a part (multipart uploads).
When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure Block Blob, Page Blob, and File Share,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
    • Amazon AWS S3, IBM Cloud Storage, Microsoft Azure Block Blob: The minimum size is 5 MB.
    • Microsoft Azure File Share and Microsoft Azure Page Blob: The minimum size is 3 MB.
    • Google Cloud Storage: The minimum size is 32 MB.
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_min_part_size,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_min_part_size><value></pvcl_min_part_size>
    </pvcl>
</default>
Setting
pvcl_max_single_put

Description
Defines how the file is transferred. If the file size is larger than the value in this option, multipart uploads are used, otherwise a single PUT is used. When tier to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
    • The maximum size is 5 MB.
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_max_single_put,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_max_single_put><value></pvcl_max_single_put>
    </pvcl>
</default>
Setting
pvcl_max_upload_size

Description
Defines how an object is copied. If the file size is larger than the value in this option, multipart uploads is used, otherwise a CopyObject request is used. When set to "undefined", pvcl_cloud relies on the predefined value for storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage.
Values and type
  • Default value: undefined
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_max_upload_size,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_max_upload_size><value></pvcl_max_upload_size>
    </pvcl>
</default>
Setting
pvcl_start_check_small_file

Description
Enable or disable the checks for open-write for small files before you start the upload process.
Small files are files that are smaller or equal to 'pvcl_max_single_put'.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: true
    The default size for a small file is 5 MB.
  • Type: Boolean.
  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_start_check_small_file,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_start_check_small_file><value></pvcl_start_check_small_file>
    </pvcl>
</default>

Threading and performance

Table 3. List of configuration settings
Details Examples
Setting
pvcl_download_largevm_max_thread_count

Description
Number of threads that are allowed to run in parallel for downloads and for large virtual machines.
This option is used as the default value for 'pvcl_download_max_thread_count' if pvcl_cloud is running on a large virtual machine.
A large virtual machine has both more cores than 'pvcl_download_largevm_min_cpus' and more RAM than 'pvcl_download_largevm_min_ram'.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: 20
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_download_largevm_max_thread_count,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_download_largevm_max_thread_count><value></pvcl_download_largevm_max_thread_count>
    </pvcl>
</default>
Setting
pvcl_download_largevm_min_cpus

Description
When downloading, the CPU criterion is used to decide what constitutes a large virtual machine.
A 'large' virtual machine has both more cores than 'pvcl_download_largevm_min_cpus' and more RAM than 'pvcl_download_largevm_min_ram'.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: 12
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_download_largevm_min_cpus,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_download_largevm_min_cpus><value></pvcl_download_largevm_min_cpus>
    </pvcl>
</default>
Setting
pvcl_download_largevm_min_ram

Description
When downloading, the RAM criterion is used to decide what constitutes a large virtual machine. A 'large' virtual machine has both more cores than 'pvcl_download_largevm_min_cpus' and more RAM than 'pvcl_download_largevm_min_ram'.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: 59055800320
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_download_largevm_min_ram,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_download_largevm_min_ram><value></pvcl_download_largevm_min_ram>
    </pvcl>
</default>
Setting
pvcl_download_largevm_min_range_size

Description

Minimum number of bytes downloaded per HTTP request when reading an object for large virtual machines. This option is used as the default value for 'pvcl_download_min_range_size' if pvcl_cloud is running on a large virtual machine.
A large virtual machine has both more cores than 'pvcl_download_largevm_min_cpus' and more RAM than 'pvcl_download_largevm_min_ram'.
This setting controls the smallest amount of data (in bytes) that is downloaded each time that a request is made when reading a file on large virtual machines.
It is used as the default value for the setting pvcl_download_min_range_size, but only if pvcl_cloud is running on a large virtual machine.
A virtual machine is considered large if it has more CPU cores than pvcl_download_largevm_min_cpus and more memory (RAM) than pvcl_download_largevm_min_ram.
When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
    • Amazon AWS S3, IBM Cloud Storage, Google Cloud Storage: The minimum downloaded bytes are 16 MB.
    • Microsoft Azure: The minimum download size is 4 MB.
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_download_largevm_min_range_size,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_download_largevm_min_range_size><value></pvcl_download_largevm_min_range_size>
    </pvcl>
</default>
Setting
pvcl_download_max_thread_count

Description
Number of threads allowed to run in parallel for downloads.
Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: 20
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_download_max_thread_count,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_download_max_thread_count><value></pvcl_download_max_thread_count>
    </pvcl>
</default>
Setting
pvcl_download_min_range_size

Description
Minimum number of bytes downloaded per HTTP request when reading an object.
When set to "undefined", pvcl_cloud relies on the predefined value for storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
  • Other values:
    Amazon AWS S3, IBM Cloud Storage, Google Cloud Storage: The minimum size is 8 MB.
    Microsoft Azure: The minimum size is 2 MB.
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_download_min_range_size,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_download_min_range_size><value></pvcl_download_min_range_size>
    </pvcl>
</default>
Setting
pvcl_max_retry_count

Description
The maximum number of times that an operation is retried when a recoverable failure was detected.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: 15
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_max_retry_count,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_max_retry_count><value></pvcl_max_retry_count>
    </pvcl>
</default>
Setting
pvcl_max_thread_count

Description
Maximum number of threads in the global thread pool.
When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: undefined
    • Amazon AWS S3, IBM Cloud Storage, Google Cloud Storage: The minimum number of threads is 300.
    • Microsoft Azure: The minimum number of threads is 10.
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_max_thread_count,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_max_thread_count><value></pvcl_max_thread_count>
    </pvcl>
</default>
Setting
pvcl_upload_max_thread_count

Description
For uploads, defines the number of threads that are allowed to run in parallel.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: 20
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_upload_max_thread_count,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_upload_max_thread_count><value></pvcl_upload_max_thread_count>
    </pvcl>
</default>
Setting
pvcl_upload_largevm_min_cpus

Description
When uploading, the CPU criterion that is used to decide what is a large virtual machine.
A 'large' virtual machine has more cores than 'pvcl_upload_largevm_min_cpus' and more RAM than 'pvcl_upload_largevm_min_ram'.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: 12
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_upload_largevm_min_cpus,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_upload_largevm_min_cpus><value></pvcl_upload_largevm_min_cpus>
    </pvcl>
</default>
Setting
pvcl_upload_largevm_min_ram

Description
For uploads, defines the RAM criterion that is used to decide what is a large virtual machine when uploading.
A large virtual machine has both more cores than 'pvcl_upload_largevm_min_cpus' and more RAM than 'pvcl_upload_largevm_min_ram'.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: 59055800320
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_upload_largevm_min_ram,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_upload_largevm_min_ram><value></pvcl_upload_largevm_min_ram>
    </pvcl>
</default>
Setting
pvcl_upload_largevm_max_thread_count

Description
For uploads, defines the number of threads that are allowed to run in parallel for large virtual machines.
This option is used as the default value for 'pvcl_upload_max_thread_count' if pvcl_cloud is running on a large virtual machine.
A large virtual machine has both more cores than 'pvcl_upload_largevm_min_cpus' and more RAM than 'pvcl_upload_largevm_min_ram'.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Microsoft Azure,
  • Google Cloud Storage.
Values and type
  • Default value: 50
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_upload_largevm_max_thread_count,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_upload_largevm_max_thread_count><value></pvcl_upload_largevm_max_thread_count>
    </pvcl>
</default>

Region and security settings

Table 4. List of configuration settings
Details Examples
Setting
pvcl_allow_cross_region

Description
Allow cross-region transfers. By default, a computer that is in a different region as the storage can't initiate a transfer.

Supported Cloud Storage
  • Amazon AWS S3.
Values and type
  • Default value: false
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_allow_cross_region,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_allow_cross_region><value></pvcl_allow_cross_region>
    </pvcl>
</default>
Setting
pvcl_disable_dns_buckets

Description
Disable the use of the bucket name in the request to the hostname.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage.
Values and type
  • Default value: false
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_disable_dns_buckets,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_disable_dns_buckets><value></pvcl_disable_dns_buckets>
    </pvcl>
</default>
Setting
pvcl_force_region

Description
This option forces the use of an S3 endpoint in the specified region.

Supported Cloud Storage
  • Amazon AWS S3.
Values and type
  • Default value: The region used by the computer
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_force_region,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_force_region><value></pvcl_force_region>
    </pvcl>
</default>
Setting
pvcl_hierarchical_mode

Description
Used to enable or disable the hierarchical mode when listing the multipart uploads.
When 'disabled' (flat mode): Delimiters are not used in list queries.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage.
Values and type
  • Default value: true
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_hierarchical_mode,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_hierarchical_mode><value></pvcl_hierarchical_mode>
    </pvcl>
</default>
Setting
pvcl_https_only

Description
Specifies whether to use HTTP or HTTPS for storage requests.
  • true: Use HTTPS for requests to storage.
  • false: Use HTTP for requests to storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage.
Values and type
  • Default value: true
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_https_only,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_https_only><value></pvcl_https_only>
    </pvcl>
</default>
Setting
pvcl_payload_checksum_algo

Description
Defines how an object integrity is checked.

Supported Cloud Storage

  • IBM Cloud Storage,
  • Amazon AWS S3.
Values and type
  • Default value: undefined
  • Other values:
    • none:0
    • sha256:1
    • sha256header:2
    • Undefined
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_ssl_cert_dir,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_ssl_cert_dir><value></pvcl_ssl_cert_dir>
    </pvcl>
</default>
Setting
pvcl_ssl_cert_dir

Description
Specifies the path from which SSL certificates are loaded.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: ""(empty string)
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_ssl_cert_dir,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_ssl_cert_dir><value></pvcl_ssl_cert_dir>
    </pvcl>
</default>
Setting
pvcl_ssl_cert_file

Description
Specifies the path to the SSL certificate.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: ""(empty string)
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_ssl_cert_file,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_ssl_cert_file><value></pvcl_ssl_cert_file>
    </pvcl>
</default>
Setting
pvcl_ssl_verify

Description
Defines whether to check the SSL certificate.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: true
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_ssl_verify,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_ssl_verify><value></pvcl_ssl_verify>
    </pvcl>
</default>

IAM and AUTH configuration

Table 5. List of configuration settings
Details Examples
Setting
pvcl_iam_default_client_id

Description
Defines the client ID for the token authentication.

Supported Cloud Storage
  • IBM Cloud Storage.
Values and type
  • Default value: ""(empty string)
  • Type: String..

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_iam_default_client_id,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_iam_default_client_id><value></pvcl_iam_default_client_id>
    </pvcl>
</default>
Setting
pvcl_iam_default_client_secret

Description
The client secret for the token used for authentication.

Supported Cloud Storage
  • IBM Cloud Storage.
Values and type
  • Default value: ""(empty string)
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_iam_default_client_secret,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_iam_default_client_secret><value></pvcl_iam_default_client_secret>
    </pvcl>
</default>
Setting
pvcl_iam_endpoint

Description
The IAM endpoint to use when using IAM secure access.

Supported Cloud Storage
  • IBM Cloud Storage, Microsoft Azure.
Values and type
  • Default value: ""(empty string)
  • Type: String.

Examples

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_iam_endpoint,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_iam_endpoint><value></pvcl_iam_endpoint>
    </pvcl>
</default>
Setting
pvcl_sts_endpoint

Description
The STS endpoint to use for assumed role authentication.
Set this property to force the use of a specific STS endpoint.

Supported Cloud Storage
  • Amazon AWS S3.
Values and type
  • Default value: undefined and the behavior is as follows:
    • If the region is unknown, the global STS endpoint is used.
    • If the region is detected, the regional STS endpoint is used.
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_sts_endpoint,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_sts_endpoint><value></pvcl_sts_endpoint>
    </pvcl>
</default>

HTTP and networking

Table 6. List of configuration settings
Details Examples
Setting
pvcl_endpoint_force_from_uri

Description
To force the endpoint from the URI and avoid the use of the endpoint that is retrieved or computed from the local instance.

Supported Cloud Storage
  • Google Cloud Storage.
Values and type
  • Default value: false
  • Type: Boolean.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_endpoint_force_from_uri,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_endpoint_force_from_uri><value></pvcl_endpoint_force_from_uri>
    </pvcl>
</default>
Setting
pvcl_http_connection_timeout_sec

Description
Defines the time within which pvcl_cloud must establish a connection with the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage.
Values and type
  • Default value: 20
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_http_connection_timeout_sec,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_http_connection_timeout_sec><value></pvcl_http_connection_timeout_sec>
    </pvcl>
</default>
Setting
pvcl_http_user_agent

Description
Defines the user agent that is in the header of each HTTP request that is sent to the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • Google Cloud Storage.
Values and type
  • Default value: The user agent is defined in the header of each HTTP request sent to storage.
    • Amazon AWS S3 and IBM Cloud Storage:
      APN/1.0 Aspera/1.0 EnterpriseServer/VERSION
    • Google Cloud Storage:
      EnterpriseServer/VERSION (GPN:Asperasoft;Production)
      Note: Replace VERSION with the installer version.
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_http_user_agent,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_http_user_agent><value></pvcl_http_user_agent>
    </pvcl>
</default>

Metadata and segmenting

Table 7. List of configuration settings
Details Examples
Setting
pvcl_aspera_transfer_meta_key

Description
The key of the metadata that was added to the uploaded files to mark them as an Aspera transfer.
If no key value is defined or an empty string is specified, the system does not add the metadata.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: .aspera.transfer
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_aspera_transfer_meta_key,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_aspera_transfer_meta_key><value></pvcl_aspera_transfer_meta_key>
    </pvcl>
</default>
Setting
pvcl_aspera_transfer_meta_value

Description
Value of the metadata that is added to uploaded files to mark them as an Aspera transfer.
If no key value is defined or an empty string is specified, the system does not add the metadata.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage,
  • Google Cloud Storage.
Values and type
  • Default value: true
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_aspera_transfer_meta_value,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_aspera_transfer_meta_value><value></pvcl_aspera_transfer_meta_value>
    </pvcl>
</default>
Setting
pvcl_project_id

Description
Google Cloud Storage project ID.

Supported Cloud Storage
  • Google Cloud Storage.
Values and type
  • Default value: ""(empty string)
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_project_id,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_project_id><value></pvcl_project_id>
    </pvcl>
</default>
Setting
pvcl_segment_dir

Description
The name of the directory used to store segments (parts). For performance reasons, when uploading to Google Cloud Storage, the system might split a file into multiple objects (segments).
After all segments are uploaded, the system reconstructs the original object from them.

Supported Cloud Storage
  • Google Cloud Storage.
Values and type
  • Default value: .aspera-segments
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_segment_dir,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_segment_dir><value></pvcl_segment_dir>
    </pvcl>
</default>

Multi-session tuning

Table 8. List of configuration settings
Details Examples
Setting
pvcl_multi_session_missing_part_max_to_wait

Description
When multi-session is enabled and a file is split and transferred by multiple ascp sessions (by using the ascp -C option, for details see Ascp command reference), pvcl_cloud continues with the next file if the number of missing parts exceeds the defined threshold and another ascp/pvcl_cloud session is handling them. Otherwise, it waits for all parts to arrive before the transfer completes.
When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage.
Values and type
  • Default value: undefined
    The maximum time to wait: 50 seconds.
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_multi_session_missing_part_max_to_wait,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_multi_session_missing_part_max_to_wait><value></pvcl_multi_session_missing_part_max_to_wait>
    </pvcl>
</default>
Setting
pvcl_multi_session_missing_part_wait_period_sec

Description
Waiting time before each check to confirm that all parts are present.
When set to "undefined", pvcl_cloud relies on the predefined value for the storage.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage.
Values and type
  • Default value: undefined
  • Other values: 2
  • Type: Integer.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_multi_session_missing_part_wait_period_sec,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_multi_session_missing_part_wait_period_sec><value></pvcl_multi_session_missing_part_wait_period_sec>
    </pvcl>
</default>
Setting
pvcl_multi_session_wait_for_start

Description
When multi-session is enabled and a file is split across multiple ascp processes (by using the ascp -C option, for details see Ascp command reference), one process creates the temporary file while the others wait. The wait log uses a time:interval format, where the first number is the elapsed time in seconds and the second is the interval between checks.
By default, pvcl_cloud checks every 2 seconds for the first 40 seconds, then every 10 seconds for the next 40 seconds, and every 30 seconds for the following 10,720 seconds. If the file is not created within 10,800 seconds, the transfer fails.

Supported Cloud Storage
  • Amazon AWS S3,
  • IBM Cloud Storage.
Values and type
  • Default value: "40:2,80:10,10800:30"
  • Type: String.

  1. By using asconfigurator: 
    asconfigurator -x "set_node_data;pvcl_multi_session_wait_for_start,<value>
  2. Manually: 
    <default>
    <pvcl>
      <pvcl_multi_session_wait_for_start><value></pvcl_multi_session_wait_for_start>
    </pvcl>
</default>