Registration command of the Default Information for Storage Management Information

You can register the default information for the Send Storage Management Information or the Receive Storage Management Information for Amazon S3 to the Cloud Storage DB.

Command format

utls3infoadd [COMMON-OPTIONS] -t {snd|rcv} --default [MANAGEMENT-OPTIONS]

Parameter explanation

[COMMON-OPTIONS]

This option is common to all utilities.

-f, --force

Omission of confirmation (optional)

This parameter registers information without confirmation of the registered information.

When you omit it, the following confirmation message is output before registration of the default information for the Send Storage Management Information or the Receive Storage Management Information:

Are you sure to register? [y/n]:

Input "y" or "Y" to register the default information for the Send Storage Management Information or the Receive Storage Management Information specified by the command.

Input other than "y" or "Y" ends in an error.

[REQUIRED]

These parameters cannot be omitted.

-t, --type {snd|rcv}

Type of management information (mandatory)

This parameter specifies the type of default information for the Send Storage Management Information or the Receive Storage Management Information that you want to register.

snd:: Send Storage Management Information
rcv:: Receive Storage Management Information

--default

Modification of default information (mandatory)

If you specify Send Storage Management Information for the type of Storage Management Information, the default information for Send Storage Management Information is registered.

If you specify Receive Storage Management Information for the type of Storage Management Information, the default information for Receive Storage Management Information is registered.

[MANAGEMENT-OPTIONS]

These are options for setting of the Send Storage Management Information or the Receive Storage Management Information.

--timeout SEC

Storage timeout (seconds) (optional)

This parameter specifies the time until a timeout for an HTTP request occurs.

Specify from "10" to "259200", or "999999". When you specify "999999", waiting time is infinite.

When you omit specification of this option, the value "Use the default value." is set. In this case, a fixed value (300 seconds) is used during transfer.

--parallels NUM

Maximum number of parallels per transfer (optional)

This parameter specifies the maximum number of parallel uploads or downloads per transfer.

If you specify Receive Storage Management Information for the type of Storage Management Information, the maximum number for parallel uploads is specified. If you specify the Send Storage Management Information, the maximum number for parallel downloads is specified.

Specify from "2" to "999".

When you omit specification of this option, the value "Use the default value." is set. In this case, a fixed value (32) is used during transfer.

= Remarks =

The maximum number of parallels per transfer is limited, as shown below, to the total number of parallels set in Cloud Storage System Environment Settings.

Even if you set a value larger than the total number of parallel uploads set in Cloud Storage System Environment Settings, this total number of parallel uploads prevails as the limit. Specify a value smaller than the total number of parallel uploads.
Even if you set a value larger than the total number of parallel downloads set in Cloud Storage System Environment Settings, this total number of parallel downloads prevails as the limit. Specify a value smaller than the total number of parallel downloads.

--partsize MBYTES

Part size (MB) (optional)

This parameter specifies the part size for parallel uploads or downloads executed at one time.

Specify from "5" to "100".

When you omit specification of this option, the value "Use the default value." is set. In this case, a fixed value (5MB) is used during transfer.

Note

If you change the Part Size to a larger value than the value of "5" that is used when the field is not specified, the load on the system may be high depending on the operating environment. Be aware of this fact when you change the Part Size.

--default-region REGION

Region (optional)

This parameter specifies the region to use for AWS connection. For available regions, refer to Regions for which operation of Amazon S3 has been verified.

Specify up to 255 bytes of ASCII printable characters.

When you omit specification of this option, the value "Use the default value." is set. In this case, the value set for the environment variable (AWS_DEFAULT_REGION) is used during transfer.

--endpoint-url URL

Endpoint URL (optional)

This parameter specifies the URL of an endpoint to which requests are sent for AWS connection.

Specify up to 255 bytes of ASCII printable characters.

Specify a URL starting with "http://" or "https://".

Example) https://bucket.vpce-1a2b3c4d-5e6f.s3.us-east-1.vpce.amazonaws.com

If you specify uppercase characters in the URL, those characters are converted to lowercase characters when connecting to AWS.

If you specify "none", the standard S3 endpoint for AWS is used during transfer.

When you omit specification of this option, the value "Use the default value." is set. In this case, the standard S3 endpoint for AWS is used during transfer.

For standard S3 endpoints, refer to the documents provided by AWS.

--acl ACL

ACL that is applied to upload files (optional)

This parameter specifies an Access Control List (ACL) to control access to objects.

Specify from 1 to 255 bytes of ASCII printable characters.

When you omit specification of this option, the value "Use the default value." is set. In this case, an ACL is not used during transfer.

--auth-id ID

Storage Authentication Information ID (optional)

This parameter specifies the ID of the Storage Authentication Information that you want to associate with the Send Storage Management Information or the Receive Storage Management Information.

Specify from 3 to 63 bytes of ASCII printable characters.

If you include single-byte spaces, "/", or "*", an error occurs.

When you omit specification of this option, the value "Use the default value." is set. In this case, the value set in the default information for the Storage Authentication Information is used during transfer.

Supplement

As shown below, you can specify either with a space or an equals sign (=) between the parameter and the setting value.
```
  --parameter Value 
  --parameter=Value
```
If you specify "-h" or "--help" for the parameter, the usage is output.