...

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:

Panel

title	node types:

Code Block

title	onap.capabilities.wan.host
collapse	true

onap.capabilities.wan.host:         type: list
         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.RelatedTo:
        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 ]

Code Block

title	onap.node.ServiceComponent.wan
collapse	true

onap.node.ServiceComponent.wan:
        derived_from: onap.nodes.ServiceComponent    entry_schema:
        properties:
            type:
 string   
            type: string
                descriptiontype: component typestring
            paras:
    description:            type: listcomponent type
                entry_schemaparas:
                    type: onaporg.datatypeopenecomp.wan.UserDefine   datatypes.Root
        capabilities:
            - component:
                type: onaptosca.capabilities.wan.partOfnetwork.Bindable          
        requirements:
            - configurationspecifications: 
                node: onap.node.ServiceComponentwan.wanResourece 
                capabilities: onaptosca.capabilities.wannetwork.partOfBindable
                relationship: onap.relationships.wannetwork.ContainsBindsTo

Code Block

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

onap.node.wan.Resource.Connection:
        derived_from: toscaonap.node.nodeswan.RootResource
        properties:
        capabilities:     uuid
			- connection:
				type: tosca.capabilities.network.Linkable
        requirements:
          type  - fcs: string
                name:
node: onap.node.wan.Resource.Fc 
                capabilities: tosca.capabilities.Node
        type: string
       relationship: tosca.relationships.DependsOn  
			-  version:links:
				node: onap.node.wan.Resource.Link
				capabilities: tosca.capabilities.Node
                typerelationship: string
            description: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.node.wan.Resource.Fd:string    
        derived_from: onap.node.wan.Resource
   type:
     description: The Forwarding Domain (FD) class models the topological component that type:represents string
a forwarding capability that provides the opportunity to enable forwarding (of specific transport characteristic information at description:one componentor type
more protocol layers) between points.
        parasproperties:
                type: listaddress:
                entry_schematype: string
                description: ip, or mac, type: onap.datatype.wan.UserDefine   or geo address
        capabilities:
            component- domain: 
                type: onaptosca.capabilities.wan.partOf            Attachment
			- node:
				type: tosca.capabilities.Node
        requirements:
            - configurationhigherLevelFd: 
                
				node: onap.node.wan.Component Resource.Fd
                capabilities: onaptosca.capabilities.wan.partOfAttachment
                relationship: onap.relationships.wan.Contains

Code Block

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

onap.node.wan.Resource.Fd:
     relationship: tosca.relationships.AttachesTo     derived_from
			- ltps:
				node: onap.node.wan.Resource.Ltp
        description:  The Forwarding Domain (FD) class models thecapabilities:  tosca.capabilities.Attachment
                relationship: tosca.relationships.AttachesTo

Code Block

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

onap.node.wan.Resource.Fc:topological component that represents a forwarding capability that provides the opportunity to enable forwarding (of specific transport characteristic information at one or more protocol layers) between points.
        propertiesdescription:
 The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between address:
two or more interfaces at a particular specific layerProtocol. 
        typederived_from: stringonap.node.wan.Resource
        properties: 
       description: ip, or mac, or geo address capabilities:
			- node:
				type: tosca.capabilities.Node
        capabilitiesrequirements: 
            - hostendPoint: 
                typenode: onap.node.wan.Resource.FcPort    
				capabilities.wan.host: tosca.capabilities.network.Bindable
        requirements:        relationship: relationships.network.BindsTo 
            higherLevelFd- fcRoute:
                node: onap.node.wan.Resource.FcRoute
				capabilities:  onaptosca.capabilities.wannetwork.hostBindable
                relationship: onap.relationships.wannetwork.RelatedTo

Code Block

title

BindsTo 
			- lowerLevelFc:
				node: onap.node.wan.Resource.Fc

collapse

true

onap.node.wan.Resource.Fc: 
        description: The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between two or more interfaces at a particular specific layerProtocol. 
capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn

Code Block

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

   derived_from: onap.node.wan.Resource.FcPort:
        propertiesdescription: 
Fowarding Construct Point. The association of the FC capabilities:
to interfaces is made via FcPorts. The FcPort class models the access dependable:
to the FC function.  
           typederived_from: onap.capabilitiesnode.wan.dependableResource
        properties:
    virtual_linkable:
         address:
       type: tosca.capabilities.wan.VirtualLinkable
        requirementstype: string
            -  endPoint:
  description: ip, or mac    
       node: onap.node.wan.Resource.FcPort    FcPortDirection:
                 capabilities: tosca.capabilities.Endpointtype: string
			role:
				type: string
				constraints:
                relationship: tosca.relationships.ConnectsTo
   - valid_values: ['working','protection','protected','symmetric','hub', 'spoke',     'leaf', 'root']  - fcRoute:
        capabilities:
        capabilities: onap.capabilities.wan.dependablerequirements:
            -    relationship: onap.relationships.wan.DependsOn

Code Block

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

fd:
				node: onap.node.wan.Resource.FcPort:
Ltp
                descriptioncapabilities: Fowarding Construct Pointtosca.capabilities.Attachment
 The association of the FC to interfaces is made via FcPorts. The FcPort class models the access to the FC function.  
relationship: tosca.relationships.AttachesTo
             derived_from- ltp:
				node: onap.node.wan.Resource.Ltp
        properties:
            address:capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo

Code Block

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

onap.node.wan.Resource.LinkPort:
type: string
                description: ip,The orassociation macof the Link to 
LTPs is made via LinkPort. The LinkPort class models the access to FcPortDirection:
the Link function.  
            type: stringderived_from: onap.node.wan.Resource
        capabilities:
            endPoint:
                type: tosca.capabilities.Endpoint
properties:
            requirementsrole:
               - fdtype: string
                capabilities:  onap.capabilities.wan.host
                relationship: onap.relationships.wan.RelatedTo
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. 
               - ltpconstraints:
                   capabilities:  onap.capabilities.wan.host
       - valid_values: ['symmetric','hub', 'spoke', 'leaf', 'root']   
         relationship: onap.relationships.wan.RelatedTo

Code Block

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

onap.node.wan.Resource.LinkPort:capabilities:
        description: The association of the Link to LTPs is made via LinkPort. The LinkPort class models the access to the Link function.  
requirements:
            - ltp:
                derived_fromnode: onap.node.wan.Resource.Ltp
               properties:
 capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo

Code Block

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

onap.node.wan.Resource.Ltp role:
        description: The Logical Termination Point (LTP) class encapsulates the type:termination string
and adaptation functions of one or more transport layers represented by instances of LayerProtocol.
   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. derived_from: onap.node.wan.Resource
        properties:
            physicalPortReference:
                constraintstype: string
            ltpDirection:
         - valid_values: ['symmetric','hub', 'spoke', 'leaf', 'root']  type: string
        capabilities:
            - endPoint:
                type: tosca.capabilities.Endpoint  
        requirements:
            - ltpfd:
				node: onap.node.wan.Resource.Fd
                capabilities:  onaptosca.capabilities.wan.hostAttachment
                relationship: onap.relationships.wan.RelatedTo

Code Block

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

onap.node.wan.Resource.Ltp:
tosca.relationships.AttachesTo  
            - serverLtp:
            description: The Logical Termination Point (LTP) class encapsulates the termination and adaptation functions of one or more transport layers represented by instances of LayerProtocol.node: onap.node.wan.Resource.Ltp
				capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn  
        derived_from: onap.node.wan.Resource
   - lp:
    properties:
            physicalPortReference:node: onap.node.wan.Resource.LayerProtocol
                typecapabilities: stringtosca.capabilities.network.Bindable
            ltpDirection:
    relationship: relationships.network.BindsTo

Code Block

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

onap.node.wan.Resource.LayerProtocol:
        description: The type:projection string
of an LTP into each transport layer is capabilities:
represented by a LayerProtocol (LP) instance. A LayerProtocol instance can be  endPoint:
used for controlling termination and monitoring functionality. 
         typederived_from: toscaonap.node.capabilitieswan.EndpointResource
        requirementsproperties:
            fdlayerProtocolName:
                capabilitiestype:  onap.capabilities.wan.host string
            address:
                relationshiptype: onap.relationships.wan.RelatedTo  string

Code Block

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

onap.node.wan.Resource.Link:
        description: The Link class models effective adjacency between two or more ForwardingDomains (FD). 
        derived_from: onap.node.wan.Resource
        properties:from: onap.node.wan.Resource
        properties:
		capabilities:
			- node:
				type: tosca.capabilities.Node
        requirements: 
            - fc:
                capabilitiesnode: onap.node.wan.Resource.Fc
				capabilities: tosca.wancapabilities.dependableNode
                relationship: onaptosca.relationships.wan.DependsOn  
            - endPoint:
                node: onap.node.wan.Resource.LinkPort    
                capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo

Code Block

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

onap.node.wan.Resource.FcRoute:
        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:derived_from: onap.node.wan.Resource
        properties:
        typecapabilities: onap.capabilities.wan.dependable        
        requirements:
            - link:
                node: onap.node.wan.Resource.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.DependsOn

R3 Class Explain

Wan Descriptor Connection IM proposal

Space shortcuts

Page tree

Versions Compared

Old Version 25

New Version Current

Key

WAN R3+

R3 Class Explain

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 25

New Version Current

Key

WAN R3+

R3 Class Explain