/*
* 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
{
///
/// Cluster-wide Cluster metadata
/// First published in XenServer 7.6.
///
public partial class Cluster : XenObject
{
#region Constructors
public Cluster()
{
}
public Cluster(string uuid,
List> cluster_hosts,
string[] pending_forget,
string cluster_token,
string cluster_stack,
List allowed_operations,
Dictionary current_operations,
bool pool_auto_join,
double token_timeout,
double token_timeout_coefficient,
Dictionary cluster_config,
Dictionary other_config)
{
this.uuid = uuid;
this.cluster_hosts = cluster_hosts;
this.pending_forget = pending_forget;
this.cluster_token = cluster_token;
this.cluster_stack = cluster_stack;
this.allowed_operations = allowed_operations;
this.current_operations = current_operations;
this.pool_auto_join = pool_auto_join;
this.token_timeout = token_timeout;
this.token_timeout_coefficient = token_timeout_coefficient;
this.cluster_config = cluster_config;
this.other_config = other_config;
}
///
/// Creates a new Cluster from a Hashtable.
/// Note that the fields not contained in the Hashtable
/// will be created with their default values.
///
///
public Cluster(Hashtable table)
: this()
{
UpdateFrom(table);
}
#endregion
///
/// Updates each field of this instance with the value of
/// the corresponding field of a given Cluster.
///
public override void UpdateFrom(Cluster record)
{
uuid = record.uuid;
cluster_hosts = record.cluster_hosts;
pending_forget = record.pending_forget;
cluster_token = record.cluster_token;
cluster_stack = record.cluster_stack;
allowed_operations = record.allowed_operations;
current_operations = record.current_operations;
pool_auto_join = record.pool_auto_join;
token_timeout = record.token_timeout;
token_timeout_coefficient = record.token_timeout_coefficient;
cluster_config = record.cluster_config;
other_config = record.other_config;
}
///
/// Given a Hashtable with field-value pairs, it updates the fields of this Cluster
/// 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("cluster_hosts"))
cluster_hosts = Marshalling.ParseSetRef(table, "cluster_hosts");
if (table.ContainsKey("pending_forget"))
pending_forget = Marshalling.ParseStringArray(table, "pending_forget");
if (table.ContainsKey("cluster_token"))
cluster_token = Marshalling.ParseString(table, "cluster_token");
if (table.ContainsKey("cluster_stack"))
cluster_stack = Marshalling.ParseString(table, "cluster_stack");
if (table.ContainsKey("allowed_operations"))
allowed_operations = Helper.StringArrayToEnumList(Marshalling.ParseStringArray(table, "allowed_operations"));
if (table.ContainsKey("current_operations"))
current_operations = Maps.convert_from_proxy_string_cluster_operation(Marshalling.ParseHashTable(table, "current_operations"));
if (table.ContainsKey("pool_auto_join"))
pool_auto_join = Marshalling.ParseBool(table, "pool_auto_join");
if (table.ContainsKey("token_timeout"))
token_timeout = Marshalling.ParseDouble(table, "token_timeout");
if (table.ContainsKey("token_timeout_coefficient"))
token_timeout_coefficient = Marshalling.ParseDouble(table, "token_timeout_coefficient");
if (table.ContainsKey("cluster_config"))
cluster_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "cluster_config"));
if (table.ContainsKey("other_config"))
other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config"));
}
public bool DeepEquals(Cluster other, bool ignoreCurrentOperations)
{
if (ReferenceEquals(null, other))
return false;
if (ReferenceEquals(this, other))
return true;
if (!ignoreCurrentOperations && !Helper.AreEqual2(this.current_operations, other.current_operations))
return false;
return Helper.AreEqual2(this._uuid, other._uuid) &&
Helper.AreEqual2(this._cluster_hosts, other._cluster_hosts) &&
Helper.AreEqual2(this._pending_forget, other._pending_forget) &&
Helper.AreEqual2(this._cluster_token, other._cluster_token) &&
Helper.AreEqual2(this._cluster_stack, other._cluster_stack) &&
Helper.AreEqual2(this._allowed_operations, other._allowed_operations) &&
Helper.AreEqual2(this._pool_auto_join, other._pool_auto_join) &&
Helper.AreEqual2(this._token_timeout, other._token_timeout) &&
Helper.AreEqual2(this._token_timeout_coefficient, other._token_timeout_coefficient) &&
Helper.AreEqual2(this._cluster_config, other._cluster_config) &&
Helper.AreEqual2(this._other_config, other._other_config);
}
public override string SaveChanges(Session session, string opaqueRef, Cluster 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))
{
Cluster.set_other_config(session, opaqueRef, _other_config);
}
return null;
}
}
///
/// Get a record containing the current state of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static Cluster get_record(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_record(session.opaque_ref, _cluster);
}
///
/// Get a reference to the Cluster instance with the specified UUID.
/// First published in XenServer 7.6.
///
/// The session
/// UUID of object to return
public static XenRef get_by_uuid(Session session, string _uuid)
{
return session.JsonRpcClient.cluster_get_by_uuid(session.opaque_ref, _uuid);
}
///
/// Get the uuid field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static string get_uuid(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_uuid(session.opaque_ref, _cluster);
}
///
/// Get the cluster_hosts field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static List> get_cluster_hosts(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_cluster_hosts(session.opaque_ref, _cluster);
}
///
/// Get the pending_forget field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static string[] get_pending_forget(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_pending_forget(session.opaque_ref, _cluster);
}
///
/// Get the cluster_token field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static string get_cluster_token(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_cluster_token(session.opaque_ref, _cluster);
}
///
/// Get the cluster_stack field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static string get_cluster_stack(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_cluster_stack(session.opaque_ref, _cluster);
}
///
/// Get the allowed_operations field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static List get_allowed_operations(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_allowed_operations(session.opaque_ref, _cluster);
}
///
/// Get the current_operations field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static Dictionary get_current_operations(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_current_operations(session.opaque_ref, _cluster);
}
///
/// Get the pool_auto_join field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static bool get_pool_auto_join(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_pool_auto_join(session.opaque_ref, _cluster);
}
///
/// Get the token_timeout field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static double get_token_timeout(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_token_timeout(session.opaque_ref, _cluster);
}
///
/// Get the token_timeout_coefficient field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static double get_token_timeout_coefficient(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_token_timeout_coefficient(session.opaque_ref, _cluster);
}
///
/// Get the cluster_config field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static Dictionary get_cluster_config(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_cluster_config(session.opaque_ref, _cluster);
}
///
/// Get the other_config field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static Dictionary get_other_config(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_other_config(session.opaque_ref, _cluster);
}
///
/// Set the other_config field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
/// New value to set
public static void set_other_config(Session session, string _cluster, Dictionary _other_config)
{
session.JsonRpcClient.cluster_set_other_config(session.opaque_ref, _cluster, _other_config);
}
///
/// Add the given key-value pair to the other_config field of the given Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
/// Key to add
/// Value to add
public static void add_to_other_config(Session session, string _cluster, string _key, string _value)
{
session.JsonRpcClient.cluster_add_to_other_config(session.opaque_ref, _cluster, _key, _value);
}
///
/// Remove the given key and its corresponding value from the other_config field of the given Cluster. If the key is not in that Map, then do nothing.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
/// Key to remove
public static void remove_from_other_config(Session session, string _cluster, string _key)
{
session.JsonRpcClient.cluster_remove_from_other_config(session.opaque_ref, _cluster, _key);
}
///
/// Creates a Cluster object and one Cluster_host object as its first member
/// First published in XenServer 7.6.
///
/// The session
/// The PIF to connect the cluster's first cluster_host to
/// simply the string 'corosync'. No other cluster stacks are currently supported
/// true if xapi is automatically joining new pool members to the cluster
/// Corosync token timeout in seconds
/// Corosync token timeout coefficient in seconds
public static XenRef create(Session session, string _pif, string _cluster_stack, bool _pool_auto_join, double _token_timeout, double _token_timeout_coefficient)
{
return session.JsonRpcClient.cluster_create(session.opaque_ref, _pif, _cluster_stack, _pool_auto_join, _token_timeout, _token_timeout_coefficient);
}
///
/// Creates a Cluster object and one Cluster_host object as its first member
/// First published in XenServer 7.6.
///
/// The session
/// The PIF to connect the cluster's first cluster_host to
/// simply the string 'corosync'. No other cluster stacks are currently supported
/// true if xapi is automatically joining new pool members to the cluster
/// Corosync token timeout in seconds
/// Corosync token timeout coefficient in seconds
public static XenRef async_create(Session session, string _pif, string _cluster_stack, bool _pool_auto_join, double _token_timeout, double _token_timeout_coefficient)
{
return session.JsonRpcClient.async_cluster_create(session.opaque_ref, _pif, _cluster_stack, _pool_auto_join, _token_timeout, _token_timeout_coefficient);
}
///
/// Destroys a Cluster object and the one remaining Cluster_host member
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static void destroy(Session session, string _cluster)
{
session.JsonRpcClient.cluster_destroy(session.opaque_ref, _cluster);
}
///
/// Destroys a Cluster object and the one remaining Cluster_host member
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static XenRef async_destroy(Session session, string _cluster)
{
return session.JsonRpcClient.async_cluster_destroy(session.opaque_ref, _cluster);
}
///
/// Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static XenRef get_network(Session session, string _cluster)
{
return session.JsonRpcClient.cluster_get_network(session.opaque_ref, _cluster);
}
///
/// Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static XenRef async_get_network(Session session, string _cluster)
{
return session.JsonRpcClient.async_cluster_get_network(session.opaque_ref, _cluster);
}
///
/// Attempt to create a Cluster from the entire pool
/// First published in XenServer 7.6.
///
/// The session
/// the single network on which corosync carries out its inter-host communications
/// simply the string 'corosync'. No other cluster stacks are currently supported
/// Corosync token timeout in seconds
/// Corosync token timeout coefficient in seconds
public static XenRef pool_create(Session session, string _network, string _cluster_stack, double _token_timeout, double _token_timeout_coefficient)
{
return session.JsonRpcClient.cluster_pool_create(session.opaque_ref, _network, _cluster_stack, _token_timeout, _token_timeout_coefficient);
}
///
/// Attempt to create a Cluster from the entire pool
/// First published in XenServer 7.6.
///
/// The session
/// the single network on which corosync carries out its inter-host communications
/// simply the string 'corosync'. No other cluster stacks are currently supported
/// Corosync token timeout in seconds
/// Corosync token timeout coefficient in seconds
public static XenRef async_pool_create(Session session, string _network, string _cluster_stack, double _token_timeout, double _token_timeout_coefficient)
{
return session.JsonRpcClient.async_cluster_pool_create(session.opaque_ref, _network, _cluster_stack, _token_timeout, _token_timeout_coefficient);
}
///
/// Attempt to force destroy the Cluster_host objects, and then destroy the Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static void pool_force_destroy(Session session, string _cluster)
{
session.JsonRpcClient.cluster_pool_force_destroy(session.opaque_ref, _cluster);
}
///
/// Attempt to force destroy the Cluster_host objects, and then destroy the Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static XenRef async_pool_force_destroy(Session session, string _cluster)
{
return session.JsonRpcClient.async_cluster_pool_force_destroy(session.opaque_ref, _cluster);
}
///
/// Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static void pool_destroy(Session session, string _cluster)
{
session.JsonRpcClient.cluster_pool_destroy(session.opaque_ref, _cluster);
}
///
/// Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static XenRef async_pool_destroy(Session session, string _cluster)
{
return session.JsonRpcClient.async_cluster_pool_destroy(session.opaque_ref, _cluster);
}
///
/// Resynchronise the cluster_host objects across the pool. Creates them where they need creating and then plugs them
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static void pool_resync(Session session, string _cluster)
{
session.JsonRpcClient.cluster_pool_resync(session.opaque_ref, _cluster);
}
///
/// Resynchronise the cluster_host objects across the pool. Creates them where they need creating and then plugs them
/// First published in XenServer 7.6.
///
/// The session
/// The opaque_ref of the given cluster
public static XenRef async_pool_resync(Session session, string _cluster)
{
return session.JsonRpcClient.async_cluster_pool_resync(session.opaque_ref, _cluster);
}
///
/// Return a list of all the Clusters known to the system.
/// First published in XenServer 7.6.
///
/// The session
public static List> get_all(Session session)
{
return session.JsonRpcClient.cluster_get_all(session.opaque_ref);
}
///
/// Get all the Cluster Records at once, in a single XML RPC call
/// First published in XenServer 7.6.
///
/// The session
public static Dictionary, Cluster> get_all_records(Session session)
{
return session.JsonRpcClient.cluster_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 list of the cluster_host objects associated with the Cluster
///
[JsonConverter(typeof(XenRefListConverter))]
public virtual List> cluster_hosts
{
get { return _cluster_hosts; }
set
{
if (!Helper.AreEqual(value, _cluster_hosts))
{
_cluster_hosts = value;
NotifyPropertyChanged("cluster_hosts");
}
}
}
private List> _cluster_hosts = new List>() {};
///
/// Internal field used by Host.destroy to store the IP of cluster members marked as permanently dead but not yet removed
///
public virtual string[] pending_forget
{
get { return _pending_forget; }
set
{
if (!Helper.AreEqual(value, _pending_forget))
{
_pending_forget = value;
NotifyPropertyChanged("pending_forget");
}
}
}
private string[] _pending_forget = {};
///
/// The secret key used by xapi-clusterd when it talks to itself on other hosts
///
public virtual string cluster_token
{
get { return _cluster_token; }
set
{
if (!Helper.AreEqual(value, _cluster_token))
{
_cluster_token = value;
NotifyPropertyChanged("cluster_token");
}
}
}
private string _cluster_token = "";
///
/// Simply the string 'corosync'. No other cluster stacks are currently supported
///
public virtual string cluster_stack
{
get { return _cluster_stack; }
set
{
if (!Helper.AreEqual(value, _cluster_stack))
{
_cluster_stack = value;
NotifyPropertyChanged("cluster_stack");
}
}
}
private string _cluster_stack = "corosync";
///
/// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
///
public virtual List allowed_operations
{
get { return _allowed_operations; }
set
{
if (!Helper.AreEqual(value, _allowed_operations))
{
_allowed_operations = value;
NotifyPropertyChanged("allowed_operations");
}
}
}
private List _allowed_operations = new List() {};
///
/// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
///
public virtual Dictionary current_operations
{
get { return _current_operations; }
set
{
if (!Helper.AreEqual(value, _current_operations))
{
_current_operations = value;
NotifyPropertyChanged("current_operations");
}
}
}
private Dictionary _current_operations = new Dictionary() {};
///
/// True if automatically joining new pool members to the cluster. This will be `true` in the first release
///
public virtual bool pool_auto_join
{
get { return _pool_auto_join; }
set
{
if (!Helper.AreEqual(value, _pool_auto_join))
{
_pool_auto_join = value;
NotifyPropertyChanged("pool_auto_join");
}
}
}
private bool _pool_auto_join = true;
///
/// The corosync token timeout in seconds
///
public virtual double token_timeout
{
get { return _token_timeout; }
set
{
if (!Helper.AreEqual(value, _token_timeout))
{
_token_timeout = value;
NotifyPropertyChanged("token_timeout");
}
}
}
private double _token_timeout = 20.000;
///
/// The corosync token timeout coefficient in seconds
///
public virtual double token_timeout_coefficient
{
get { return _token_timeout_coefficient; }
set
{
if (!Helper.AreEqual(value, _token_timeout_coefficient))
{
_token_timeout_coefficient = value;
NotifyPropertyChanged("token_timeout_coefficient");
}
}
}
private double _token_timeout_coefficient = 1.000;
///
/// Contains read-only settings for the cluster, such as timeouts and other options. It can only be set at cluster create time
///
[JsonConverter(typeof(StringStringMapConverter))]
public virtual Dictionary cluster_config
{
get { return _cluster_config; }
set
{
if (!Helper.AreEqual(value, _cluster_config))
{
_cluster_config = value;
NotifyPropertyChanged("cluster_config");
}
}
}
private Dictionary _cluster_config = new Dictionary() {};
///
/// 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() {};
}
}