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.capability.wan.host
collapse	true

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

Code Block

title	onap.capability.wan.component
collapse	true

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

Code Block

title	onap.capability.wan.dependable
collapse	true

onap.capability.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:
        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

Code Block

title	onap.relationship.wan.HostOn
collapse	true

onap.relationship.wan.HostOn:
        descriptiontype: >-
integer
        description: ac2 svlan
        required: Thefalse relationship specifies what Node
 the Endpoint is hosted on. ac2_ip:
        derived_fromtype: tosca.relationships.Root
string
        description: ip of ac2,  valid_target_types: [onap.capability.wan.host]

Code Block

title	onap.relationship.wan.Contains
collapse	true

onap.relationship.wan.Contains:only for layer3 vpn, it should contain mask
        descriptionrequired: >-
false    
      ac2_peer_ip:
  The relationship specifies what component is contained.type: string
        derived_from: tosca.relationships.Root
        valid_target_types: [onap.capability.wan.component]

Code Block

title	onap.relationship.wan.DependsOn
collapse	true

onap.relationship.wan.DependsOn: description: ip of ac2 peer CE tp, only for layer3 vpn, it should contain mask
        descriptionrequired: >-
false    
      ac2_route:
  The relationship specifies what is depended on.type: string
        derived_fromdescription: tosca.relationships.Root
        valid_target_types: [onap.capability.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:route configure of ac2, only for layer3 vpn
        required: false    
      ac2_protocol:
        type: string
        derived_fromdescription: tosca.nodes.Root
        properties:
 routing protocol type of ac2, only for layer3 vpn   
        uuidconstraints:
          -   valid_values: ['STATIC','OSPF','ISIS','BGP','other']   type: string
    
        namedefault:
 'STATIC'    
           typerequired: string
false    
        versionac2_protocol_bgp_as:
                type: string
        description: autonomous-system number of description:
ac2, , only required for ebgp protocol        
  type: string    
 required: false    
      af_type:
                type: string
                description: componentaddress family type
        default: 'ipv4'
   paras:
     required: false
    requirements:
    -  typevirtualLink: list
        capability: tosca.capabilities.network.Linkable
       entry_schema: relationship: tosca.relationships.network.LinksTo
    capabilities:
      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:onap.datatype.wan.UserDefine   
            deploy-mode:derived_from: tosca.nodes.Root
                type: stringproperties:
            uuid:
    description: all-in-one means SO will send FC and all component related in one request to SDN-C, step-by-step means SO will send each component in a single request.type: string
            name:
                constraintstype: string
            version:
        - valid_values: ['all-in-one','step-by-step']       type: string
            deploy-order?label:
                type: integerlist
                description: effective while deploy-mode equals 'step-by-step', smaller number first
entry_schema:
                    capabilitiestype: string   
            componenttype:
                type: onap.capability.wan.componentstring
            
    description: component   requirements:type
            - configurationparas: 
                nodetype: onaporg.nodeopenecomp.wan.Component 
datatypes.Root
        capabilities:
            capability: onap.capability.wan.component- component:
                relationshiptype: onaptosca.relationshipcapabilities.wan.Containsnetwork.Bindable

Code Block

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

onap.node.wan.Component.Node:
        derived_fromrequirements: onap.node.wan.Component

           description: Node- resource,specifications: it
 could be site or ne or anything else which can be a host for endPoint
 node: onap.node.wan.Resourece 
     properties:
            address:capabilities: tosca.capabilities.network.Bindable
                type: stringrelationship: 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:
            - hostfcs: 
                typenode: onap.capabilitynode.wan.hostResource.Fc 
        requirements:
        capabilities: tosca.capabilities.Node
    parentNode:
            relationship: tosca.relationships.DependsOn  
			- links:
				node: onap.node.wan.Component.Resource.Link
				capabilities: tosca.capabilities.Node
                capabilityrelationship: tosca.relationships.DependsOn
			- fds:
				node: onap.capability.wan.host.node.wan.Resource.Fd
				capabilities: tosca.capabilities.Node
                relationship: onaptosca.relationship.wan.HostOn     relationships.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.capabilitynode.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.nodecapabilities.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: 
           capabilitycapabilities:
			- node:
				type: tosca.capabilities.EndpointNode
                relationship: tosca.relationships.ConnectsTorequirements: 
            - subFcendPoint:
                node: onap.node.wan.Component.FCResource.FcPort    
				capabilities: tosca.capabilities.network.Bindable
                capabilityrelationship: onaprelationships.capability.wan.dependablenetwork.BindsTo 
            - fcRoute:
                relationshipnode: onap.relationshipnode.wan.DependsOn
       Resource.FcRoute
				capabilities: tosca.capabilities.network.Bindable
     - fcRoute:
          relationship: relationships.network.BindsTo     
			- lowerLevelFc:
				node: onap.node.wan.ComponentResource.FCRouteFc 
                capabilitycapabilities: onaptosca.capabilitycapabilities.wan.dependableNode
                relationship: onaptosca.relationshiprelationships.wan.DependsOn

Code Block

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

onap.node.wan.ComponentResource.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.ComponentResource
        properties:
            interfaceaddress:
                type: string
               address:
 description: ip, or mac    
            typeFcPortDirection: string
                descriptiontype: ip, or mac    
 string
			role:
				type: string
				constraints:
           hub-spoke-role:
         - valid_values: ['working','protection','protected','symmetric','hub', 'spoke', 'leaf', 'root']  type: string
        capabilities:
        description: role of the FC Pointrequirements:
            -    constraintsfd:
				node: onap.node.wan.Resource.Ltp
                   - valid_values: ['hub','spoke']capabilities:  tosca.capabilities.Attachment
                required: false
        capabilities:relationship: tosca.relationships.AttachesTo
            endPoint- ltp:
				node: onap.node.wan.Resource.Ltp
               type capabilities: tosca.capabilities.Endpoint
          requirements:
      relationship: tosca.relationships.ConnectsTo

Code Block

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

onap.node.wan.Resource.LinkPort:
      node:
  description: The association of the Link to LTPs is made via LinkPort. The LinkPort node: onap.node.wan.Component.Node
        class models the access to the Link function.  
        capabilityderived_from:  onap.capabilitynode.wan.hostResource
        properties:
           relationship: onap.relationship.wan.HostOn

Code Block

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

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

Code Block

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

onap.node.wan.Resource.Ltp:
        capabilitiesdescription:
 The Logical Termination Point (LTP) class encapsulates the termination and  endPoint:
        adaptation functions of one or more transport layers represented by instances of LayerProtocol.
        typederived_from: toscaonap.node.capabilitieswan.EndpointResource
        requirementsproperties:
            nodephysicalPortReference:
                nodetype: onap.node.wan.Component.Nodestring
                capability:  onap.capability.wan.host
 ltpDirection:
               relationship: onap.relationship.wan.HostOn

Code Block

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

onap.node.wan.Component.XC: type: string
        descriptioncapabilities:
 Exchange Connection. The exchange relationship within a node describes how the interfaces within the node are linked.
           - endPoint:
                derived_fromtype: onaptosca.node.wan.Componentcapabilities.Endpoint  
        propertiesrequirements:
             requirements: 
- fd:
				node: onap.node.wan.Resource.Fd
               - endPort:capabilities:  tosca.capabilities.Attachment
                noderelationship: onaptosca.node.wan.Component.XcPoint  relationships.AttachesTo  
            -    capabilityserverLtp:
 tosca.capabilities.Endpoint
                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
                capabilitycapabilities:  onaptosca.capabilitycapabilities.wannetwork.hostBindable
                relationship: onaprelationships.relationship.wan.HostOnnetwork.BindsTo

Code Block

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

onap.node.wan.ComponentResource.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
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.Component
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
                capability: onap.capability.wan.dependableFc
				capabilities: tosca.capabilities.Node
                relationship: onaptosca.relationshiprelationships.wan.DependsOn  
            - endPoint:
                node: onap.node.wan.ComponentResource.XcPointLinkPort    
                capabilitycapabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo

Code Block

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

onap.node.wan.ComponentResource.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.ComponentResource
        properties:
        capabilities:
            dependable:
                type: onap.capability.wan.dependable        
        requirements:
            - xclink: 
                node: onap.node.wan.ComponentResource.XC
                capability: onap.capability.wan.componentLink
				capabilities: tosca.capabilities.Node
                relationship: onaptosca.relationship.wan.Contains  relationships.DependsOn
            - lcsubFc:
                node: onap.node.wan.ComponentResource.LinkConnection
                capability: onap.capability.wan.componentFc
				capabilities: tosca.capabilities.Node
                relationship: onaptosca.relationship.wan.Contains  relationships.DependsOn

R3 Class Explain

Wan Connection IM proposal

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 8

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain