diff options
author | Keir Fraser <keir.fraser@citrix.com> | 2008-04-18 11:10:17 +0100 |
---|---|---|
committer | Keir Fraser <keir.fraser@citrix.com> | 2008-04-18 11:10:17 +0100 |
commit | 93f92fcf9c8ef07c4e8faff20f1cbfedc5296d3b (patch) | |
tree | 6216a67ad909f29f9ff6a23b1a5fd5f4a86f96c7 /docs | |
parent | 4b9fd1bad112427d74b491342f238dc53300b36e (diff) | |
download | xen-93f92fcf9c8ef07c4e8faff20f1cbfedc5296d3b.tar.gz xen-93f92fcf9c8ef07c4e8faff20f1cbfedc5296d3b.tar.bz2 xen-93f92fcf9c8ef07c4e8faff20f1cbfedc5296d3b.zip |
docs: update xen-apic docs
Added undocumented fields and methods for default_netmask and
default_gateway to the Network class. Remove an unimplemented method
from the XSPolicy class and remove the 'optional' from 'oldlabel'
parameters.
Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/xen-api/revision-history.tex | 10 | ||||
-rw-r--r-- | docs/xen-api/xenapi-coversheet.tex | 2 | ||||
-rw-r--r-- | docs/xen-api/xenapi-datamodel.tex | 180 |
3 files changed, 148 insertions, 44 deletions
diff --git a/docs/xen-api/revision-history.tex b/docs/xen-api/revision-history.tex index cf4a211f62..21ec02c45f 100644 --- a/docs/xen-api/revision-history.tex +++ b/docs/xen-api/revision-history.tex @@ -37,5 +37,15 @@ \end{flushleft} \end{minipage}\\ \hline + 1.0.5 & 17th Apr. 08 & S. Berger & + \begin{minipage}[t]{7cm} + \begin{flushleft} + Added undocumented fields and methods for default\_netmask and + default\_gateway to the Network class. Removed an unimplemented + method from the XSPolicy class and removed the 'optional' from + 'oldlabel' parameters. + \end{flushleft} + \end{minipage}\\ + \hline \end{tabular} \end{center} diff --git a/docs/xen-api/xenapi-coversheet.tex b/docs/xen-api/xenapi-coversheet.tex index ab6f0e3eff..cd71f80ff9 100644 --- a/docs/xen-api/xenapi-coversheet.tex +++ b/docs/xen-api/xenapi-coversheet.tex @@ -22,7 +22,7 @@ \newcommand{\releasestatement}{Stable Release} %% Document revision -\newcommand{\revstring}{API Revision 1.0.4} +\newcommand{\revstring}{API Revision 1.0.5} %% Document authors \newcommand{\docauthors}{ diff --git a/docs/xen-api/xenapi-datamodel.tex b/docs/xen-api/xenapi-datamodel.tex index 04a0266550..94f5feb0d5 100644 --- a/docs/xen-api/xenapi-datamodel.tex +++ b/docs/xen-api/xenapi-datamodel.tex @@ -4467,7 +4467,7 @@ security_label, string old_label)\end{verbatim} {\bf type} & {\bf name} & {\bf description} \\ \hline {\tt VM ref } & self & reference to the object \\ \hline {\tt string } & security\_label & security label for the VM \\ \hline -{\tt string } & old\_label & Optional label value that the security label \\ +{\tt string } & old\_label & Label value that the security label \\ & & must currently have for the change to succeed.\\ \hline \end{tabular} @@ -7619,6 +7619,8 @@ $\mathit{RW}$ & {\tt name/label} & string & a human-readable name \\ $\mathit{RW}$ & {\tt name/description} & string & a notes field containg human-readable description \\ $\mathit{RO}_\mathit{run}$ & {\tt VIFs} & (VIF ref) Set & list of connected vifs \\ $\mathit{RO}_\mathit{run}$ & {\tt PIFs} & (PIF ref) Set & list of connected pifs \\ +$\mathit{RW}$ & {\tt default\_gateway} & string & default gateway \\ +$\mathit{RW}$ & {\tt default\_netmask} & string & default netmask \\ $\mathit{RW}$ & {\tt other\_config} & (string $\rightarrow$ string) Map & additional configuration \\ \hline \end{longtable} @@ -7872,6 +7874,138 @@ value of the field \vspace{0.3cm} \vspace{0.3cm} \vspace{0.3cm} +\subsubsection{RPC name:~get\_default\_gateway} + +{\bf Overview:} +Get the default\_gateway field of the given network. + + \noindent {\bf Signature:} +\begin{verbatim} string get_default_gateway (session_id s, network 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 network ref } & self & reference to the object \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +string +} + + +value of the field +\vspace{0.3cm} +\vspace{0.3cm} +\vspace{0.3cm} +\subsubsection{RPC name:~set\_default\_gateway} + +{\bf Overview:} +Set the default\_gateway field of the given network. + + \noindent {\bf Signature:} +\begin{verbatim} void set_default_gateway (session_id s, network ref self, string value)\end{verbatim} + + +\noindent{\bf Arguments:} + + +\vspace{0.3cm} +\begin{tabular}{|c|c|p{7cm}|} + \hline +{\bf type} & {\bf name} & {\bf description} \\ \hline +{\tt network ref } & self & reference to the object \\ \hline + +{\tt string } & value & New value to set \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +void +} + + + +\vspace{0.3cm} +\vspace{0.3cm} +\vspace{0.3cm} +\subsubsection{RPC name:~get\_default\_netmask} + +{\bf Overview:} +Get the default\_netmask field of the given network. + + \noindent {\bf Signature:} +\begin{verbatim} string get_default_netmask (session_id s, network 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 network ref } & self & reference to the object \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +string +} + + +value of the field +\vspace{0.3cm} +\vspace{0.3cm} +\vspace{0.3cm} +\subsubsection{RPC name:~set\_default\_netmask} + +{\bf Overview:} +Set the default\_netmask field of the given network. + + \noindent {\bf Signature:} +\begin{verbatim} void set_default_netmask (session_id s, network ref self, string value)\end{verbatim} + + +\noindent{\bf Arguments:} + + +\vspace{0.3cm} +\begin{tabular}{|c|c|p{7cm}|} + \hline +{\bf type} & {\bf name} & {\bf description} \\ \hline +{\tt network ref } & self & reference to the object \\ \hline + +{\tt string } & value & New value to set \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +void +} + + + +\vspace{0.3cm} +\vspace{0.3cm} +\vspace{0.3cm} \subsubsection{RPC name:~get\_other\_config} {\bf Overview:} @@ -8999,7 +9133,7 @@ security_label, string old_label)\end{verbatim} {\tt VIF ref } & self & reference to the object \\ \hline {\tt string } & security\_label & New value of the security label \\ \hline -{\tt string } & old\_label & Optional label value that the security label \\ +{\tt string } & old\_label & Label value that the security label \\ & & must currently have for the change to succeed.\\ \hline \end{tabular} @@ -11504,7 +11638,7 @@ security_label, string old_label)\end{verbatim} {\tt VDI ref } & self & reference to the object \\ \hline {\tt string } & security\_label & New value of the security label \\ \hline -{\tt string } & old\_label & Optional label value that the security label \\ +{\tt string } & old\_label & Label value that the security label \\ & & must currently have for the change to succeed.\\ \hline \end{tabular} @@ -14898,46 +15032,6 @@ The label of the given resource. \vspace{0.3cm} \vspace{0.3cm} \vspace{0.3cm} -\subsubsection{RPC name:~activate\_xspolicy} - -{\bf Overview:} -Load the referenced policy into the hypervisor. - - \noindent {\bf Signature:} -\begin{verbatim} xs_instantiationflags activate_xspolicy (session_id s, xs_ref xspolicy, -xs_instantiationflags flags)\end{verbatim} - - -\noindent{\bf Arguments:} - - -\vspace{0.3cm} -\begin{tabular}{|c|c|p{7cm}|} - \hline -{\bf type} & {\bf name} & {\bf description} \\ \hline -{\tt xs ref } & self & reference to the object \\ \hline -{\tt xs\_instantiationflags } & flags & flags to activate on a policy; flags - can only be set \\ \hline - -\end{tabular} - -\vspace{0.3cm} - - - \noindent {\bf Return Type:} -{\tt -xs\_instantiationflags -} - - -Currently active instantiation flags. -\vspace{0.3cm} - -\noindent{\bf Possible Error Codes:} {\tt SECURITY\_ERROR} - -\vspace{0.3cm} -\vspace{0.3cm} -\vspace{0.3cm} \subsubsection{RPC name:~can\_run} {\bf Overview:} |