10 Data Definitions
29.198-103GPPOpen Service Access (OSA) Application Programming Interface (API)Part 10: Connectivity manager Service Capability Feature (SCF)TS
Data type specifications can be found below. There is an extensive use of a specific data type for connectivity manager. This data type is discussed here to clarify how different interfaces and methods use it.
The data type TpNameDescrpTag is not explicitly specified (however, it is shown in the class diagrams document) as it is inherited by various other data types, such as TpNameDescrpTagDateTime, TpNameDescrpTagdayofWeek, TpNameDescrpTagint, TpNameDescrpTagString, and so forth. The TpNameDescrpTag class includes three parameters that are inherited by all of its subclasses data types: The name parameter, the description parameter, and the tag parameter. These parameters were defined for the get method in the template interface, and were reused by other methods, with some semantic modifications. The three parameters are:
- The name parameter which names the parameter in a template.
- The description parameter describes the parameter as it relates to the QoS service, and could add explanations and restrictions regarding the use of a parameter, such as what values can be selected by the operator for the parameter in a given template.
- The tag parameter has the following values and interpretation:
- Provider specified: the operator cannot modify the value of this parameter as set in the template interface.
- Operator specified: enterprise operator may change the default value set by the provider in the template. The default value can be blank to indicate that there is no default value for this parameter. The operator may change it according to advice, if provided in the description parameters.
- Unspecified: the parameter is not used for this template, and the enterprise operator cannot change it.
Various interfaces and methods reuse these data types, since they require only a slight semantic modification while reusing the entire structure. The following specifies the modified semantics as used by the various methods.
For the QoS template interface and all the set methods that use the TpNameDescrpTag data type, the tag values should be ignored by the CM implementation, as only the provider sets the tag value in all cases, and the operator cannot change it. For any parameter that is set to operator specified, the set method can modify the values set in the template, but not the associated tag. If the tag is set to provider specified, or unspecified, and the operator tries to modify it with a set method, the P_NOT_OPERATOR_SPECIFIED_VALUE exception is raised. However, the description can be modified by the set method if the tag is operator specified. The operator can use this feature to enter notes that would be later shown when retrieving VPrP information. However, the name parameter can not be changed as it might be unique in the provider’s network.
For the VPrP interface, the tag value is irrelevant for all the get methods and may be ignored by the operator client.
All data types referenced but not defined in this clause are common data definitions which may be found in
ES 204 915-2.
10.1 Connectivity Manager Data Types
10.1.1 TpIPSubnet
Defines a Sequence of Data Elements.
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
subnetNumber |
TpString |
IP address, IPv4 example 2.3.4.15 |
|
subnetMask |
TpString |
IPv4 mask example, 255.255.255.0 |
|
addressType |
TpIPv4AddType |
Class for the Ipv4 address format |
|
IPVersionSupport |
TpIPVersion |
Version supported |
|
NOTE: The TpIPSubnet data type follows the DMTF CIM specification for IP sub-net. |
||
10.1.2 TpIPv4AddType
|
Name |
Value |
Description |
|---|---|---|
|
IPV4_ADD_CLASS_A |
0 |
Address Class A |
|
IPV4_ADD_CLASS_B |
1 |
Address Class b |
|
IPV4_ADD_CLASS_C |
2 |
Address Class c |
|
IPV4_ADD_CLASS_D |
3 |
Address Class d |
|
IPV4_ADD_CLASS_E |
4 |
Address Class e |
10.1.3 TpIPVersion
|
Name |
Value |
Description |
|---|---|---|
|
VERSION_UNKNOWN |
0 |
Unknown IP addressing format |
|
VERSION_IPV4 |
1 |
IPv4 addressing format |
|
VERSION_IPV6 |
2 |
IPv6 addressing format |
10.1.4 TpVprpStatus
|
Name |
Value |
Description |
|---|---|---|
|
ACTIVE |
0 |
A VPrP status indicating that this VPrP is a previously established VPrP. Also means that a previous request to create the VPrP was granted by the provider. Packets that belong to this VPrP and meet the validity time requirements, are admitted to the enterprise VPrN. |
|
PENDING |
1 |
A VPrP status indicating that this VPrP is a request to create a new VPrP, and it is still pending a response from the provider, i.e. the provider is still processing the request to create a this new VPrP. Packets that belong to this VPrP are not admitted to the enterprise VPrN. |
|
DISALLOWED |
2 |
A VPrP status indicating that this VPrP is a request to create a new VPrP, however, the request was denied. A description parameter may include the reason for the denial. This is an disallowed VPrP and packets that belong to this VPrP are not admitted to the enterprise VPrN. |
10.1.5 TpDsCodepoint
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
match |
TpString |
Marking significant bits. 6-bit long. Valid characters are 0 and 1. |
|
mask |
TpString |
Identifies significant part (1s) of for marking Codepoint. 6-bit long. Valid characters are 0 and 1. |
10.1.6 TpProvisionedQoSInfo
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
delayDescriptor |
TpDelayDescriptor |
Delay parameters |
|
lossDescriptor |
TpLossDescriptor |
Loss parameters |
|
jitterDescriptor |
TpJitterDescriptor |
Jitter parameters |
|
excessLoadAction |
TpNameDescrpTagExcessLoadAction |
Excess load action parameters |
|
description |
TpNameDescrpTagString |
Operator can add text using the Set method, if tag is Operator Specified |
10.1.7 TpDelayDescriptor
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
meanDelay |
TpNameDescrpTagInt |
in milliseconds |
|
measurementPeriod |
TpNameDescrpTagInt |
in milliseconds |
|
maxDelay |
TpNameDescrpTagInt |
in milliseconds |
|
minDelay |
TpNameDescrpTagInt |
in milliseconds |
|
delayPriority |
TpNameDescrpTagInt |
higher value indicates higher priority |
|
description |
TpNameDescrpTagString |
Operator can add text using the Set method, if tag is Operator Specified |
10.1.8 TpLossDescriptor
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
meanLoss |
TpNameDescrpTagInt |
per this many packets, one packet is lost |
|
measurementPeriod |
TpNameDescrpTagInt |
in milliseconds |
|
maxLoss |
TpNameDescrpTagInt |
per this many packets, one packet is lost |
|
minLoss |
TpNameDescrpTagInt |
per this many packets, one packet is lost |
|
lossPriority |
TpNameDescrpTagInt |
higher value indicates higher priority |
|
description |
TpNameDescrpTagString |
Operator can add text using the Set method, if tag is Operator Specified |
10.1.9 TpJitterDescriptor
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
meanJitter |
TpNameDescrpTagInt |
in milliseconds. |
|
measurementPeriod |
TpNameDescrpTagInt |
in milliseconds. |
|
maxJitter |
TpNameDescrpTagSInt |
in milliseconds. |
|
minJitter |
TpNameDescrpTagInt |
in milliseconds. |
|
jitterPriority |
TpNameDescrpTagInt |
higher value indicates higher priority. |
|
description |
TpNameDescrpTagString |
Operator can add text using the Set method, if tag is Operator Specified. |
10.1.10 TpNameDescrpTagInt
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
name |
TpString |
Name set by provider. |
|
description |
TpString |
Description set by provider. |
|
tag |
TpTagValue |
Tag set by provider. Cannot be overwritten by operator. |
|
value |
TpInt32 |
Can be set by operator or provider, depending on the tag value. |
10.1.11 TpNameDescrpTagString
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
name |
TpString |
Name set by provider. |
|
description |
TpString |
Description set by provider |
|
tag |
TpTagValue |
Tag set by provider. Cannot be overwritten by operator. |
|
value |
TpString |
Can be set by operator or provider, depending on the tag value. |
10.1.12 TpTagValue
|
Name |
Value |
Description |
|---|---|---|
|
PROVIDER_SPECIFIED |
0 |
The operator cannot modify the value of this parameter as set in the template interface. |
|
OPERATOR_SPECIFIED |
1 |
Enterprise operator may change the default value set by the provider in the template. The default value can be blank to indicate that there is no default value for this parameter. The operator may change it according with advice, if provided in the description parameters. |
|
UNSPECIFIED |
2 |
Parameter is not used for this template, and the enterprise operator cannot change it. |
10.1.13 TpNameDescrpTagExcessLoadAction
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
name |
TpString |
Name set by provider. |
|
description |
TpString |
Description set by provider. |
|
tag |
TpTagValue |
Tag set by provider. Cannot be overwritten by operator. |
|
value |
TpAction |
Can be set by operator or provider, depending on the tag value. |
10.1.14 TpAction
|
Name |
Value |
Description |
|---|---|---|
|
DROP |
0 |
Drop packets (i.e. do not ever transmit them) that exceed the load traffic parameters that were set for the VPrP |
|
TRANSMIT |
1 |
Transmit packets even though transmitting them will create a load in excess of the load traffic parameters that were set for the VPrP |
|
RESHAPE |
2 |
Reshape the entering traffic by trying to keep the packet (and not drop them yet) waiting for the entering traffic load to come down below the load conditions set for the VPrP, and if it does, transmit the packets then |
|
REMARK |
3 |
Remark the packet for a lower QoS service, then transmit them (i.e. transfer the packet through some other less demanding VPrP). This may result in increased packet loss (i.e. the excess packets may have now higher probability of being dropped before reaching their SAP or Site destination), or increased packet delay and / or packet jitter |
10.1.15 TpPipeQoSInfo
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
directionality |
TpNameDescrpTagDir |
Specifies whether traffic is uni- or |
|
serviceOrigin |
TpEndpoint |
|
|
serviceDestination |
TpEndpoint |
|
|
forwardLoad |
TpLoadDescriptor |
Traffic flowing from service origin to service destination. |
|
reverseLoad |
TpLoadDescriptor |
Traffic flowing from service destination to service source. |
|
description |
TpNameDescrpTagString |
10.1.16 TpNameDescrpTagDir
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
name |
TpString |
Name set by provider. |
|
description |
TpString |
Description set by provider. |
|
tag |
TpTagValue |
Tag set by provider. Cannot be overwritten by operator. |
|
value |
TpTrafficDirection |
Can be set by operator or provider, depending on the tag value. |
10.1.17 TpTrafficDirection
|
Name |
Value |
Description |
|---|---|---|
|
UNIDIRECTIONAL |
0 |
The traffic for this VPrP is unidirectional. |
|
BIDIRECTIONAL |
1 |
The traffic for this VPrP is bi-directional. |
10.1.18 TpEndpoint
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
type |
TpSiteOrSap |
Specifies whether the endpoint is a site or a SAP. |
|
id |
TpString |
Endpoint name. |
10.1.19 TpSiteOrSap
|
Name |
Value |
Description |
|---|---|---|
|
SITE |
0 |
Endpoint is a site |
|
SAP |
1 |
Endpoint is a SAP |
10.1.20 TpLoadDescriptor
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
meanBandwidth |
TpNameDescrpTagInt |
Bytes per second |
|
measurmentInterval |
TpNameDescrpTagInt |
milliseconds |
|
maxBandwidth |
TpNameDescrpTagInt |
Bytes per second |
|
minBandwidth |
TpNameDescrpTagInt |
Bytes per second |
|
bandwidthShare |
TpNameDescrpTagInt |
1/100 of a percent, e.g. 500 is 0,5 % |
|
bandwidthWeight |
TpNameDescrpTagInt |
|
|
burstSize |
TpNameDescrpTagInt |
Bytes |
|
description |
TpNameDescrpTagString |
10.1.21 TpValidityInfo
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
validFrom |
TpNameDescrpTagDateTime |
valid start time |
|
validPeriod |
TpNameDescrpTagTimePeriod |
valid Duration |
|
validDailyFrom |
TpNameDescrpTagTimeOfDay |
daily start time |
|
validDailyPeriod |
TpNameDescrpTagTimePeriod |
Daily Duration |
|
validDayOfWeek |
TpNameDescrpTagDayOfWeek |
days of the week |
|
validMonth |
TpNameDescrpTagMonth |
months in a year |
|
description |
TpNameDescrpTagString |
description |
Specifies the validity period for a VPrP.
10.1.22 TpNameDescrpTagDateTime
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
name |
TpString |
Name set by provider. |
|
description |
TpString |
Description set by provider. |
|
tag |
TpTagValue |
Tag set by provider. Cannot be overwritten by operator. |
|
value |
TpDateAndTime |
Can be set by operator or provider, depending on the tag value. The TpDateAndTime data type is a common data type in accordance with ISO 8601. |
Specifies a date and the time on that day for a valid period to start.
10.1.23 TpNameDescrpTagTimePeriod
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
duration |
TpInt32 |
Time measured from a start time specified by another parameter for the validity information. Measured in Seconds. |
10.1.24 TpNameDescrpTagTimeOfDay
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
name |
TpString |
Name set by provider. |
|
description |
TpString |
Description set by provider. |
|
tag |
TpTagValue |
Tag set by provider. Cannot be overwritten by operator. |
|
value |
TpString |
String with the following format HH:MM. HH two digit hour, and MM two digit minutes. Time of the day to be applied to validity information provided by other validity parameters. |
Specifies a time in a day, where the day is specified by another validity parameter. For example, if validity information includes Mondays and Thursday of the week, this daily time applies to these two days. The valid time window will start on Mondays and Thursday s at the time specified by this parameter.
10.1.25 TpNameDescrpTagDayOfWeek
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
name |
TpString |
Name set by provider. |
|
description |
TpString |
Description set by provider. |
|
tag |
TpTagValue |
Tag set by provider. Cannot be overwritten by operator. |
|
value |
TpInt32 |
Day of the week to be applied to validity information provided by other validity parameters. Next table below shows the value assigned to each day. The value for this parameter can be in the range of 1 to 127. |
The value parameter specifies information regarding the days of the week for the validity time period. For multiple days, this parameter holds the total value of the days, see examples below.
In the following table the value corresponding to the valid days is obtained by adding the values for each day. For example:
1 = Mondays
2 = Tuesdays
3 = 2 + 1 = Mondays and Tuesdays
4 = Wednesdays
5 = 4 + 1 = Mondays and Wednesdays
96 = 32 + 64 = Saturday + Sunday = weekend.
|
Values for Days Of Week |
|
|---|---|
|
Day |
Value |
|
Monday |
1 |
|
Tuesday |
2 |
|
Wednesday |
4 |
|
Thursday |
8 |
|
Friday |
16 |
|
Saturday |
32 |
|
Sunday |
64 |
10.1.26 TpNameDescrpTagMonth
|
Sequence Element Name |
Sequence Element Type |
Description |
|---|---|---|
|
name |
TpString |
Name set by provider. |
|
description |
TpString |
Description set by provider. |
|
tag |
TpTagValue |
Tag set by provider. Cannot be overwritten by operator. |
|
value |
TpInt32 |
Months of the year to be applied to validity information provided by other validity parameters. Next table below shows the value assigned to each Month. The value for this parameter must be in the range of 1 to 4095. |
In the following table the value corresponding to the valid month is obtained by adding the values for each valid month. For example:
1 = January
2 = February
3 = 2 + 1 = January and February
4 = March
5 = 4 + 1 = March and January
|
Values for Months of Year |
|
|---|---|
|
Month |
Sequence Element Type |
|
January |
1 |
|
February |
2 |
|
March |
4 |
|
April |
8 |
|
May |
16 |
|
June |
32 |
|
July |
64 |
|
August |
128 |
|
September |
256 |
|
October |
512 |
|
November |
1024 |
|
December |
2048 |