|
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [Xen-changelog] [xen-unstable] Fix documentation so that the connection objects (PIF, VBD, and VIF) are
# HG changeset patch
# User Ewan Mellor <ewan@xxxxxxxxxxxxx>
# Date 1170082347 0
# Node ID 0a422c8c3144e3084da318a65f0b8b63a6c5f8bf
# Parent 66c2a408586359f5a2c4ec9d99ce0c74ad97fb28
Fix documentation so that the connection objects (PIF, VBD, and VIF) are
connected to their referands through StaticRO fields.
Signed-off-by: Ewan Mellor <ewan@xxxxxxxxxxxxx>
---
docs/xen-api/xenapi-datamodel.tex | 258 +++-----------------------------------
tools/libxen/include/xen_pif.h | 14 --
tools/libxen/include/xen_vbd.h | 14 --
tools/libxen/include/xen_vif.h | 14 --
tools/libxen/src/xen_pif.c | 32 ----
tools/libxen/src/xen_vbd.c | 32 ----
tools/libxen/src/xen_vif.c | 32 ----
7 files changed, 27 insertions(+), 369 deletions(-)
diff -r 66c2a4085863 -r 0a422c8c3144 docs/xen-api/xenapi-datamodel.tex
--- a/docs/xen-api/xenapi-datamodel.tex Mon Jan 29 13:18:20 2007 +0000
+++ b/docs/xen-api/xenapi-datamodel.tex Mon Jan 29 14:52:27 2007 +0000
@@ -5862,8 +5862,8 @@ Quals & Field & Type & Description \\
\hline
$\mathit{RO}_\mathit{run}$ & {\tt uuid} & string & unique identifier/object
reference \\
$\mathit{RW}$ & {\tt device} & string & name of network device as exposed to
guest e.g. eth0 \\
-$\mathit{RW}$ & {\tt network} & network ref & virtual network to which this
vif is connected \\
-$\mathit{RW}$ & {\tt VM} & VM ref & virtual machine to which this vif is
connected \\
+$\mathit{RO}_\mathit{ins}$ & {\tt network} & network ref & virtual network to
which this vif is connected \\
+$\mathit{RO}_\mathit{ins}$ & {\tt VM} & VM ref & virtual machine to which
this vif is connected \\
$\mathit{RW}$ & {\tt MAC} & string & ethernet MAC address of virtual
interface, as exposed to guest \\
$\mathit{RW}$ & {\tt MTU} & int & MTU in octets \\
$\mathit{RO}_\mathit{run}$ & {\tt io/read\_kbs} & float & Read bandwidth
(KiB/s) \\
@@ -6001,13 +6001,13 @@ value of the field
\vspace{0.3cm}
\vspace{0.3cm}
\vspace{0.3cm}
-\subsubsection{RPC name:~set\_network}
-
-{\bf Overview:}
-Set the network field of the given VIF.
-
- \noindent {\bf Signature:}
-\begin{verbatim} void set_network (session_id s, VIF ref self, network ref
value)\end{verbatim}
+\subsubsection{RPC name:~get\_VM}
+
+{\bf Overview:}
+Get the VM field of the given VIF.
+
+ \noindent {\bf Signature:}
+\begin{verbatim} (VM ref) get_VM (session_id s, VIF ref self)\end{verbatim}
\noindent{\bf Arguments:}
@@ -6019,40 +6019,6 @@ Set the network field of the given VIF.
{\bf type} & {\bf name} & {\bf description} \\ \hline
{\tt VIF ref } & self & reference to the object \\ \hline
-{\tt network ref } & 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\_VM}
-
-{\bf Overview:}
-Get the VM field of the given VIF.
-
- \noindent {\bf Signature:}
-\begin{verbatim} (VM ref) get_VM (session_id s, VIF 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 VIF ref } & self & reference to the object \\ \hline
-
\end{tabular}
\vspace{0.3cm}
@@ -6064,40 +6030,6 @@ VM ref
value of the field
-\vspace{0.3cm}
-\vspace{0.3cm}
-\vspace{0.3cm}
-\subsubsection{RPC name:~set\_VM}
-
-{\bf Overview:}
-Set the VM field of the given VIF.
-
- \noindent {\bf Signature:}
-\begin{verbatim} void set_VM (session_id s, VIF ref self, VM ref
value)\end{verbatim}
-
-
-\noindent{\bf Arguments:}
-
-
-\vspace{0.3cm}
-\begin{tabular}{|c|c|p{7cm}|}
- \hline
-{\bf type} & {\bf name} & {\bf description} \\ \hline
-{\tt VIF ref } & self & reference to the object \\ \hline
-
-{\tt VM ref } & 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}
@@ -6441,8 +6373,8 @@ Quals & Field & Type & Description \\
\hline
$\mathit{RO}_\mathit{run}$ & {\tt uuid} & string & unique identifier/object
reference \\
$\mathit{RW}$ & {\tt device} & string & machine-readable name of the
interface (e.g. eth0) \\
-$\mathit{RW}$ & {\tt network} & network ref & virtual network to which this
pif is connected \\
-$\mathit{RW}$ & {\tt host} & host ref & physical machine to which this pif is
connected \\
+$\mathit{RO}_\mathit{ins}$ & {\tt network} & network ref & virtual network to
which this pif is connected \\
+$\mathit{RO}_\mathit{ins}$ & {\tt host} & host ref & physical machine to
which this pif is connected \\
$\mathit{RW}$ & {\tt MAC} & string & ethernet MAC address of physical
interface \\
$\mathit{RW}$ & {\tt MTU} & int & MTU in octets \\
$\mathit{RW}$ & {\tt VLAN} & int & VLAN tag for all traffic passing through
this interface \\
@@ -6656,13 +6588,13 @@ value of the field
\vspace{0.3cm}
\vspace{0.3cm}
\vspace{0.3cm}
-\subsubsection{RPC name:~set\_network}
-
-{\bf Overview:}
-Set the network field of the given PIF.
-
- \noindent {\bf Signature:}
-\begin{verbatim} void set_network (session_id s, PIF ref self, network ref
value)\end{verbatim}
+\subsubsection{RPC name:~get\_host}
+
+{\bf Overview:}
+Get the host field of the given PIF.
+
+ \noindent {\bf Signature:}
+\begin{verbatim} (host ref) get_host (session_id s, PIF ref self)\end{verbatim}
\noindent{\bf Arguments:}
@@ -6674,40 +6606,6 @@ Set the network field of the given PIF.
{\bf type} & {\bf name} & {\bf description} \\ \hline
{\tt PIF ref } & self & reference to the object \\ \hline
-{\tt network ref } & 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\_host}
-
-{\bf Overview:}
-Get the host field of the given PIF.
-
- \noindent {\bf Signature:}
-\begin{verbatim} (host ref) get_host (session_id s, PIF 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 PIF ref } & self & reference to the object \\ \hline
-
\end{tabular}
\vspace{0.3cm}
@@ -6719,40 +6617,6 @@ host ref
value of the field
-\vspace{0.3cm}
-\vspace{0.3cm}
-\vspace{0.3cm}
-\subsubsection{RPC name:~set\_host}
-
-{\bf Overview:}
-Set the host field of the given PIF.
-
- \noindent {\bf Signature:}
-\begin{verbatim} void set_host (session_id s, PIF ref self, host ref
value)\end{verbatim}
-
-
-\noindent{\bf Arguments:}
-
-
-\vspace{0.3cm}
-\begin{tabular}{|c|c|p{7cm}|}
- \hline
-{\bf type} & {\bf name} & {\bf description} \\ \hline
-{\tt PIF ref } & self & reference to the object \\ \hline
-
-{\tt host ref } & 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}
@@ -8538,8 +8402,8 @@ Quals & Field & Type & Description \\
Quals & Field & Type & Description \\
\hline
$\mathit{RO}_\mathit{run}$ & {\tt uuid} & string & unique identifier/object
reference \\
-$\mathit{RW}$ & {\tt VM} & VM ref & the virtual machine \\
-$\mathit{RW}$ & {\tt VDI} & VDI ref & the virtual disk \\
+$\mathit{RO}_\mathit{ins}$ & {\tt VM} & VM ref & the virtual machine \\
+$\mathit{RO}_\mathit{ins}$ & {\tt VDI} & VDI ref & the virtual disk \\
$\mathit{RW}$ & {\tt device} & string & device seen by the guest e.g. hda1 \\
$\mathit{RW}$ & {\tt bootable} & bool & true if this VBD is bootable \\
$\mathit{RW}$ & {\tt mode} & vbd\_mode & the mode the VBD should be mounted
with \\
@@ -8648,13 +8512,13 @@ value of the field
\vspace{0.3cm}
\vspace{0.3cm}
\vspace{0.3cm}
-\subsubsection{RPC name:~set\_VM}
-
-{\bf Overview:}
-Set the VM field of the given VBD.
-
- \noindent {\bf Signature:}
-\begin{verbatim} void set_VM (session_id s, VBD ref self, VM ref
value)\end{verbatim}
+\subsubsection{RPC name:~get\_VDI}
+
+{\bf Overview:}
+Get the VDI field of the given VBD.
+
+ \noindent {\bf Signature:}
+\begin{verbatim} (VDI ref) get_VDI (session_id s, VBD ref self)\end{verbatim}
\noindent{\bf Arguments:}
@@ -8666,40 +8530,6 @@ Set the VM field of the given VBD.
{\bf type} & {\bf name} & {\bf description} \\ \hline
{\tt VBD ref } & self & reference to the object \\ \hline
-{\tt VM ref } & 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\_VDI}
-
-{\bf Overview:}
-Get the VDI field of the given VBD.
-
- \noindent {\bf Signature:}
-\begin{verbatim} (VDI ref) get_VDI (session_id s, VBD 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 VBD ref } & self & reference to the object \\ \hline
-
\end{tabular}
\vspace{0.3cm}
@@ -8711,40 +8541,6 @@ VDI ref
value of the field
-\vspace{0.3cm}
-\vspace{0.3cm}
-\vspace{0.3cm}
-\subsubsection{RPC name:~set\_VDI}
-
-{\bf Overview:}
-Set the VDI field of the given VBD.
-
- \noindent {\bf Signature:}
-\begin{verbatim} void set_VDI (session_id s, VBD ref self, VDI ref
value)\end{verbatim}
-
-
-\noindent{\bf Arguments:}
-
-
-\vspace{0.3cm}
-\begin{tabular}{|c|c|p{7cm}|}
- \hline
-{\bf type} & {\bf name} & {\bf description} \\ \hline
-{\tt VBD ref } & self & reference to the object \\ \hline
-
-{\tt VDI ref } & 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}
diff -r 66c2a4085863 -r 0a422c8c3144 tools/libxen/include/xen_pif.h
--- a/tools/libxen/include/xen_pif.h Mon Jan 29 13:18:20 2007 +0000
+++ b/tools/libxen/include/xen_pif.h Mon Jan 29 14:52:27 2007 +0000
@@ -239,20 +239,6 @@ xen_pif_set_device(xen_session *session,
/**
- * Set the network field of the given PIF.
- */
-extern bool
-xen_pif_set_network(xen_session *session, xen_pif pif, xen_network network);
-
-
-/**
- * Set the host field of the given PIF.
- */
-extern bool
-xen_pif_set_host(xen_session *session, xen_pif pif, xen_host host);
-
-
-/**
* Set the MAC field of the given PIF.
*/
extern bool
diff -r 66c2a4085863 -r 0a422c8c3144 tools/libxen/include/xen_vbd.h
--- a/tools/libxen/include/xen_vbd.h Mon Jan 29 13:18:20 2007 +0000
+++ b/tools/libxen/include/xen_vbd.h Mon Jan 29 14:52:27 2007 +0000
@@ -239,20 +239,6 @@ xen_vbd_get_io_write_kbs(xen_session *se
/**
- * Set the VM field of the given VBD.
- */
-extern bool
-xen_vbd_set_vm(xen_session *session, xen_vbd vbd, xen_vm vm);
-
-
-/**
- * Set the VDI field of the given VBD.
- */
-extern bool
-xen_vbd_set_vdi(xen_session *session, xen_vbd vbd, xen_vdi vdi);
-
-
-/**
* Set the device field of the given VBD.
*/
extern bool
diff -r 66c2a4085863 -r 0a422c8c3144 tools/libxen/include/xen_vif.h
--- a/tools/libxen/include/xen_vif.h Mon Jan 29 13:18:20 2007 +0000
+++ b/tools/libxen/include/xen_vif.h Mon Jan 29 14:52:27 2007 +0000
@@ -244,20 +244,6 @@ xen_vif_set_device(xen_session *session,
/**
- * Set the network field of the given VIF.
- */
-extern bool
-xen_vif_set_network(xen_session *session, xen_vif vif, xen_network network);
-
-
-/**
- * Set the VM field of the given VIF.
- */
-extern bool
-xen_vif_set_vm(xen_session *session, xen_vif vif, xen_vm vm);
-
-
-/**
* Set the MAC field of the given VIF.
*/
extern bool
diff -r 66c2a4085863 -r 0a422c8c3144 tools/libxen/src/xen_pif.c
--- a/tools/libxen/src/xen_pif.c Mon Jan 29 13:18:20 2007 +0000
+++ b/tools/libxen/src/xen_pif.c Mon Jan 29 14:52:27 2007 +0000
@@ -283,38 +283,6 @@ xen_pif_set_device(xen_session *session,
bool
-xen_pif_set_network(xen_session *session, xen_pif pif, xen_network network)
-{
- abstract_value param_values[] =
- {
- { .type = &abstract_type_string,
- .u.string_val = pif },
- { .type = &abstract_type_string,
- .u.string_val = network }
- };
-
- xen_call_(session, "PIF.set_network", param_values, 2, NULL, NULL);
- return session->ok;
-}
-
-
-bool
-xen_pif_set_host(xen_session *session, xen_pif pif, xen_host host)
-{
- abstract_value param_values[] =
- {
- { .type = &abstract_type_string,
- .u.string_val = pif },
- { .type = &abstract_type_string,
- .u.string_val = host }
- };
-
- xen_call_(session, "PIF.set_host", param_values, 2, NULL, NULL);
- return session->ok;
-}
-
-
-bool
xen_pif_set_mac(xen_session *session, xen_pif pif, char *mac)
{
abstract_value param_values[] =
diff -r 66c2a4085863 -r 0a422c8c3144 tools/libxen/src/xen_vbd.c
--- a/tools/libxen/src/xen_vbd.c Mon Jan 29 13:18:20 2007 +0000
+++ b/tools/libxen/src/xen_vbd.c Mon Jan 29 14:52:27 2007 +0000
@@ -282,38 +282,6 @@ xen_vbd_get_io_write_kbs(xen_session *se
bool
-xen_vbd_set_vm(xen_session *session, xen_vbd vbd, xen_vm vm)
-{
- abstract_value param_values[] =
- {
- { .type = &abstract_type_string,
- .u.string_val = vbd },
- { .type = &abstract_type_string,
- .u.string_val = vm }
- };
-
- xen_call_(session, "VBD.set_VM", param_values, 2, NULL, NULL);
- return session->ok;
-}
-
-
-bool
-xen_vbd_set_vdi(xen_session *session, xen_vbd vbd, xen_vdi vdi)
-{
- abstract_value param_values[] =
- {
- { .type = &abstract_type_string,
- .u.string_val = vbd },
- { .type = &abstract_type_string,
- .u.string_val = vdi }
- };
-
- xen_call_(session, "VBD.set_VDI", param_values, 2, NULL, NULL);
- return session->ok;
-}
-
-
-bool
xen_vbd_set_device(xen_session *session, xen_vbd vbd, char *device)
{
abstract_value param_values[] =
diff -r 66c2a4085863 -r 0a422c8c3144 tools/libxen/src/xen_vif.c
--- a/tools/libxen/src/xen_vif.c Mon Jan 29 13:18:20 2007 +0000
+++ b/tools/libxen/src/xen_vif.c Mon Jan 29 14:52:27 2007 +0000
@@ -295,38 +295,6 @@ xen_vif_set_device(xen_session *session,
bool
-xen_vif_set_network(xen_session *session, xen_vif vif, xen_network network)
-{
- abstract_value param_values[] =
- {
- { .type = &abstract_type_string,
- .u.string_val = vif },
- { .type = &abstract_type_string,
- .u.string_val = network }
- };
-
- xen_call_(session, "VIF.set_network", param_values, 2, NULL, NULL);
- return session->ok;
-}
-
-
-bool
-xen_vif_set_vm(xen_session *session, xen_vif vif, xen_vm vm)
-{
- abstract_value param_values[] =
- {
- { .type = &abstract_type_string,
- .u.string_val = vif },
- { .type = &abstract_type_string,
- .u.string_val = vm }
- };
-
- xen_call_(session, "VIF.set_VM", param_values, 2, NULL, NULL);
- return session->ok;
-}
-
-
-bool
xen_vif_set_mac(xen_session *session, xen_vif vif, char *mac)
{
abstract_value param_values[] =
_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog
|
 |
Lists.xenproject.org is hosted with RackSpace, monitoring our |