Offline File Manager (for Microsoft Windows)

If you are using a StorNext HA environment, then you must use a StorNext HA virtual IP (VIP) address on your system for the Offline File Manager application to work properly.

See How to Add or Change the System VIP Address.

For proper operation of the Finder when using the Offline File Manager (for Apple macOS) application, it is important that you exclude Apple double files from truncation. This is the default behavior for StorNext 6; however, Quantum recommends you verify the configuration.

You must also exclude the configuration file used by the Offline File Manager (for Apple macOS) application from truncation, or it will not function.

The configuration file /usr/adic/TSM/config/excludes.truncate must include:

The Finder also maintains metadata content in ._DS_Store; storing this file triggers work for Storage Manager, which is not needed. You can control this by using /usr/adic/TSM/config/excludes.store, which must include:

On Systems Running StorNext 6.3.0 or Later

The named streams feature (see Add a File System) allows Offline File Manager to reject Finder (macOS) or Explorer (Microsoft Windows) from retrieving a truncated file.

If you enable named streams on your file system, then you do not have to configure your system to disable retrieves. The Offline File Manager performs operations to disable the client using the application.

Before you perform any browsing operation on your client, verify the Offline File Manager is running to prevent unintentional retrieves in Finder (macOS) or Explorer (Microsoft Windows).

Note: The addition of extended attributes to control a client’s ability to retrieve files allows the MDC to have retrieves denied. In StorNext 6.3 (or later), if retrieves are denied on the MDC, then some other operations may not complete. The most common need for an MDC to have retrieves disabled is when the MDC is used as a NAS server. If it is not a NAS server, then you can enable retrieves . For example:

Note: If you were previously using an nss_cctl.xml file only to deny retrieves for clients, you can remove the file. If you do not use named streams or a central control file, you will be able to open a truncated file.

On Systems Running StorNext 6.0.x to 6.2.x

To disable on-demand retrieve operations, you must configure the Central Control feature of StorNext. Central Control allows you to restrict the access that different machines are granted to the file systems in a cluster. Currently there is no GUI option for this, so you must log into your MDC.

1. Log on to an SSH client, and connect to your system.

   Central Control is managed from the StorNext nameservers by an XML configuration file in the directory /usr/cvfs/config/nss_cctl.xml (see the nss_cctl(4) command in the StorNext Man Pages Reference Guide for additional information). These nameservers must also be on StorNext 6.x if they are not the same system as the MDC.

   For initial configuration, the command nss_cctl_template is available. For example, nss_cctl_template>/usr/cvfs/config/nss_cctl.xml.

2. At the prompt, enter the following command:

   nss_cctl_template>/usr/cvfs/config/nss_cctl.xml

   The nss_cctl.xml script uses the snprobe command to walk the current cluster and output a template file based on the cluster it finds. This tool generates a permissive configuration file with all capabilities enabled for all visible clients.

3. Edit the configuration properties in the nss_cctl.xml file.

   The configuration file contains a securityControl section for each file system, and a separate section at the end for the fake file system #SNFS_ALL#. When looking for the controls for a file system, it invokes a command that queries for a file system specific record and then falls back to the one for #SNFS_ALL#.

   Within each file system there are one or more controlEntries. Each control entry specifies the addresses of one or more clients, and the controls to be applied to them.

   Tips for Configuring Client Retrieval and Denial

   • If there are a mix of clients, some that wish to deny retrieves and others that do not, create separate control entries within the file system’s security control tags.
   • For DLC clients, add the client’s hostname or IP address to the client section with the desired controls.
   • For NAS, controls can only be set for the NAS server. This is due to the NAS server’s IP being used for all operations. Clients connected via NAS cannot be controlled on a per client basis.
   • For HA, use the VIP in the client section.

   For example:

   <?xml version="1.0" ?>
   <snfsControl xmlns="https://www.quantum.com/snfs/cctl/v1.0">
     <securityControl fileSystem="snfs1">
       <controlEntry>
         <client>
           <address value="fruit.company.com"/>
           <address value="banana.company.com"/>
           <address value="mdc-1.company.com"/>
           <address value="mdc-2.company.com"/>
         </client>
         <controls>
           <mountReadOnly value="false"/>
           <mountDlanClient value="true"/>
           <takeOwnership value="true"/>
           <exec value="true"/>
           <suid value="true"/>
           <denyRetrieves value="true"/>
           <globalSuperUser value="true"/>
         </controls>
       </controlEntry>
       <controlEntry>
         <client>
           <address value="orange.company.com"/>
           <address value="apricot.company.com"/>
         </client>
         <controls>
           <mountReadOnly value="false"/>
           <mountDlanClient value="true"/>
           <takeOwnership value="true"/>
           <exec value="true"/>
           <suid value="true"/>
           <denyRetrieves value="false"/>
           <globalSuperUser value="true”/>
         </controls>
       </controlEntry>
     </securityControl>
     <securityControl fileSystem="#SNFS_ALL#">
       <controlEntry>
         <client>
           <address value="0.0.0.0/0"/>
         </client>
         <controls>
           <mountReadOnly value="false"/>
           <mountDlanClient value="true"/>
           <takeOwnership value="true"/>
           <exec value="true"/>
           <suid value="true"/>
           <snfsAdmin value="true"/>
           <snfsAdminConnect value="true"/>
           <denyRetrieves value="false"/>
           <globalSuperUser value="true"/>
         </controls>
       </controlEntry>
     </securityControl>
   </snfsControl>

   Central Control does not allow access to hosts that are not listed. However, it does support a netmask when specifying hosts, so a subnet can be covered by one record if desired.

   Note: If you add new clients, you must add them to the securityControl control configuration.

4. Edit the denyRetrieves control entry, within the nss_cctl.xml file, by setting it to true.

   <denyRetrieves value="true"/>

   The denyRetrieves control prevents a client from triggering on-demand file retrieves. Set this to true to prevent the client from triggering retrieves. This control functionality runs on the MDC, so older clients will have the control enforced after you have configured the file nss_cctl.xml.

   The client controls relate to SAN and LAN clients. SMB and NFS client control is routed through those client's NAS server and cannot be individually controlled. This is particularly important when configuring denyRetrieves for Offline File Manager.

   • SAN and DLC clients: The addresses of the clients themselves.
   • NAS clients via a NAS server on an HA pair: The VIP of the HA pair.
   • NAS clients via a NAS server on an MDC: The address of the MDC.
   • NAS clients via a NAS server on a gateway: The address of gateway.

   Note: If you set denyRetrieves to true for a NAS server, then this disables retrieves for that server and all NAS clients connecting using that server.

5. After you have configured the file, add it to the nameserver nodes.

   The nameserver processes will pick up an updated configuration on service restart, or on sending a SIGHUP to the fsmpm process. The updated configuration is only seen by clients at mount time, and by the FSM when a client connects.

   You can perform this by finding the pid and using kill to send the signal. To send a signal to the fsmpm, follow the commands below:

   For example:

   [root@node ~]# ps -ef | grep fsmpm

   root 9772 1 0 Dec11 ? 00:00:00 /bin/bash /usr/cvfs/lib/LogToFile fsmpm /usr/cvfs/debug

   root 9777 9772 0 Dec11 ? 00:00:00 /bin/bash /usr/cvfs/lib/LogToFile fsmpm /usr/cvfs/debug

   root 9778 1 0 Dec11 ? 00:00:00 fsmpm-watcher

   root 9779 9778 0 Dec11 ? 00:05:03 /usr/cvfs/bin/fsmpm -- -- /usr/cvfs/debug/fsmpm-sync

   root 23056 22583 0 08:00 pts/4 00:00:00 grep --color=auto fsmpm

   [root@node ~]# kill -HUP 9779

The Offline File Manager application requires information about the location of the MDC and the web services configuration to operate. This information is placed in a JSON configuration file in the root of the file system, or in the case of NAS access, in the root of each NAS share.

Below is the man page help output for the snwebsetup command:

snwebsetup [-h] [-u USER] [-p PASSWORD] -s SERVER dirs [dirs ...]

Setup remote rest access to filesystem or share

arguments:
  dirs                  directories to setup
  -h, --help            show this help message and exit
  -u USER, --user USER  web services user
  -p PASSWORD, --password PASSWORD
                        web services password
  -s SERVER, --server SERVER
                        web services URI

At the command prompt, enter one of the following commands:

• For the HTTPS protocol:

  snwebsetup -u <username> -p <password> -s https://mdc.company.com /stornext/<SNFS>

• For the HTTP protocol:

  snwebsetup -u <username> -p <password> -s http://mdc.company.com:81 /stornext/<SNFS>

The server option must specify the web address and protocol of the web services, so it expects a URL (for example, https://mdc.company.com or http://mdc.company.com).

The user and password fields must match an account that has been set up with access to web services. The application uses them to access the services.

Note: When you use the service over NAS, the online/offline state of a file is determined by file attributes which require StorNext 6.2 (or later).

On systems running StorNext 6.3.0 or later:

To use the icon overlay functionality, your file system must meet the following requirements:

• You must enable Named Streams on the file system.
• The file system must have access for the client to open them.
• The icons are not available as a NAS client.

If the requirements are not met, the icons only display the state of the file (online/offline).

Note: Due to a Microsoft Windows limitation, if you have other applications that use icon overlays, then your Offline File Manager icon overlays might not appear.

You can use the StorNext GUI or the CLI to enable named streams; do one of the following to enable named streams:

Use the StorNext GUI

1. On the menu, click Configuration, and then click File Systems.
2. Select a file system, and then click Edit....
3. Click Configuration Parameters.
4. Click Features.
5. Click Named Streams.
6. Click Apply. You are prompted to confirm the configuration change.
7. Click Yes.

Use the CLI

1. Edit your stornext.cfgx file:

   <snfs:globals>
       <snfs:namedStreams msgId="namedStreams">true</snfs:namedStreams>
       <snfs:storageManager msgId="storageManager">true</snfs:storageManager>
       <snfs:bufferCacheSize msgId="bufferCacheSize">1073741824</snfs:bufferCacheSize>
   </snfs:globals>
   

2. Stop the file system:

   [node@node] /usr/cvfs/bin/cvadmin -e 'stop snfs1'

3. Run cvupdatefs:

   [node@node] /usr/cvfs/bin/cvupdatefs
   Checked Build disabled - default.
   StorNext File Systems on host snt375492-mdc1:
   
   1) *snfs2 
   2)  snfs1
   
   The asterisk (*) denotes the file system is active.
   
   Choose a file system by number (1-3) or zero (0) to exit -> 2
   
   Buf_init: L1 size 1024 MB, L2 size 0 MB
   
   The following changes have been detected in the configuration
   Please review these changes carefully.
   
   Stripe Group Name          Stripe Status               MetaData     Journal
   =================          =============               ========     =======
   sg0                        No Change                   No Change    No Change
   
                                                 
   *** Named streams will be enabled in the file system. ***
   
   *Warning*: This will modify the file system "snfs1"
   
   Are you sure you want to continue? [(y)es/(N)o] y
   

4. Start the file system:

   [node@node] /usr/cvfs/bin/cvadmin -e 'start snfs1'

This section provides information on how to edit the .StorNext_rest.json file to allow the Offline File Manager application to function with the NFS/SMB file sharing protocols.

Use the CLI and perform the following on your system(s):

1. Log on to an SSH client, and connect to your system as the root user.

2. At the prompt, run the command below to display the API gateway configuration:

   snrest gateway show

   Example Output

   {
       "gateways": {
           "https://apigateway.mycompany.com:8443": {
               "url": "https://apigateway.mycompany.com:8443",
               "admin_url": "https://apigateway.mycompany.com:8443",
               "register": true
           }
       },
       "url": "https://apigateway.mycompany.com:8443",
       "admin_url": "apigateway.mycompany.com:8443"
   }
   

   
   

3. At the prompt, enter the following command to edit the .StorNext_rest.json file:

   vi /stornext/<directory>/.StorNext_rest.json

4. Within the editor, press i to insert text.

5. Add the following lines of text to the bottom of the .StorNext_rest.json file:

   "apiGatewayURI": "<URL of the registered API gateway>",

   "storeActions": "enabled"

   Note: The "storeActions" entry allows you to enable or disable the available Offline Actions options (Truncate, Store, Store All Copies, and so on) for an NFS/SMB share. If you have a managed file system for a mount, enter "enabled". If you do not have a managed file system for a mount, and only want to use the file system pooling feature with the Offline File Manager application, enter "disabled" or exclude the "storeActions" entry (the Offline Actions options only display Refresh and Action Window).

   Caution: Add a comma (,) after the last entry in the .StorNext_rest.json file. In the example below, it is the "password" entry.

   Example

   {
       "enabled": "true",
       "remap": "/stornext/snfs1",
       "server": "https://myserver.mycompany.com",
       "user": "admin",
       "password": "password",
       "apiGatewayURI": "https://apigateway.mycompany.com:8443",
       "storeActions": "enabled"
   
   }
   

6. Press Esc and then enter :w to write the changes to the file.

7. Press Esc and then enter :q to exit the editor.

8. Log out of your system, and then log in to apply the changes.

Open Windows Explorer to view the files within the relation point on a managed file system. The application begins by searching the currently mounted volumes for a StorNext file system. If a mount exists, then the application searches the volume for a .StorNext_rest.json configuration file. During the search, if a configuration file is found, but no user credentials are added, a dialog box appears informing you to provide your user credentials (for example, username and password).

Beginning with StorNext 6.3.0, you can use a richer set of icon overlays to describe the metadata of a file.

The table below illustrates the icons and their descriptions.

Icon	Description
	This file is online and has multiple tiers.
	This file is online and has object-store media backing.
	This file is online and has a tape library backing.
	This file is online and has an sdisk backing.
	This file is online.
	This file is offline and has multiple tiers.
	This file is offline and has object-store media backing.
	This file is offline and has a tape library backing.
	This file is offline and has an sdisk backing.
	This file is offline.

Note: For requirements, see Configure a File System To Enable the Offline File Manager Application above. If you do not meet the requirements, only the green check icon overlay and the red check icon overlay are displayed.

The image below illustrates how some files are truncated and other files are available on primary storage. You can see that some files have multiple copies while other files only have a single copy on a tape library.

Even with the Offline File Manager (for Microsoft Windows) installed and running, a truncated file cannot be directly read; it must be retrieved first.

Note: Offline File Manager actions might not function on files that contain illegal NTFS characters. Quantum recommends you use the /usr/cvfs/lib/snfsnamescanner feature to locate and rename illegal names in your StorNext file system. See the SNFSNAMESCANNER(8) command in the StorNext Man Pages Reference Guide for details.

To use the offline actions, perform the following procedure.

1. Using the Windows Explorer, right click a file (or multiple files) to display the context menu.
2. Click Offline Actions, and then click one of the following offline actions that appear:
   • Retreive. Click this option to restore the data blocks to the primary storage.
   • Truncate. Click this option to remove the data block from the primary storage to a tiered storage.
   • Store. Click this option to copy the data block that have not been tiered to tiered storage.
   • Store All Copies. Click this option to copy all data blocks that have not been tiered to tiered storage.
   • Refresh. Click this option to check the state of the file, for example, if it is truncated.
   • Action Window. Click this option to obtain extended file information and perform a pooling operation (see Use the Action Window (Extended File Attributes) Dialog).

   After an operation is performed, the icons update and a notification displays the beginning and end of an action.

   

   

In the Offline File Manager icon in the notification tray, you can click Open Log to view the log of an action performed.

The Offline File Manager log dialog provides a cumulative list of actions and their respective job numbers. For example:

To view a specific list of actions for a given job, in the Search field enter a job number preceded by the term Job and then click Search. For example:

To refresh the log, click Refresh.

In the Offline File Manager icon in the notification tray you can click the Enable recursive retrieves menu option to enable recursive retrieves. By default, Offline File Manager allows an action on only the first level down from a directory. When you enable recursive retrieves, you can perform an action on the entire directory tree.

Caution: Use this option with caution as you might unintentionally retrieve or truncate millions of files.

Beginning with Offline File Manager (for Microsoft Windows) 2.1.0, you can use file system pooling to move files and folders between defined pools of NVMe, SSD, and HDD within your file system.

To use the feature, your system must meet the following requirements:

• Use an API gateway; your API gateway allows Offline File Manager to locate a pooling host, assuming you configure pooling on a client or MDC, and also register the client or MDC with your API gateway.

• Enable file system pooling on a client or MDC.

  • Register your client or MDC with your API gateway; to register your components with your API gateway, see API Gateway Registration and Configuration.

There are two interface options that allow you to perform a file system pooling operation.

Use the Action Window (Extended File Attributes) Dialog

You can use the Action Window (Extended File Attributes) dialog to obtain extended file information and perform a pooling operation. Since Offline File Manager allows you to perform a pooling operation on multiple files, the Action Window (Extended File Attributes) displays the information for the first file; however, the pooling operation is applied to all the selected files.

Note: File system pooling is determined by Offline File Manager's ability to locate a pooling host. If a pooling host is not located, then the pooling operation functions and buttons are disabled.

Note: If a file is truncated, then the pooling operation functions and buttons are also disabled since the file is not on primary storage and pooling is not always configured to retrieve files.

Note: The file system pooling location is based upon the affinity set on a file.

Do the following to display the Action Window (Extended File Attributes) dialog and perform a pooling operation:

1. In Windows Explorer, navigate to your file system and then select multiple files.

2. Right-click the multiple files, click Offline Actions, and then click Action Window.

   

3. The Action Window (Extended File Attributes) dialog appears.

   

   The table below provides a description of the fields in the Action Window (Extended File Attributes) dialog.

   Field	Description
   Primary Tiering	Displays the status of the file system pooling process on the selected file(s): Enabled: File system pooling is enabled on the file(s). Disabled: File system pooling is disabled on the file(s).
   Primary Tiering Location	Displays the storage pool location on the selected file(s).
   Location Store Time Class Policy Truncate Time	The Location, Store Time, Class Policy, and Truncate Time, fields are snippets of the fsfileinfo command that describe a file’s Storage Manager policy.
   Filepath	Displays the directory path of the selected file(s).

4. Click a file system pooling operation:

   • Promote

   • Demote

   • Move

   • Remove

   • Truncate

   Note: For more information about a file system pooling operation (for example, Move, Promote, Demote, and so on), see StorNext File System Pooling.

5. Click OK to continue the pooling process, or click Cancel to return to the previous dialog. The Primary Tiering Destination dialog appears.

   

6. Click a pool name in the Current Location field, and then click OK. A notification displays the beginning and end of a successful pooling operation.

   

If you did not previously enter your API gateway user credentials, then you are prompted to enter the credentials during a pooling operation in the API Gateway Credentials dialog.

If you are not able to process a pooling operation, a notification appears if an operation is performed on a file. A failure also provides a reason and contains additional information in the log file.

Use the Primary Tiering Request Dialog

You can use the Primary Tiering Request dialog to perform a path based or a pattern based pooling operation.

Do the following to display the Primary Tiering Request dialog and perform a pooling operation:

1. In the Offline File Manager icon in the notification tray, click Perform tiering operation.

   

   The Primary Tiering Request dialog appears.

   

2. In the Primary Tiering Request dialog, complete the following:

   Option	Description
   Action	Click a file system pooling operation: Demote Move Promote Remove
   Type	Click a file system pooling operation type: Path Pattern Note: For more information about a pooling pattern rule, see StorNext File System Pooling.
   Mount	Click a file system pooling mount point. Note: Use the text box as an extension of the Mount point select. For example, if you select \Volumes\snfs\ as the mount point and you input movies\10-11-2020\ as the path, then the pooling operation is performed on Volumes\snfs\movies\10-11-2020\. Note: The Pattern type uses the same logic with separate syntax rules. It is important that you to understand a path and a pattern are handled differently. For example, if your input is \Volume\snfs\my_policy\file1, then the Path operation type treats your input as a single file. If you click Pattern for your Type, then the pooling operation treats your input as a search within the directory its entire sub-directory (\Volumes\snfs\my_policy) for the pattern file1. If there are multiple directories in the sub-directory, then all directories are checked for files that match the pattern. These files, if needed, are moved. For example: \Volumes\snfs\my_policy\file1 \Volumes\snfs\my_policy\test\file1 \Volumes\snfs\my_policy\first\last\one\two\file1

3. Click OK to continue the pooling process, or click Cancel to return to the previous dialog. The Primary Tiering Destination dialog appears. This dialog allows you to select the pool the operation is applied to.

   

4. Click a pool name in the Current Location field, and then click OK. A notification displays the beginning and end of a successful pooling operation.

   

If you did not previously enter your API gateway user credentials, then you are prompted to enter the credentials during a pooling operation in the API Gateway Credentials dialog.

If you are not able to process a pooling operation, a notification appears if an operation is performed on a file. A failure also provides a reason and contains additional information in the log file.

Troubleshoot Offline File Manager File System Pooling

• If a truncated file can be opened on the Offline File Manager client and the system meets any of the requirements below.

  Appliance Controller (NAS) is installed on the primary MDC or standalone MDC and the client is accessing a file system through NFS/SMB.

  Note: The configuration is not supported to work with Offline File Manager.

  The primary/standalone MDC cannot have retrieves denied. This is due to Web Service requests to retrieve data that are blocked.

  To resolve this issue, you must have Appliance Controller on the secondary MDC or a StorNext gateway client. This allow the Offline File Manager client to be blocked by the nss_cctl.xml file as described above, by adding the secondary MDC or the StorNext gateway client IP address to a control element that has denyRetrieves set to true.

  Note: If you need to use the central control file (/usr/cvfs/config/nss_cctl.xml) to resolve this issue, see the Central Control section above (below the heading On Systems Running StorNext 6.0.x to 6.2.x).

• Error message indicates a possible issue with credentials.

  If you receive an error message about credentials, then verify Windows Credentials contains the correct information. The user information for pooling is the same user information used when you configure your API gateway. This could be a user within a group of Active Directory that was allowed access when you configure pooling.

  Note: The Windows Credentials might be different than the Web Services user credentials.

  Do the following to edit or remove the Windows Credentials.

  1. On the search bar type windows credentials and then click Manage Windows Credentials. The Control Panel\User Accounts\Credential Manager dialog appears.

     

  2. Under Generic Credentials, click apigateway.credentials to expand the entry.

     

  3. Do one of the following:

     • Click Edit. The Edit Generic Credential dialog appears.

       

       1. Enter the appropriate credentials in the User name and password fields.

       2. Click Save.

  • (Optional) Click Remove. If you click Remove, then you must use Offline File Manager to execute a pooling operation and enter the API gateway user credentials at that time.

    

    1. Click Yes to remove the apigateway.credentials entry, or click Cancel to abort the operation and return to the previous dialog.

To quit the Offline File Manager (for Microsoft Windows) application, perform the following procedure.

1. On your desktop, click the Offline File Manager (for Microsoft Windows) icon in the notification tray.

2. Click Quit.

   

To check for an update, or install an update, to the Offline File Manager (for Microsoft Windows) application, perform the following procedure.

1. Start the Offline File Manager (for Microsoft Windows) application.

2. On your desktop, click the Offline File Manager (for Microsoft Windows) icon in the notification tray.

   

3. Click Check for Updates.... The Software Update dialog appears.

   

4. Click Install Update. This begins the application download process. Upon a successful download of the application update, the Software Update dialog displays the following.

   

5. Click Install Update. The Offline File Manager Setup dialog appears and you are prompted to review the Quantum Corporation End User License Agreement ("EULA").

   

6. Click I agree to the license terms and conditions and then click Install.

   Note: The installation package includes the Microsoft Visual C++ 2015 Redistributable (x64) package, the Offline File Manager (for Microsoft Windows) application file (OfflineFileManager.exe), the command line tool (snofflinecmd), and the required dynamic link library (DLL) files to extend Windows Explorer.

7. After a successful installation, the Offline File Manager Setup dialog appears. Click Close.

   

8. Close and reopen the Offline File Manager using the system tray.