xenadmin/XenModel/XenAPI/PCI.cs
Konstantina Chremmou eb85c8113a Updated C# SDK (xapi 1.303.0-1.xs8)
Signed-off-by: Konstantina Chremmou <konstantina.chremmou@citrix.com>
2021-06-23 15:29:53 +01:00

672 lines
27 KiB
C#
Executable File

/*
* 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
{
/// <summary>
/// A PCI device
/// First published in XenServer 6.0.
/// </summary>
public partial class PCI : XenObject<PCI>
{
#region Constructors
public PCI()
{
}
public PCI(string uuid,
string class_name,
string vendor_name,
string device_name,
XenRef<Host> host,
string pci_id,
List<XenRef<PCI>> dependencies,
Dictionary<string, string> other_config,
string subsystem_vendor_name,
string subsystem_device_name,
string driver_name)
{
this.uuid = uuid;
this.class_name = class_name;
this.vendor_name = vendor_name;
this.device_name = device_name;
this.host = host;
this.pci_id = pci_id;
this.dependencies = dependencies;
this.other_config = other_config;
this.subsystem_vendor_name = subsystem_vendor_name;
this.subsystem_device_name = subsystem_device_name;
this.driver_name = driver_name;
}
/// <summary>
/// Creates a new PCI from a Hashtable.
/// Note that the fields not contained in the Hashtable
/// will be created with their default values.
/// </summary>
/// <param name="table"></param>
public PCI(Hashtable table)
: this()
{
UpdateFrom(table);
}
/// <summary>
/// Creates a new PCI from a Proxy_PCI.
/// </summary>
/// <param name="proxy"></param>
public PCI(Proxy_PCI proxy)
{
UpdateFrom(proxy);
}
#endregion
/// <summary>
/// Updates each field of this instance with the value of
/// the corresponding field of a given PCI.
/// </summary>
public override void UpdateFrom(PCI record)
{
uuid = record.uuid;
class_name = record.class_name;
vendor_name = record.vendor_name;
device_name = record.device_name;
host = record.host;
pci_id = record.pci_id;
dependencies = record.dependencies;
other_config = record.other_config;
subsystem_vendor_name = record.subsystem_vendor_name;
subsystem_device_name = record.subsystem_device_name;
driver_name = record.driver_name;
}
internal void UpdateFrom(Proxy_PCI proxy)
{
uuid = proxy.uuid == null ? null : proxy.uuid;
class_name = proxy.class_name == null ? null : proxy.class_name;
vendor_name = proxy.vendor_name == null ? null : proxy.vendor_name;
device_name = proxy.device_name == null ? null : proxy.device_name;
host = proxy.host == null ? null : XenRef<Host>.Create(proxy.host);
pci_id = proxy.pci_id == null ? null : proxy.pci_id;
dependencies = proxy.dependencies == null ? null : XenRef<PCI>.Create(proxy.dependencies);
other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config);
subsystem_vendor_name = proxy.subsystem_vendor_name == null ? null : proxy.subsystem_vendor_name;
subsystem_device_name = proxy.subsystem_device_name == null ? null : proxy.subsystem_device_name;
driver_name = proxy.driver_name == null ? null : proxy.driver_name;
}
/// <summary>
/// Given a Hashtable with field-value pairs, it updates the fields of this PCI
/// 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.
/// </summary>
/// <param name="table"></param>
public void UpdateFrom(Hashtable table)
{
if (table.ContainsKey("uuid"))
uuid = Marshalling.ParseString(table, "uuid");
if (table.ContainsKey("class_name"))
class_name = Marshalling.ParseString(table, "class_name");
if (table.ContainsKey("vendor_name"))
vendor_name = Marshalling.ParseString(table, "vendor_name");
if (table.ContainsKey("device_name"))
device_name = Marshalling.ParseString(table, "device_name");
if (table.ContainsKey("host"))
host = Marshalling.ParseRef<Host>(table, "host");
if (table.ContainsKey("pci_id"))
pci_id = Marshalling.ParseString(table, "pci_id");
if (table.ContainsKey("dependencies"))
dependencies = Marshalling.ParseSetRef<PCI>(table, "dependencies");
if (table.ContainsKey("other_config"))
other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config"));
if (table.ContainsKey("subsystem_vendor_name"))
subsystem_vendor_name = Marshalling.ParseString(table, "subsystem_vendor_name");
if (table.ContainsKey("subsystem_device_name"))
subsystem_device_name = Marshalling.ParseString(table, "subsystem_device_name");
if (table.ContainsKey("driver_name"))
driver_name = Marshalling.ParseString(table, "driver_name");
}
public Proxy_PCI ToProxy()
{
Proxy_PCI result_ = new Proxy_PCI();
result_.uuid = uuid ?? "";
result_.class_name = class_name ?? "";
result_.vendor_name = vendor_name ?? "";
result_.device_name = device_name ?? "";
result_.host = host ?? "";
result_.pci_id = pci_id ?? "";
result_.dependencies = dependencies == null ? new string[] {} : Helper.RefListToStringArray(dependencies);
result_.other_config = Maps.convert_to_proxy_string_string(other_config);
result_.subsystem_vendor_name = subsystem_vendor_name ?? "";
result_.subsystem_device_name = subsystem_device_name ?? "";
result_.driver_name = driver_name ?? "";
return result_;
}
public bool DeepEquals(PCI other)
{
if (ReferenceEquals(null, other))
return false;
if (ReferenceEquals(this, other))
return true;
return Helper.AreEqual2(this._uuid, other._uuid) &&
Helper.AreEqual2(this._class_name, other._class_name) &&
Helper.AreEqual2(this._vendor_name, other._vendor_name) &&
Helper.AreEqual2(this._device_name, other._device_name) &&
Helper.AreEqual2(this._host, other._host) &&
Helper.AreEqual2(this._pci_id, other._pci_id) &&
Helper.AreEqual2(this._dependencies, other._dependencies) &&
Helper.AreEqual2(this._other_config, other._other_config) &&
Helper.AreEqual2(this._subsystem_vendor_name, other._subsystem_vendor_name) &&
Helper.AreEqual2(this._subsystem_device_name, other._subsystem_device_name) &&
Helper.AreEqual2(this._driver_name, other._driver_name);
}
public override string SaveChanges(Session session, string opaqueRef, PCI 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))
{
PCI.set_other_config(session, opaqueRef, _other_config);
}
return null;
}
}
/// <summary>
/// Get a record containing the current state of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static PCI get_record(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_record(session.opaque_ref, _pci);
else
return new PCI(session.XmlRpcProxy.pci_get_record(session.opaque_ref, _pci ?? "").parse());
}
/// <summary>
/// Get a reference to the PCI instance with the specified UUID.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_uuid">UUID of object to return</param>
public static XenRef<PCI> get_by_uuid(Session session, string _uuid)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_by_uuid(session.opaque_ref, _uuid);
else
return XenRef<PCI>.Create(session.XmlRpcProxy.pci_get_by_uuid(session.opaque_ref, _uuid ?? "").parse());
}
/// <summary>
/// Get the uuid field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static string get_uuid(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_uuid(session.opaque_ref, _pci);
else
return session.XmlRpcProxy.pci_get_uuid(session.opaque_ref, _pci ?? "").parse();
}
/// <summary>
/// Get the class_name field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static string get_class_name(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_class_name(session.opaque_ref, _pci);
else
return session.XmlRpcProxy.pci_get_class_name(session.opaque_ref, _pci ?? "").parse();
}
/// <summary>
/// Get the vendor_name field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static string get_vendor_name(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_vendor_name(session.opaque_ref, _pci);
else
return session.XmlRpcProxy.pci_get_vendor_name(session.opaque_ref, _pci ?? "").parse();
}
/// <summary>
/// Get the device_name field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static string get_device_name(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_device_name(session.opaque_ref, _pci);
else
return session.XmlRpcProxy.pci_get_device_name(session.opaque_ref, _pci ?? "").parse();
}
/// <summary>
/// Get the host field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static XenRef<Host> get_host(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_host(session.opaque_ref, _pci);
else
return XenRef<Host>.Create(session.XmlRpcProxy.pci_get_host(session.opaque_ref, _pci ?? "").parse());
}
/// <summary>
/// Get the pci_id field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static string get_pci_id(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_pci_id(session.opaque_ref, _pci);
else
return session.XmlRpcProxy.pci_get_pci_id(session.opaque_ref, _pci ?? "").parse();
}
/// <summary>
/// Get the dependencies field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static List<XenRef<PCI>> get_dependencies(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_dependencies(session.opaque_ref, _pci);
else
return XenRef<PCI>.Create(session.XmlRpcProxy.pci_get_dependencies(session.opaque_ref, _pci ?? "").parse());
}
/// <summary>
/// Get the other_config field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static Dictionary<string, string> get_other_config(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_other_config(session.opaque_ref, _pci);
else
return Maps.convert_from_proxy_string_string(session.XmlRpcProxy.pci_get_other_config(session.opaque_ref, _pci ?? "").parse());
}
/// <summary>
/// Get the subsystem_vendor_name field of the given PCI.
/// First published in XenServer 6.2 SP1 Hotfix 11.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static string get_subsystem_vendor_name(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_subsystem_vendor_name(session.opaque_ref, _pci);
else
return session.XmlRpcProxy.pci_get_subsystem_vendor_name(session.opaque_ref, _pci ?? "").parse();
}
/// <summary>
/// Get the subsystem_device_name field of the given PCI.
/// First published in XenServer 6.2 SP1 Hotfix 11.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static string get_subsystem_device_name(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_subsystem_device_name(session.opaque_ref, _pci);
else
return session.XmlRpcProxy.pci_get_subsystem_device_name(session.opaque_ref, _pci ?? "").parse();
}
/// <summary>
/// Get the driver_name field of the given PCI.
/// First published in XenServer 7.5.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
public static string get_driver_name(Session session, string _pci)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_driver_name(session.opaque_ref, _pci);
else
return session.XmlRpcProxy.pci_get_driver_name(session.opaque_ref, _pci ?? "").parse();
}
/// <summary>
/// Set the other_config field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
/// <param name="_other_config">New value to set</param>
public static void set_other_config(Session session, string _pci, Dictionary<string, string> _other_config)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.pci_set_other_config(session.opaque_ref, _pci, _other_config);
else
session.XmlRpcProxy.pci_set_other_config(session.opaque_ref, _pci ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse();
}
/// <summary>
/// Add the given key-value pair to the other_config field of the given PCI.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
/// <param name="_key">Key to add</param>
/// <param name="_value">Value to add</param>
public static void add_to_other_config(Session session, string _pci, string _key, string _value)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.pci_add_to_other_config(session.opaque_ref, _pci, _key, _value);
else
session.XmlRpcProxy.pci_add_to_other_config(session.opaque_ref, _pci ?? "", _key ?? "", _value ?? "").parse();
}
/// <summary>
/// Remove the given key and its corresponding value from the other_config field of the given PCI. If the key is not in that Map, then do nothing.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
/// <param name="_pci">The opaque_ref of the given pci</param>
/// <param name="_key">Key to remove</param>
public static void remove_from_other_config(Session session, string _pci, string _key)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.pci_remove_from_other_config(session.opaque_ref, _pci, _key);
else
session.XmlRpcProxy.pci_remove_from_other_config(session.opaque_ref, _pci ?? "", _key ?? "").parse();
}
/// <summary>
/// Return a list of all the PCIs known to the system.
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
public static List<XenRef<PCI>> get_all(Session session)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_all(session.opaque_ref);
else
return XenRef<PCI>.Create(session.XmlRpcProxy.pci_get_all(session.opaque_ref).parse());
}
/// <summary>
/// Get all the PCI Records at once, in a single XML RPC call
/// First published in XenServer 6.0.
/// </summary>
/// <param name="session">The session</param>
public static Dictionary<XenRef<PCI>, PCI> get_all_records(Session session)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.pci_get_all_records(session.opaque_ref);
else
return XenRef<PCI>.Create<Proxy_PCI>(session.XmlRpcProxy.pci_get_all_records(session.opaque_ref).parse());
}
/// <summary>
/// Unique identifier/object reference
/// </summary>
public virtual string uuid
{
get { return _uuid; }
set
{
if (!Helper.AreEqual(value, _uuid))
{
_uuid = value;
NotifyPropertyChanged("uuid");
}
}
}
private string _uuid = "";
/// <summary>
/// PCI class name
/// </summary>
public virtual string class_name
{
get { return _class_name; }
set
{
if (!Helper.AreEqual(value, _class_name))
{
_class_name = value;
NotifyPropertyChanged("class_name");
}
}
}
private string _class_name = "";
/// <summary>
/// Vendor name
/// </summary>
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 = "";
/// <summary>
/// Device name
/// </summary>
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 = "";
/// <summary>
/// Physical machine that owns the PCI device
/// </summary>
[JsonConverter(typeof(XenRefConverter<Host>))]
public virtual XenRef<Host> host
{
get { return _host; }
set
{
if (!Helper.AreEqual(value, _host))
{
_host = value;
NotifyPropertyChanged("host");
}
}
}
private XenRef<Host> _host = new XenRef<Host>("OpaqueRef:NULL");
/// <summary>
/// PCI ID of the physical device
/// </summary>
public virtual string pci_id
{
get { return _pci_id; }
set
{
if (!Helper.AreEqual(value, _pci_id))
{
_pci_id = value;
NotifyPropertyChanged("pci_id");
}
}
}
private string _pci_id = "";
/// <summary>
/// List of dependent PCI devices
/// </summary>
[JsonConverter(typeof(XenRefListConverter<PCI>))]
public virtual List<XenRef<PCI>> dependencies
{
get { return _dependencies; }
set
{
if (!Helper.AreEqual(value, _dependencies))
{
_dependencies = value;
NotifyPropertyChanged("dependencies");
}
}
}
private List<XenRef<PCI>> _dependencies = new List<XenRef<PCI>>() {};
/// <summary>
/// Additional configuration
/// </summary>
[JsonConverter(typeof(StringStringMapConverter))]
public virtual Dictionary<string, string> other_config
{
get { return _other_config; }
set
{
if (!Helper.AreEqual(value, _other_config))
{
_other_config = value;
NotifyPropertyChanged("other_config");
}
}
}
private Dictionary<string, string> _other_config = new Dictionary<string, string>() {};
/// <summary>
/// Subsystem vendor name
/// First published in XenServer 6.2 SP1 Hotfix 11.
/// </summary>
public virtual string subsystem_vendor_name
{
get { return _subsystem_vendor_name; }
set
{
if (!Helper.AreEqual(value, _subsystem_vendor_name))
{
_subsystem_vendor_name = value;
NotifyPropertyChanged("subsystem_vendor_name");
}
}
}
private string _subsystem_vendor_name = "";
/// <summary>
/// Subsystem device name
/// First published in XenServer 6.2 SP1 Hotfix 11.
/// </summary>
public virtual string subsystem_device_name
{
get { return _subsystem_device_name; }
set
{
if (!Helper.AreEqual(value, _subsystem_device_name))
{
_subsystem_device_name = value;
NotifyPropertyChanged("subsystem_device_name");
}
}
}
private string _subsystem_device_name = "";
/// <summary>
/// Driver name
/// First published in XenServer 7.5.
/// </summary>
public virtual string driver_name
{
get { return _driver_name; }
set
{
if (!Helper.AreEqual(value, _driver_name))
{
_driver_name = value;
NotifyPropertyChanged("driver_name");
}
}
}
private string _driver_name = "";
}
}