On This Page
Network File Share (NFS) Connector
The NFS connector in SkySync has specific permission-related requirements beyond that of the connector Identity. Additional configuration may be needed to allow SkySync to use of the NFS Connector.
Prepare a SkySync Manager Service account
When a SkySync Job runs, it is the SkySync Manager Service that is connecting to and accessing the content on the NFS platform. Therefore, the SkySync Manager Service needs to be running as a domain account that has the proper permissions to access the content that will be managed by SkySync.
Review the SkySync Manager/Server Installation documentation to learn about Configuring SkySync 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. SkySyncV4.
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 > SkySyncV4 > db_owner
Please see the following documentation: SkySync 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
Select Connections > Add connection.
Select Network File Share as the platform on the Add connection modal.
Enter the connection information. Reference the table below for details about each field.
Test the connection to ensure SkySync can connect using the information entered.
Select Done.
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. SkySync’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 SkySync
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.
Permissions
When applying permissions to FS/NFS, SkySync sets read access permission to "Read and Execute" rather than just "Read."
NFS Connection Troubleshooting for Microsoft Windows
When SkySync 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 SkySync is running on Windows. The connection creation will fail for the second user because the SkySync 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 | SkySync API
{
"name": "\\\\{{Your Machine Name}}\\{{Your NFS Directory or Folder}}",
"platform": {
"id": "nfs"
},
"auth": {
"unc": "\\\\{{Your Machine Name}}\\{{Your NFS Directory or Folder}}"
}
}