diff options
author | Ewan Mellor <ewan@xensource.com> | 2007-01-30 16:09:16 +0000 |
---|---|---|
committer | Ewan Mellor <ewan@xensource.com> | 2007-01-30 16:09:16 +0000 |
commit | 77442ed1d3615d15b9cb2841e4510915d7eaee1c (patch) | |
tree | 5ba01a898040fc54a39b92468e0b0fdd67b86e87 /docs | |
parent | e9bca537abf526a0a85c843a3407088b0cab28f8 (diff) | |
download | xen-77442ed1d3615d15b9cb2841e4510915d7eaee1c.tar.gz xen-77442ed1d3615d15b9cb2841e4510915d7eaee1c.tar.bz2 xen-77442ed1d3615d15b9cb2841e4510915d7eaee1c.zip |
Added task.session field.
Fix session.get_by_uuid and get_uuid, and remove session.get_all.
Signed-off-by: Ewan Mellor <ewan@xensource.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/xen-api/xenapi-datamodel.tex | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/xen-api/xenapi-datamodel.tex b/docs/xen-api/xenapi-datamodel.tex index cde30247cd..2454b28f7a 100644 --- a/docs/xen-api/xenapi-datamodel.tex +++ b/docs/xen-api/xenapi-datamodel.tex @@ -495,6 +495,7 @@ $\mathit{RO}_\mathit{run}$ & {\tt uuid} & string & unique identifier/object ref $\mathit{RO}_\mathit{run}$ & {\tt name/label} & string & a human-readable name \\ $\mathit{RO}_\mathit{run}$ & {\tt name/description} & string & a notes field containg human-readable description \\ $\mathit{RO}_\mathit{run}$ & {\tt status} & task\_status\_type & current status of the task \\ +$\mathit{RO}_\mathit{run}$ & {\tt session} & session ref & the session that created the task \\ $\mathit{RO}_\mathit{run}$ & {\tt progress} & int & if the task is still pending, this field contains the estimated percentage complete (0-100). If task has completed (successfully or unsuccessfully) this should be 100. \\ $\mathit{RO}_\mathit{run}$ & {\tt type} & string & if the task has completed successfully, this field contains the type of the encoded result (i.e. name of the class whose reference is in the result field). Undefined otherwise. \\ $\mathit{RO}_\mathit{run}$ & {\tt result} & string & if the task has completed successfully, this field contains the result value (either Void or an object reference). Undefined otherwise. \\ @@ -691,6 +692,38 @@ value of the field \vspace{0.3cm} \vspace{0.3cm} \vspace{0.3cm} +\subsubsection{RPC name:~get\_session} + +{\bf Overview:} +Get the session field of the given task. + + \noindent {\bf Signature:} +\begin{verbatim} (session ref) get_session (session_id s, task 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 task ref } & self & reference to the object \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +session ref +} + + +value of the field +\vspace{0.3cm} +\vspace{0.3cm} +\vspace{0.3cm} \subsubsection{RPC name:~get\_progress} {\bf Overview:} |