.. code:: bash
- $ ceph nfs export create cephfs <fsname> <clusterid> <binding> [--readonly] [--path=/path/in/cephfs]
+ $ ceph nfs export create cephfs <fsname> <clusterid> <pseudo-path> [--readonly] [--path=/path/in/cephfs]
This creates export RADOS objects containing the export block, where
``<clusterid>`` is the NFS Ganesha cluster ID.
-``<binding>`` is the pseudo root path (must be an absolute path and unique).
-It specifies the export position within the NFS v4 Pseudo Filesystem.
+``<pseudo-path>`` is the export position within the NFS v4 Pseudo Filesystem where the export will be available on the server. It must be an absolute path and unique.
``<path>`` is the path within cephfs. Valid path should be given and default
path is '/'. It need not be unique. Subvolume path can be fetched using:
.. code:: bash
- $ ceph nfs export rm <clusterid> <binding>
+ $ ceph nfs export rm <clusterid> <pseudo-path>
This deletes an export in an NFS Ganesha cluster, where:
``<clusterid>`` is the NFS Ganesha cluster ID.
-``<binding>`` is the pseudo root path (must be an absolute path).
+``<pseudo-path>`` is the pseudo root path (must be an absolute path).
List CephFS Exports
===================
.. code:: bash
- $ ceph nfs export get <clusterid> <binding>
+ $ ceph nfs export get <clusterid> <pseudo-path>
-This displays export block for a cluster based on pseudo root name (binding),
+This displays export block for a cluster based on pseudo root name,
where:
``<clusterid>`` is the NFS Ganesha cluster ID.
-``<binding>`` is the pseudo root path (must be an absolute path).
+``<pseudo-path>`` is the pseudo root path (must be an absolute path).
Create or update CephFS Export via JSON specification
self,
fsname: str,
cluster_id: str,
- binding: str,
+ pseudo_path: str,
path: Optional[str] = '/',
readonly: Optional[bool] = False,
addr: Optional[List[str]] = None,
) -> Tuple[int, str, str]:
"""Create a cephfs export"""
return self.export_mgr.create_export(fsal_type='cephfs', fs_name=fsname,
- cluster_id=cluster_id, pseudo_path=binding,
+ cluster_id=cluster_id, pseudo_path=pseudo_path,
read_only=readonly, path=path,
squash=squash, addr=addr)
self,
bucket: str,
cluster_id: str,
- binding: str,
+ pseudo_path: str,
readonly: Optional[bool] = False,
addr: Optional[List[str]] = None,
realm: Optional[str] = None,
"""Create an RGW export"""
return self.export_mgr.create_export(fsal_type='rgw', bucket=bucket,
realm=realm,
- cluster_id=cluster_id, pseudo_path=binding,
+ cluster_id=cluster_id, pseudo_path=pseudo_path,
read_only=readonly, squash='none',
addr=addr)
@CLICommand('nfs export rm', perm='rw')
- def _cmd_nfs_export_rm(self, cluster_id: str, binding: str) -> Tuple[int, str, str]:
+ def _cmd_nfs_export_rm(self, cluster_id: str, pseudo_path: str) -> Tuple[int, str, str]:
"""Remove a cephfs export"""
- return self.export_mgr.delete_export(cluster_id=cluster_id, pseudo_path=binding)
+ return self.export_mgr.delete_export(cluster_id=cluster_id, pseudo_path=pseudo_path)
@CLICommand('nfs export delete', perm='rw')
- def _cmd_nfs_export_delete(self, cluster_id: str, binding: str) -> Tuple[int, str, str]:
+ def _cmd_nfs_export_delete(self, cluster_id: str, pseudo_path: str) -> Tuple[int, str, str]:
"""Delete a cephfs export (DEPRECATED)"""
- return self.export_mgr.delete_export(cluster_id=cluster_id, pseudo_path=binding)
+ return self.export_mgr.delete_export(cluster_id=cluster_id, pseudo_path=pseudo_path)
@CLICommand('nfs export ls', perm='r')
def _cmd_nfs_export_ls(self, cluster_id: str, detailed: bool = False) -> Tuple[int, str, str]:
return self.export_mgr.list_exports(cluster_id=cluster_id, detailed=detailed)
@CLICommand('nfs export get', perm='r')
- def _cmd_nfs_export_get(self, cluster_id: str, binding: str) -> Tuple[int, str, str]:
+ def _cmd_nfs_export_get(self, cluster_id: str, pseudo_path: str) -> Tuple[int, str, str]:
"""Fetch a export of a NFS cluster given the pseudo path/binding"""
- return self.export_mgr.get_export(cluster_id=cluster_id, pseudo_path=binding)
+ return self.export_mgr.get_export(cluster_id=cluster_id, pseudo_path=pseudo_path)
@CLICommand('nfs export apply', perm='rw')
@CLICheckNonemptyFileInput(desc='Export JSON specification')