Table of Contents

WAN R2

Same with R1

Panel

title	data type:Node Type

Code Block

title	onaporg.openecomp.datatyperesource.wanvl.UserDefineoverlaytunnel
collapse	true

onaporg.openecomp.datatyperesource.wanvl.UserDefineoverlaytunnel:
        derived_from: tosca.datatypesnodes.Root
        propertiesdescription:
 This entity represents abstract overlay tunnel end point.
    nameproperties:
      id:
          type: string
        description: Identifier of the Tunnel Endpoint node.
  description: resful uri supported
   required: false
      template_name:
      required  type: truestring
        required: false
     value version:
        type: string
        typerequired: stringfalse
      name:
          requiredtype: false

Panel

title	capability types:

Code Block

title	onap.capabilities.wan.host
collapse	true

onap.capabilities.wan.host:
string
        description: Overlay  derived_from: tosca.capabilities.Node

Code Block

title	onap.capabilities.wan.partOf
collapse	true

onap.capabilities.wan.partOf:
 tunnel name used by for reference by the administrator.
        required: false
      description:
        derived_from: tosca.capabilities.Roottype: string

Code Block

title	onap.capabilities.wan.dependable
collapse	true

onap.capabilities.wan.dependable:
    description: Additional comments/information about overlay tunnel.
     derived_from: tosca.capabilities.Root

Code Block

firstline	1
title	tosca.capabilities.wan.VirtualLinkable
linenumbers	true
collapse	true

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

Panel

title	relationship types:

Code Block

title	onap.relationships.wan.HostOn
collapse	true

onap.relationships.wan.HostOn:  tunnelType:
        descriptiontype: >-string
        constraints:
    The relationship specifies what Node the Endpoint is hosted on. 
- valid_values: ['L3-DCI','L2-DCI']
        description: type derived_from: tosca.relationships.Root
        valid_target_types: [onap.capabilities.wan.host]

Code Block

title	onap.relationships.wan.Contains
collapse	true

onap.relationships.wan.Contains:defines if the overlay tunnel is L3-DCI tunnel or L2-DCI tunnel.
        descriptionrequired: >-true
      site1_id:
      The relationship specifies what component is contained. type: string
        derived_fromdescription: tosca.relationships.Root
        valid_target_types: [onap.capabilities.wan.partOf]

Code Block

title	onap.relationships.wan.DependsOn
collapse	true

onap.relationships.wan.DependsOn:Identifier of first DCI overlay tunnel endpoint. This could be IP address of domain controller.
        descriptionrequired: >-true
      site1_description:
      The relationship specifiestype: whatstring
 is depended on. 
    description: Additional comments/information about derived_from: tosca.relationships.Root
  overlay tunnel. Description can also be used to identify domain controller.
        required: false
      validsite1_target_typesnetworkName: [onap.capabilities.wan.dependable]

Code Block

firstline	1
title	tosca.relationships.wan.VirtualLinksTo
linenumbers	true
collapse	true

tosca.relationships.wan.VirtualLinksTo:   type: string
    derived_from: tosca.relationships.DependsOn
    description: Name of the network that is being associated with overlay tunnel.
     valid_target_types: [ tosca.capabilities.wan.VirtualLinkable ]

Panel

title	node types:

   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

Code Block

title	org.openecomp.resource.vl.underlayvpn
collapse	true

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

Code Block

title	onap.node.ServiceComponent.wan
collapse	true

onap.node.ServiceComponent.wan:
        derived_from: onap.nodes.ServiceComponent
        propertiesrequired:
 false    
       af_type:
                type: string
        description: address family type
        descriptiondefault: component type
'ipv4'
        required: false
    parasrequirements:
    - virtualLink:
        capability: tosca.capabilities.network.Linkable
  type: list
     relationship: tosca.relationships.network.LinksTo
    capabilities:
      entryvirtual_schemalinkable:
        type: tosca.capabilities.network.Linkable

WAN R3+

Panel

title	Node Types:

Code Block

title	onap.node.wan.Resource
collapse	true

onap.node.wan.Resource:
           typederived_from: onaptosca.datatype.wan.UserDefine   nodes.Root
        capabilitiesproperties:
            componentuuid:
                type: onap.capabilities.wan.partOf
string
         requirements   name:
            -    configurationtype: string
            version:
    node: onap.node.ServiceComponent.wan 
            type: string
      capabilities: onap.capabilities.wan.partOf
     label:
           relationship: onap.relationships.wan.Contains

Code Block

title	onap.node.wan.Resource
collapse	true

onap.node.wan.Resource:
type: list
          derived_from: tosca.nodes.Root      entry_schema:
        properties:
            uuidtype:
 string   
            type:
    string
            nametype: string
                typedescription: stringcomponent type
            versionparas:
                type: string
 org.openecomp.datatypes.Root
        capabilities:
            - descriptioncomponent:
                type: tosca.capabilities.network.Bindable  type: string    
   
         typerequirements:
            -    typespecifications: string
                descriptionnode: component typeonap.node.wan.Resourece 
            paras:
    capabilities: tosca.capabilities.network.Bindable
           type: list
    relationship: relationships.network.BindsTo           entry_schema

Code Block

title	onap.node.wan.Resource.Connection
collapse	true

onap.node.wan.Resource.Connection:
                    typederived_from: onap.datatypenode.wan.UserDefine   Resource
        capabilitiesproperties:
            componentcapabilities:
                
			- connection:
				type: onaptosca.capabilities.wan.partOf            network.Linkable
        requirements:
            - configurationfcs: 
                node: onap.node.wan.Resource.ComponentFc 
                capabilities: onaptosca.capabilities.wan.partOfNode
                relationship: onaptosca.relationships.wan.ContainsDependsOn

Code Block

title	onap.node.wan.Resource.Node
collapse	true

onap.node.wan.Resource.Node:
        derived_from
			- links:
				node: 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:.Link
				capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn
			- fds:
				node: onap.node.wan.Resource.Fd
				capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn

Code Block

title	onap.node.wan.Resource.Fd
collapse	true

onap.node.wan.Resource.Fd:type: string
        derived_from: onap.node.wan.Resource
        description: ip,The orForwarding mac, or geo address
            vendor:
                type: stringDomain (FD) class models the topological component that represents a forwarding capability that provides the opportunity to enable forwarding (of specific transport characteristic information at one or more protocol layers) between points.
        capabilitiesproperties:
            hostaddress: 
                type: onap.capabilities.wan.hoststring
        requirements:
            parentNodedescription:
 ip, or mac, or geo   address
        capabilities:  onap.capabilities.wan.host
                relationship: onap.relationships.wan.HostOn

Code Block

title	onap.node.wan.FC
collapse	true

onap.node.wan.FC:
- domain: 
          description:  The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between two or more interfaces at a particular specific layerProtocol. 
type: tosca.capabilities.Attachment
			- node:
				type: tosca.capabilities.Node
        requirements:
             derived_from- higherLevelFd:
				node: onap.node.wan.ServiceComponentResource.wan
Fd
              properties  capabilities: tosca.capabilities.Attachment
             topology:
   relationship: tosca.relationships.AttachesTo    
			- ltps:
				node: onap.node.wan.Resource.Ltp
      type: string
         capabilities:  tosca.capabilities.Attachment
     constraints:
           relationship: tosca.relationships.AttachesTo

Code Block

title	onap.node.wan.Resource.Fc
collapse	true

onap.node.wan.Resource.Fc:
    - valid_values: ['hub-spoke','fullmesh','p2p']   description: 
The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between two tenant:
or more interfaces at a particular specific layerProtocol. 
        typederived_from: stringonap.node.wan.Resource
        properties: 
   creator:
     capabilities:
			- node:
				type: tosca.capabilities.Node
         typerequirements:  string
            -    description:  creator 
endPoint:
         capabilities:
       node: onap.node.wan.Resource.FcPort    dependable:
				capabilities: tosca.capabilities.network.Bindable
                typerelationship: onaprelationships.capabilities.wan.dependablenetwork.BindsTo 
            virtual_linkable- fcRoute:
                typenode: toscaonap.capabilitiesnode.wan.Resource.VirtualLinkable
        requirements: 
       FcRoute
				capabilities: tosca.capabilities.network.Bindable
     - endPoint:
          relationship: relationships.network.BindsTo     
			- lowerLevelFc:
				node: onap.node.wan.Resource.FCPoint  Fc  
                capabilities: tosca.capabilities.EndpointNode
                relationship: tosca.relationships.DependsOn

Code Block

title	onap.node.wan.Resource.FcPort
collapse	true

onap.node.wan.Resource.FcPortConnectsTo
            - subFc:
        description: Fowarding       capabilities: onap.capabilities.wan.dependable
                relationship: onap.relationships.wan.DependsOn
            - fcRoute: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
       capabilities: onap.capabilities.wan.dependable properties:
            address:
    relationship: onap.relationships.wan.DependsOn

Code Block

title	onap.node.wan.Resource.FCPoint
collapse	true

onap.node.wan.Resource.FCPoint:
          description: Fowarding Construct Point. The association of the FC to interfaces is made via FCPoints. The FCPoint class models the access to the FC function.type: string
                description: ip, or mac    
        derived_from: onap.node.wan.Resource
    FcPortDirection:
      properties:
          type:  interface:
string
			role:
				type: string
				constraints:
                    - type: string
            address:valid_values: ['working','protection','protected','symmetric','hub', 'spoke', 'leaf', 'root']   
        capabilities:
        typerequirements: string
                description: ip, or mac- fd:
				node: onap.node.wan.Resource.Ltp
      
          capabilities:  hub-spoke-role:tosca.capabilities.Attachment
                typerelationship: string
      tosca.relationships.AttachesTo
          description: role of the FC Point- ltp:
				node: onap.node.wan.Resource.Ltp
                constraints:capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo

Code Block

title	onap.node.wan.Resource.LinkPort
collapse	true

onap.node.wan.Resource.LinkPort:    - valid_values: ['hub','spoke']
        description: The association of the Link to LTPs required:is false
made via LinkPort. The LinkPort class models the capabilities:
access to the Link function.        endPoint:
                type: tosca.capabilities.Endpointderived_from: onap.node.wan.Resource
        requirementsproperties:
            noderole:
                capabilitiestype:  onap.capabilities.wan.hoststring
                relationshipdescription: onap.relationships.wan.HostOn

Code Block

title	onap.node.wan.Resource.XCPoint
collapse	true

onap.node.wan.Resource.XCPoint:
        description: Exchange Connection Point. Interfaces involved in exchange in a node
 Each LinkPort of the Link has a role (e.g., symmetric, hub, spoke, leaf, root) in the context of the Link with respect to the Link capability. 
                derived_from: onap.node.wan.Resourceconstraints:
        properties:
            hub-spoke-role:
    - valid_values: ['symmetric','hub', 'spoke', 'leaf', 'root']   
         typecapabilities: string
        requirements:
        description: role of the FC- Pointltp:
                constraints:node: onap.node.wan.Resource.Ltp
                capabilities: tosca.capabilities.Endpoint
   - valid_values: ['hub','spoke']
           relationship: tosca.relationships.ConnectsTo

Code Block

title	onap.node.wan.Resource.Ltp
collapse	true

onap.node.wan.Resource.Ltp:
     required:  false description: The Logical 
Termination Point (LTP) class encapsulates the termination and adaptation functions of one interface:
or more transport layers represented by instances of LayerProtocol.
        typederived_from: stringonap.node.wan.Resource
        capabilitiesproperties:
            endPointphysicalPortReference:
                type: tosca.capabilities.Endpoint
string
          requirements  ltpDirection:
             node:
   type: string
        capabilities:
          capabilities:  onap.capabilities.wan.host- endPoint:
                relationshiptype: onaptosca.relationshipscapabilities.wan.HostOn

Code Block

title	onap.node.wan.Resource.XC
collapse	true

onap.node.wan.Resource.XC:Endpoint  
        descriptionrequirements:
     Exchange  Connection. The exchange relationship within a node describes how the interfaces within the node are linked.
- fd:
				node: onap.node.wan.Resource.Fd
                derived_fromcapabilities: onap tosca.nodecapabilities.wan.ResourceAttachment
        properties:
        requirements: relationship: tosca.relationships.AttachesTo  
            - endPortserverLtp:
                node: onap.node.wan.Resource.XcPoint    
                Ltp
				capabilities: tosca.capabilities.EndpointNode
                relationship: tosca.relationships.ConnectsToDependsOn   
            -    description: all endPorts can access each other
lp:
               - ne:node: onap.node.wan.Resource.LayerProtocol
                capabilities:  onaptosca.capabilities.wannetwork.hostBindable
                relationship: onap.relationships.wannetwork.HostOnBindsTo

Code Block

title	onap.node.wan.Resource.LinkConnectionLayerProtocol
collapse	true

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
.wan.Resource.LayerProtocol:
        description: The projection of an LTP into each transport layer is represented by a LayerProtocol (LP) instance. A LayerProtocol instance can be 
used for controlling termination and monitoring functionality. 
        derived_from: onap.node.wan.Resource
        properties:
            derived_from: onap.node.wan.Resource
layerProtocolName:
                propertiestype: string
          topology  address:
                type: string

Code Block

title	onap.node.wan.Resource.Link
collapse	true

onap.node.wan.Resource.Link:
        description: The Link class models effective adjacency between two or constraints:
more ForwardingDomains (FD). 
        derived_from: onap.node.wan.Resource
        - valid_values: ['hub-spoke','fullmesh','p2p']       properties:
		capabilities:
			- node:
				type: tosca.capabilities.Node
        requirements: 
            - fc:
                capabilitiesnode: onap.node.wan.Resource.Fc
				capabilities: tosca.wancapabilities.dependableNode
                relationship: onaptosca.relationships.wan.DependsOn  
            - endPoint:
                node: onap.node.wan.Resource.XcPointLinkPort    
                capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo

Code Block

title	onap.node.wan.Resource.FCRouteFcRoute
collapse	true

onap.node.wan.Resource.FCRouteFcRoute:
        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 link:
                capabilitiesnode: onap.node.wan.Resource.Link
				capabilities: tosca.wancapabilities.partOfNode
                relationship: onaptosca.relationships.wan.Contains  DependsOn
            - lcsubFc:
                node: onap.node.wan.Resource.LinkConnection
                Fc
				capabilities: onaptosca.capabilities.wan.partOfNode
                relationship: onaptosca.relationships.wan.Contains  DependsOn

R3 Class Explain

Wan Connection IM proposal

Space shortcuts

Page tree

Versions Compared

Old Version 15

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 15

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain