com.xensource.xenapi.Host Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xen-api Show documentation
Show all versions of xen-api Show documentation
Mavenized build of the XenServer SDK for Java.
/*
* Copyright (c) 2006-2008 Citrix Systems, Inc.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of version 2 of the GNU General Public License as published
* by the Free Software Foundation, with the additional linking exception as
* follows:
*
* Linking this library statically or dynamically with other modules is
* making a combined work based on this library. Thus, the terms and
* conditions of the GNU General Public License cover the whole combination.
*
* As a special exception, the copyright holders of this library give you
* permission to link this library with independent modules to produce an
* executable, regardless of the license terms of these independent modules,
* and to copy and distribute the resulting executable under terms of your
* choice, provided that you also meet, for each linked independent module,
* the terms and conditions of the license of that module. An independent
* module is a module which is not derived from or based on this library. If
* you modify this library, you may extend this exception to your version of
* the library, but you are not obligated to do so. If you do not wish to do
* so, delete this exception statement from your version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc., 51
* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package com.xensource.xenapi;
import com.xensource.xenapi.Types.BadServerResponse;
import com.xensource.xenapi.Types.VersionException;
import com.xensource.xenapi.Types.XenAPIException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Date;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import org.apache.xmlrpc.XmlRpcException;
/**
* A physical host
*
* @author Citrix Systems, Inc.
*/
public class Host extends XenAPIObject {
/**
* The XenAPI reference to this object.
*/
protected final String ref;
/**
* For internal use only.
*/
Host(String ref) {
this.ref = ref;
}
public String toWireString() {
return this.ref;
}
/**
* If obj is a Host, compares XenAPI references for equality.
*/
@Override
public boolean equals(Object obj)
{
if (obj != null && obj instanceof Host)
{
Host other = (Host) obj;
return other.ref.equals(this.ref);
} else
{
return false;
}
}
/**
* Represents all the fields in a Host
*/
public static class Record implements Types.Record {
public String toString() {
StringWriter writer = new StringWriter();
PrintWriter print = new PrintWriter(writer);
print.printf("%1$20s: %2$s\n", "uuid", this.uuid);
print.printf("%1$20s: %2$s\n", "nameLabel", this.nameLabel);
print.printf("%1$20s: %2$s\n", "nameDescription", this.nameDescription);
print.printf("%1$20s: %2$s\n", "allowedOperations", this.allowedOperations);
print.printf("%1$20s: %2$s\n", "currentOperations", this.currentOperations);
print.printf("%1$20s: %2$s\n", "APIVersionMajor", this.APIVersionMajor);
print.printf("%1$20s: %2$s\n", "APIVersionMinor", this.APIVersionMinor);
print.printf("%1$20s: %2$s\n", "APIVersionVendor", this.APIVersionVendor);
print.printf("%1$20s: %2$s\n", "APIVersionVendorImplementation", this.APIVersionVendorImplementation);
print.printf("%1$20s: %2$s\n", "enabled", this.enabled);
print.printf("%1$20s: %2$s\n", "softwareVersion", this.softwareVersion);
print.printf("%1$20s: %2$s\n", "otherConfig", this.otherConfig);
print.printf("%1$20s: %2$s\n", "capabilities", this.capabilities);
print.printf("%1$20s: %2$s\n", "cpuConfiguration", this.cpuConfiguration);
print.printf("%1$20s: %2$s\n", "schedPolicy", this.schedPolicy);
print.printf("%1$20s: %2$s\n", "supportedBootloaders", this.supportedBootloaders);
print.printf("%1$20s: %2$s\n", "residentVMs", this.residentVMs);
print.printf("%1$20s: %2$s\n", "logging", this.logging);
print.printf("%1$20s: %2$s\n", "PIFs", this.PIFs);
print.printf("%1$20s: %2$s\n", "suspendImageSr", this.suspendImageSr);
print.printf("%1$20s: %2$s\n", "crashDumpSr", this.crashDumpSr);
print.printf("%1$20s: %2$s\n", "crashdumps", this.crashdumps);
print.printf("%1$20s: %2$s\n", "patches", this.patches);
print.printf("%1$20s: %2$s\n", "PBDs", this.PBDs);
print.printf("%1$20s: %2$s\n", "hostCPUs", this.hostCPUs);
print.printf("%1$20s: %2$s\n", "hostname", this.hostname);
print.printf("%1$20s: %2$s\n", "address", this.address);
print.printf("%1$20s: %2$s\n", "metrics", this.metrics);
print.printf("%1$20s: %2$s\n", "licenseParams", this.licenseParams);
print.printf("%1$20s: %2$s\n", "haStatefiles", this.haStatefiles);
print.printf("%1$20s: %2$s\n", "haNetworkPeers", this.haNetworkPeers);
print.printf("%1$20s: %2$s\n", "blobs", this.blobs);
print.printf("%1$20s: %2$s\n", "tags", this.tags);
return writer.toString();
}
/**
* Convert a host.Record to a Map
*/
public Map toMap() {
Map map = new HashMap();
map.put("uuid", this.uuid == null ? "" : this.uuid);
map.put("name_label", this.nameLabel == null ? "" : this.nameLabel);
map.put("name_description", this.nameDescription == null ? "" : this.nameDescription);
map.put("allowed_operations", this.allowedOperations == null ? new LinkedHashSet() : this.allowedOperations);
map.put("current_operations", this.currentOperations == null ? new HashMap() : this.currentOperations);
map.put("API_version_major", this.APIVersionMajor == null ? 0 : this.APIVersionMajor);
map.put("API_version_minor", this.APIVersionMinor == null ? 0 : this.APIVersionMinor);
map.put("API_version_vendor", this.APIVersionVendor == null ? "" : this.APIVersionVendor);
map.put("API_version_vendor_implementation", this.APIVersionVendorImplementation == null ? new HashMap() : this.APIVersionVendorImplementation);
map.put("enabled", this.enabled == null ? false : this.enabled);
map.put("software_version", this.softwareVersion == null ? new HashMap() : this.softwareVersion);
map.put("other_config", this.otherConfig == null ? new HashMap() : this.otherConfig);
map.put("capabilities", this.capabilities == null ? new LinkedHashSet() : this.capabilities);
map.put("cpu_configuration", this.cpuConfiguration == null ? new HashMap() : this.cpuConfiguration);
map.put("sched_policy", this.schedPolicy == null ? "" : this.schedPolicy);
map.put("supported_bootloaders", this.supportedBootloaders == null ? new LinkedHashSet() : this.supportedBootloaders);
map.put("resident_VMs", this.residentVMs == null ? new LinkedHashSet() : this.residentVMs);
map.put("logging", this.logging == null ? new HashMap() : this.logging);
map.put("PIFs", this.PIFs == null ? new LinkedHashSet() : this.PIFs);
map.put("suspend_image_sr", this.suspendImageSr == null ? new SR("OpaqueRef:NULL") : this.suspendImageSr);
map.put("crash_dump_sr", this.crashDumpSr == null ? new SR("OpaqueRef:NULL") : this.crashDumpSr);
map.put("crashdumps", this.crashdumps == null ? new LinkedHashSet() : this.crashdumps);
map.put("patches", this.patches == null ? new LinkedHashSet() : this.patches);
map.put("PBDs", this.PBDs == null ? new LinkedHashSet() : this.PBDs);
map.put("host_CPUs", this.hostCPUs == null ? new LinkedHashSet() : this.hostCPUs);
map.put("hostname", this.hostname == null ? "" : this.hostname);
map.put("address", this.address == null ? "" : this.address);
map.put("metrics", this.metrics == null ? new HostMetrics("OpaqueRef:NULL") : this.metrics);
map.put("license_params", this.licenseParams == null ? new HashMap() : this.licenseParams);
map.put("ha_statefiles", this.haStatefiles == null ? new LinkedHashSet() : this.haStatefiles);
map.put("ha_network_peers", this.haNetworkPeers == null ? new LinkedHashSet() : this.haNetworkPeers);
map.put("blobs", this.blobs == null ? new HashMap() : this.blobs);
map.put("tags", this.tags == null ? new LinkedHashSet() : this.tags);
return map;
}
/**
* unique identifier/object reference
*/
public String uuid;
/**
* a human-readable name
*/
public String nameLabel;
/**
* a notes field containg human-readable description
*/
public String nameDescription;
/**
* list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
*/
public Set allowedOperations;
/**
* links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
*/
public Map currentOperations;
/**
* major version number
*/
public Long APIVersionMajor;
/**
* minor version number
*/
public Long APIVersionMinor;
/**
* identification of vendor
*/
public String APIVersionVendor;
/**
* details of vendor implementation
*/
public Map APIVersionVendorImplementation;
/**
* True if the host is currently enabled
*/
public Boolean enabled;
/**
* version strings
*/
public Map softwareVersion;
/**
* additional configuration
*/
public Map otherConfig;
/**
* Xen capabilities
*/
public Set capabilities;
/**
* The CPU configuration on this host. May contain keys such as "nr_nodes", "sockets_per_node", "cores_per_socket", or "threads_per_core"
*/
public Map cpuConfiguration;
/**
* Scheduler policy currently in force on this host
*/
public String schedPolicy;
/**
* a list of the bootloaders installed on the machine
*/
public Set supportedBootloaders;
/**
* list of VMs currently resident on host
*/
public Set residentVMs;
/**
* logging configuration
*/
public Map logging;
/**
* physical network interfaces
*/
public Set PIFs;
/**
* The SR in which VDIs for suspend images are created
*/
public SR suspendImageSr;
/**
* The SR in which VDIs for crash dumps are created
*/
public SR crashDumpSr;
/**
* Set of host crash dumps
*/
public Set crashdumps;
/**
* Set of host patches
*/
public Set patches;
/**
* physical blockdevices
*/
public Set PBDs;
/**
* The physical CPUs on this host
*/
public Set hostCPUs;
/**
* The hostname of this host
*/
public String hostname;
/**
* The address by which this host can be contacted from any other host in the pool
*/
public String address;
/**
* metrics associated with this host
*/
public HostMetrics metrics;
/**
* The key/value pairs read from the license file
*/
public Map licenseParams;
/**
* The set of statefiles accessible from this host
*/
public Set haStatefiles;
/**
* The set of hosts visible via the network from this host
*/
public Set haNetworkPeers;
/**
* Binary blobs associated with this host
*/
public Map blobs;
/**
* user-specified tags for categorization purposes
*/
public Set tags;
}
/**
* Get a record containing the current state of the given host.
*
* @return all fields from the object
*/
public Host.Record getRecord(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_record";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toHostRecord(result);
}
/**
* Get a reference to the host instance with the specified UUID.
*
* @param uuid UUID of object to return
* @return reference to the object
*/
public static Host getByUuid(Connection c, String uuid) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_by_uuid";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(uuid)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toHost(result);
}
/**
* Get all the host instances with the given label.
*
* @param label label of object to return
* @return references to objects with matching names
*/
public static Set getByNameLabel(Connection c, String label) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_by_name_label";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(label)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfHost(result);
}
/**
* Get the uuid field of the given host.
*
* @return value of the field
*/
public String getUuid(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_uuid";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Get the name/label field of the given host.
*
* @return value of the field
*/
public String getNameLabel(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_name_label";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Get the name/description field of the given host.
*
* @return value of the field
*/
public String getNameDescription(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_name_description";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Get the allowed_operations field of the given host.
*
* @return value of the field
*/
public Set getAllowedOperations(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_allowed_operations";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfHostAllowedOperations(result);
}
/**
* Get the current_operations field of the given host.
*
* @return value of the field
*/
public Map getCurrentOperations(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_current_operations";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfStringHostAllowedOperations(result);
}
/**
* Get the API_version/major field of the given host.
*
* @return value of the field
*/
public Long getAPIVersionMajor(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_API_version_major";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toLong(result);
}
/**
* Get the API_version/minor field of the given host.
*
* @return value of the field
*/
public Long getAPIVersionMinor(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_API_version_minor";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toLong(result);
}
/**
* Get the API_version/vendor field of the given host.
*
* @return value of the field
*/
public String getAPIVersionVendor(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_API_version_vendor";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Get the API_version/vendor_implementation field of the given host.
*
* @return value of the field
*/
public Map getAPIVersionVendorImplementation(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_API_version_vendor_implementation";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfStringString(result);
}
/**
* Get the enabled field of the given host.
*
* @return value of the field
*/
public Boolean getEnabled(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_enabled";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toBoolean(result);
}
/**
* Get the software_version field of the given host.
*
* @return value of the field
*/
public Map getSoftwareVersion(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_software_version";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfStringString(result);
}
/**
* Get the other_config field of the given host.
*
* @return value of the field
*/
public Map getOtherConfig(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_other_config";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfStringString(result);
}
/**
* Get the capabilities field of the given host.
*
* @return value of the field
*/
public Set getCapabilities(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_capabilities";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfString(result);
}
/**
* Get the cpu_configuration field of the given host.
*
* @return value of the field
*/
public Map getCpuConfiguration(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_cpu_configuration";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfStringString(result);
}
/**
* Get the sched_policy field of the given host.
*
* @return value of the field
*/
public String getSchedPolicy(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_sched_policy";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Get the supported_bootloaders field of the given host.
*
* @return value of the field
*/
public Set getSupportedBootloaders(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_supported_bootloaders";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfString(result);
}
/**
* Get the resident_VMs field of the given host.
*
* @return value of the field
*/
public Set getResidentVMs(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_resident_VMs";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfVM(result);
}
/**
* Get the logging field of the given host.
*
* @return value of the field
*/
public Map getLogging(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_logging";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfStringString(result);
}
/**
* Get the PIFs field of the given host.
*
* @return value of the field
*/
public Set getPIFs(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_PIFs";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfPIF(result);
}
/**
* Get the suspend_image_sr field of the given host.
*
* @return value of the field
*/
public SR getSuspendImageSr(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_suspend_image_sr";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSR(result);
}
/**
* Get the crash_dump_sr field of the given host.
*
* @return value of the field
*/
public SR getCrashDumpSr(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_crash_dump_sr";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSR(result);
}
/**
* Get the crashdumps field of the given host.
*
* @return value of the field
*/
public Set getCrashdumps(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_crashdumps";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfHostCrashdump(result);
}
/**
* Get the patches field of the given host.
*
* @return value of the field
*/
public Set getPatches(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_patches";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfHostPatch(result);
}
/**
* Get the PBDs field of the given host.
*
* @return value of the field
*/
public Set getPBDs(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_PBDs";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfPBD(result);
}
/**
* Get the host_CPUs field of the given host.
*
* @return value of the field
*/
public Set getHostCPUs(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_host_CPUs";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfHostCpu(result);
}
/**
* Get the hostname field of the given host.
*
* @return value of the field
*/
public String getHostname(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_hostname";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Get the address field of the given host.
*
* @return value of the field
*/
public String getAddress(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_address";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Get the metrics field of the given host.
*
* @return value of the field
*/
public HostMetrics getMetrics(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_metrics";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toHostMetrics(result);
}
/**
* Get the license_params field of the given host.
*
* @return value of the field
*/
public Map getLicenseParams(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_license_params";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfStringString(result);
}
/**
* Get the ha_statefiles field of the given host.
*
* @return value of the field
*/
public Set getHaStatefiles(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_ha_statefiles";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfString(result);
}
/**
* Get the ha_network_peers field of the given host.
*
* @return value of the field
*/
public Set getHaNetworkPeers(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_ha_network_peers";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfString(result);
}
/**
* Get the blobs field of the given host.
*
* @return value of the field
*/
public Map getBlobs(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_blobs";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfStringBlob(result);
}
/**
* Get the tags field of the given host.
*
* @return value of the field
*/
public Set getTags(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_tags";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfString(result);
}
/**
* Set the name/label field of the given host.
*
* @param label New value to set
*/
public void setNameLabel(Connection c, String label) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.set_name_label";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(label)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Set the name/description field of the given host.
*
* @param description New value to set
*/
public void setNameDescription(Connection c, String description) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.set_name_description";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(description)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Set the other_config field of the given host.
*
* @param otherConfig New value to set
*/
public void setOtherConfig(Connection c, Map otherConfig) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.set_other_config";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(otherConfig)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Add the given key-value pair to the other_config field of the given host.
*
* @param key Key to add
* @param value Value to add
*/
public void addToOtherConfig(Connection c, String key, String value) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.add_to_other_config";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(key), Marshalling.toXMLRPC(value)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* 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.
*
* @param key Key to remove
*/
public void removeFromOtherConfig(Connection c, String key) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.remove_from_other_config";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(key)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Set the logging field of the given host.
*
* @param logging New value to set
*/
public void setLogging(Connection c, Map logging) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.set_logging";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(logging)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Add the given key-value pair to the logging field of the given host.
*
* @param key Key to add
* @param value Value to add
*/
public void addToLogging(Connection c, String key, String value) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.add_to_logging";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(key), Marshalling.toXMLRPC(value)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* 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.
*
* @param key Key to remove
*/
public void removeFromLogging(Connection c, String key) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.remove_from_logging";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(key)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Set the suspend_image_sr field of the given host.
*
* @param suspendImageSr New value to set
*/
public void setSuspendImageSr(Connection c, SR suspendImageSr) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.set_suspend_image_sr";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(suspendImageSr)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Set the crash_dump_sr field of the given host.
*
* @param crashDumpSr New value to set
*/
public void setCrashDumpSr(Connection c, SR crashDumpSr) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.set_crash_dump_sr";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(crashDumpSr)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Set the hostname field of the given host.
*
* @param hostname New value to set
*/
public void setHostname(Connection c, String hostname) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.set_hostname";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(hostname)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Set the address field of the given host.
*
* @param address New value to set
*/
public void setAddress(Connection c, String address) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.set_address";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(address)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Set the tags field of the given host.
*
* @param tags New value to set
*/
public void setTags(Connection c, Set tags) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.set_tags";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(tags)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing.
*
* @param value New value to add
*/
public void addTags(Connection c, String value) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.add_tags";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(value)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing.
*
* @param value Value to remove
*/
public void removeTags(Connection c, String value) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.remove_tags";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(value)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.
*
* @return Task
*/
public Task disableAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.disable";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.
*
*/
public void disable(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.disable";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Puts the host into a state in which new VMs can be started.
*
* @return Task
*/
public Task enableAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.enable";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Puts the host into a state in which new VMs can be started.
*
*/
public void enable(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.enable";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
*
* @return Task
*/
public Task shutdownAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.shutdown";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
*
*/
public void shutdown(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.shutdown";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
*
* @return Task
*/
public Task rebootAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.reboot";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
*
*/
public void reboot(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.reboot";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Get the host xen dmesg.
*
* @return Task
*/
public Task dmesgAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.dmesg";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Get the host xen dmesg.
*
* @return dmesg string
*/
public String dmesg(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.dmesg";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Get the host xen dmesg, and clear the buffer.
*
* @return Task
*/
public Task dmesgClearAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.dmesg_clear";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Get the host xen dmesg, and clear the buffer.
*
* @return dmesg string
*/
public String dmesgClear(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.dmesg_clear";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Get the host's log file
*
* @return Task
*/
public Task getLogAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.get_log";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Get the host's log file
*
* @return The contents of the host's primary log file
*/
public String getLog(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_log";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Inject the given string as debugging keys into Xen
*
* @param keys The keys to send
* @return Task
*/
public Task sendDebugKeysAsync(Connection c, String keys) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.send_debug_keys";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(keys)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Inject the given string as debugging keys into Xen
*
* @param keys The keys to send
*/
public void sendDebugKeys(Connection c, String keys) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.send_debug_keys";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(keys)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Run xen-bugtool --yestoall and upload the output to Citrix support
*
* @param url The URL to upload to
* @param options Extra configuration operations
* @return Task
*/
public Task bugreportUploadAsync(Connection c, String url, Map options) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.bugreport_upload";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(url), Marshalling.toXMLRPC(options)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Run xen-bugtool --yestoall and upload the output to Citrix support
*
* @param url The URL to upload to
* @param options Extra configuration operations
*/
public void bugreportUpload(Connection c, String url, Map options) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.bugreport_upload";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(url), Marshalling.toXMLRPC(options)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* List all supported methods
*
* @return The name of every supported method.
*/
public static Set listMethods(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.list_methods";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfString(result);
}
/**
* Apply a new license to a host
*
* @param contents The contents of the license file, base64 encoded
* @return Task
*/
public Task licenseApplyAsync(Connection c, String contents) throws
BadServerResponse,
XenAPIException,
XmlRpcException,
Types.LicenseProcessingError {
String method_call = "Async.host.license_apply";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(contents)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Apply a new license to a host
*
* @param contents The contents of the license file, base64 encoded
*/
public void licenseApply(Connection c, String contents) throws
BadServerResponse,
XenAPIException,
XmlRpcException,
Types.LicenseProcessingError {
String method_call = "host.license_apply";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(contents)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Destroy specified host record in database
*
* @return Task
*/
public Task destroyAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.destroy";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Destroy specified host record in database
*
*/
public void destroy(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.destroy";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Attempt to power-on the host (if the capability exists).
*
* @return Task
*/
public Task powerOnAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.power_on";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Attempt to power-on the host (if the capability exists).
*
*/
public void powerOn(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.power_on";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* This call disables HA on the local host. This should only be used with extreme care.
*
*/
public static void emergencyHaDisable(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.emergency_ha_disable";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
*
*
* @return A set of data sources
*/
public Set getDataSources(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_data_sources";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfDataSourceRecord(result);
}
/**
* Start recording the specified data source
*
* @param dataSource The data source to record
*/
public void recordDataSource(Connection c, String dataSource) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.record_data_source";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(dataSource)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Query the latest value of the specified data source
*
* @param dataSource The data source to query
* @return The latest value, averaged over the last 5 seconds
*/
public Double queryDataSource(Connection c, String dataSource) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.query_data_source";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(dataSource)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toDouble(result);
}
/**
* Forget the recorded statistics related to the specified data source
*
* @param dataSource The data source whose archives are to be forgotten
*/
public void forgetDataSourceArchives(Connection c, String dataSource) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.forget_data_source_archives";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(dataSource)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Check this host can be evacuated.
*
* @return Task
*/
public Task assertCanEvacuateAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.assert_can_evacuate";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Check this host can be evacuated.
*
*/
public void assertCanEvacuate(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.assert_can_evacuate";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Return a set of VMs which prevent the host being evacuated, with per-VM error codes
*
* @return Task
*/
public Task getVmsWhichPreventEvacuationAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.get_vms_which_prevent_evacuation";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Return a set of VMs which prevent the host being evacuated, with per-VM error codes
*
* @return VMs which block evacuation together with reasons
*/
public Map> getVmsWhichPreventEvacuation(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_vms_which_prevent_evacuation";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfVMSetOfString(result);
}
/**
* Disable the host and Migrate all VMs off of it, where possible.
*
* @return Task
*/
public Task evacuateAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.evacuate";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Disable the host and Migrate all VMs off of it, where possible.
*
*/
public void evacuate(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.evacuate";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Re-configure syslog logging
*
* @return Task
*/
public Task syslogReconfigureAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.syslog_reconfigure";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Re-configure syslog logging
*
*/
public void syslogReconfigure(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.syslog_reconfigure";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Reconfigure the management network interface
*
* @param pif reference to a PIF object corresponding to the management interface
* @return Task
*/
public static Task managementReconfigureAsync(Connection c, PIF pif) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.management_reconfigure";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(pif)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Reconfigure the management network interface
*
* @param pif reference to a PIF object corresponding to the management interface
*/
public static void managementReconfigure(Connection c, PIF pif) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.management_reconfigure";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(pif)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken.
*
* @param iface name of the interface to use as a management interface
*/
public static void localManagementReconfigure(Connection c, String iface) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.local_management_reconfigure";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(iface)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Disable the management network interface
*
*/
public static void managementDisable(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.management_disable";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
*
*
* @return An XML fragment containing the system status capabilities.
*/
public String getSystemStatusCapabilities(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_system_status_capabilities";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* Restarts the agent after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called.
*
* @return Task
*/
public Task restartAgentAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.restart_agent";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Restarts the agent after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called.
*
*/
public void restartAgent(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.restart_agent";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Shuts the agent down after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called.
*
*/
public static void shutdownAgent(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.shutdown_agent";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately.
*
* @param hostname The new host name
*/
public void setHostnameLive(Connection c, String hostname) throws
BadServerResponse,
XenAPIException,
XmlRpcException,
Types.HostNameInvalid {
String method_call = "host.set_hostname_live";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(hostname)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Computes the amount of free memory on the host.
*
* @return Task
*/
public Task computeFreeMemoryAsync(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.compute_free_memory";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Computes the amount of free memory on the host.
*
* @return the amount of free memory on the host.
*/
public Long computeFreeMemory(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.compute_free_memory";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toLong(result);
}
/**
* This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host
*
*/
public void syncData(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.sync_data";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* This causes the RRDs to be backed up to the master
*
* @param delay Delay in seconds from when the call is received to perform the backup
*/
public void backupRrds(Connection c, Double delay) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.backup_rrds";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(delay)};
Map response = c.dispatch(method_call, method_params);
return;
}
/**
* Create a placeholder for a named binary blob of data that is associated with this host
*
* @param name The name associated with the blob
* @param mimeType The mime type for the data. Empty string translates to application/octet-stream
* @return Task
*/
public Task createNewBlobAsync(Connection c, String name, String mimeType) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.create_new_blob";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(name), Marshalling.toXMLRPC(mimeType)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Create a placeholder for a named binary blob of data that is associated with this host
*
* @param name The name associated with the blob
* @param mimeType The mime type for the data. Empty string translates to application/octet-stream
* @return The reference of the blob, needed for populating its data
*/
public Blob createNewBlob(Connection c, String name, String mimeType) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.create_new_blob";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(name), Marshalling.toXMLRPC(mimeType)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toBlob(result);
}
/**
* Call a XenAPI plugin on this host
*
* @param plugin The name of the plugin
* @param fn The name of the function within the plugin
* @param args Arguments for the function
* @return Task
*/
public Task callPluginAsync(Connection c, String plugin, String fn, Map args) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "Async.host.call_plugin";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(plugin), Marshalling.toXMLRPC(fn), Marshalling.toXMLRPC(args)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toTask(result);
}
/**
* Call a XenAPI plugin on this host
*
* @param plugin The name of the plugin
* @param fn The name of the function within the plugin
* @param args Arguments for the function
* @return Result from the plugin
*/
public String callPlugin(Connection c, String plugin, String fn, Map args) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.call_plugin";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(plugin), Marshalling.toXMLRPC(fn), Marshalling.toXMLRPC(args)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toString(result);
}
/**
* This call queries the host's clock for the current time
*
* @return The current time
*/
public Date getServertime(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_servertime";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toDate(result);
}
/**
* Return a list of all the hosts known to the system.
*
* @return references to all objects
*/
public static Set getAll(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_all";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toSetOfHost(result);
}
/**
* Return a map of host references to host records for all hosts known to the system.
*
* @return records of all objects
*/
public static Map getAllRecords(Connection c) throws
BadServerResponse,
XenAPIException,
XmlRpcException {
String method_call = "host.get_all_records";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session)};
Map response = c.dispatch(method_call, method_params);
Object result = response.get("Value");
return Types.toMapOfHostHostRecord(result);
}
}