ia64/xen-unstable

changeset 12158:d94dec09558a

Fix network model by moving Network.NIC and Network.VLAN onto a new PIF class.
Also, merge network and disk bandwidth into a single io/ namespace.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Thu Oct 26 15:35:18 2006 +0100 (2006-10-26)
parents d1b8acfaf9be
children ab69ecc1d172
files docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/xenapi-datamodel.tex	Thu Oct 26 15:03:47 2006 +0100
     1.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Thu Oct 26 15:35:18 2006 +0100
     1.3 @@ -5020,8 +5020,6 @@ Quals & Field & Type & Description \\
     1.4  $\mathit{RW}$ &  {\tt name/label} & string & a human-readable name \\
     1.5  $\mathit{RW}$ &  {\tt name/description} & string & a notes field containg human-readable description \\
     1.6  $\mathit{RO}_\mathit{run}$ &  {\tt VIFs} & (VIF ref) Set & list of connected vifs \\
     1.7 -$\mathit{RW}$ &  {\tt NIC} & string & ethernet device to use to access this network. Note: in this revision of the API all hosts will use the specified NIC to access this network \\
     1.8 -$\mathit{RW}$ &  {\tt VLAN} & string & VLAN tag to use to access this network. Note: in this revision of the API all hosts will use the specified VLAN tag to access this network \\
     1.9  $\mathit{RW}$ &  {\tt default\_gateway} & string & default gateway IP address. Used for auto-configuring guests with fixed IP setting \\
    1.10  $\mathit{RW}$ &  {\tt default\_netmask} & string & default netmask. Used for auto-configuring guests with fixed IP setting \\
    1.11  \hline
    1.12 @@ -5244,138 +5242,6 @@ value of the field
    1.13  \vspace{0.3cm}
    1.14  \vspace{0.3cm}
    1.15  \vspace{0.3cm}
    1.16 -\subsubsection{RPC name:~get\_NIC}
    1.17 -
    1.18 -{\bf Overview:} 
    1.19 -get accessor message derived from field NIC of object network
    1.20 -
    1.21 - \noindent {\bf Signature:} 
    1.22 -\begin{verbatim} string get_NIC (session_id s, network ref self)\end{verbatim}
    1.23 -
    1.24 -
    1.25 -\noindent{\bf Arguments:}
    1.26 -
    1.27 - 
    1.28 -\vspace{0.3cm}
    1.29 -\begin{tabular}{|c|c|p{7cm}|}
    1.30 - \hline
    1.31 -{\bf type} & {\bf name} & {\bf description} \\ \hline
    1.32 -{\tt network ref } & self & object instance \\ \hline 
    1.33 -
    1.34 -\end{tabular}
    1.35 -
    1.36 -\vspace{0.3cm}
    1.37 -
    1.38 - \noindent {\bf Return Type:} 
    1.39 -{\tt 
    1.40 -string
    1.41 -}
    1.42 -
    1.43 -
    1.44 -value of the field
    1.45 -\vspace{0.3cm}
    1.46 -\vspace{0.3cm}
    1.47 -\vspace{0.3cm}
    1.48 -\subsubsection{RPC name:~set\_NIC}
    1.49 -
    1.50 -{\bf Overview:} 
    1.51 -set accessor message derived from field NIC of object network
    1.52 -
    1.53 - \noindent {\bf Signature:} 
    1.54 -\begin{verbatim} void set_NIC (session_id s, network ref self, string value)\end{verbatim}
    1.55 -
    1.56 -
    1.57 -\noindent{\bf Arguments:}
    1.58 -
    1.59 - 
    1.60 -\vspace{0.3cm}
    1.61 -\begin{tabular}{|c|c|p{7cm}|}
    1.62 - \hline
    1.63 -{\bf type} & {\bf name} & {\bf description} \\ \hline
    1.64 -{\tt network ref } & self & object instance \\ \hline 
    1.65 -
    1.66 -{\tt string } & value & New value to set \\ \hline 
    1.67 -
    1.68 -\end{tabular}
    1.69 -
    1.70 -\vspace{0.3cm}
    1.71 -
    1.72 - \noindent {\bf Return Type:} 
    1.73 -{\tt 
    1.74 -void
    1.75 -}
    1.76 -
    1.77 -
    1.78 -
    1.79 -\vspace{0.3cm}
    1.80 -\vspace{0.3cm}
    1.81 -\vspace{0.3cm}
    1.82 -\subsubsection{RPC name:~get\_VLAN}
    1.83 -
    1.84 -{\bf Overview:} 
    1.85 -get accessor message derived from field VLAN of object network
    1.86 -
    1.87 - \noindent {\bf Signature:} 
    1.88 -\begin{verbatim} string get_VLAN (session_id s, network ref self)\end{verbatim}
    1.89 -
    1.90 -
    1.91 -\noindent{\bf Arguments:}
    1.92 -
    1.93 - 
    1.94 -\vspace{0.3cm}
    1.95 -\begin{tabular}{|c|c|p{7cm}|}
    1.96 - \hline
    1.97 -{\bf type} & {\bf name} & {\bf description} \\ \hline
    1.98 -{\tt network ref } & self & object instance \\ \hline 
    1.99 -
   1.100 -\end{tabular}
   1.101 -
   1.102 -\vspace{0.3cm}
   1.103 -
   1.104 - \noindent {\bf Return Type:} 
   1.105 -{\tt 
   1.106 -string
   1.107 -}
   1.108 -
   1.109 -
   1.110 -value of the field
   1.111 -\vspace{0.3cm}
   1.112 -\vspace{0.3cm}
   1.113 -\vspace{0.3cm}
   1.114 -\subsubsection{RPC name:~set\_VLAN}
   1.115 -
   1.116 -{\bf Overview:} 
   1.117 -set accessor message derived from field VLAN of object network
   1.118 -
   1.119 - \noindent {\bf Signature:} 
   1.120 -\begin{verbatim} void set_VLAN (session_id s, network ref self, string value)\end{verbatim}
   1.121 -
   1.122 -
   1.123 -\noindent{\bf Arguments:}
   1.124 -
   1.125 - 
   1.126 -\vspace{0.3cm}
   1.127 -\begin{tabular}{|c|c|p{7cm}|}
   1.128 - \hline
   1.129 -{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.130 -{\tt network ref } & self & object instance \\ \hline 
   1.131 -
   1.132 -{\tt string } & value & New value to set \\ \hline 
   1.133 -
   1.134 -\end{tabular}
   1.135 -
   1.136 -\vspace{0.3cm}
   1.137 -
   1.138 - \noindent {\bf Return Type:} 
   1.139 -{\tt 
   1.140 -void
   1.141 -}
   1.142 -
   1.143 -
   1.144 -
   1.145 -\vspace{0.3cm}
   1.146 -\vspace{0.3cm}
   1.147 -\vspace{0.3cm}
   1.148  \subsubsection{RPC name:~get\_default\_gateway}
   1.149  
   1.150  {\bf Overview:} 
   1.151 @@ -5741,10 +5607,8 @@ Quals & Field & Type & Description \\
   1.152  $\mathit{RW}$ &  {\tt VM} & VM ref & virtual machine to which this vif is connected \\
   1.153  $\mathit{RW}$ &  {\tt MAC} & string & ethernet MAC address of virtual interface, as exposed to guest \\
   1.154  $\mathit{RW}$ &  {\tt MTU} & int & MTU in octets \\
   1.155 -$\mathit{RO}_\mathit{run}$ &  {\tt network\_read\_kbs} & float & Incoming network bandwidth \\
   1.156 -$\mathit{RO}_\mathit{run}$ &  {\tt network\_write\_kbs} & float & Outgoing network bandwidth \\
   1.157 -$\mathit{RO}_\mathit{run}$ &  {\tt IO\_bandwidth/incoming\_kbs} & float & Read bandwidth (Kb/s) \\
   1.158 -$\mathit{RO}_\mathit{run}$ &  {\tt IO\_bandwidth/outgoing\_kbs} & float & Write bandwidth (Kb/s) \\
   1.159 +$\mathit{RO}_\mathit{run}$ &  {\tt io/read\_kbs} & float & Read bandwidth (KiB/s) \\
   1.160 +$\mathit{RO}_\mathit{run}$ &  {\tt io/write\_kbs} & float & Write bandwidth (KiB/s) \\
   1.161  \hline
   1.162  \end{longtable}
   1.163  \subsection{Additional RPCs associated with class: VIF}
   1.164 @@ -6242,13 +6106,13 @@ void
   1.165  \vspace{0.3cm}
   1.166  \vspace{0.3cm}
   1.167  \vspace{0.3cm}
   1.168 -\subsubsection{RPC name:~get\_network\_read\_kbs}
   1.169 -
   1.170 -{\bf Overview:} 
   1.171 -get accessor message derived from field network\_read\_kbs of object VIF
   1.172 -
   1.173 - \noindent {\bf Signature:} 
   1.174 -\begin{verbatim} float get_network_read_kbs (session_id s, VIF ref self)\end{verbatim}
   1.175 +\subsubsection{RPC name:~get\_io\_read\_kbs}
   1.176 +
   1.177 +{\bf Overview:} 
   1.178 +get accessor message derived from field io/read\_kbs of object VIF
   1.179 +
   1.180 + \noindent {\bf Signature:} 
   1.181 +\begin{verbatim} float get_io_read_kbs (session_id s, VIF ref self)\end{verbatim}
   1.182  
   1.183  
   1.184  \noindent{\bf Arguments:}
   1.185 @@ -6274,77 +6138,13 @@ value of the field
   1.186  \vspace{0.3cm}
   1.187  \vspace{0.3cm}
   1.188  \vspace{0.3cm}
   1.189 -\subsubsection{RPC name:~get\_network\_write\_kbs}
   1.190 -
   1.191 -{\bf Overview:} 
   1.192 -get accessor message derived from field network\_write\_kbs of object VIF
   1.193 -
   1.194 - \noindent {\bf Signature:} 
   1.195 -\begin{verbatim} float get_network_write_kbs (session_id s, VIF ref self)\end{verbatim}
   1.196 -
   1.197 -
   1.198 -\noindent{\bf Arguments:}
   1.199 -
   1.200 - 
   1.201 -\vspace{0.3cm}
   1.202 -\begin{tabular}{|c|c|p{7cm}|}
   1.203 - \hline
   1.204 -{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.205 -{\tt VIF ref } & self & object instance \\ \hline 
   1.206 -
   1.207 -\end{tabular}
   1.208 -
   1.209 -\vspace{0.3cm}
   1.210 -
   1.211 - \noindent {\bf Return Type:} 
   1.212 -{\tt 
   1.213 -float
   1.214 -}
   1.215 -
   1.216 -
   1.217 -value of the field
   1.218 -\vspace{0.3cm}
   1.219 -\vspace{0.3cm}
   1.220 -\vspace{0.3cm}
   1.221 -\subsubsection{RPC name:~get\_IO\_bandwidth\_incoming\_kbs}
   1.222 -
   1.223 -{\bf Overview:} 
   1.224 -get accessor message derived from field IO\_bandwidth/incoming\_kbs of object VIF
   1.225 -
   1.226 - \noindent {\bf Signature:} 
   1.227 -\begin{verbatim} float get_IO_bandwidth_incoming_kbs (session_id s, VIF ref self)\end{verbatim}
   1.228 -
   1.229 -
   1.230 -\noindent{\bf Arguments:}
   1.231 -
   1.232 - 
   1.233 -\vspace{0.3cm}
   1.234 -\begin{tabular}{|c|c|p{7cm}|}
   1.235 - \hline
   1.236 -{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.237 -{\tt VIF ref } & self & object instance \\ \hline 
   1.238 -
   1.239 -\end{tabular}
   1.240 -
   1.241 -\vspace{0.3cm}
   1.242 -
   1.243 - \noindent {\bf Return Type:} 
   1.244 -{\tt 
   1.245 -float
   1.246 -}
   1.247 -
   1.248 -
   1.249 -value of the field
   1.250 -\vspace{0.3cm}
   1.251 -\vspace{0.3cm}
   1.252 -\vspace{0.3cm}
   1.253 -\subsubsection{RPC name:~get\_IO\_bandwidth\_outgoing\_kbs}
   1.254 -
   1.255 -{\bf Overview:} 
   1.256 -get accessor message derived from field IO\_bandwidth/outgoing\_kbs of object VIF
   1.257 -
   1.258 - \noindent {\bf Signature:} 
   1.259 -\begin{verbatim} float get_IO_bandwidth_outgoing_kbs (session_id s, VIF ref self)\end{verbatim}
   1.260 +\subsubsection{RPC name:~get\_io\_write\_kbs}
   1.261 +
   1.262 +{\bf Overview:} 
   1.263 +get accessor message derived from field io/write\_kbs of object VIF
   1.264 +
   1.265 + \noindent {\bf Signature:} 
   1.266 +\begin{verbatim} float get_io_write_kbs (session_id s, VIF ref self)\end{verbatim}
   1.267  
   1.268  
   1.269  \noindent{\bf Arguments:}
   1.270 @@ -8147,11 +7947,45 @@ Quals & Field & Type & Description \\
   1.271  $\mathit{RW}$ &  {\tt device} & string & device seen by the guest e.g. hda1 \\
   1.272  $\mathit{RW}$ &  {\tt mode} & vbd\_mode & the mode the disk should be mounted with \\
   1.273  $\mathit{RW}$ &  {\tt driver} & driver\_type & the style of driver \\
   1.274 -$\mathit{RO}_\mathit{run}$ &  {\tt IO\_bandwidth/incoming\_kbs} & float & Read bandwidth (Kb/s) \\
   1.275 -$\mathit{RO}_\mathit{run}$ &  {\tt IO\_bandwidth/outgoing\_kbs} & float & Write bandwidth (Kb/s) \\
   1.276 +$\mathit{RO}_\mathit{run}$ &  {\tt io/read\_kbs} & float & Read bandwidth (KiB/s) \\
   1.277 +$\mathit{RO}_\mathit{run}$ &  {\tt io/write\_kbs} & float & Write bandwidth (KiB/s) \\
   1.278  \hline
   1.279  \end{longtable}
   1.280  \subsection{Additional RPCs associated with class: VBD}
   1.281 +\subsubsection{RPC name:~media\_change}
   1.282 +
   1.283 +{\bf Overview:} 
   1.284 +Change the media in the device for CDROM-like devices only. For other devices, detach the VBD and attach a new one
   1.285 +
   1.286 + \noindent {\bf Signature:} 
   1.287 +\begin{verbatim} void media_change (session_id s, VBD ref vbd, VDI ref vdi)\end{verbatim}
   1.288 +
   1.289 +
   1.290 +\noindent{\bf Arguments:}
   1.291 +
   1.292 + 
   1.293 +\vspace{0.3cm}
   1.294 +\begin{tabular}{|c|c|p{7cm}|}
   1.295 + \hline
   1.296 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.297 +{\tt VBD ref } & vbd & The vbd representing the CDROM-like device \\ \hline 
   1.298 +
   1.299 +{\tt VDI ref } & vdi & The new VDI to 'insert' \\ \hline 
   1.300 +
   1.301 +\end{tabular}
   1.302 +
   1.303 +\vspace{0.3cm}
   1.304 +
   1.305 + \noindent {\bf Return Type:} 
   1.306 +{\tt 
   1.307 +void
   1.308 +}
   1.309 +
   1.310 +
   1.311 +
   1.312 +\vspace{0.3cm}
   1.313 +\vspace{0.3cm}
   1.314 +\vspace{0.3cm}
   1.315  \subsubsection{RPC name:~get\_uuid}
   1.316  
   1.317  {\bf Overview:} 
   1.318 @@ -8514,13 +8348,13 @@ void
   1.319  \vspace{0.3cm}
   1.320  \vspace{0.3cm}
   1.321  \vspace{0.3cm}
   1.322 -\subsubsection{RPC name:~get\_IO\_bandwidth\_incoming\_kbs}
   1.323 -
   1.324 -{\bf Overview:} 
   1.325 -get accessor message derived from field IO\_bandwidth/incoming\_kbs of object VBD
   1.326 -
   1.327 - \noindent {\bf Signature:} 
   1.328 -\begin{verbatim} float get_IO_bandwidth_incoming_kbs (session_id s, VBD ref self)\end{verbatim}
   1.329 +\subsubsection{RPC name:~get\_io\_read\_kbs}
   1.330 +
   1.331 +{\bf Overview:} 
   1.332 +get accessor message derived from field io/read\_kbs of object VBD
   1.333 +
   1.334 + \noindent {\bf Signature:} 
   1.335 +\begin{verbatim} float get_io_read_kbs (session_id s, VBD ref self)\end{verbatim}
   1.336  
   1.337  
   1.338  \noindent{\bf Arguments:}
   1.339 @@ -8546,13 +8380,13 @@ value of the field
   1.340  \vspace{0.3cm}
   1.341  \vspace{0.3cm}
   1.342  \vspace{0.3cm}
   1.343 -\subsubsection{RPC name:~get\_IO\_bandwidth\_outgoing\_kbs}
   1.344 -
   1.345 -{\bf Overview:} 
   1.346 -get accessor message derived from field IO\_bandwidth/outgoing\_kbs of object VBD
   1.347 -
   1.348 - \noindent {\bf Signature:} 
   1.349 -\begin{verbatim} float get_IO_bandwidth_outgoing_kbs (session_id s, VBD ref self)\end{verbatim}
   1.350 +\subsubsection{RPC name:~get\_io\_write\_kbs}
   1.351 +
   1.352 +{\bf Overview:} 
   1.353 +get accessor message derived from field io/write\_kbs of object VBD
   1.354 +
   1.355 + \noindent {\bf Signature:} 
   1.356 +\begin{verbatim} float get_io_write_kbs (session_id s, VBD ref self)\end{verbatim}
   1.357  
   1.358  
   1.359  \noindent{\bf Arguments:}