Table of Contents

WAN R2

Same with R1

Panel

title	Node Type

Code Block

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

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

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        
        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

WAN R3+

Panel

title	data typeNode Types:

Code Block

title	onap.datatypenode.wan.UserDefineResource
collapse	true

onap.datatypenode.wan.UserDefineResource:
        derived_from: tosca.datatypesnodes.Root
        properties:
            nameuuid:
                type: string
                description: resful uri supportedname:
                requiredtype: truestring
            valueversion:
                type: string
            label:
    required: false

Panel

title	capability types:

Code Block

title	onap.capabilities.wan.host
collapse	true

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

Code Block

title	onap.capabilities.wan.partOf
collapse	true

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

Code Block

title	onap.capabilities.wan.dependable
collapse	true

onap.capabilities.wan.dependable:
         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:

Code Block

title	onap.relationships.wan.HostOn
collapse	true

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]

Code Block

title	onap.relationships.wan.Contains
collapse	true

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

Code Block

title	onap.relationships.wan.DependsOn
collapse	true

onap.relationships.wan.DependsOn:
        description: >-
            The relationship specifies what is depended on. 
        derived_from: tosca.relationships.Root
        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.ServiceComponent.wan
collapse	true

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

Code Block

title	onap.node.wan.Resource
collapse	true

onap.node.wan.Resource:
        derived_from: tosca.nodes.Root
        properties:
            uuid:
                type: string
            name:
                type: string
            version:
type: list
                         type: string
   entry_schema:
         description:
                type: string    
            type:
                type: string
                description: component type
            paras:
                type: list
                entry_schema:
                    type: onap.datatype.wan.UserDefine   org.openecomp.datatypes.Root
        capabilities:
            - component:
                type: onaptosca.capabilities.wannetwork.partOf  Bindable          
        requirements:
            - configurationspecifications: 
                node: onap.node.wan.ComponentResourece 
                capabilities: onaptosca.capabilities.wannetwork.partOfBindable
                relationship: onap.relationships.wannetwork.ContainsBindsTo

Code Block

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

onap.node.wan.Resource.NodeConnection:
        derived_from: onap.node.wan.Resource
        descriptionproperties:
 Node resource, it could be site or necapabilities: or anything else which can be a host for endPoint
			- connection:
				type: tosca.capabilities.network.Linkable
        propertiesrequirements:
            - addressfcs: 
                node: onap.node.wan.Resource.Fc 
    type: string
           capabilities: tosca.capabilities.Node
    description: ip, or mac, or geo address
      relationship: tosca.relationships.DependsOn  
			- links:
				node:  vendor:onap.node.wan.Resource.Link
				capabilities: tosca.capabilities.Node
                typerelationship: string
        capabilities:
            host: tosca.relationships.DependsOn
			- fds:
				node: onap.node.wan.Resource.Fd
				capabilities: tosca.capabilities.Node
                typerelationship: tosca.relationships.DependsOn

Code Block

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

onap.capabilitiesnode.wan.Resource.hostFd:
        requirements:derived_from: onap.node.wan.Resource
            parentNode:
      description: The Forwarding Domain (FD) class models the topological component capabilities:that  onap.capabilities.wan.host
                relationship: onap.relationships.wan.HostOn

Code Block

title	onap.node.wan.FC
collapse	true

onap.node.wan.FC:represents a forwarding capability that provides the opportunity to enable forwarding (of specific transport characteristic information at one or more protocol layers) between points.
        descriptionproperties:
 The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between two oraddress:
 more interfaces at a particular specific layerProtocol. 
        derived_fromtype: onap.node.ServiceComponent.wan
string
         properties: 
      description: ip, or mac, or geo topology:
address
        capabilities:
            - typedomain: string
                 constraints:type: tosca.capabilities.Attachment
			- node:
				type: tosca.capabilities.Node
         requirements:
            - valid_values: ['hub-spoke','fullmesh','p2p']higherLevelFd:
				node: onap.node.wan.Resource.Fd
    
            tenant:capabilities: tosca.capabilities.Attachment
                typerelationship: string
tosca.relationships.AttachesTo    
			-        creator:ltps:
				node: onap.node.wan.Resource.Ltp
                typecapabilities:  stringtosca.capabilities.Attachment
                description:relationship: tosca.relationships.AttachesTo

Code Block

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

onap.node.wan.Resource.Fc:creator 
        capabilitiesdescription:
 The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between two dependable:
or more interfaces at a particular specific layerProtocol. 
        typederived_from: onap.capabilitiesnode.wan.dependableResource
            virtual_linkable:
       properties: 
        capabilities:
			- node:
				type: tosca.capabilities.wan.VirtualLinkableNode
        requirements: 
            - endPoint:
                node: onap.node.wan.Resource.FCPortFcPort    
				capabilities: tosca.capabilities.network.Bindable
                capabilitiesrelationship: toscarelationships.capabilities.Endpoint
network.BindsTo 
            - fcRoute:
                node: onap.node.wan.Resource.FcRoute
				capabilities: tosca.capabilities.network.Bindable
     relationship: tosca.relationships.ConnectsTo
          relationship: relationships.network.BindsTo 
			- fcRoute:lowerLevelFc:
				node: onap.node.wan.Resource.Fc 
                capabilities: onaptosca.capabilities.wan.dependableNode
                relationship: onaptosca.relationships.wan.DependsOn

Code Block

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

onap.node.wan.Resource.FCPortFcPort:
        description: Fowarding Construct Point. The association of the FC to interfaces is made via FCPortsFcPorts. The FCPortFcPort class models the access to the FC function.  
        derived_from: onap.node.wan.Resource
        properties:
            interface:
    .Resource
            type: stringproperties:
            address:
                type: string
                description: ip, or mac    
            hub-spoke-roleFcPortDirection:
                type: string
			role:
				type: string
				constraints:
               description: role of the FC Point
                constraints:
    - valid_values: ['working','protection','protected','symmetric','hub', 'spoke', 'leaf', 'root']   
        capabilities:
        - valid_values: ['hub','spoke']requirements:
                required: false- fd:
				node: onap.node.wan.Resource.Ltp
        capabilities:
        capabilities:    endPoint:tosca.capabilities.Attachment
                typerelationship: tosca.capabilitiesrelationships.EndpointAttachesTo
        requirements:
    -        node:ltp:
				node: onap.node.wan.Resource.Ltp
                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: Cross Connection Point. Interfaces involved in exchange in a node The 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:
                type: string
    hub-spoke-role:
            description: Each LinkPort of type:the string
Link has a role (e.g., symmetric, hub, spoke, leaf, root) in the context of the Link description:with rolerespect ofto the FCLink Pointcapability. 
                constraints:
                    - valid_values: ['symmetric','hub', 'spoke']
  , 'leaf', 'root']   
        capabilities:
   required: false    requirements:
            interface- ltp:
                 type: stringnode: onap.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:
        requirementsdescription:
 The Logical Termination Point (LTP) class encapsulates the termination and adaptation node:
functions of one or more transport layers represented by instances of LayerProtocol.
     capabilities:    derived_from: onap.capabilitiesnode.wan.hostResource
        properties:
         relationship: onap.relationships.wan.HostOn

Code Block

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

onap.node.wan.Resource.XC:
  physicalPortReference:
            description: Cross Connection. The exchangetype: relationshipstring
 within a node describes how the interfaces within the node are linked.ltpDirection:
        derived_from: onap.node.wan.Resource
        propertiestype: string
        requirementscapabilities: 
            - endPortendPoint:
                nodetype: onaptosca.node.wan.Resource.XcPointcapabilities.Endpoint  
     
   requirements:
             capabilities: tosca.capabilities.Endpoint- fd:
				node: onap.node.wan.Resource.Fd
                relationshipcapabilities:  tosca.relationships.ConnectsTo   capabilities.Attachment
                descriptionrelationship: all endPorts can access each othertosca.relationships.AttachesTo  
            - neserverLtp:
                  node: onap.node.wan.Resource.Ltp
				capabilities:  onaptosca.capabilities.wan.hostNode
                relationship: onaptosca.relationships.wan.HostOn

Code Block

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

onap.node.wan.Resource.LinkConnection:
DependsOn  
            - descriptionlp:
  The exchange relationship between nodes, describing how the interfaces between nodes are linked. The link can depend on the FC of the service layer
node: onap.node.wan.Resource.LayerProtocol
                derived_fromcapabilities: onaptosca.nodecapabilities.wannetwork.ResourceBindable
        properties:
        relationship:  topologyrelationships.network.BindsTo

Code Block

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

onap.node.wan.Resource.LayerProtocol:
        description: The projection of an LTP into each type:transport string
layer is represented by a LayerProtocol (LP) instance. A LayerProtocol instance can be 
used for controlling constraints:
termination and monitoring functionality. 
        derived_from: onap.node.wan.Resource
       - valid_valuesproperties: ['hub-spoke','fullmesh','p2p']
        
        requirementslayerProtocolName: 
            - fc:
   type: string
            capabilities: onap.capabilities.wan.dependableaddress:
                relationshiptype: string

Code Block

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

onap.node.relationships.wan.Resource.DependsOnLink:
        description: The Link class -models endPoint:
effective adjacency between two or more ForwardingDomains (FD). 
        nodederived_from: onap.node.wan.Resource.XcPoint
        properties:
		capabilities:
			- node:
				type: tosca.capabilities.Node
        requirements: 
       capabilities: tosca.capabilities.Endpoint
    - fc:
           relationship: tosca.relationships.ConnectsTo

Code Block

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

node: onap.node.wan.Resource.FCRoute:
Fc
				capabilities: tosca.capabilities.Node
            description: The routing relationships within FC are described, including routing between sub FC (interdomain links), and links between network elements and network elements.
    relationship: tosca.relationships.DependsOn  
            - endPoint:
                derived_fromnode: onap.node.wan.Resource
   .LinkPort     properties:
        capabilities:
            dependable:capabilities: tosca.capabilities.Endpoint
                typerelationship: tosca.relationships.ConnectsTo

Code Block

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

onap.node.capabilities.wan.dependable        .Resource.FcRoute:
        requirementsdescription:
 The routing relationships within FC are described, including routing between sub -FC xc: 
        (interdomain links), and links between network elements and network elements.
        nodederived_from: onap.node.wan.Resource.XC
                capabilities: onap.capabilities.wan.partOfproperties:
        capabilities:   
     relationship: onap.relationships.wan.Contains  requirements:
            - lclink:
                node: onap.node.wan.Resource.LinkConnection
                Link
				capabilities: onaptosca.capabilities.wan.partOfNode
                relationship: onaptosca.relationships.wan.Contains  DependsOn
            - subFc:
                capabilitiesnode: onap.node.wan.Resource.Fc
				capabilities: tosca.wancapabilities.dependableNode
                relationship: onaptosca.relationships.wan.DependsOnDependsOn

R3 Class Explain

Wan Connection IM proposal

Space shortcuts

Page tree

Versions Compared

Old Version 19

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 19

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain