/* * Copyright (c) Cloud Software Group, Inc. * * 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 { /// /// Pool-wide patches /// First published in XenServer 4.1. /// public partial class Pool_patch : XenObject { #region Constructors public Pool_patch() { } public Pool_patch(string uuid, string name_label, string name_description, string version, long size, bool pool_applied, List> host_patches, List after_apply_guidance, XenRef pool_update, Dictionary other_config) { this.uuid = uuid; this.name_label = name_label; this.name_description = name_description; this.version = version; this.size = size; this.pool_applied = pool_applied; this.host_patches = host_patches; this.after_apply_guidance = after_apply_guidance; this.pool_update = pool_update; this.other_config = other_config; } /// /// Creates a new Pool_patch from a Hashtable. /// Note that the fields not contained in the Hashtable /// will be created with their default values. /// /// public Pool_patch(Hashtable table) : this() { UpdateFrom(table); } #endregion /// /// Updates each field of this instance with the value of /// the corresponding field of a given Pool_patch. /// public override void UpdateFrom(Pool_patch record) { uuid = record.uuid; name_label = record.name_label; name_description = record.name_description; version = record.version; size = record.size; pool_applied = record.pool_applied; host_patches = record.host_patches; after_apply_guidance = record.after_apply_guidance; pool_update = record.pool_update; other_config = record.other_config; } /// /// Given a Hashtable with field-value pairs, it updates the fields of this Pool_patch /// 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("name_label")) name_label = Marshalling.ParseString(table, "name_label"); if (table.ContainsKey("name_description")) name_description = Marshalling.ParseString(table, "name_description"); if (table.ContainsKey("version")) version = Marshalling.ParseString(table, "version"); if (table.ContainsKey("size")) size = Marshalling.ParseLong(table, "size"); if (table.ContainsKey("pool_applied")) pool_applied = Marshalling.ParseBool(table, "pool_applied"); if (table.ContainsKey("host_patches")) host_patches = Marshalling.ParseSetRef(table, "host_patches"); if (table.ContainsKey("after_apply_guidance")) after_apply_guidance = Helper.StringArrayToEnumList(Marshalling.ParseStringArray(table, "after_apply_guidance")); if (table.ContainsKey("pool_update")) pool_update = Marshalling.ParseRef(table, "pool_update"); if (table.ContainsKey("other_config")) other_config = Maps.ToDictionary_string_string(Marshalling.ParseHashTable(table, "other_config")); } public bool DeepEquals(Pool_patch other) { if (ReferenceEquals(null, other)) return false; if (ReferenceEquals(this, other)) return true; return Helper.AreEqual2(_uuid, other._uuid) && Helper.AreEqual2(_name_label, other._name_label) && Helper.AreEqual2(_name_description, other._name_description) && Helper.AreEqual2(_version, other._version) && Helper.AreEqual2(_size, other._size) && Helper.AreEqual2(_pool_applied, other._pool_applied) && Helper.AreEqual2(_host_patches, other._host_patches) && Helper.AreEqual2(_after_apply_guidance, other._after_apply_guidance) && Helper.AreEqual2(_pool_update, other._pool_update) && Helper.AreEqual2(_other_config, other._other_config); } public override string SaveChanges(Session session, string opaqueRef, Pool_patch 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_patch.set_other_config(session, opaqueRef, _other_config); } return null; } } /// /// Get a record containing the current state of the given pool_patch. /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch [Deprecated("XenServer 7.1")] public static Pool_patch get_record(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_record(session.opaque_ref, _pool_patch); } /// /// Get a reference to the pool_patch instance with the specified UUID. /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// UUID of object to return [Deprecated("XenServer 7.1")] public static XenRef get_by_uuid(Session session, string _uuid) { return session.JsonRpcClient.pool_patch_get_by_uuid(session.opaque_ref, _uuid); } /// /// Get all the pool_patch instances with the given label. /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// label of object to return [Deprecated("XenServer 7.1")] public static List> get_by_name_label(Session session, string _label) { return session.JsonRpcClient.pool_patch_get_by_name_label(session.opaque_ref, _label); } /// /// Get the uuid field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch public static string get_uuid(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_uuid(session.opaque_ref, _pool_patch); } /// /// Get the name/label field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch public static string get_name_label(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_name_label(session.opaque_ref, _pool_patch); } /// /// Get the name/description field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch public static string get_name_description(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_name_description(session.opaque_ref, _pool_patch); } /// /// Get the version field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch public static string get_version(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_version(session.opaque_ref, _pool_patch); } /// /// Get the size field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch public static long get_size(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_size(session.opaque_ref, _pool_patch); } /// /// Get the pool_applied field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch public static bool get_pool_applied(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_pool_applied(session.opaque_ref, _pool_patch); } /// /// Get the host_patches field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch public static List> get_host_patches(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_host_patches(session.opaque_ref, _pool_patch); } /// /// Get the after_apply_guidance field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch public static List get_after_apply_guidance(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_after_apply_guidance(session.opaque_ref, _pool_patch); } /// /// Get the pool_update field of the given pool_patch. /// First published in XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch public static XenRef get_pool_update(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_pool_update(session.opaque_ref, _pool_patch); } /// /// Get the other_config field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch public static Dictionary get_other_config(Session session, string _pool_patch) { return session.JsonRpcClient.pool_patch_get_other_config(session.opaque_ref, _pool_patch); } /// /// Set the other_config field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch /// New value to set public static void set_other_config(Session session, string _pool_patch, Dictionary _other_config) { session.JsonRpcClient.pool_patch_set_other_config(session.opaque_ref, _pool_patch, _other_config); } /// /// Add the given key-value pair to the other_config field of the given pool_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch /// Key to add /// Value to add public static void add_to_other_config(Session session, string _pool_patch, string _key, string _value) { session.JsonRpcClient.pool_patch_add_to_other_config(session.opaque_ref, _pool_patch, _key, _value); } /// /// Remove the given key and its corresponding value from the other_config field of the given pool_patch. If the key is not in that Map, then do nothing. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given pool_patch /// Key to remove public static void remove_from_other_config(Session session, string _pool_patch, string _key) { session.JsonRpcClient.pool_patch_remove_from_other_config(session.opaque_ref, _pool_patch, _key); } /// /// Apply the selected patch to a host and return its output /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch /// The host to apply the patch too [Deprecated("XenServer 7.1")] public static string apply(Session session, string _pool_patch, string _host) { return session.JsonRpcClient.pool_patch_apply(session.opaque_ref, _pool_patch, _host); } /// /// Apply the selected patch to a host and return its output /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch /// The host to apply the patch too [Deprecated("XenServer 7.1")] public static XenRef async_apply(Session session, string _pool_patch, string _host) { return session.JsonRpcClient.async_pool_patch_apply(session.opaque_ref, _pool_patch, _host); } /// /// Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch [Deprecated("XenServer 7.1")] public static void pool_apply(Session session, string _pool_patch) { session.JsonRpcClient.pool_patch_pool_apply(session.opaque_ref, _pool_patch); } /// /// Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch [Deprecated("XenServer 7.1")] public static XenRef async_pool_apply(Session session, string _pool_patch) { return session.JsonRpcClient.async_pool_patch_pool_apply(session.opaque_ref, _pool_patch); } /// /// Execute the precheck stage of the selected patch on a host and return its output /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch /// The host to run the prechecks on [Deprecated("XenServer 7.1")] public static string precheck(Session session, string _pool_patch, string _host) { return session.JsonRpcClient.pool_patch_precheck(session.opaque_ref, _pool_patch, _host); } /// /// Execute the precheck stage of the selected patch on a host and return its output /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch /// The host to run the prechecks on [Deprecated("XenServer 7.1")] public static XenRef async_precheck(Session session, string _pool_patch, string _host) { return session.JsonRpcClient.async_pool_patch_precheck(session.opaque_ref, _pool_patch, _host); } /// /// Removes the patch's files from the server /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch [Deprecated("XenServer 7.1")] public static void clean(Session session, string _pool_patch) { session.JsonRpcClient.pool_patch_clean(session.opaque_ref, _pool_patch); } /// /// Removes the patch's files from the server /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch [Deprecated("XenServer 7.1")] public static XenRef async_clean(Session session, string _pool_patch) { return session.JsonRpcClient.async_pool_patch_clean(session.opaque_ref, _pool_patch); } /// /// Removes the patch's files from all hosts in the pool, but does not remove the database entries /// First published in XenServer 6.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch [Deprecated("XenServer 7.1")] public static void pool_clean(Session session, string _pool_patch) { session.JsonRpcClient.pool_patch_pool_clean(session.opaque_ref, _pool_patch); } /// /// Removes the patch's files from all hosts in the pool, but does not remove the database entries /// First published in XenServer 6.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch [Deprecated("XenServer 7.1")] public static XenRef async_pool_clean(Session session, string _pool_patch) { return session.JsonRpcClient.async_pool_patch_pool_clean(session.opaque_ref, _pool_patch); } /// /// Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches. /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch [Deprecated("XenServer 7.1")] public static void destroy(Session session, string _pool_patch) { session.JsonRpcClient.pool_patch_destroy(session.opaque_ref, _pool_patch); } /// /// Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches. /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch [Deprecated("XenServer 7.1")] public static XenRef async_destroy(Session session, string _pool_patch) { return session.JsonRpcClient.async_pool_patch_destroy(session.opaque_ref, _pool_patch); } /// /// Removes the patch's files from the specified host /// First published in XenServer 6.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch /// The host on which to clean the patch [Deprecated("XenServer 7.1")] public static void clean_on_host(Session session, string _pool_patch, string _host) { session.JsonRpcClient.pool_patch_clean_on_host(session.opaque_ref, _pool_patch, _host); } /// /// Removes the patch's files from the specified host /// First published in XenServer 6.1. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given pool_patch /// The host on which to clean the patch [Deprecated("XenServer 7.1")] public static XenRef async_clean_on_host(Session session, string _pool_patch, string _host) { return session.JsonRpcClient.async_pool_patch_clean_on_host(session.opaque_ref, _pool_patch, _host); } /// /// Return a list of all the pool_patchs known to the system. /// First published in XenServer 4.1. /// Deprecated since XenServer 7.1. /// /// The session [Deprecated("XenServer 7.1")] public static List> get_all(Session session) { return session.JsonRpcClient.pool_patch_get_all(session.opaque_ref); } /// /// Get all the pool_patch Records at once, in a single XML RPC call /// First published in XenServer 4.1. /// /// The session public static Dictionary, Pool_patch> get_all_records(Session session) { return session.JsonRpcClient.pool_patch_get_all_records(session.opaque_ref); } /// /// Unique identifier/object reference /// public virtual string uuid { get { return _uuid; } set { if (!Helper.AreEqual(value, _uuid)) { _uuid = value; 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; 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; NotifyPropertyChanged("name_description"); } } } private string _name_description = ""; /// /// Patch version number /// public virtual string version { get { return _version; } set { if (!Helper.AreEqual(value, _version)) { _version = value; NotifyPropertyChanged("version"); } } } private string _version = ""; /// /// Size of the patch /// public virtual long size { get { return _size; } set { if (!Helper.AreEqual(value, _size)) { _size = value; NotifyPropertyChanged("size"); } } } private long _size = 0; /// /// This patch should be applied across the entire pool /// public virtual bool pool_applied { get { return _pool_applied; } set { if (!Helper.AreEqual(value, _pool_applied)) { _pool_applied = value; NotifyPropertyChanged("pool_applied"); } } } private bool _pool_applied = false; /// /// This hosts this patch is applied to. /// [JsonConverter(typeof(XenRefListConverter))] public virtual List> host_patches { get { return _host_patches; } set { if (!Helper.AreEqual(value, _host_patches)) { _host_patches = value; NotifyPropertyChanged("host_patches"); } } } private List> _host_patches = new List>() {}; /// /// What the client should do after this patch 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; NotifyPropertyChanged("after_apply_guidance"); } } } private List _after_apply_guidance = new List() {}; /// /// A reference to the associated pool_update object /// First published in XenServer 7.1. /// [JsonConverter(typeof(XenRefConverter))] public virtual XenRef pool_update { get { return _pool_update; } set { if (!Helper.AreEqual(value, _pool_update)) { _pool_update = value; NotifyPropertyChanged("pool_update"); } } } private XenRef _pool_update = new XenRef("OpaqueRef:NULL"); /// /// additional configuration /// [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() {}; } }