/* * Copyright (c) Citrix Systems, Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1) Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2) Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials * provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. */ using System; using System.Collections; using System.Collections.Generic; namespace XenAPI { /// /// A virtual GPU (vGPU) /// First published in XenServer 6.0. /// public partial class VGPU : XenObject { public VGPU() { } public VGPU(string uuid, XenRef VM, XenRef GPU_group, string device, bool currently_attached, Dictionary other_config, XenRef type, XenRef resident_on, XenRef scheduled_to_be_resident_on) { this.uuid = uuid; this.VM = VM; this.GPU_group = GPU_group; this.device = device; this.currently_attached = currently_attached; this.other_config = other_config; this.type = type; this.resident_on = resident_on; this.scheduled_to_be_resident_on = scheduled_to_be_resident_on; } /// /// Creates a new VGPU from a Proxy_VGPU. /// /// public VGPU(Proxy_VGPU proxy) { this.UpdateFromProxy(proxy); } public override void UpdateFrom(VGPU update) { uuid = update.uuid; VM = update.VM; GPU_group = update.GPU_group; device = update.device; currently_attached = update.currently_attached; other_config = update.other_config; type = update.type; resident_on = update.resident_on; scheduled_to_be_resident_on = update.scheduled_to_be_resident_on; } internal void UpdateFromProxy(Proxy_VGPU proxy) { uuid = proxy.uuid == null ? null : (string)proxy.uuid; VM = proxy.VM == null ? null : XenRef.Create(proxy.VM); GPU_group = proxy.GPU_group == null ? null : XenRef.Create(proxy.GPU_group); device = proxy.device == null ? null : (string)proxy.device; currently_attached = (bool)proxy.currently_attached; other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config); type = proxy.type == null ? null : XenRef.Create(proxy.type); resident_on = proxy.resident_on == null ? null : XenRef.Create(proxy.resident_on); scheduled_to_be_resident_on = proxy.scheduled_to_be_resident_on == null ? null : XenRef.Create(proxy.scheduled_to_be_resident_on); } public Proxy_VGPU ToProxy() { Proxy_VGPU result_ = new Proxy_VGPU(); result_.uuid = uuid ?? ""; result_.VM = VM ?? ""; result_.GPU_group = GPU_group ?? ""; result_.device = device ?? ""; result_.currently_attached = currently_attached; result_.other_config = Maps.convert_to_proxy_string_string(other_config); result_.type = type ?? ""; result_.resident_on = resident_on ?? ""; result_.scheduled_to_be_resident_on = scheduled_to_be_resident_on ?? ""; return result_; } /// /// Creates a new VGPU from a Hashtable. /// /// public VGPU(Hashtable table) { uuid = Marshalling.ParseString(table, "uuid"); VM = Marshalling.ParseRef(table, "VM"); GPU_group = Marshalling.ParseRef(table, "GPU_group"); device = Marshalling.ParseString(table, "device"); currently_attached = Marshalling.ParseBool(table, "currently_attached"); other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config")); type = Marshalling.ParseRef(table, "type"); resident_on = Marshalling.ParseRef(table, "resident_on"); scheduled_to_be_resident_on = Marshalling.ParseRef(table, "scheduled_to_be_resident_on"); } public bool DeepEquals(VGPU other) { if (ReferenceEquals(null, other)) return false; if (ReferenceEquals(this, other)) return true; return Helper.AreEqual2(this._uuid, other._uuid) && Helper.AreEqual2(this._VM, other._VM) && Helper.AreEqual2(this._GPU_group, other._GPU_group) && Helper.AreEqual2(this._device, other._device) && Helper.AreEqual2(this._currently_attached, other._currently_attached) && Helper.AreEqual2(this._other_config, other._other_config) && Helper.AreEqual2(this._type, other._type) && Helper.AreEqual2(this._resident_on, other._resident_on) && Helper.AreEqual2(this._scheduled_to_be_resident_on, other._scheduled_to_be_resident_on); } internal static List ProxyArrayToObjectList(Proxy_VGPU[] input) { var result = new List(); foreach (var item in input) result.Add(new VGPU(item)); return result; } public override string SaveChanges(Session session, string opaqueRef, VGPU server) { if (opaqueRef == null) { System.Diagnostics.Debug.Assert(false, "Cannot create instances of this type on the server"); return ""; } else { if (!Helper.AreEqual2(_other_config, server._other_config)) { VGPU.set_other_config(session, opaqueRef, _other_config); } return null; } } /// /// Get a record containing the current state of the given VGPU. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu public static VGPU get_record(Session session, string _vgpu) { return new VGPU((Proxy_VGPU)session.proxy.vgpu_get_record(session.uuid, _vgpu ?? "").parse()); } /// /// Get a reference to the VGPU instance with the specified UUID. /// First published in XenServer 6.0. /// /// The session /// UUID of object to return public static XenRef get_by_uuid(Session session, string _uuid) { return XenRef.Create(session.proxy.vgpu_get_by_uuid(session.uuid, _uuid ?? "").parse()); } /// /// Get the uuid field of the given VGPU. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu public static string get_uuid(Session session, string _vgpu) { return (string)session.proxy.vgpu_get_uuid(session.uuid, _vgpu ?? "").parse(); } /// /// Get the VM field of the given VGPU. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu public static XenRef get_VM(Session session, string _vgpu) { return XenRef.Create(session.proxy.vgpu_get_vm(session.uuid, _vgpu ?? "").parse()); } /// /// Get the GPU_group field of the given VGPU. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu public static XenRef get_GPU_group(Session session, string _vgpu) { return XenRef.Create(session.proxy.vgpu_get_gpu_group(session.uuid, _vgpu ?? "").parse()); } /// /// Get the device field of the given VGPU. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu public static string get_device(Session session, string _vgpu) { return (string)session.proxy.vgpu_get_device(session.uuid, _vgpu ?? "").parse(); } /// /// Get the currently_attached field of the given VGPU. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu public static bool get_currently_attached(Session session, string _vgpu) { return (bool)session.proxy.vgpu_get_currently_attached(session.uuid, _vgpu ?? "").parse(); } /// /// Get the other_config field of the given VGPU. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu public static Dictionary get_other_config(Session session, string _vgpu) { return Maps.convert_from_proxy_string_string(session.proxy.vgpu_get_other_config(session.uuid, _vgpu ?? "").parse()); } /// /// Get the type field of the given VGPU. /// First published in XenServer 6.2 SP1 Tech-Preview. /// /// The session /// The opaque_ref of the given vgpu public static XenRef get_type(Session session, string _vgpu) { return XenRef.Create(session.proxy.vgpu_get_type(session.uuid, _vgpu ?? "").parse()); } /// /// Get the resident_on field of the given VGPU. /// First published in XenServer 6.2 SP1 Tech-Preview. /// /// The session /// The opaque_ref of the given vgpu public static XenRef get_resident_on(Session session, string _vgpu) { return XenRef.Create(session.proxy.vgpu_get_resident_on(session.uuid, _vgpu ?? "").parse()); } /// /// Get the scheduled_to_be_resident_on field of the given VGPU. /// First published in XenServer 7.0. /// /// The session /// The opaque_ref of the given vgpu public static XenRef get_scheduled_to_be_resident_on(Session session, string _vgpu) { return XenRef.Create(session.proxy.vgpu_get_scheduled_to_be_resident_on(session.uuid, _vgpu ?? "").parse()); } /// /// Set the other_config field of the given VGPU. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu /// New value to set public static void set_other_config(Session session, string _vgpu, Dictionary _other_config) { session.proxy.vgpu_set_other_config(session.uuid, _vgpu ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse(); } /// /// Add the given key-value pair to the other_config field of the given VGPU. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu /// Key to add /// Value to add public static void add_to_other_config(Session session, string _vgpu, string _key, string _value) { session.proxy.vgpu_add_to_other_config(session.uuid, _vgpu ?? "", _key ?? "", _value ?? "").parse(); } /// /// Remove the given key and its corresponding value from the other_config field of the given VGPU. If the key is not in that Map, then do nothing. /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu /// Key to remove public static void remove_from_other_config(Session session, string _vgpu, string _key) { session.proxy.vgpu_remove_from_other_config(session.uuid, _vgpu ?? "", _key ?? "").parse(); } /// /// /// First published in XenServer 6.0. /// /// The session /// /// /// /// public static XenRef create(Session session, string _vm, string _gpu_group, string _device, Dictionary _other_config) { return XenRef.Create(session.proxy.vgpu_create(session.uuid, _vm ?? "", _gpu_group ?? "", _device ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse()); } /// /// /// First published in XenServer 6.0. /// /// The session /// /// /// /// public static XenRef async_create(Session session, string _vm, string _gpu_group, string _device, Dictionary _other_config) { return XenRef.Create(session.proxy.async_vgpu_create(session.uuid, _vm ?? "", _gpu_group ?? "", _device ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse()); } /// /// /// First published in XenServer 6.0. /// /// The session /// /// /// /// /// First published in XenServer 6.2 SP1 Tech-Preview. public static XenRef create(Session session, string _vm, string _gpu_group, string _device, Dictionary _other_config, string _type) { return XenRef.Create(session.proxy.vgpu_create(session.uuid, _vm ?? "", _gpu_group ?? "", _device ?? "", Maps.convert_to_proxy_string_string(_other_config), _type ?? "").parse()); } /// /// /// First published in XenServer 6.0. /// /// The session /// /// /// /// /// First published in XenServer 6.2 SP1 Tech-Preview. public static XenRef async_create(Session session, string _vm, string _gpu_group, string _device, Dictionary _other_config, string _type) { return XenRef.Create(session.proxy.async_vgpu_create(session.uuid, _vm ?? "", _gpu_group ?? "", _device ?? "", Maps.convert_to_proxy_string_string(_other_config), _type ?? "").parse()); } /// /// /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu public static void destroy(Session session, string _vgpu) { session.proxy.vgpu_destroy(session.uuid, _vgpu ?? "").parse(); } /// /// /// First published in XenServer 6.0. /// /// The session /// The opaque_ref of the given vgpu public static XenRef async_destroy(Session session, string _vgpu) { return XenRef.Create(session.proxy.async_vgpu_destroy(session.uuid, _vgpu ?? "").parse()); } /// /// Return a list of all the VGPUs known to the system. /// First published in XenServer 6.0. /// /// The session public static List> get_all(Session session) { return XenRef.Create(session.proxy.vgpu_get_all(session.uuid).parse()); } /// /// Get all the VGPU Records at once, in a single XML RPC call /// First published in XenServer 6.0. /// /// The session public static Dictionary, VGPU> get_all_records(Session session) { return XenRef.Create(session.proxy.vgpu_get_all_records(session.uuid).parse()); } /// /// Unique identifier/object reference /// public virtual string uuid { get { return _uuid; } set { if (!Helper.AreEqual(value, _uuid)) { _uuid = value; Changed = true; NotifyPropertyChanged("uuid"); } } } private string _uuid; /// /// VM that owns the vGPU /// public virtual XenRef VM { get { return _VM; } set { if (!Helper.AreEqual(value, _VM)) { _VM = value; Changed = true; NotifyPropertyChanged("VM"); } } } private XenRef _VM; /// /// GPU group used by the vGPU /// public virtual XenRef GPU_group { get { return _GPU_group; } set { if (!Helper.AreEqual(value, _GPU_group)) { _GPU_group = value; Changed = true; NotifyPropertyChanged("GPU_group"); } } } private XenRef _GPU_group; /// /// Order in which the devices are plugged into the VM /// public virtual string device { get { return _device; } set { if (!Helper.AreEqual(value, _device)) { _device = value; Changed = true; NotifyPropertyChanged("device"); } } } private string _device; /// /// Reflects whether the virtual device is currently connected to a physical device /// public virtual bool currently_attached { get { return _currently_attached; } set { if (!Helper.AreEqual(value, _currently_attached)) { _currently_attached = value; Changed = true; NotifyPropertyChanged("currently_attached"); } } } private bool _currently_attached; /// /// Additional configuration /// public virtual Dictionary other_config { get { return _other_config; } set { if (!Helper.AreEqual(value, _other_config)) { _other_config = value; Changed = true; NotifyPropertyChanged("other_config"); } } } private Dictionary _other_config; /// /// Preset type for this VGPU /// First published in XenServer 6.2 SP1 Tech-Preview. /// public virtual XenRef type { get { return _type; } set { if (!Helper.AreEqual(value, _type)) { _type = value; Changed = true; NotifyPropertyChanged("type"); } } } private XenRef _type; /// /// The PGPU on which this VGPU is running /// First published in XenServer 6.2 SP1 Tech-Preview. /// public virtual XenRef resident_on { get { return _resident_on; } set { if (!Helper.AreEqual(value, _resident_on)) { _resident_on = value; Changed = true; NotifyPropertyChanged("resident_on"); } } } private XenRef _resident_on; /// /// The PGPU on which this VGPU is scheduled to run /// First published in XenServer 7.0. /// public virtual XenRef scheduled_to_be_resident_on { get { return _scheduled_to_be_resident_on; } set { if (!Helper.AreEqual(value, _scheduled_to_be_resident_on)) { _scheduled_to_be_resident_on = value; Changed = true; NotifyPropertyChanged("scheduled_to_be_resident_on"); } } } private XenRef _scheduled_to_be_resident_on; } }