Provides access to SMB Sessions with shared authentication credentials.


samba, smb, cifs, files


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
HostnamehostnameThe network host of the SMB file server.
Portport445Port to use for connection.
ShareshareThe network share to which files should be listed from. This is the "first folder"after the hostname: smb://hostname:port/[share]/dir1/dir2
UsernameusernameGuestThe username used for authentication.
PasswordpasswordThe password used for authentication.
Sensitive Property: true
DomaindomainThe domain used for authentication. Optional, in most cases username and password is sufficient.
SMB Dialectsmb-dialectAUTO
  • AUTO
  • SMB 2.0.2
  • SMB 2.1
  • SMB 3.0
  • SMB 3.0.2
  • SMB 3.1.1
The SMB dialect is negotiated between the client and the server by default to the highest common version supported by both end. In some rare cases, the client-server communication may fail with the automatically negotiated dialect. This property can be used to set the dialect explicitly (e.g. to downgrade to a lower version), when those situations would occur.
Use Encryptionuse-encryptionfalse
  • true
  • false
Turns on/off encrypted communication between the client and the server. The property's behavior is SMB dialect dependent: SMB 2.x does not support encryption and the property has no effect. In case of SMB 3.x, it is a hint/request to the server to turn encryption on if the server also supports it.
Timeouttimeout5 secTimeout for read and write operations.

State management:

This component does not store state.


This component is not restricted.

System Resource Considerations:

None specified.