ia64/xen-unstable
changeset 13700:965cdfff68b0
Minor tidy-up.
Signed-off-by: Ewan Mellor <ewan@xensource.com>
Signed-off-by: Ewan Mellor <ewan@xensource.com>
author | Ewan Mellor <ewan@xensource.com> |
---|---|
date | Sat Jan 27 15:02:00 2007 +0000 (2007-01-27) |
parents | 6e3decbd3e56 |
children | ea3c75204555 |
files | docs/xen-api/xenapi-datamodel.tex |
line diff
1.1 --- a/docs/xen-api/xenapi-datamodel.tex Tue Jan 30 00:52:51 2007 +0000 1.2 +++ b/docs/xen-api/xenapi-datamodel.tex Sat Jan 27 15:02:00 2007 +0000 1.3 @@ -9642,134 +9642,6 @@ Quals & Field & Type & Description \\ 1.4 \hline 1.5 \end{longtable} 1.6 \subsection{Additional RPCs associated with class: console} 1.7 -\subsubsection{RPC name:~get\_record} 1.8 - 1.9 -{\bf Overview:} 1.10 -Get the current state of the given console. 1.11 - 1.12 - \noindent {\bf Signature:} 1.13 -\begin{verbatim} (console record) get_record (session_id s, console ref self)\end{verbatim} 1.14 - 1.15 - 1.16 -\noindent{\bf Arguments:} 1.17 - 1.18 - 1.19 -\vspace{0.3cm} 1.20 -\begin{tabular}{|c|c|p{7cm}|} 1.21 - \hline 1.22 -{\bf type} & {\bf name} & {\bf description} \\ \hline 1.23 -{\tt console ref } & self & reference to the object \\ \hline 1.24 - 1.25 -\end{tabular} 1.26 - 1.27 -\vspace{0.3cm} 1.28 - 1.29 - \noindent {\bf Return Type:} 1.30 -{\tt 1.31 -console record 1.32 -} 1.33 - 1.34 - 1.35 -all fields from the object 1.36 -\vspace{0.3cm} 1.37 -\vspace{0.3cm} 1.38 -\vspace{0.3cm} 1.39 -\subsubsection{RPC name:~get\_by\_uuid} 1.40 - 1.41 -{\bf Overview:} 1.42 -Get a reference to the object with the specified UUID. 1.43 - 1.44 - \noindent {\bf Signature:} 1.45 -\begin{verbatim} (console ref) get_by_uuid (session_id s, string uuid)\end{verbatim} 1.46 - 1.47 - 1.48 -\noindent{\bf Arguments:} 1.49 - 1.50 - 1.51 -\vspace{0.3cm} 1.52 -\begin{tabular}{|c|c|p{7cm}|} 1.53 - \hline 1.54 -{\bf type} & {\bf name} & {\bf description} \\ \hline 1.55 -{\tt string } & uuid & UUID of object to return \\ \hline 1.56 - 1.57 -\end{tabular} 1.58 - 1.59 -\vspace{0.3cm} 1.60 - 1.61 - \noindent {\bf Return Type:} 1.62 -{\tt 1.63 -console ref 1.64 -} 1.65 - 1.66 - 1.67 -reference to the object 1.68 -\vspace{0.3cm} 1.69 -\vspace{0.3cm} 1.70 -\vspace{0.3cm} 1.71 -\subsubsection{RPC name:~create} 1.72 - 1.73 -{\bf Overview:} 1.74 -Create a new console instance, and return its handle. 1.75 - 1.76 - \noindent {\bf Signature:} 1.77 -\begin{verbatim} (console ref) create (session_id s, console record args)\end{verbatim} 1.78 - 1.79 - 1.80 -\noindent{\bf Arguments:} 1.81 - 1.82 - 1.83 -\vspace{0.3cm} 1.84 -\begin{tabular}{|c|c|p{7cm}|} 1.85 - \hline 1.86 -{\bf type} & {\bf name} & {\bf description} \\ \hline 1.87 -{\tt console record } & args & All constructor arguments \\ \hline 1.88 - 1.89 -\end{tabular} 1.90 - 1.91 -\vspace{0.3cm} 1.92 - 1.93 - \noindent {\bf Return Type:} 1.94 -{\tt 1.95 -console ref 1.96 -} 1.97 - 1.98 - 1.99 -reference to the newly created object 1.100 -\vspace{0.3cm} 1.101 -\vspace{0.3cm} 1.102 -\vspace{0.3cm} 1.103 -\subsubsection{RPC name:~destroy} 1.104 - 1.105 -{\bf Overview:} 1.106 -Destroy the specified console instance. 1.107 - 1.108 - \noindent {\bf Signature:} 1.109 -\begin{verbatim} void destroy (session_id s, console ref self)\end{verbatim} 1.110 - 1.111 - 1.112 -\noindent{\bf Arguments:} 1.113 - 1.114 - 1.115 -\vspace{0.3cm} 1.116 -\begin{tabular}{|c|c|p{7cm}|} 1.117 - \hline 1.118 -{\bf type} & {\bf name} & {\bf description} \\ \hline 1.119 -{\tt console ref } & self & reference to the object \\ \hline 1.120 - 1.121 -\end{tabular} 1.122 - 1.123 -\vspace{0.3cm} 1.124 - 1.125 - \noindent {\bf Return Type:} 1.126 -{\tt 1.127 -void 1.128 -} 1.129 - 1.130 - 1.131 - 1.132 -\vspace{0.3cm} 1.133 -\vspace{0.3cm} 1.134 -\vspace{0.3cm} 1.135 \subsubsection{RPC name:~get\_uuid} 1.136 1.137 {\bf Overview:} 1.138 @@ -9898,6 +9770,134 @@ value of the field 1.139 \vspace{0.3cm} 1.140 \vspace{0.3cm} 1.141 \vspace{0.3cm} 1.142 +\subsubsection{RPC name:~create} 1.143 + 1.144 +{\bf Overview:} 1.145 +Create a new console instance, and return its handle. 1.146 + 1.147 + \noindent {\bf Signature:} 1.148 +\begin{verbatim} (console ref) create (session_id s, console record args)\end{verbatim} 1.149 + 1.150 + 1.151 +\noindent{\bf Arguments:} 1.152 + 1.153 + 1.154 +\vspace{0.3cm} 1.155 +\begin{tabular}{|c|c|p{7cm}|} 1.156 + \hline 1.157 +{\bf type} & {\bf name} & {\bf description} \\ \hline 1.158 +{\tt console record } & args & All constructor arguments \\ \hline 1.159 + 1.160 +\end{tabular} 1.161 + 1.162 +\vspace{0.3cm} 1.163 + 1.164 + \noindent {\bf Return Type:} 1.165 +{\tt 1.166 +console ref 1.167 +} 1.168 + 1.169 + 1.170 +reference to the newly created object 1.171 +\vspace{0.3cm} 1.172 +\vspace{0.3cm} 1.173 +\vspace{0.3cm} 1.174 +\subsubsection{RPC name:~destroy} 1.175 + 1.176 +{\bf Overview:} 1.177 +Destroy the specified console instance. 1.178 + 1.179 + \noindent {\bf Signature:} 1.180 +\begin{verbatim} void destroy (session_id s, console ref self)\end{verbatim} 1.181 + 1.182 + 1.183 +\noindent{\bf Arguments:} 1.184 + 1.185 + 1.186 +\vspace{0.3cm} 1.187 +\begin{tabular}{|c|c|p{7cm}|} 1.188 + \hline 1.189 +{\bf type} & {\bf name} & {\bf description} \\ \hline 1.190 +{\tt console ref } & self & reference to the object \\ \hline 1.191 + 1.192 +\end{tabular} 1.193 + 1.194 +\vspace{0.3cm} 1.195 + 1.196 + \noindent {\bf Return Type:} 1.197 +{\tt 1.198 +void 1.199 +} 1.200 + 1.201 + 1.202 + 1.203 +\vspace{0.3cm} 1.204 +\vspace{0.3cm} 1.205 +\vspace{0.3cm} 1.206 +\subsubsection{RPC name:~get\_by\_uuid} 1.207 + 1.208 +{\bf Overview:} 1.209 +Get a reference to the console instance with the specified UUID. 1.210 + 1.211 + \noindent {\bf Signature:} 1.212 +\begin{verbatim} (console ref) get_by_uuid (session_id s, string uuid)\end{verbatim} 1.213 + 1.214 + 1.215 +\noindent{\bf Arguments:} 1.216 + 1.217 + 1.218 +\vspace{0.3cm} 1.219 +\begin{tabular}{|c|c|p{7cm}|} 1.220 + \hline 1.221 +{\bf type} & {\bf name} & {\bf description} \\ \hline 1.222 +{\tt string } & uuid & UUID of object to return \\ \hline 1.223 + 1.224 +\end{tabular} 1.225 + 1.226 +\vspace{0.3cm} 1.227 + 1.228 + \noindent {\bf Return Type:} 1.229 +{\tt 1.230 +console ref 1.231 +} 1.232 + 1.233 + 1.234 +reference to the object 1.235 +\vspace{0.3cm} 1.236 +\vspace{0.3cm} 1.237 +\vspace{0.3cm} 1.238 +\subsubsection{RPC name:~get\_record} 1.239 + 1.240 +{\bf Overview:} 1.241 +Get a record containing the current state of the given console. 1.242 + 1.243 + \noindent {\bf Signature:} 1.244 +\begin{verbatim} (console record) get_record (session_id s, console ref self)\end{verbatim} 1.245 + 1.246 + 1.247 +\noindent{\bf Arguments:} 1.248 + 1.249 + 1.250 +\vspace{0.3cm} 1.251 +\begin{tabular}{|c|c|p{7cm}|} 1.252 + \hline 1.253 +{\bf type} & {\bf name} & {\bf description} \\ \hline 1.254 +{\tt console ref } & self & reference to the object \\ \hline 1.255 + 1.256 +\end{tabular} 1.257 + 1.258 +\vspace{0.3cm} 1.259 + 1.260 + \noindent {\bf Return Type:} 1.261 +{\tt 1.262 +console record 1.263 +} 1.264 + 1.265 + 1.266 +all fields from the object 1.267 +\vspace{0.3cm} 1.268 +\vspace{0.3cm} 1.269 +\vspace{0.3cm} 1.270 1.271 \vspace{1cm} 1.272 \newpage