ia64/xen-unstable

changeset 13723:0a422c8c3144

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@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Mon Jan 29 14:52:27 2007 +0000 (2007-01-29)
parents 66c2a4085863
children 7261e0d4b7df
files docs/xen-api/xenapi-datamodel.tex tools/libxen/include/xen_pif.h tools/libxen/include/xen_vbd.h tools/libxen/include/xen_vif.h tools/libxen/src/xen_pif.c tools/libxen/src/xen_vbd.c tools/libxen/src/xen_vif.c
line diff
     1.1 --- a/docs/xen-api/xenapi-datamodel.tex	Mon Jan 29 13:18:20 2007 +0000
     1.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Mon Jan 29 14:52:27 2007 +0000
     1.3 @@ -5862,8 +5862,8 @@ Quals & Field & Type & Description \\
     1.4  \hline
     1.5  $\mathit{RO}_\mathit{run}$ &  {\tt uuid} & string & unique identifier/object reference \\
     1.6  $\mathit{RW}$ &  {\tt device} & string & name of network device as exposed to guest e.g. eth0 \\
     1.7 -$\mathit{RW}$ &  {\tt network} & network ref & virtual network to which this vif is connected \\
     1.8 -$\mathit{RW}$ &  {\tt VM} & VM ref & virtual machine to which this vif is connected \\
     1.9 +$\mathit{RO}_\mathit{ins}$ &  {\tt network} & network ref & virtual network to which this vif is connected \\
    1.10 +$\mathit{RO}_\mathit{ins}$ &  {\tt VM} & VM ref & virtual machine to which this vif is connected \\
    1.11  $\mathit{RW}$ &  {\tt MAC} & string & ethernet MAC address of virtual interface, as exposed to guest \\
    1.12  $\mathit{RW}$ &  {\tt MTU} & int & MTU in octets \\
    1.13  $\mathit{RO}_\mathit{run}$ &  {\tt io/read\_kbs} & float & Read bandwidth (KiB/s) \\
    1.14 @@ -6001,40 +6001,6 @@ value of the field
    1.15  \vspace{0.3cm}
    1.16  \vspace{0.3cm}
    1.17  \vspace{0.3cm}
    1.18 -\subsubsection{RPC name:~set\_network}
    1.19 -
    1.20 -{\bf Overview:} 
    1.21 -Set the network field of the given VIF.
    1.22 -
    1.23 - \noindent {\bf Signature:} 
    1.24 -\begin{verbatim} void set_network (session_id s, VIF ref self, network ref value)\end{verbatim}
    1.25 -
    1.26 -
    1.27 -\noindent{\bf Arguments:}
    1.28 -
    1.29 - 
    1.30 -\vspace{0.3cm}
    1.31 -\begin{tabular}{|c|c|p{7cm}|}
    1.32 - \hline
    1.33 -{\bf type} & {\bf name} & {\bf description} \\ \hline
    1.34 -{\tt VIF ref } & self & reference to the object \\ \hline 
    1.35 -
    1.36 -{\tt network ref } & value & New value to set \\ \hline 
    1.37 -
    1.38 -\end{tabular}
    1.39 -
    1.40 -\vspace{0.3cm}
    1.41 -
    1.42 - \noindent {\bf Return Type:} 
    1.43 -{\tt 
    1.44 -void
    1.45 -}
    1.46 -
    1.47 -
    1.48 -
    1.49 -\vspace{0.3cm}
    1.50 -\vspace{0.3cm}
    1.51 -\vspace{0.3cm}
    1.52  \subsubsection{RPC name:~get\_VM}
    1.53  
    1.54  {\bf Overview:} 
    1.55 @@ -6067,40 +6033,6 @@ value of the field
    1.56  \vspace{0.3cm}
    1.57  \vspace{0.3cm}
    1.58  \vspace{0.3cm}
    1.59 -\subsubsection{RPC name:~set\_VM}
    1.60 -
    1.61 -{\bf Overview:} 
    1.62 -Set the VM field of the given VIF.
    1.63 -
    1.64 - \noindent {\bf Signature:} 
    1.65 -\begin{verbatim} void set_VM (session_id s, VIF ref self, VM ref value)\end{verbatim}
    1.66 -
    1.67 -
    1.68 -\noindent{\bf Arguments:}
    1.69 -
    1.70 - 
    1.71 -\vspace{0.3cm}
    1.72 -\begin{tabular}{|c|c|p{7cm}|}
    1.73 - \hline
    1.74 -{\bf type} & {\bf name} & {\bf description} \\ \hline
    1.75 -{\tt VIF ref } & self & reference to the object \\ \hline 
    1.76 -
    1.77 -{\tt VM ref } & value & New value to set \\ \hline 
    1.78 -
    1.79 -\end{tabular}
    1.80 -
    1.81 -\vspace{0.3cm}
    1.82 -
    1.83 - \noindent {\bf Return Type:} 
    1.84 -{\tt 
    1.85 -void
    1.86 -}
    1.87 -
    1.88 -
    1.89 -
    1.90 -\vspace{0.3cm}
    1.91 -\vspace{0.3cm}
    1.92 -\vspace{0.3cm}
    1.93  \subsubsection{RPC name:~get\_MAC}
    1.94  
    1.95  {\bf Overview:} 
    1.96 @@ -6441,8 +6373,8 @@ Quals & Field & Type & Description \\
    1.97  \hline
    1.98  $\mathit{RO}_\mathit{run}$ &  {\tt uuid} & string & unique identifier/object reference \\
    1.99  $\mathit{RW}$ &  {\tt device} & string & machine-readable name of the interface (e.g. eth0) \\
   1.100 -$\mathit{RW}$ &  {\tt network} & network ref & virtual network to which this pif is connected \\
   1.101 -$\mathit{RW}$ &  {\tt host} & host ref & physical machine to which this pif is connected \\
   1.102 +$\mathit{RO}_\mathit{ins}$ &  {\tt network} & network ref & virtual network to which this pif is connected \\
   1.103 +$\mathit{RO}_\mathit{ins}$ &  {\tt host} & host ref & physical machine to which this pif is connected \\
   1.104  $\mathit{RW}$ &  {\tt MAC} & string & ethernet MAC address of physical interface \\
   1.105  $\mathit{RW}$ &  {\tt MTU} & int & MTU in octets \\
   1.106  $\mathit{RW}$ &  {\tt VLAN} & int & VLAN tag for all traffic passing through this interface \\
   1.107 @@ -6656,40 +6588,6 @@ value of the field
   1.108  \vspace{0.3cm}
   1.109  \vspace{0.3cm}
   1.110  \vspace{0.3cm}
   1.111 -\subsubsection{RPC name:~set\_network}
   1.112 -
   1.113 -{\bf Overview:} 
   1.114 -Set the network field of the given PIF.
   1.115 -
   1.116 - \noindent {\bf Signature:} 
   1.117 -\begin{verbatim} void set_network (session_id s, PIF ref self, network ref value)\end{verbatim}
   1.118 -
   1.119 -
   1.120 -\noindent{\bf Arguments:}
   1.121 -
   1.122 - 
   1.123 -\vspace{0.3cm}
   1.124 -\begin{tabular}{|c|c|p{7cm}|}
   1.125 - \hline
   1.126 -{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.127 -{\tt PIF ref } & self & reference to the object \\ \hline 
   1.128 -
   1.129 -{\tt network ref } & value & New value to set \\ \hline 
   1.130 -
   1.131 -\end{tabular}
   1.132 -
   1.133 -\vspace{0.3cm}
   1.134 -
   1.135 - \noindent {\bf Return Type:} 
   1.136 -{\tt 
   1.137 -void
   1.138 -}
   1.139 -
   1.140 -
   1.141 -
   1.142 -\vspace{0.3cm}
   1.143 -\vspace{0.3cm}
   1.144 -\vspace{0.3cm}
   1.145  \subsubsection{RPC name:~get\_host}
   1.146  
   1.147  {\bf Overview:} 
   1.148 @@ -6722,40 +6620,6 @@ value of the field
   1.149  \vspace{0.3cm}
   1.150  \vspace{0.3cm}
   1.151  \vspace{0.3cm}
   1.152 -\subsubsection{RPC name:~set\_host}
   1.153 -
   1.154 -{\bf Overview:} 
   1.155 -Set the host field of the given PIF.
   1.156 -
   1.157 - \noindent {\bf Signature:} 
   1.158 -\begin{verbatim} void set_host (session_id s, PIF ref self, host ref value)\end{verbatim}
   1.159 -
   1.160 -
   1.161 -\noindent{\bf Arguments:}
   1.162 -
   1.163 - 
   1.164 -\vspace{0.3cm}
   1.165 -\begin{tabular}{|c|c|p{7cm}|}
   1.166 - \hline
   1.167 -{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.168 -{\tt PIF ref } & self & reference to the object \\ \hline 
   1.169 -
   1.170 -{\tt host ref } & value & New value to set \\ \hline 
   1.171 -
   1.172 -\end{tabular}
   1.173 -
   1.174 -\vspace{0.3cm}
   1.175 -
   1.176 - \noindent {\bf Return Type:} 
   1.177 -{\tt 
   1.178 -void
   1.179 -}
   1.180 -
   1.181 -
   1.182 -
   1.183 -\vspace{0.3cm}
   1.184 -\vspace{0.3cm}
   1.185 -\vspace{0.3cm}
   1.186  \subsubsection{RPC name:~get\_MAC}
   1.187  
   1.188  {\bf Overview:} 
   1.189 @@ -8538,8 +8402,8 @@ virtual block device.}} \\
   1.190  Quals & Field & Type & Description \\
   1.191  \hline
   1.192  $\mathit{RO}_\mathit{run}$ &  {\tt uuid} & string & unique identifier/object reference \\
   1.193 -$\mathit{RW}$ &  {\tt VM} & VM ref & the virtual machine \\
   1.194 -$\mathit{RW}$ &  {\tt VDI} & VDI ref & the virtual disk \\
   1.195 +$\mathit{RO}_\mathit{ins}$ &  {\tt VM} & VM ref & the virtual machine \\
   1.196 +$\mathit{RO}_\mathit{ins}$ &  {\tt VDI} & VDI ref & the virtual disk \\
   1.197  $\mathit{RW}$ &  {\tt device} & string & device seen by the guest e.g. hda1 \\
   1.198  $\mathit{RW}$ &  {\tt bootable} & bool & true if this VBD is bootable \\
   1.199  $\mathit{RW}$ &  {\tt mode} & vbd\_mode & the mode the VBD should be mounted with \\
   1.200 @@ -8648,40 +8512,6 @@ value of the field
   1.201  \vspace{0.3cm}
   1.202  \vspace{0.3cm}
   1.203  \vspace{0.3cm}
   1.204 -\subsubsection{RPC name:~set\_VM}
   1.205 -
   1.206 -{\bf Overview:} 
   1.207 -Set the VM field of the given VBD.
   1.208 -
   1.209 - \noindent {\bf Signature:} 
   1.210 -\begin{verbatim} void set_VM (session_id s, VBD ref self, VM ref value)\end{verbatim}
   1.211 -
   1.212 -
   1.213 -\noindent{\bf Arguments:}
   1.214 -
   1.215 - 
   1.216 -\vspace{0.3cm}
   1.217 -\begin{tabular}{|c|c|p{7cm}|}
   1.218 - \hline
   1.219 -{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.220 -{\tt VBD ref } & self & reference to the object \\ \hline 
   1.221 -
   1.222 -{\tt VM ref } & value & New value to set \\ \hline 
   1.223 -
   1.224 -\end{tabular}
   1.225 -
   1.226 -\vspace{0.3cm}
   1.227 -
   1.228 - \noindent {\bf Return Type:} 
   1.229 -{\tt 
   1.230 -void
   1.231 -}
   1.232 -
   1.233 -
   1.234 -
   1.235 -\vspace{0.3cm}
   1.236 -\vspace{0.3cm}
   1.237 -\vspace{0.3cm}
   1.238  \subsubsection{RPC name:~get\_VDI}
   1.239  
   1.240  {\bf Overview:} 
   1.241 @@ -8714,40 +8544,6 @@ value of the field
   1.242  \vspace{0.3cm}
   1.243  \vspace{0.3cm}
   1.244  \vspace{0.3cm}
   1.245 -\subsubsection{RPC name:~set\_VDI}
   1.246 -
   1.247 -{\bf Overview:} 
   1.248 -Set the VDI field of the given VBD.
   1.249 -
   1.250 - \noindent {\bf Signature:} 
   1.251 -\begin{verbatim} void set_VDI (session_id s, VBD ref self, VDI ref value)\end{verbatim}
   1.252 -
   1.253 -
   1.254 -\noindent{\bf Arguments:}
   1.255 -
   1.256 - 
   1.257 -\vspace{0.3cm}
   1.258 -\begin{tabular}{|c|c|p{7cm}|}
   1.259 - \hline
   1.260 -{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.261 -{\tt VBD ref } & self & reference to the object \\ \hline 
   1.262 -
   1.263 -{\tt VDI ref } & value & New value to set \\ \hline 
   1.264 -
   1.265 -\end{tabular}
   1.266 -
   1.267 -\vspace{0.3cm}
   1.268 -
   1.269 - \noindent {\bf Return Type:} 
   1.270 -{\tt 
   1.271 -void
   1.272 -}
   1.273 -
   1.274 -
   1.275 -
   1.276 -\vspace{0.3cm}
   1.277 -\vspace{0.3cm}
   1.278 -\vspace{0.3cm}
   1.279  \subsubsection{RPC name:~get\_device}
   1.280  
   1.281  {\bf Overview:} 
     2.1 --- a/tools/libxen/include/xen_pif.h	Mon Jan 29 13:18:20 2007 +0000
     2.2 +++ b/tools/libxen/include/xen_pif.h	Mon Jan 29 14:52:27 2007 +0000
     2.3 @@ -239,20 +239,6 @@ xen_pif_set_device(xen_session *session,
     2.4  
     2.5  
     2.6  /**
     2.7 - * Set the network field of the given PIF.
     2.8 - */
     2.9 -extern bool
    2.10 -xen_pif_set_network(xen_session *session, xen_pif pif, xen_network network);
    2.11 -
    2.12 -
    2.13 -/**
    2.14 - * Set the host field of the given PIF.
    2.15 - */
    2.16 -extern bool
    2.17 -xen_pif_set_host(xen_session *session, xen_pif pif, xen_host host);
    2.18 -
    2.19 -
    2.20 -/**
    2.21   * Set the MAC field of the given PIF.
    2.22   */
    2.23  extern bool
     3.1 --- a/tools/libxen/include/xen_vbd.h	Mon Jan 29 13:18:20 2007 +0000
     3.2 +++ b/tools/libxen/include/xen_vbd.h	Mon Jan 29 14:52:27 2007 +0000
     3.3 @@ -239,20 +239,6 @@ xen_vbd_get_io_write_kbs(xen_session *se
     3.4  
     3.5  
     3.6  /**
     3.7 - * Set the VM field of the given VBD.
     3.8 - */
     3.9 -extern bool
    3.10 -xen_vbd_set_vm(xen_session *session, xen_vbd vbd, xen_vm vm);
    3.11 -
    3.12 -
    3.13 -/**
    3.14 - * Set the VDI field of the given VBD.
    3.15 - */
    3.16 -extern bool
    3.17 -xen_vbd_set_vdi(xen_session *session, xen_vbd vbd, xen_vdi vdi);
    3.18 -
    3.19 -
    3.20 -/**
    3.21   * Set the device field of the given VBD.
    3.22   */
    3.23  extern bool
     4.1 --- a/tools/libxen/include/xen_vif.h	Mon Jan 29 13:18:20 2007 +0000
     4.2 +++ b/tools/libxen/include/xen_vif.h	Mon Jan 29 14:52:27 2007 +0000
     4.3 @@ -244,20 +244,6 @@ xen_vif_set_device(xen_session *session,
     4.4  
     4.5  
     4.6  /**
     4.7 - * Set the network field of the given VIF.
     4.8 - */
     4.9 -extern bool
    4.10 -xen_vif_set_network(xen_session *session, xen_vif vif, xen_network network);
    4.11 -
    4.12 -
    4.13 -/**
    4.14 - * Set the VM field of the given VIF.
    4.15 - */
    4.16 -extern bool
    4.17 -xen_vif_set_vm(xen_session *session, xen_vif vif, xen_vm vm);
    4.18 -
    4.19 -
    4.20 -/**
    4.21   * Set the MAC field of the given VIF.
    4.22   */
    4.23  extern bool
     5.1 --- a/tools/libxen/src/xen_pif.c	Mon Jan 29 13:18:20 2007 +0000
     5.2 +++ b/tools/libxen/src/xen_pif.c	Mon Jan 29 14:52:27 2007 +0000
     5.3 @@ -283,38 +283,6 @@ xen_pif_set_device(xen_session *session,
     5.4  
     5.5  
     5.6  bool
     5.7 -xen_pif_set_network(xen_session *session, xen_pif pif, xen_network network)
     5.8 -{
     5.9 -    abstract_value param_values[] =
    5.10 -        {
    5.11 -            { .type = &abstract_type_string,
    5.12 -              .u.string_val = pif },
    5.13 -            { .type = &abstract_type_string,
    5.14 -              .u.string_val = network }
    5.15 -        };
    5.16 -
    5.17 -    xen_call_(session, "PIF.set_network", param_values, 2, NULL, NULL);
    5.18 -    return session->ok;
    5.19 -}
    5.20 -
    5.21 -
    5.22 -bool
    5.23 -xen_pif_set_host(xen_session *session, xen_pif pif, xen_host host)
    5.24 -{
    5.25 -    abstract_value param_values[] =
    5.26 -        {
    5.27 -            { .type = &abstract_type_string,
    5.28 -              .u.string_val = pif },
    5.29 -            { .type = &abstract_type_string,
    5.30 -              .u.string_val = host }
    5.31 -        };
    5.32 -
    5.33 -    xen_call_(session, "PIF.set_host", param_values, 2, NULL, NULL);
    5.34 -    return session->ok;
    5.35 -}
    5.36 -
    5.37 -
    5.38 -bool
    5.39  xen_pif_set_mac(xen_session *session, xen_pif pif, char *mac)
    5.40  {
    5.41      abstract_value param_values[] =
     6.1 --- a/tools/libxen/src/xen_vbd.c	Mon Jan 29 13:18:20 2007 +0000
     6.2 +++ b/tools/libxen/src/xen_vbd.c	Mon Jan 29 14:52:27 2007 +0000
     6.3 @@ -282,38 +282,6 @@ xen_vbd_get_io_write_kbs(xen_session *se
     6.4  
     6.5  
     6.6  bool
     6.7 -xen_vbd_set_vm(xen_session *session, xen_vbd vbd, xen_vm vm)
     6.8 -{
     6.9 -    abstract_value param_values[] =
    6.10 -        {
    6.11 -            { .type = &abstract_type_string,
    6.12 -              .u.string_val = vbd },
    6.13 -            { .type = &abstract_type_string,
    6.14 -              .u.string_val = vm }
    6.15 -        };
    6.16 -
    6.17 -    xen_call_(session, "VBD.set_VM", param_values, 2, NULL, NULL);
    6.18 -    return session->ok;
    6.19 -}
    6.20 -
    6.21 -
    6.22 -bool
    6.23 -xen_vbd_set_vdi(xen_session *session, xen_vbd vbd, xen_vdi vdi)
    6.24 -{
    6.25 -    abstract_value param_values[] =
    6.26 -        {
    6.27 -            { .type = &abstract_type_string,
    6.28 -              .u.string_val = vbd },
    6.29 -            { .type = &abstract_type_string,
    6.30 -              .u.string_val = vdi }
    6.31 -        };
    6.32 -
    6.33 -    xen_call_(session, "VBD.set_VDI", param_values, 2, NULL, NULL);
    6.34 -    return session->ok;
    6.35 -}
    6.36 -
    6.37 -
    6.38 -bool
    6.39  xen_vbd_set_device(xen_session *session, xen_vbd vbd, char *device)
    6.40  {
    6.41      abstract_value param_values[] =
     7.1 --- a/tools/libxen/src/xen_vif.c	Mon Jan 29 13:18:20 2007 +0000
     7.2 +++ b/tools/libxen/src/xen_vif.c	Mon Jan 29 14:52:27 2007 +0000
     7.3 @@ -295,38 +295,6 @@ xen_vif_set_device(xen_session *session,
     7.4  
     7.5  
     7.6  bool
     7.7 -xen_vif_set_network(xen_session *session, xen_vif vif, xen_network network)
     7.8 -{
     7.9 -    abstract_value param_values[] =
    7.10 -        {
    7.11 -            { .type = &abstract_type_string,
    7.12 -              .u.string_val = vif },
    7.13 -            { .type = &abstract_type_string,
    7.14 -              .u.string_val = network }
    7.15 -        };
    7.16 -
    7.17 -    xen_call_(session, "VIF.set_network", param_values, 2, NULL, NULL);
    7.18 -    return session->ok;
    7.19 -}
    7.20 -
    7.21 -
    7.22 -bool
    7.23 -xen_vif_set_vm(xen_session *session, xen_vif vif, xen_vm vm)
    7.24 -{
    7.25 -    abstract_value param_values[] =
    7.26 -        {
    7.27 -            { .type = &abstract_type_string,
    7.28 -              .u.string_val = vif },
    7.29 -            { .type = &abstract_type_string,
    7.30 -              .u.string_val = vm }
    7.31 -        };
    7.32 -
    7.33 -    xen_call_(session, "VIF.set_VM", param_values, 2, NULL, NULL);
    7.34 -    return session->ok;
    7.35 -}
    7.36 -
    7.37 -
    7.38 -bool
    7.39  xen_vif_set_mac(xen_session *session, xen_vif vif, char *mac)
    7.40  {
    7.41      abstract_value param_values[] =