Network File Share (NFS)



On This Page


Network File Share (NFS) Connector

The NFS connector in DryvIQ has specific permission-related requirements beyond that of the connector Identity. Additional configuration may be needed to allow DryvIQ to use of the NFS Connector. 

Prepare a DryvIQ Manager Service account 

When a DryvIQ Job runs, it is the DryvIQ Manager Service that is connecting to and accessing the content on the NFS platform.  Therefore, the DryvIQ Manager Service needs to be running as a domain account that has the proper permissions to access the content that will be managed by DryvIQ.  

Review the DryvIQ Manager/Server Installation documentation to learn about Configuring DryvIQ and pay particular attention to the Configure Windows Service section.

 

For proper job function, the account requires Read, Write, Update and Delete privileges.

 

SQL Server (Optional)

You can optionally create the database before running the installer:

1. Log into SQL Server Management Studio.

2. Create a new database.

  • Set the name appropriately, ie. DryvIQV4.

  • Do not select an owner.

  • Set the recovery mode to simple.

  • Add the Windows Service Account User to the database.

    • Security > Logins > {Windows Service Account User} > properties > Server Roles > dbcreator or sysadmin

    • Security > Logins > {Windows Service Account User} > properties > User Mapping > DryvIQV4 > db_owner

 

Please see the following documentation: DryvIQ Platform | Infrastructure & Hardware Considerations

Prepare Source Environment  

  • Create a Windows domain user account that will be used for the migration and grant main admin privileges to that user on the file server.

  • Ensure the account used to create the NFS Connector has all necessary permissions to edit, copy, delete, and create files and folders.

  • If using IP, ensure that the IP is static and will not change.


Create an NFS Connection

  1. Select Connections > Add connection.

  2. Select Network File Share as the platform on the Add connection modal.

  3. Enter the connection information. Reference the table below for details about each field.

  4. Test the connection to ensure DryvIQ can connect using the information entered.

  5. Select Done.

 

 

Field

Value

Description

Required

Field

Value

Description

Required

Display as

Any value

Enter the display name for the connection. If you will be creating multiple connections, ensure the name readily identifies the connection. The name displays in the application, and you can use it to search for the connection and filter lists.

If you do not add a display name, the connection will automatically be assigned a default name. 

Optional

UNC Path

UNC Path  / Domain Name

Enter the UNC path for the connector. The UNC path will be to a folder at least 1 level off the root of the server, for example: \\<server name>\<folder on server>

You can also use the server IP address, for example: \\<ipaddress>\<folder on server>

You can locate the information by going to Windows>Control Panel>System and Security>System.

Required

User Name

Admin User Name

Enter the user name for the administrator account. You should leave this field blank if you are using integrated authentication.

This needs to be an account with authority to access the content you will to process.

*When creating a NFS connection with a UNC Path containing unicode characters (i.e. \\test\あああ), User Name and Password are REQUIRED.

Optional*

Password

Admin Password

Enter the password for the administrator account. You should leave this field blank if you are using integrated authentication.

*When creating a NFS connection with a UNC Path containing unicode characters (i.e. \\test\あああ), User Name and Password are REQUIRED

Optional*


Features and Limitations 

Platforms all have unique features and limitations. DryvIQ’s transfer engine manages these differences between platforms and allows you to configure actions based on Job Policies and Behaviors. Utilize the Platform Comparison tool to see how your integration platforms may interact regarding features and limitations.

  • The maximum length of any folder or file name is 32767

  • The maximum path length is 32767

  • No trailing spaces in folder names, file names, or file extensions

  • No trailing periods

  • Any non-printable ASCII characters will not be filtered by DryvIQ

  • Restricted characters in the file name: < > : " / \ | ? *

  • When creating a Connector, it must be one level down from the root. Example, C:/1st folder

 

Author Preservation (Windows Only)

Author Preservation for Network File Share is only supported for Windows only.

The NFS account owner can be identified in Properties → Security → Advanced → Advanced Security Settings.

Verify the Windows environment has long path support enabled.

  • (Local Computer Policy → Computer Configuration → Administrative Templates → All Settings → Enable Win32 long paths).

  • Refer to Microsoft's Maximum Path Length Limitation documentation for more information. 

.net core supports long paths, however functions that retrieve permissions for individual files still use old Win32 system calls. Long path support with these functions is not enabled by default.
Without long path support enabled, you will see the exception ‘invalid parameter: name’ in the log file or in the application user-interface log tab when attempting to get permissions on files with long paths.

Last Accessed Date

DryvIQ processing affects the Last Accessed date for files, but DryvIQ restores the original Last Accessed date after reading the file to preserve this date. If the NFS account used to create the source connection has read-only permissions to the source files, DryvIQ cannot restore the Last Accessed date, so the date will be affected by DryvIQ processing.

Permissions

When applying permissions to FS/NFS, DryvIQ sets read access permission to "Read and Execute" rather than just "Read."

“This Folder Only” Permissions

Network File Share supports the ability to assign permissions only to a certain folder. DryvIQ does not support “This folder only” permissions when moving content from NFS to other destinations. DryvIQ will add permissions to the folder on the destination based on the platform rules.


NFS Connection Troubleshooting for Microsoft Windows

When DryvIQ is running on Microsoft Windows, there are some nuances that may affect creating an NFS connection.

Multiple NFS Connections

You cannot create multiple connections to the same location UNC path and multiple users when DryvIQ is running on Windows. The connection creation will fail for the second user because the DryvIQ application uses an underlying Windows mechanism that requires unique names for each connection. If a connection to the same location but different user is needed, a workaround is to use the domain name in the UNC path for one connection and the IP address in the UNC path for the second connection.

Failed Connection Tests after Correcting Username or Password

There is an underlying Microsoft Windows issue that can cause issues when creating NFS connections. If an attempt is made to create a new NFS connection using an invalid username/password. The connection test will fail, which is expected behavior. Immediately entering the correct username/password may still result in a failed connection test even though it should pass. To prevent this issue, wait about 15 seconds after entering the correct username/password before running the connection test. The extra time allows Windows time to clear out the incorrect credentials and recognize the correct ones that were provided.


Create Connection | REST API

{    "name": "\\\\{{Your Machine Name}}\\{{Your NFS Directory or Folder}}",    "platform": {          "id": "nfs"    }, "auth": {      "unc": "\\\\{{Your Machine Name}}\\{{Your NFS Directory or Folder}}"       } }

 

 

DryvIQ Migrate Version: 5.6.2.4175
Release Date: March 7, 2024