LUDOC-276 protocol: Document RPCs for setattr

[doc/protocol.git] / ost_setattr.txt

diff --git a/ost_setattr.txt b/ost_setattr.txt
new file mode 100644 (file)
index 0000000..520df6a
--- /dev/null
+++ b/ost_setattr.txt
@@ -0,0 +1,27 @@
+Command 2: OST_SETATTR
+~~~~~~~~~~~~~~~~~~~~~~
+[[ost-setattr-rpc]]
+
+An RPC that sets resource attributes.
+
+.OST_SETATTR Generic Packet Structure
+image::ost-setattr-generic.png["OST_SETATTR Generic Packet Structure",height=100]
+
+//////////////////////////////////////////////////////////////////////
+The ost-setattr-generic.png diagram resembles this text art:
+
+       OST_SETATTR:
+      --request-----------------
+      | ptlrpc_body | ost_body |
+      --------------------------
+      --reply-------------------
+      | ptlrpc_body | ost_body |
+      --------------------------
+//////////////////////////////////////////////////////////////////////
+
+'ptlrpc_body'::
+RPC descriptor.
+
+'ost_body'::
+Metadata about the resource, as it appears on the OST.
+