Added host.logging, to hold server-side logging configuration.
authorEwan Mellor <ewan@xensource.com>
Tue, 30 Jan 2007 12:31:20 +0000 (12:31 +0000)
committerEwan Mellor <ewan@xensource.com>
Tue, 30 Jan 2007 12:31:20 +0000 (12:31 +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

index 632f023c727b3570dece3a83c6101cfd94ecfb32..6e123106a49f16ee677b88e1d6c792023edf9a81 100644 (file)
@@ -3758,6 +3758,7 @@ $\mathit{RW}$ &  {\tt name/description} & string & a notes field containg human-
 $\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{RW}$ &  {\tt logging} & (string $\rightarrow$ string) Map & logging configuration \\
 $\mathit{RO}_\mathit{run}$ &  {\tt PIFs} & (PIF ref) Set & physical network interfaces \\
 $\mathit{RO}_\mathit{run}$ &  {\tt PBDs} & (PBD ref) Set & physical blockdevices \\
 $\mathit{RO}_\mathit{run}$ &  {\tt host\_CPUs} & (host\_cpu ref) Set & The physical CPUs on this host \\
@@ -4278,6 +4279,143 @@ Get the resident\_VMs field of the given host.
 
 
 value of the field
+\vspace{0.3cm}
+\vspace{0.3cm}
+\vspace{0.3cm}
+\subsubsection{RPC name:~get\_logging}
+
+{\bf Overview:} 
+Get the logging field of the given host.
+
+ \noindent {\bf Signature:} 
+\begin{verbatim} ((string -> string) Map) get_logging (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\_logging}
+
+{\bf Overview:} 
+Set the logging field of the given host.
+
+ \noindent {\bf Signature:} 
+\begin{verbatim} void set_logging (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\_logging}
+
+{\bf Overview:} 
+Add the given key-value pair to the logging field of the given host.
+
+ \noindent {\bf Signature:} 
+\begin{verbatim} void add_to_logging (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\_logging}
+
+{\bf Overview:} 
+Remove the given key and its corresponding value from the logging field of
+the given host.  If the key is not in that Map, then do nothing.
+
+ \noindent {\bf Signature:} 
+\begin{verbatim} void remove_from_logging (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 ed4dcd55a4f8fae8818d36d00a343fde5ac52c1f..d94a74ecb4f588c54def6634af1f87daedc1c69b 100644 (file)
@@ -72,6 +72,7 @@ typedef struct xen_host_record
     xen_string_string_map *software_version;
     xen_string_string_map *other_config;
     struct xen_vm_record_opt_set *resident_vms;
+    xen_string_string_map *logging;
     struct xen_pif_record_opt_set *pifs;
     struct xen_pbd_record_opt_set *pbds;
     struct xen_host_cpu_record_opt_set *host_cpus;
@@ -233,6 +234,13 @@ extern bool
 xen_host_get_resident_vms(xen_session *session, struct xen_vm_set **result, xen_host host);
 
 
+/**
+ * Get the logging field of the given host.
+ */
+extern bool
+xen_host_get_logging(xen_session *session, xen_string_string_map **result, xen_host host);
+
+
 /**
  * Get the PIFs field of the given host.
  */
@@ -292,6 +300,28 @@ extern bool
 xen_host_remove_from_other_config(xen_session *session, xen_host host, char *key);
 
 
+/**
+ * Set the logging field of the given host.
+ */
+extern bool
+xen_host_set_logging(xen_session *session, xen_host host, xen_string_string_map *logging);
+
+
+/**
+ * Add the given key-value pair to the logging field of the given host.
+ */
+extern bool
+xen_host_add_to_logging(xen_session *session, xen_host host, char *key, char *value);
+
+
+/**
+ * Remove the given key and its corresponding value from the logging
+ * field of the given host.  If the key is not in that Map, then do nothing.
+ */
+extern bool
+xen_host_remove_from_logging(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 dfec48cb32dc3c287800d303745987c6a12faf31..f511579c2064ed5ce1fcdb78538eb20b5ede8408 100644 (file)
@@ -59,6 +59,9 @@ static const struct_member xen_host_record_struct_members[] =
         { .key = "resident_VMs",
           .type = &abstract_type_ref_set,
           .offset = offsetof(xen_host_record, resident_vms) },
+        { .key = "logging",
+          .type = &abstract_type_string_string_map,
+          .offset = offsetof(xen_host_record, logging) },
         { .key = "PIFs",
           .type = &abstract_type_ref_set,
           .offset = offsetof(xen_host_record, pifs) },
@@ -94,6 +97,7 @@ xen_host_record_free(xen_host_record *record)
     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_string_string_map_free(record->logging);
     xen_pif_record_opt_set_free(record->pifs);
     xen_pbd_record_opt_set_free(record->pbds);
     xen_host_cpu_record_opt_set_free(record->host_cpus);
@@ -274,6 +278,23 @@ xen_host_get_resident_vms(xen_session *session, struct xen_vm_set **result, xen_
 }
 
 
+bool
+xen_host_get_logging(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_logging");
+    return session->ok;
+}
+
+
 bool
 xen_host_get_pifs(xen_session *session, struct xen_pif_set **result, xen_host host)
 {
@@ -407,6 +428,56 @@ xen_host_remove_from_other_config(xen_session *session, xen_host host, char *key
 }
 
 
+bool
+xen_host_set_logging(xen_session *session, xen_host host, xen_string_string_map *logging)
+{
+    abstract_value param_values[] =
+        {
+            { .type = &abstract_type_string,
+              .u.string_val = host },
+            { .type = &abstract_type_string_string_map,
+              .u.set_val = (arbitrary_set *)logging }
+        };
+
+    xen_call_(session, "host.set_logging", param_values, 2, NULL, NULL);
+    return session->ok;
+}
+
+
+bool
+xen_host_add_to_logging(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_logging", param_values, 3, NULL, NULL);
+    return session->ok;
+}
+
+
+bool
+xen_host_remove_from_logging(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_logging", param_values, 2, NULL, NULL);
+    return session->ok;
+}
+
+
 bool
 xen_host_disable(xen_session *session, xen_host host)
 {