Added host.other_config.
authorEwan Mellor <ewan@xensource.com>
Tue, 30 Jan 2007 01:23:58 +0000 (01:23 +0000)
committerEwan Mellor <ewan@xensource.com>
Tue, 30 Jan 2007 01:23:58 +0000 (01:23 +0000)
Signed-off-by: Ewan Mellor <ewan@xensource.com>
docs/xen-api/xenapi-datamodel.tex
tools/libxen/include/xen_host.h
tools/libxen/src/xen_host.c
tools/python/xen/xend/XendAPI.py
tools/python/xen/xend/XendNode.py

index 5e34bb63e9fd128519df2b546a14e2cecb05558a..632f023c727b3570dece3a83c6101cfd94ecfb32 100644 (file)
@@ -3756,6 +3756,7 @@ $\mathit{RO}_\mathit{run}$ &  {\tt uuid} & string & unique identifier/object ref
 $\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 software\_version} & (string $\rightarrow$ string) Map & version strings \\
+$\mathit{RW}$ &  {\tt other\_config} & (string $\rightarrow$ string) Map & additional configuration \\
 $\mathit{RO}_\mathit{run}$ &  {\tt resident\_VMs} & (VM ref) Set & list of VMs currently resident on host \\
 $\mathit{RO}_\mathit{run}$ &  {\tt PIFs} & (PIF ref) Set & physical network interfaces \\
 $\mathit{RO}_\mathit{run}$ &  {\tt PBDs} & (PBD ref) Set & physical blockdevices \\
@@ -4108,6 +4109,143 @@ Get the software\_version field of the given host.
 
 
 value of the field
+\vspace{0.3cm}
+\vspace{0.3cm}
+\vspace{0.3cm}
+\subsubsection{RPC name:~get\_other\_config}
+
+{\bf Overview:} 
+Get the other\_config field of the given host.
+
+ \noindent {\bf Signature:} 
+\begin{verbatim} ((string -> string) Map) get_other_config (session_id s, host 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 host ref } & self & reference to the object \\ \hline 
+
+\end{tabular}
+
+\vspace{0.3cm}
+
+ \noindent {\bf Return Type:} 
+{\tt 
+(string $\rightarrow$ string) Map
+}
+
+
+value of the field
+\vspace{0.3cm}
+\vspace{0.3cm}
+\vspace{0.3cm}
+\subsubsection{RPC name:~set\_other\_config}
+
+{\bf Overview:} 
+Set the other\_config field of the given host.
+
+ \noindent {\bf Signature:} 
+\begin{verbatim} void set_other_config (session_id s, host ref self, (string -> string) Map value)\end{verbatim}
+
+
+\noindent{\bf Arguments:}
+
+\vspace{0.3cm}
+\begin{tabular}{|c|c|p{7cm}|}
+ \hline
+{\bf type} & {\bf name} & {\bf description} \\ \hline
+{\tt host ref } & self & reference to the object \\ \hline 
+
+{\tt (string $\rightarrow$ string) Map } & 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:~add\_to\_other\_config}
+
+{\bf Overview:} 
+Add the given key-value pair to the other\_config field of the given host.
+
+ \noindent {\bf Signature:} 
+\begin{verbatim} void add_to_other_config (session_id s, host ref self, string key, 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 host ref } & self & reference to the object \\ \hline 
+
+{\tt string } & key & Key to add \\ \hline 
+
+{\tt string } & value & Value to add \\ \hline 
+
+\end{tabular}
+
+\vspace{0.3cm}
+
+ \noindent {\bf Return Type:} 
+{\tt 
+void
+}
+
+
+
+\vspace{0.3cm}
+\vspace{0.3cm}
+\vspace{0.3cm}
+\subsubsection{RPC name:~remove\_from\_other\_config}
+
+{\bf Overview:} 
+Remove the given key and its corresponding value from the other\_config
+field of the given host.  If the key is not in that Map, then do nothing.
+
+ \noindent {\bf Signature:} 
+\begin{verbatim} void remove_from_other_config (session_id s, host ref self, string key)\end{verbatim}
+
+
+\noindent{\bf Arguments:}
+
+\vspace{0.3cm}
+\begin{tabular}{|c|c|p{7cm}|}
+ \hline
+{\bf type} & {\bf name} & {\bf description} \\ \hline
+{\tt host ref } & self & reference to the object \\ \hline 
+
+{\tt string } & key & Key to remove \\ \hline 
+
+\end{tabular}
+
+\vspace{0.3cm}
+
+ \noindent {\bf Return Type:} 
+{\tt 
+void
+}
+
+
+
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}
index 41823abca89458d1190f6206092f9c6f44f19857..ed4dcd55a4f8fae8818d36d00a343fde5ac52c1f 100644 (file)
@@ -70,6 +70,7 @@ typedef struct xen_host_record
     char *name_label;
     char *name_description;
     xen_string_string_map *software_version;
+    xen_string_string_map *other_config;
     struct xen_vm_record_opt_set *resident_vms;
     struct xen_pif_record_opt_set *pifs;
     struct xen_pbd_record_opt_set *pbds;
@@ -218,6 +219,13 @@ extern bool
 xen_host_get_software_version(xen_session *session, xen_string_string_map **result, xen_host host);
 
 
+/**
+ * Get the other_config field of the given host.
+ */
+extern bool
+xen_host_get_other_config(xen_session *session, xen_string_string_map **result, xen_host host);
+
+
 /**
  * Get the resident_VMs field of the given host.
  */
@@ -260,6 +268,30 @@ extern bool
 xen_host_set_name_description(xen_session *session, xen_host host, char *description);
 
 
+/**
+ * Set the other_config field of the given host.
+ */
+extern bool
+xen_host_set_other_config(xen_session *session, xen_host host, xen_string_string_map *other_config);
+
+
+/**
+ * Add the given key-value pair to the other_config field of the given
+ * host.
+ */
+extern bool
+xen_host_add_to_other_config(xen_session *session, xen_host host, char *key, char *value);
+
+
+/**
+ * Remove the given key and its corresponding value from the
+ * other_config field of the given host.  If the key is not in that Map, then
+ * do nothing.
+ */
+extern bool
+xen_host_remove_from_other_config(xen_session *session, xen_host host, char *key);
+
+
 /**
  * Puts the host into a state in which no new VMs can be started.
  * Currently active VMs on the host continue to execute.
index f93dda0bc974ff7718bccd5014c48ff5ca8fdb7f..dfec48cb32dc3c287800d303745987c6a12faf31 100644 (file)
@@ -53,6 +53,9 @@ static const struct_member xen_host_record_struct_members[] =
         { .key = "software_version",
           .type = &abstract_type_string_string_map,
           .offset = offsetof(xen_host_record, software_version) },
+        { .key = "other_config",
+          .type = &abstract_type_string_string_map,
+          .offset = offsetof(xen_host_record, other_config) },
         { .key = "resident_VMs",
           .type = &abstract_type_ref_set,
           .offset = offsetof(xen_host_record, resident_vms) },
@@ -89,6 +92,7 @@ xen_host_record_free(xen_host_record *record)
     free(record->name_label);
     free(record->name_description);
     xen_string_string_map_free(record->software_version);
+    xen_string_string_map_free(record->other_config);
     xen_vm_record_opt_set_free(record->resident_vms);
     xen_pif_record_opt_set_free(record->pifs);
     xen_pbd_record_opt_set_free(record->pbds);
@@ -236,6 +240,23 @@ xen_host_get_software_version(xen_session *session, xen_string_string_map **resu
 }
 
 
+bool
+xen_host_get_other_config(xen_session *session, xen_string_string_map **result, xen_host host)
+{
+    abstract_value param_values[] =
+        {
+            { .type = &abstract_type_string,
+              .u.string_val = host }
+        };
+
+    abstract_type result_type = abstract_type_string_string_map;
+
+    *result = NULL;
+    XEN_CALL_("host.get_other_config");
+    return session->ok;
+}
+
+
 bool
 xen_host_get_resident_vms(xen_session *session, struct xen_vm_set **result, xen_host host)
 {
@@ -336,6 +357,56 @@ xen_host_set_name_description(xen_session *session, xen_host host, char *descrip
 }
 
 
+bool
+xen_host_set_other_config(xen_session *session, xen_host host, xen_string_string_map *other_config)
+{
+    abstract_value param_values[] =
+        {
+            { .type = &abstract_type_string,
+              .u.string_val = host },
+            { .type = &abstract_type_string_string_map,
+              .u.set_val = (arbitrary_set *)other_config }
+        };
+
+    xen_call_(session, "host.set_other_config", param_values, 2, NULL, NULL);
+    return session->ok;
+}
+
+
+bool
+xen_host_add_to_other_config(xen_session *session, xen_host host, char *key, char *value)
+{
+    abstract_value param_values[] =
+        {
+            { .type = &abstract_type_string,
+              .u.string_val = host },
+            { .type = &abstract_type_string,
+              .u.string_val = key },
+            { .type = &abstract_type_string,
+              .u.string_val = value }
+        };
+
+    xen_call_(session, "host.add_to_other_config", param_values, 3, NULL, NULL);
+    return session->ok;
+}
+
+
+bool
+xen_host_remove_from_other_config(xen_session *session, xen_host host, char *key)
+{
+    abstract_value param_values[] =
+        {
+            { .type = &abstract_type_string,
+              .u.string_val = host },
+            { .type = &abstract_type_string,
+              .u.string_val = key }
+        };
+
+    xen_call_(session, "host.remove_from_other_config", param_values, 2, NULL, NULL);
+    return session->ok;
+}
+
+
 bool
 xen_host_disable(xen_session *session, xen_host host)
 {
index 1d3a0fcb7cc08533fed5562b7916597a01930ce9..5879fccd5b413376f38babef11e7fd05107aa370 100644 (file)
@@ -581,12 +581,15 @@ class XendAPI(object):
                     'host_CPUs']
     
     host_attr_rw = ['name_label',
-                    'name_description']
+                    'name_description',
+                    'other_config']
 
     host_methods = [('disable', None),
                     ('enable', None),
                     ('reboot', None),
-                    ('shutdown', None)]
+                    ('shutdown', None),
+                    ('add_to_other_config', None),
+                    ('remove_from_other_config', None)]
     
     host_funcs = [('get_by_name_label', 'Set(host)')]
 
@@ -601,6 +604,23 @@ class XendAPI(object):
     def host_set_name_description(self, session, host_ref, new_desc):
         XendNode.instance().set_description(new_desc)
         return xen_api_success_void()
+    def host_get_other_config(self, session, host_ref):
+        return xen_api_success(XendNode.instance().other_config)
+    def host_set_other_config(self, session, host_ref, other_config):
+        node = XendNode.instance()
+        node.other_config = dict(other_config)
+        node.save()
+        return xen_api_success_void()
+    def host_add_to_other_config(self, session, host_ref, key, value):
+        node = XendNode.instance()
+        node.other_config[key] = value
+        node.save()
+        return xen_api_success_void()
+    def host_remove_from_other_config(self, session, host_ref, key):
+        node = XendNode.instance()
+        del node.other_config[key]
+        node.save()
+        return xen_api_success_void()
     def host_get_software_version(self, session, host_ref):
         return xen_api_success(XendNode.instance().xen_version())
     def host_get_resident_VMs(self, session, host_ref):
index f4b9dbf33cb5544bb8162463ba15dbaea7f64ec2..6a01e958f26ec55deadae2e07529d2f809322bf3 100644 (file)
@@ -59,11 +59,16 @@ class XendNode:
             host = saved_host[self.uuid]
             self.name = host.get('name_label', socket.gethostname())
             self.desc = host.get('name_description', '')
+            try:
+                self.other_config = eval(host['other_config'])
+            except:
+                self.other_config = {}
             self.cpus = {}
         else:
             self.uuid = uuid.createString()
             self.name = socket.gethostname()
             self.desc = ''
+            self.other_config = {}
             self.cpus = {}
             
         # load CPU UUIDs
@@ -218,7 +223,8 @@ class XendNode:
     def save(self):
         # save state
         host_record = {self.uuid: {'name_label':self.name,
-                                   'name_description':self.desc}}
+                                   'name_description':self.desc,
+                                   'other_config': repr(self.other_config)}}
         self.state_store.save_state('host',host_record)
         self.state_store.save_state('cpu', self.cpus)
         self.save_PIFs()