org.openecomp.resource.vl.overlaytunnel:
    derived_from: tosca.nodes.Root
    description: This entity represents abstract overlay tunnel end point.
    properties:
      id:
        type: string
        description: Identifier of the Tunnel Endpoint node.
        required: false
      template_name:
        type: string
        required: false
      version:
        type: string
        required: false
      name:
        type: string
        description: Overlay tunnel name used by for reference by the administrator.
        required: false
      description:
        type: string
        description: Additional comments/information about overlay tunnel.
        required: false
      tunnelType:
        type: string
        constraints:
          - valid_values: ['L3-DCI','L2-DCI']
        description: type defines if the overlay tunnel is L3-DCI tunnel or L2-DCI tunnel.
        required: true
      site1_id:
        type: string
        description: Identifier of first DCI overlay tunnel endpoint. This could be IP address of domain controller.
        required: true
      site1_description:
        type: string
        description: Additional comments/information about overlay tunnel. Description can also be used to identify domain controller.
        required: false
      site1_networkName:
        type: string
        description: Name of the network that is being associated with overlay tunnel.
        required: true
      site1_routerId:
        type: string
        description: Identifier of router connected to L3 tunnel end point, while configuring L3-DCI tunnel.
        required: false
      site1_importRT1:
        type: string
        description: List of Route targets imported by the local router.
        required: false
      site1_exportRT1:
        type: string
        description: List of Route targets exported by the local router.
        required: false
      site1_vni:
        type: integer
        description: VXLAN ID
        required: false
      site1_fireWallEnable:
        type: boolean
        required: false
        description: Identifies if a firewall exists in the path of overlay tunnel.
        default: false
      site1_fireWallId:
        type: string
        description: Identifier of Firewall that is in overlay tunnel path
        required: false
      site1_localNetworkAll:
        type: boolean
        description: Identifies whether all the local networks associate with the tunnel or not.
        required: false
        default: 'false'
      site2_id:
        type: string
        description: Identifier of second DCI overlay tunnel endpoint. This could be IP address of domain controller.
        required: true
      site2_description:
        type: string
        description: Additional comments/information about overlay tunnel. Description can also be used to identify domain controller.
        required: false
      site2_networkName:
        type: string
        description: Name of the network that is being associated with overlay tunnel.
        required: true
      site2_routerId:
        type: string
        description: Identifier of router connected to L3 tunnel end point, while configuring L3-DCI tunnel.
        required: false
      site2_importRT1:
        type: string
        description: List of Route targets imported by the local router.
        required: false
      site2_exportRT1:
        type: string
        description: List of Route targets exported by the local router.
        required: false
      site2_vni:
        type: integer
        description: VXLAN ID
        required: false
      site2_fireWallEnable:
        type: boolean
        required: false
        description: Identifies if a firewall exists in the path of overlay tunnel.
        default: false
      site2_fireWallId:
        type: string
        description: Identifier of Firewall that is in overlay tunnel path
        required: false
      site2_localNetworkAll:
        type: boolean
        description: Identifies whether all the local networks associate with the tunnel or not.
        required: false
        default: 'false'
    requirements:
    - virtualLink:
        capability: tosca.capabilities.network.Linkable
        relationship: tosca.relationships.network.LinksTo
    capabilities:
      virtual_linkable:
        type: tosca.capabilities.network.Linkable

org.openecomp.resource.vl.underlayvpn:
    derived_from: tosca.nodes.Root
    description: undelay vpn type definitions
    properties:
      id:
        type: string
        required: false
      template_name:
        type: string
        required: false
      version:
        type: string
        required: false
      vendor:
        type: string
        required: false
      template_author:
        type: string
        required: false
      name:
        type: string
        required: false
      description:
        type: string
        required: false
      serviceType:    
        type: string
        description: type of VPN service
        required: false
        default: 'l3vpn_sptn'
      topology:
        type: string
        description: type of VPN topology
        constraints:
          - valid_values: ['full-mesh','point_to_multipoint','point_to_point','singlePoint','hubspoke','hubspoke_via_hubce','hubspoke_disjoint','ADD_DROP_Z']
        required: false
        default: 'full-mesh'
      technology:
        type: string
        description: type of VPN technology
        constraints:
          - valid_values: ['mpls','rosen multivpn','vxlan overlay l3vpn','eth over sdh','vlan']
        required: false
        default: 'mpls'
      site1_name:       
        type: string
        description: name of first site
        required: false
      site2_name:       
        type: string
        description: name of second site
        required: false
      sna1_name:
        type: string
        description: name of site network accesses associated with the site1
        required: false
      sna2_name:
        type: string
        description: name of site network accesses associated with the site2  
        required: false
      pe1_id:    
        type: string
        description: id of provider edge1, it can be name or ip or uuid 
        required: false
      pe2_id:    
        type: string
        description: id of provider edge2, it can be name or ip or uuid 
        required: false
      ac1_id:
        type: string
        description: id of attachment circuit1, it can be port name or uuid    
        required: false
      ac1_svlan:
        type: integer
        description: ac1 svlan
        required: false
      ac1_ip:
        type: string
        description: ip of ac1, only for layer3 vpn, it should contain mask
        required: false
      ac1_peer_ip:
        type: string
        description: ip of ac1 peer CE tp, only for layer3 vpn, it should contain mask
        required: false
      ac1_route:
        type: string
        description: route configure of ac1, only for layer3 vpn    
        required: false
      ac1_protocol:
        type: string
        description: routing protocol type of ac1, only for layer3 vpn    
        constraints:
          - valid_values: ['STATIC','OSPF','ISIS','BGP','other']
        required: false    
      ac1_protocol_bgp_as:
        type: string
        description: autonomous-system number of ac1, , only required for ebgp protocol
        required: false                    
      ac2_id:
        type: string
        description: id of attachment circuit2, it can be port name or uuid  
        required: false    
      ac2_svlan:
        type: integer
        description: ac2 svlan
        required: false    
      ac2_ip:
        type: string
        description: ip of ac2, only for layer3 vpn, it should contain mask
        required: false    
      ac2_peer_ip:
        type: string
        description: ip of ac2 peer CE tp, only for layer3 vpn, it should contain mask
        required: false    
      ac2_route:
        type: string
        description: route configure of ac2, only for layer3 vpn
        required: false    
      ac2_protocol:
        type: string
        description: routing protocol type of ac2, only for layer3 vpn   
        constraints:
          - valid_values: ['STATIC','OSPF','ISIS','BGP','other']        
        default: 'STATIC'    
        required: false    
      ac2_protocol_bgp_as:
        type: string
        description: autonomous-system number of ac2, , only required for ebgp protocol        
        required: false    
      af_type:
        type: string
        description: address family type
        default: 'ipv4'
        required: false
    requirements:
    - virtualLink:
        capability: tosca.capabilities.network.Linkable
        relationship: tosca.relationships.network.LinksTo
    capabilities:
      virtual_linkable:
        type: tosca.capabilities.network.Linkable

onap.datatype.wan.UserDefine:
        derived_from: tosca.datatypes.Root
        properties:
            name:
                type: string
                description: resful uri supported
                required: true
            value:
                type: string
                required: false  

onap.capabilities.wan.host:
         derived_from: tosca.capabilities.Node  

onap.capabilities.wan.partOf:
         derived_from: tosca.capabilities.Root    

onap.capabilities.wan.dependable:
         derived_from: tosca.capabilities.Root  

tosca.capabilities.wan.VirtualLinkable:
    derived_from: tosca.capabilities.Root

onap.relationships.wan.HostOn:
        description: >-
            The relationship specifies what Node the Endpoint is hosted on. 
        derived_from: tosca.relationships.Root
        valid_target_types: [onap.capabilities.wan.host]     

onap.relationships.wan.Contains:
        description: >-
            The relationship specifies what component is contained. 
        derived_from: tosca.relationships.Root
        valid_target_types: [onap.capabilities.wan.partOf]     

onap.relationships.wan.DependsOn:
        description: >-
            The relationship specifies what is depended on. 
        derived_from: tosca.relationships.Root
        valid_target_types: [onap.capabilities.wan.dependable]    

tosca.relationships.wan.VirtualLinksTo:
    derived_from: tosca.relationships.DependsOn
    valid_target_types: [ tosca.capabilities.wan.VirtualLinkable ]

onap.node.ServiceComponent.wan:
        derived_from: onap.nodes.ServiceComponent
        properties:
            type:
                type: string
                description: component type
            paras:
                type: list
                entry_schema:
                    type: onap.datatype.wan.UserDefine   
        capabilities:
            component:
                type: onap.capabilities.wan.partOf
        requirements:
            - configuration: 
                node: onap.node.ServiceComponent.wan 
                capabilities: onap.capabilities.wan.partOf
                relationship: onap.relationships.wan.Contains    

onap.node.wan.Resource:
        derived_from: tosca.nodes.Root
        properties:
            uuid:
                type: string
            name:
                type: string
            version:
                type: string
            description:
                type: string    
            type:
                type: string
                description: component type
            paras:
                type: list
                entry_schema:
                    type: onap.datatype.wan.UserDefine   
        capabilities:
            component:
                type: onap.capabilities.wan.partOf            
        requirements:
            - configuration: 
                node: onap.node.wan.Component 
                capabilities: onap.capabilities.wan.partOf
                relationship: onap.relationships.wan.Contains    

onap.node.wan.Resource.Node:
        derived_from: onap.node.wan.Resource
        description: Node resource, it could be site or ne or anything else which can be a host for endPoint
        properties:
            address:
                type: string
                description: ip, or mac, or geo address
            vendor:
                type: string
        capabilities:
            host: 
                type: onap.capabilities.wan.host
        requirements:
            parentNode:
                capabilities:  onap.capabilities.wan.host
                relationship: onap.relationships.wan.HostOn     

onap.node.wan.FC:
        description: The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between two or more interfaces at a particular specific layerProtocol. 
        derived_from: onap.node.ServiceComponent.wan
        properties: 
            topology:
                type: string
                constraints:
                    - valid_values: ['hub-spoke','fullmesh','p2p']    
            tenant:
                type: string
            creator:
                type:  string
                description:  creator 
        capabilities:
            dependable:
                type: onap.capabilities.wan.dependable
            virtual_linkable:
                type: tosca.capabilities.wan.VirtualLinkable
        requirements: 
            - endPoint:
                node: onap.node.wan.Resource.FCPort    
                capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo
            - fcRoute:
                capabilities: onap.capabilities.wan.dependable
                relationship: onap.relationships.wan.DependsOn

onap.node.wan.Resource.FCPort:
        description: Fowarding Construct Point. The association of the FC to interfaces is made via FCPorts. The FCPort class models the access to the FC function.  
        derived_from: onap.node.wan.Resource
        properties:
            interface:
                type: string
            address:
                type: string
                description: ip, or mac    
            hub-spoke-role:
                type: string
                description: role of the FC Point
                constraints:
                    - valid_values: ['hub','spoke']
                required: false
        capabilities:
            endPoint:
                type: tosca.capabilities.Endpoint
        requirements:
            node:
                capabilities:  onap.capabilities.wan.host
                relationship: onap.relationships.wan.HostOn

onap.node.wan.Resource.XCPoint:
        description: Cross Connection Point. Interfaces involved in exchange in a node
        derived_from: onap.node.wan.Resource
        properties:
            hub-spoke-role:
                type: string
                description: role of the FC Point
                constraints:
                    - valid_values: ['hub','spoke']
                required: false    
            interface:
                type: string
        capabilities:
            endPoint:
                type: tosca.capabilities.Endpoint
        requirements:
            node:
                capabilities:  onap.capabilities.wan.host
                relationship: onap.relationships.wan.HostOn  

onap.node.wan.Resource.XC:
        description: Cross Connection. The exchange relationship within a node describes how the interfaces within the node are linked.
        derived_from: onap.node.wan.Resource
        properties:
        requirements: 
            - endPort:
                node: onap.node.wan.Resource.XcPoint    
                capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo   
                description: all endPorts can access each other
            - ne:
                capabilities:  onap.capabilities.wan.host
                relationship: onap.relationships.wan.HostOn

onap.node.wan.Resource.LinkConnection:
        description: The exchange relationship between nodes, describing how the interfaces between nodes are linked. The link can depend on the FC of the service layer
        derived_from: onap.node.wan.Resource
        properties:
          topology:
                type: string
                constraints:
                    - valid_values: ['hub-spoke','fullmesh','p2p']       
        requirements: 
            - fc:
                capabilities: onap.capabilities.wan.dependable
                relationship: onap.relationships.wan.DependsOn
            - endPoint:
                node: onap.node.wan.Resource.XcPoint    
                capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo    

onap.node.wan.Resource.FCRoute:
        description: The routing relationships within FC are described, including routing between sub FC (interdomain links), and links between network elements and network elements.
        derived_from: onap.node.wan.Resource
        properties:
        capabilities:
            dependable:
                type: onap.capabilities.wan.dependable        
        requirements:
            - xc: 
                node: onap.node.wan.Resource.XC
                capabilities: onap.capabilities.wan.partOf
                relationship: onap.relationships.wan.Contains  
            - lc:
                node: onap.node.wan.Resource.LinkConnection
                capabilities: onap.capabilities.wan.partOf
                relationship: onap.relationships.wan.Contains  
            - subFc:
                capabilities: onap.capabilities.wan.dependable
                relationship: onap.relationships.wan.DependsOn