Search the docs

Referral Shares

A referral share is a type of share that does not serve data itself but redirects clients to another system’s export path. Instead of managing files locally within Hammerspace, the share acts as a pointer to an external NFS export, typically another Hammerspace cluster.

A referral share consists of

  • Referral or target path: The export path of the target share (e.g., /remote/target). Referred to as “referral path” in the CLI output and “target path” in the Management GUI.

  • Referral or target address: One or more IPv4, IPv6, or hostnames where the target share is hosted. It is recommended to use the data cluster IP of the target Hammerspace cluster. Referred to as “referral address” in the CLI and “target address” in the Management GUI.

  • isReferral or referral flag: Marks the share as a referral, letting the system and GUI distinguish it from normal shares. Referred to as “isReferral” in the CLI and “referral” in the Management GUI.

Users can create referral shares through either the Hammerspace GUI, Admin CLI, or the REST API.

This section includes the following subsections: