Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

WAN R2


Same with R1

Panel
titleNode Type
Code Block
titleorg.openecomp.resource.vl.overlaytunnel
collapsetrue
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
titleorg.openecomp.resource.vl.underlayvpn
collapsetrue
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
titledata typeNode Types:
Code Block
titleonap.datatypenode.wan.UserDefineResource
collapsetrue
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
titlecapability types:
Code Block
titleonap.capabilities.wan.host
collapsetrue
onap.capabilities.wan.host:
         derived_from: tosca.capabilities.Node  
Code Block
titleonap.capabilities.wan.partOf
collapsetrue
onap.capabilities.wan.partOf:
type: list
                entry_schema:
           derived_from: tosca.capabilities.Root         
Code Block
titleonap.capabilities.wan.dependable
collapsetrue
onap.capabilities.wan.dependable:type: string   
         derived_from: tosca.capabilities.Root  
Code Block
firstline1
titletosca.capabilities.wan.VirtualLinkable
linenumberstrue
collapsetrue
tosca.capabilities.wan.VirtualLinkable  type:
    derived_from: tosca.capabilities.Root
Panel
titlerelationship types:
Code Block
titleonap.relationships.wan.HostOn
collapsetrue
onap.relationships.wan.RelatedTo:
            descriptiontype: >-string
            The relationship specifies what Nodedescription: thecomponent Endpointtype
 is hosted on. 
        derived_fromparas: tosca.relationships.Root

           valid_target_types: [onap.capabilities.wan.host]     
Code Block
titleonap.relationships.wan.Contains
collapsetrue
onap.relationships.wan.Contains:type: org.openecomp.datatypes.Root
        descriptioncapabilities:
 >-
           - Thecomponent:
  relationship specifies what component is contained. 
        derived_fromtype: tosca.relationships.Root
capabilities.network.Bindable          
  valid_target_types: [onap.capabilities.wan.partOf]     
Code Block
titleonap.relationships.wan.DependsOn
collapsetrue
onap.relationships.wan.DependsOn:
requirements:
            - descriptionspecifications: >-
            The relationship specifies what is depended on.node: onap.node.wan.Resourece 
        derived_from: tosca.relationships.Root
        valid_target_types: [onap.capabilities.wan.dependable]capabilities: tosca.capabilities.network.Bindable
                relationship: relationships.network.BindsTo    
firstline
Code Block
1titletoscaonap.relationshipsnode.wan.VirtualLinksTolinenumberstrueResource.Connection
collapsetrue
toscaonap.relationshipsnode.wan.VirtualLinksToResource.Connection:
        derived_from: toscaonap.node.relationships.DependsOn
    valid_target_types: [ tosca.capabilities.wan.VirtualLinkable ]
Panel
titlenode types:
wan.Resource
        properties:
        capabilities:     
			- connection:
				type: tosca.capabilities.network.Linkable
        requirements:
            - fcs: 
                node: onap.node.wan.Resource.Fc 
                capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn  
			- links:
				node: onap.node.wan.Resource.Link
				capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn
			- fds:
				node: onap.node.wan.Resource.Fd
				capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn 
Code Block
titleonap.node.wan.ServiceComponentResource.wanFd
collapsetrue
onap.node.wan.ServiceComponentResource.wanFd:
        derived_from: onap.nodesnode.wan.ServiceComponentResource
        propertiesdescription:
 The Forwarding Domain (FD) class models the topological component that represents type:
a forwarding capability that provides the opportunity to enable forwarding (of specific transport characteristic information at type:one string
or more protocol layers) between   points.
         description: component typeproperties:
            parasaddress:
                type: liststring
                entry_schema:
description: ip, or mac, or geo address
        capabilities:
            - typedomain: onap.datatype.wan.UserDefine 
    
        capabilities:
    type: tosca.capabilities.Attachment
			- node:
				type: tosca.capabilities.Node
     component:
   requirements:
             type- higherLevelFd:
				node: onap.capabilitiesnode.wan.Resource.partOfFd
        requirements:
        capabilities: tosca.capabilities.Attachment
   -  configuration: 
          relationship: tosca.relationships.AttachesTo    
			- ltps:
				node: onap.node.ServiceComponent.wan wan.Resource.Ltp
                capabilities:  onaptosca.capabilities.wan.partOfAttachment
                relationship: onaptosca.relationships.wan.ContainsAttachesTo    
Code Block
titleonap.node.wan.Resource.Fc
collapsetrue
onap.node.wan.Resource:
        derived_from: tosca.nodes.Root
        properties.Resource.Fc:
        description: The ForwardingConstruct  uuid:
                type: string(FC) class models enabled constrained potential for forwarding between two or more interfaces at a particular specific layerProtocol. 
            name:derived_from: onap.node.wan.Resource
                typeproperties: string
            version:
 capabilities:
			- node:
				type: tosca.capabilities.Node
        requirements: 
      type: string
     - endPoint:
      description:
          node: onap.node.wan.Resource.FcPort     type: string
				capabilities: tosca.capabilities.network.Bindable
    
            typerelationship:
 relationships.network.BindsTo 
            -  typefcRoute: string
                descriptionnode: component type
       onap.node.wan.Resource.FcRoute
				capabilities: tosca.capabilities.network.Bindable
     paras:
           relationship: relationships.network.BindsTo 
			- lowerLevelFc:
				node:  type: listonap.node.wan.Resource.Fc 
                entry_schema:capabilities: tosca.capabilities.Node
                relationship:    tosca.relationships.DependsOn  

Code Block
titleonap.node.wan.Resource.FcPort
collapsetrue
onap.node.wan.Resource.FcPort:
        description: Fowarding Construct Point. The association of the FC to interfaces is made via FcPorts. The FcPort class models the access to the FC function.  
type: onap.datatype.wan.UserDefine   
        capabilities:
            component:
                typederived_from: onap.capabilitiesnode.wan.partOf            Resource
        requirementsproperties:
            - configurationaddress: 
                nodetype: onap.node.wan.Component string
                capabilitiesdescription: onap.capabilities.wan.partOf
     ip, or mac    
       relationship: onap.relationships.wan.Contains    
Code Block
titleonap.node.wan.Resource.Fd
collapsetrue
onap.node.wan.Resource.FdFcPortDirection:
        derived_from: onap.node.wan.Resource
        type:  description: The Forwarding Domain (FD) class models the 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.string
			role:
				type: string
				constraints:
                    - valid_values: ['working','protection','protected','symmetric','hub', 'spoke', 'leaf', 'root']   
        capabilities:
        propertiesrequirements:
              address: - fd:
				node: onap.node.wan.Resource.Ltp
                typecapabilities:  stringtosca.capabilities.Attachment
                descriptionrelationship: ip, or mac, or geo address
tosca.relationships.AttachesTo
            - capabilitiesltp:
				node: onap.node.wan.Resource.Ltp
               host capabilities: tosca.capabilities.Endpoint
                typerelationship: tosca.relationships.ConnectsTo
Code Block
titleonap.node.wan.Resource.LinkPort
collapsetrue
onap.capabilitiesnode.wan.Resource.hostLinkPort:
        requirements:
            higherLevelFd:
        description: The association of the Link to LTPs is made via LinkPort. The LinkPort class models the access to the Link function.  
        capabilitiesderived_from:  onap.capabilitiesnode.wan.hostResource
        properties:
        relationship: onap.relationships.wan.RelatedTo     
Code Block
titleonap.node.wan.Resource.Fc
collapsetrue
onap.node.wan.Resource.Fcrole:
        description: The ForwardingConstruct (FC) class models enabled constrained potentialtype: forstring
 forwarding between two or more interfaces at a particular specific layerProtocol. 
    description: Each LinkPort of derived_from: onap.node.wan.Resource
        properties: 
        capabilities:
    the Link has a role (e.g., symmetric, hub, spoke, leaf, root) in the context of the Link with respect to the Link capability. 
        dependable:
        constraints:
        type: onap.capabilities.wan.dependable
           - virtualvalid_linkablevalues:
     ['symmetric','hub', 'spoke', 'leaf', 'root']   
         type: tosca.capabilities.wan.VirtualLinkablecapabilities:
        requirements: 
            - endPointltp:
                node: onap.node.wan.Resource.FcPort    Ltp
                capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo tosca.relationships.ConnectsTo
onap..FcPort
Code Block
titleonap.node.wan.Resource.Ltp
collapsetrue
onap.node.wan.Resource.Ltp:
        description: The Logical  - fcRoute:
                capabilities: onap.capabilities.wan.dependableTermination Point (LTP) class encapsulates the termination and adaptation functions of one or more transport layers represented by instances of LayerProtocol.
                relationshipderived_from: onap.relationships.wan.DependsOn

Code Block
title
node.wan.Resource
collapsetrue
onap.node.wan.Resource.FcPort:

        properties:
         description   physicalPortReference:
 Fowarding    Construct Point. The association of the FC to interfaces is made via FcPorts. The FcPort class models the access to the FC function.  
type: string
            ltpDirection:
            derived_from: onap.node.wan.Resource    type: string
        propertiescapabilities:
            address- endPoint:
                type: string tosca.capabilities.Endpoint  
        requirements:
        description: ip, or mac  - fd:
				node: onap.node.wan.Resource.Fd
            FcPortDirection:
    capabilities:  tosca.capabilities.Attachment
          type: string
     relationship: tosca.relationships.AttachesTo  capabilities:
            - endPointserverLtp:
                 typenode: onap.node.wan.Resource.Ltp
				capabilities: tosca.capabilities.EndpointNode
        requirements:
          relationship: tosca.relationships.DependsOn  - fd:
               - capabilities:  onap.capabilities.wan.hostlp:
                relationshipnode: onap.relationshipsnode.wan.RelatedTo
            - ltp:Resource.LayerProtocol
                capabilities:  onaptosca.capabilities.wannetwork.hostBindable
                relationship: onap.relationships.wannetwork.RelatedToBindsTo 
Code Block
titleonap.node.wan.Resource.LtpLayerProtocol
collapsetrue
onap.node.wan.Resource.LtpLayerProtocol:
        description: The Logicalprojection Terminationof Pointan (LTP) class encapsulates the termination and adaptation functions of one or more transport layers represented by instances of LayerProtocol.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:
         physicalPortReference       type: string
            address:
                type: string
Link
Code Block
titleonap.node.wan.Resource.Link
collapsetrue
onap.node.wan.Resource.Link:
        description: The Link class models ltpDirection:
effective adjacency between two or more ForwardingDomains (FD). 
        typederived_from: stringonap.node.wan.Resource
        properties:
		capabilities:
            endPoint:
                			- node:
				type: tosca.capabilities.Endpoint
        requirements:
   Node
        requirements: fd:
            -    capabilities:  onap.capabilities.wan.hostfc:
                relationship: onap.relationships.wan.RelatedTo  
Code Block
title
node: onap.node.wan.Resource.
collapsetrue
onap.node.wan.Resource.Link:
 Fc
				capabilities: tosca.capabilities.Node
       description: The Link class models effective adjacency between two or more ForwardingDomains (FD). 
        derived_fromrelationship: onaptosca.node.wan.Resource
relationships.DependsOn  
         properties   - endPoint:
        requirements: 
         node: onap.node.wan.Resource.LinkPort   - fc:
                capabilities: onaptosca.capabilities.wan.dependableEndpoint
                relationship: onaptosca.relationships.wan.DependsOn  ConnectsTo
Code Block
titleonap.node.wan.Resource.FcRoute
collapsetrue
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:.Resource
        properties:
        type: onap.capabilities.wan.dependable     capabilities:   
        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 Connection IM proposal