LUDOC-276 protocol: Document RPCs for setattr

[doc/protocol.git] / mds_getxattr.txt

diff --git a/mds_getxattr.txt b/mds_getxattr.txt
new file mode 100644 (file)
index 0000000..be43928
--- /dev/null
+++ b/mds_getxattr.txt
@@ -0,0 +1,40 @@
+Command 49: MDS_GETXATTR
+~~~~~~~~~~~~~~~~~~~~~~~~
+[[mds-getxattr-rpc]]
+
+An RPC that provides information about extended attributes for a
+resource.
+
+.MDS_GETXATTR Generic Packet Structure
+image::mds-getxattr-generic.png["MDS_GETXATTR Generic Packet Structure",height=100]
+
+//////////////////////////////////////////////////////////////////////
+The mds-getxattr-generic.png diagram resembles this text art:
+
+       MDS_GETXATTR:
+      --request-----------------------------------------------
+      | ptlrpc_body | mdt_body | lustre_capa | name | eadata |
+      --------------------------------------------------------
+      --reply----------------------------
+      | ptlrpc_body | mdt_body | eadata |
+      -----------------------------------
+//////////////////////////////////////////////////////////////////////
+
+'ptlrpc_body'::
+RPC descriptor.
+
+'mdt_body'::
+Metadata about the resource.
+
+'lustre_capa'::
+So called "capabilities" structure. This is deprecated in recent
+versions of Lustre, and commonly appears in the packet header as a zero
+length buffer.
+
+'name'::
+A text field supplying the name of the desired resource.
+
+'eadata'::
+Information about extended attributes. This buffer is optional and will
+appear as zero length in some packets.
+