Merge tag 'upstream/3.3.2'
[debian/amanda] / man / xml-source / amanda-devices.7.xml
index f1792bdc6922edc849a664066412c15c91d722b9..f122e98fa3bb4c4664ac693b1b472ebd5c5eab16 100644 (file)
@@ -202,6 +202,10 @@ for future expansion.  Not all devices implement all of these properties.</para>
  <!-- ==== -->
  <varlistentry><term>MAX_VOLUME_USAGE</term><listitem>
  (read-write) On devices that support it, this property will limit the total amount of data written to a volume; attempts to write beyond this point will cause the device to simulate "out of space."  Zero means no limit.  The tapetype parameter <emphasis>length</emphasis> sets this property.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>ENFORCE_MAX_VOLUME_USAGE</term><listitem>
+ (read-write) If this property is false, limit set by MAX_VOLUME_USAGE property (and thus the tapetype LENGTH parameter) will not be verified while writing to device, allowing the volume to expand without limit. If this property is true, then MAX_VOLUME_USAGE willbe enforced, limiting the total size of the volume. This property is not available on all devices; see below.
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>PARTIAL_DELETION</term><listitem>
@@ -371,7 +375,7 @@ as properties.</para>
 
 <para>The S3 device driver stores each block in a distinct S3 object.  Due to
 high HTTP overhead for each request, use of larger than normal block
-  sizes (&gt; 1 megabyte) is reccomended with the S3 device.</para>
+  sizes (&gt; 1 megabyte) is recommended with the S3 device.</para>
 
 <para>
 Amanda automatically creates a bucket when writing, if the bucket doesn't
@@ -401,6 +405,8 @@ chasing down a problem in communications with Amazon's servers.</para>
 <para>Since Amazon storage is unlimited, the device never encounteres EOM, so
 LEOM detection is trivially enabled for this device.</para>
 
+<para>This driver supports the ENFORCE_MAX_VOLUME_USAGE property. Default value is false. See COMMON_PROPERTIES, above.</para>
+
 <refsect3><title>Device-Specific Properties</title>
 
 <para>In addition to the common properties, the S3 device supports the
@@ -417,6 +423,22 @@ device-property "S3_SECRET_KEY" "agphc2Q7Zmxragphc2RmO2xragpzZGY7a2xqCgr"
 
 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
 <variablelist>
+ <!-- ==== -->
+ <varlistentry><term>CLIENT_ID</term><listitem>
+(read-write) The client_id for oauth2.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>CLIENT_SECRET</term><listitem>
+(read-write) The client_secret for oauth2.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>CREATE-BUCKET</term><listitem>
+(read-write) Default: yes. If amanda create/delete the bucket.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>REFRESH_TOKEN</term><listitem>
+(read-write) The refresh-token for oauth2.
+</listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>MAX_RECV_SPEED</term><listitem>
 (read-write) Maximum speed, in bytes per second, that this device will receive
@@ -428,6 +450,39 @@ reading long enough to bring the average below this value.
 (read-write) Maximum speed, in bytes per second, that this device will send
 data to S3.  If the average speed exceeds this value, the device will stop
 writing long enough to bring the average below this value.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>S3_MULTI_DELETE</term><listitem>
+(read-write) If the server support the multi delete protocol (only Amazon S3),
+default is "YES". If it fail, it revert to single delete.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>NB_THREADS_BACKUP</term><listitem>
+(read-write) The number of thread that send data to the s3 device, higher value can provide more throutput.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>NB_THREADS_RECOVERY</term><listitem>
+(read-write) The number of thread that read data from the s3 device, higher value can provide more throutput.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>OPENSTACK_SWIFT_API</term><listitem>
+ (read-write) Deprecated, set "STORAGE_API to "SWIFT-1.0".
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>PROXY</term><listitem>
+ (read-write) The proxy hostname or IP in the format "host[:port]".
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>PASSWORD</term><listitem>
+(read-write) The password (for swift v2).
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>PROJECT-ID</term><listitem>
+(read-write) The projectid (for google).
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>REUSE-CONNECTION</term><listitem>
+(read-write) Default: YES. Set it to "NO" if reusing a connection cause some bug, this is sometime the case with big block size.
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>S3_ACCESS_KEY</term><listitem>
@@ -439,7 +494,7 @@ writing long enough to bring the average below this value.
 As of this writing, it can be set to "*" (US Standard, i.e. lowest-latency
 choice of US East or West), "us-west-1" (US West, Northern California), "EU"
 (European Union), or "ap-southeast-1" (Asia Pacific).  See <ulink
-url="http://docs.amazonwebservices.com/AmazonS3/latest/index.html?LocationSelection.html"
+url="http://docs.amazonwebservices.com/general/latest/gr/index.html?rande.html"
 /> for the most up-to-date list.
 </listitem></varlistentry>
  <!-- ==== -->
@@ -450,10 +505,26 @@ if OpenSSL or GnuTLS is being used with libcurl. Multiple certificates can be
 bundled together simply by concatenating them.
 If NSS is being used, then it is the directory that the database resides in.
 The value is passed to curl_easy_setopt(3) as CURLOPT_CAINFO.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>S3_HOST</term><listitem>
+(read-write) The host name to connect, in the form "hostname:port" or "ip:port", default is "s3.amazonaws.com"
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>S3_SECRET_KEY</term><listitem>
- (read-write) This property gives the Amazon S3 secret key used to access the service.
+(read-write) This property gives the Amazon S3 secret key used to access the service.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>S3_SERVER_SIDE_ENCRYPTION</term><listitem>
+(read-write) Set to the server side encryption algorithm to use.
+There is actually only one algorithm, it is "AES256".  The encryption is done
+by Amazon on their server. See
+<ulink url="http://docs.amazonwebservices.com/AmazonS3/latest/API/index.html?RESTObjectPUT.html" />
+for the most up-to-date list.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>S3_SERVICE_PATH</term><listitem>
+(read-write) A path to add at the beginning of the URL.
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>S3_STORAGE_CLASS</term><listitem>
@@ -464,20 +535,51 @@ for the most up-to-date list.
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>S3_SSL</term><listitem>
- (read-write) Whether or not to use SSL/TLS to secure communications with Amazon S3.
+(read-write) Whether or not to use SSL/TLS to secure communications with Amazon S3.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>S3_SUBDOMAIN</term><listitem>
+ (read-write) Whether or not to use subdomain hostname.
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>S3_USER_TOKEN</term><listitem>
- (read-write) This property specifies the user token for Amanda Enterprise Edition customers.
+(read-write) This property specifies the user token for Amanda Enterprise Edition customers.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>STORAGE_API</term><listitem>
+ (read-write) Which API to use for the cloud:
+<programlisting>
+  S3            Amanzon S3 api
+  SWITF-1.0     Openstack swift v1.0
+  SWIFT-2.0     Openstack swift v2.0
+</programlisting>
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>TENANT_ID</term><listitem>
+(read-write) The tenant_id (for swift v2).
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>TENANT_NAME</term><listitem>
+(read-write) The tenant_name (for swift v2).
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>USERNAME</term><listitem>
+(read-write) The username (for swift v2).
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>VERBOSE</term><listitem>
- (read-write) If true, verbose data about each HTTP transaction is sent to the debug log.
+(read-write) If true, verbose data about each HTTP transaction is sent to the debug log.
 </listitem></varlistentry>
  <!-- ==== -->
 </variablelist>
 
 </refsect3>
+<refsect3><title>S3 URL</title>
+     SSL &amp;&amp;  SUBDOMAIN:   https://bucket.host/service_path/file
+     SSL &amp;&amp; !SUBDOMAIN:   https://host/service_path/bucket/file
+    !SSL &amp;&amp;  SUBDOMAIN:   http://bucket.host/service_path/file
+    !SSL &amp;&amp; !SUBDOMAIN:   http://host/service_path/bucket/file
+</refsect3>
 
 </refsect2>
 
@@ -553,7 +655,7 @@ operations can be emulated with the MTREW and read data operations.</para>
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>NONBLOCKING_OPEN</term><listitem>
- (read-write) Set this boolean property to "true" if O_NONBLOCK must be used on the open call. Default to "true" on Linux and "false" on all others machines. Witout it, Linux wait for a few seconds if no tape are loaded. Solaris have strange error it is set to "yes".
+ (read-write) Set this boolean property to "true" if O_NONBLOCK must be used on the open call. Default to "true" on Linux and "false" on all others machines. Without it, Linux wait for a few seconds if no tape are loaded. Solaris have strange error it is set to "yes".
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>READ_BLOCK_SIZE</term><listitem>
@@ -590,6 +692,11 @@ access the NDMP server.  The default for both is "ndmp".</para>
 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
 <variablelist>
  <!-- ==== -->
+<varlistentry><term>INDIRECT</term><listitem>
+(read-write) Set to "yes" if the ndmp server doesn't allow to set a window length to 0.
+The default is "no".
+</listitem></varlistentry>
+ <!-- ==== -->
 <varlistentry><term>NDMP_AUTH</term><listitem>
 (read-write) Authentication method to use to connect to the NDMP server.  One of
 "md5" (default), "text", "none" (for an empty authentication attempt) or "void" (for
@@ -639,6 +746,7 @@ size, regardless of the blocksize used to write the data.</para>
     LEOM detection can be disabled by setting the LEOM property to
     false.</para>
 
+<para>This device supports the ENFORCE_MAX_VOLUME_USAGE property. Default value is true. See COMMON PROPERTIES, above.</para>
 <refsect3><title>Device-Specific Properties</title>
 
 <variablelist>