account
|
|
[optional]
|
account
|
|
[optional]
|
DataType: SOSOptionString |
Default-Value:
---
|
|
DataType: SOSOptionString |
Default-Value:
---
|
|
alternative_account
|
|
[optional]
|
alternative_account
|
|
[optional]
|
Additional accounting information
Optional account info needed for authentication with an (FTP) server.
Alternative parameter for the primary parameter
→account
.
The alternative parameters are used solely should the connection to an server fail,
e.g. if the server were not available or if invalid
credentials were used.
|
|
alternative_host
|
|
[optional]
|
alternative_host
|
|
[optional]
|
Alternative parameter for the primary parameter
→host
.
The alternative parameters are used solely should the connection to an server fail,
e.g. if the server were not available or if invalid
credentials were used.
DataType: SOSOptionHostName |
Default-Value:
---
|
|
DataType: SOSOptionHostName |
Default-Value:
---
|
|
alternative_passive_mode
|
|
[optional]
|
alternative_passive_mode
|
|
[optional]
|
Alternative parameter for the primary parameter
→passive_mode
.
The alternative parameters are used solely should the connection to an server fail,
e.g. if the server were not available or if invalid
credentials were used.
|
|
alternative_password
|
|
[optional]
|
alternative_password
|
|
[optional]
|
Alternative parameter for the primary parameter
→password
.
The alternative parameters are used solely should the connection to an server fail,
e.g. if the server were not available or if invalid
credentials were used.
|
|
alternative_port
|
|
[optional]
|
alternative_port
|
|
[optional]
|
Alternative parameter for the primary parameter
→port
.
The alternative parameters are used solely should the connection to an server fail,
e.g. if the server were not available or if invalid
credentials were used.
DataType: SOSOptionPortNumber |
Default-Value:
---
|
|
DataType: SOSOptionPortNumber |
Default-Value:
---
|
|
alternative_remote_dir
|
|
[optional]
|
alternative_remote_dir
|
|
[optional]
|
Alternative parameter for the primary parameter
→remote_dir
.
The alternative parameters are used solely should the connection to an server fail,
e.g. if the server were not available or if invalid
credentials were used.
|
|
alternative_transfer_mode
|
|
[optional]
|
alternative_transfer_mode
|
|
[optional]
|
Alternative parameter for the primary parameter
→transfer_mode
.
The alternative parameters are used solely should the connection to an server fail,
e.g. if the server were not available or if invalid
credentials were used.
|
|
alternative_user
|
|
[optional]
|
alternative_user
|
|
[optional]
|
Alternative parameter for the primary parameter
→user
.
The alternative parameters are used solely should the connection to an server fail,
e.g. if the server were not available or if invalid
credentials were used.
|
|
append_files
|
|
[optional]
|
append_files
|
|
[optional]
|
This parameter specifies whether the content of a source file should
be appended to the target file should this file exist.
The parameter
→overwrite_files
will be ignored if this parameter
is specified with the value
true.
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
atomic_prefix
|
|
[optional]
|
atomic_prefix
|
|
[optional]
|
This parameter specifies whether target files should be created with a prefix such as "~",
and must be renamed to the target file name after the file transfer is completed without errors.
This mechanism is useful if the target directory is monitored for incoming files
by some application
and if files are required to appear atomically instead of being subsequently written to.
The temporary prefix is specified as the value of this parameter.
This setting is recommended should target directories be monitored by an application
or a JobScheduler.
DataType: SOSOptionString |
Default-Value:
---
|
|
DataType: SOSOptionString |
Default-Value:
---
|
|
atomic_suffix
|
|
[optional]
|
atomic_suffix
|
|
[optional]
|
This parameter specifies whether target files should be created with a suffix such as "~",
and should be renamed to the target file name after the file transfer is completed.
This mechanism is useful if the target directory is monitored for incoming files
by some application
and if files are required to appear atomically instead of being subsequently written to.
The temporary suffix is specified as the value of this parameter.
This setting is recommended should target directories be monitored by an application
or a Job Scheduler.
DataType: SOSOptionString |
Default-Value:
---
|
|
DataType: SOSOptionString |
Default-Value:
---
|
|
banner_footer
|
Name der Template-Datei für Protokoll-Ende
|
[optional]
|
banner_footer
|
Name der Template-Datei für Protokoll-Ende
|
[optional]
|
Name der Template-Datei für Protokoll-Ende
This program logs output to stdout or to a file that has been specified by the parameter
→log_filename
. A template can be used in order to organize the output that is created.
The output is grouped into header, file list and footer.
This parameter specifies a template file for footer output.
Templates can use internal variables and parameters as placeholders
in the form %{placeholder}. The standard footer template looks like this:
*************************************************************************
execution status = %{status}
successful transfers = %{successful_transfers}
failed transfers = %{failed_transfers}
last error = %{last_error}
*************************************************************************
DataType: SOSOptionInFileName |
Default-Value:
---
|
|
DataType: SOSOptionInFileName |
Default-Value:
---
|
|
banner_header
|
Name of Template-File for log-File
|
[optional]
|
banner_header
|
Name of Template-File for log-File
|
[optional]
|
Name of Template-File for log-File
This program logs output to stdout or to a file that has been specified by the parameter
→log_filename
. A template can be used in order to organize the output that is created.
The output is grouped into header, file list and footer.
This parameter specifies a template file for header output.
Templates can use internal variables and parameters as placeholders
in the form %{placeholder}. The standard header template looks like this:
*************************************************************************
* *
* SOSFTP - Managed File Transfer Utility *
* -------------------------------------- *
* *
*************************************************************************
version = %{version}
date = %{date} %{time}
operation = %{operation}
protocol = %{protocol}
file specification = %{file_spec}
file path = %{file_path}
source host = %{localhost} (%{local_host_ip})
local directory = %{local_dir}
jump host = %{jump_host}
target host = %{host} (%{host_ip})
target directory = %{remote_dir}
pid = %{current_pid}
ppid = %{ppid}
*************************************************************************
DataType: SOSOptionInFileName |
Default-Value:
---
|
|
DataType: SOSOptionInFileName |
Default-Value:
---
|
|
check_interval
|
|
[optional]
|
check_interval
|
|
[optional]
|
This parameter specifies the interval in seconds between two file transfer trials,
if repeated transfer of files has been configured using the
→check_retry
parameter.
DataType: SOSOptionInteger |
Default-Value: 60 |
|
DataType: SOSOptionInteger |
Default-Value: 60 |
|
check_retry
|
|
[optional]
|
check_retry
|
|
[optional]
|
This parameter specifies whether a file transfer should be repeated
in order to ensure that the file was complete when the transfer started.
This is relevant for Unix systems that allow read and write access
to a file at the same time.
This parameter causes the size of the current file transfer and of the previous file transfer
to be compared
and repeats transferring one file up to the number of trials specified by
this parameter. Should the file size of both transfers be the same,
then it is assumed that the file was complete at the FTP/SFTP server.
The interval between two trials to transfer a file is configured
using the
→check_interval
parameter.
DataType: SOSOptionInteger |
Default-Value: 0 |
|
DataType: SOSOptionInteger |
Default-Value: 0 |
|
check_size
|
|
[optional]
|
check_size
|
|
[optional]
|
This parameter determines whether the original file size and the number of
bytes transferred should be compared after a file transfer and whether
an error should be raised if they would not match.
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: true |
|
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: true |
|
compress_files
|
|
[optional]
|
compress_files
|
|
[optional]
|
This parameter specifies whether the content of the source files
should
be compressed by using a zip-algorithm or not.
In case of sending files the files to be sent will be compressed.
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
compressed_file_extension
|
Additional file-name extension for compressed files
|
[optional]
|
compressed_file_extension
|
Additional file-name extension for compressed files
|
[optional]
|
Additional file-name extension for compressed files
This parameter specifies the file extension should target file
compression
be specified using the
→compress_files
parameter.
DataType: SOSOptionString |
Default-Value: .gz |
|
DataType: SOSOptionString |
Default-Value: .gz |
|
file_path
|
|
[optional]
|
file_path
|
|
[optional]
|
This parameter is used alternatively to the parameter
→file_spec
to specify a single file for transfer.
- When receiving files the following applies:
This parameter accepts the absolute name and path of file at the FTP/SFTP server that should be transferred.
The file name has to include both name and path of the file at the FTP/SFTP server.
The file will be stored unter its name in the directory that is specified
by the parameter
→local_dir
.
The following parameters are ignored should this parameter be used:
→file_spec
and
→remote_dir
.
- When sending files the following applies:
This parameter accepts the absolute name and path of file that should be transferred.
An absolute path has to be specified.
The file will be stored under its name in the directory at the FTP/SFTP server
that has been specified by the parameter
→remote_dir
.
The following parameters are ignored should this parameter be used:
→file_spec
and
→local_dir
.
DataType: SOSOptionFileName |
Default-Value:
---
|
|
DataType: SOSOptionFileName |
Default-Value:
---
|
|
file_spec
|
file_spec
|
[optional]
|
file_spec
|
file_spec
|
[optional]
|
file_spec
This parameter expects a regular expression to select files
from a local directory or from an FTP/SFTP server
(depending on the
→operation
parameter values send or receive )
to be transferred.
For the operations send and receive either this parameter has to be specified
or the parameter
→file_path
or a list of file names as additional parameters.
Some remarks on regular expression, used in JobScheduler.
A regular expression is not a
wildcard
.
To get an impression of the differences one have a look on the meaning of the wildcard *.txt, which will
select all filenames with the filename-extension ".txt".
A regular expression to match, e.g. works the same way, this "wildcard" must look like "^.*\.txt$".
That looks a little bit strange but it is much more flexible and powerfull on filtering filenames
than the concept of wildcards, if one want to filter more complex names or pattern.
The general syntax of an
regular expression, also referred to as regex or regexp,
is described
here.
It is different to other RegExp definitions, e.g. as for Perl.
For further information on regular expressions see
java.util.regex.Pattern
DataType: SOSOptionRegExp |
Default-Value: .* |
|
DataType: SOSOptionRegExp |
Default-Value: .* |
|
ssh_auth_file
|
|
[optional]
|
ssh_auth_file
|
|
[optional]
|
This parameter specifies the path and name of a user's private key file
that is used for authentication with an SSH server.
This parameter has to be specified should the publickey authentication method
have been specified in the
→ssh_auth_method
parameter.
Should the private key file be secured by a passphrase, then the passphrase has to be specified
using the
→password
parameter.
DataType: SOSOptionInFileName |
Default-Value:
---
|
|
DataType: SOSOptionInFileName |
Default-Value:
---
|
|
ssh_auth_method
|
|
[optional]
|
ssh_auth_method
|
|
[optional]
|
This parameter specifies the authentication method for the SSH server -
the publickey and password methods are supported.
Should the publickey authentication method be used,
then the path name of the private key file has to be specified with the
→ssh_auth_file
parameter.
Should the private key file be secured by a passphrase then the passphrase has to be specified
with the
→password
parameter.
For the password authentication method the password for the user account has to be specified
using the
→password
parameter.
The authentication methods that are enabled depend on the SSH server configuration.
Not all SSH servers are configured for password authentication.
DataType: SOSOptionStringValueList |
Default-Value: publickey |
|
DataType: SOSOptionStringValueList |
Default-Value: publickey |
|
ssh_proxy_host
|
|
[optional]
|
ssh_proxy_host
|
|
[optional]
|
The value of this parameter is the host name or the IP address of a
proxy that is used in order to establish a connection to the SSH server.
The use of a proxy is optional.
|
|
ssh_proxy_password
|
|
[optional]
|
ssh_proxy_password
|
|
[optional]
|
This parameter specifies the password for the proxy server user account,
should a proxy be used in order to connect to the SSH server.
|
|
ssh_proxy_port
|
|
[optional]
|
ssh_proxy_port
|
|
[optional]
|
This parameter specifies the port number of the proxy,
should a proxy be used in order to establish a connection to the SSH server.
|
|
ssh_proxy_user
|
|
[optional]
|
ssh_proxy_user
|
|
[optional]
|
The value of this parameter specifies the user account for authentication
by the proxy server should a proxy be used in order to connect to the SSH server.
|
|
force_files
|
|
[optional]
|
force_files
|
|
[optional]
|
This parameter specifies whether an error should be raised if no files could be found for transfer.
The number of files to be transferred is determined by the
→file_spec
or
→file_path
parameters and can be restricted by the
→overwrite_files
parameter should this
be specified with the value
false.
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: true |
|
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: true |
|
host
|
Host-Name
|
[required]
|
host
|
Host-Name
|
[required]
|
Host-Name
This parameter specifies the hostname (e.g. wilma.sos) or IP address (e.g. IPv4 192.168.0.1) of the (FTP, SFTP, SSH, etc.) server
to which a connection has to be made.
DataType: SOSOptionHostName |
Default-Value:
---
|
|
DataType: SOSOptionHostName |
Default-Value:
---
|
|
local_dir
|
local_dir
|
[required]
|
local_dir
|
local_dir
|
[required]
|
local_dir
Local directory into which or from which files should be transferred.
By default the current working directory is used.
Besides paths in the local file system UNC path names are supported
that could be used to address remote server systems:
\\somehost\somedirectory can be used in the same way as
//somehost/somedirectory to transfer files from an FTP/SFTP server to
a different remote server system.
Moreover, you could specify URIs for a file schema as in
file:////somehost/somedirectory .
Please, consider the required number of slashes. file URIs are
subject to the following limitations due to constraints of the underlying Java JRE:
- File names and path names must not contain any spaces.
-
Authentication by
authority strings as in
file:////user:password@somehost/somedirectory
is not supported.
DataType: SOSOptionFolderName |
Default-Value: . |
|
DataType: SOSOptionFolderName |
Default-Value: . |
|
log_filename
|
Name (and Pathname) of the logging-file
|
[optional]
|
log_filename
|
Name (and Pathname) of the logging-file
|
[optional]
|
Name (and Pathname) of the logging-file
This parameter specifies the location of a file to which the log output will be written.
Should the file not exist then it will be created. If the already exists
then all log output will be appended.
Without specifying this parameter all log output will be written to stdout.
DataType: SOSOptionOutFileName |
Default-Value:
---
|
|
DataType: SOSOptionOutFileName |
Default-Value:
---
|
|
mandator
|
|
[optional]
|
mandator
|
|
[optional]
|
This parameter specifies the mandator for which a file transfer is effected.
The mandator is added to an optional history file, see parameter
→history
and has no technical relevance for the transfer.
DataType: SOSOptionString |
Default-Value: SOS |
|
DataType: SOSOptionString |
Default-Value: SOS |
|
operation
|
Operation to be executed
|
[required]
|
operation
|
Operation to be executed
|
[required]
|
Operation to be executed
send, receive, remove, execute or install.
- send - transfer files by FTP/SFTP to a remote server
- receive - transfer files by FTP/SFTP from a remote server
- remove - remove files by FTP/SFTP on a remote server
- execute - execute a command by SSH on a remote server
- install - install SOSFTP on a remote server
DataType: SOSOptionStringValueList |
Default-Value: send |
|
DataType: SOSOptionStringValueList |
Default-Value: send |
|
overwrite_files
|
|
[optional]
|
overwrite_files
|
|
[optional]
|
This parameter specifies wether existing files can be overwritten.
Is this parameter used with
→force_files
and should no files be
transferred due to overwrite protection then an error will be raised stating
that "no matching files" could be found.
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: true |
|
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: true |
|
passive_mode
|
passive_mode
|
[optional]
|
passive_mode
|
passive_mode
|
[optional]
|
passive_mode
Passive mode for FTP is often used with firewalls. Valid values are
0
or
1 .
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
password
|
Password for UserID
|
[optional]
|
password
|
Password for UserID
|
[optional]
|
Password for UserID
Password for authentication at the FTP/SFTP server.
For SSH/SFTP connections that make use of public/private key authentication
the password parameter is specified for the passphrase
that optionally secures a private key.
DataType: SOSOptionPassword |
Default-Value:
---
|
|
DataType: SOSOptionPassword |
Default-Value:
---
|
|
poll_interval
|
|
[optional]
|
poll_interval
|
|
[optional]
|
This parameter specifies the interval in seconds, how often a file is polled for
within the duration that is specified by the parameter
→poll_timeout
.
DataType: SOSOptionInteger |
Default-Value: 60 |
|
DataType: SOSOptionInteger |
Default-Value: 60 |
|
poll_minfiles
|
|
[optional]
|
poll_minfiles
|
|
[optional]
|
This parameter specifies the number of files that have to be found during the polling
period in order to cause the transfer to start. This parameter is used exclusively with
the parameters
→poll_timeout
.
DataType: SOSOptionInteger |
Default-Value: 1 |
|
DataType: SOSOptionInteger |
Default-Value: 1 |
|
poll_timeout
|
|
[optional]
|
poll_timeout
|
|
[optional]
|
This parameter specifies the time in minutes, how long a file is polled for.
If a file becomes available within the time specified then it will be transferred,
otherwise an error "no matching files" will be raised.
DataType: SOSOptionInteger |
Default-Value: 0 |
|
DataType: SOSOptionInteger |
Default-Value: 0 |
|
port
|
Port-Number to be used for Data-Transfer
|
[required]
|
port
|
Port-Number to be used for Data-Transfer
|
[required]
|
Port-Number to be used for Data-Transfer
Port by which files should be transferred.
For FTP this is usually port 21, for SFTP this is usually port 22.
DataType: SOSOptionPortNumber |
Default-Value: 21 |
|
DataType: SOSOptionPortNumber |
Default-Value: 21 |
|
profile
|
The Name of a Profile-Section to be executed
|
[optional]
|
profile
|
The Name of a Profile-Section to be executed
|
[optional]
|
The Name of a Profile-Section to be executed
If a configuration file is being used (see parameter settings ),
then this parameter specifies a name of a section within the configuration file.
Such sections, i.e. profiles, specify parameters as pairs of names and values
that otherwise would be specified by command line parameters.
At the command line the name of the configuration file and the profile are specified like this:
sosftp.sh -operation=send -settings=settings.ini -profile=sample_transfer ...
DataType: SOSOptionString |
Default-Value:
---
|
|
DataType: SOSOptionString |
Default-Value:
---
|
|
protocol
|
Type of requested Datatransfer
|
[required]
|
protocol
|
Type of requested Datatransfer
|
[required]
|
Type of requested Datatransfer
The values ftp , sftp or ftps
are valid for this parameter.
If sftp is used, then the ssh_* parameters will
be applied.
DataType: SOSOptionStringValueList |
Default-Value: ftp |
|
DataType: SOSOptionStringValueList |
Default-Value: ftp |
|
recursive
|
Include subfolders in operation
|
[optional]
|
recursive
|
Include subfolders in operation
|
[optional]
|
Include subfolders in operation
This parameter specifies wether files from subdirectories
should be included recursively.
Only effective if
→file
is a directory.
Regular expression matches apply to files from subdirectories
as specified by the parameter
→file_spec
.
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
remote_dir
|
remote_dir
|
[required]
|
remote_dir
|
remote_dir
|
[required]
|
remote_dir
Directory at the FTP/SFTP server from which or to which files should be transferred.
By default the home directory of the user at the FTP/SFTP server is used.
DataType: SOSOptionFolderName |
Default-Value: . |
|
DataType: SOSOptionFolderName |
Default-Value: . |
|
remove_files
|
|
[optional]
|
remove_files
|
|
[optional]
|
This parameter specifies whether files on the FTP/SFTP server should be removed after transfer.
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
replacement
|
String for Replacement
|
[optional]
|
replacement
|
String for Replacement
|
[optional]
|
String for Replacement
String for replacement of matching character sequences within file names that are specified with the
value of the parameter
→replacing
.
If multiple "capturing groups" shall be replaced then one replacement string per group has to be specified.
These strings are separated by a semicolon ";":
replacement: aa;[filename:];bb
Supports masks for substitution in the file name with format strings that are enclosed with
[
and
]
.
The following format strings are supported:
-
[date:
date format
]
date format
must be a valid Java data format string, e.g.
yyyyMMddHHmmss
,
yyyy-MM-dd.HHmmss
etc.
-
[filename:]
Will be substituted by the original file name including the file extension.
-
[filename:lowercase]
Will be substituted by the original file name including the file extension with all characters converted to lower case.
-
[filename:uppercase]
Will be substituted by the original file name including the file extension with all characters converted to upper case.
Requires the parameter
→replacing
to be specified.
DataType: SOSOptionString |
Default-Value:
---
|
|
DataType: SOSOptionString |
Default-Value:
---
|
|
replacing
|
Regular expression for filename replacement
|
[optional]
|
replacing
|
Regular expression for filename replacement
|
[optional]
|
Regular expression for filename replacement
Regular expression for filename replacement with
the value of the parameter
→replacement
.
If the expression matches the filename then the groups found are
replaced.
a)
For replacement "capturing groups" are used. Only the content of the
capturing groups is replaced.
Replacements are separated by a semicolon ";". Example:
→replacing
= (1)abc(12)def(.*)
→replacement
= A;BB;CCC
Input file: 1abc12def123.txt
Output file: AabcBBdefCCC
b)
If no "capturing groups" are specified then the entire match is
replaced. Example:
→replacing
= Hello
→replacement
= 1234
Input file: Hello_World.txt
Output file: 1234_World.txt
Requires the parameter
→replacement
to be specified.
DataType: SOSOptionRegExp |
Default-Value:
---
|
|
DataType: SOSOptionRegExp |
Default-Value:
---
|
|
scheduler_host
|
|
[optional]
|
scheduler_host
|
|
[optional]
|
This parameter specifies the host name or IP address of a server for which
Job Scheduler is operated for Managed File Transfer.
The contents of an optional history file (see parameter
→history
),
is added to a central database by Job Scheduler.
This parameter causes the transfer of the history entries for the current transfer
by UDP to Job Scheduler. Should Job Scheduler not be accessible then no errors are
reported, instead, the contents of the history will automaticall be processed later on.
DataType: SOSOptionHostName |
Default-Value: localhost |
|
DataType: SOSOptionHostName |
Default-Value: localhost |
|
scheduler_job_chain
|
|
[optional]
|
scheduler_job_chain
|
|
[optional]
|
The name of a job chain for Managed File Transfer with Job Scheduler,
see parameter
→scheduler_host
.
The job chain accepts history entries and performs an import into
a central database.
DataType: JSJobChain |
Default-Value: scheduler_sosftp_history |
|
DataType: JSJobChain |
Default-Value: scheduler_sosftp_history |
|
scheduler_port
|
|
[optional]
|
scheduler_port
|
|
[optional]
|
DataType: SOSOptionPortNumber |
Default-Value: 4444 |
|
DataType: SOSOptionPortNumber |
Default-Value: 4444 |
|
settings
|
Name of INI-File which contains the profiles to execute
|
[optional]
|
settings
|
Name of INI-File which contains the profiles to execute
|
[optional]
|
Name of INI-File which contains the profiles to execute
A configuration (INI-) file can be specified that contains profiles, i.e. sections,
with parameters specified as pairs of names and values in a plain text format like this:
[sample_transfer]
protocol = ftp
host = localhost
port = 21
local_dir = /tmp
...
At the command line the name of the configuration file and the profile are specified like this:
sosftp.sh -operation=send -settings=settings.ini -profile=sample_transfer ...
A profile can reference the contents of other profiles like this:
[default]
history = /sosftp/transfer_history.csv
mandator = SOS
scheduler_host = localhost
scheduler_port = 4444
[sample_transfer]
include = default
protocol = ftp
host = www.sos-berlin.com
port = 21
local_dir = /tmp
...
With this sample the profile sample_transfer includes the default profile
via the include directive and thus applies the file transfer history settings.
DataType: SOSOptionIniFileName |
Default-Value: ./SOSFtpSettings.ini |
|
DataType: SOSOptionIniFileName |
Default-Value: ./SOSFtpSettings.ini |
|
transactional
|
|
[optional]
|
transactional
|
|
[optional]
|
This parameter specifies if file transfers should be operated within a single transaction,
i.e. either all files are successfully transferred or none.
Should an error occur during a transfer operation then all transfers will be rolled back.
When specifying the value true then the following applies:
- The parameter
→atomic_suffix
has to be specified that causes
target files to be created with a suffix such as "~"
and that causes the respective files to be renamed to their target file name
after the transfer of all files has been successfully completed.
If at least one file out of a set of files cannot be transferred successfully
then no files will be renamed, instead the temporarily created files are removed
from the target system.
- The parameter
→remove_files
that causes files to be removed after
successful transfer will be effective only after all files have been successfully
transferred. Otherwise no files will be removed.
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
DataType: SOSOptionBoolean
Valid values:
true, 1, on, yes, y, ja, j
and
false, 0, off, no, n, nein
|
Default-Value: false |
|
transfer_mode
|
Type of Character-Encoding
|
[optional]
|
transfer_mode
|
Type of Character-Encoding
|
[optional]
|
Type of Character-Encoding
Transfer mode is used for FTP exclusively and can be either
ascii
or
binary .
DataType: SOSOptionTransferMode |
Default-Value: binary |
|
DataType: SOSOptionTransferMode |
Default-Value: binary |
|
user
|
UserID of user in charge
|
[required]
|
user
|
UserID of user in charge
|
[required]
|
UserID of user in charge
User name for authentication at the (FTP/SFTP) server.
DataType: SOSOptionUserName |
Default-Value: anonymous |
|
DataType: SOSOptionUserName |
Default-Value: anonymous |
|
verbose
|
The granuality of (Debug-)Messages
|
[optional]
|
verbose
|
The granuality of (Debug-)Messages
|
[optional]
|
The granuality of (Debug-)Messages
The verbosity level specifies the intensity of log entries.
A value between 1 and 9 can be specified.
Higher values cause more detailed information to be logged.
Log output is written to stdout or to a file that has been specified
with the parameter
→log_filename
.
DataType: SOSOptionInteger |
Default-Value: 10 |
|
DataType: SOSOptionInteger |
Default-Value: 10 |
|
zero_byte_transfer
|
|
[optional]
|
zero_byte_transfer
|
|
[optional]
|
This parameter specifies whether zero byte files should be transferred and processed by subsequent commands.
The following settings are available:
-
yes
: Files with zero byte size are transferred (default).
-
no
: Files with zero byte size are transferred, should at least one of
the files have more than zero byte size.
-
strict
: Files with zero byte size are not transferred. An error will
be raised if any zero byte file is found.
-
relaxed
: Files with zero byte size will not be transferred.
However, no error will be raised if this results in no files being transferred.
Use of this parameter can be refined using the
→force_files
parameter:
should
→force_files
have the value
false,
then processing will be treated as successful in the event of no files having been transferred.
Note that the
→remove_files
parameter has unrestricted validity.
Files with zero byte size will be removed regardless of whether or not they have been transferred.
DataType: SOSOptionStringValueList |
Default-Value: yes |
|
DataType: SOSOptionStringValueList |
Default-Value: yes |
|