/* * 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 { /// /// A tunnel for network traffic /// First published in XenServer 5.6 FP1. /// public partial class Tunnel : XenObject { #region Constructors public Tunnel() { } public Tunnel(string uuid, XenRef access_PIF, XenRef transport_PIF, Dictionary status, Dictionary other_config, tunnel_protocol protocol) { this.uuid = uuid; this.access_PIF = access_PIF; this.transport_PIF = transport_PIF; this.status = status; this.other_config = other_config; this.protocol = protocol; } /// /// Creates a new Tunnel from a Hashtable. /// Note that the fields not contained in the Hashtable /// will be created with their default values. /// /// public Tunnel(Hashtable table) : this() { UpdateFrom(table); } /// /// Creates a new Tunnel from a Proxy_Tunnel. /// /// public Tunnel(Proxy_Tunnel proxy) { UpdateFrom(proxy); } #endregion /// /// Updates each field of this instance with the value of /// the corresponding field of a given Tunnel. /// public override void UpdateFrom(Tunnel record) { uuid = record.uuid; access_PIF = record.access_PIF; transport_PIF = record.transport_PIF; status = record.status; other_config = record.other_config; protocol = record.protocol; } internal void UpdateFrom(Proxy_Tunnel proxy) { uuid = proxy.uuid == null ? null : proxy.uuid; access_PIF = proxy.access_PIF == null ? null : XenRef.Create(proxy.access_PIF); transport_PIF = proxy.transport_PIF == null ? null : XenRef.Create(proxy.transport_PIF); status = proxy.status == null ? null : Maps.convert_from_proxy_string_string(proxy.status); other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config); protocol = proxy.protocol == null ? (tunnel_protocol) 0 : (tunnel_protocol)Helper.EnumParseDefault(typeof(tunnel_protocol), (string)proxy.protocol); } /// /// Given a Hashtable with field-value pairs, it updates the fields of this Tunnel /// 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("access_PIF")) access_PIF = Marshalling.ParseRef(table, "access_PIF"); if (table.ContainsKey("transport_PIF")) transport_PIF = Marshalling.ParseRef(table, "transport_PIF"); if (table.ContainsKey("status")) status = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "status")); if (table.ContainsKey("other_config")) other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config")); if (table.ContainsKey("protocol")) protocol = (tunnel_protocol)Helper.EnumParseDefault(typeof(tunnel_protocol), Marshalling.ParseString(table, "protocol")); } public Proxy_Tunnel ToProxy() { Proxy_Tunnel result_ = new Proxy_Tunnel(); result_.uuid = uuid ?? ""; result_.access_PIF = access_PIF ?? ""; result_.transport_PIF = transport_PIF ?? ""; result_.status = Maps.convert_to_proxy_string_string(status); result_.other_config = Maps.convert_to_proxy_string_string(other_config); result_.protocol = tunnel_protocol_helper.ToString(protocol); return result_; } public bool DeepEquals(Tunnel other) { if (ReferenceEquals(null, other)) return false; if (ReferenceEquals(this, other)) return true; return Helper.AreEqual2(this._uuid, other._uuid) && Helper.AreEqual2(this._access_PIF, other._access_PIF) && Helper.AreEqual2(this._transport_PIF, other._transport_PIF) && Helper.AreEqual2(this._status, other._status) && Helper.AreEqual2(this._other_config, other._other_config) && Helper.AreEqual2(this._protocol, other._protocol); } public override string SaveChanges(Session session, string opaqueRef, Tunnel server) { if (opaqueRef == null) { System.Diagnostics.Debug.Assert(false, "Cannot create instances of this type on the server"); return ""; } else { if (!Helper.AreEqual2(_status, server._status)) { Tunnel.set_status(session, opaqueRef, _status); } if (!Helper.AreEqual2(_other_config, server._other_config)) { Tunnel.set_other_config(session, opaqueRef, _other_config); } if (!Helper.AreEqual2(_protocol, server._protocol)) { Tunnel.set_protocol(session, opaqueRef, _protocol); } return null; } } /// /// Get a record containing the current state of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel public static Tunnel get_record(Session session, string _tunnel) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_record(session.opaque_ref, _tunnel); else return new Tunnel(session.XmlRpcProxy.tunnel_get_record(session.opaque_ref, _tunnel ?? "").parse()); } /// /// Get a reference to the tunnel instance with the specified UUID. /// First published in XenServer 5.6 FP1. /// /// The session /// UUID of object to return public static XenRef get_by_uuid(Session session, string _uuid) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_by_uuid(session.opaque_ref, _uuid); else return XenRef.Create(session.XmlRpcProxy.tunnel_get_by_uuid(session.opaque_ref, _uuid ?? "").parse()); } /// /// Get the uuid field of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel public static string get_uuid(Session session, string _tunnel) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_uuid(session.opaque_ref, _tunnel); else return session.XmlRpcProxy.tunnel_get_uuid(session.opaque_ref, _tunnel ?? "").parse(); } /// /// Get the access_PIF field of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel public static XenRef get_access_PIF(Session session, string _tunnel) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_access_pif(session.opaque_ref, _tunnel); else return XenRef.Create(session.XmlRpcProxy.tunnel_get_access_pif(session.opaque_ref, _tunnel ?? "").parse()); } /// /// Get the transport_PIF field of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel public static XenRef get_transport_PIF(Session session, string _tunnel) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_transport_pif(session.opaque_ref, _tunnel); else return XenRef.Create(session.XmlRpcProxy.tunnel_get_transport_pif(session.opaque_ref, _tunnel ?? "").parse()); } /// /// Get the status field of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel public static Dictionary get_status(Session session, string _tunnel) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_status(session.opaque_ref, _tunnel); else return Maps.convert_from_proxy_string_string(session.XmlRpcProxy.tunnel_get_status(session.opaque_ref, _tunnel ?? "").parse()); } /// /// Get the other_config field of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel public static Dictionary get_other_config(Session session, string _tunnel) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_other_config(session.opaque_ref, _tunnel); else return Maps.convert_from_proxy_string_string(session.XmlRpcProxy.tunnel_get_other_config(session.opaque_ref, _tunnel ?? "").parse()); } /// /// Get the protocol field of the given tunnel. /// First published in 1.250.0. /// /// The session /// The opaque_ref of the given tunnel public static tunnel_protocol get_protocol(Session session, string _tunnel) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_protocol(session.opaque_ref, _tunnel); else return (tunnel_protocol)Helper.EnumParseDefault(typeof(tunnel_protocol), (string)session.XmlRpcProxy.tunnel_get_protocol(session.opaque_ref, _tunnel ?? "").parse()); } /// /// Set the status field of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel /// New value to set public static void set_status(Session session, string _tunnel, Dictionary _status) { if (session.JsonRpcClient != null) session.JsonRpcClient.tunnel_set_status(session.opaque_ref, _tunnel, _status); else session.XmlRpcProxy.tunnel_set_status(session.opaque_ref, _tunnel ?? "", Maps.convert_to_proxy_string_string(_status)).parse(); } /// /// Add the given key-value pair to the status field of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel /// Key to add /// Value to add public static void add_to_status(Session session, string _tunnel, string _key, string _value) { if (session.JsonRpcClient != null) session.JsonRpcClient.tunnel_add_to_status(session.opaque_ref, _tunnel, _key, _value); else session.XmlRpcProxy.tunnel_add_to_status(session.opaque_ref, _tunnel ?? "", _key ?? "", _value ?? "").parse(); } /// /// Remove the given key and its corresponding value from the status field of the given tunnel. If the key is not in that Map, then do nothing. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel /// Key to remove public static void remove_from_status(Session session, string _tunnel, string _key) { if (session.JsonRpcClient != null) session.JsonRpcClient.tunnel_remove_from_status(session.opaque_ref, _tunnel, _key); else session.XmlRpcProxy.tunnel_remove_from_status(session.opaque_ref, _tunnel ?? "", _key ?? "").parse(); } /// /// Set the other_config field of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel /// New value to set public static void set_other_config(Session session, string _tunnel, Dictionary _other_config) { if (session.JsonRpcClient != null) session.JsonRpcClient.tunnel_set_other_config(session.opaque_ref, _tunnel, _other_config); else session.XmlRpcProxy.tunnel_set_other_config(session.opaque_ref, _tunnel ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse(); } /// /// Add the given key-value pair to the other_config field of the given tunnel. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel /// Key to add /// Value to add public static void add_to_other_config(Session session, string _tunnel, string _key, string _value) { if (session.JsonRpcClient != null) session.JsonRpcClient.tunnel_add_to_other_config(session.opaque_ref, _tunnel, _key, _value); else session.XmlRpcProxy.tunnel_add_to_other_config(session.opaque_ref, _tunnel ?? "", _key ?? "", _value ?? "").parse(); } /// /// Remove the given key and its corresponding value from the other_config field of the given tunnel. If the key is not in that Map, then do nothing. /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel /// Key to remove public static void remove_from_other_config(Session session, string _tunnel, string _key) { if (session.JsonRpcClient != null) session.JsonRpcClient.tunnel_remove_from_other_config(session.opaque_ref, _tunnel, _key); else session.XmlRpcProxy.tunnel_remove_from_other_config(session.opaque_ref, _tunnel ?? "", _key ?? "").parse(); } /// /// Set the protocol field of the given tunnel. /// First published in 1.250.0. /// /// The session /// The opaque_ref of the given tunnel /// New value to set public static void set_protocol(Session session, string _tunnel, tunnel_protocol _protocol) { if (session.JsonRpcClient != null) session.JsonRpcClient.tunnel_set_protocol(session.opaque_ref, _tunnel, _protocol); else session.XmlRpcProxy.tunnel_set_protocol(session.opaque_ref, _tunnel ?? "", tunnel_protocol_helper.ToString(_protocol)).parse(); } /// /// Create a tunnel /// First published in XenServer 5.6 FP1. /// /// The session /// PIF which receives the tagged traffic First published in XenServer 7.0. /// Network to receive the tunnelled traffic First published in XenServer 7.0. public static XenRef create(Session session, string _transport_pif, string _network) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_create(session.opaque_ref, _transport_pif, _network); else return XenRef.Create(session.XmlRpcProxy.tunnel_create(session.opaque_ref, _transport_pif ?? "", _network ?? "").parse()); } /// /// Create a tunnel /// First published in XenServer 5.6 FP1. /// /// The session /// PIF which receives the tagged traffic First published in XenServer 7.0. /// Network to receive the tunnelled traffic First published in XenServer 7.0. public static XenRef async_create(Session session, string _transport_pif, string _network) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_tunnel_create(session.opaque_ref, _transport_pif, _network); else return XenRef.Create(session.XmlRpcProxy.async_tunnel_create(session.opaque_ref, _transport_pif ?? "", _network ?? "").parse()); } /// /// Create a tunnel /// First published in XenServer 5.6 FP1. /// /// The session /// PIF which receives the tagged traffic First published in XenServer 7.0. /// Network to receive the tunnelled traffic First published in XenServer 7.0. /// Protocol used for the tunnel (GRE or VxLAN) First published in Unreleased. public static XenRef create(Session session, string _transport_pif, string _network, tunnel_protocol _protocol) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_create(session.opaque_ref, _transport_pif, _network, _protocol); else return XenRef.Create(session.XmlRpcProxy.tunnel_create(session.opaque_ref, _transport_pif ?? "", _network ?? "", tunnel_protocol_helper.ToString(_protocol)).parse()); } /// /// Create a tunnel /// First published in XenServer 5.6 FP1. /// /// The session /// PIF which receives the tagged traffic First published in XenServer 7.0. /// Network to receive the tunnelled traffic First published in XenServer 7.0. /// Protocol used for the tunnel (GRE or VxLAN) First published in Unreleased. public static XenRef async_create(Session session, string _transport_pif, string _network, tunnel_protocol _protocol) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_tunnel_create(session.opaque_ref, _transport_pif, _network, _protocol); else return XenRef.Create(session.XmlRpcProxy.async_tunnel_create(session.opaque_ref, _transport_pif ?? "", _network ?? "", tunnel_protocol_helper.ToString(_protocol)).parse()); } /// /// Destroy a tunnel /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel public static void destroy(Session session, string _tunnel) { if (session.JsonRpcClient != null) session.JsonRpcClient.tunnel_destroy(session.opaque_ref, _tunnel); else session.XmlRpcProxy.tunnel_destroy(session.opaque_ref, _tunnel ?? "").parse(); } /// /// Destroy a tunnel /// First published in XenServer 5.6 FP1. /// /// The session /// The opaque_ref of the given tunnel public static XenRef async_destroy(Session session, string _tunnel) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_tunnel_destroy(session.opaque_ref, _tunnel); else return XenRef.Create(session.XmlRpcProxy.async_tunnel_destroy(session.opaque_ref, _tunnel ?? "").parse()); } /// /// Return a list of all the tunnels known to the system. /// First published in XenServer 5.6 FP1. /// /// The session public static List> get_all(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_all(session.opaque_ref); else return XenRef.Create(session.XmlRpcProxy.tunnel_get_all(session.opaque_ref).parse()); } /// /// Get all the tunnel Records at once, in a single XML RPC call /// First published in XenServer 5.6 FP1. /// /// The session public static Dictionary, Tunnel> get_all_records(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.tunnel_get_all_records(session.opaque_ref); else return XenRef.Create(session.XmlRpcProxy.tunnel_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 = ""; /// /// The interface through which the tunnel is accessed /// [JsonConverter(typeof(XenRefConverter))] public virtual XenRef access_PIF { get { return _access_PIF; } set { if (!Helper.AreEqual(value, _access_PIF)) { _access_PIF = value; NotifyPropertyChanged("access_PIF"); } } } private XenRef _access_PIF = new XenRef(Helper.NullOpaqueRef); /// /// The interface used by the tunnel /// [JsonConverter(typeof(XenRefConverter))] public virtual XenRef transport_PIF { get { return _transport_PIF; } set { if (!Helper.AreEqual(value, _transport_PIF)) { _transport_PIF = value; NotifyPropertyChanged("transport_PIF"); } } } private XenRef _transport_PIF = new XenRef(Helper.NullOpaqueRef); /// /// Status information about the tunnel /// [JsonConverter(typeof(StringStringMapConverter))] public virtual Dictionary status { get { return _status; } set { if (!Helper.AreEqual(value, _status)) { _status = value; NotifyPropertyChanged("status"); } } } private Dictionary _status = new Dictionary() {{"active", "false"}}; /// /// 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() {}; /// /// The protocol used for tunneling (either GRE or VxLAN) /// First published in 1.250.0. /// [JsonConverter(typeof(tunnel_protocolConverter))] public virtual tunnel_protocol protocol { get { return _protocol; } set { if (!Helper.AreEqual(value, _protocol)) { _protocol = value; NotifyPropertyChanged("protocol"); } } } private tunnel_protocol _protocol = tunnel_protocol.gre; } }