ImcSdk 0.9.2

data/lib/ImcSdk/imcmethod.rb

@@ -0,0 +1,182 @@
+# Copyright 2017 Cisco Systems, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This module contains the ImcSdk Core Classes
+
+require_relative 'imccore'
+require_relative 'imccoreutils'
+
+
+class ExternalMethod < ImcBase
+    
+    @@external_method_attrs = { "errorCode" => "error_code",
+                                "errorDescr" => "error_descr",
+                                "invocationResult" => "invocation_result",
+                                "response" => "response"}
+
+    attr_accessor :error_code
+    attr_accessor :error_descr
+
+    def initialize(method_id)
+        super(method_id)
+        meta = File.dirname(__FILE__) + "/methodmeta/" + method_id + "Meta.rb"
+        load meta
+        @error_code = 0
+        @error_descr = nil
+        @invocation_result = nil
+        @response = nil
+        self.mark_clean()
+    end
+
+    def set_property(prop,value)
+        self.instance_variable_set("@" + prop, value)
+    end
+
+    def get_property(prop)
+        if self.instance_variable_defined?("@" + prop)
+            return self.instance_variable_get("@" + prop)
+        else
+            return nil
+        end
+    end
+
+    def child_add(mo)
+        #This method adds child external method object to a external method object.
+        childs.push(mo)
+    end
+
+    def set_attr(key, value)
+        #This method sets the attribute of external method object
+        if @@method_prop_meta.include?(key)
+            set_property(key, value)
+        elsif key.equal?("error_code")
+            @error_code = value
+        elsif key.equal?("error_descr")
+            @error_descr = value
+        elsif key.equal?("invocation_result")
+            @invocation_result = value
+        elsif key.equal?("response")
+            @response = value            
+        else
+            #no such property
+            return nil
+        end
+    end
+
+    def get_error_response(error_code, error_descr)
+        # This methos sets error attributes of an external method object.
+
+        @error_code = error_code
+        @error_descr = error_descr
+        @response = "yes"
+    end
+
+
+    def to_xml(xml_doc=nil, option=nil, elem_name=nil)
+        # This method writes the xml representation of the external method object.
+        cookie = nil
+        if self.instance_variable_defined?("@cookie")
+            cookie = self.get_property("cookie")
+        end
+        xml_obj = elem_create(@@method_meta.xml_attribute, xml_doc, elem_name)
+        
+        @@method_prop_meta.each do |prop, prop_meta|
+            if xml_obj.name == "aaaLogout" and prop == "in_delay_secs" and get_property(prop).to_i > 300
+                next
+            end
+
+            if prop_meta.inp_out == "Output"
+                next
+            end
+
+            if prop_meta.is_complex_type
+                if !get_property(prop).nil?
+                    #x = get_property(prop)
+                    get_property(prop).to_xml(xml_obj, option, prop_meta.xml_attribute, cookie=cookie)
+                end
+            elsif
+                key = prop_meta.xml_attribute
+                value = get_property(prop)
+                xml_obj.add_attribute(key, value)
+            end
+        end
+        child_to_xml(xml_obj, option, cookie=cookie)
+        return xml_obj
+    end
+
+    def from_xml(elem, handle=nil)
+        # This method updates/fills the object from xml representation of the External method object.
+
+        if elem.attributes
+            elem.attributes.each do |attr_name, attr_value|
+                if @@method_prop_map.include? attr_name
+                    attr1 = @@method_prop_map[attr_name]
+                    method_prop_meta = @@method_prop_meta[attr1]
+                    if method_prop_meta.inp_out.equal? "Input" or method_prop_meta.is_complex_type
+                        pass
+                    end
+                    set_attr(attr1, attr_value)
+                elsif @@external_method_attrs.include? attr_name
+                    set_attr @@external_method_attrs[attr_name], attr_value
+                end
+            end
+        end
+
+        if elem.children
+            for child_elem in elem.children do
+                if !child_elem.instance_variable_defined?(:@name)
+                    next
+                end
+                child_name = child_elem.name
+
+                if @@method_prop_map.include? child_name
+                    child_name = @@method_prop_map[child_name]
+                    method_prop_meta = @@method_prop_meta[child_name]
+                    if method_prop_meta.inp_out == "Output" and method_prop_meta.is_complex_type
+                        child_obj = ImcCoreUtils.get_imc_obj(method_prop_meta.field_type, child_elem, nil)
+                        if !child_obj.nil?
+                            set_attr(child_name, child_obj)
+                            child_obj.from_xml(child_elem, handle)
+                        end
+                    end
+                end
+            end
+        end
+    end
+    def get_outconfig_child()
+        if self.instance_variable_defined?(:@out_config)
+            return self.instance_variable_get(:@out_config).instance_variable_get(:@child)
+        elsif self.instance_variable_defined?(:@out_configs)
+            return self.instance_variable_get(:@out_configs).instance_variable_get(:@child)
+        else
+            return Array.new
+        end
+    end
+
+    def is_outconfig_available()
+        if self.instance_variable_defined?(:@out_config) or self.instance_variable_defined?(:@out_configs)
+            return true
+        else
+            false
+        end
+    end
+=begin
+    private
+    def to_s()
+        
+        #TBD implementation
+    end
+=end
+
+
+end

data/lib/ImcSdk/imcmethodfactory.rb

@@ -0,0 +1,190 @@
+# Copyright 2015 Cisco Systems, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+#This is an auto-generated module.
+#It contains supporting classes for External Method.
+
+
+require_relative 'imcmethod'
+require_relative 'imccoremeta'
+require_relative 'imcconstants'
+
+
+def aaa_get_compute_auth_tokens(cookie)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("AaaGetComputeAuthTokens")
+
+    method.set_property("cookie",cookie)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def aaa_keep_alive(cookie)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("AaaKeepAlive")
+
+    method.set_property("cookie",cookie)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def aaa_login(in_name, in_password)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("AaaLogin")
+
+    method.set_property("in_name",in_name)
+    method.set_property("in_password",in_password)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def aaa_logout(in_cookie)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("AaaLogout")
+
+    method.set_property("in_cookie",in_cookie)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def aaa_refresh(in_cookie, in_name, in_password)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("AaaRefresh")
+
+    method.set_property("in_cookie",in_cookie)
+    method.set_property("in_name",in_name)
+    method.set_property("in_password",in_password)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def config_conf_mo(cookie, dn, in_config, in_hierarchical=YesOrNo.FALSE)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("ConfigConfMo")
+
+    method.set_property("cookie",cookie)
+    method.set_property("dn",dn)
+    method.set_property("in_config",in_config)
+    method.set_property("in_hierarchical", (ImcGenUtils::AFFIRMATIVE_LIST.include? in_hierarchical) ? true : false)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def config_conf_mos(cookie, in_configs, in_hierarchical=YesOrNo.FALSE)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("ConfigConfMos")
+
+    method.set_property("cookie",cookie)
+    method.set_property("in_configs",in_configs)
+    method.set_property("in_hierarchical", (ImcGenUtils::AFFIRMATIVE_LIST.include? in_hierarchical) ? true : false)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def config_resolve_children(cookie, class_id, in_dn, in_hierarchical=YesOrNo.FALSE)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("ConfigResolveChildren")
+
+    meta_class_id = ImcCoreUtils.find_class_id_in_mo_meta_ignore_case(class_id)
+    if !meta_class_id.nil?
+        class_id = ImcGenUtils.word_l(meta_class_id)
+    end
+    method.set_property("class_id",class_id)
+    method.set_property("cookie",cookie)
+    method.set_property("in_dn",in_dn)
+    method.set_property("in_hierarchical", (ImcGenUtils::AFFIRMATIVE_LIST.include? in_hierarchical) ? true : false)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def config_resolve_class(cookie, class_id, in_hierarchical=YesOrNo.FALSE)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("ConfigResolveClass")
+
+    meta_class_id = ImcCoreUtils.find_class_id_in_mo_meta_ignore_case(class_id)
+    if !meta_class_id.nil?
+        class_id = ImcGenUtils.word_l(meta_class_id)
+    end
+    method.set_property("class_id",class_id)
+    method.set_property("cookie",cookie)
+    method.set_property("in_hierarchical", (ImcGenUtils::AFFIRMATIVE_LIST.include? in_hierarchical) ? true : false)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def config_resolve_dn(cookie, dn, in_hierarchical=YesOrNo.FALSE)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("ConfigResolveDn")
+
+    method.set_property("cookie",cookie)
+    method.set_property("dn",dn)
+    method.set_property("in_hierarchical", (ImcGenUtils::AFFIRMATIVE_LIST.include? in_hierarchical) ? true : false)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def config_resolve_parent(cookie, dn, in_hierarchical=YesOrNo.FALSE)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("ConfigResolveParent")
+
+    method.set_property("cookie",cookie)
+    method.set_property("dn",dn)
+    method.set_property("in_hierarchical", (ImcGenUtils::AFFIRMATIVE_LIST.include? in_hierarchical) ? true : false)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def event_subscribe(cookie)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("EventSubscribe")
+
+    method.set_property("cookie",cookie)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end
+
+def event_unsubscribe(cookie)
+    # Auto-generated IMC XML API Method. 
+    method = ExternalMethod.new("EventUnsubscribe")
+
+    method.set_property("cookie",cookie)
+
+    xml_request = method.to_xml(nil, WriteXmlOption::DIRTY, nil)
+    return xml_request
+
+end

data/lib/ImcSdk/imcmo.rb

@@ -0,0 +1,669 @@
+#!/usr/bin/ruby
+# Copyright 2017 Cisco Systems, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This module contains the Managed Object and Generic Managed Object class
+
+require_relative 'imcgenutils'
+require_relative 'imccoreutils'
+require_relative 'imccoremeta'
+require_relative 'imcxmlcodec'
+
+private
+class GenericProp
+
+    attr_accessor :name
+    attr_accessor :value
+    attr_accessor :is_dirty
+    
+    #Internal class to handle the unknown property
+    def initialize(name, value, is_dirty)
+        @name = name
+        @value = value
+        @is_dirty = is_dirty
+    end
+end
+
+class ManagedObject < ImcBase
+
+    # This class structures/represents all the managed objects.
+
+    attr_reader :parent_mo
+    attr_reader :parent_dn
+    attr_reader :dn
+    attr_reader :mo_class
+    DUMMY_DIRTY = "0x1L"
+
+    @@internal_prop = ["dirty_mask", "class_id", "child", "handle",'']
+    @@internal_prop.freeze
+    def initialize(class_id: nil, parent_mo_or_dn: nil, from_xml_response: false, **kwargs)
+
+        @parent_mo = nil
+        @status = nil
+        @parent_dn = nil
+        @xtra_props = {}
+        @xtra_props_dirty_mask = 0x1
+        @mo_class = Object.const_get(self.class.name)
+
+        if parent_mo_or_dn
+            if parent_mo_or_dn.is_a? ManagedObject
+                @parent_mo = parent_mo_or_dn
+                @parent_dn = @parent_mo.dn
+            elsif parent_mo_or_dn.is_a? String
+                @parent_dn = parent_mo_or_dn
+            else
+                raise ValueError.new('parent mo or dn must be specified')
+            end
+        end
+
+        if !from_xml_response
+            rn_set()
+            dn_set()
+        end
+
+        mo_meta = ImcCoreUtils.get_mo_meta(@mo_class)
+        xml_attribute = mo_meta.xml_attribute
+
+        super(ImcGenUtils.word_u(xml_attribute))
+
+        if @parent_mo
+            @parent_mo.child_add(self)
+        end
+
+        if kwargs
+            kwargs.each do |prop_name, prop_value|
+                if ImcCoreUtils.prop_exists(@mo_class, prop_name.to_s)
+                    set_prop(prop_name, prop_value)
+                end
+            end
+        end
+    end
+
+    def mark_dirty()
+    #Method to mark the managed object dirty
+        if self.class.name.equal? "ManagedObject" and !self.is_dirty()
+            self.dirty_mask = ManagedObject.DUMMY_DIRTY
+        elsif instance_variable_defined?("mo_meta")
+            self.dirty_mask = self.mo_meta.mask
+        end
+    end
+
+
+    def is_dirty()
+    #This method checks if managed object is dirty
+        condition1 = @dirty_mask.to_i.equal? 0
+        condition2 = child_is_dirty()
+        return !condition1 || condition2
+    end
+
+
+    def make_rn()
+        #This method returns the Rb for a managed Object
+   
+        mo_meta = ImcCoreUtils.get_mo_meta(self.mo_class)
+        rn_pattern = mo_meta.rn
+        rn_pattern.scan(/\[([^\]]*)\]/) do |prop|
+            prop_name = prop[0]
+
+            if ImcCoreUtils.prop_exists(@mo_class, prop_name)
+                prop_value = self.instance_variable_get("@" + prop_name)
+
+                if prop_value
+                    rn_pattern = rn_pattern.gsub(/\[#{prop_name}\]/, prop_value)
+                else
+                    raise ImcValidationException("Property #{prop} was None in make_rn")
+                end
+
+            else
+                #log.debug('Property "%s" was not found in make_rn arguments' % prop)
+                raise ImcValidationException("Property #{prop} was not found in make_rn arguments")
+            end
+        end
+        return rn_pattern
+    end
+
+    def to_xml(xml_doc=nil, option=nil, elem_name=nil, cookie=nil)
+    #Method writes the xml representation of the Managed Object
+
+        #unknown_properties = []
+
+        if option == WriteXmlOption::DIRTY and !is_dirty()
+            return
+        end
+
+        platform = nil
+        handle = nil
+
+        if cookie
+            handle = ImcCoreUtils.get_handle_from_cookie(cookie)
+
+            if handle
+                platform = handle.platform
+            end
+
+        end
+
+        mo_meta = ImcCoreUtils.get_mo_meta(self.mo_class)
+        xml_attribute = mo_meta.xml_attribute
+        xml_obj = elem_create(xml_attribute, xml_doc=xml_doc, elem_name)
+
+        self.instance_variables.each do |key|
+            key_str = key.to_s
+            key_str[0] = ''
+            #hash = self.class.prop_meta
+            if key_str != "rn" and ImcCoreUtils.prop_exists(
+                                self.mo_class,
+                                key_str,
+                                platform=platform)
+                mo_prop_meta = ImcCoreUtils.get_prop_meta(self.mo_class, key_str, platform=platform)
+
+                if option != WriteXmlOption::DIRTY or (!mo_prop_meta.mask.nil? and  (self.dirty_mask & mo_prop_meta.mask !=0))
+                    value = instance_variable_get(key)
+                    if !value.nil?
+                        if handle
+                            if(mo_prop_meta.version.le(handle.version))
+                                xml_obj.add_attribute(mo_prop_meta.xml_attribute, value)
+                            end
+                        else
+                            xml_obj.add_attribute(mo_prop_meta.xml_attribute, value)
+                        end
+                    end
+                end
+
+            else
+
+                if !@xtra_props.has_key? key
+                    #This is an internal property
+                    #This should not be a part of the xml
+                    next
+                end
+
+                if option != WriteXmlOption.DIRTY or xtra_props[key].is_dirty
+                    value = xtra_props[key].value
+                    if !value.nil?
+                        xml_obj.add_attribute(key, value)
+                    end
+                end
+                
+            end
+        end
+
+        if !xml_obj.attributes.include?("dn")
+            xml_obj.add_attribute('dn', self.instance_variable_get(:@dn))
+        end
+
+        child_to_xml(xml_obj, option)
+        return xml_obj
+    end
+
+    def check_prop_match(**kwargs)
+        kwargs.each do |prop_name, prop_value|
+            #prop_name_s = prop_name.to_s
+            if prop_value.nil?
+                next
+            end
+            if !ImcCoreUtils.prop_exists(self.mo_class, prop_name.to_s)
+                raise ValueError.new("Invalid Property Name Exception - Prop #{prop_name}")
+            end
+            if prop_value != self.instance_variable_get("@" + prop_name.to_s)
+                return false
+            end
+        end
+        return true
+    end
+
+    def set_prop_multiple(**kwargs)
+        kwargs.each do |prop_name, prop_value|
+            if ImcCoreUtils.prop_exists(self.mo_class, prop_name)
+                set_prop(prop_name.to_s, prop_value)
+            else
+                ImcWarning("Invalid Property Name for Class [#{self.class.to_s}]: Prop <#{prop_name.to_s}>, setting it forcefully")
+                set_prop(prop_name.to_s, prop_value, forced: true)
+            end
+        end
+    end
+
+    def from_xml(elem, handle=nil)
+    # Method updates the object from the xml representation of the managed object.
+
+        @handle = handle
+        if elem.attributes
+            if !self.class.name.equal? "ManagedObject"
+                elem.attributes.each do |attr_name, attr_value|
+                    if ImcCoreUtils.property_exists_in_prop_map(self.mo_class, attr_name)
+                        attr_name = ImcCoreUtils.get_property_from_prop_map(self.mo_class, attr_name)
+                    else
+                        @xtra_props[attr_name.to_sym] = GenericProp.new(attr_name, attr_value, false)
+                    end
+                    self.instance_variable_set("@" + attr_name, attr_value)
+                end
+            else
+                elem.attributes.each do |attr_name, attr_value|
+                    self.instance_variable_set("@" + attr_name, attr_value)                    
+                end
+            end
+        end
+
+        
+        if elem.children
+            elem.children.each do |child_elem|
+                if !child_elem.is_a? Element
+                    next
+                end
+                if !self.class.name.equal? "ManagedObject" and  ImcCoreUtils.get_mo_meta(self.mo_class).field_names.include? child_elem.name
+                    next
+                end
+
+                class_id = ImcGenUtils.word_u(child_elem.name)
+                child_obj = ImcCoreUtils.get_imc_obj(class_id, child_elem, nil)
+              
+                child_obj.from_xml(child_elem, handle)
+                self.child_add(child_obj)
+            end
+        end
+    end
+
+    def get_version(platform)
+=begin
+        Method to get the IMC version from which this MO is supported
+=end
+       mo_meta = ImcCoreUtils.get_mo_meta(self, platform)
+        return mo_meta.version
+    end
+
+    def sync_mo(mo)
+    #Method to return string representation of a managed object.
+    #TBD
+    end
+
+    def show_tree(level=0)
+    #Method to return string representation of a managed object.
+    end
+
+    def show_hierarchy(level=0, depth=nil, show_level=[])
+    #Method to print hierarchy
+    end
+
+    def set_prop(name, value, mark_dirty: true, forced: false)
+=begin
+        Internal method to set the properties after validation
+
+        Args:
+            name (str): property name
+            value (str): property value
+            mark_dirty (bool): if True, property will be part of xml request
+            forced (bool): if True, set the value without validation
+
+        Returns:
+            None
+=end
+
+        if value.nil?
+            return
+        end
+        if !forced
+            #prop_meta = @mo_class.prop_meta[name.to_s]
+            prop_meta = ImcCoreUtils.get_prop_meta(self.mo_class, name.to_s)
+            #if prop_meta.access != MoPropertyMeta::READ_WRITE
+            if !ImcCoreUtils.is_writable_prop(self.mo_class, name.to_s)
+                if self.instance_variable_defined?("@" + name) and  prop_meta.access != MoPropertyMeta::CREATE_ONLY
+                    raise ValueError.new("#{name} is not a read-write property.")
+                end
+            end
+
+            if !prop_meta.validate_property_value(value)
+                raise ValueError.new("Invalid Value Exception - #{self.class.name}: Prop <#{name}>, Value <#{value}> ")
+            end
+
+            if prop_meta.mask and mark_dirty
+                @dirty_mask |= prop_meta.mask
+            end
+        end
+        self.instance_variable_set("@" + name.to_s, value)
+    end
+
+
+    private
+
+    def setattr(name, value)
+        
+        if self.instance_variable_defined? "prop_meta" and \
+            ImcCoreUtils.prop_exists(self, name)
+
+            if ImcCoreUtils.prop_exists(self.mo_class, name)
+                if self.instance_variable_defined?("@" + name)
+                    set_prop(name, value)
+                end
+            else
+                if value
+                    #if not self.prop_meta[name].validate_property_value(value):
+                    #    raise ValueError.new("Invalid Value Exception - [#{self.class.name}]: Prop <#{name}>, Value<#{value}>. ")
+                    #end
+                    self.instance_variable_set("@" + name, value)
+                    prop = ImcCoreUtils.get_prop_meta(self, name)
+                    if !prop.mask.nil?
+                        self.dirty_mask |= prop.mask
+                    end
+                end
+            end
+        elsif name.start_with("_")
+            self.instance_variable_set("@"+name, value)
+        else
+            # These are properties which the current version of imc sdk
+            # does not know of.
+            # The code will come here lot often, when using older version of
+            # imcsdk with newer releases on the IMC.
+            # This needs to be handled so that the same sdk can work across
+            # multiple imc releases
+            self.xtra_props[name.to_sym] = GenericProp.new(name, value, true)
+            self.dirty_mask |= self.xtra_props_dirty_mask
+            self.instance_variable_set("@"+name, value)
+        end
+    end
+
+    def rn_set()
+
+        #Internal method to set rn
+
+        if ImcCoreUtils.prop_exists(self.mo_class, "rn")
+            @rn = make_rn()
+        else
+            @rn = ""
+        end
+    end
+
+    def dn_set()
+
+        #Internal method to set dn
+        if ImcCoreUtils.prop_exists(self.mo_class, "dn")
+            if !self.parent_dn.nil?
+                @dn = @parent_dn + '/' + @rn
+            else
+                @dn = @rn
+            end
+        else
+            @dn = ""
+        end
+    end
+
+end
+
+def generic_mo_from_xml(xml_str)
+#create GenericMo Object from xml String
+=begin
+    create GenericMo object from xml string
+=end
+    root_elem = ET.fromstring(xml_str)
+    class_id = root_elem.name
+    gmo = GenericMo.new(class_id)
+    gmo.from_xml(root_elem)
+    return gmo
+end
+
+def generic_mo_from_xml_elem(elem)
+#create GenericMo object from xml element
+=begin
+    create GenericMo object from xml element
+=end
+
+    #from . import imcxmlcodec as xc
+    xml_str = ImcXmlCodec.to_xml_str(elem)
+    gmo = generic_mo_from_xml(xml_str)
+    return gmo
+end
+
+
+class GenericMo < ImcBase
+
+=begin
+    This class implements a Generic Managed Object.
+    Args:
+        class_id (str): class id of managed object
+        parent_mo_or_dn (ManagedObject or str): parent managed object or dn
+=end
+
+    # Every variable that should not be a part of the final xml
+    # should start with a underscore in this class
+
+
+    def initialize(class_id, parent_mo_or_dn=nil, **kwargs)
+        @properties = {}
+
+        if parent_mo_or_dn.is_a? GenericMo
+            @parent_mo = parent_mo_or_dn
+            @parent_dn = parent_mo_or_dn.dn
+        elsif parent_mo_or_dn.is_a? String
+            @parent_dn = parent_mo_or_dn
+            @parent_mo = nil
+        elsif parent_mo_or_dn.nil?
+            @parent_dn=""
+            @parent_mo=nil            
+        else
+            raise ValueError.new("parent_mo_or_dn should be an instance of str or Generic Mo")
+        end
+
+        super(class_id)
+
+        if kwargs
+            kwargs.each do |key, value|
+                instance_variable_set(:key, value.to_s)
+                properties[:key] = value.to_s
+            end
+        end
+        if self.instance_variable_defined?("@rn") and self.instance_variable_defined?("@dn")
+
+        elsif self.instance_variable_defined?("@rn") and !self.instance_variable_defined?("@dn")
+            if self.parent_dn and self.parent_dn != ""
+                self.dn = self.parent_dn + '/' + self.rn
+                self.properties[:dn] = self.dn
+            else
+                self.dn = self.rn
+                self.properties[:dn] = self.dn
+            end
+        elsif !self.instance_variable_defined?("@rn") and self.instance_variable_defined?("@dn")
+            self.rn = File.basename(self.dn)
+            self.properties[:rn] = self.rn
+        else
+            self.rn = ""
+            self.dn = ""
+        end
+        if self.parent_mo
+            self.parent_mo.child_add(self)
+        end
+    end
+
+    def to_xml(xml_doc=nil, option=nil, cookie=nil)
+=begin
+        This method returns the xml element node for the current object
+        with it's hierarchy.
+        Args:
+            xml_doc: document to which the Mo attributes are added.
+                    Can be None.
+            option: not required for Generic Mo class object
+        Example:
+            from imcmsdk.imcmo import GenericMo\n
+            args = {"a": 1, "b": 2, "c":3}\n
+            obj = GenericMo("testLsA", "org-root", **args)\n
+            obj1 = GenericMo("testLsB", "org-root", **args)\n
+            obj.add_child(obj1)\n
+            elem = obj.write_xml()\n
+            import imcmsdk.imcxmlcodec as xc\n
+            xc.to_xml_str(elem)\n
+        Output:
+            '<testLsA a="1" b="2" c="3" dn="org-root/" rn="">\n
+                <testLsB a="1" b="2" c="3" dn="org-root/" rn="" />\n
+            </testLsA>'
+=end
+
+        if xml_doc.nil?
+            xml_obj = Element.new (ImcGenUtils.word_l(self._class_id))
+        else
+            xml_obj = xml_obj.add_element(ImcGenUtils.word_l(self._class_id))
+        end
+        self.instance_variables.each do |key|
+            if !key.start_with?("_")
+                #xml_obj.set(key, getattr(self, key))
+                value = instance_variable_get(key)
+                if !value.nil?
+                    xml_obj.add_attribute(key, value)
+                end
+            end
+        end
+        self.child_to_xml(xml_obj)
+        return xml_obj
+    end
+
+    def from_xml(elem, handle=nil)
+=begin
+        This method is form objects out of xml element.
+        This is called internally from imcxmlcode.from_xml_str
+        method.
+        Example:
+            xml = '<testLsA a="1" b="2" c="3" dn="org-root/" rn="">
+            <testLsB a="1" b="2" c="3" dn="org-root/" rn="" /></testLsA>'\n
+            obj = xc.from_xml_str(xml)\n
+            print type(obj)\n
+        Outputs:
+            <class 'imcsdk.imcmo.GenericMo'>
+=end
+
+        if elem.nil?
+            return nil
+        end
+        self.handle = handle
+        self.class_id = elem.name
+        if elem.attributes
+            elem.attributes.each do |attr_name, attr_value|
+                self.instance_variable_set("@" + attr_name, attr_value) 
+                self.properties[attr_name.to_sym] = attr_value.to_s
+            end
+        end
+        if self.rn and self.dn
+
+        elsif self.rn and !self.dn
+            if self.parent_dn and self.parent_dn != ""
+                self.dn = self.parent_dn + '/' + self.rn
+                self.properties[:dn] = self.dn
+            else
+                self.dn = self.rn
+                self.properties[:dn] = self.dn
+            end
+        elsif !self.rn and self.dn
+            self.rn = File.basename(self.dn)
+            self.properties[:rn] = self.rn
+        end
+
+        #children = elem.getchildren()
+        if elem.children
+            elem.children.each do |child_elem|
+                if !child_elem.is_a? Element
+                    next
+                end
+                class_id = ImcGenUtils.word_u(child.name)
+                pdn = nil
+                if self.instance_variable_defined?("@dn")
+                    pdn = self.dn
+                end
+                child_obj = GenericMo.new(class_id, pdn)
+                self.child_add(child_obj)
+                child_obj.from_xml(child, handle)
+            end
+        end
+    end
+
+
+    def to_mo()
+=begin
+        Converts GenericMo to ManagedObject
+=end
+
+        #from . import imcmeta
+
+        class_id = ImcGenUtils.word_u(self.class_id)
+        if !($MO_CLASS_ID.include? class_id)
+            return nil
+        end
+        mo = _get_mo_obj(class_id)
+        if !mo  # or not isinstance(mo, ManagedObject):
+            return nil
+        end
+
+        for prop in self.properties
+            if ImcCoreUtils.property_exists_in_prop_map(mo, prop)
+                prop = ImcCoreUtils.get_property_from_prop_map(mo, prop)
+                value = self.properties[prop]
+                mo.instance_variable_set(prop.to_sym, value)
+                #mo.__dict__[ImcCoreUtils.get_property_from_prop_map(mo, prop)] = \
+                #    self.properties[prop]
+            else
+                ImcWarning("Property #{ImcGenUtils.word_u(prop)} Not Exist in MO #{child_id}")
+            end
+        end
+        if self.child.size
+            for ch_ in self.child
+                mo_ch = ch_.to_mo()
+                mo.child_add(mo_ch)
+            end
+        end
+
+        return mo
+    end
+
+    private
+
+
+    def _get_mo_obj(class_id)
+=begin
+        Internal methods to create managed object from class_id
+=end
+
+        #import inspect
+        mo_class = ImcCoreUtils.load_class(class_id)
+        mo_class_params = mo_class.instance_method(:initialize).parameters.map(&:last).map(&:to_s)
+
+        mo_class_param_dict = {}
+        for param in mo_class_params
+            prop = ImcCoreUtils.get_prop_meta(mo_class, param)
+            mo_param = prop.xml_attribute
+            if !(self.properties.include? mo_param)
+                if self.properties.inlcude?("rn")
+                    rn_str = self.properties['rn']
+                elsif self.properties.include?("dn")
+                    rn_str = File.basename(self.properties['dn'])
+                end
+
+                mo_meta = ImcCoreUtils.get_mo_meta(mo_class)
+                rn_pattern = mo_meta.rn
+                np_dict = ImcCoreUtils.get_naming_props(rn_str, rn_pattern)
+                if !(np_dict.inlcude?(param))
+                    mo_class_param_dict[param] = ""
+                else
+                    mo_class_param_dict[param] = np_dict[param]
+                end
+            else
+                mo_class_param_dict[param] = self.properties[mo_param]
+            end
+        end
+
+        p_dn = ""
+
+        mo_meta = ImcCoreUtils.get_mo_meta(mo_class)
+        class_parents = mo_meta.parents
+        if class_parents.include?("topRoot")
+            mo_obj = mo_class(**mo_class_param_dict)
+        else
+            mo_obj = mo_class(p_dn, **mo_class_param_dict)
+        end
+        return mo_obj
+    end
+end