/* * 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 Newtonsoft.Json; using Newtonsoft.Json.Converters; namespace XenAPI { /// /// Pool-wide updates to the host software /// First published in XenServer 7.1. /// public partial class Pool_update : XenObject { public Pool_update() { } public Pool_update(string uuid, string name_label, string name_description, string version, long installation_size, string key, List after_apply_guidance, XenRef vdi, List> hosts, Dictionary other_config, bool enforce_homogeneity) { this.uuid = uuid; this.name_label = name_label; this.name_description = name_description; this.version = version; this.installation_size = installation_size; this.key = key; this.after_apply_guidance = after_apply_guidance; this.vdi = vdi; this.hosts = hosts; this.other_config = other_config; this.enforce_homogeneity = enforce_homogeneity; } /// /// Creates a new Pool_update from a Proxy_Pool_update. /// /// public Pool_update(Proxy_Pool_update proxy) { this.UpdateFromProxy(proxy); } public override void UpdateFrom(Pool_update update) { uuid = update.uuid; name_label = update.name_label; name_description = update.name_description; version = update.version; installation_size = update.installation_size; key = update.key; after_apply_guidance = update.after_apply_guidance; vdi = update.vdi; hosts = update.hosts; other_config = update.other_config; enforce_homogeneity = update.enforce_homogeneity; } internal void UpdateFromProxy(Proxy_Pool_update proxy) { uuid = proxy.uuid == null ? null : (string)proxy.uuid; name_label = proxy.name_label == null ? null : (string)proxy.name_label; name_description = proxy.name_description == null ? null : (string)proxy.name_description; version = proxy.version == null ? null : (string)proxy.version; installation_size = proxy.installation_size == null ? 0 : long.Parse((string)proxy.installation_size); key = proxy.key == null ? null : (string)proxy.key; after_apply_guidance = proxy.after_apply_guidance == null ? null : Helper.StringArrayToEnumList(proxy.after_apply_guidance); vdi = proxy.vdi == null ? null : XenRef.Create(proxy.vdi); hosts = proxy.hosts == null ? null : XenRef.Create(proxy.hosts); other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config); enforce_homogeneity = (bool)proxy.enforce_homogeneity; } public Proxy_Pool_update ToProxy() { Proxy_Pool_update result_ = new Proxy_Pool_update(); result_.uuid = uuid ?? ""; result_.name_label = name_label ?? ""; result_.name_description = name_description ?? ""; result_.version = version ?? ""; result_.installation_size = installation_size.ToString(); result_.key = key ?? ""; result_.after_apply_guidance = (after_apply_guidance != null) ? Helper.ObjectListToStringArray(after_apply_guidance) : new string[] {}; result_.vdi = vdi ?? ""; result_.hosts = (hosts != null) ? Helper.RefListToStringArray(hosts) : new string[] {}; result_.other_config = Maps.convert_to_proxy_string_string(other_config); result_.enforce_homogeneity = enforce_homogeneity; return result_; } /// /// Creates a new Pool_update from a Hashtable. /// /// public Pool_update(Hashtable table) { uuid = Marshalling.ParseString(table, "uuid"); name_label = Marshalling.ParseString(table, "name_label"); name_description = Marshalling.ParseString(table, "name_description"); version = Marshalling.ParseString(table, "version"); installation_size = Marshalling.ParseLong(table, "installation_size"); key = Marshalling.ParseString(table, "key"); after_apply_guidance = Helper.StringArrayToEnumList(Marshalling.ParseStringArray(table, "after_apply_guidance")); vdi = Marshalling.ParseRef(table, "vdi"); hosts = Marshalling.ParseSetRef(table, "hosts"); other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config")); enforce_homogeneity = Marshalling.ParseBool(table, "enforce_homogeneity"); } public bool DeepEquals(Pool_update other) { if (ReferenceEquals(null, other)) return false; if (ReferenceEquals(this, other)) return true; return Helper.AreEqual2(this._uuid, other._uuid) && Helper.AreEqual2(this._name_label, other._name_label) && Helper.AreEqual2(this._name_description, other._name_description) && Helper.AreEqual2(this._version, other._version) && Helper.AreEqual2(this._installation_size, other._installation_size) && Helper.AreEqual2(this._key, other._key) && Helper.AreEqual2(this._after_apply_guidance, other._after_apply_guidance) && Helper.AreEqual2(this._vdi, other._vdi) && Helper.AreEqual2(this._hosts, other._hosts) && Helper.AreEqual2(this._other_config, other._other_config) && Helper.AreEqual2(this._enforce_homogeneity, other._enforce_homogeneity); } internal static List ProxyArrayToObjectList(Proxy_Pool_update[] input) { var result = new List(); foreach (var item in input) result.Add(new Pool_update(item)); return result; } public override string SaveChanges(Session session, string opaqueRef, Pool_update 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)) { Pool_update.set_other_config(session, opaqueRef, _other_config); } return null; } } /// /// Get a record containing the current state of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static Pool_update get_record(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_record(session.uuid, _pool_update); else return new Pool_update((Proxy_Pool_update)session.proxy.pool_update_get_record(session.uuid, _pool_update ?? "").parse()); } /// /// Get a reference to the pool_update instance with the specified UUID. /// First published in XenServer 7.1. /// /// The session /// UUID of object to return public static XenRef get_by_uuid(Session session, string _uuid) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_by_uuid(session.uuid, _uuid); else return XenRef.Create(session.proxy.pool_update_get_by_uuid(session.uuid, _uuid ?? "").parse()); } /// /// Get all the pool_update instances with the given label. /// First published in XenServer 7.1. /// /// The session /// label of object to return public static List> get_by_name_label(Session session, string _label) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_by_name_label(session.uuid, _label); else return XenRef.Create(session.proxy.pool_update_get_by_name_label(session.uuid, _label ?? "").parse()); } /// /// Get the uuid field of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static string get_uuid(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_uuid(session.uuid, _pool_update); else return (string)session.proxy.pool_update_get_uuid(session.uuid, _pool_update ?? "").parse(); } /// /// Get the name/label field of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static string get_name_label(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_name_label(session.uuid, _pool_update); else return (string)session.proxy.pool_update_get_name_label(session.uuid, _pool_update ?? "").parse(); } /// /// Get the name/description field of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static string get_name_description(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_name_description(session.uuid, _pool_update); else return (string)session.proxy.pool_update_get_name_description(session.uuid, _pool_update ?? "").parse(); } /// /// Get the version field of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static string get_version(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_version(session.uuid, _pool_update); else return (string)session.proxy.pool_update_get_version(session.uuid, _pool_update ?? "").parse(); } /// /// Get the installation_size field of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static long get_installation_size(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_installation_size(session.uuid, _pool_update); else return long.Parse((string)session.proxy.pool_update_get_installation_size(session.uuid, _pool_update ?? "").parse()); } /// /// Get the key field of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static string get_key(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_key(session.uuid, _pool_update); else return (string)session.proxy.pool_update_get_key(session.uuid, _pool_update ?? "").parse(); } /// /// Get the after_apply_guidance field of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static List get_after_apply_guidance(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_after_apply_guidance(session.uuid, _pool_update); else return Helper.StringArrayToEnumList(session.proxy.pool_update_get_after_apply_guidance(session.uuid, _pool_update ?? "").parse()); } /// /// Get the vdi field of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static XenRef get_vdi(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_vdi(session.uuid, _pool_update); else return XenRef.Create(session.proxy.pool_update_get_vdi(session.uuid, _pool_update ?? "").parse()); } /// /// Get the hosts field of the given pool_update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static List> get_hosts(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_hosts(session.uuid, _pool_update); else return XenRef.Create(session.proxy.pool_update_get_hosts(session.uuid, _pool_update ?? "").parse()); } /// /// Get the other_config field of the given pool_update. /// First published in XenServer 7.3. /// /// The session /// The opaque_ref of the given pool_update public static Dictionary get_other_config(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_other_config(session.uuid, _pool_update); else return Maps.convert_from_proxy_string_string(session.proxy.pool_update_get_other_config(session.uuid, _pool_update ?? "").parse()); } /// /// Get the enforce_homogeneity field of the given pool_update. /// First published in XenServer 7.3. /// /// The session /// The opaque_ref of the given pool_update public static bool get_enforce_homogeneity(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_enforce_homogeneity(session.uuid, _pool_update); else return (bool)session.proxy.pool_update_get_enforce_homogeneity(session.uuid, _pool_update ?? "").parse(); } /// /// Set the other_config field of the given pool_update. /// First published in XenServer 7.3. /// /// The session /// The opaque_ref of the given pool_update /// New value to set public static void set_other_config(Session session, string _pool_update, Dictionary _other_config) { if (session.JsonRpcClient != null) session.JsonRpcClient.pool_update_set_other_config(session.uuid, _pool_update, _other_config); else session.proxy.pool_update_set_other_config(session.uuid, _pool_update ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse(); } /// /// Add the given key-value pair to the other_config field of the given pool_update. /// First published in XenServer 7.3. /// /// The session /// The opaque_ref of the given pool_update /// Key to add /// Value to add public static void add_to_other_config(Session session, string _pool_update, string _key, string _value) { if (session.JsonRpcClient != null) session.JsonRpcClient.pool_update_add_to_other_config(session.uuid, _pool_update, _key, _value); else session.proxy.pool_update_add_to_other_config(session.uuid, _pool_update ?? "", _key ?? "", _value ?? "").parse(); } /// /// Remove the given key and its corresponding value from the other_config field of the given pool_update. If the key is not in that Map, then do nothing. /// First published in XenServer 7.3. /// /// The session /// The opaque_ref of the given pool_update /// Key to remove public static void remove_from_other_config(Session session, string _pool_update, string _key) { if (session.JsonRpcClient != null) session.JsonRpcClient.pool_update_remove_from_other_config(session.uuid, _pool_update, _key); else session.proxy.pool_update_remove_from_other_config(session.uuid, _pool_update ?? "", _key ?? "").parse(); } /// /// Introduce update VDI /// First published in XenServer 7.1. /// /// The session /// The VDI which contains a software update. public static XenRef introduce(Session session, string _vdi) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_introduce(session.uuid, _vdi); else return XenRef.Create(session.proxy.pool_update_introduce(session.uuid, _vdi ?? "").parse()); } /// /// Introduce update VDI /// First published in XenServer 7.1. /// /// The session /// The VDI which contains a software update. public static XenRef async_introduce(Session session, string _vdi) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_pool_update_introduce(session.uuid, _vdi); else return XenRef.Create(session.proxy.async_pool_update_introduce(session.uuid, _vdi ?? "").parse()); } /// /// Execute the precheck stage of the selected update on a host /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update /// The host to run the prechecks on. public static livepatch_status precheck(Session session, string _pool_update, string _host) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_precheck(session.uuid, _pool_update, _host); else return (livepatch_status)Helper.EnumParseDefault(typeof(livepatch_status), (string)session.proxy.pool_update_precheck(session.uuid, _pool_update ?? "", _host ?? "").parse()); } /// /// Execute the precheck stage of the selected update on a host /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update /// The host to run the prechecks on. public static XenRef async_precheck(Session session, string _pool_update, string _host) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_pool_update_precheck(session.uuid, _pool_update, _host); else return XenRef.Create(session.proxy.async_pool_update_precheck(session.uuid, _pool_update ?? "", _host ?? "").parse()); } /// /// Apply the selected update to a host /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update /// The host to apply the update to. public static void apply(Session session, string _pool_update, string _host) { if (session.JsonRpcClient != null) session.JsonRpcClient.pool_update_apply(session.uuid, _pool_update, _host); else session.proxy.pool_update_apply(session.uuid, _pool_update ?? "", _host ?? "").parse(); } /// /// Apply the selected update to a host /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update /// The host to apply the update to. public static XenRef async_apply(Session session, string _pool_update, string _host) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_pool_update_apply(session.uuid, _pool_update, _host); else return XenRef.Create(session.proxy.async_pool_update_apply(session.uuid, _pool_update ?? "", _host ?? "").parse()); } /// /// Apply the selected update to all hosts in the pool /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static void pool_apply(Session session, string _pool_update) { if (session.JsonRpcClient != null) session.JsonRpcClient.pool_update_pool_apply(session.uuid, _pool_update); else session.proxy.pool_update_pool_apply(session.uuid, _pool_update ?? "").parse(); } /// /// Apply the selected update to all hosts in the pool /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static XenRef async_pool_apply(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_pool_update_pool_apply(session.uuid, _pool_update); else return XenRef.Create(session.proxy.async_pool_update_pool_apply(session.uuid, _pool_update ?? "").parse()); } /// /// Removes the update's files from all hosts in the pool, but does not revert the update /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static void pool_clean(Session session, string _pool_update) { if (session.JsonRpcClient != null) session.JsonRpcClient.pool_update_pool_clean(session.uuid, _pool_update); else session.proxy.pool_update_pool_clean(session.uuid, _pool_update ?? "").parse(); } /// /// Removes the update's files from all hosts in the pool, but does not revert the update /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static XenRef async_pool_clean(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_pool_update_pool_clean(session.uuid, _pool_update); else return XenRef.Create(session.proxy.async_pool_update_pool_clean(session.uuid, _pool_update ?? "").parse()); } /// /// Removes the database entry. Only works on unapplied update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static void destroy(Session session, string _pool_update) { if (session.JsonRpcClient != null) session.JsonRpcClient.pool_update_destroy(session.uuid, _pool_update); else session.proxy.pool_update_destroy(session.uuid, _pool_update ?? "").parse(); } /// /// Removes the database entry. Only works on unapplied update. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_update public static XenRef async_destroy(Session session, string _pool_update) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_pool_update_destroy(session.uuid, _pool_update); else return XenRef.Create(session.proxy.async_pool_update_destroy(session.uuid, _pool_update ?? "").parse()); } /// /// Return a list of all the pool_updates known to the system. /// First published in XenServer 7.1. /// /// The session public static List> get_all(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_all(session.uuid); else return XenRef.Create(session.proxy.pool_update_get_all(session.uuid).parse()); } /// /// Get all the pool_update Records at once, in a single XML RPC call /// First published in XenServer 7.1. /// /// The session public static Dictionary, Pool_update> get_all_records(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.pool_update_get_all_records(session.uuid); else return XenRef.Create(session.proxy.pool_update_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 = ""; /// /// a human-readable name /// public virtual string name_label { get { return _name_label; } set { if (!Helper.AreEqual(value, _name_label)) { _name_label = value; Changed = true; NotifyPropertyChanged("name_label"); } } } private string _name_label = ""; /// /// a notes field containing human-readable description /// public virtual string name_description { get { return _name_description; } set { if (!Helper.AreEqual(value, _name_description)) { _name_description = value; Changed = true; NotifyPropertyChanged("name_description"); } } } private string _name_description = ""; /// /// Update version number /// public virtual string version { get { return _version; } set { if (!Helper.AreEqual(value, _version)) { _version = value; Changed = true; NotifyPropertyChanged("version"); } } } private string _version = ""; /// /// Size of the update in bytes /// public virtual long installation_size { get { return _installation_size; } set { if (!Helper.AreEqual(value, _installation_size)) { _installation_size = value; Changed = true; NotifyPropertyChanged("installation_size"); } } } private long _installation_size = 0; /// /// GPG key of the update /// public virtual string key { get { return _key; } set { if (!Helper.AreEqual(value, _key)) { _key = value; Changed = true; NotifyPropertyChanged("key"); } } } private string _key = ""; /// /// What the client should do after this update has been applied. /// public virtual List after_apply_guidance { get { return _after_apply_guidance; } set { if (!Helper.AreEqual(value, _after_apply_guidance)) { _after_apply_guidance = value; Changed = true; NotifyPropertyChanged("after_apply_guidance"); } } } private List _after_apply_guidance = new List() {}; /// /// VDI the update was uploaded to /// [JsonConverter(typeof(XenRefConverter))] public virtual XenRef vdi { get { return _vdi; } set { if (!Helper.AreEqual(value, _vdi)) { _vdi = value; Changed = true; NotifyPropertyChanged("vdi"); } } } private XenRef _vdi = new XenRef(Helper.NullOpaqueRef); /// /// The hosts that have applied this update. /// [JsonConverter(typeof(XenRefListConverter))] public virtual List> hosts { get { return _hosts; } set { if (!Helper.AreEqual(value, _hosts)) { _hosts = value; Changed = true; NotifyPropertyChanged("hosts"); } } } private List> _hosts = new List>() {}; /// /// additional configuration /// First published in XenServer 7.3. /// 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 = new Dictionary() {}; /// /// Flag - if true, all hosts in a pool must apply this update /// First published in XenServer 7.3. /// public virtual bool enforce_homogeneity { get { return _enforce_homogeneity; } set { if (!Helper.AreEqual(value, _enforce_homogeneity)) { _enforce_homogeneity = value; Changed = true; NotifyPropertyChanged("enforce_homogeneity"); } } } private bool _enforce_homogeneity = false; } }