ia64/xen-unstable

changeset 12823:21c2bac97104

Added VBD.type field (CD or Disk).

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Wed Dec 06 15:45:09 2006 +0000 (2006-12-06)
parents 7cb0ed283197
children a05841d57ce0
files docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/xenapi-datamodel.tex	Wed Dec 06 15:42:28 2006 +0000
     1.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Wed Dec 06 15:45:09 2006 +0000
     1.3 @@ -266,6 +266,16 @@ The following enumeration types are used
     1.4  \vspace{1cm}
     1.5  \begin{longtable}{|ll|}
     1.6  \hline
     1.7 +{\tt enum vbd\_type} & \\
     1.8 +\hline
     1.9 +\hspace{0.5cm}{\tt CD} & VBD will appear to guest as CD \\
    1.10 +\hspace{0.5cm}{\tt Disk} & VBD will appear to guest as disk \\
    1.11 +\hline
    1.12 +\end{longtable}
    1.13 +
    1.14 +\vspace{1cm}
    1.15 +\begin{longtable}{|ll|}
    1.16 +\hline
    1.17  {\tt enum driver\_type} & \\
    1.18  \hline
    1.19  \hspace{0.5cm}{\tt ioemu} & use hardware emulation \\
    1.20 @@ -8635,6 +8645,7 @@ Quals & Field & Type & Description \\
    1.21  $\mathit{RW}$ &  {\tt VDI} & VDI ref & the virtual disk \\
    1.22  $\mathit{RW}$ &  {\tt device} & string & device seen by the guest e.g. hda1 \\
    1.23  $\mathit{RW}$ &  {\tt mode} & vbd\_mode & the mode the disk should be mounted with \\
    1.24 +$\mathit{RW}$ &  {\tt type} & vbd\_type & how the VBD will appear to the guest (e.g. disk or CD) \\
    1.25  $\mathit{RW}$ &  {\tt driver} & driver\_type & the style of driver \\
    1.26  $\mathit{RO}_\mathit{run}$ &  {\tt io/read\_kbs} & float & Read bandwidth (KiB/s) \\
    1.27  $\mathit{RO}_\mathit{run}$ &  {\tt io/write\_kbs} & float & Write bandwidth (KiB/s) \\
    1.28 @@ -8971,6 +8982,72 @@ void
    1.29  \vspace{0.3cm}
    1.30  \vspace{0.3cm}
    1.31  \vspace{0.3cm}
    1.32 +\subsubsection{RPC name:~get\_type}
    1.33 +
    1.34 +{\bf Overview:} 
    1.35 +Get the type field of the given VBD.
    1.36 +
    1.37 + \noindent {\bf Signature:} 
    1.38 +\begin{verbatim} (vbd_type) get_type (session_id s, VBD ref self)\end{verbatim}
    1.39 +
    1.40 +
    1.41 +\noindent{\bf Arguments:}
    1.42 +
    1.43 + 
    1.44 +\vspace{0.3cm}
    1.45 +\begin{tabular}{|c|c|p{7cm}|}
    1.46 + \hline
    1.47 +{\bf type} & {\bf name} & {\bf description} \\ \hline
    1.48 +{\tt VBD ref } & self & reference to the object \\ \hline 
    1.49 +
    1.50 +\end{tabular}
    1.51 +
    1.52 +\vspace{0.3cm}
    1.53 +
    1.54 + \noindent {\bf Return Type:} 
    1.55 +{\tt 
    1.56 +vbd\_type
    1.57 +}
    1.58 +
    1.59 +
    1.60 +value of the field
    1.61 +\vspace{0.3cm}
    1.62 +\vspace{0.3cm}
    1.63 +\vspace{0.3cm}
    1.64 +\subsubsection{RPC name:~set\_type}
    1.65 +
    1.66 +{\bf Overview:} 
    1.67 +Set the type field of the given VBD.
    1.68 +
    1.69 + \noindent {\bf Signature:} 
    1.70 +\begin{verbatim} void set_type (session_id s, VBD ref self, vbd_type value)\end{verbatim}
    1.71 +
    1.72 +
    1.73 +\noindent{\bf Arguments:}
    1.74 +
    1.75 + 
    1.76 +\vspace{0.3cm}
    1.77 +\begin{tabular}{|c|c|p{7cm}|}
    1.78 + \hline
    1.79 +{\bf type} & {\bf name} & {\bf description} \\ \hline
    1.80 +{\tt VBD ref } & self & reference to the object \\ \hline 
    1.81 +
    1.82 +{\tt vbd\_type } & value & New value to set \\ \hline 
    1.83 +
    1.84 +\end{tabular}
    1.85 +
    1.86 +\vspace{0.3cm}
    1.87 +
    1.88 + \noindent {\bf Return Type:} 
    1.89 +{\tt 
    1.90 +void
    1.91 +}
    1.92 +
    1.93 +
    1.94 +
    1.95 +\vspace{0.3cm}
    1.96 +\vspace{0.3cm}
    1.97 +\vspace{0.3cm}
    1.98  \subsubsection{RPC name:~get\_driver}
    1.99  
   1.100  {\bf Overview:}