/* * 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; using System.ComponentModel; using System.Globalization; using System.Linq; using Newtonsoft.Json; namespace XenAPI { /// /// The metrics associated with a physical network interface /// First published in XenServer 4.0. /// public partial class PIF_metrics : XenObject { #region Constructors public PIF_metrics() { } public PIF_metrics(string uuid, double io_read_kbs, double io_write_kbs, bool carrier, string vendor_id, string vendor_name, string device_id, string device_name, long speed, bool duplex, string pci_bus_path, DateTime last_updated, Dictionary other_config) { this.uuid = uuid; this.io_read_kbs = io_read_kbs; this.io_write_kbs = io_write_kbs; this.carrier = carrier; this.vendor_id = vendor_id; this.vendor_name = vendor_name; this.device_id = device_id; this.device_name = device_name; this.speed = speed; this.duplex = duplex; this.pci_bus_path = pci_bus_path; this.last_updated = last_updated; this.other_config = other_config; } /// /// Creates a new PIF_metrics from a Hashtable. /// Note that the fields not contained in the Hashtable /// will be created with their default values. /// /// public PIF_metrics(Hashtable table) : this() { UpdateFrom(table); } /// /// Creates a new PIF_metrics from a Proxy_PIF_metrics. /// /// public PIF_metrics(Proxy_PIF_metrics proxy) { UpdateFrom(proxy); } #endregion /// /// Updates each field of this instance with the value of /// the corresponding field of a given PIF_metrics. /// public override void UpdateFrom(PIF_metrics record) { uuid = record.uuid; io_read_kbs = record.io_read_kbs; io_write_kbs = record.io_write_kbs; carrier = record.carrier; vendor_id = record.vendor_id; vendor_name = record.vendor_name; device_id = record.device_id; device_name = record.device_name; speed = record.speed; duplex = record.duplex; pci_bus_path = record.pci_bus_path; last_updated = record.last_updated; other_config = record.other_config; } internal void UpdateFrom(Proxy_PIF_metrics proxy) { uuid = proxy.uuid == null ? null : proxy.uuid; io_read_kbs = Convert.ToDouble(proxy.io_read_kbs); io_write_kbs = Convert.ToDouble(proxy.io_write_kbs); carrier = (bool)proxy.carrier; vendor_id = proxy.vendor_id == null ? null : proxy.vendor_id; vendor_name = proxy.vendor_name == null ? null : proxy.vendor_name; device_id = proxy.device_id == null ? null : proxy.device_id; device_name = proxy.device_name == null ? null : proxy.device_name; speed = proxy.speed == null ? 0 : long.Parse(proxy.speed); duplex = (bool)proxy.duplex; pci_bus_path = proxy.pci_bus_path == null ? null : proxy.pci_bus_path; last_updated = proxy.last_updated; other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config); } /// /// Given a Hashtable with field-value pairs, it updates the fields of this PIF_metrics /// with the values listed in the Hashtable. Note that only the fields contained /// in the Hashtable will be updated and the rest will remain the same. /// /// public void UpdateFrom(Hashtable table) { if (table.ContainsKey("uuid")) uuid = Marshalling.ParseString(table, "uuid"); if (table.ContainsKey("io_read_kbs")) io_read_kbs = Marshalling.ParseDouble(table, "io_read_kbs"); if (table.ContainsKey("io_write_kbs")) io_write_kbs = Marshalling.ParseDouble(table, "io_write_kbs"); if (table.ContainsKey("carrier")) carrier = Marshalling.ParseBool(table, "carrier"); if (table.ContainsKey("vendor_id")) vendor_id = Marshalling.ParseString(table, "vendor_id"); if (table.ContainsKey("vendor_name")) vendor_name = Marshalling.ParseString(table, "vendor_name"); if (table.ContainsKey("device_id")) device_id = Marshalling.ParseString(table, "device_id"); if (table.ContainsKey("device_name")) device_name = Marshalling.ParseString(table, "device_name"); if (table.ContainsKey("speed")) speed = Marshalling.ParseLong(table, "speed"); if (table.ContainsKey("duplex")) duplex = Marshalling.ParseBool(table, "duplex"); if (table.ContainsKey("pci_bus_path")) pci_bus_path = Marshalling.ParseString(table, "pci_bus_path"); if (table.ContainsKey("last_updated")) last_updated = Marshalling.ParseDateTime(table, "last_updated"); if (table.ContainsKey("other_config")) other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config")); } public Proxy_PIF_metrics ToProxy() { Proxy_PIF_metrics result_ = new Proxy_PIF_metrics(); result_.uuid = uuid ?? ""; result_.io_read_kbs = io_read_kbs; result_.io_write_kbs = io_write_kbs; result_.carrier = carrier; result_.vendor_id = vendor_id ?? ""; result_.vendor_name = vendor_name ?? ""; result_.device_id = device_id ?? ""; result_.device_name = device_name ?? ""; result_.speed = speed.ToString(); result_.duplex = duplex; result_.pci_bus_path = pci_bus_path ?? ""; result_.last_updated = last_updated; result_.other_config = Maps.convert_to_proxy_string_string(other_config); return result_; } public bool DeepEquals(PIF_metrics other) { if (ReferenceEquals(null, other)) return false; if (ReferenceEquals(this, other)) return true; return Helper.AreEqual2(this._uuid, other._uuid) && Helper.AreEqual2(this._io_read_kbs, other._io_read_kbs) && Helper.AreEqual2(this._io_write_kbs, other._io_write_kbs) && Helper.AreEqual2(this._carrier, other._carrier) && Helper.AreEqual2(this._vendor_id, other._vendor_id) && Helper.AreEqual2(this._vendor_name, other._vendor_name) && Helper.AreEqual2(this._device_id, other._device_id) && Helper.AreEqual2(this._device_name, other._device_name) && Helper.AreEqual2(this._speed, other._speed) && Helper.AreEqual2(this._duplex, other._duplex) && Helper.AreEqual2(this._pci_bus_path, other._pci_bus_path) && Helper.AreEqual2(this._last_updated, other._last_updated) && Helper.AreEqual2(this._other_config, other._other_config); } public override string SaveChanges(Session session, string opaqueRef, PIF_metrics 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)) { PIF_metrics.set_other_config(session, opaqueRef, _other_config); } return null; } } /// /// Get a record containing the current state of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static PIF_metrics get_record(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_record(session.opaque_ref, _pif_metrics); else return new PIF_metrics(session.XmlRpcProxy.pif_metrics_get_record(session.opaque_ref, _pif_metrics ?? "").parse()); } /// /// Get a reference to the PIF_metrics instance with the specified UUID. /// First published in XenServer 4.0. /// /// The session /// UUID of object to return public static XenRef get_by_uuid(Session session, string _uuid) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_by_uuid(session.opaque_ref, _uuid); else return XenRef.Create(session.XmlRpcProxy.pif_metrics_get_by_uuid(session.opaque_ref, _uuid ?? "").parse()); } /// /// Get the uuid field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static string get_uuid(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_uuid(session.opaque_ref, _pif_metrics); else return session.XmlRpcProxy.pif_metrics_get_uuid(session.opaque_ref, _pif_metrics ?? "").parse(); } /// /// Get the io/read_kbs field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static double get_io_read_kbs(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_io_read_kbs(session.opaque_ref, _pif_metrics); else return Convert.ToDouble(session.XmlRpcProxy.pif_metrics_get_io_read_kbs(session.opaque_ref, _pif_metrics ?? "").parse()); } /// /// Get the io/write_kbs field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static double get_io_write_kbs(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_io_write_kbs(session.opaque_ref, _pif_metrics); else return Convert.ToDouble(session.XmlRpcProxy.pif_metrics_get_io_write_kbs(session.opaque_ref, _pif_metrics ?? "").parse()); } /// /// Get the carrier field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static bool get_carrier(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_carrier(session.opaque_ref, _pif_metrics); else return (bool)session.XmlRpcProxy.pif_metrics_get_carrier(session.opaque_ref, _pif_metrics ?? "").parse(); } /// /// Get the vendor_id field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static string get_vendor_id(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_vendor_id(session.opaque_ref, _pif_metrics); else return session.XmlRpcProxy.pif_metrics_get_vendor_id(session.opaque_ref, _pif_metrics ?? "").parse(); } /// /// Get the vendor_name field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static string get_vendor_name(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_vendor_name(session.opaque_ref, _pif_metrics); else return session.XmlRpcProxy.pif_metrics_get_vendor_name(session.opaque_ref, _pif_metrics ?? "").parse(); } /// /// Get the device_id field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static string get_device_id(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_device_id(session.opaque_ref, _pif_metrics); else return session.XmlRpcProxy.pif_metrics_get_device_id(session.opaque_ref, _pif_metrics ?? "").parse(); } /// /// Get the device_name field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static string get_device_name(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_device_name(session.opaque_ref, _pif_metrics); else return session.XmlRpcProxy.pif_metrics_get_device_name(session.opaque_ref, _pif_metrics ?? "").parse(); } /// /// Get the speed field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static long get_speed(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_speed(session.opaque_ref, _pif_metrics); else return long.Parse(session.XmlRpcProxy.pif_metrics_get_speed(session.opaque_ref, _pif_metrics ?? "").parse()); } /// /// Get the duplex field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static bool get_duplex(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_duplex(session.opaque_ref, _pif_metrics); else return (bool)session.XmlRpcProxy.pif_metrics_get_duplex(session.opaque_ref, _pif_metrics ?? "").parse(); } /// /// Get the pci_bus_path field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static string get_pci_bus_path(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_pci_bus_path(session.opaque_ref, _pif_metrics); else return session.XmlRpcProxy.pif_metrics_get_pci_bus_path(session.opaque_ref, _pif_metrics ?? "").parse(); } /// /// Get the last_updated field of the given PIF_metrics. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given pif_metrics public static DateTime get_last_updated(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_last_updated(session.opaque_ref, _pif_metrics); else return session.XmlRpcProxy.pif_metrics_get_last_updated(session.opaque_ref, _pif_metrics ?? "").parse(); } /// /// Get the other_config field of the given PIF_metrics. /// First published in XenServer 5.0. /// /// The session /// The opaque_ref of the given pif_metrics public static Dictionary get_other_config(Session session, string _pif_metrics) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_other_config(session.opaque_ref, _pif_metrics); else return Maps.convert_from_proxy_string_string(session.XmlRpcProxy.pif_metrics_get_other_config(session.opaque_ref, _pif_metrics ?? "").parse()); } /// /// Set the other_config field of the given PIF_metrics. /// First published in XenServer 5.0. /// /// The session /// The opaque_ref of the given pif_metrics /// New value to set public static void set_other_config(Session session, string _pif_metrics, Dictionary _other_config) { if (session.JsonRpcClient != null) session.JsonRpcClient.pif_metrics_set_other_config(session.opaque_ref, _pif_metrics, _other_config); else session.XmlRpcProxy.pif_metrics_set_other_config(session.opaque_ref, _pif_metrics ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse(); } /// /// Add the given key-value pair to the other_config field of the given PIF_metrics. /// First published in XenServer 5.0. /// /// The session /// The opaque_ref of the given pif_metrics /// Key to add /// Value to add public static void add_to_other_config(Session session, string _pif_metrics, string _key, string _value) { if (session.JsonRpcClient != null) session.JsonRpcClient.pif_metrics_add_to_other_config(session.opaque_ref, _pif_metrics, _key, _value); else session.XmlRpcProxy.pif_metrics_add_to_other_config(session.opaque_ref, _pif_metrics ?? "", _key ?? "", _value ?? "").parse(); } /// /// Remove the given key and its corresponding value from the other_config field of the given PIF_metrics. If the key is not in that Map, then do nothing. /// First published in XenServer 5.0. /// /// The session /// The opaque_ref of the given pif_metrics /// Key to remove public static void remove_from_other_config(Session session, string _pif_metrics, string _key) { if (session.JsonRpcClient != null) session.JsonRpcClient.pif_metrics_remove_from_other_config(session.opaque_ref, _pif_metrics, _key); else session.XmlRpcProxy.pif_metrics_remove_from_other_config(session.opaque_ref, _pif_metrics ?? "", _key ?? "").parse(); } /// /// Return a list of all the PIF_metrics instances known to the system. /// First published in XenServer 4.0. /// /// The session public static List> get_all(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_all(session.opaque_ref); else return XenRef.Create(session.XmlRpcProxy.pif_metrics_get_all(session.opaque_ref).parse()); } /// /// Get all the PIF_metrics Records at once, in a single XML RPC call /// First published in XenServer 4.0. /// /// The session public static Dictionary, PIF_metrics> get_all_records(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pif_metrics_get_all_records(session.opaque_ref); else return XenRef.Create(session.XmlRpcProxy.pif_metrics_get_all_records(session.opaque_ref).parse()); } /// /// Unique identifier/object reference /// public virtual string uuid { get { return _uuid; } set { if (!Helper.AreEqual(value, _uuid)) { _uuid = value; NotifyPropertyChanged("uuid"); } } } private string _uuid = ""; /// /// Read bandwidth (KiB/s) /// public virtual double io_read_kbs { get { return _io_read_kbs; } set { if (!Helper.AreEqual(value, _io_read_kbs)) { _io_read_kbs = value; NotifyPropertyChanged("io_read_kbs"); } } } private double _io_read_kbs; /// /// Write bandwidth (KiB/s) /// public virtual double io_write_kbs { get { return _io_write_kbs; } set { if (!Helper.AreEqual(value, _io_write_kbs)) { _io_write_kbs = value; NotifyPropertyChanged("io_write_kbs"); } } } private double _io_write_kbs; /// /// Report if the PIF got a carrier or not /// public virtual bool carrier { get { return _carrier; } set { if (!Helper.AreEqual(value, _carrier)) { _carrier = value; NotifyPropertyChanged("carrier"); } } } private bool _carrier; /// /// Report vendor ID /// public virtual string vendor_id { get { return _vendor_id; } set { if (!Helper.AreEqual(value, _vendor_id)) { _vendor_id = value; NotifyPropertyChanged("vendor_id"); } } } private string _vendor_id = ""; /// /// Report vendor name /// public virtual string vendor_name { get { return _vendor_name; } set { if (!Helper.AreEqual(value, _vendor_name)) { _vendor_name = value; NotifyPropertyChanged("vendor_name"); } } } private string _vendor_name = ""; /// /// Report device ID /// public virtual string device_id { get { return _device_id; } set { if (!Helper.AreEqual(value, _device_id)) { _device_id = value; NotifyPropertyChanged("device_id"); } } } private string _device_id = ""; /// /// Report device name /// public virtual string device_name { get { return _device_name; } set { if (!Helper.AreEqual(value, _device_name)) { _device_name = value; NotifyPropertyChanged("device_name"); } } } private string _device_name = ""; /// /// Speed of the link (if available) /// public virtual long speed { get { return _speed; } set { if (!Helper.AreEqual(value, _speed)) { _speed = value; NotifyPropertyChanged("speed"); } } } private long _speed; /// /// Full duplex capability of the link (if available) /// public virtual bool duplex { get { return _duplex; } set { if (!Helper.AreEqual(value, _duplex)) { _duplex = value; NotifyPropertyChanged("duplex"); } } } private bool _duplex; /// /// PCI bus path of the pif (if available) /// public virtual string pci_bus_path { get { return _pci_bus_path; } set { if (!Helper.AreEqual(value, _pci_bus_path)) { _pci_bus_path = value; NotifyPropertyChanged("pci_bus_path"); } } } private string _pci_bus_path = ""; /// /// Time at which this information was last updated /// [JsonConverter(typeof(XenDateTimeConverter))] public virtual DateTime last_updated { get { return _last_updated; } set { if (!Helper.AreEqual(value, _last_updated)) { _last_updated = value; NotifyPropertyChanged("last_updated"); } } } private DateTime _last_updated; /// /// additional configuration /// First published in XenServer 5.0. /// [JsonConverter(typeof(StringStringMapConverter))] public virtual Dictionary other_config { get { return _other_config; } set { if (!Helper.AreEqual(value, _other_config)) { _other_config = value; NotifyPropertyChanged("other_config"); } } } private Dictionary _other_config = new Dictionary() {}; } }