The SMB connector is used to communicate with network file shares using the Common Internet File System (CIFS) protocol, which is a dialect of the Server Message Block (SMB) protocol.
This connector allows access to a file share as a specific network user configured in the connector. A Share Path is defined through the SMB properties tab as the path that appears as the root of the files accessible through the connector. Files and folders at or below the Share Path are accessible while those above are not.
The connector will attempt to use the highest dialect set by the Max Smb Version and will negotiate down to the Min Smb Version until a dialect is selected that both the client and the server support.
A list of additional properties that can be added using "Additional SMB Properties" is available at https://jcifs.samba.org/src/docs/api/overview-summary.html#scp
To enable debugging for the underlying SMB library, select SMB: in the Include Debug Options found in Administration > Logs. Debug log messages are written to the standard debug log.
If running Cleo Harmony in FIPS mode, the FIPS mode option must be enabled for the connection to work correctly. When the SMB connector is running in FIPS mode the maximum protocol version is set to SMB 1 and the "jcifs.smb.client.useExtendedSecurity" is disabled as it requires ciphers that are not supported in FIPS.
- The SMB connector currently supports SMB 1 (NT LM 0.12), SMB2.02, SMB2.1, SMB3.0, SMB3.0.2, and SMB3.1.1
|Share Path||The SMB root path.
Custom macros may be used at the beginning of the path.
|User Name||The host server connection account user name.||Yes|
|User Password||The host server connection account user password.||Yes|
|Domain||The domain name.|
|Max Smb Version||Set the maximum SMB version.||Yes|
|Min Smb Version||Set the minimum SMB version.||Yes|
|Smb Cache Expiration||The amount of time to cache attributes about a file.
|Additional SMB Properties||Custom properties.|
|Force Make Directories||Create parent folders that do not exist for a destination file.|
|FIPS Mode||When running with FIPS this option must be selected. When FIPS Mode is enabled, only SMB 1 is supported.|
|Command Retries||The number of times the command should be retried when an error or exception occurs.
Valid range: [0-5].
|Command Retry Delay (seconds)||The number of seconds to wait between retries.
Valid range: [0-120].
|Do Not Send Zero Length Files||For PUT, a switch that controls whether to send a file if it is zero-length.|
|Delete Received Zero Length Files||For GET, a switch that controls whether to remove a received file that is zero-length.|
|Retrieve Directory Sort||For PUT, the sorting options for the list of outbound files.|
|Enable Debug||A switch that indicates whether to perform debug logging.|
|System Scheme Name||The URI scheme name used as a shortcut to this host.
|System Public||A switch that indicates whether the connector is public.|