diff options
author | Ewan Mellor <ewan@xensource.com> | 2007-04-09 17:09:21 +0100 |
---|---|---|
committer | Ewan Mellor <ewan@xensource.com> | 2007-04-09 17:09:21 +0100 |
commit | 6492f2ffbf3fadb112a5e819c1afb56cd258893c (patch) | |
tree | 23acde499a940cb3a4597adfabf64a7687b6fa8c /docs/xen-api | |
parent | 668fbded84ff31d548ae5e84419b2acab88600e2 (diff) | |
download | xen-6492f2ffbf3fadb112a5e819c1afb56cd258893c.tar.gz xen-6492f2ffbf3fadb112a5e819c1afb56cd258893c.tar.bz2 xen-6492f2ffbf3fadb112a5e819c1afb56cd258893c.zip |
Added documentation, C bindings, and a test for VM_metrics.{start_time,
VCPUs_CPU,VCPUs_params}.
Changed VM_metrics.start_time to be a DateTime, not an integer.
Signed-off-by: Ewan Mellor <ewan@xensource.com>
Diffstat (limited to 'docs/xen-api')
-rw-r--r-- | docs/xen-api/xenapi-datamodel.tex | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/docs/xen-api/xenapi-datamodel.tex b/docs/xen-api/xenapi-datamodel.tex index d2a97b5848..b2784e234c 100644 --- a/docs/xen-api/xenapi-datamodel.tex +++ b/docs/xen-api/xenapi-datamodel.tex @@ -4107,6 +4107,9 @@ $\mathit{RO}_\mathit{run}$ & {\tt uuid} & string & unique identifier/object ref $\mathit{RO}_\mathit{run}$ & {\tt memory/actual} & int & Guest's actual memory (bytes) \\ $\mathit{RO}_\mathit{run}$ & {\tt VCPUs/number} & int & Current number of VCPUs \\ $\mathit{RO}_\mathit{run}$ & {\tt VCPUs/utilisation} & (int $\rightarrow$ float) Map & Utilisation for all of guest's current VCPUs \\ +$\mathit{RO}_\mathit{run}$ & {\tt VCPUs/CPU} & (int $\rightarrow$ int) Map & VCPU to PCPU map \\ +$\mathit{RO}_\mathit{run}$ & {\tt VCPUs/params} & (string $\rightarrow$ string) Map & The live equivalent to VM.VCPUs\_params \\ +$\mathit{RO}_\mathit{run}$ & {\tt start\_time} & datetime & Time at which this VM was last booted \\ $\mathit{RO}_\mathit{run}$ & {\tt last\_updated} & datetime & Time at which this information was last updated \\ \hline \end{longtable} @@ -4260,6 +4263,102 @@ value of the field \vspace{0.3cm} \vspace{0.3cm} \vspace{0.3cm} +\subsubsection{RPC name:~get\_VCPUs\_CPU} + +{\bf Overview:} +Get the VCPUs/CPU field of the given VM\_metrics. + + \noindent {\bf Signature:} +\begin{verbatim} ((int -> int) Map) get_VCPUs_CPU (session_id s, VM_metrics ref self)\end{verbatim} + + +\noindent{\bf Arguments:} + + +\vspace{0.3cm} +\begin{tabular}{|c|c|p{7cm}|} + \hline +{\bf type} & {\bf name} & {\bf description} \\ \hline +{\tt VM\_metrics ref } & self & reference to the object \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +(int $\rightarrow$ int) Map +} + + +value of the field +\vspace{0.3cm} +\vspace{0.3cm} +\vspace{0.3cm} +\subsubsection{RPC name:~get\_VCPUs\_params} + +{\bf Overview:} +Get the VCPUs/params field of the given VM\_metrics. + + \noindent {\bf Signature:} +\begin{verbatim} ((string -> string) Map) get_VCPUs_params (session_id s, VM_metrics ref self)\end{verbatim} + + +\noindent{\bf Arguments:} + + +\vspace{0.3cm} +\begin{tabular}{|c|c|p{7cm}|} + \hline +{\bf type} & {\bf name} & {\bf description} \\ \hline +{\tt VM\_metrics ref } & self & reference to the object \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +(string $\rightarrow$ string) Map +} + + +value of the field +\vspace{0.3cm} +\vspace{0.3cm} +\vspace{0.3cm} +\subsubsection{RPC name:~get\_start\_time} + +{\bf Overview:} +Get the start\_time field of the given VM\_metrics. + + \noindent {\bf Signature:} +\begin{verbatim} datetime get_start_time (session_id s, VM_metrics ref self)\end{verbatim} + + +\noindent{\bf Arguments:} + + +\vspace{0.3cm} +\begin{tabular}{|c|c|p{7cm}|} + \hline +{\bf type} & {\bf name} & {\bf description} \\ \hline +{\tt VM\_metrics ref } & self & reference to the object \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +datetime +} + + +value of the field +\vspace{0.3cm} +\vspace{0.3cm} +\vspace{0.3cm} \subsubsection{RPC name:~get\_last\_updated} {\bf Overview:} |