ia64/xen-unstable

changeset 18662:bf84c03c38ee

docs: Update XenAPI document for pvSCSI

Signed-off-by: Masaki Kanno <kanno.masaki@jp.fujitsu.com>
author Keir Fraser <keir.fraser@citrix.com>
date Mon Oct 20 15:18:09 2008 +0100 (2008-10-20)
parents 6ca065624051
children 2a25fd94c6f2
files docs/xen-api/coversheet.tex docs/xen-api/revision-history.tex docs/xen-api/xenapi-coversheet.tex docs/xen-api/xenapi-datamodel-graph.dot docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/coversheet.tex	Mon Oct 20 15:17:24 2008 +0100
     1.2 +++ b/docs/xen-api/coversheet.tex	Mon Oct 20 15:18:09 2008 +0100
     1.3 @@ -51,6 +51,7 @@ Hollis Blanchard, IBM & Alastair Tse, Xe
     1.4  Mike Day, IBM & Daniel Veillard, Red Hat \\
     1.5  Jim Fehlig, Novell & Tom Wilkie, University of Cambridge \\
     1.6  Jon Harrop, XenSource & Yosuke Iwamatsu, NEC \\
     1.7 +Masaki Kanno, FUJITSU \\
     1.8  \end{tabular}
     1.9  \end{large}
    1.10  
     2.1 --- a/docs/xen-api/revision-history.tex	Mon Oct 20 15:17:24 2008 +0100
     2.2 +++ b/docs/xen-api/revision-history.tex	Mon Oct 20 15:18:09 2008 +0100
     2.3 @@ -56,5 +56,14 @@
     2.4      \end{flushleft}
     2.5     \end{minipage}\\
     2.6    \hline
     2.7 +  1.0.7 & 20th Oct. 08 & M. Kanno &
     2.8 +   \begin{minipage}[t]{7cm}
     2.9 +    \begin{flushleft}
    2.10 +     Added definitions of new classes DSCSI and PSCSI. Updated the table
    2.11 +     and the diagram representing relationships between classes.
    2.12 +     Added host.PSCSIs and VM.DSCSIs fields.
    2.13 +    \end{flushleft}
    2.14 +   \end{minipage}\\
    2.15 +  \hline
    2.16   \end{tabular}
    2.17  \end{center}
     3.1 --- a/docs/xen-api/xenapi-coversheet.tex	Mon Oct 20 15:17:24 2008 +0100
     3.2 +++ b/docs/xen-api/xenapi-coversheet.tex	Mon Oct 20 15:18:09 2008 +0100
     3.3 @@ -17,12 +17,12 @@
     3.4  \newcommand{\coversheetlogo}{xen.eps}
     3.5  
     3.6  %% Document date
     3.7 -\newcommand{\datestring}{24th July 2008}
     3.8 +\newcommand{\datestring}{20th October 2008}
     3.9  
    3.10  \newcommand{\releasestatement}{Stable Release}
    3.11  
    3.12  %% Document revision
    3.13 -\newcommand{\revstring}{API Revision 1.0.6}
    3.14 +\newcommand{\revstring}{API Revision 1.0.7}
    3.15  
    3.16  %% Document authors
    3.17  \newcommand{\docauthors}{
     4.1 --- a/docs/xen-api/xenapi-datamodel-graph.dot	Mon Oct 20 15:17:24 2008 +0100
     4.2 +++ b/docs/xen-api/xenapi-datamodel-graph.dot	Mon Oct 20 15:18:09 2008 +0100
     4.3 @@ -12,9 +12,11 @@
     4.4  digraph "Xen-API Class Diagram" {
     4.5  fontname="Verdana";
     4.6  
     4.7 -node [ shape=box ]; session VM host network VIF PIF SR VDI VBD PBD user XSPolicy ACMPolicy;
     4.8 -node [shape=ellipse]; PIF_metrics VIF_metrics VM_metrics VBD_metrics PBD_metrics VM_guest_metrics host_metrics;
     4.9 -node [shape=box]; DPCI PPCI host_cpu console VTPM
    4.10 +node [ shape=box ]; session VM host network VIF PIF SR VDI VBD PBD user;
    4.11 +node [ shape=box ]; XSPolicy ACMPolicy DPCI PPCI host_cpu console VTPM;
    4.12 +node [ shape=box ]; DSCSI PSCSI;
    4.13 +node [ shape=ellipse ]; VM_metrics VM_guest_metrics host_metrics;
    4.14 +node [ shape=ellipse ]; PIF_metrics VIF_metrics VBD_metrics PBD_metrics;
    4.15  session -> host [ arrowhead="none" ]
    4.16  session -> user [ arrowhead="none" ]
    4.17  VM -> VM_metrics [ arrowhead="none" ]
    4.18 @@ -41,4 +43,7 @@ XSPolicy -> ACMPolicy [ arrowhead="none"
    4.19  DPCI -> VM [ arrowhead="none", arrowtail="crow" ]
    4.20  DPCI -> PPCI [ arrowhead="none" ]
    4.21  PPCI -> host [ arrowhead="none", arrowtail="crow" ]
    4.22 +DSCSI -> VM [ arrowhead="none", arrowtail="crow" ]
    4.23 +DSCSI -> PSCSI [ arrowhead="none" ]
    4.24 +PSCSI -> host [ arrowhead="none", arrowtail="crow" ]
    4.25  }
     5.1 --- a/docs/xen-api/xenapi-datamodel.tex	Mon Oct 20 15:17:24 2008 +0100
     5.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Mon Oct 20 15:18:09 2008 +0100
     5.3 @@ -46,6 +46,8 @@ Name & Description \\
     5.4  {\tt console} & A console \\
     5.5  {\tt DPCI} & A pass-through PCI device \\
     5.6  {\tt PPCI} & A physical PCI device \\
     5.7 +{\tt DSCSI} & A half-virtualized SCSI device \\
     5.8 +{\tt PSCSI} & A physical SCSI device \\
     5.9  {\tt user} & A user of the system \\
    5.10  {\tt debug} & A basic class for testing \\
    5.11  {\tt XSPolicy} & A class for handling Xen Security Policies \\
    5.12 @@ -74,6 +76,8 @@ VTPM.VM & VM.VTPMs & one-to-many\\
    5.13  console.VM & VM.consoles & one-to-many\\
    5.14  DPCI.VM & VM.DPCIs & one-to-many\\
    5.15  PPCI.host & host.PPCIs & one-to-many\\
    5.16 +DSCSI.VM & VM.DSCSIs & one-to-many\\
    5.17 +PSCSI.host & host.PSCSIs & one-to-many\\
    5.18  host.resident\_VMs & VM.resident\_on & many-to-one\\
    5.19  host.host\_CPUs & host\_cpu.host & many-to-one\\
    5.20  \hline
    5.21 @@ -1407,6 +1411,7 @@ Quals & Field & Type & Description \\
    5.22  $\mathit{RO}_\mathit{run}$ &  {\tt crash\_dumps} & (crashdump ref) Set & crash dumps associated with this VM \\
    5.23  $\mathit{RO}_\mathit{run}$ &  {\tt VTPMs} & (VTPM ref) Set & virtual TPMs \\
    5.24  $\mathit{RO}_\mathit{run}$ &  {\tt DPCIs} & (DPCI ref) Set & pass-through PCI devices \\
    5.25 +$\mathit{RO}_\mathit{run}$ &  {\tt DSCSIs} & (DSCSI ref) Set & half-virtualized SCSI devices \\
    5.26  $\mathit{RW}$ &  {\tt PV/bootloader} & string & name of or path to bootloader \\
    5.27  $\mathit{RW}$ &  {\tt PV/kernel} & string & path to the kernel \\
    5.28  $\mathit{RW}$ &  {\tt PV/ramdisk} & string & path to the initrd \\
    5.29 @@ -3450,6 +3455,38 @@ value of the field
    5.30  \vspace{0.3cm}
    5.31  \vspace{0.3cm}
    5.32  \vspace{0.3cm}
    5.33 +\subsubsection{RPC name:~get\_DSCSIs}
    5.34 +
    5.35 +{\bf Overview:} 
    5.36 +Get the DSCSIs field of the given VM.
    5.37 +
    5.38 + \noindent {\bf Signature:} 
    5.39 +\begin{verbatim} ((DSCSI ref) Set) get_DSCSIs (session_id s, VM ref self)\end{verbatim}
    5.40 +
    5.41 +
    5.42 +\noindent{\bf Arguments:}
    5.43 +
    5.44 +
    5.45 +\vspace{0.3cm}
    5.46 +\begin{tabular}{|c|c|p{7cm}|}
    5.47 + \hline
    5.48 +{\bf type} & {\bf name} & {\bf description} \\ \hline
    5.49 +{\tt VM ref } & self & reference to the object \\ \hline 
    5.50 +
    5.51 +\end{tabular}
    5.52 +
    5.53 +\vspace{0.3cm}
    5.54 +
    5.55 + \noindent {\bf Return Type:} 
    5.56 +{\tt 
    5.57 +(DSCSI ref) Set
    5.58 +}
    5.59 +
    5.60 +
    5.61 +value of the field
    5.62 +\vspace{0.3cm}
    5.63 +\vspace{0.3cm}
    5.64 +\vspace{0.3cm}
    5.65  \subsubsection{RPC name:~get\_PV\_bootloader}
    5.66  
    5.67  {\bf Overview:} 
    5.68 @@ -5518,6 +5555,7 @@ Quals & Field & Type & Description \\
    5.69  $\mathit{RW}$ &  {\tt crash\_dump\_sr} & SR ref & The SR in which VDIs for crash dumps are created \\
    5.70  $\mathit{RO}_\mathit{run}$ &  {\tt PBDs} & (PBD ref) Set & physical blockdevices \\
    5.71  $\mathit{RO}_\mathit{run}$ &  {\tt PPCIs} & (PPCI ref) Set & physical PCI devices \\
    5.72 +$\mathit{RO}_\mathit{run}$ &  {\tt PSCSIs} & (PSCSI ref) Set & physical SCSI devices \\
    5.73  $\mathit{RO}_\mathit{run}$ &  {\tt host\_CPUs} & (host\_cpu ref) Set & The physical CPUs on this host \\
    5.74  $\mathit{RO}_\mathit{run}$ &  {\tt metrics} & host\_metrics ref & metrics associated with this host \\
    5.75  \hline
    5.76 @@ -6844,6 +6882,38 @@ value of the field
    5.77  \vspace{0.3cm}
    5.78  \vspace{0.3cm}
    5.79  \vspace{0.3cm}
    5.80 +\subsubsection{RPC name:~get\_PSCSIs}
    5.81 +
    5.82 +{\bf Overview:} 
    5.83 +Get the PSCSIs field of the given host.
    5.84 +
    5.85 + \noindent {\bf Signature:} 
    5.86 +\begin{verbatim} ((PSCSI ref) Set) get_PSCSIs (session_id s, host ref self)\end{verbatim}
    5.87 +
    5.88 +
    5.89 +\noindent{\bf Arguments:}
    5.90 +
    5.91 +
    5.92 +\vspace{0.3cm}
    5.93 +\begin{tabular}{|c|c|p{7cm}|}
    5.94 + \hline
    5.95 +{\bf type} & {\bf name} & {\bf description} \\ \hline
    5.96 +{\tt host ref } & self & reference to the object \\ \hline 
    5.97 +
    5.98 +\end{tabular}
    5.99 +
   5.100 +\vspace{0.3cm}
   5.101 +
   5.102 + \noindent {\bf Return Type:} 
   5.103 +{\tt 
   5.104 +(PSCSI ref) Set
   5.105 +}
   5.106 +
   5.107 +
   5.108 +value of the field
   5.109 +\vspace{0.3cm}
   5.110 +\vspace{0.3cm}
   5.111 +\vspace{0.3cm}
   5.112  \subsubsection{RPC name:~get\_host\_CPUs}
   5.113  
   5.114  {\bf Overview:} 
   5.115 @@ -15723,6 +15793,1096 @@ all fields from the object
   5.116  
   5.117  \vspace{1cm}
   5.118  \newpage
   5.119 +\section{Class: DSCSI}
   5.120 +\subsection{Fields for class: DSCSI}
   5.121 +\begin{longtable}{|lllp{0.38\textwidth}|}
   5.122 +\hline
   5.123 +\multicolumn{1}{|l}{Name} & \multicolumn{3}{l|}{\bf DSCSI} \\
   5.124 +\multicolumn{1}{|l}{Description} & \multicolumn{3}{l|}{\parbox{11cm}{\em A
   5.125 +half-virtualized SCSI device.}} \\
   5.126 +\hline
   5.127 +Quals & Field & Type & Description \\
   5.128 +\hline
   5.129 +$\mathit{RO}_\mathit{run}$ &  {\tt uuid} & string & unique identifier/object reference \\
   5.130 +$\mathit{RO}_\mathit{inst}$ &  {\tt VM} & VM ref & the virtual machine \\
   5.131 +$\mathit{RO}_\mathit{inst}$ &  {\tt PSCSI} & PSCSI ref & the physical SCSI device \\
   5.132 +$\mathit{RO}_\mathit{run}$ &  {\tt virtual\_host} & int & the virtual host number \\
   5.133 +$\mathit{RO}_\mathit{run}$ &  {\tt virtual\_channel} & int & the virtual channel number \\
   5.134 +$\mathit{RO}_\mathit{run}$ &  {\tt virtual\_target} & int & the virtual target number \\
   5.135 +$\mathit{RO}_\mathit{run}$ &  {\tt virtual\_lun} & int & the virtual logical unit number \\
   5.136 +$\mathit{RO}_\mathit{inst}$ &  {\tt virtual\_HCTL} & string & the virtual HCTL \\
   5.137 +$\mathit{RO}_\mathit{run}$ &  {\tt runtime\_properties} & (string $\rightarrow$ string) Map & Device runtime properties \\
   5.138 +\hline
   5.139 +\end{longtable}
   5.140 +\subsection{RPCs associated with class: DSCSI}
   5.141 +\subsubsection{RPC name:~get\_all}
   5.142 +
   5.143 +{\bf Overview:} 
   5.144 +Return a list of all the DSCSIs known to the system.
   5.145 +
   5.146 + \noindent {\bf Signature:} 
   5.147 +\begin{verbatim} ((DSCSI ref) Set) get_all (session_id s)\end{verbatim}
   5.148 +
   5.149 +
   5.150 +\vspace{0.3cm}
   5.151 +
   5.152 + \noindent {\bf Return Type:} 
   5.153 +{\tt 
   5.154 +(DSCSI ref) Set
   5.155 +}
   5.156 +
   5.157 +
   5.158 +references to all objects
   5.159 +\vspace{0.3cm}
   5.160 +\vspace{0.3cm}
   5.161 +\vspace{0.3cm}
   5.162 +\subsubsection{RPC name:~get\_uuid}
   5.163 +
   5.164 +{\bf Overview:} 
   5.165 +Get the uuid field of the given DSCSI.
   5.166 +
   5.167 + \noindent {\bf Signature:} 
   5.168 +\begin{verbatim} string get_uuid (session_id s, DSCSI ref self)\end{verbatim}
   5.169 +
   5.170 +
   5.171 +\noindent{\bf Arguments:}
   5.172 +
   5.173 +
   5.174 +\vspace{0.3cm}
   5.175 +\begin{tabular}{|c|c|p{7cm}|}
   5.176 + \hline
   5.177 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.178 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.179 +
   5.180 +\end{tabular}
   5.181 +
   5.182 +\vspace{0.3cm}
   5.183 +
   5.184 + \noindent {\bf Return Type:} 
   5.185 +{\tt
   5.186 +string
   5.187 +}
   5.188 +
   5.189 +
   5.190 +value of the field
   5.191 +\vspace{0.3cm}
   5.192 +\vspace{0.3cm}
   5.193 +\vspace{0.3cm}
   5.194 +\subsubsection{RPC name:~get\_VM}
   5.195 +
   5.196 +{\bf Overview:} 
   5.197 +Get the VM field of the given DSCSI.
   5.198 +
   5.199 + \noindent {\bf Signature:} 
   5.200 +\begin{verbatim} (VM ref) get_VM (session_id s, DSCSI ref self)\end{verbatim}
   5.201 +
   5.202 +
   5.203 +\noindent{\bf Arguments:}
   5.204 +
   5.205 +
   5.206 +\vspace{0.3cm}
   5.207 +\begin{tabular}{|c|c|p{7cm}|}
   5.208 + \hline
   5.209 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.210 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.211 +
   5.212 +\end{tabular}
   5.213 +
   5.214 +\vspace{0.3cm}
   5.215 +
   5.216 + \noindent {\bf Return Type:} 
   5.217 +{\tt 
   5.218 +VM ref
   5.219 +}
   5.220 +
   5.221 +
   5.222 +value of the field
   5.223 +\vspace{0.3cm}
   5.224 +\vspace{0.3cm}
   5.225 +\vspace{0.3cm}
   5.226 +\subsubsection{RPC name:~get\_PSCSI}
   5.227 +
   5.228 +{\bf Overview:} 
   5.229 +Get the PSCSI field of the given DSCSI.
   5.230 +
   5.231 + \noindent {\bf Signature:} 
   5.232 +\begin{verbatim} (PSCSI ref) get_PSCSI (session_id s, DSCSI ref self)\end{verbatim}
   5.233 +
   5.234 +
   5.235 +\noindent{\bf Arguments:}
   5.236 +
   5.237 +
   5.238 +\vspace{0.3cm}
   5.239 +\begin{tabular}{|c|c|p{7cm}|}
   5.240 + \hline
   5.241 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.242 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.243 +
   5.244 +\end{tabular}
   5.245 +
   5.246 +\vspace{0.3cm}
   5.247 +
   5.248 + \noindent {\bf Return Type:} 
   5.249 +{\tt 
   5.250 +PSCSI ref
   5.251 +}
   5.252 +
   5.253 +
   5.254 +value of the field
   5.255 +\vspace{0.3cm}
   5.256 +\vspace{0.3cm}
   5.257 +\vspace{0.3cm}
   5.258 +\subsubsection{RPC name:~get\_virtual\_host}
   5.259 +
   5.260 +{\bf Overview:} 
   5.261 +Get the virtual\_host field of the given DSCSI.
   5.262 +
   5.263 + \noindent {\bf Signature:} 
   5.264 +\begin{verbatim} int get_virtual_host (session_id s, DSCSI ref self)\end{verbatim}
   5.265 +
   5.266 +
   5.267 +\noindent{\bf Arguments:}
   5.268 +
   5.269 +
   5.270 +\vspace{0.3cm}
   5.271 +\begin{tabular}{|c|c|p{7cm}|}
   5.272 + \hline
   5.273 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.274 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.275 +
   5.276 +\end{tabular}
   5.277 +
   5.278 +\vspace{0.3cm}
   5.279 +
   5.280 + \noindent {\bf Return Type:} 
   5.281 +{\tt 
   5.282 +int
   5.283 +}
   5.284 +
   5.285 +
   5.286 +value of the field
   5.287 +\vspace{0.3cm}
   5.288 +\vspace{0.3cm}
   5.289 +\vspace{0.3cm}
   5.290 +\subsubsection{RPC name:~get\_virtual\_channel}
   5.291 +
   5.292 +{\bf Overview:} 
   5.293 +Get the virtual\_channel field of the given DSCSI.
   5.294 +
   5.295 + \noindent {\bf Signature:} 
   5.296 +\begin{verbatim} int get_virtual_channel (session_id s, DSCSI ref self)\end{verbatim}
   5.297 +
   5.298 +
   5.299 +\noindent{\bf Arguments:}
   5.300 +
   5.301 +
   5.302 +\vspace{0.3cm}
   5.303 +\begin{tabular}{|c|c|p{7cm}|}
   5.304 + \hline
   5.305 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.306 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.307 +
   5.308 +\end{tabular}
   5.309 +
   5.310 +\vspace{0.3cm}
   5.311 +
   5.312 + \noindent {\bf Return Type:} 
   5.313 +{\tt 
   5.314 +int
   5.315 +}
   5.316 +
   5.317 +
   5.318 +value of the field
   5.319 +\vspace{0.3cm}
   5.320 +\vspace{0.3cm}
   5.321 +\vspace{0.3cm}
   5.322 +\subsubsection{RPC name:~get\_virtual\_target}
   5.323 +
   5.324 +{\bf Overview:} 
   5.325 +Get the virtual\_target field of the given DSCSI.
   5.326 +
   5.327 + \noindent {\bf Signature:} 
   5.328 +\begin{verbatim} int get_virtual_target (session_id s, DSCSI ref self)\end{verbatim}
   5.329 +
   5.330 +
   5.331 +\noindent{\bf Arguments:}
   5.332 +
   5.333 +
   5.334 +\vspace{0.3cm}
   5.335 +\begin{tabular}{|c|c|p{7cm}|}
   5.336 + \hline
   5.337 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.338 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.339 +
   5.340 +\end{tabular}
   5.341 +
   5.342 +\vspace{0.3cm}
   5.343 +
   5.344 + \noindent {\bf Return Type:} 
   5.345 +{\tt 
   5.346 +int
   5.347 +}
   5.348 +
   5.349 +
   5.350 +value of the field
   5.351 +\vspace{0.3cm}
   5.352 +\vspace{0.3cm}
   5.353 +\vspace{0.3cm}
   5.354 +\subsubsection{RPC name:~get\_virtual\_lun}
   5.355 +
   5.356 +{\bf Overview:} 
   5.357 +Get the virtual\_lun field of the given DSCSI.
   5.358 +
   5.359 + \noindent {\bf Signature:} 
   5.360 +\begin{verbatim} int get_virtual_lun (session_id s, DSCSI ref self)\end{verbatim}
   5.361 +
   5.362 +
   5.363 +\noindent{\bf Arguments:}
   5.364 +
   5.365 +
   5.366 +\vspace{0.3cm}
   5.367 +\begin{tabular}{|c|c|p{7cm}|}
   5.368 + \hline
   5.369 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.370 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.371 +
   5.372 +\end{tabular}
   5.373 +
   5.374 +\vspace{0.3cm}
   5.375 +
   5.376 + \noindent {\bf Return Type:} 
   5.377 +{\tt 
   5.378 +int
   5.379 +}
   5.380 +
   5.381 +
   5.382 +value of the field
   5.383 +\vspace{0.3cm}
   5.384 +\vspace{0.3cm}
   5.385 +\vspace{0.3cm}
   5.386 +\subsubsection{RPC name:~get\_virtual\_HCTL}
   5.387 +
   5.388 +{\bf Overview:} 
   5.389 +Get the virtual\_HCTL field of the given DSCSI.
   5.390 +
   5.391 + \noindent {\bf Signature:} 
   5.392 +\begin{verbatim} string get_virtual_HCTL (session_id s, DSCSI ref self)\end{verbatim}
   5.393 +
   5.394 +
   5.395 +\noindent{\bf Arguments:}
   5.396 +
   5.397 +
   5.398 +\vspace{0.3cm}
   5.399 +\begin{tabular}{|c|c|p{7cm}|}
   5.400 + \hline
   5.401 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.402 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.403 +
   5.404 +\end{tabular}
   5.405 +
   5.406 +\vspace{0.3cm}
   5.407 +
   5.408 + \noindent {\bf Return Type:} 
   5.409 +{\tt 
   5.410 +string
   5.411 +}
   5.412 +
   5.413 +
   5.414 +value of the field
   5.415 +\vspace{0.3cm}
   5.416 +\vspace{0.3cm}
   5.417 +\vspace{0.3cm}
   5.418 +\subsubsection{RPC name:~get\_runtime\_properties}
   5.419 +
   5.420 +{\bf Overview:} 
   5.421 +Get the runtime\_properties field of the given DSCSI.
   5.422 +
   5.423 + \noindent {\bf Signature:} 
   5.424 +\begin{verbatim} ((string -> string) Map) get_runtime_properties (session_id s, DSCSI ref self)\end{verbatim}
   5.425 +
   5.426 +
   5.427 +\noindent{\bf Arguments:}
   5.428 +
   5.429 + 
   5.430 +\vspace{0.3cm}
   5.431 +\begin{tabular}{|c|c|p{7cm}|}
   5.432 + \hline
   5.433 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.434 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.435 +
   5.436 +\end{tabular}
   5.437 +
   5.438 +\vspace{0.3cm}
   5.439 +
   5.440 + \noindent {\bf Return Type:} 
   5.441 +{\tt 
   5.442 +(string $\rightarrow$ string) Map
   5.443 +}
   5.444 +
   5.445 +
   5.446 +value of the field
   5.447 +\vspace{0.3cm}
   5.448 +\vspace{0.3cm}
   5.449 +\vspace{0.3cm}
   5.450 +\subsubsection{RPC name:~create}
   5.451 +
   5.452 +{\bf Overview:} 
   5.453 +Create a new DSCSI instance, and return its handle.
   5.454 +
   5.455 + \noindent {\bf Signature:} 
   5.456 +\begin{verbatim} (DSCSI ref) create (session_id s, DSCSI record args)\end{verbatim}
   5.457 +
   5.458 +
   5.459 +\noindent{\bf Arguments:}
   5.460 +
   5.461 +
   5.462 +\vspace{0.3cm}
   5.463 +\begin{tabular}{|c|c|p{7cm}|}
   5.464 + \hline
   5.465 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.466 +{\tt DSCSI record } & args & All constructor arguments \\ \hline 
   5.467 +
   5.468 +\end{tabular}
   5.469 +
   5.470 +\vspace{0.3cm}
   5.471 +
   5.472 + \noindent {\bf Return Type:} 
   5.473 +{\tt 
   5.474 +DSCSI ref
   5.475 +}
   5.476 +
   5.477 +
   5.478 +reference to the newly created object
   5.479 +\vspace{0.3cm}
   5.480 +\vspace{0.3cm}
   5.481 +\vspace{0.3cm}
   5.482 +\subsubsection{RPC name:~destroy}
   5.483 +
   5.484 +{\bf Overview:} 
   5.485 +Destroy the specified DSCSI instance.
   5.486 +
   5.487 + \noindent {\bf Signature:} 
   5.488 +\begin{verbatim} void destroy (session_id s, DSCSI ref self)\end{verbatim}
   5.489 +
   5.490 +
   5.491 +\noindent{\bf Arguments:}
   5.492 +
   5.493 +
   5.494 +\vspace{0.3cm}
   5.495 +\begin{tabular}{|c|c|p{7cm}|}
   5.496 + \hline
   5.497 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.498 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.499 +
   5.500 +\end{tabular}
   5.501 +
   5.502 +\vspace{0.3cm}
   5.503 +
   5.504 + \noindent {\bf Return Type:} 
   5.505 +{\tt 
   5.506 +void
   5.507 +}
   5.508 +
   5.509 +
   5.510 +\vspace{0.3cm}
   5.511 +\vspace{0.3cm}
   5.512 +\vspace{0.3cm}
   5.513 +\subsubsection{RPC name:~get\_by\_uuid}
   5.514 +
   5.515 +{\bf Overview:} 
   5.516 +Get a reference to the DSCSI instance with the specified UUID.
   5.517 +
   5.518 + \noindent {\bf Signature:} 
   5.519 +\begin{verbatim} (DSCSI ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   5.520 +
   5.521 +
   5.522 +\noindent{\bf Arguments:}
   5.523 +
   5.524 +
   5.525 +\vspace{0.3cm}
   5.526 +\begin{tabular}{|c|c|p{7cm}|}
   5.527 + \hline
   5.528 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.529 +{\tt string } & uuid & UUID of object to return \\ \hline 
   5.530 +
   5.531 +\end{tabular}
   5.532 +
   5.533 +\vspace{0.3cm}
   5.534 +
   5.535 + \noindent {\bf Return Type:} 
   5.536 +{\tt 
   5.537 +DSCSI ref
   5.538 +}
   5.539 +
   5.540 +
   5.541 +reference to the object
   5.542 +\vspace{0.3cm}
   5.543 +\vspace{0.3cm}
   5.544 +\vspace{0.3cm}
   5.545 +\subsubsection{RPC name:~get\_record}
   5.546 +
   5.547 +{\bf Overview:} 
   5.548 +Get a record containing the current state of the given DSCSI.
   5.549 +
   5.550 + \noindent {\bf Signature:} 
   5.551 +\begin{verbatim} (DSCSI record) get_record (session_id s, DSCSI ref self)\end{verbatim}
   5.552 +
   5.553 +
   5.554 +\noindent{\bf Arguments:}
   5.555 +
   5.556 +
   5.557 +\vspace{0.3cm}
   5.558 +\begin{tabular}{|c|c|p{7cm}|}
   5.559 + \hline
   5.560 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.561 +{\tt DSCSI ref } & self & reference to the object \\ \hline 
   5.562 +
   5.563 +\end{tabular}
   5.564 +
   5.565 +\vspace{0.3cm}
   5.566 +
   5.567 + \noindent {\bf Return Type:} 
   5.568 +{\tt 
   5.569 +DSCSI record
   5.570 +}
   5.571 +
   5.572 +
   5.573 +all fields from the object
   5.574 +\vspace{0.3cm}
   5.575 +\vspace{0.3cm}
   5.576 +\vspace{0.3cm}
   5.577 +
   5.578 +\vspace{1cm}
   5.579 +\newpage
   5.580 +\section{Class: PSCSI}
   5.581 +\subsection{Fields for class: PSCSI}
   5.582 +\begin{longtable}{|lllp{0.38\textwidth}|}
   5.583 +\hline
   5.584 +\multicolumn{1}{|l}{Name} & \multicolumn{3}{l|}{\bf PSCSI} \\
   5.585 +\multicolumn{1}{|l}{Description} & \multicolumn{3}{l|}{\parbox{11cm}{\em A
   5.586 +physical SCSI device.}} \\
   5.587 +\hline
   5.588 +Quals & Field & Type & Description \\
   5.589 +\hline
   5.590 +$\mathit{RO}_\mathit{run}$ &  {\tt uuid} & string & unique identifier/object reference \\
   5.591 +$\mathit{RO}_\mathit{run}$ &  {\tt host} & host ref &  the physical machine to which this PSCSI is connected \\
   5.592 +$\mathit{RO}_\mathit{run}$ &  {\tt physical\_host} & int & the physical host number \\
   5.593 +$\mathit{RO}_\mathit{run}$ &  {\tt physical\_channel} & int & the physical channel number \\
   5.594 +$\mathit{RO}_\mathit{run}$ &  {\tt physical\_target} & int & the physical target number \\
   5.595 +$\mathit{RO}_\mathit{run}$ &  {\tt physical\_lun} & int & the physical logical unit number \\
   5.596 +$\mathit{RO}_\mathit{run}$ &  {\tt physical\_HCTL} & string & the physical HCTL \\
   5.597 +$\mathit{RO}_\mathit{run}$ &  {\tt vendor\_name} & string & the vendor name \\
   5.598 +$\mathit{RO}_\mathit{run}$ &  {\tt model} & string & the model \\
   5.599 +$\mathit{RO}_\mathit{run}$ &  {\tt type\_id} & int & the SCSI type ID \\
   5.600 +$\mathit{RO}_\mathit{run}$ &  {\tt type} & string &  the SCSI type \\
   5.601 +$\mathit{RO}_\mathit{run}$ &  {\tt dev\_name} & string & the SCSI device name (e.g. sda or st0) \\
   5.602 +$\mathit{RO}_\mathit{run}$ &  {\tt sg\_name} & string & the SCSI generic device name (e.g. sg0) \\
   5.603 +$\mathit{RO}_\mathit{run}$ &  {\tt revision} & string & the revision \\
   5.604 +$\mathit{RO}_\mathit{run}$ &  {\tt scsi\_id} & string & the SCSI ID \\
   5.605 +$\mathit{RO}_\mathit{run}$ &  {\tt scsi\_level} & int & the SCSI level \\
   5.606 +\hline
   5.607 +\end{longtable}
   5.608 +\subsection{RPCs associated with class: PSCSI}
   5.609 +\subsubsection{RPC name:~get\_all}
   5.610 +
   5.611 +{\bf Overview:} 
   5.612 +Return a list of all the PSCSIs known to the system.
   5.613 +
   5.614 + \noindent {\bf Signature:} 
   5.615 +\begin{verbatim} ((PSCSI ref) Set) get_all (session_id s)\end{verbatim}
   5.616 +
   5.617 +
   5.618 +\vspace{0.3cm}
   5.619 +
   5.620 + \noindent {\bf Return Type:} 
   5.621 +{\tt 
   5.622 +(PSCSI ref) Set
   5.623 +}
   5.624 +
   5.625 +
   5.626 +references to all objects
   5.627 +\vspace{0.3cm}
   5.628 +\vspace{0.3cm}
   5.629 +\vspace{0.3cm}
   5.630 +\subsubsection{RPC name:~get\_uuid}
   5.631 +
   5.632 +{\bf Overview:} 
   5.633 +Get the uuid field of the given PSCSI.
   5.634 +
   5.635 + \noindent {\bf Signature:} 
   5.636 +\begin{verbatim} string get_uuid (session_id s, PSCSI ref self)\end{verbatim}
   5.637 +
   5.638 +
   5.639 +\noindent{\bf Arguments:}
   5.640 +
   5.641 +
   5.642 +\vspace{0.3cm}
   5.643 +\begin{tabular}{|c|c|p{7cm}|}
   5.644 + \hline
   5.645 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.646 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.647 +
   5.648 +\end{tabular}
   5.649 +
   5.650 +\vspace{0.3cm}
   5.651 +
   5.652 + \noindent {\bf Return Type:} 
   5.653 +{\tt 
   5.654 +string
   5.655 +}
   5.656 +
   5.657 +
   5.658 +value of the field
   5.659 +\vspace{0.3cm}
   5.660 +\vspace{0.3cm}
   5.661 +\vspace{0.3cm}
   5.662 +\subsubsection{RPC name:~get\_host}
   5.663 +
   5.664 +{\bf Overview:} 
   5.665 +Get the host field of the given PSCSI.
   5.666 +
   5.667 + \noindent {\bf Signature:} 
   5.668 +\begin{verbatim} (host ref) get_host (session_id s, PSCSI ref self)\end{verbatim}
   5.669 +
   5.670 +
   5.671 +\noindent{\bf Arguments:}
   5.672 +
   5.673 +
   5.674 +\vspace{0.3cm}
   5.675 +\begin{tabular}{|c|c|p{7cm}|}
   5.676 + \hline
   5.677 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.678 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.679 +
   5.680 +\end{tabular}
   5.681 +
   5.682 +\vspace{0.3cm}
   5.683 +
   5.684 + \noindent {\bf Return Type:} 
   5.685 +{\tt 
   5.686 +host ref
   5.687 +}
   5.688 +
   5.689 +
   5.690 +value of the field
   5.691 +\vspace{0.3cm}
   5.692 +\vspace{0.3cm}
   5.693 +\vspace{0.3cm}
   5.694 +\subsubsection{RPC name:~get\_physical\_host}
   5.695 +
   5.696 +{\bf Overview:} 
   5.697 +Get the physical\_host field of the given PSCSI.
   5.698 +
   5.699 + \noindent {\bf Signature:} 
   5.700 +\begin{verbatim} int get_physical_host (session_id s, PSCSI ref self)\end{verbatim}
   5.701 +
   5.702 +
   5.703 +\noindent{\bf Arguments:}
   5.704 +
   5.705 +
   5.706 +\vspace{0.3cm}
   5.707 +\begin{tabular}{|c|c|p{7cm}|}
   5.708 + \hline
   5.709 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.710 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.711 +
   5.712 +\end{tabular}
   5.713 +
   5.714 +\vspace{0.3cm}
   5.715 +
   5.716 + \noindent {\bf Return Type:} 
   5.717 +{\tt 
   5.718 +int
   5.719 +}
   5.720 +
   5.721 +
   5.722 +value of the field
   5.723 +\vspace{0.3cm}
   5.724 +\vspace{0.3cm}
   5.725 +\vspace{0.3cm}
   5.726 +\subsubsection{RPC name:~get\_physical\_channel}
   5.727 +
   5.728 +{\bf Overview:} 
   5.729 +Get the physical\_channel field of the given PSCSI.
   5.730 +
   5.731 + \noindent {\bf Signature:} 
   5.732 +\begin{verbatim} int get_physical_channel (session_id s, PSCSI ref self)\end{verbatim}
   5.733 +
   5.734 +
   5.735 +\noindent{\bf Arguments:}
   5.736 +
   5.737 +
   5.738 +\vspace{0.3cm}
   5.739 +\begin{tabular}{|c|c|p{7cm}|}
   5.740 + \hline
   5.741 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.742 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.743 +
   5.744 +\end{tabular}
   5.745 +
   5.746 +\vspace{0.3cm}
   5.747 +
   5.748 + \noindent {\bf Return Type:} 
   5.749 +{\tt 
   5.750 +int
   5.751 +}
   5.752 +
   5.753 +
   5.754 +value of the field
   5.755 +\vspace{0.3cm}
   5.756 +\vspace{0.3cm}
   5.757 +\vspace{0.3cm}
   5.758 +\subsubsection{RPC name:~get\_physical\_target}
   5.759 +
   5.760 +{\bf Overview:} 
   5.761 +Get the physical\_target field of the given PSCSI.
   5.762 +
   5.763 + \noindent {\bf Signature:} 
   5.764 +\begin{verbatim} int get_physical_target (session_id s, PSCSI ref self)\end{verbatim}
   5.765 +
   5.766 +
   5.767 +\noindent{\bf Arguments:}
   5.768 +
   5.769 +
   5.770 +\vspace{0.3cm}
   5.771 +\begin{tabular}{|c|c|p{7cm}|}
   5.772 + \hline
   5.773 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.774 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.775 +
   5.776 +\end{tabular}
   5.777 +
   5.778 +\vspace{0.3cm}
   5.779 +
   5.780 + \noindent {\bf Return Type:} 
   5.781 +{\tt 
   5.782 +int
   5.783 +}
   5.784 +
   5.785 +
   5.786 +value of the field
   5.787 +\vspace{0.3cm}
   5.788 +\vspace{0.3cm}
   5.789 +\vspace{0.3cm}
   5.790 +\subsubsection{RPC name:~get\_physical\_lun}
   5.791 +
   5.792 +{\bf Overview:} 
   5.793 +Get the physical\_lun field of the given PSCSI.
   5.794 +
   5.795 + \noindent {\bf Signature:} 
   5.796 +\begin{verbatim} int get_physical_lun (session_id s, PSCSI ref self)\end{verbatim}
   5.797 +
   5.798 +
   5.799 +\noindent{\bf Arguments:}
   5.800 +
   5.801 +
   5.802 +\vspace{0.3cm}
   5.803 +\begin{tabular}{|c|c|p{7cm}|}
   5.804 + \hline
   5.805 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.806 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.807 +
   5.808 +\end{tabular}
   5.809 +
   5.810 +\vspace{0.3cm}
   5.811 +
   5.812 + \noindent {\bf Return Type:} 
   5.813 +{\tt 
   5.814 +int
   5.815 +}
   5.816 +
   5.817 +
   5.818 +value of the field
   5.819 +\vspace{0.3cm}
   5.820 +\vspace{0.3cm}
   5.821 +\vspace{0.3cm}
   5.822 +\subsubsection{RPC name:~get\_physical\_HCTL}
   5.823 +
   5.824 +{\bf Overview:} 
   5.825 +Get the physical\_HCTL field of the given PSCSI.
   5.826 +
   5.827 + \noindent {\bf Signature:} 
   5.828 +\begin{verbatim} string get_physical_HCTL (session_id s, PSCSI ref self)\end{verbatim}
   5.829 +
   5.830 +
   5.831 +\noindent{\bf Arguments:}
   5.832 +
   5.833 +
   5.834 +\vspace{0.3cm}
   5.835 +\begin{tabular}{|c|c|p{7cm}|}
   5.836 + \hline
   5.837 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.838 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.839 +
   5.840 +\end{tabular}
   5.841 +
   5.842 +\vspace{0.3cm}
   5.843 +
   5.844 + \noindent {\bf Return Type:} 
   5.845 +{\tt 
   5.846 +string
   5.847 +}
   5.848 +
   5.849 +
   5.850 +value of the field
   5.851 +\vspace{0.3cm}
   5.852 +\vspace{0.3cm}
   5.853 +\vspace{0.3cm}
   5.854 +\subsubsection{RPC name:~get\_vendor\_name}
   5.855 +
   5.856 +{\bf Overview:} 
   5.857 +Get the vendor\_name field of the given PSCSI.
   5.858 +
   5.859 + \noindent {\bf Signature:} 
   5.860 +\begin{verbatim} string get_vendor_name (session_id s, PSCSI ref self)\end{verbatim}
   5.861 +
   5.862 +
   5.863 +\noindent{\bf Arguments:}
   5.864 +
   5.865 +
   5.866 +\vspace{0.3cm}
   5.867 +\begin{tabular}{|c|c|p{7cm}|}
   5.868 + \hline
   5.869 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.870 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.871 +
   5.872 +\end{tabular}
   5.873 +
   5.874 +\vspace{0.3cm}
   5.875 +
   5.876 + \noindent {\bf Return Type:} 
   5.877 +{\tt 
   5.878 +string
   5.879 +}
   5.880 +
   5.881 +
   5.882 +value of the field
   5.883 +\vspace{0.3cm}
   5.884 +\vspace{0.3cm}
   5.885 +\vspace{0.3cm}
   5.886 +\subsubsection{RPC name:~get\_model}
   5.887 +
   5.888 +{\bf Overview:} 
   5.889 +Get the model field of the given PSCSI.
   5.890 +
   5.891 + \noindent {\bf Signature:} 
   5.892 +\begin{verbatim} string get_model (session_id s, PSCSI ref self)\end{verbatim}
   5.893 +
   5.894 +
   5.895 +\noindent{\bf Arguments:}
   5.896 +
   5.897 +
   5.898 +\vspace{0.3cm}
   5.899 +\begin{tabular}{|c|c|p{7cm}|}
   5.900 + \hline
   5.901 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.902 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.903 +
   5.904 +\end{tabular}
   5.905 +
   5.906 +\vspace{0.3cm}
   5.907 +
   5.908 + \noindent {\bf Return Type:} 
   5.909 +{\tt 
   5.910 +string
   5.911 +}
   5.912 +
   5.913 +
   5.914 +value of the field
   5.915 +\vspace{0.3cm}
   5.916 +\vspace{0.3cm}
   5.917 +\vspace{0.3cm}
   5.918 +\subsubsection{RPC name:~get\_type\_id}
   5.919 +
   5.920 +{\bf Overview:} 
   5.921 +Get the type\_id field of the given PSCSI.
   5.922 +
   5.923 + \noindent {\bf Signature:} 
   5.924 +\begin{verbatim} int get_type_id (session_id s, PSCSI ref self)\end{verbatim}
   5.925 +
   5.926 +
   5.927 +\noindent{\bf Arguments:}
   5.928 +
   5.929 +
   5.930 +\vspace{0.3cm}
   5.931 +\begin{tabular}{|c|c|p{7cm}|}
   5.932 + \hline
   5.933 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.934 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.935 +
   5.936 +\end{tabular}
   5.937 +
   5.938 +\vspace{0.3cm}
   5.939 +
   5.940 + \noindent {\bf Return Type:} 
   5.941 +{\tt 
   5.942 +int
   5.943 +}
   5.944 +
   5.945 +
   5.946 +value of the field
   5.947 +\vspace{0.3cm}
   5.948 +\vspace{0.3cm}
   5.949 +\vspace{0.3cm}
   5.950 +\subsubsection{RPC name:~get\_type}
   5.951 +
   5.952 +{\bf Overview:} 
   5.953 +Get the type field of the given PSCSI.
   5.954 +
   5.955 + \noindent {\bf Signature:} 
   5.956 +\begin{verbatim} string get_type (session_id s, PSCSI ref self)\end{verbatim}
   5.957 +
   5.958 +
   5.959 +\noindent{\bf Arguments:}
   5.960 +
   5.961 +
   5.962 +\vspace{0.3cm}
   5.963 +\begin{tabular}{|c|c|p{7cm}|}
   5.964 + \hline
   5.965 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.966 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.967 +
   5.968 +\end{tabular}
   5.969 +
   5.970 +\vspace{0.3cm}
   5.971 +
   5.972 + \noindent {\bf Return Type:} 
   5.973 +{\tt 
   5.974 +string
   5.975 +}
   5.976 +
   5.977 +
   5.978 +value of the field
   5.979 +\vspace{0.3cm}
   5.980 +\vspace{0.3cm}
   5.981 +\vspace{0.3cm}
   5.982 +\subsubsection{RPC name:~get\_dev\_name}
   5.983 +
   5.984 +{\bf Overview:} 
   5.985 +Get the dev\_name field of the given PSCSI.
   5.986 +
   5.987 + \noindent {\bf Signature:} 
   5.988 +\begin{verbatim} string get_dev_name (session_id s, PSCSI ref self)\end{verbatim}
   5.989 +
   5.990 +
   5.991 +\noindent{\bf Arguments:}
   5.992 +
   5.993 +
   5.994 +\vspace{0.3cm}
   5.995 +\begin{tabular}{|c|c|p{7cm}|}
   5.996 + \hline
   5.997 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   5.998 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
   5.999 +
  5.1000 +\end{tabular}
  5.1001 +
  5.1002 +\vspace{0.3cm}
  5.1003 +
  5.1004 + \noindent {\bf Return Type:} 
  5.1005 +{\tt 
  5.1006 +string
  5.1007 +}
  5.1008 +
  5.1009 +
  5.1010 +value of the field
  5.1011 +\vspace{0.3cm}
  5.1012 +\vspace{0.3cm}
  5.1013 +\vspace{0.3cm}
  5.1014 +\subsubsection{RPC name:~get\_sg\_name}
  5.1015 +
  5.1016 +{\bf Overview:} 
  5.1017 +Get the sg\_name field of the given PSCSI.
  5.1018 +
  5.1019 + \noindent {\bf Signature:} 
  5.1020 +\begin{verbatim} string get_sg_name (session_id s, PSCSI ref self)\end{verbatim}
  5.1021 +
  5.1022 +
  5.1023 +\noindent{\bf Arguments:}
  5.1024 +
  5.1025 +
  5.1026 +\vspace{0.3cm}
  5.1027 +\begin{tabular}{|c|c|p{7cm}|}
  5.1028 + \hline
  5.1029 +{\bf type} & {\bf name} & {\bf description} \\ \hline
  5.1030 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
  5.1031 +
  5.1032 +\end{tabular}
  5.1033 +
  5.1034 +\vspace{0.3cm}
  5.1035 +
  5.1036 + \noindent {\bf Return Type:} 
  5.1037 +{\tt 
  5.1038 +string
  5.1039 +}
  5.1040 +
  5.1041 +
  5.1042 +value of the field
  5.1043 +\vspace{0.3cm}
  5.1044 +\vspace{0.3cm}
  5.1045 +\vspace{0.3cm}
  5.1046 +\subsubsection{RPC name:~get\_revision}
  5.1047 +
  5.1048 +{\bf Overview:} 
  5.1049 +Get the revision field of the given PSCSI.
  5.1050 +
  5.1051 + \noindent {\bf Signature:} 
  5.1052 +\begin{verbatim} string get_revision (session_id s, PSCSI ref self)\end{verbatim}
  5.1053 +
  5.1054 +
  5.1055 +\noindent{\bf Arguments:}
  5.1056 +
  5.1057 +
  5.1058 +\vspace{0.3cm}
  5.1059 +\begin{tabular}{|c|c|p{7cm}|}
  5.1060 + \hline
  5.1061 +{\bf type} & {\bf name} & {\bf description} \\ \hline
  5.1062 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
  5.1063 +
  5.1064 +\end{tabular}
  5.1065 +
  5.1066 +\vspace{0.3cm}
  5.1067 +
  5.1068 + \noindent {\bf Return Type:} 
  5.1069 +{\tt 
  5.1070 +string
  5.1071 +}
  5.1072 +
  5.1073 +
  5.1074 +value of the field
  5.1075 +\vspace{0.3cm}
  5.1076 +\vspace{0.3cm}
  5.1077 +\vspace{0.3cm}
  5.1078 +\subsubsection{RPC name:~get\_scsi\_id}
  5.1079 +
  5.1080 +{\bf Overview:} 
  5.1081 +Get the scsi\_id field of the given PSCSI.
  5.1082 +
  5.1083 + \noindent {\bf Signature:} 
  5.1084 +\begin{verbatim} string get_scsi_id (session_id s, PSCSI ref self)\end{verbatim}
  5.1085 +
  5.1086 +
  5.1087 +\noindent{\bf Arguments:}
  5.1088 +
  5.1089 +
  5.1090 +\vspace{0.3cm}
  5.1091 +\begin{tabular}{|c|c|p{7cm}|}
  5.1092 + \hline
  5.1093 +{\bf type} & {\bf name} & {\bf description} \\ \hline
  5.1094 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
  5.1095 +
  5.1096 +\end{tabular}
  5.1097 +
  5.1098 +\vspace{0.3cm}
  5.1099 +
  5.1100 + \noindent {\bf Return Type:} 
  5.1101 +{\tt 
  5.1102 +string
  5.1103 +}
  5.1104 +
  5.1105 +
  5.1106 +value of the field
  5.1107 +\vspace{0.3cm}
  5.1108 +\vspace{0.3cm}
  5.1109 +\vspace{0.3cm}
  5.1110 +\subsubsection{RPC name:~get\_scsi\_level}
  5.1111 +
  5.1112 +{\bf Overview:} 
  5.1113 +Get the scsi\_level field of the given PSCSI.
  5.1114 +
  5.1115 + \noindent {\bf Signature:} 
  5.1116 +\begin{verbatim} int get_scsi_level (session_id s, PSCSI ref self)\end{verbatim}
  5.1117 +
  5.1118 +
  5.1119 +\noindent{\bf Arguments:}
  5.1120 +
  5.1121 +
  5.1122 +\vspace{0.3cm}
  5.1123 +\begin{tabular}{|c|c|p{7cm}|}
  5.1124 + \hline
  5.1125 +{\bf type} & {\bf name} & {\bf description} \\ \hline
  5.1126 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
  5.1127 +
  5.1128 +\end{tabular}
  5.1129 +
  5.1130 +\vspace{0.3cm}
  5.1131 +
  5.1132 + \noindent {\bf Return Type:} 
  5.1133 +{\tt 
  5.1134 +int
  5.1135 +}
  5.1136 +
  5.1137 +
  5.1138 +value of the field
  5.1139 +\vspace{0.3cm}
  5.1140 +\vspace{0.3cm}
  5.1141 +\vspace{0.3cm}
  5.1142 +\subsubsection{RPC name:~get\_by\_uuid}
  5.1143 +
  5.1144 +{\bf Overview:} 
  5.1145 +Get a reference to the PSCSI instance with the specified UUID.
  5.1146 +
  5.1147 + \noindent {\bf Signature:} 
  5.1148 +\begin{verbatim} (PSCSI ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
  5.1149 +
  5.1150 +
  5.1151 +\noindent{\bf Arguments:}
  5.1152 +
  5.1153 +
  5.1154 +\vspace{0.3cm}
  5.1155 +\begin{tabular}{|c|c|p{7cm}|}
  5.1156 + \hline
  5.1157 +{\bf type} & {\bf name} & {\bf description} \\ \hline
  5.1158 +{\tt string } & uuid & UUID of object to return \\ \hline 
  5.1159 +
  5.1160 +\end{tabular}
  5.1161 +
  5.1162 +\vspace{0.3cm}
  5.1163 +
  5.1164 + \noindent {\bf Return Type:} 
  5.1165 +{\tt 
  5.1166 +PSCSI ref
  5.1167 +}
  5.1168 +
  5.1169 +
  5.1170 +reference to the object
  5.1171 +\vspace{0.3cm}
  5.1172 +\vspace{0.3cm}
  5.1173 +\vspace{0.3cm}
  5.1174 +\subsubsection{RPC name:~get\_record}
  5.1175 +
  5.1176 +{\bf Overview:} 
  5.1177 +Get a record containing the current state of the given PSCSI.
  5.1178 +
  5.1179 + \noindent {\bf Signature:} 
  5.1180 +\begin{verbatim} (PSCSI record) get_record (session_id s, PSCSI ref self)\end{verbatim}
  5.1181 +
  5.1182 +
  5.1183 +\noindent{\bf Arguments:}
  5.1184 +
  5.1185 +
  5.1186 +\vspace{0.3cm}
  5.1187 +\begin{tabular}{|c|c|p{7cm}|}
  5.1188 + \hline
  5.1189 +{\bf type} & {\bf name} & {\bf description} \\ \hline
  5.1190 +{\tt PSCSI ref } & self & reference to the object \\ \hline 
  5.1191 +
  5.1192 +\end{tabular}
  5.1193 +
  5.1194 +\vspace{0.3cm}
  5.1195 +
  5.1196 + \noindent {\bf Return Type:} 
  5.1197 +{\tt 
  5.1198 +PSCSI record
  5.1199 +}
  5.1200 +
  5.1201 +
  5.1202 +all fields from the object
  5.1203 +\vspace{0.3cm}
  5.1204 +\vspace{0.3cm}
  5.1205 +\vspace{0.3cm}
  5.1206 +
  5.1207 +\vspace{1cm}
  5.1208 +\newpage
  5.1209  \section{Class: user}
  5.1210  \subsection{Fields for class: user}
  5.1211  \begin{longtable}{|lllp{0.38\textwidth}|}