SMB/CIFS (Shared Resource Monitoring)

SMB/CIFS Device Driver provides monitoring for files and folders shared via Server Message Block (SMB) technology that's also referred as Common Internet File System (CIFS) or Microsoft Windows Network.

Driver Information

Driver Plugin ID:

com.tibbo.linkserver.plugin.device.samba

Global Settings

None defined.

User Level Settings

None defined.

Device Account Properties

SMB/CIFS device account is configured by the following properties:

Field Name

Field Description

Address

IP Address or host name of the SMB server.

Protocol

Select your protocol: SMB v1 or SMB v2/v3.

Path

Location (full path) of a remote file or folder to be monitored.

Read Contents

Enables/disables reading of file contents.

Recursive

Enables/disables recursive reading for folders.

Incremental Reading

Switches between reading the whole file and incremental reading.

Incremental reading is ideal for log file analysis. If it's enabled, the server remembers previous file size and, during the next synchronization cycle, reads data starting from the previous end point to the end of file. If the file size has not grown since the previous cycle, no reading is performed. If file size has decreased, the reading is restarted from file start (this is suitable to handle log file rotation).

Maximum Read Size

Maximum number of bytes that the server will read if incremental reading is enabled.

Backlog Read Size

Number of bytes to include from previous steps of incremental reading.

Allow Editing

Allows or prohibits modification of file contents.

Calculate Checksum

Enables/disables file checksum calculation.

Enable Authentication

Enables/disables access to password-protected resources.

Domain

Domain in which the username exists.

Username

Username to use for authentication.

Password

Password to use for authentication.

Device Assets

Assets are not supported by the driver.

Device Settings

SMB/CIFS device driver creates the following Device setting variables:

Variable Name

Variable Description

Comments

attributes

File Attributes

This variable is created only if Path points to a file.

Contains the file attributes:

  • Last Modification Time (modificationTime)
  • Size (size)
  • Checksum calculated using Adler-32 algorithm (checksum)

attributes

Folder Attributes

This variable is created only if Path points to a folder.

Contains the folder attributes:

  • Last Modification Time (modificationTime)
  • Size (size)
  • File Count (fileCount)

contents

File Contents

This variable is created only if Path points to a file.

It contains read-only (if Read Contents option is on) or editable (if Allow Editing option is also on) file contents.

contents

Folder Contents

This variable is created only if Path points to a folder.

List of folder items (files and subfolders) with the following fields:

  • Type (itemType)
  • Relative Path (itemPath)
  • Size (itemSize)

Device Operations

Upload File

This operation uploads a file.

Input:

Result:

  • Result. String. Status of the file upload operation.

Download File

This operation downloads a file.

Input:

Result:

Rename File

This operation renames a file.

Input:

  • File. String. File name.
  • New File Name. String. New name for the file.

Result:

  • Result. String. Status of the file renaming operation.

Delete File

This operation deletes a file.

Input:

Result:

  • Result. String. Status of the file deletion operation.

Device Events

No events provided by the driver.

Connection Handling

The SMB/CIFS device will be deemed online if the following steps was successfully completed:

  • Connection to the remote server was established
  • Authentication was successful (if enabled)
  • The remote resource specified by Path setting exists and is available
  • All I/O operations with the resource (e.g. file/folder content reading or writing) were successfully completed

Synchronization Details

During synchronization of an SMB/CIFS device with the server, the following operations are performed:

  • If the Path points to a file, attributes and (optionally) contents of the file are obtained
  • If the Path points to a folder, attributes of the folder and list of files located in this folder and (if Recursive is enabled) its subfolders are retrieved
  • If editing is allowed and a user has edited server-side copy of file contents, the new contents are written to the file

Was this page helpful?