Virtual File System Settings.

Virtual filesystem Highlights(VFS)

-When you want to specify properties for a VFS for a particular host, the rules are as follows.

1)    You can specify VFS properties as parameters. The format of the reference to a VFS property is vfs.scheme.property.host.

The following list describes the subparts of the format:

·         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.

2)     

Any string configuration parameter of a VFS scheme is supported by default.

The VFS configuration options follow the format:

vfs.scheme.parameter...

Where:

‘Vfs ' is required to indicate a VFS configuration option

‘Scheme ' is required to indicate the VFS scheme against which the parameter will be applied

‘Parameter ' is the name of the VFS-Scheme configuration parameter to apply

Note: This is case sensitive.

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

SFTP Notes:

The standard SFTP URL format is sftp://username:password@host:port/path

If you are using private key authentication, password is not supported. If your key requires a passphrase you must use the 'authkeypassphrase' configuration parameter.

The configuration options support limiting of the option to a specific host.

This is accomplished by adding the hostname, separated by a ' . ' after the parameter name.

For instance, you may wish to turn of StrictHostKeyChecking for a specific host only.

Examples:

vfs.sftp.StrictHostKeyChecking.sftp.myhost.net

vfs.sftp.StrictHostKeyChecking.192.168.1.5

SFTP supports the following options:

StrictHostKeyChecking - If 'no', the certificate of any remote host will be accepted. If 'yes', the remote host must exist in the known hosts file (~/.ssh/known_hosts).

authkeypassphrase - An optional passphrase that may be required to use the identity key

identity - The fully qualified path to the private key used for SFTP authentication

All Three ways shown below.

àsftp--key Authentication:

sftp://${sftp_authkey_username}@${sftp_authkey_host}/${sftp_authkey_path}

àsftp---Standard Authentication

sftp://${sftp_stdauth_username}:${sftp_stdauth_password}@${sftp_stdauth_host}/${sftp_stdauth_path}

àzip simple:

zip://${zip_file_path}!/${zip_internal_path}

 =====================================================================================

The Variables must be supplied. Based on the hierarchy the interface will check in to find the variable in the curly bracket. The interface will check in few different places like Path file/Environment Variables/Variables supplied.

The following MUST be set through variables for this example to run:

sftp_authkey_username            : johndoe

sftp_stdauth_username             : johndoe(Username/Password  example host)

sftp_stdauth_password             : password 

sftp_authkey_host                     : 192.168.5?.10?(Key Authentication example                             host)

sftp_authkey_path                     : home(Key Authentication example path on sftp             server)

sftp_stdauth_host                      :(Username/Password  example host)

sftp_stdauth_path                      : (Username/Password Authentication example                       path on sftp server)

vfs.http.proxyHost                      : 192.168.1.2??(A parameter that exists but is           not used by any steps in this transformation)

vfs.sftp.StrictHostKeyChecking : no(Accept the encryption key of any SFTP                                                                                server)

vfs.sftp.authkeypassphrase.192.168.5?.10?: password(The passphrase for the                                                                               private key used for authentication                                                                           to the specified SFTP host)

vfs.sftp.identity.192.168.5?.10?         : C:\temp\auth\private_key(The private key                                                                              used for authentication to the                                                                                     specified SFTP host)

zip_file_path                                       : /c:/temp/temp.zip(Local path to a zip file)

zip_internal_path                                :(Path inside of zip file to extract)