ia64/xen-unstable

changeset 13163:2ae2204bbef3

More error codes.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Thu Dec 21 17:38:02 2006 +0000 (2006-12-21)
parents 71c40c3f92f7
children 63bd462b1f45
files docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/xenapi-datamodel.tex	Thu Dec 21 16:20:11 2006 +0000
     1.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Thu Dec 21 17:38:02 2006 +0000
     1.3 @@ -10494,6 +10494,68 @@ Each possible error code is documented i
     1.4  \subsection{Error Codes}
     1.5  
     1.6  \vspace{0.9cm}
     1.7 +\subsubsection{HOST\_CPU\_HANDLE\_INVALID}
     1.8 +
     1.9 +You gave an invalid host\_cpu handle.  The host\_cpu may have recently been
    1.10 +deleted.  The handle parameter echoes the bad value given.
    1.11 +
    1.12 +\vspace{0.3cm}
    1.13 +\noindent{\bf Signature:}
    1.14 +\begin{verbatim}HOST_CPU_HANDLE_INVALID(handle)\end{verbatim}
    1.15 +
    1.16 +
    1.17 +\vspace{0.9cm}
    1.18 +\subsubsection{HOST\_HANDLE\_INVALID}
    1.19 +
    1.20 +You gave an invalid host handle.  The host may have recently been deleted. 
    1.21 +The handle parameter echoes the bad value given.
    1.22 +
    1.23 +\vspace{0.3cm}
    1.24 +\noindent{\bf Signature:}
    1.25 +\begin{verbatim}HOST_HANDLE_INVALID(handle)\end{verbatim}
    1.26 +
    1.27 +
    1.28 +\vspace{0.9cm}
    1.29 +\subsubsection{INTERNAL\_ERROR}
    1.30 +
    1.31 +The server failed to handle your request, due to an internal error.  The
    1.32 +given message may give details useful for debugging the problem.
    1.33 +
    1.34 +\vspace{0.3cm}
    1.35 +\noindent{\bf Signature:}
    1.36 +\begin{verbatim}INTERNAL_ERROR(message)\end{verbatim}
    1.37 +
    1.38 +
    1.39 +\subsubsection{HOST\_CPU\_HANDLE\_INVALID}
    1.40 +
    1.41 +You gave an invalid host\_cpu handle.  The host\_cpu may have recently been
    1.42 +deleted.  The handle parameter echoes the bad value given.
    1.43 +
    1.44 +\vspace{0.3cm}
    1.45 +{\bf Signature:}
    1.46 +\begin{verbatim}HOST_CPU_HANDLE_INVALID(handle)\end{verbatim}
    1.47 +\begin{center}\rule{10em}{0.1pt}\end{center}
    1.48 +
    1.49 +\subsubsection{HOST\_HANDLE\_INVALID}
    1.50 +
    1.51 +You gave an invalid host handle.  The host may have recently been deleted. 
    1.52 +The handle parameter echoes the bad value given.
    1.53 +
    1.54 +\vspace{0.3cm}
    1.55 +{\bf Signature:}
    1.56 +\begin{verbatim}HOST_HANDLE_INVALID(handle)\end{verbatim}
    1.57 +\begin{center}\rule{10em}{0.1pt}\end{center}
    1.58 +
    1.59 +\subsubsection{INTERNAL\_ERROR}
    1.60 +
    1.61 +The server failed to handle your request, due to an internal error.  The
    1.62 +given message may give details useful for debugging the problem.
    1.63 +
    1.64 +\vspace{0.3cm}
    1.65 +{\bf Signature:}
    1.66 +\begin{verbatim}INTERNAL_ERROR(message)\end{verbatim}
    1.67 +\begin{center}\rule{10em}{0.1pt}\end{center}
    1.68 +
    1.69  \subsubsection{MAP\_DUPLICATE\_KEY}
    1.70  
    1.71  You tried to add a key-value pair to a map, but that key is already there. 
    1.72 @@ -10506,15 +10568,36 @@ echoed.
    1.73  
    1.74  
    1.75  \vspace{0.9cm}
    1.76 -\subsubsection{INTERNAL\_ERROR}
    1.77 -
    1.78 -The server failed to handle your request, due to an internal error.  The
    1.79 -given message may give details useful for debugging the problem.
    1.80 +\subsubsection{MESSAGE\_METHOD\_UNKNOWN}
    1.81 +
    1.82 +You tried to call a method that does not exist.  The method name that you
    1.83 +used is echoed.
    1.84  
    1.85  \vspace{0.3cm}
    1.86  \noindent{\bf Signature:}
    1.87 -\begin{verbatim}INTERNAL_ERROR(message)\end{verbatim}
    1.88 -
    1.89 +\begin{verbatim}MESSAGE_METHOD_UNKNOWN(method)\end{verbatim}
    1.90 +
    1.91 +
    1.92 +\vspace{0.9cm}
    1.93 +\subsubsection{MESSAGE\_PARAMETER\_COUNT\_MISMATCH}
    1.94 +
    1.95 +You tried to call a method with the incorrect number of parameters.  The
    1.96 +fully-qualified method name that you used, and the number of received and
    1.97 +expected parameters are returned.
    1.98 +
    1.99 +\vspace{0.3cm}
   1.100 +\noindent{\bf Signature:}
   1.101 +\begin{verbatim}MESSAGE_PARAMETER_COUNT_MISMATCH(method, expected, received)\end{verbatim}
   1.102 +
   1.103 +
   1.104 +\vspace{0.9cm}
   1.105 +\subsubsection{SESSION\_AUTHENTICATION\_FAILED}
   1.106 +
   1.107 +The credentials given by the user are incorrect, so access has been denied,
   1.108 +and you have not been issued a session handle.
   1.109 +
   1.110 +\vspace{0.3cm}
   1.111 +No parameters.
   1.112  
   1.113  \vspace{0.9cm}
   1.114  \subsubsection{SESSION\_INVALID}
   1.115 @@ -10530,6 +10613,50 @@ current connection.  The handle paramete
   1.116  
   1.117  
   1.118  \vspace{0.9cm}
   1.119 +\subsubsection{SR\_HANDLE\_INVALID}
   1.120 +
   1.121 +You gave an invalid SR handle.  The SR may have recently been deleted.  The
   1.122 +handle parameter echoes the bad value given.
   1.123 +
   1.124 +\vspace{0.3cm}
   1.125 +\noindent{\bf Signature:}
   1.126 +\begin{verbatim}SR_HANDLE_INVALID(handle)\end{verbatim}
   1.127 +
   1.128 +
   1.129 +\vspace{0.9cm}
   1.130 +\subsubsection{VBD\_HANDLE\_INVALID}
   1.131 +
   1.132 +You gave an invalid VBD handle.  The VBD may have recently been deleted. 
   1.133 +The handle parameter echoes the bad value given.
   1.134 +
   1.135 +\vspace{0.3cm}
   1.136 +\noindent{\bf Signature:}
   1.137 +\begin{verbatim}VBD_HANDLE_INVALID(handle)\end{verbatim}
   1.138 +
   1.139 +
   1.140 +\vspace{0.9cm}
   1.141 +\subsubsection{VDI\_HANDLE\_INVALID}
   1.142 +
   1.143 +You gave an invalid VDI handle.  The VDI may have recently been deleted. 
   1.144 +The handle parameter echoes the bad value given.
   1.145 +
   1.146 +\vspace{0.3cm}
   1.147 +\noindent{\bf Signature:}
   1.148 +\begin{verbatim}VDI_HANDLE_INVALID(handle)\end{verbatim}
   1.149 +
   1.150 +
   1.151 +\vspace{0.9cm}
   1.152 +\subsubsection{VIF\_HANDLE\_INVALID}
   1.153 +
   1.154 +You gave an invalid VIF handle.  The VIF may have recently been deleted. 
   1.155 +The handle parameter echoes the bad value given.
   1.156 +
   1.157 +\vspace{0.3cm}
   1.158 +\noindent{\bf Signature:}
   1.159 +\begin{verbatim}VIF_HANDLE_INVALID(handle)\end{verbatim}
   1.160 +
   1.161 +
   1.162 +\vspace{0.9cm}
   1.163  \subsubsection{VM\_HANDLE\_INVALID}
   1.164  
   1.165  You gave an invalid VM handle.  The VM may have recently been deleted.  The
   1.166 @@ -10539,6 +10666,17 @@ handle parameter echoes the bad value gi
   1.167  \noindent{\bf Signature:}
   1.168  \begin{verbatim}VM_HANDLE_INVALID(handle)\end{verbatim}
   1.169  
   1.170 +
   1.171 +\vspace{0.9cm}
   1.172 +\subsubsection{VTPM\_HANDLE\_INVALID}
   1.173 +
   1.174 +You gave an invalid VTPM handle.  The VTPM may have recently been deleted. 
   1.175 +The handle parameter echoes the bad value given.
   1.176 +
   1.177 +\vspace{0.3cm}
   1.178 +\noindent{\bf Signature:}
   1.179 +\begin{verbatim}VTPM_HANDLE_INVALID(handle)\end{verbatim}
   1.180 +
   1.181  \newpage
   1.182  \section{DTD}
   1.183  General notes: