ia64/xen-unstable

changeset 13703:f40528773629

Document new error codes VLAN_TAG_INVALID and PIF_IS_PHYSICAL.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Sun Jan 28 13:50:56 2007 +0000 (2007-01-28)
parents 5e1c7022d4ad
children 4651595d9502
files docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/xenapi-datamodel.tex	Sun Jan 28 13:40:07 2007 +0000
     1.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Sun Jan 28 13:50:56 2007 +0000
     1.3 @@ -6583,8 +6583,10 @@ PIF ref
     1.4  
     1.5  The reference of the created PIF object
     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 VLAN\_TAG\_INVALID}
    1.11 +
    1.12 +\vspace{0.6cm}
    1.13  \subsubsection{RPC name:~destroy}
    1.14  
    1.15  {\bf Overview:} 
    1.16 @@ -6615,8 +6617,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 PIF\_IS\_PHYSICAL}
    1.24 +
    1.25 +\vspace{0.6cm}
    1.26  \subsubsection{RPC name:~get\_uuid}
    1.27  
    1.28  {\bf Overview:} 
    1.29 @@ -10498,6 +10502,17 @@ already attached to some other PIF, and 
    1.30  \begin{verbatim}NETWORK_ALREADY_CONNECTED(network, connected PIF)\end{verbatim}
    1.31  \begin{center}\rule{10em}{0.1pt}\end{center}
    1.32  
    1.33 +\subsubsection{PIF\_IS\_PHYSICAL}
    1.34 +
    1.35 +You tried to destroy a PIF, but it represents an aspect of the physical
    1.36 +host configuration, and so cannot be destroyed.  The parameter echoes the
    1.37 +PIF handle you gave.
    1.38 +
    1.39 +\vspace{0.3cm}
    1.40 +{\bf Signature:}
    1.41 +\begin{verbatim}PIF_IS_PHYSICAL(PIF)\end{verbatim}
    1.42 +\begin{center}\rule{10em}{0.1pt}\end{center}
    1.43 +
    1.44  \subsubsection{SESSION\_AUTHENTICATION\_FAILED}
    1.45  
    1.46  The credentials given by the user are incorrect, so access has been denied,
    1.47 @@ -10559,11 +10574,21 @@ The handle parameter echoes the bad valu
    1.48  \begin{verbatim}VIF_HANDLE_INVALID(handle)\end{verbatim}
    1.49  \begin{center}\rule{10em}{0.1pt}\end{center}
    1.50  
    1.51 +\subsubsection{VLAN\_TAG\_INVALID}
    1.52 +
    1.53 +You tried to create a VLAN, but the tag you gave was invalid -- it mmust be
    1.54 +between 0 and 4095.  The parameter echoes the VLAN tag you gave.
    1.55 +
    1.56 +\vspace{0.3cm}
    1.57 +{\bf Signature:}
    1.58 +\begin{verbatim}VLAN_TAG_INVALID(VLAN)\end{verbatim}
    1.59 +\begin{center}\rule{10em}{0.1pt}\end{center}
    1.60 +
    1.61  \subsubsection{VM\_BAD\_POWER\_STATE}
    1.62  
    1.63  You attempted an operation on a VM that was not in an appropriate power
    1.64  state at the time; for example, you attempted to start a VM that was
    1.65 -already running.  The parameters returned are the VM's UUID, and the
    1.66 +already running.  The parameters returned are the VM's handle, and the
    1.67  expected and actual VM state at the time of the call.
    1.68  
    1.69  \vspace{0.3cm}