ETSI ES 201 915-10 V1.4.1 (2003-07)

Open Service Access (OSA); Application Programming Interface (API); Part 10: Connectivity Manager SCF (Parlay 3)

RES/SPAN-120095-10

Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 10. del: Upravljalnik povezljivosti SCF

General Information

• Status: Published
• Publication Date: 28-Jul-2003
• Technical Committee: SPAN 12 - Applications Interfaces for Service Providers and Network Operators
• Current Stage: 12 - Completion
• Due Date: 08-Aug-2003
• Completion Date: 29-Jul-2003
• Ref Project: SIST ES 201 915-10 V1.4.1:2005 - Open Service Access (OSA); Application Programming Interface (API); Part 10: Connectivity Manager SCF

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ES 201 915-10 V1.4.1:2005
01-januar-2005
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) –
10. del: Upravljalnik povezljivosti SCF
Open Service Access (OSA); Application Programming Interface (API); Part 10:
Connectivity Manager SCF
Ta slovenski standard je istoveten z: ES 201 915-10 Version 1.4.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
SIST ES 201 915-10 V1.4.1:2005 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

---------------------- Page: 1 ----------------------

SIST ES 201 915-10 V1.4.1:2005

---------------------- Page: 2 ----------------------

SIST ES 201 915-10 V1.4.1:2005

ETSI ES 201 915-10 V1.4.1 (2003-07)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 10: Connectivity Manager SCF
(Parlay 3)



�

---------------------- Page: 3 ----------------------

SIST ES 201 915-10 V1.4.1:2005
 2 ETSI ES 201 915-10 V1.4.1 (2003-07)



Reference
RES/SPAN-120095-10
Keywords
API, OSA, IDL, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, send your comment to:
[e-mail]
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2003.
© The Parlay Group 2003.
All rights reserved.

TM TM TM
DECT , PLUGTESTS and UMTS are Trade Marks of ETSI registered for the benefit of its Members.
TM
TIPHON and the TIPHON logo are Trade Marks currently being registered by ETSI for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI

---------------------- Page: 4 ----------------------

SIST ES 201 915-10 V1.4.1:2005
 3 ETSI ES 201 915-10 V1.4.1 (2003-07)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
3 Definitions and abbreviations.6
3.1 Definitions.6
3.2 Abbreviations.7
4 Connectivity Manager SCF.8
5 Sequence Diagrams.11
5.1 Operator Selects Service Components and creates a new VPrP.11
5.2 Operator Browses Virtual Provisioned Pipe.12
5.3 Operator Browses SAPs and Sites.13
6 Class Diagrams.14
7 The Service Interface Specifications.20
7.1 Interface Specification Format .20
7.1.1 Interface Class.20
7.1.2 Method descriptions.20
7.1.3 Parameter descriptions.21
7.1.4 State Model.21
7.2 Base Interface.21
7.2.1 Interface Class IpInterface .21
7.3 Service Interfaces.21
7.3.1 Overview.21
7.4 Generic Service Interface .21
7.4.1 Interface Class IpService .21
8 Connectivity Manager Interface Classes.22
8.1 Interface Class IpConnectivityManager .22
8.2 Interface Class IpEnterpriseNetwork.24
8.3 Interface Class IpEnterpriseNetworkSite .26
8.4 Interface Class IpQoSMenu .28
8.5 Interface Class IpQoSTemplate.30
8.6 Interface Class IpVPrN .35
8.7 Interface Class IpVPrP .38
9 State Transition Diagrams.42
10 Data Definitions.42
10.1 Connectivity Manager Data Types.43
10.1.1 TpStringList.43
10.1.2 TpIPSubnet.43
10.1.3 TpIPv4AddType.43
10.1.4 TpIPVersion.43
10.1.5 TpVprpStatus.44
10.1.6 TpDsCodepoint.44
10.1.7 TpProvisionedQoSInfo.44
10.1.8 TpDelayDescriptor.44
10.1.9 TpLossDescriptor.45
10.1.10 TpJitterDescriptor.45
10.1.11 TpNameDescrpTagInt.45
10.1.12 TpNameDescrpTagString.45
10.1.13 TpTagValue.46
10.1.14 TpNameDescrpTagExcessLoadAction.46
ETSI

---------------------- Page: 5 ----------------------

SIST ES 201 915-10 V1.4.1:2005
 4 ETSI ES 201 915-10 V1.4.1 (2003-07)
10.1.15 TpAction.46
10.1.16 TpPipeQoSInfo.46
10.1.17 TpNameDescrpTagDir.47
10.1.18 TpTrafficDirection.47
10.1.19 TpEndpoint.47
10.1.20 TpSiteOrSap.47
10.1.21 TpLoadDescriptor.47
10.1.22 TpValidityInfo.48
10.1.23 TpNameDescrpTagDateTime.48
10.1.24 TpNameDescrpTagTimePeriod.48
10.1.25 TpNameDescrpTagTimeOfDay.48
10.1.26 TpNameDescrpTagDayOfWeek.49
10.1.27 TpNameDescrpTagMonth.49
11 Exception Classes.51
Annex A (normative): OMG IDL Description of Connectivity Manager SCF.52
Annex B (informative): Record of changes .53
B.1 Interfaces.53
B.1.1 New.53
B.1.2 Deprecated.53
B.1.3 Removed.53
B.2 Methods.53
B.2.1 New.53
B.2.2 Deprecated.53
B.2.3 Modified.54
B.2.4 Removed.54
B.3 Data Definitions.54
B.3.1 New.54
B.3.2 Modified.54
B.3.3 Removed.54
B.4 Service Properties.54
B.4.1 New.54
B.4.2 Deprecated.55
B.4.3 Modified.55
B.4.4 Removed.55
B.5 Exceptions.55
B.5.1 New.55
B.5.2 Modified.55
B.5.3 Removed.55
B.6 Others.55
History .56

ETSI

---------------------- Page: 6 ----------------------

SIST ES 201 915-10 V1.4.1:2005
 5 ETSI ES 201 915-10 V1.4.1 (2003-07)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Services and Protocols for Advanced
Networks (SPAN).
The present document is part 10 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 201 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control SCF";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 3.3 set of specifications.
ETSI

---------------------- Page: 7 ----------------------

SIST ES 201 915-10 V1.4.1:2005
 6 ETSI ES 201 915-10 V1.4.1 (2003-07)
1 Scope
The present document is part 10 of the Stage 3 specification for an Application Programming Interface (API) for Open
Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardised interface, i.e. the OSA APIs.
The present document specifies the Connectivity Manager Service Capability Feature (SCF) aspects of the interface. All
aspects of the Connectivity Manager SCF are defined here, these being:
• Sequence Diagrams
• Class Diagrams
• Interface specification plus detailed method descriptions
• State Transition diagrams
• Data Definitions
• IDL Description of the interfaces
The process by which this task is accomplished is through the use of object modelling techniques described by the
Unified Modelling Language (UML).
2 References
The references listed in clause 2 of ES 201 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 201 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 201 915-1 and the following apply:
best effort traffic: traffic that is not carried by a VPrN established for the enterprise network by the provider
differentiated services: effort in the Internet Engineering Task Force (IETF) to provide quality of service in networks
employing small well defined building blocks from which variety of service may be built
DS Codepoint: marking associated with a specific VPrP
enterprise operator: administrator of the enterprise network/user of APIs also referred to as operator
operator: enterprise operator
provider network: provides a VPN and VPrP service to the enterprise network, and offers APIs for connectivity
manager to the enterprise operator also referred to as network service provider
provider: entity that offers the VPN and VPrP services, and implements the APIs in the provider network
ETSI

---------------------- Page: 8 ----------------------

SIST ES 201 915-10 V1.4.1:2005
 7 ETSI ES 201 915-10 V1.4.1 (2003-07)
Quality of Service (QoS): collection of service levels delivered by a provider network to an enterprise network
NOTE: QoS can be characterised by various performance attributes such as: packet loss, packet delay; traffic
policing measures such as maximum bandwidth and burst rate for traffic entering the providers network.
Service Access Point (SAP): enterprise network is connected to the provider network through the enterprise network
service access points
NOTE: A SAP is typically the egress router from the enterprise network that connects to the provider network.
TOS bits: value held in the TOS field
NOTE: IETF defined the use the TOS field in the IPv4 packet header as a signalling mechanism aimed at
providing definitions of aggregation of flows, where each aggregate is supported by the same level of
QoS.
Virtual Private Network (VPN): network that uses a provider network infrastructure to connect geographically
separated sites of an enterprise
NOTE: Such a network looks like a private network to the enterprise as the sites are connected using tunnelling
and security technologies. With no QoS measures, VPN passes all packets among the sites with a best
effort approach.
Virtual Leased Line (VLL): network that uses a provider network infrastructure to connect two geographically
separated sites of an enterprise
Virtual Provisioned Network (VPrN): collection of VPrP delivered as a service to a single enterprise network
Virtual Provisioned Pipe (VPrP): service provided by the provider network to the enterprise network, which is a type
of virtual leased line (VLL) provisioned with QoS levels
NOTE: VPrP carries enterprise network traffic whose packets are marked with the specific DS Codepoint that is
associated with this VPrP. The enterprise operator using APIs can create on-line a VPrP.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 201 915-1 and the following apply:
CIM Common Information Model
CM Connectivity Manager
DiffServ Differentiated Services
DMTF Distributed Management Task Force
DS Differentiated Services
QoS Quality of Service
SAP Service Access Point
SLA Service Level Agreement terms
TOS Type Of Service
VLL Virtual Leased Line
VPN Virtual Private Network
VPrN Virtual Provisioned Network
VPrP Virtual Provisioned Pipe
ETSI

---------------------- Page: 9 ----------------------

SIST ES 201 915-10 V1.4.1:2005
 8 ETSI ES 201 915-10 V1.4.1 (2003-07)
4 Connectivity Manager SCF
Connectivity Manager includes the APIs between the enterprise operator and the provider network for the two parties to
establish QoS parameters for enterprise network packets travelling through the provider network.
The Connectivity Manager service provides tools for the enterprise operator to set up a Provisioned QoS service in the
provider network. The QoS measures used in the enterprise network are outside the scope of the service. The API does
not require any specific QoS method to be used in the enterprise network, nor in the provider network. However, in
order for Provisioned QoS service to be applied to packets arriving from the enterprise network into the provider
network, the packets have to be marked using DS Codepoint marking. Once the packets are so marked, they can enjoy
the QoS service provisioned in the provider network.
APIs provide the enterprise network operator on-line access to provision quality of service measures that control the
enterprise's own traffic passing through the provider network. Using APIs the operator can create virtual provisioned
pipes (VPrPs) in the provider network to carry the enterprise traffic and support it with pre-specified quality of service
attributes. A VPrP can be thought of as a Virtual Leased Line (VLL) provisioned to deliver pre-specified QoS. The
provider may offer to the enterprise operator a set of templates that are used by the operator to specify a VPrP. For
instance, the provider may offer templates for video conferencing, audio conferencing, Gold Service, Silver Service,
etc. Using these templates the operator can select and provision a VPrP that specifies the quality of service attributes for
this VPrP.
Elements that can be specified for a VPrP include attributes such as packet delay and packet loss. Characteristics of
traffic that enters the VPrP at its access point to the provider network can be also specified with attributes such as
maximum rate and burst rate.
The following is an example of a possible scenario:
• The provider prepares a template with operator-specified attributes, provider-specified attributes, and
unspecified attributes, one for each QoS level.
• The provider generates for the enterprise network a list of all the current sites and their access points to the
provider network.
• Enterprise operator logs into connectivity manager after being authenticated and authorised by the Framework
service.
• Operator gets the list of the sites and service access points of the enterprise virtual private network (VPN)
already provided to the enterprise by the provider.
• Enterprise operator retrieves the set of templates available to the enterprise (as supported by the SLA), selects
one, and requests a template for constructing a new VPrP based upon the selected QoS.
• Enterprise operator completes the VPrP template: i.e. selects a value for delay, loss, jitter and excess traffic
treatment action, enters the SLA ID against which the template could be validated, selects endpoints, load
parameters and traffic flow direction, and selects the time requirements desired. The enterprise operator can
choose or modify those attributes that are operator-specified attributes in the template. Provider-specified
attributes cannot be modified and are inherently part of the service.
• Enterprise operator submits the completed VPrP template for validation by the CM service. Operator creates a
new VPrP with pending-status that holds these selections.
• The provider responds after validating the requests, which may be an approval or a denial (e.g. the requested
service is not available at this access point, or at the specified time).
• If the provider approves service, the operator may send packets marked with the templates DiffServ
Codepoint, which identifies together with the endpoints the VPrP that carries these packets.
ETSI

---------------------- Page: 10 ----------------------

SIST ES 201 915-10 V1.4.1:2005
 9 ETSI ES 201 915-10 V1.4.1 (2003-07)
Some additional clarification points:
• A VPrN is associated with a single network provider.
• A VPrP defines QoS parameters for traffic flowing through this provider network, between two specified
enterprise endpoints, optionally during specified date/time period(s).
• The enterprise operator may be (provider's choice) constrained to selecting QoS parameter values from a
pre-defined set of values, and selecting endpoints from a predefined set of enterprise sites; where these sets
were negotiated off-line between the enterprise and the network provider and possibly documented in a
Service Level Agreement (SLA).
• The CM service validates each VPrP request submitted by the enterprise operator. The validation process is
not specified here. Validation against the SLA is an example of such possible validation.
• If the CM service accepts the VPrP request, it adds it to the VPrN. The DiffServ Codepoint provided by the
enterprise operator is then used by the enterprise for marking all packets belonging to any traffic flow
associated with the VPrP.
The following is a summary of interfaces and methods supported by connectivity manager. The syntax method
(interface) is used for this description.
There are Passive CM interface functions (CM1, CM2, CM4) that are used to retrieve information (read) relative to
VPN, VPrN, and QoS templates provided by the service provider,
...