Universal FTP Client Configuration Options

This page provides links to detailed information on the configuration options available for use with Universal FTP Client.

The options are listed alphabetically, without regard to any specific operating system.

Configuration Options

The following table identifies the Universal FTP Client configuration options.

Option Name	Description
ACTIVE_MODE	Specification that the data connection mode of the FTP Client server is Active.
AUTHENTICATE_PEER	Specification for whether or not UFTP will certify that an FTP server's certificate was issued by a known and trusted authority.
BIF_DIRECTORY	Broker Interface Directory (BIF) directory where the Universal Broker interface file, ubroker.bif, is located.
CA_CERTIFICATES	Location of a PEM-formatted trusted CA x.509 certificate.
CERTIFICATE	Location of a PEM-formatted X-509 certificate (that is, a public key).
CERTIFICATE_EXPIRATION_NOTICE	Number of days prior to certificate expiration to begin issuing informational messages about the expiration.
CERTIFICATE_REVOCATION_LIST	Location of a PEM-formatted certificate revocation list.
COMMAND	Command to be executed by the host.
COMMAND_FILE	File (ddname for z/OS) of a plain text command file containing one or more configuration options.
DATA_TYPE	Modifies the behavior of GET/MGET and PUT/MPUT by explicitly setting the data representation type used for data transfer.
DESTINATION	Destination path of the file being transferred.
ENABLE_SSL	Specification for whether or not UFTP will request an explicit FTPS session to the server specified by the HOST option.
ENCRYPTED_COMMAND_FILE	File / ddname containing encrypted values for command line options.
ENCRYPTION_KEY	Key that is used to decrypt the file specified by the ENCRYPTED_COMMAND_FILE option.
EXTENDED_PASSIVE_MODE	Specification that the data connection mode of the FTP Client server is Extended Passive.
HELP	Displays a description of the command line options and their format.
HOST	Name of the remote host to connect to on which the command is to be run.
KEY_PASSPHRASE	Passphrase which may have been used to secure a private key file used in SFTP transfers.
LIST_PARSER	Path to a file containing entries that describe the format of file listings received from FTP servers, based on operating system and/or file system.
MAX_SSL_PROTOCOL	Maximum SSL/TLS protocol level that will be negotiated and used to secure a session for FTPS transfers.
MESSAGE_LEVEL	Level of messages written.
MIN_SSL_PROTOCOL	Minimum SSL/TLS protocol level that will be negotiated and used for communication channels.
MOVE	Modifies the behavior of GET / MGET and PUT / MPUT commands by deleting the source file after it has been transferred to the destination.
NO_SIZE	Disables the GET command File Size operation.
OTEL_ENABLE_TRACING	Specifies whether UFTP will export traces to the Opentelemetry collector.
OTEL_SERVICE_NAME	Sets the value of the `service.name` resource attribute used to identify UFTP in traces and metrics.
OTEL_SSL_CA_CERT_PATH	Specifies the full path to the file containing one or more X.509 trusted certificates in PEM format. The certificate(s) will be used to validate the Opentelemetry Collector (server). This option should only be specified for secure, HTTPS endpoints (ignored for HTTP).
OTEL_SSL_CLIENT_CERT_PATH	Specifies the full path to an X.509 certificate used to identify UFTP to the Opentelemetry Collector. This option is only needed for HTTP connections where client authentication is set up in the Opentelemetry Collector.
OTEL_SSL_CLIENT_KEY_PATH	Specifies the full path to the PEM formatted file containing the private key associated with the client certificate specified by the OTEL_SSL_CLIENT_CERT_PATH option. This option is only needed for HTTP connections where client authentication is set up in the Opentelemetry Collector.
OTEL_SSL_INSECURE_SKIP_VERIFY	Specifies whether to validate the Opentelemetry Collector's (server's) certificate against the locally configured CA certificate (specified by OTEL_CA_CERT_PATH option).
OTEL_TRACE_ENDPOINT	URL used to export UFTP trace data using the OTLP/HTTP(S) protocol to the Opentelemetry Collector.
OTEL_TRACE_PARENT	Specifies the parent span context for the `start` span. If provided, the `start` span will be a child of the specified parent span, otherwise it will be a root span. This option is useful for continuing tracing among multiple applications.
PASSIVE_MODE	Specification that the data connection mode of the FTP Client server is Passive.
PASSWORD	Password to use in authentication.
PLF_DIRECTORY	Program Lock File (PLF) directory where the program lock files are located.
PORT	Port number of the remote port to connect to.
PRIVATE_KEY	Location of a PEM-formatted RSA private key.
PRIVATE_KEY_PWD	The (optional) password required to access the file specified by PRIVATE_KEY.
PROTOCOL	Default procotol to be used for a transfer, if HOST and COMMAND configuration options have been specified.
QUOTE	Specification to send a command string directly to the host.
REGEX	Specification to use of Regular Expression matching for the MGET, MPUT, and MDELETE commands.
SFTP_UPLOAD_BUFFER_SIZE	Specifies the size of the cURL upload buffer.
SITE	Formats directory listings (LIST) so that they can be parsed by the FTP Client.
SOURCE	Source directory of the file being transferred.
SSH_KEY	Path to the SSH key file.
SSL_CIPHER_LIST	List of SSL/TLS ciphers used to secure control and data sessions for FTPS transfers.
SSL_CIPHER_SUITES	SSL/TLS 1.3 specific cipher suites that UFTP would like to use to secure the control and data sessions for an FTPS transfer.
SYSTEM_ID	Local Universal Broker with which UFTP must register before it performs any request.
UNHIDE	Specification for UFTP to include any hidden files in files reported to the user.
USER	Remote user name to use in authentication.
VERIFY_HOST_NAME	Specification for whether or not UFTP will require identifying information in an FTP server's certificate that corresponds to the specified HOST value.
VERSION	Writes the program version and copyright information.