SMB Connector

This node connects to a remote SMB server (e.g. Samba, or Windows Server). The resulting output port allows downstream nodes to access files, e.g. to read or write, or to perform other file system operations (browse/list files, copy, move, ...). This node generally supports versions 2 and 3 of the SMB protocol. It also supports connecting to a Windows DFS namespace.

Path syntax: Paths for SMB are specified similar to Windows Paths, but with a leading backslash (\). The path is interpreted relative to the chosen Share (or DFS namespace). For example \myfolder\file.csv, is an absolute path that consists of:

  1. A leading backslash (\).
  2. The name of a folder (myfolder), followed by a backslash.
  3. Followed by the name of a file (file.csv).

Options

Settings

Connect to
Specifies whether to connect by specifying a file server host or a Windows domain.

Choosing File server specifies that a direct connection shall be made to access a file share on a specific file server. A file server is any machine that runs an SMB service, such as those provided by Windows Server and Samba. For example, this mode is similar to connecting to \\server.company.com\marketing using the Windows Explorer, which makes a direct connection to the SMB service running on server.company.com.

Choosing Domain specifies that a connection shall be made to access a file share in a Windows Active Directory domain. For example, this mode is similar to connecting to \\company.com\marketing using the Windows Explorer, which first locates and then connects to an SMB service that provides the marketing file share (or DFS namespace) for the Windows domain company.com.

Host
When using "File server" connection:Hostname of the host where the SMB server runs, e.g. server.company.com.
Port
When using "File server" connection:Port that the SMB server is listening on for incoming connections.
Share
When using "File server" connection:The name of the file share provided by the SMB server. The name of the file share must not contain any backslashes.
Domain
When using "Domain" connection:The name of the Windows domain (Active Directory), e.g. company.com.
Share/Namespace
When using "Domain" connection:The name of the file share (or DFS namespace) to access. The name of the file share/namespace must not contain any backslashes.
Authentication
Method of authentication to use:
  • Username & password: Authenticate with a username and password (the underlying authentication mechanism is NTLM). Either enter a username and password here, in which case the password will be persistently stored (in encrypted form) with the workflow. Or check Use credentials and a select a credentials flow variable to supply the username and password. Note that the username field also accepts usernames of the form DOMAIN\user and user@DOMAIN.
  • Kerberos: Authenticate using an existing Kerberos ticket.
  • Guest: Authenticate as the Guest user (without password).
  • Anonymous: Authenticate with an empty username (without password).
Working directory
Specify the working directory of the resulting file system connection, using the Path syntax explained above. The working directory must be specified as an absolute path. A working directory allows downstream nodes to access files/folders using relative paths, i.e. paths that do not have a leading backslash. The default working directory is "\".

Advanced

Read/Write timeout
The timeout for read/write operations (in seconds).
SMB version(s)
The option allows to enforce the usage of specific SMB protocol version(s). Selecting Auto option will make the node to choose the highest version supported by both this node and the SMB server.
Use encryption
If enabled the node will use SMB Encryption that provides SMB data end-to-end encryption if also supported by the SMB server. This option requires SMB versions 3.x.

Input Ports

This node has no input ports

Output Ports

Icon
SMB File System Connection

Popular Predecessors

Popular Successors

Views

This node has no views

Workflows

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.

Installation

To use this node in KNIME, install the extension KNIME Basic File System Connectors from the below update site following our NodePit Product and Node Installation Guide:

v5.4

A zipped version of the software site can be downloaded here.

Plugin provider: KNIME AG, Zurich, Switzerland
Plugin version: 5.4.0.v202411071403
On NodePit since: 2024-12-06
Last update: 2024-12-17
KNIME versions: Since v4.4

Deploy, schedule, execute, and monitor your KNIME workflows locally, in the cloud or on-premises – with our brand new NodePit Runner.

Try NodePit Runner!