The Mac Finder has no concept of offline files. When combined with Quick Look file previews, using the Mac Finder to access Storage Manager content does not offer the best user experience. All content viewed using the Mac Finder is retrieved, which leads to a very slow performance and prevents you from using Storage Manager as a capacity tier behind a smaller primary file system.
Beginning with StorNext 6, Mac Xsan clients have new and better approach.
- On-demand file retrieves can be disabled on a per-client basis; this prevents the Mac Finder from causing inadvertent retrieves during browsing.
- The new Offline File Manager application gives you visibility into the online/offline state of files, and access to services to use menu choices to request that Storage Manager store, retrieve, or truncate content.
After it has been configured correctly, the application functions for both Xsan clients and for NAS access to StorNext.
Python Programming Language Requirements
To use the Offline File Manager application, you must have Python 2.7.5 (or later) installed on your system.
There are 3 aspects to configuring StorNext to use the Offline File Manager, as follows:
- In the StorNext GUI, click the Service menu, and then click Web Services (V2). The Service > Web Services (V2) page appears.
- In the State field, select On.
- In the Protocol field, select HTTPS.
In the Authentication Type field, select User.
Note: This requires that you create a user account with access to web services (General User Functions > Use Web Services); the name and password for this user are used by macOS clients to access the system (on the Tools menu, click User Accounts).
- On the Tools menu, click User Accounts, and then click New... to create a user account with access to web services. See Tools > User Accounts.
(Optional) You might need to change the configuration options for Web Services or for larger configurations. The file
/usr/adic/wsar_agent/config/wsar_agent.cfgcontrols the configuration options. By default, the configuration runs up to four (4) jobs at once. After modifying the configuration options, execute the following command:/usr/adic/wsar_agent/bin/wsar_agent_control restart
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.
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
/usr/cvfs/config/nss_cctl.xmland is documented in the StorNext Man Pages Reference Guide. 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_templateis available. For example,
At the prompt, enter the following command:nss_cctl_template>/usr/cvfs/config/nss_cctl.xml
nss_cctl.xmlscript uses the
snprobecommand 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.
Edit the configuration properties in the
The configuration file contains a
securityControlsection 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
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. For example:
<securityControl fileSystem="managedfs"> <controlEntry> <client> <address value="fruit.company.com"/> <address value="banana.company.com"/> <address value="mdc-a.company.com"/> <address value="mdc-b.company.com"/> </client> <controls> <mountReadOnly value="false"/> <mountDlanClient value="true"/> <mountDlanServer value="true"/> <takeOwnership value="true"/> <exec value="true"/> <suid value="true"/> <snfsAdmin value="true"/> <snfsAdminConnect value="true"/> <denyRetrieves value="false"/> </controls> </controlEntry> </securityControl>
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
denyRetrievescontrol entry, within the
nss_cctl.xmlfile, by setting it to
denyRetrievescontrol prevents a client from triggering on-demand file retrieves. Set this to
trueto 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
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.
The Offline File Manager application for macOS clients 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 [-h] [-u USER] [-p PASSWORD] -s SERVER dirs [dirs ...] Setup remote rest access to filesystem or share positional arguments: dirs directories to setup optional arguments: -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 the following command:
- The server option is mandatory and must specify the web address and protocol of the web services, so it expects a URL (for example,
The user and password fields are optional; if supplied, they must match an account that has been set up with access to web services. If you provide a user name and password, the Mac application uses them to access the services. If they are not provided, you are prompted for login information, which will be stored on your keychain for subsequent reuse.
Note: When you use the service over NAS, the online/offline state of a file is determined by a heuristic. That is, if a file (such as a stub file) contains no blocks present in the file. This means that the use of a stub file may confuse the service as to a file being online or offline and is not recommended.
The Offline File Manager application for macOS clients is supplied as a standard macOS application .pkg file. Follow the procedure below to download the Offline File Manager application installer package from StorNext Connect.
Note: The Offline File Manager application is not distributed through the macOS App Store.
Because you will download the Offline File Manager application installer package from StorNext Connect, you must first register your Quantum appliance on the StorNext Connect website and create a StorNext Connect account. See Pre-Installation in the StorNext Connect Documentation Center.
You will download the Offline File Manager application installer package from the StorNext add ons page on the StorNext Connect website. See Download StorNext Add-ons in the StorNext Connect Documentation Center.
From the StorNext Connect Welcome page, click StorNext add ons. The StorNext add ons page appears.
Click the Offline File Manager button to download the Offline File Manager installer package. You are prompted to save the file to a local destination.
Note: Make note of this destination for the installation process.
Follow the procedure below to install the Offline File Manager application.
To install the Offline File Manager application, double-click the ofm.pkg file. The Welcome to the Offline File Manager Installer dialog appears.
Note: You are prompted for an administrative account during the install process.
Click Continue. The Software License Agreement dialog appears.
Click Continue. Your are prompted to review the software license agreement.
Click Agree. The Select a Destination dialog appears.
Select the disk where you want to install the Offline File Manager software, and then click Continue. The Installation Type dialog appears.
Click Install to perform a standard installation of the Offline File Manager software. Alternatively, you can change the installation location by clicking Change Install Location..., or customize the installation by clicking Customize. You are prompted to log in.
In the log in dialog, input your administrative credentials to install the software, and then click Install Software. After a successful installation, the Summary dialog appears.
- Click Close.
Follow the procedure below to configure the Offline File Manager application.
Navigate to Applications.
- Right-click Offline File Manager.
- Navigate to System Preferences to configure the following preferences:
Users & Groups
- Click Extensions. After it has been installed, the Offline File Manager application is configured as a Finder extension.
- Click Finder.
Enable the offline_sync extension.
Note: For each user that is using the Offline File Manager application, enable the Finder extension, or the Offline Actions menu is not available for that user.
- The application also makes use of event notification. Navigate to System Preferences to configure the Notifications preferences.
- Click Offline File Manager.
Configure the available notifications and alert styles.
- The Offline File Manager provides services that run between the Finder and StorNext Web services. The services do not run automatically; however, you can configure the services as a login item under Login Items in the user's account preferences. Navigate to System Preferences to configure the Users & Groups preferences.
- Click the account to configure.
- Click Login Items.
Verify the Offline File Manager appears as an item that will open automatically when you log in.
Note: If you want to hide the Offline File Manager application when you log in, select the checkbox in the Hide column next to the application.
When browsing content, either using the finder or the standard open file dialog boxes in an application, the finder plug-in is activated for any StorNext content that has the JSON configuration file in its root, and for NAS content that has the configuration file in the root directory of the system.
macOS only supports a single finder extension active on a directory at once. If you have another extension installed and managing a directory, Quantum recommends you disable it, because only one of the extensions is used. Apple does not provide a mechanism to select one over the other. For managed content, the status of files is presented by an overlay icon (for example, a green check mark or a red x) in the window:
- A green check mark denotes a file that has an online copy and secondary copies.
- A red x denotes a file does not contain an online copy.
- Files that do not have a secondary copy have no overlay icon. The preview icon of a file may still be presented; however, this is not retrieved from the file content when the file is offline. It is retrieved from a copy previously cached by Quick Look.
Even with the Offline File Manger installed and running, a truncated file cannot be directly read; it must be retrieved first. To do this, select a file and bring up the context menu for it (right click). The Finder menu includes an offline actions menu, which allows you to truncate, store to secondary, or retrieve content from secondary. The files appear in a working state until the retrieve operation is complete, then the icon overlay changes to represent the current state.
If the file system was configured without placing the web services user name and password into the configuration, the first time one of these items is selected, a pop-up window asks you for the account information. After you enter the account information, the credentials are stored on the Keychain and normally are not requested again.
- On the menu bar, right-click the Offline File Manager icon, and then click Quit.
- In the Extensions panel under System Preferences, deselect (disable) Offline File Manager.
- Navigate to the Application folder.
Click and drag the Offline File Manager application to the Trash. You might be prompted to enter the username and password.
Note: If you do not deselect (disable) the Offline File Manager finder extension in Step 2, you are not able to click and drag the Offline File Manager application to the Trash.
Command line interface tools are available to operate on a set of files, if an application is to be run that uses a lot of files that must be retrieved from secondary first.
The command line interface tools are the Python scripts:
The scripts act upon a list of files on the command line, or using the syntax
@filename, a file that contains a list of files. The list is converted to a rest query and sent to the StorNext MDC. There is also a
snfileinfo command, which provides a text report on the state of a file (see the example below).
For additional information on all the commands listed above, refer to the StorNext Man Pages Reference Guide.
Note: These commands are also available on Linux clients and can be executed by any user who has access to the file system. If the
json configuration does not contain account information, you will be prompted for account information.
Example output of the
> snfileinfo AstroPhoto-Vol3-Issue6.pdf User name: webadmin Password: ------------------------------------------------------------------------------- File Information Report 2017-01-24 12:42:07 Filename: /Volumes/wotan/S3/user/AstroPhoto-Vol3-Issue6.pdf Stored Name: /Volumes/wotan/S3/user/AstroPhoto-Vol3-Issue6.pdf ------------------------------------------------------------------------------- Last Modification: 06-dec-2016 13:14:41 Owner: user Location: ARCHIVE Group: cvfs Existing Copies: 1 Access: 644 Target Copies: 1 Expired Copies: 0 Target Stub: 0 (KB) Existing Stub: 0 (KB) File size: 6,610,881 Store: MINTIME Affinity: n/a Reloc: MINTIME Class: lattus Trunc: IMMEDIATE Alt Store Copy: Disabled Clean DB Info: NO Media: lattus-s3(1) Checksum: N Encryption: N Compression: N Object Ids: Y