[AAI] Release docker artifact 1.12.4
[aai/schema-service.git] / aai-schema / src / main / resources / onap / oxm / v17 / aai_oxm_v17.xml
index 565f181..58c3fdb 100644 (file)
                        </java-attributes>
                        <xml-properties>
                                <xml-property name="description" value="Persist SDNC address information used by ONAP SDNC."/>
-                               <xml-property name="indexedProps" value="sdnc-id"/>
-                               <xml-property name="searchable" value="sdnc-id"/>
                                <xml-property name="container" value="esr-thirdparty-sdnc-list"/>
                                <xml-property name="namespace" value="external-system"/>
                                <xml-property name="requiredProps" value="thirdparty-sdnc-id"/>
                 <xml-element java-attribute="relationshipList" name="relationship-list" type="inventory.aai.onap.org.v17.RelationshipList"/>
                 <xml-element container-type="java.util.ArrayList" java-attribute="vipIpv4AddressList" name="vip-ipv4-address-list" type="inventory.aai.onap.org.v17.VipIpv4AddressList"/>
                 <xml-element container-type="java.util.ArrayList" java-attribute="vipIpv6AddressList" name="vip-ipv6-address-list" type="inventory.aai.onap.org.v17.VipIpv6AddressList"/>
+                               <xml-element java-attribute="vlanRanges" name="vlan-ranges" type="inventory.aai.onap.org.v17.VlanRanges"/>
                                <xml-element java-attribute="hpaCapabilities" name="hpa-capabilities" type="inventory.aai.onap.org.v17.HpaCapabilities">
                                        <xml-properties>
                                                <xml-property name="description" value="List of cloud-region specific HPA Capabilities"/>
             </java-attributes>
             <xml-properties>
                 <xml-property name="description" value="Physical interface (e.g., nic)"/>
-                               <xml-property name="indexedProps" value="interface-name,prov-status,networkRef,operational-status,interface-role"/>
+                               <xml-property name="indexedProps" value="interface-name,prov-status,network-ref,operational-status,interface-role"/>
                 <xml-property name="nameProps" value="prov-status"/>
                 <xml-property name="dependentOn" value="vpls-pe,pserver,pnf"/>
                 <xml-property name="container" value="p-interfaces"/>
                 <xml-element java-attribute="configurations" name="configurations" type="inventory.aai.onap.org.v17.Configurations"/>
                 <xml-element java-attribute="forwardingPaths" name="forwarding-paths" type="inventory.aai.onap.org.v17.ForwardingPaths"/>
                 <xml-element java-attribute="collections" name="collections" type="inventory.aai.onap.org.v17.Collections"/>
-                <xml-element java-attribute="vlanTags" name="vlan-tags" type="inventory.aai.onap.org.v17.VlanTags"/>
                                <xml-element java-attribute="connectivities" name="connectivities" type="inventory.aai.onap.org.v17.Connectivities"/>
                                <xml-element java-attribute="lanPortConfigs" name="lan-port-configs" type="inventory.aai.onap.org.v17.LanPortConfigs"/>
                                <xml-element java-attribute="networkResources" name="network-resources" type="inventory.aai.onap.org.v17.NetworkResources"/>
             <xml-properties>
                 <xml-property name="description" value="Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated."/>
                 <xml-property name="nameProps" value="vnf-name"/>
-                <xml-property name="indexedProps" value="vnf-name,vnf-name2,vnf-type,heat-stack-id,vnf-id,interface-name,regional-resource-zone,vpe-id,prov-status,service-id,orchestration-status"/>
+                <xml-property name="indexedProps" value="vnf-name,vnf-name2,vnf-type,heat-stack-id,vnf-id,regional-resource-zone,vpe-id,prov-status,service-id,orchestration-status"/>
                 <xml-property name="searchable" value="vnf-id,vnf-name,vnf-name2"/>
                 <xml-property name="uniqueProps" value="vnf-id"/>
                 <xml-property name="container" value="vces"/>
             <xml-properties>
                 <xml-property name="description" value="Used to capture the network interfaces of this VCE"/>
                 <xml-property name="nameProps" value="port-group-name"/>
-                <xml-property name="indexedProps" value="port-group-id,heat-stack-id,interface-id,interface-name,switch-nameinterface-role,orchestration-status"/>
+                <xml-property name="indexedProps" value="port-group-id,heat-stack-id,interface-id,switch-name,interface-role,orchestration-status"/>
                 <xml-property name="dependentOn" value="vce"/>
                 <xml-property name="container" value="port-groups"/>
                 <xml-property name="uriTemplate" value="/port-groups/port-group/{interface-id}"/>
             <xml-properties>
                 <xml-property name="description" value="Generic network definition"/>
                 <xml-property name="nameProps" value="network-name"/>
-                <xml-property name="indexedProps" value="heat-stack-id,network-uuid,service-id,network-id,network-name,model-invariant-id,model-version-id,widget-model-id,widget-model-version,contrail-network-fqdn,network-role,orchestration-status"/>
+                <xml-property name="indexedProps" value="heat-stack-id,service-id,network-id,network-name,model-invariant-id,model-version-id,widget-model-id,widget-model-version,contrail-network-fqdn,network-role,orchestration-status"/>
                 <xml-property name="searchable" value="network-id,network-name"/>
                 <xml-property name="uniqueProps" value="network-id"/>
                 <xml-property name="container" value="l3-networks"/>
             </java-attributes>
             <xml-properties>
                 <xml-property name="description" value="Software Version"/>
-                <xml-property name="indexedProps" value="softwareVersionId,isActiveSwVer"/>
+                <xml-property name="indexedProps" value="software-version-id,is-active-sw-ver"/>
                 <xml-property name="dependentOn" value="pnf"/>
                 <xml-property name="container" value="pnf"/>
                 <xml-property name="requiredProps" value="software-version-id,is-active-sw-ver"/>
                <java-type name="ReservedPropNames">
                        <xml-properties>
                                <xml-property name="description" value="Internal map to define some reserved properties of a vertex"/>
-                               <xml-property name="uniqueProps" value="aai-unique-key,aai-uri,aai-uuid"/>
-                               <xml-property name="indexedProps" value="aai-unique-key,source-of-truth,aai-node-type,aai-uri,aai-uuid"/>
+                               <xml-property name="uniqueProps" value="aai-unique-key,aai-uri"/>
+                               <xml-property name="indexedProps" value="aai-unique-key,source-of-truth,aai-node-type,aai-uri"/>
                        </xml-properties>
                        <xml-root-element name="reserved-prop-names"/>
                        <java-attributes>
                 <xml-property name="nameProps" value="description,instance-group-name"/>
                 <xml-property name="uniqueProps" value="id"/>
                 <xml-property name="searchable" value="id,description"/>
-                <xml-property name="indexedProps" value="id,type,sub-type,model-invariant-id,model-version-id"/>
+                <xml-property name="indexedProps" value="id,model-invariant-id,model-version-id"/>
                 <xml-property name="container" value="instance-groups"/>
                 <xml-property name="namespace" value="network"/>
                 <xml-property name="uriTemplate" value="/network/instance-groups/instance-group/{id}"/>
             </xml-properties>
         </java-type>
 
+        <java-type name="VlanRanges">
+            <xml-root-element name="vlan-ranges"/>
+            <java-attributes>
+                <xml-element container-type="java.util.ArrayList" java-attribute="vlanRange" name="vlan-range" type="inventory.aai.onap.org.v17.VlanRange"/>
+            </java-attributes>
+            <xml-properties>
+            </xml-properties>
+        </java-type>
+
+        <java-type name="VlanRange">
+            <xml-root-element name="vlan-range"/>
+            <java-attributes>
+                <xml-element java-attribute="vlanRangeId" name="vlan-range-id" required="true" type="java.lang.String" xml-key="true">
+                    <xml-properties>
+                        <xml-property name="description" value="vlan id in range UUID."/>
+                    </xml-properties>
+                </xml-element>
+                <xml-element java-attribute="vlanIdLower" name="vlan-id-lower" required="true" type="java.lang.Long">
+                    <xml-properties>
+                        <xml-property name="description" value="vlan id in range lower"/>
+                    </xml-properties>
+                </xml-element>
+                <xml-element java-attribute="vlanIdUpper" name="vlan-id-upper" required="true" type="java.lang.Long">
+                    <xml-properties>
+                        <xml-property name="description" value="vlan id in range upper"/>
+                    </xml-properties>
+                </xml-element>
+                <xml-element java-attribute="vlanType" name="vlan-type" required="true" type="java.lang.String">
+                    <xml-properties>
+                        <xml-property name="description" value="vlan type"/>
+                    </xml-properties>
+                </xml-element>
+                <xml-element java-attribute="resourceVersion" name="resource-version" type="java.lang.String">
+                    <xml-properties>
+                        <xml-property name="description" value="Used for optimistic concurrency.  Must be empty on create, valid on update and delete."/>
+                    </xml-properties>
+                </xml-element>
+                <xml-element java-attribute="vlanTags" name="vlan-tags" type="inventory.aai.onap.org.v17.VlanTags"/>
+                <xml-element java-attribute="relationshipList" name="relationship-list" type="inventory.aai.onap.org.v17.RelationshipList"/>
+            </java-attributes>
+            <xml-properties>
+                <xml-property name="description" value="Definition of vlan range"/>
+                <xml-property name="indexedProps" value="vlan-range-id,vlan-type"/>
+                <xml-property name="dependentOn" value="cloud-region"/>
+                <xml-property name="container" value="vlan-ranges"/>
+                <xml-property name="uriTemplate" value="/vlan-ranges/vlan-range/{vlan-range-id}"/>
+                <xml-property name="searchable" value="vlan-range-id"/>
+                <xml-property name="requiredProps" value="vlan-range-id,vlan-id-lower,vlan-id-upper,vlan-type"/>
+                <xml-property name="dslStartNodeProps" value="vlan-range-id,vlan-type,vlan-id-lower,vlan-id-upper"/>
+            </xml-properties>
+        </java-type>
+
         <java-type name="VlanTags">
+            <xml-properties>
+                <xml-property name="description" value="Vlan Tags Assigned out of a Vlan Range"/>
+            </xml-properties>
             <xml-root-element name="vlan-tags"/>
             <java-attributes>
                 <xml-element container-type="java.util.ArrayList" java-attribute="vlanTag" name="vlan-tag" type="inventory.aai.onap.org.v17.VlanTag"/>
             </java-attributes>
         </java-type>
-
         <java-type name="VlanTag">
             <xml-root-element name="vlan-tag"/>
             <java-attributes>
                 <xml-element java-attribute="vlanTagId" name="vlan-tag-id" required="true" type="java.lang.String" xml-key="true">
                     <xml-properties>
-                        <xml-property name="description" value="Unique ID of the vlan-tag"/>
+                        <xml-property name="description" value="Vlan Tag Id"/>
                     </xml-properties>
                 </xml-element>
                 <xml-element java-attribute="vlanTagRole" name="vlan-tag-role" required="true" type="java.lang.String">
                     <xml-properties>
-                        <xml-property name="description" value="purpose (l3-network to be connected to)"/>
+                        <xml-property name="description" value="Role assigned to this vlan-tag"/>
                     </xml-properties>
                 </xml-element>
-                <xml-element java-attribute="vlanIdInner" name="vlan-id-inner" type="java.lang.Integer">
+                <xml-element java-attribute="vlanIdInner" name="vlan-id-inner" type="java.lang.Long">
                     <xml-properties>
-                        <xml-property name="description" value="VLAN inner id"/>
+                        <xml-property name="description" value="Inner VLAN tag"/>
                     </xml-properties>
                 </xml-element>
-                <xml-element java-attribute="vlanIdOuter" name="vlan-id-outer" required="true" type="java.lang.Integer">
+                <xml-element java-attribute="vlanIdOuter" name="vlan-id-outer" type="java.lang.Long">
                     <xml-properties>
-                        <xml-property name="description" value="VLAN outer id"/>
+                        <xml-property name="description" value="Outer VLAN tag"/>
                     </xml-properties>
                 </xml-element>
-                <xml-element default-value="false" java-attribute="isPrivate" name="is-private" required="true" type="java.lang.Boolean">
+                <xml-element java-attribute="isPrivate" name="is-private" required="true" type="java.lang.Boolean">
                     <xml-properties>
-                        <xml-property name="defaultValue" value="false"/>
-                        <xml-property name="description" value="is VLAN private?"/>
+                        <xml-property name="description" value="is private flag."/>
+                    </xml-properties>
+                </xml-element>
+                               <xml-element java-attribute="vlanTagType" name="vlan-tag-type" type="java.lang.String">
+                    <xml-properties>
+                        <xml-property name="description" value="VLAN tag Type"/>
+                    </xml-properties>
+                </xml-element>
+                               <xml-element java-attribute="vlanTagFunction" name="vlan-tag-function" type="java.lang.String">
+                    <xml-properties>
+                        <xml-property name="description" value="VLAN Tag Function"/>
+                    </xml-properties>
+                </xml-element>
+                <xml-element java-attribute="configPhase" name="config-phase" type="java.lang.String">
+                    <xml-properties>
+                        <xml-property name="description" value="The config-phase associated with this vlan-tag"/>
                     </xml-properties>
                 </xml-element>
                 <xml-element java-attribute="resourceVersion" name="resource-version" type="java.lang.String">
                 <xml-element java-attribute="relationshipList" name="relationship-list" type="inventory.aai.onap.org.v17.RelationshipList"/>
             </java-attributes>
             <xml-properties>
-                <xml-property name="namespace" value="network"/>
+                <xml-property name="description" value="vlan tag information"/>
                 <xml-property name="container" value="vlan-tags"/>
-                <xml-property name="uniqueProps" value="vlan-tag-id"/>
-                <xml-property name="uriTemplate" value="/network/vlan-tags/vlan-tag/{vlan-tag-id}"/>
+                <xml-property name="dependentOn" value="vlan-range"/>
+                <xml-property name="uriTemplate" value="/vlan-tags/vlan-tag/{vlan-tag-id}"/>
+                <xml-property name="requiredProps" value="vlan-tag-id,vlan-tag-role,is-private"/>
+                <xml-property name="dslStartNodeProps" value="vlan-tag-id,vlan-tag-role,vlan-tag-type,vlan-id-inner,vlan-id-outer,config-phase,vlan-tag-function"/>
             </xml-properties>
         </java-type>
 
                 <xml-element container-type="java.util.ArrayList" java-attribute="aggregateRoute" name="aggregate-route" type="inventory.aai.onap.org.v17.AggregateRoute"/>
             </java-attributes>
         </java-type>   
-        
+
         <java-type name="AggregateRoute">
             <xml-root-element name="aggregate-route"/>
             <java-attributes>
-                <xml-element java-attribute="routeId" name="route-id" required="true" type="java.lang.String" xml-key="true">
+                <xml-element java-attribute="aggRouteId" name="agg-route-id" required="true" type="java.lang.String" xml-key="true">
                     <xml-properties>
                         <xml-property name="description" value="Unique id of the aggregate-route instance"/>
                     </xml-properties>
-                </xml-element>                
+                </xml-element>
                 <xml-element java-attribute="networkStartAddress" name="network-start-address" required="true" type="java.lang.String">
                     <xml-properties>
                         <xml-property name="description" value="Name of the forwarding-path"/>
                     </xml-properties>
-                </xml-element>                
+                </xml-element>
                 <xml-element java-attribute="cidrMask" name="cidr-mask" required="true" type="java.lang.String">
                     <xml-properties>
                         <xml-property name="description" value="CIDR-mask for aggregate route subnet"/>
                     </xml-properties>
-                </xml-element>                
+                </xml-element>
                 <xml-element java-attribute="ipVersion" name="ip-version" required="true" type="java.lang.String">
                     <xml-properties>
                         <xml-property name="description" value="Identifies is aggregate route is ipv4 or ipv6"/>
                     </xml-properties>
-                </xml-element>                
+                </xml-element>
                  <xml-element java-attribute="resourceVersion" name="resource-version" type="java.lang.String">
                     <xml-properties>
                         <xml-property name="description" value="Used for optimistic concurrency.  Must be empty on create, valid on update and delete."/>
                     </xml-properties>
-                </xml-element> 
-                <xml-element java-attribute="relationshipList" name="relationship-list" type="inventory.aai.onap.org.v17.RelationshipList"/>                   
+                </xml-element>
+                <xml-element java-attribute="relationshipList" name="relationship-list" type="inventory.aai.onap.org.v17.RelationshipList"/>
             </java-attributes>
             <xml-properties>
-                <xml-property name="description" value="Aggregate route configs are used on the D2 IPE&#x2019;s for the Voice services.  In 1902, SDNC will create aggregate-route objects and write them to A&amp;AI. "/>
-                <xml-property name="uniqueProps" value="route-id"/>
-                <xml-property name="container" value="aggregate-routes"/> 
+                <xml-property name="description" value="Aggregate route configs are used on the D2 IPEs for the Voice services.  In 1902, SDNC will create aggregate-route objects and write them to A&amp;AI. "/>
+                <xml-property name="uniqueProps" value="agg-route-id"/>
+                <xml-property name="container" value="aggregate-routes"/>
                 <xml-property name="dependentOn" value="l3-network"/>
-                <xml-property name="uriTemplate" value="/aggregate-routes/aggregate-route/{route-id}"/>
-            <xml-property name="requiredProps" value="route-id,network-start-address,cidr-mask,ip-version"/>
+                <xml-property name="uriTemplate" value="/aggregate-routes/aggregate-route/{agg-route-id}"/>
+            <xml-property name="requiredProps" value="agg-route-id,network-start-address,cidr-mask,ip-version"/>
             </xml-properties>
                </java-type>
-                       
+        
        </java-types>
 </xml-bindings>