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
     value version:
        type: string
        typerequired: stringfalse
      name:
          requiredtype: false

Panel

title	capability types:

Code Block

title	onap.capability.wan.host
collapse	true

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

Code Block

title	onap.capability.wan.component
collapse	true

onap.capability.wan.component:
 tunnel name used by for reference by the administrator.
        required: false
      description:
        derived_from: tosca.capabilities.Roottype: string

Code Block

title	onap.capability.wan.dependable
collapse	true

onap.capability.wan.dependable:
 description: Additional comments/information about overlay tunnel.
        required: false
      tunnelType:
        derived_from: tosca.capabilities.Root

Panel

title	relationship types:

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

Code Block

title	onap.relationship.wan.HostOn
collapse	true

onap.relationship.wan.HostOn:
        descriptionrequired: >- false    
      ac2_route:
      The relationship specifiestype: whatstring
 Node the Endpoint is hosted on. 
 description: route configure of ac2, only for derived_from: tosca.relationships.Rootlayer3 vpn
        valid_target_typesrequired: [onap.capability.wan.host]false

Code Block

title	onap.relationship.wan.Contains
collapse	true

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

Code Block

title	onap.relationship.wan.DependsOn
collapse	true

onap.relationship.wan.DependsOntype: string
        description: routing protocol type of ac2, only for layer3 vpn   
        constraints:
        description:  >-
    valid_values: ['STATIC','OSPF','ISIS','BGP','other']        The
 relationship specifies what is depended on. 
 default: 'STATIC'      derived_from: tosca.relationships.Root
        valid_target_typesrequired: [onap.capability.wan.dependable]false

Panel

title	node types?

Code Block

title	onap.node.wan.Component
collapse	true

onap.node.wan.Component:
        derived_from: tosca.nodes.Rootac2_protocol_bgp_as:
        propertiestype: string
        description: autonomous-system number of uuid:
ac2, , only required for ebgp protocol        
  type: string
     required:   false    name:
      af_type:
          type: string
        description: address family type
 version:
       default: 'ipv4'
        typerequired: stringfalse
    requirements:
       - descriptionvirtualLink:
        capability: tosca.capabilities.network.Linkable
       type relationship: stringtosca.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:

                typederived_from: stringtosca.nodes.Root
                description: component typeproperties:
            parasuuid:
                type: liststring
                entry_schemaname:
                    type: onap.datatype.wan.UserDefine   string
            deploy-modeversion:
                type: string
                description: all-in-one means SO will send FC and all componentlabel:
 related in one request to SDN-C, step-by-step means SO will send each component in a singletype: request.list
                constraintsentry_schema:
                    type: string   
  - valid_values: ['all-in-one','step-by-step']        type:
                 deploy-order?type: string
                typedescription: integer
component type
            paras:
       description:   effective while deploy-mode equals 'step-by-step', smaller number firsttype: org.openecomp.datatypes.Root
        capabilities:
            - component:
                type: onaptosca.capabilitycapabilities.wannetwork.component  Bindable          
        requirements:
            - configurationspecifications: 
                node: onap.node.wan.ComponentResourece 
                capabilitycapabilities: onaptosca.capabilitycapabilities.wannetwork.componentBindable
                relationship: onaprelationships.relationship.wannetwork.ContainsBindsTo

Code Block

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

onap.node.wan.ComponentResource.NodeConnection:
        derived_from: onap.node.wan.ComponentResource
        descriptionproperties: Node resource, it could be site or ne or anything else which can be a host for endPoint
  
        capabilities:     
			- connection:
				type: tosca.capabilities.network.Linkable
        requirements:
            - fcs: 
      properties:
          node:  address:onap.node.wan.Resource.Fc 
                typecapabilities: string
tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn   description: ip, or mac, or geo address

			- links:
				node: onap.node.wan.Resource.Link
				capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn
			-  vendor:
fds:
				node: onap.node.wan.Resource.Fd
				capabilities: tosca.capabilities.Node
                relationship: tosca.relationships.DependsOn

Code Block

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

onap.node.wan.Resource.Fd:  type: string
        capabilities:derived_from: onap.node.wan.Resource
            hostdescription: 
The Forwarding Domain (FD) class models the topological component that represents a     type: onap.capability.wan.host
        requirements:
            parentNode:
        forwarding capability that provides the opportunity to enable forwarding (of specific transport characteristic information at one or more protocol layers) between points.
        node: onap.node.wan.Component.Nodeproperties:
                capability:  onap.capability.wan.hostaddress:
                relationship: onap.relationship.wan.HostOn

Code Block

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

onap.node.wan.Component.FC:
type: string
         description: The ForwardingConstruct (FC) class models enabled constraineddescription: potentialip, foror forwardingmac, betweenor twogeo oraddress
 more interfaces at a particular specific layerProtocol. capabilities:
        derived_from: onap.node.wan.Component    - domain: 
        properties:
        type:    topology:tosca.capabilities.Attachment
			- node:
				type: tosca.capabilities.Node
                type: stringrequirements:
            -    constraintshigherLevelFd:
				node: onap.node.wan.Resource.Fd
                   - valid_values: ['hub-spoke','fullmesh','p2p']capabilities: tosca.capabilities.Attachment
    
            tenantrelationship:
    tosca.relationships.AttachesTo    
			- ltps:
				node: onap.node.wan.Resource.Ltp
       type: string
        capabilities:    creator:tosca.capabilities.Attachment
                typerelationship: tosca.relationships.AttachesTo string

Code Block

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

onap.node.wan.Resource.Fc:
          description: The creatorForwardingConstruct 
(FC) class models enabled constrained potential for forwarding capabilities:
between two or more interfaces at a particular specific  layerProtocol.  dependable:
                typederived_from: onap.capabilitynode.wan.dependableResource
            virtual_linkable:properties: 
                capabilities:
			- node:
				type: tosca.capabilities.nfv.VirtualLinkableNode
        requirements: 
            - endPoint:
                node: onap.node.wan.ComponentResource.FCPointFcPort    
                capability				capabilities: tosca.capabilities.network.EndpointBindable
                relationship: tosca.relationships.ConnectsTo
            - subFc:
                node: onap.node.wan.Component.FCrelationships.network.BindsTo 
            -    capability: onap.capability.wan.dependablefcRoute:
                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: onap.capabilitytosca.wancapabilities.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 FCPoints. The FCPoint class models the access to the FC function.  
        derived_from: onap.node.wan.Component
        properties:
            interface:FcPorts. The FcPort class models the access to the FC function.  
        derived_from: onap.node.wan.Resource
        typeproperties: string
            address:
                type: string
                description: ip, or mac    
            hub-spoke-roleFcPortDirection:
                type: string
                description: role of the FC Point
                			role:
				type: string
				constraints:
                    - valid_values: ['working','protection','protected','symmetric','hub', 'spoke', 'leaf', 'root']   
        capabilities:
        requiredrequirements: false

             capabilities:
- fd:
				node: onap.node.wan.Resource.Ltp
                endPoint:capabilities:  tosca.capabilities.Attachment
                typerelationship: tosca.capabilitiesrelationships.EndpointAttachesTo
         requirements:   - ltp:
				node: onap.node.wan.Resource.Ltp
            node:    capabilities: tosca.capabilities.Endpoint
                noderelationship: tosca.relationships.ConnectsTo

Component.XCPoint

Code Block

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

onap.node.wan.ComponentResource.NodeLinkPort:
        description: The association of the Link to LTPs capability:is made via onap.capability.wan.host
         LinkPort. The LinkPort class models the access to the Link function.  
       relationship derived_from: onap.relationship.wan.HostOn

Code Block

title

onap.node.wan.

collapse

true

onap.node.wan.Component.XCPointResource
        properties:
        description: Exchange Connection Point. Interfaces involved in exchange in a node
    role:
                type: string
            derived_from: onap.node.wan.Component
        properties:
            hub-spoke-role:    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
                relationship: tosca.relationships.ConnectsTo

Code Block

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

onap.node.wan.Resource.Ltp:
        description: The Logical Termination Point (LTP) class encapsulates the termination and adaptation functions of one or more transport layers represented by instances of LayerProtocol.
type: string
            peerId
                typederived_from: stringonap.node.wan.Resource
        capabilitiesproperties:
            endPointphysicalPortReference:
                type: tosca.capabilities.Endpoint
        requirements:string
            nodeltpDirection:
                nodetype: onap.node.wan.Component.Node
        string
        capabilitycapabilities:
  onap.capability.wan.host
          - endPoint:
     relationship: onap.relationship.wan.HostOn

Code Block

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

onap.node.wan.Component.XC:
        descriptiontype: Exchange Connection. The exchange relationship within a node describes how the interfaces within the node are linked.
tosca.capabilities.Endpoint  
        requirements:
             derived_from- fd:
				node: onap.node.wan.Resource.ComponentFd
        properties:
        requirementscapabilities:  tosca.capabilities.Attachment
            - endPort:
   relationship: tosca.relationships.AttachesTo  
          node: onap.node.wan.Component.XcPoint   - serverLtp:
                capabilitynode: tosca.capabilities.Endpoint
                relationshiponap.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.LinkConnectionLayerProtocol:
        description: The exchange relationship between nodes, describing how the interfaces between nodes are linked. The link can depend on the FC of the service layer projection of an LTP into each transport layer is represented by a LayerProtocol (LP) instance. A LayerProtocol instance can be 
used for controlling termination and monitoring functionality. 
        derived_from: onap.node.wan.ComponentResource
        properties:
           topology layerProtocolName:
                type: string
            address: string

                type: string

Code Block

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

onap.node.wan.Resource.Link:
        constraintsdescription:
 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    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 4

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

WAN R2

WAN R3+

R3 Class Explain