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

Code Block

title	onap.relationships.wan.HostOn
collapse	true

onap.relationships.wan.HostOn:
        descriptionrequired: >-false
      ac1_route:
        type: string
 The relationship specifies what Node the Endpoint isdescription: hostedroute on.configure 
of ac1, only for layer3 vpn   derived_from: tosca.relationships.Root
        valid_target_types: [onap.capabilities.wan.host]required: false

Code Block

title	onap.relationships.wan.Contains
collapse	true

onap.relationships.wan.Containsac1_protocol:
        descriptiontype: >-string
        description: routing protocol  The relationship specifies what component is contained.type of ac1, only for layer3 vpn    
        derived_fromconstraints: tosca.relationships.Root

          - valid_target_typesvalues: [onap.capabilities.wan.partOf]

Code Block

title	onap.relationships.wan.DependsOn
collapse	true

onap.relationships.wan.DependsOn:'STATIC','OSPF','ISIS','BGP','other']
        descriptionrequired: >-
false    
        The relationship specifies what is depended on. 
ac1_protocol_bgp_as:
        type: string
    derived_from: tosca.relationships.Root
   description: autonomous-system number of  valid_target_types: [onap.capabilities.wan.dependable]

Code Block

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

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

Panel

title	node types:

Code Block

title	onap.node.wan.Component
collapse	true

onap.node.wan.Component:
  ac1, , only required for ebgp protocol
        required: false                    
      derivedac2_from: tosca.nodes.Rootid:
        propertiestype: string
        description: id of attachment circuit2, uuid:
it can be port name or uuid  
        typerequired: string
false    
        nameac2_svlan:
        type: integer
        typedescription: stringac2 svlan
        required: false    version:
      ac2_ip:
          type: string
        description: ip of ac2, description:
only for layer3 vpn,  it should contain mask
        typerequired: stringfalse    
      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   
      of ac2, only for layer3 vpn   capabilities:
        constraints:
    component:
      - valid_values: ['STATIC','OSPF','ISIS','BGP','other']        type: onap.capabilities.wan.partOf
        requirements:
default: 'STATIC'    
        - configurationrequired: 
false    
      ac2_protocol_bgp_as:
      node  type: onap.node.wan.Component 
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'
       uuid required: false
    requirements:
    - virtualLink:
        typecapability: string
tosca.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.partOf string
           
     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:
       capabilities: tosca.capabilities.Node
    parentNode:
            relationship: tosca.relationships.DependsOn  
			- links:
				node: onap.node.wan.Component.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.ComponentResource.FCFd
collapse	true

onap.node.wan.Component.FC:Resource.Fd:
        derived_from: onap.node.wan.Resource
        description: The ForwardingConstructForwarding Domain (FCFD) class models the topological enabledcomponent constrainedthat potentialrepresents fora forwarding capability betweenthat twoprovides orthe moreopportunity interfacesto atenable aforwarding particular(of specific layerProtocol.transport 
characteristic information at one or more protocol  derived_from: onap.node.wan.Componentlayers) 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.capabilitiesrelationships.AttachesTo

Code Block

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

onap.node.wan.VirtualLinkableResource.Fc:
        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.Component.FCPointResource
    
    properties: 
           capabilitiescapabilities:
			- node:
				type: tosca.capabilities.EndpointNode
                relationship: tosca.relationships.ConnectsTorequirements: 
            - subFcendPoint:
                node: onap.node.wan.Component.FCResource.FcPort    
				capabilities: tosca.capabilities.network.Bindable
                capabilitiesrelationship: onaprelationships.capabilities.wan.dependablenetwork.BindsTo 
            - fcRoute:
   relationship: onap.relationships.wan.DependsOn
            - fcRoute:
node: onap.node.wan.Resource.FcRoute
				capabilities: tosca.capabilities.network.Bindable
                relationship: relationships.network.BindsTo 
			- lowerLevelFc:
				node: onap.node.wan.ComponentResource.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:
            address:
                propertiestype: string
            interface:    description: ip, or mac    
            FcPortDirection:
    type: string
            address:
 type: string
			role:
				type: string
				constraints:
               type: string
    - valid_values: ['working','protection','protected','symmetric','hub', 'spoke', 'leaf', 'root']   
    description: ip, or mac    capabilities:
            hub-spoke-rolerequirements:
                type: string- fd:
				node: onap.node.wan.Resource.Ltp
                descriptioncapabilities: role of the FC Point
       tosca.capabilities.Attachment
          constraints:
        relationship: tosca.relationships.AttachesTo
            - valid_values: ['hub','spoke']ltp:
				node: onap.node.wan.Resource.Ltp
                requiredcapabilities: falsetosca.capabilities.Endpoint
        capabilities:
            endPointrelationship: tosca.relationships.ConnectsTo

Code Block

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

onap.node.wan.Resource.LinkPort:
        description: The association of the Link to LTPs type: tosca.capabilities.Endpoint
        requirements:
            node:is made via LinkPort. The LinkPort class models the access to the Link function.  
                nodederived_from: onap.node.wan.Component.NodeResource
        properties:
          capabilities:  onap.capabilities.wan.hostrole:
                relationship: onap.relationships.wan.HostOn

Code Block

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

onap.node.wan.Resource.XCPoint:
type: string
                description: Exchange Connection Point. Interfaces involved in exchange in a node
        derived_from: onap.node.wan.Resource
   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. 
     properties:
            hub-spoke-roleconstraints:
                type: string
   - valid_values: ['symmetric','hub', 'spoke', 'leaf', 'root']   
     description: role of the FC Point capabilities:
        requirements:
        constraints:
    - ltp:
               - valid_values: ['hub','spoke']node: onap.node.wan.Resource.Ltp
                requiredcapabilities: falsetosca.capabilities.Endpoint
    
            interfacerelationship: tosca.relationships.ConnectsTo

Code Block

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

onap.node.wan.Resource.Ltp:

            description: The Logical Termination type: string
        capabilities:
            endPoint:Point (LTP) class encapsulates the termination and adaptation functions of one or more transport layers represented by instances of LayerProtocol.
                type: tosca.capabilities.Endpointderived_from: onap.node.wan.Resource
        requirementsproperties:
            nodephysicalPortReference:
                nodetype: onap.node.wan.Component.Node
    string
            capabilities:  onap.capabilities.wan.hostltpDirection:
                relationship: onap.relationships.wan.HostOn

Code Block

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

onap.node.wan.Resource.XC:type: string
        descriptioncapabilities:
 Exchange Connection. The exchange relationship within a node describes how the interfaces within the node are linked.
- endPoint:
          derived_from: onap.node.wan.Resource
     type: tosca.capabilities.Endpoint  properties:
        requirements: 
            - endPort:fd:
				node: onap.node.wan.Resource.Fd
                nodecapabilities:  onaptosca.node.wan.Component.XcPoint    capabilities.Attachment
                capabilitiesrelationship: tosca.capabilities.Endpoint
relationships.AttachesTo  
            - serverLtp:
                 relationshipnode: onap.node.wan.Resource.Ltp
				capabilities: tosca.relationships.ConnectsTo   capabilities.Node
                descriptionrelationship: all endPorts can access each othertosca.relationships.DependsOn  
            - nelp:
                node: onap.node.wan.Component.Node    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.LinkConnectionLayerProtocol:
        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 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:
            layerProtocolName:
                propertiestype: string
          topology  address:
                type: string

Code Block

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

onap.node.wan.Resource.Link:
                constraints:
             description: The Link class models effective adjacency between two or more ForwardingDomains (FD). 
       - validderived_values: ['hub-spoke','fullmesh','p2p']from: onap.node.wan.Resource
        properties:
		capabilities:
			- node:
				type: tosca.capabilities.Node
        requirements: 
            - fc:
                node: onap.node.wan.ComponentResource.FC
                Fc
				capabilities: onaptosca.capabilities.wan.dependableNode
                relationship: onaptosca.relationships.wan.DependsOn  
            - endPoint:
                node: onap.node.wan.ComponentResource.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.Component.XClink:
                capabilitiesnode: onap.node.wan.Resource.Link
				capabilities: tosca.wancapabilities.partOfNode
                relationship: onaptosca.relationships.wan.Contains  DependsOn
            - lcsubFc:
                node: onap.node.wan.ComponentResource.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 12

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 12

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain