NFS
Discover more about the NFS component and how to use it on the Digibee Integration Platform.
Last updated
Discover more about the NFS component and how to use it on the Digibee Integration Platform.
Last updated
Important information:
Due to NFS protocol features that work only on private and local networks, only dedicated SaaS platforms are supported by the component.
Currently, the Digibee Integration Platform only supports NFS version 3.
The NFS component manipulates files. You can list, download and upload files, and also delete them.
Take a look at the configuration parameters of the component. Parameters supported by Double Braces expressions are marked with (DB).
| Parameter | Description | Default value | Data type |
|---|---|---|---|
In order to have access to the directory of an NFS server through the NFS component, the /etc/exports archive will have to be configured using * character to map the customer's IP.
For example: /home *(rw,sync,nohide)
No specific message is required in the input. You may only set up the fields required for each operation.
success: it is “false” when an execution error has occurred.
message: it is the component’s error message.
error: it is an error message received from NFS.
Server IP: 192.168.56.101
Exported Path: /var/nfs/general
Operation: LIST_FILTER
Remote Directory: /
File Name: test
Exact Match: deactivated
UID: 0
GID: 0
Maximum Retries: 3
Fail On Error: deactivated
Server IP: 192.168.56.101
Exported Path: /var/nfs/general
Operation: LIST_FILTER
Remote Directory: /
File Name: test.txt
Exact Match: activated
UID: 0
GID: 0
Maximum Retries: 3
Fail On Error: deactivated
Server IP: 192.168.56.101
Exported Path: /var/nfs/general
Operation: DOWNLOAD
Remote Directory: /
File Name: file.txt
Remote File Name: file-remote.txt
UID: 0
GID: 0
Maximum Retries: 3
Fail On Error: deactivated
Server IP: 192.168.56.101
Exported Path: /var/nfs/general
Operation: UPLOAD
Remote Directory: /
File Name: file.txt
Remote File Name: file-remote.txt
UID: 0
GID: 0
Maximum Retries: 3
Fail On Error: deactivated
Server IP: 192.168.56.101
Exported Path: /var/nfs/general
Operation: DOWNLOAD
Remote Directory: /
Remote File Name: file-remote.txt
UID: 0
GID: 0
Maximum Retries: 3
Fail On Error: deactivated
Operations
It lists available operation types - Hash Fields and Hash Payload.
N/A
String
Server IP
IP number from the NFS server.
N/A
String
Exported Path
Full path of the directory exported from the NFS server (this path is set up in the server file etc/exports).
N/A
String
Maximum Retries
Maximum number of attempts to connect to the NFS server.
3
Integer
UID
UID stands for User IDentifier. Linux uses the UID number to monitor users and verify their permissions. Files and directories initially have the same UID as the user who created them. It is used to grant access permission to the file.
N/A
Integer
GID
GID stands for Group Identifier. Linux organizes files and directories into groups. The GID of a file is initially inherited from the user who creates the file. It is used to grant access permission to the file.
N/A
Integer
GIDs
This parameter is optional. It lists a maximum of 16 GID numbers to which the user is part. It must be separated by a comma. E.g.: 0,1.
N/A
String
File Name (DB)
FIle name or full file path (i.e. tmp/processed/file.txt) of the local file used for downloading, uploading, and filtering files in a list.
N/A
String
Remote File Name (DB)
Name of the file or full file path (i.e. tmp/processed/file.txt) of the NFS server file.
N/A
String
Remote Directory
Remote directory name.
/
String
Exact Match
It is a filter. When activated, it searches exactly what is specified in the File Name field. Otherwise, it will make an approximate search.
False
Boolean
Fail On Error
If the option is activated, pipeline executions will be interrupted if an error occurs. Otherwise, the execution of the pipeline continues, but the result of the success property will be false in the output of the component.
False
Boolean