From 9853a49dd9feb3180ecfa9b9b5c3339af8f3442c Mon Sep 17 00:00:00 2001 From: Ewan Mellor Date: Tue, 10 Apr 2007 17:29:16 +0100 Subject: Added docs and bindings for VM.{send_trigger,send_sysrq}. Signed-off-by: Ewan Mellor --- docs/xen-api/xenapi-datamodel.tex | 75 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) (limited to 'docs/xen-api') diff --git a/docs/xen-api/xenapi-datamodel.tex b/docs/xen-api/xenapi-datamodel.tex index b2784e234c..d152bcc469 100644 --- a/docs/xen-api/xenapi-datamodel.tex +++ b/docs/xen-api/xenapi-datamodel.tex @@ -1558,6 +1558,81 @@ void \vspace{0.3cm} \vspace{0.3cm} \vspace{0.3cm} +\subsubsection{RPC name:~send\_sysrq} + +{\bf Overview:} +Send the given key as a sysrq to this VM. The key is specified as a single +character (a String of length 1). This can only be called when the +specified VM is in the Running state. + + \noindent {\bf Signature:} +\begin{verbatim} void send_sysrq (session_id s, VM ref vm, string key)\end{verbatim} + + +\noindent{\bf Arguments:} + + +\vspace{0.3cm} +\begin{tabular}{|c|c|p{7cm}|} + \hline +{\bf type} & {\bf name} & {\bf description} \\ \hline +{\tt VM ref } & vm & The VM \\ \hline + +{\tt string } & key & The key to send \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +void +} + + + +\vspace{0.3cm} + +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE} + +\vspace{0.6cm} +\subsubsection{RPC name:~send\_trigger} + +{\bf Overview:} +Send the named trigger to this VM. This can only be called when the +specified VM is in the Running state. + + \noindent {\bf Signature:} +\begin{verbatim} void send_trigger (session_id s, VM ref vm, string trigger)\end{verbatim} + + +\noindent{\bf Arguments:} + + +\vspace{0.3cm} +\begin{tabular}{|c|c|p{7cm}|} + \hline +{\bf type} & {\bf name} & {\bf description} \\ \hline +{\tt VM ref } & vm & The VM \\ \hline + +{\tt string } & trigger & The trigger to send \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +void +} + + + +\vspace{0.3cm} + +\noindent{\bf Possible Error Codes:} {\tt VM\_BAD\_POWER\_STATE} + +\vspace{0.6cm} \subsubsection{RPC name:~get\_all} {\bf Overview:} -- cgit v1.2.3