ia64/xen-unstable

changeset 17485:3ecc9ab1f5df

docs: update xen-apic docs

Added undocumented fields and methods for default_netmask and
default_gateway to the Network class. Remove an unimplemented method
from the XSPolicy class and remove the 'optional' from 'oldlabel'
parameters.

Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
author Keir Fraser <keir.fraser@citrix.com>
date Fri Apr 18 11:10:17 2008 +0100 (2008-04-18)
parents 7683bb98d4e3
children e823b22c6017
files docs/xen-api/revision-history.tex docs/xen-api/xenapi-coversheet.tex docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/revision-history.tex	Fri Apr 18 11:08:10 2008 +0100
     1.2 +++ b/docs/xen-api/revision-history.tex	Fri Apr 18 11:10:17 2008 +0100
     1.3 @@ -37,5 +37,15 @@
     1.4      \end{flushleft}
     1.5     \end{minipage}\\
     1.6    \hline
     1.7 +  1.0.5 & 17th Apr. 08 & S. Berger &
     1.8 +   \begin{minipage}[t]{7cm}
     1.9 +    \begin{flushleft}
    1.10 +     Added undocumented fields and methods for default\_netmask and
    1.11 +     default\_gateway to the Network class. Removed an unimplemented
    1.12 +     method from the XSPolicy class and removed the 'optional' from
    1.13 +     'oldlabel' parameters.
    1.14 +    \end{flushleft}
    1.15 +   \end{minipage}\\
    1.16 +  \hline
    1.17   \end{tabular}
    1.18  \end{center}
     2.1 --- a/docs/xen-api/xenapi-coversheet.tex	Fri Apr 18 11:08:10 2008 +0100
     2.2 +++ b/docs/xen-api/xenapi-coversheet.tex	Fri Apr 18 11:10:17 2008 +0100
     2.3 @@ -22,7 +22,7 @@
     2.4  \newcommand{\releasestatement}{Stable Release}
     2.5  
     2.6  %% Document revision
     2.7 -\newcommand{\revstring}{API Revision 1.0.4}
     2.8 +\newcommand{\revstring}{API Revision 1.0.5}
     2.9  
    2.10  %% Document authors
    2.11  \newcommand{\docauthors}{
     3.1 --- a/docs/xen-api/xenapi-datamodel.tex	Fri Apr 18 11:08:10 2008 +0100
     3.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Fri Apr 18 11:10:17 2008 +0100
     3.3 @@ -4467,7 +4467,7 @@ security_label, string old_label)\end{ve
     3.4  {\bf type} & {\bf name} & {\bf description} \\ \hline
     3.5  {\tt VM ref } & self & reference to the object \\ \hline
     3.6  {\tt string } & security\_label & security label for the VM \\ \hline
     3.7 -{\tt string } & old\_label & Optional label value that the security label \\
     3.8 +{\tt string } & old\_label & Label value that the security label \\
     3.9  & & must currently have for the change to succeed.\\ \hline
    3.10  
    3.11  \end{tabular}
    3.12 @@ -7619,6 +7619,8 @@ Quals & Field & Type & Description \\
    3.13  $\mathit{RW}$ &  {\tt name/description} & string & a notes field containg human-readable description \\
    3.14  $\mathit{RO}_\mathit{run}$ &  {\tt VIFs} & (VIF ref) Set & list of connected vifs \\
    3.15  $\mathit{RO}_\mathit{run}$ &  {\tt PIFs} & (PIF ref) Set & list of connected pifs \\
    3.16 +$\mathit{RW}$ &  {\tt default\_gateway} & string & default gateway \\
    3.17 +$\mathit{RW}$ &  {\tt default\_netmask} & string & default netmask \\
    3.18  $\mathit{RW}$ &  {\tt other\_config} & (string $\rightarrow$ string) Map & additional configuration \\
    3.19  \hline
    3.20  \end{longtable}
    3.21 @@ -7872,6 +7874,138 @@ value of the field
    3.22  \vspace{0.3cm}
    3.23  \vspace{0.3cm}
    3.24  \vspace{0.3cm}
    3.25 +\subsubsection{RPC name:~get\_default\_gateway}
    3.26 +
    3.27 +{\bf Overview:} 
    3.28 +Get the default\_gateway field of the given network.
    3.29 +
    3.30 + \noindent {\bf Signature:} 
    3.31 +\begin{verbatim} string get_default_gateway (session_id s, network ref self)\end{verbatim}
    3.32 +
    3.33 +
    3.34 +\noindent{\bf Arguments:}
    3.35 +
    3.36 + 
    3.37 +\vspace{0.3cm}
    3.38 +\begin{tabular}{|c|c|p{7cm}|}
    3.39 + \hline
    3.40 +{\bf type} & {\bf name} & {\bf description} \\ \hline
    3.41 +{\tt network ref } & self & reference to the object \\ \hline 
    3.42 +
    3.43 +\end{tabular}
    3.44 +
    3.45 +\vspace{0.3cm}
    3.46 +
    3.47 + \noindent {\bf Return Type:} 
    3.48 +{\tt 
    3.49 +string
    3.50 +}
    3.51 +
    3.52 +
    3.53 +value of the field
    3.54 +\vspace{0.3cm}
    3.55 +\vspace{0.3cm}
    3.56 +\vspace{0.3cm}
    3.57 +\subsubsection{RPC name:~set\_default\_gateway}
    3.58 +
    3.59 +{\bf Overview:} 
    3.60 +Set the default\_gateway field of the given network.
    3.61 +
    3.62 + \noindent {\bf Signature:} 
    3.63 +\begin{verbatim} void set_default_gateway (session_id s, network ref self, string value)\end{verbatim}
    3.64 +
    3.65 +
    3.66 +\noindent{\bf Arguments:}
    3.67 +
    3.68 + 
    3.69 +\vspace{0.3cm}
    3.70 +\begin{tabular}{|c|c|p{7cm}|}
    3.71 + \hline
    3.72 +{\bf type} & {\bf name} & {\bf description} \\ \hline
    3.73 +{\tt network ref } & self & reference to the object \\ \hline 
    3.74 +
    3.75 +{\tt string } & value & New value to set \\ \hline 
    3.76 +
    3.77 +\end{tabular}
    3.78 +
    3.79 +\vspace{0.3cm}
    3.80 +
    3.81 + \noindent {\bf Return Type:} 
    3.82 +{\tt 
    3.83 +void
    3.84 +}
    3.85 +
    3.86 +
    3.87 +
    3.88 +\vspace{0.3cm}
    3.89 +\vspace{0.3cm}
    3.90 +\vspace{0.3cm}
    3.91 +\subsubsection{RPC name:~get\_default\_netmask}
    3.92 +
    3.93 +{\bf Overview:} 
    3.94 +Get the default\_netmask field of the given network.
    3.95 +
    3.96 + \noindent {\bf Signature:} 
    3.97 +\begin{verbatim} string get_default_netmask (session_id s, network ref self)\end{verbatim}
    3.98 +
    3.99 +
   3.100 +\noindent{\bf Arguments:}
   3.101 +
   3.102 + 
   3.103 +\vspace{0.3cm}
   3.104 +\begin{tabular}{|c|c|p{7cm}|}
   3.105 + \hline
   3.106 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   3.107 +{\tt network ref } & self & reference to the object \\ \hline 
   3.108 +
   3.109 +\end{tabular}
   3.110 +
   3.111 +\vspace{0.3cm}
   3.112 +
   3.113 + \noindent {\bf Return Type:} 
   3.114 +{\tt 
   3.115 +string
   3.116 +}
   3.117 +
   3.118 +
   3.119 +value of the field
   3.120 +\vspace{0.3cm}
   3.121 +\vspace{0.3cm}
   3.122 +\vspace{0.3cm}
   3.123 +\subsubsection{RPC name:~set\_default\_netmask}
   3.124 +
   3.125 +{\bf Overview:} 
   3.126 +Set the default\_netmask field of the given network.
   3.127 +
   3.128 + \noindent {\bf Signature:} 
   3.129 +\begin{verbatim} void set_default_netmask (session_id s, network ref self, string value)\end{verbatim}
   3.130 +
   3.131 +
   3.132 +\noindent{\bf Arguments:}
   3.133 +
   3.134 + 
   3.135 +\vspace{0.3cm}
   3.136 +\begin{tabular}{|c|c|p{7cm}|}
   3.137 + \hline
   3.138 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   3.139 +{\tt network ref } & self & reference to the object \\ \hline 
   3.140 +
   3.141 +{\tt string } & value & New value to set \\ \hline 
   3.142 +
   3.143 +\end{tabular}
   3.144 +
   3.145 +\vspace{0.3cm}
   3.146 +
   3.147 + \noindent {\bf Return Type:} 
   3.148 +{\tt 
   3.149 +void
   3.150 +}
   3.151 +
   3.152 +
   3.153 +
   3.154 +\vspace{0.3cm}
   3.155 +\vspace{0.3cm}
   3.156 +\vspace{0.3cm}
   3.157  \subsubsection{RPC name:~get\_other\_config}
   3.158  
   3.159  {\bf Overview:} 
   3.160 @@ -8999,7 +9133,7 @@ security_label, string old_label)\end{ve
   3.161  {\tt VIF ref } & self & reference to the object \\ \hline
   3.162  
   3.163  {\tt string } & security\_label & New value of the security label \\ \hline
   3.164 -{\tt string } & old\_label & Optional label value that the security label \\
   3.165 +{\tt string } & old\_label & Label value that the security label \\
   3.166  & & must currently have for the change to succeed.\\ \hline
   3.167  \end{tabular}
   3.168  
   3.169 @@ -11504,7 +11638,7 @@ security_label, string old_label)\end{ve
   3.170  {\tt VDI ref } & self & reference to the object \\ \hline
   3.171  
   3.172  {\tt string } & security\_label & New value of the security label \\ \hline
   3.173 -{\tt string } & old\_label & Optional label value that the security label \\
   3.174 +{\tt string } & old\_label & Label value that the security label \\
   3.175  & & must currently have for the change to succeed.\\ \hline
   3.176  \end{tabular}
   3.177  
   3.178 @@ -14898,46 +15032,6 @@ The label of the given resource.
   3.179  \vspace{0.3cm}
   3.180  \vspace{0.3cm}
   3.181  \vspace{0.3cm}
   3.182 -\subsubsection{RPC name:~activate\_xspolicy}
   3.183 -
   3.184 -{\bf Overview:}
   3.185 -Load the referenced policy into the hypervisor.
   3.186 -
   3.187 - \noindent {\bf Signature:}
   3.188 -\begin{verbatim} xs_instantiationflags activate_xspolicy (session_id s, xs_ref xspolicy,
   3.189 -xs_instantiationflags flags)\end{verbatim}
   3.190 -
   3.191 -
   3.192 -\noindent{\bf Arguments:}
   3.193 -
   3.194 -
   3.195 -\vspace{0.3cm}
   3.196 -\begin{tabular}{|c|c|p{7cm}|}
   3.197 - \hline
   3.198 -{\bf type} & {\bf name} & {\bf description} \\ \hline
   3.199 -{\tt xs ref } & self & reference to the object \\ \hline
   3.200 -{\tt xs\_instantiationflags } & flags & flags to activate on a policy; flags
   3.201 -  can only be set \\ \hline
   3.202 -
   3.203 -\end{tabular}
   3.204 -
   3.205 -\vspace{0.3cm}
   3.206 -
   3.207 -
   3.208 - \noindent {\bf Return Type:}
   3.209 -{\tt
   3.210 -xs\_instantiationflags
   3.211 -}
   3.212 -
   3.213 -
   3.214 -Currently active instantiation flags.
   3.215 -\vspace{0.3cm}
   3.216 -
   3.217 -\noindent{\bf Possible Error Codes:} {\tt SECURITY\_ERROR}
   3.218 -
   3.219 -\vspace{0.3cm}
   3.220 -\vspace{0.3cm}
   3.221 -\vspace{0.3cm}
   3.222  \subsubsection{RPC name:~can\_run}
   3.223  
   3.224  {\bf Overview:}