setopt / showopt

Top  Previous  Next

The following commands are used to set (or reset) S3Express options.

setopt [-retry:X] [-retrywait:X] [-verbosity:X] [-timer:on|off] [-endpoint:ENDPOINT] [-protocol:PROTOCOL] [-clientencpwd:PASSWORD] [-clientencpwdhint:HINT] [-clientencprogram:PROGRAM] [-proxyserver:SERVER] [-qmaxthreads:X] [-timeout:X] [-useV4sign:on|off] [-disablecertvalidation:on|off] [-reset]

Set S3Express options. Options are saved in the Windows registry and are re-used every time S3Express starts, unless changed again.

 

Option

Description

Default Value

-retry:X

Set the number of retries performed by S3Express in the case of a network error. By default S3Express retries 3 times.

3

-retrywait:X

Set the wait time, in seconds, before a retry. Default value is 5 seconds.

5

-verbosity:X

Set the output verbosity level. Default value is 1. It can be increased to 2 or 3.

1

-timer:on|off

Set the timer on or off (use -timer:on to set the timer on, -timer:off to set the timer off). When the timer is on, the elapsed time for each command is included in the output. By default the timer is off.

off

-endpoint:ENDPOINT

Set the service endpoint that S3Express will use for all requests. The default endpoint is s3.amazonaws.com

s3.amazonaws.com

-protocol:PROTOCOL

Set the protocol S3Express should use to connect to Amazon S3 servers. Possible values are https (the default value) or http.

https

Encryption Options

-clientencpwd:PASSWORD

Password to use for local file encryption. See -le flag of the put command.

not set

-clientencpwdhint:HINT

An optional password hint to use during local file encryption. See -le flag of the put command for more info on local file encryption.

 

A password hint is a reminder of how you made up your encryption password and it's added to the metadata of each encrypted file. The metadata header containing the password hint is 'x-amz-meta-s3xpress-encrypted-pwd-hint'. If you forgot the encryption password used to encrypt a file, you can try to use the hint to remember it. The password hint can not contain the password itself, because it is attached to the file metadata unencrypted.

not set

-clientencprogram:PROGRAM

Use this option to specify which program S3Express should use to perform local file encryption (and optionally, depending on the program capabilities, file compression).
 
The default value and the default encryption program used by S3Express is aescrypt. S3Express will use the program aescrypt.exe to perform local file encryption. AEScrypt is an open-source encryption program that can be downloaded from www.aescrypt.com. Download the command line version of AEScrypt for Windows and save the file aescrypt.exe in the same folder where S3Express.exe is located.
 
Alternatively, you can set the -clientencprogram option to 7zip. In this case, S3Express will use the program 7z.exe to encrypt and it also compresses files locally before uploading. 7zip is also open source and can be downloaded from here: www.7-zip.org. Once installed, copy the file 7z.exe to the folder where s3express.exe is located and set the -clientencprogram option to 7zip, e.g.:
setopt -clientencprogram:7zip
 
Finally, you can specify your own custom program to use in the following form: <program path>|<program parameters>, e.g. setopt -clientencprogram:<program_path>|<program_parameters>
<program_path> is the path of the encryption program to use. <program_parameters> are the parameters to be passed to the encryption program. They are to be separated by a |.
<program_parameters> should contain at least 3 tags:
<password> <output> <input>
 
For instance, for aescrypt <program_path> and <program_parameters> would look like this:
setopt -clientencprogram:"aescrypt.exe|-e -p <password> -o <output> <input>"
(aescrypt.exe is in the same folder as s3express.exe, so the program path is just aescrypt.exe)

For 7zip, <program_path> and <program_parameters> would look like this:
setopt -clientencprogram:"7z.exe|a -y -p<password> <output> <input>"

aescrypt

Advanced Options

-proxyserver:SERVER

Set the proxy server S3Express should use to connect to the Internet.

 
If this value is set to auto (the default value), the proxy server address is automatically taken from the Windows Internet settings. S3Express will look for the system proxy settings for https connections. If not present in the system settings, no proxy server will be used.

 
If this value is set to direct, no proxy server is used.

 
Alternatively you can manually specify a proxy server for S3Express to use. This can be in one of the following forms:

 
server (just the proxy server address, e.g. proxyserver.com or 10.1.1.24)

 
server:port (the proxy server address and port, e.g. proxyserver.com:8000 or 10.1.1.24:3128)

 
username:password@server:port (the proxy server address and port, plus username and password, e.g. marc:mypassword@proxyserver.com:3128

 

See some examples below.

auto

-qmaxthreads:X

Sets the maximum amount of concurrent threads to use when querying multiple S3 objects or when deleting multiple S3 objects. By default this value is set to 20. This value does not affect the maximum amount of concurrent threads to use during file uploads (i.e. the put command). To control the maximum amount of concurrent threads to use during file uploads, use the -t parameter of the put command.

20

-timeout:X

Set the timeout (in seconds) of each communication between S3Express and Amazon S3. The default value is 60 seconds. Set timeout to 0 to disable timeout (not recommended).
If no data is exchanged between S3Express and Amazon S3 within the time specified by the -timeout option, then the request is aborted. A new request is initiated if the -retry option allows it (see above).

60

-useV4sign:on|off

Use Amazon S3 signature version 4. By default S3Express will use signature version 4 only for S3 regions where it is required (for example for 'eu-central-1'). Use this option to have S3Express always use signature version 4 for all S3 regions.

off

-disablecertvalidation:on|off

Disable SSL certificate validation over https.

off

Reset Options

-reset

Reset option values to default. To reset a specific option only, specify the option on the command line, e.g. setopt -verbosity -reset or setopt -proxyserver -reset. If no option is specified, e.g. setopt -reset, then all options are reset to default values.

n.a.

 

Note: Once set, options are saved in the Windows Registry and are re-used every time S3Express starts, unless changed again.
The encryption password is stored in the Windows Registry encrypted.

 

 

showopt

Show the current value for specific S3Express options or for all options.
To show specific options only, specify the options on the command line, e.g. showopt -verbosity or setopt -proxyserver or both together showopt -verbosity -proxyserver.
If no option is specified, e.g. using just showopt, then all values of all options are shown. Values that are not the default values are highlighted.

 

 

setopt examples:
 
setopt -retry:10 -retrywait:60
 
setopt -clientencpwd:mypassword
 
setopt -reset
 
setopt -verbosity -reset
 
setopt -timer:on
 
setopt -endpoint:s3-website-us-gov-west-1.amazonaws.com
 
setopt -proxyserver:marc:mypassword@proxyserver.com:3128
 
setopt -proxyserver:10.0.1.254:443
 
setopt -proxyserver:auto
 
setopt -proxyserver:direct
 
setopt -protocol:http
 
setopt -protocol:https
 
setopt -clientencprogram:7zip
 
setopt -disablecertvalidation:on
 
 
showopt examples:
 
showopt
 
showopt -verbosity
 
setopt -proxyserver
 
showopt -verbosity -proxyserver