From: Varsha Rao <varao@redhat.com>
Date: Thu, 14 Jan 2021 21:56:13 +0000 (+0530)
Subject: doc/cephfs/nfs: Add about update export interface
X-Git-Tag: v17.1.0~2662^2~2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=05d1fb0751013a8e0e7bcaa6a717c564f096229c;p=ceph.git

doc/cephfs/nfs: Add about update export interface

Signed-off-by: Varsha Rao <varao@redhat.com>
---

diff --git a/doc/cephfs/fs-nfs-exports.rst b/doc/cephfs/fs-nfs-exports.rst
index 07a8aa0fae86..df2d69bfc351 100644
--- a/doc/cephfs/fs-nfs-exports.rst
+++ b/doc/cephfs/fs-nfs-exports.rst
@@ -214,6 +214,68 @@ where:
 
 ``<binding>`` is the pseudo root path (must be an absolute path).
 
+
+Update CephFS Export
+====================
+
+.. code:: bash
+
+    $ ceph nfs export update -i <json_file>
+
+This updates the cephfs export specified in the json file. Export in json
+format can be fetched with above get command. For example::
+
+   $ ceph nfs export get vstart /cephfs > update_cephfs_export.json
+   $ cat update_cephfs_export.json
+   {
+     "export_id": 1,
+     "path": "/",
+     "cluster_id": "vstart",
+     "pseudo": "/cephfs",
+     "access_type": "RW",
+     "squash": "no_root_squash",
+     "security_label": true,
+     "protocols": [
+       4
+     ],
+     "transports": [
+       "TCP"
+     ],
+     "fsal": {
+       "name": "CEPH",
+       "user_id": "vstart1",
+       "fs_name": "a",
+       "sec_label_xattr": ""
+     },
+     "clients": []
+   }
+   # Here in the fetched export, pseudo and access_type is modified. Then the modified file is passed to update interface
+   $ ceph nfs export update -i update_cephfs_export.json
+   $ cat update_cephfs_export.json
+   {
+     "export_id": 1,
+     "path": "/",
+     "cluster_id": "vstart",
+     "pseudo": "/cephfs_testing",
+     "access_type": "RO",
+     "squash": "no_root_squash",
+     "security_label": true,
+     "protocols": [
+       4
+     ],
+     "transports": [
+       "TCP"
+     ],
+     "fsal": {
+       "name": "CEPH",
+       "user_id": "vstart1",
+       "fs_name": "a",
+       "sec_label_xattr": ""
+     },
+     "clients": []
+   }
+
+
 Configuring NFS Ganesha to export CephFS with vstart
 ====================================================