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
      valueversion:
        type: string
        typerequired: stringfalse
      name:
        type: string
 required: false

Panel

title	capability types:

Code Block

title	onap.capabilities.wan.host
collapse	true

onap.capabilities.wan.host:
    description: Overlay tunnel name  derived_from: tosca.capabilities.Node

Code Block

title	onap.capabilities.wan.partOf
collapse	true

onap.capabilities.wan.partOf:
used by for reference by the administrator.
        required: false
 derived_from: tosca.capabilities.Root

Code Block

title	onap.capabilities.wan.dependable
collapse	true

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

Code Block

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

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

Panel

title	relationship types:

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

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

Code Block

title	onap.relationships.wan.HostOn
collapse	true

onap.relationships.wan.HostOn:
        descriptiontype: >-string
        description: autonomous-system number of ac1, , Theonly relationshiprequired specifiesfor whatebgp Nodeprotocol
 the Endpoint is hosted on. 
  required: false     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:
      ac2_id:
  description: >-
     type: string
      The relationship specifies what component is contained. 
        derived_from: tosca.relationships.Rootdescription: id of attachment circuit2, it can be port name or uuid  
        valid_target_types: [onap.capabilities.wan.partOf] required: false

Code Block

title	onap.relationships.wan.DependsOn
collapse	true

onap.relationships.wan.DependsOn:
        description: >-ac2_svlan:
        type: integer
   The relationship specifies what is dependeddescription: on.ac2 svlan
        derived_from: tosca.relationships.Root
required: false    
      validac2_target_types: [onap.capabilities.wan.dependable]ip:

Code Block

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

tosca.relationships.wan.VirtualLinksTo:
    derived_fromtype: tosca.relationships.DependsOnstring
     valid_target_types: [ tosca.capabilities.wan.VirtualLinkable ]

Panel

title	node types:

Code Block

title	onap.node.ServiceComponent.wan
collapse	true

onap.node.ServiceComponent.wan:
        derived_from: onap.nodes.ServiceComponent
        properties:   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 type:for string
layer3 vpn, it should contain mask
        required: false  description: component type
      ac2_route:
      paras  type: string
        description: route configure of ac2, only for layer3 vpn
  type: list
     required: false    
      entryac2_schemaprotocol:
        type: string
        description: routing protocol type: onap.datatype.wan.UserDefine   
        capabilities: of ac2, only for layer3 vpn   
        constraints:
    component:
      - valid_values: ['STATIC','OSPF','ISIS','BGP','other']        type: onap.capabilities.wan.partOf
        requirements:
default: 'STATIC'    
        required: -false configuration: 
  
      ac2_protocol_bgp_as:
        nodetype: onap.node.ServiceComponent.wan 
string
        description: autonomous-system number of ac2, , only required for capabilities: onap.capabilities.wan.partOf
ebgp protocol        
        relationshiprequired: onap.relationships.wan.Containsfalse

Code Block

title	onap.node.wan.Resource
collapse	true

onap.node.wan.Resource
      af_type:
        derived_fromtype: tosca.nodes.Rootstring
        properties:
description: address family type
        default: 'ipv4'
        uuidrequired: false
    requirements:
    - virtualLink:
        typecapability: stringtosca.capabilities.network.Linkable
        relationship: tosca.relationships.network.LinksTo
    namecapabilities:
      virtual_linkable:
          type: tosca.capabilities.network.Linkable

WAN R3+

Panel

title	Node Types:

Code Block

title	onap.node.wan.Resource
collapse	true

onap.node.wan.Resource:string
        derived_from: tosca.nodes.Root
   version:
     properties:
            typeuuid:
  string
            description:
  type: string
             typename:
 string    
            type: string
                type: stringversion:
                descriptiontype: component typestring
            paraslabel:
                type: list
                entry_schema:
                    type: onap.datatype.wan.UserDefinestring   
        capabilities:
            componenttype:
                type: onap.capabilities.wan.partOfstring
            
    description: component   requirements:type
            - configurationparas: 
                nodetype: onaporg.openecomp.node.wan.Component 
datatypes.Root
        capabilities:
           capabilities: onap.capabilities.wan.partOf - component:
                relationshiptype: onaptosca.relationshipscapabilities.wannetwork.ContainsBindable

Code Block

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

onap.node.wan.Resource.Node:
     
   derived_from: onap.node.wan.Resource
    requirements:
    description: Node resource, it could be site or ne- orspecifications: anything
 else which can be a host for endPoint
        properties:
node: onap.node.wan.Resourece 
             address:   capabilities: tosca.capabilities.network.Bindable
                typerelationship: string
relationships.network.BindsTo

Code Block

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

onap.node.wan.Resource.Connection:
           description: ip, or mac, or geo addressderived_from: onap.node.wan.Resource
            vendorproperties:
        capabilities:        
			- connection:
				type: stringtosca.capabilities.network.Linkable
        capabilitiesrequirements:
            host- fcs: 
                typenode: onap.capabilitiesnode.wan.Resource.hostFc 
        requirements:
            parentNode:capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn  
			- links:
				node: onap.node.wan.Resource.Link
				capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn
			- fds:
				node: onap.node.wan.Resource.Fd
				capabilities:  onaptosca.capabilities.wan.hostNode
                relationship: onaptosca.relationships.wan.HostOn    DependsOn

Code Block

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

onap.node.wan.FC:Resource.Fd:
        derived_from: onap.node.wan.Resource
        description: The ForwardingConstructForwarding Domain (FCFD) class models enabled constrained potential forthe topological component that represents a forwarding betweencapability that twoprovides orthe moreopportunity interfacesto atenable aforwarding particular(of specific layerProtocol.transport 
characteristic information at one or more protocol  derived_from: onap.node.ServiceComponent.wanlayers) between points.
        properties: 
            topologyaddress:
                type: string
                constraintsdescription:
 ip,                   - valid_values: ['hub-spoke','fullmesh','p2p']    
    or mac, or geo address
        tenantcapabilities:
            -    typedomain: string
            creator:
    type: tosca.capabilities.Attachment
			- node:
				type: tosca.capabilities.Node
         typerequirements:
  string
          - higherLevelFd:
				node: onap.node.wan.Resource.Fd
     description:  creator 
        capabilities:
      tosca.capabilities.Attachment
       dependable:
         relationship: tosca.relationships.AttachesTo      type
			- ltps:
				node: onap.capabilitiesnode.wan.dependable
Resource.Ltp
                virtual_linkable:capabilities:  tosca.capabilities.Attachment
                typerelationship: tosca.relationships.AttachesTo

Code Block

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

onap.node.wan.Resource.Fc:capabilities.wan.VirtualLinkable
        requirementsdescription: 
The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between two -or endPoint:
more interfaces at a particular specific layerProtocol. 
         nodederived_from: onap.node.wan.Resource.FCPoint
    
    properties: 
           capabilitiescapabilities:
			- node:
				type: tosca.capabilities.EndpointNode
                relationship: tosca.relationships.ConnectsTorequirements: 
            - subFcendPoint:
                node: onap.node.wan.Resource.FCFcPort    
				capabilities: tosca.capabilities.network.Bindable
                capabilitiesrelationship: onaprelationships.capabilities.wan.dependable
network.BindsTo 
            - fcRoute:
      relationship: onap.relationships.wan.DependsOn
         node: onap.node.wan.Resource.FcRoute
				capabilities: tosca.capabilities.network.Bindable
  - fcRoute:
             relationship: relationships.network.BindsTo 
			- lowerLevelFc:
				node: onap.node.wan.Resource.FCRouteFc 
                capabilities: onaptosca.capabilities.wan.dependableNode
                relationship: onaptosca.relationships.wan.DependsOn

Code Block

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

onap.node.wan.Resource.FCPointFcPort:
        description: Fowarding Construct Point. The association of the FC to interfaces is made via FCPointsFcPorts. The FCPointFcPort 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-roleFcPortDirection:
                type: string
                description: role of the FC Point
                			role:
				type: string
				constraints:
                    - valid_values: [: ['working','protection','protected','symmetric','hub', 'spoke']
  , 'leaf', 'root']   
           required: falsecapabilities:
        capabilitiesrequirements:
            endPoint:- fd:
				node: onap.node.wan.Resource.Ltp
                typecapabilities:  tosca.capabilities.EndpointAttachment
        requirements:
            node:relationship: tosca.relationships.AttachesTo
                - ltp:
				node: onap.node.wan.Resource.NodeLtp
                capabilities:  onaptosca.capabilities.wan.hostEndpoint
                relationship: onaptosca.relationships.wan.HostOnConnectsTo

Code Block

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

onap.node.wan.Resource.XCPointLinkPort:
        description: Exchange Connection Point. Interfaces involved in exchange in a nodeThe association of the Link to LTPs is made via LinkPort. The LinkPort class models the access to the Link function.  
        derived_from: onap.node.wan.Resource
        properties:

            role:
                hub-spoke-role:type: string
                typedescription: string
                description: role of the FC PointEach 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. 
                constraints:
                    - valid_values: ['symmetric','hub', 'spoke']
  , 'leaf', 'root']   
        capabilities:
   required: false    requirements:
            - interfaceltp:
                typenode: stringonap.node.wan.Resource.Ltp
        capabilities:
            endPoint:capabilities: tosca.capabilities.Endpoint
                typerelationship: tosca.capabilities.Endpoint.relationships.ConnectsTo

Code Block

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

onap.node.wan.Resource.Ltp:
        requirements:
            node:
       description: The Logical Termination Point (LTP) class encapsulates the termination and adaptation functions of one or more transport layers represented by instances of LayerProtocol.
         nodederived_from: onap.node.wan.Resource.Node
                capabilities:  onap.capabilities.wan.host
properties:
            physicalPortReference:
      relationship: onap.relationships.wan.HostOn

Code Block

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

onap.node.wan.Resource.XC:         type: string
        description    ltpDirection:
 Exchange Connection. The exchange relationship within a node describes how the interfaces within the node aretype: linked.string
        derived_fromcapabilities: onap.node.wan.Resource

            - propertiesendPoint:
         requirements:  
     type: tosca.capabilities.Endpoint  
    - endPort:
   requirements:
            - fd:
				node: onap.node.wan.Resource.XcPoint    Fd
                capabilities:  tosca.capabilities.EndpointAttachment
                relationship: tosca.relationships.ConnectsToAttachesTo  
            - serverLtp:
                 description: all endPorts can access each othernode: onap.node.wan.Resource.Ltp
				capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn  
            - nelp:
                node: onap.node.wan.Resource.Node    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
.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 constraints:
two or more ForwardingDomains (FD). 
               - valid_values: ['hub-spoke','fullmesh','p2p']derived_from: onap.node.wan.Resource
        properties:
		capabilities:
			- node:
				type: tosca.capabilities.Node
        requirements: 
            - fc:
                node: onap.node.wan.Resource.FC
                Fc
				capabilities: onaptosca.capabilities.wan.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 14

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 14

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain