Skip to main content
Pentaho Documentation

VFS Properties

vfs . scheme . property . host

The vfs subpart is required to identify this as a virtual filesystem configuration property. The scheme subpart represents the VFS driver's scheme (or VFS type), such as http, sftp, or zip. The property subpart is the name of a VFS driver's ConfigBuilder's setter (the specific VFS element that you want to set). The host optionally defines a specific IP address or hostname that this setting applies to.

You must consult each scheme's API reference to determine which properties you can create variables for. Apache provides VFS scheme documentation at The org.apache.commons.vfs.provider package lists each of the configurable VFS providers (ftp, http, sftp, etc.). Each provider has a FileSystemConfigBuilder class that in turn has set*(FileSystemOptions, Object) methods. If a method's second parameter is a String or a number (Integer, Long, etc.) then you can create a PDI variable to set the value for VFS dialogues.

The table below explains VFS properties for the SFTP scheme. Each property must be declared as a PDI variable and preceded by the vfs.sftp prefix as defined above.

Note: All of these properties are optional.
SFTP VFS Property Purpose
compression Specifies whether zlib compression is used for the destination files. Possible values are zlib and none.
identity The private key file (fully qualified local or remote path and filename) to use for host authentication.
authkeypassphrase The passphrase for the private key specified by the identity property.
StrictHostKeyChecking If this is set to no, the certificate of any remote host will be accepted. If set to yes, the remote host must exist in the known hosts file (~/.ssh/known_hosts).