ia64/xen-unstable

changeset 17358:76c4af29842f

docs: Documentation for XSPolicy.can_run command

Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
author Keir Fraser <keir.fraser@citrix.com>
date Tue Apr 01 10:05:52 2008 +0100 (2008-04-01)
parents da9bd2e81288
children 05ac689a9473
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	Mon Mar 31 18:05:18 2008 +0100
     1.2 +++ b/docs/xen-api/revision-history.tex	Tue Apr 01 10:05:52 2008 +0100
     1.3 @@ -23,12 +23,19 @@
     1.4      \end{flushleft}
     1.5     \end{minipage}\\
     1.6    \hline
     1.7 -  1.0.2 & 11th Feb. 08 & S. Berger &
     1.8 +  1.0.3 & 11th Feb. 08 & S. Berger &
     1.9     \begin{minipage}[t]{7cm}
    1.10      \begin{flushleft}
    1.11       Added table of contents and hyperlink cross reference.
    1.12      \end{flushleft}
    1.13     \end{minipage}\\
    1.14    \hline
    1.15 +  1.0.4 & 23rd March 08 & S. Berger &
    1.16 +   \begin{minipage}[t]{7cm}
    1.17 +    \begin{flushleft}
    1.18 +     Added XSPolicy.can\_run
    1.19 +    \end{flushleft}
    1.20 +   \end{minipage}\\
    1.21 +  \hline
    1.22   \end{tabular}
    1.23 -\end{center}
    1.24 \ No newline at end of file
    1.25 +\end{center}
     2.1 --- a/docs/xen-api/xenapi-coversheet.tex	Mon Mar 31 18:05:18 2008 +0100
     2.2 +++ b/docs/xen-api/xenapi-coversheet.tex	Tue Apr 01 10:05:52 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.2}
     2.8 +\newcommand{\revstring}{API Revision 1.0.4}
     2.9  
    2.10  %% Document authors
    2.11  \newcommand{\docauthors}{
     3.1 --- a/docs/xen-api/xenapi-datamodel.tex	Mon Mar 31 18:05:18 2008 +0100
     3.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Tue Apr 01 10:05:52 2008 +0100
     3.3 @@ -14938,6 +14938,41 @@ Currently active instantiation flags.
     3.4  \vspace{0.3cm}
     3.5  \vspace{0.3cm}
     3.6  \vspace{0.3cm}
     3.7 +\subsubsection{RPC name:~can\_run}
     3.8 +
     3.9 +{\bf Overview:}
    3.10 +Check whether a VM with the given security label could run on the system.
    3.11 +
    3.12 + \noindent {\bf Signature:}
    3.13 +\begin{verbatim} int can_run (session_id s, string security_label)\end{verbatim}
    3.14 +
    3.15 +
    3.16 +\noindent{\bf Arguments:}
    3.17 +
    3.18 +
    3.19 +\vspace{0.3cm}
    3.20 +\begin{tabular}{|c|c|p{7cm}|}
    3.21 + \hline
    3.22 +{\bf type} & {\bf name} & {\bf description} \\ \hline
    3.23 +{\tt string } & security_label & reference to the object \\ \hline
    3.24 +
    3.25 +\end{tabular}
    3.26 +
    3.27 +\vspace{0.3cm}
    3.28 +
    3.29 + \noindent {\bf Return Type:}
    3.30 +{\tt
    3.31 +int
    3.32 +}
    3.33 +
    3.34 +
    3.35 +Error code indicating whether a VM with the given security label could run.
    3.36 +If zero, it can run.
    3.37 +
    3.38 +\vspace{0.3cm}
    3.39 +
    3.40 +\noindent{\bf Possible Error Codes:} {\tt SECURITY\_ERROR}
    3.41 +
    3.42  \subsubsection{RPC name:~get\_all}
    3.43  
    3.44  {\bf Overview:}