ia64/xen-unstable

changeset 13193:6533ebfc25e1

Added the BAD_VM_STATE error code, and tidy up the error code section.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Mon Dec 25 18:44:27 2006 +0000 (2006-12-25)
parents 159ae46d5e7f
children ce4e548f42b8
files docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/xenapi-datamodel.tex	Mon Dec 25 17:02:16 2006 +0000
     1.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Mon Dec 25 18:44:27 2006 +0000
     1.3 @@ -1279,8 +1279,10 @@ VM ref
     1.4  
     1.5  The ID of the newly created VM.
     1.6  \vspace{0.3cm}
     1.7 -\vspace{0.3cm}
     1.8 -\vspace{0.3cm}
     1.9 +
    1.10 +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE}
    1.11 +
    1.12 +\vspace{0.6cm}
    1.13  \subsubsection{RPC name:~start}
    1.14  
    1.15  {\bf Overview:} 
    1.16 @@ -1313,8 +1315,10 @@ void
    1.17  
    1.18  
    1.19  \vspace{0.3cm}
    1.20 -\vspace{0.3cm}
    1.21 -\vspace{0.3cm}
    1.22 +
    1.23 +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE}
    1.24 +
    1.25 +\vspace{0.6cm}
    1.26  \subsubsection{RPC name:~pause}
    1.27  
    1.28  {\bf Overview:} 
    1.29 @@ -1345,8 +1349,10 @@ void
    1.30  
    1.31  
    1.32  \vspace{0.3cm}
    1.33 -\vspace{0.3cm}
    1.34 -\vspace{0.3cm}
    1.35 +
    1.36 +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE}
    1.37 +
    1.38 +\vspace{0.6cm}
    1.39  \subsubsection{RPC name:~unpause}
    1.40  
    1.41  {\bf Overview:} 
    1.42 @@ -1363,22 +1369,24 @@ Resume the specified VM. This can only b
    1.43  \begin{tabular}{|c|c|p{7cm}|}
    1.44   \hline
    1.45  {\bf type} & {\bf name} & {\bf description} \\ \hline
    1.46 -{\tt VM ref } & vm & The VM to pause \\ \hline 
    1.47 -
    1.48 -\end{tabular}
    1.49 -
    1.50 -\vspace{0.3cm}
    1.51 -
    1.52 - \noindent {\bf Return Type:} 
    1.53 -{\tt 
    1.54 -void
    1.55 -}
    1.56 -
    1.57 -
    1.58 -
    1.59 -\vspace{0.3cm}
    1.60 -\vspace{0.3cm}
    1.61 -\vspace{0.3cm}
    1.62 +{\tt VM ref } & vm & The VM to unpause \\ \hline 
    1.63 +
    1.64 +\end{tabular}
    1.65 +
    1.66 +\vspace{0.3cm}
    1.67 +
    1.68 + \noindent {\bf Return Type:} 
    1.69 +{\tt 
    1.70 +void
    1.71 +}
    1.72 +
    1.73 +
    1.74 +
    1.75 +\vspace{0.3cm}
    1.76 +
    1.77 +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE}
    1.78 +
    1.79 +\vspace{0.6cm}
    1.80  \subsubsection{RPC name:~clean\_shutdown}
    1.81  
    1.82  {\bf Overview:} 
    1.83 @@ -1386,6 +1394,8 @@ Attempt to cleanly shutdown the specifie
    1.84  
    1.85  Once shutdown has been completed perform poweroff action specified in guest configuration.
    1.86  
    1.87 +This can only be called when the specified VM is in the Running state.
    1.88 +
    1.89   \noindent {\bf Signature:} 
    1.90  \begin{verbatim} void clean_shutdown (session_id s, VM ref vm)\end{verbatim}
    1.91  
    1.92 @@ -1411,8 +1421,10 @@ void
    1.93  
    1.94  
    1.95  \vspace{0.3cm}
    1.96 -\vspace{0.3cm}
    1.97 -\vspace{0.3cm}
    1.98 +
    1.99 +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE}
   1.100 +
   1.101 +\vspace{0.6cm}
   1.102  \subsubsection{RPC name:~clean\_reboot}
   1.103  
   1.104  {\bf Overview:} 
   1.105 @@ -1420,6 +1432,8 @@ Attempt to cleanly shutdown the specifie
   1.106  
   1.107  Once shutdown has been completed perform reboot action specified in guest configuration.
   1.108  
   1.109 +This can only be called when the specified VM is in the Running state.
   1.110 +
   1.111   \noindent {\bf Signature:} 
   1.112  \begin{verbatim} void clean_reboot (session_id s, VM ref vm)\end{verbatim}
   1.113  
   1.114 @@ -1445,8 +1459,10 @@ void
   1.115  
   1.116  
   1.117  \vspace{0.3cm}
   1.118 -\vspace{0.3cm}
   1.119 -\vspace{0.3cm}
   1.120 +
   1.121 +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE}
   1.122 +
   1.123 +\vspace{0.6cm}
   1.124  \subsubsection{RPC name:~hard\_shutdown}
   1.125  
   1.126  {\bf Overview:} 
   1.127 @@ -1514,7 +1530,7 @@ void
   1.128  \subsubsection{RPC name:~suspend}
   1.129  
   1.130  {\bf Overview:} 
   1.131 -Suspend the specified VM to disk.
   1.132 +Suspend the specified VM to disk.  This can only be called when the specified VM is in the Running state.
   1.133  
   1.134   \noindent {\bf Signature:} 
   1.135  \begin{verbatim} void suspend (session_id s, VM ref vm)\end{verbatim}
   1.136 @@ -1541,12 +1557,14 @@ void
   1.137  
   1.138  
   1.139  \vspace{0.3cm}
   1.140 -\vspace{0.3cm}
   1.141 -\vspace{0.3cm}
   1.142 +
   1.143 +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE}
   1.144 +
   1.145 +\vspace{0.6cm}
   1.146  \subsubsection{RPC name:~resume}
   1.147  
   1.148  {\bf Overview:} 
   1.149 -Awaken the specified VM and resume it.
   1.150 +Awaken the specified VM and resume it.  This can only be called when the specified VM is in the Suspended state.
   1.151  
   1.152   \noindent {\bf Signature:} 
   1.153  \begin{verbatim} void resume (session_id s, VM ref vm, bool start_paused)\end{verbatim}
   1.154 @@ -1575,8 +1593,10 @@ void
   1.155  
   1.156  
   1.157  \vspace{0.3cm}
   1.158 -\vspace{0.3cm}
   1.159 -\vspace{0.3cm}
   1.160 +
   1.161 +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE}
   1.162 +
   1.163 +\vspace{0.6cm}
   1.164  \subsubsection{RPC name:~get\_all}
   1.165  
   1.166  {\bf Overview:} 
   1.167 @@ -10493,39 +10513,6 @@ Each possible error code is documented i
   1.168  
   1.169  \subsection{Error Codes}
   1.170  
   1.171 -\vspace{0.9cm}
   1.172 -\subsubsection{HOST\_CPU\_HANDLE\_INVALID}
   1.173 -
   1.174 -You gave an invalid host\_cpu handle.  The host\_cpu may have recently been
   1.175 -deleted.  The handle parameter echoes the bad value given.
   1.176 -
   1.177 -\vspace{0.3cm}
   1.178 -\noindent{\bf Signature:}
   1.179 -\begin{verbatim}HOST_CPU_HANDLE_INVALID(handle)\end{verbatim}
   1.180 -
   1.181 -
   1.182 -\vspace{0.9cm}
   1.183 -\subsubsection{HOST\_HANDLE\_INVALID}
   1.184 -
   1.185 -You gave an invalid host handle.  The host may have recently been deleted. 
   1.186 -The handle parameter echoes the bad value given.
   1.187 -
   1.188 -\vspace{0.3cm}
   1.189 -\noindent{\bf Signature:}
   1.190 -\begin{verbatim}HOST_HANDLE_INVALID(handle)\end{verbatim}
   1.191 -
   1.192 -
   1.193 -\vspace{0.9cm}
   1.194 -\subsubsection{INTERNAL\_ERROR}
   1.195 -
   1.196 -The server failed to handle your request, due to an internal error.  The
   1.197 -given message may give details useful for debugging the problem.
   1.198 -
   1.199 -\vspace{0.3cm}
   1.200 -\noindent{\bf Signature:}
   1.201 -\begin{verbatim}INTERNAL_ERROR(message)\end{verbatim}
   1.202 -
   1.203 -
   1.204  \subsubsection{HOST\_CPU\_HANDLE\_INVALID}
   1.205  
   1.206  You gave an invalid host\_cpu handle.  The host\_cpu may have recently been
   1.207 @@ -10563,22 +10550,20 @@ The key, current value, and the new valu
   1.208  echoed.
   1.209  
   1.210  \vspace{0.3cm}
   1.211 -\noindent{\bf Signature:}
   1.212 +{\bf Signature:}
   1.213  \begin{verbatim}MAP_DUPLICATE_KEY(key, current value, new value)\end{verbatim}
   1.214 -
   1.215 -
   1.216 -\vspace{0.9cm}
   1.217 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.218 +
   1.219  \subsubsection{MESSAGE\_METHOD\_UNKNOWN}
   1.220  
   1.221  You tried to call a method that does not exist.  The method name that you
   1.222  used is echoed.
   1.223  
   1.224  \vspace{0.3cm}
   1.225 -\noindent{\bf Signature:}
   1.226 +{\bf Signature:}
   1.227  \begin{verbatim}MESSAGE_METHOD_UNKNOWN(method)\end{verbatim}
   1.228 -
   1.229 -
   1.230 -\vspace{0.9cm}
   1.231 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.232 +
   1.233  \subsubsection{MESSAGE\_PARAMETER\_COUNT\_MISMATCH}
   1.234  
   1.235  You tried to call a method with the incorrect number of parameters.  The
   1.236 @@ -10586,11 +10571,10 @@ fully-qualified method name that you use
   1.237  expected parameters are returned.
   1.238  
   1.239  \vspace{0.3cm}
   1.240 -\noindent{\bf Signature:}
   1.241 +{\bf Signature:}
   1.242  \begin{verbatim}MESSAGE_PARAMETER_COUNT_MISMATCH(method, expected, received)\end{verbatim}
   1.243 -
   1.244 -
   1.245 -\vspace{0.9cm}
   1.246 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.247 +
   1.248  \subsubsection{SESSION\_AUTHENTICATION\_FAILED}
   1.249  
   1.250  The credentials given by the user are incorrect, so access has been denied,
   1.251 @@ -10598,8 +10582,8 @@ and you have not been issued a session h
   1.252  
   1.253  \vspace{0.3cm}
   1.254  No parameters.
   1.255 -
   1.256 -\vspace{0.9cm}
   1.257 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.258 +
   1.259  \subsubsection{SESSION\_INVALID}
   1.260  
   1.261  You gave an invalid session handle.  It may have been invalidated by a
   1.262 @@ -10608,74 +10592,83 @@ one of the session.login\_ calls.  This 
   1.263  current connection.  The handle parameter echoes the bad value given.
   1.264  
   1.265  \vspace{0.3cm}
   1.266 -\noindent{\bf Signature:}
   1.267 +{\bf Signature:}
   1.268  \begin{verbatim}SESSION_INVALID(handle)\end{verbatim}
   1.269 -
   1.270 -
   1.271 -\vspace{0.9cm}
   1.272 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.273 +
   1.274  \subsubsection{SR\_HANDLE\_INVALID}
   1.275  
   1.276  You gave an invalid SR handle.  The SR may have recently been deleted.  The
   1.277  handle parameter echoes the bad value given.
   1.278  
   1.279  \vspace{0.3cm}
   1.280 -\noindent{\bf Signature:}
   1.281 +{\bf Signature:}
   1.282  \begin{verbatim}SR_HANDLE_INVALID(handle)\end{verbatim}
   1.283 -
   1.284 -
   1.285 -\vspace{0.9cm}
   1.286 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.287 +
   1.288  \subsubsection{VBD\_HANDLE\_INVALID}
   1.289  
   1.290  You gave an invalid VBD handle.  The VBD may have recently been deleted. 
   1.291  The handle parameter echoes the bad value given.
   1.292  
   1.293  \vspace{0.3cm}
   1.294 -\noindent{\bf Signature:}
   1.295 +{\bf Signature:}
   1.296  \begin{verbatim}VBD_HANDLE_INVALID(handle)\end{verbatim}
   1.297 -
   1.298 -
   1.299 -\vspace{0.9cm}
   1.300 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.301 +
   1.302  \subsubsection{VDI\_HANDLE\_INVALID}
   1.303  
   1.304  You gave an invalid VDI handle.  The VDI may have recently been deleted. 
   1.305  The handle parameter echoes the bad value given.
   1.306  
   1.307  \vspace{0.3cm}
   1.308 -\noindent{\bf Signature:}
   1.309 +{\bf Signature:}
   1.310  \begin{verbatim}VDI_HANDLE_INVALID(handle)\end{verbatim}
   1.311 -
   1.312 -
   1.313 -\vspace{0.9cm}
   1.314 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.315 +
   1.316  \subsubsection{VIF\_HANDLE\_INVALID}
   1.317  
   1.318  You gave an invalid VIF handle.  The VIF may have recently been deleted. 
   1.319  The handle parameter echoes the bad value given.
   1.320  
   1.321  \vspace{0.3cm}
   1.322 -\noindent{\bf Signature:}
   1.323 +{\bf Signature:}
   1.324  \begin{verbatim}VIF_HANDLE_INVALID(handle)\end{verbatim}
   1.325 -
   1.326 -
   1.327 -\vspace{0.9cm}
   1.328 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.329 +
   1.330 +\subsubsection{VM\_BAD\_POWER\_STATE}
   1.331 +
   1.332 +You attempted an operation on a VM that was not in an appropriate power
   1.333 +state at the time; for example, you attempted to start a VM that was
   1.334 +already running.  The parameters returned are the VM's UUID, and the
   1.335 +expected and actual VM state at the time of the call.
   1.336 +
   1.337 +\vspace{0.3cm}
   1.338 +{\bf Signature:}
   1.339 +\begin{verbatim}VM_BAD_POWER_STATE(vm, expected, actual)\end{verbatim}
   1.340 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.341 +
   1.342  \subsubsection{VM\_HANDLE\_INVALID}
   1.343  
   1.344  You gave an invalid VM handle.  The VM may have recently been deleted.  The
   1.345  handle parameter echoes the bad value given.
   1.346  
   1.347  \vspace{0.3cm}
   1.348 -\noindent{\bf Signature:}
   1.349 +{\bf Signature:}
   1.350  \begin{verbatim}VM_HANDLE_INVALID(handle)\end{verbatim}
   1.351 -
   1.352 -
   1.353 -\vspace{0.9cm}
   1.354 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.355 +
   1.356  \subsubsection{VTPM\_HANDLE\_INVALID}
   1.357  
   1.358  You gave an invalid VTPM handle.  The VTPM may have recently been deleted. 
   1.359  The handle parameter echoes the bad value given.
   1.360  
   1.361  \vspace{0.3cm}
   1.362 -\noindent{\bf Signature:}
   1.363 +{\bf Signature:}
   1.364  \begin{verbatim}VTPM_HANDLE_INVALID(handle)\end{verbatim}
   1.365 +\begin{center}\rule{10em}{0.1pt}\end{center}
   1.366 +
   1.367 +
   1.368  
   1.369  \newpage
   1.370  \section{DTD}