aspera-cli 4.21.1 → 4.22.0

data/lib/aspera/transfer/spec.yaml

@@ -1,718 +0,0 @@
-# desc           [String] description
-# accepted_types [Symbol, Array(Symbol)] accepted types for non-enum
-# default        [String] default value if not specified
-# enum           [Array]  set with list of values for enum types accepted in transfer spec
-# agents         [Array]  supported agents (for doc only), if not specified: all
-# required       [bool]   optional, default: false
-# cli.type       [Symbol] ascp: type of parameter, one of CLI_OPTION_TYPES (opt_without_arg opt_with_arg special ignore envvar)
-# cli.switch     [String] ascp: switch for ascp command line
-# cli.convert    [String] ascp: transform value: either a Hash with conversion values, or name of class
-# cli.variable   [String] ascp: name of env var
-# cspell:words dgram dnat dnats faspmgr asperanoded xattrs keepalive datagram
----
-cipher:
-  :desc: "In transit encryption type."
-  :enum:
-  - none
-  - aes-128
-  - aes-192
-  - aes-256
-  - aes-128-cfb
-  - aes-192-cfb
-  - aes-256-cfb
-  - aes-128-gcm
-  - aes-192-gcm
-  - aes-256-gcm
-  :default: none
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-c"
-    :convert: Aspera::Transfer::Parameters.convert_remove_hyphen
-content_protection:
-  :desc: Enable client-side encryption at rest. (CSEAR, content protection)
-  :enum:
-  - encrypt
-  - decrypt
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--file-crypt"
-content_protection_password:
-  :desc: "Specifies CSEAR password. (content protection)"
-  :accepted_types: :string
-  :cli:
-    :type: :envvar
-    :variable: ASPERA_SCP_FILEPASS
-cookie:
-  :desc: Metadata for transfer specified by application
-  :accepted_types: :string
-  :cli:
-    :type: :envvar
-    :variable: ASPERA_SCP_COOKIE
-create_dir:
-  :desc: Specifies whether to create new directories.
-  :accepted_types: :bool
-  :cli:
-    :type: :opt_without_arg
-    :switch: "-d"
-delete_before_transfer:
-  :desc: |-
-    Before transfer, delete files that exist at the destination but not at the source.
-    The source and destination arguments must be directories that have matching names.
-    Objects on the destination that have the same name but different type or size as objects
-    on the source are not deleted.
-
-
-  :cli:
-    :type: :opt_without_arg
-delete_source: # duplicate of remove_after_transfer ?
-  :desc: Remove SRC files after transfer success
-  :accepted_types: :bool
-  :agents:
-  - :node
-  - :direct
-  :cli:
-    :type: :opt_without_arg
-    :switch: "--remove-after-transfer"
-destination_root:
-  :desc: Destination root directory.
-  :required: true
-  :cli:
-    :type: :special
-destination_root_id:
-  :desc: |-
-    The file ID of the destination root directory.
-    Required when using Bearer token auth for the destination node.
-
-
-  :accepted_types: :string
-  :agents:
-  - :sdk
-  :cli:
-    :type: :ignore
-direction:
-  :desc: 'Direction of transfer (on client side)'
-  :required: true
-  :enum:
-  - send
-  - receive
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--mode"
-    :convert:
-      receive: recv
-      send: send
-exclude_newer_than:
-  :desc: Exclude files, but not directories, from the transfer if they are newer than the specified number of seconds added to the source computer's epoch. e.g. "-86400" for newer than a day back.
-  :accepted_types: :string
-  :cli:
-    :type: :opt_with_arg
-exclude_older_than:
-  :desc: Exclude files, but not directories, from the transfer if they are older than the specified number of seconds added to the source computer's epoch. e.g. "-86400" for older than a day back.
-  :accepted_types: :string
-  :cli:
-    :type: :opt_with_arg
-fasp_port:
-  :desc: Specifies fasp (UDP) port.
-  :accepted_types: :int
-  :default: 33001
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-O"
-file_checksum:
-  :desc: "Enable checksum reporting for transferred files by specifying the hash to use."
-  :enum:
-  - sha-512
-  - sha-384
-  - sha-256
-  - sha1
-  - md5
-  - none
-  :default: none
-  :agents:
-  - :sdk
-  - :node
-  - :direct
-  :cli:
-    :type: :ignore
-    :switch: "--checksum-type"
-http_fallback:
-  :desc: When true(1), attempts to perform an HTTP transfer if a FASP transfer cannot be performed.
-  :accepted_types:
-  - :bool
-  - :string
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-y"
-    :convert:
-      force: F
-      true: 1
-      false: 0
-http_fallback_port:
-  :desc: Specifies http port when no cipher is used
-  :accepted_types: :int
-  :agents:
-  - :direct
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-t"
-https_fallback_port:
-  :desc: Specifies https port when cipher is used
-  :accepted_types: :int
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-t"
-move_after_transfer:
-  :desc: The relative path to which the files will be moved after the transfer at the source side. Available as of 3.8.0.
-  :agents:
-  - :direct
-  - :node
-  :cli:
-    :type: :opt_with_arg
-multi_session:
-  :desc: |
-    Use multi-session transfer. max 128.
-    Each participant on one host needs an independent UDP (-O) port.
-    Large files are split between sessions only when transferring with resume_policy=none.
-
-
-  :accepted_types: :int
-  :cli:
-    :type: :special
-    :switch: "-C"
-multi_session_threshold:
-  :desc: |-
-    Split files across multiple ascp sessions if their size in bytes is greater than or equal to the specified value.
-    (0=no file is split)
-
-
-  :accepted_types: :int
-  :agents:
-  - :direct
-  - :node
-  :cli:
-    :type: :opt_with_arg
-overwrite:
-  :desc: "Overwrite destination files with the source files of the same name."
-  :default: diff
-  :enum:
-  - never
-  - always
-  - diff
-  - older
-  - diff+older
-  :cli:
-    :type: :opt_with_arg
-password:
-  :desc: |-
-    Password for local Windows user when transfer user associated with node api user is not the same as the one running asperanoded.
-    Allows impersonating the transfer user and have access to resources (e.g. network shares).
-    Windows only, node api only.
-
-
-  :accepted_types: :string
-  :agents:
-  - :node
-  :cli:
-    :type: :ignore
-paths:
-  :desc: Array of path to the source (required) and a path to the destination (optional).
-  :required: true
-  :accepted_types: :array
-  :cli:
-    :type: :special
-precalculate_job_size:
-  :desc: Specifies whether to precalculate the job size.
-  :accepted_types: :bool
-  :cli:
-    :type: :opt_without_arg
-preserve_access_time:
-  :desc: |-
-    Preserve the source-file access timestamps at the destination.
-    Because source access times are updated by the transfer operation,
-    the timestamp that is preserved is the one just before to the transfer.
-
-
-  :cli:
-    :type: :opt_without_arg
-preserve_creation_time:
-  :desc: |-
-    (Windows only) Preserve source-file creation timestamps at the destination.
-    Only Windows systems retain information about creation time.
-    If the destination is not a Windows computer, this option is ignored.
-
-
-  :cli:
-    :type: :opt_without_arg
-preserve_modification_time:
-  :desc: |-
-    Set the modification time, the last time a file or directory was modified (written), of a transferred file
-    to the modification of the source file or directory.
-    Preserve source-file modification timestamps at the destination.
-
-
-  :cli:
-    :type: :opt_without_arg
-preserve_times:
-  :desc: Preserve file timestamps. 
-  :agents:
-  - :sdk
-  - :node
-  :cli:
-    :type: :opt_without_arg
-rate_policy:
-  :desc: The transfer rate policy to use when sharing bandwidth.
-  :enum:
-  - low
-  - fair
-  - high
-  - fixed
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--policy"
-remote_access_key:
-  :desc: The access key ID of the access key that was used to construct the bearer token that is used to authenticate to the remote node.
-  :accepted_types: :string
-  :agents:
-  - :sdk
-  :cli:
-    :type: :ignore
-remote_host:
-  :desc: IP or fully qualified domain name of the remote server
-  :required: true
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--host"
-remote_user:
-  :desc: Remote user. Default value is "xfer" on node or connect.
-  :required: true
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--user"
-remote_password:
-  :desc: SSH session password
-  :cli:
-    :type: :envvar
-    :variable: ASPERA_SCP_PASS
-remove_after_transfer:
-  :desc: Remove SRC files after transfer success
-  :accepted_types: :bool
-  :agents:
-  - :direct
-  - :node
-  :cli:
-    :type: :opt_without_arg
-remove_empty_directories:
-  :desc: Specifies whether to remove empty directories.
-  :accepted_types: :bool
-  :agents:
-  - :direct
-  - :node
-  :cli:
-    :type: :opt_without_arg
-remove_skipped:
-  :desc: Must also have remove_after_transfer set to true, Defaults to false, if true, skipped files will be removed as well.
-  :accepted_types: :bool
-  :agents:
-  - :direct
-  - :connect
-  - :sdk
-  - :node
-  :cli:
-    :type: :opt_without_arg
-proxy:
-  :desc: |-
-    Specify the address of the Aspera high-speed proxy server.
-    dnat(s)://[user[:password]@]server:port
-    Default ports for DNAT and DNATS protocols are 9091 and 9092.
-    Password, if specified here, overrides the value of environment variable ASPERA_PROXY_PASS.
-
-
-  :agents:
-  - :direct
-  - :sdk
-  :cli:
-    :type: :opt_with_arg
-resume_policy:
-  :desc: If a transfer is interrupted or fails to finish, resume without re-transferring the whole files.
-  :default: faspmgr:none;other:sparse_csum
-  :enum:
-  - none
-  - attrs
-  - sparse_csum
-  - full_csum
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-k"
-    :convert:
-      none: 0
-      attrs: 1
-      sparse_csum: 2
-      full_csum: 3
-retry_duration:
-  :desc: Specifies how long to wait before retrying transfer. (e.g. "5min")
-  :accepted_types:
-  - :string
-  - :int
-  :agents:
-  - :node
-  - :connect
-  - :sdk
-  :cli:
-    :type: :ignore
-source_root_id:
-  :desc: The file ID of the source root directory. Required when using Bearer token auth for the source node.
-  :accepted_types: :string
-  :agents:
-  - :sdk
-  - :node
-  :cli:
-    :type: :ignore
-ssh_port:
-  :desc: "Specifies SSH (TCP) port. Default: local:22, other:33001"
-  :accepted_types: :int
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-P"
-ssh_private_key:
-  :desc: |-
-    Private key used for SSH authentication.
-    Shall look like: -----BEGIN RSA PRIV4TE KEY-----/nMII...
-    Note the JSON encoding: /n for newlines.
-
-
-  :agents:
-  - :direct
-  - :sdk
-  :cli:
-    :type: :envvar
-    :variable: ASPERA_SCP_KEY
-ssh_private_key_passphrase:
-  :desc: The passphrase associated with the transfer user's SSH private key. Available as of 3.7.2.
-  :accepted_types: :string
-  :agents:
-  - :sdk
-  - :direct
-  :cli:
-    :type: :envvar
-    :variable: ASPERA_SCP_PASS
-ssh_args:
-  :desc: Array of arguments to pass to SSH. Use with caution.
-  :accepted_types: :string
-  :agents:
-  - :sdk
-  :cli:
-    :type: :ignore
-symlink_policy:
-  :desc: "Handle source side symbolic links"
-  :enum:
-  - follow
-  - copy
-  - copy+force
-  - skip
-  :default: follow
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--symbolic-links"
-tags:
-  :desc: Metadata for transfer as JSON. Key `aspera` is reserved. Key `aspera.xfer_retry` specified a retry timeout for node api initiated transfers.
-  :accepted_types: :hash
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--tags64"
-    :convert: Aspera::Transfer::Parameters.convert_json64
-target_rate_cap_kbps:
-  :desc: Returned by upload/download_setup node API.
-  :accepted_types: :int
-  :agents:
-  - :connect
-  :cli:
-    :type: :ignore
-target_rate_kbps:
-  :desc: Specifies desired speed for the transfer.
-  :accepted_types: :int
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-l"
-title:
-  :desc: Title of the transfer
-  :accepted_types: :string
-  :agents:
-  - :node
-  - :connect
-  - :sdk
-  :cli:
-    :type: :ignore
-token:
-  :desc: 'Authorization token: Bearer, Basic or ATM (Also arg -W)'
-  :cli:
-    :type: :envvar
-    :variable: ASPERA_SCP_TOKEN
-use_ascp4:
-  :desc: specify version of protocol
-  :accepted_types: :bool
-  :default: false
-  :agents:
-  - :direct
-  - :node
-  - :sdk
-  :cli:
-    :type: :special
-use_system_ssh:
-  :desc: TODO, comment...
-  :accepted_types: :string
-  :agents:
-  - :sdk
-  :cli:
-    :type: :ignore
-    :switch: "-SSH"
-source_root:
-  :desc: |-
-    Path to be prepended to each source path.
-    This is either a conventional path or it can be a URI but only if there is no root defined.
-
-
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--source-prefix64"
-    :convert: Aspera::Transfer::Parameters.convert_base64
-min_rate_cap_kbps:
-  :desc: |-
-    The highest minimum rate that an incoming transfer can request, in kilobits per second.
-    Client minimum rate requests that exceed the minimum rate cap are ignored.
-    The default value of unlimited applies no cap to the minimum rate. (Default: 0)
-
-
-  :accepted_types: :int
-  :cli:
-    :type: :ignore
-lock_rate_policy:
-  :desc: If true, lock the rate policy to the default value.
-  :accepted_types: :bool
-  :agents:
-  - :sdk
-  - :connect
-  :cli:
-    :type: :ignore
-lock_target_rate_kbps:
-  :desc: |-
-    If true, lock the target transfer rate to the default value set for target_rate_kbps.
-    If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.
-
-
-  :accepted_types: :bool
-  :cli:
-    :type: :ignore
-lock_min_rate_kbps:
-  :desc: |-
-    If true, lock the minimum transfer rate to the value set for min_rate_kbps.
-    If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.
-
-
-  :accepted_types: :bool
-  :agents:
-  - :sdk
-  - :connect
-  :cli:
-    :type: :ignore
-apply_local_docroot:
-  :desc: Apply local docroot to source paths.
-  :agents:
-  - :direct
-  - :sdk
-  :cli:
-    :type: :opt_without_arg
-src_base:
-  :desc: |-
-    Specify the prefix to be stripped off from each source object.
-    The remaining portion of the source path is kept intact at the destination.
-    Special care must be taken when used with cloud storage.
-
-
-  :agents:
-  - :direct
-  - :node
-  - :sdk
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--src-base64"
-    :convert: Aspera::Transfer::Parameters.convert_base64
-preserve_acls:
-  :desc: "Preserve access control lists."
-  :enum:
-  - none
-  - native
-  - metafile
-  :default: none
-  :agents:
-  - :direct
-  - :sdk
-  :cli:
-    :type: :opt_with_arg
-preserve_remote_acls:
-  :desc: "Preserve remote access control lists."
-  :enum:
-  - none
-  - native
-  - metafile
-  :default: none
-  :agents:
-  - :sdk
-  - :direct
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--remote-preserve-acls"
-preserve_file_owner_uid:
-  :desc: Preserve the user ID for a file owner
-  :accepted_types: :bool
-  :agents:
-  - :sdk
-  - :direct
-  :cli:
-    :type: :opt_without_arg
-preserve_file_owner_gid:
-  :desc: Preserve the group ID for a file owner
-  :accepted_types: :bool
-  :agents:
-  - :sdk
-  - :direct
-  :cli:
-    :type: :opt_without_arg
-preserve_extended_attrs:
-  :desc: "Preserve the extended attributes."
-  :enum:
-  - none
-  - native
-  - metafile
-  :default: none
-  :agents:
-  - :sdk
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--preserve-xattrs"
-preserve_source_access_time:
-  :desc: Preserve the time logged for when the source file was accessed
-  :accepted_types: :bool
-  :agents:
-  - :sdk
-  - :direct
-  :cli:
-    :type: :opt_without_arg
-remove_empty_source_directory:
-  :desc: "Remove empty source subdirectories and remove the source directory itself, if empty"
-  :accepted_types: :bool
-  :agents:
-  - :direct
-  - :sdk
-  :cli:
-    :type: :opt_without_arg
-keepalive:
-  :desc: The session is running in persistent session mode.
-  :agents:
-  - :sdk
-  - :direct
-  :cli:
-    :type: :opt_without_arg
-dgram_size:
-  :desc: UDP datagram size in bytes
-  :accepted_types: :int
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-Z"
-min_rate_kbps:
-  :desc: Set the minimum transfer rate in kilobits per second.
-  :accepted_types: :int
-  :default: 0
-  :cli:
-    :type: :opt_with_arg
-    :switch: "-m"
-sshfp:
-  :desc: Check it against server SSH host key fingerprint
-  :cli:
-    :type: :opt_with_arg
-    :switch: "--check-sshfp"
-target_rate_percentage:
-  :desc: "TODO: remove ?"
-  :cli:
-    :type: :ignore
-rate_policy_allowed:
-  :desc: "Specifies most aggressive rate policy that is allowed.\nReturned by node API."
-  :enum:
-  - low
-  - fair
-  - high
-  - fixed
-  :agents:
-  - :connect
-  :cli:
-    :type: :ignore
-fasp_url:
-  :desc: Only used in Faspex.
-  :agents:
-  - :unknown
-  :cli:
-    :type: :ignore
-lock_min_rate:
-  :desc: "TODO: remove ?"
-  :accepted_types: :bool
-  :cli:
-    :type: :ignore
-lock_target_rate:
-  :desc: "TODO: remove ?"
-  :accepted_types: :bool
-  :cli:
-    :type: :ignore
-authentication:
-  :desc: 'value=token for SSH bypass keys, else password asked if not provided.'
-  :agents:
-  - :connect
-  :cli:
-    :type: :ignore
-cipher_allowed:
-  :desc: returned by node API. Valid literals include "aes-128" and "none".
-  :cli:
-    :type: :ignore
-obfuscate_file_names:
-  :desc: HTTP Gateway obfuscates file names when set to true.
-  :accepted_types: :bool
-  :agents:
-  - :httpgw
-  :cli:
-    :type: :ignore
-wss_enabled:
-  :desc: Server has Web Socket service enabled
-  :accepted_types: :bool
-  :cli:
-    :type: :special
-wss_port:
-  :desc: TCP port used for websocket service feed
-  :accepted_types: :int
-  :cli:
-    :type: :special
-compression:
-  :desc: ascp4 only, 0 / 1?
-  :accepted_types: :int
-  :agents:
-  - :unknown
-  :cli:
-    :type: :ignore
-read_threads:
-  :desc: ascp4 only
-  :accepted_types: :int
-  :agents:
-  - :unknown
-  :cli:
-    :type: :ignore
-write_threads:
-  :desc: ascp4 only
-  :accepted_types: :int
-  :agents:
-  - :unknown
-  :cli:
-    :type: :ignore
-xfer_max_retries:
-  :desc: maximum number of retries, for node API initiated transfers. Shall not exceed aspera.conf `transfer_manager_max_retries` (default 5).
-  :accepted_types: :int
-  :agents:
-  - :node
-  :cli:
-    :type: :ignore