6 Interface Definition
28.3053GPPControl and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP)Information Service (IS)Release 17TS
6.1 Interface definition for solution 1
6.1.1 Class diagram
None.
6.2 Interface definition for solution 2
6.2.1 Class diagram
Figure 6.2.1.1: Class diagram representing interfaces for solution 2
6.2.2 Generic rules
Rule 1: each operation with at least one input parameter supports a pre-condition valid_input_parameter which indicates that all input parameters shall be valid with regards to their information type. Additionally, each such operation supports an exception operation_failed_invalid_input_parameter which is raised when pre-condition valid_input_parameter is false. The exception has the same entry and exit state.
Rule 2: Each operation with at least one optional input parameter supports a set of pre-conditions supported_optional_input_parameter_yyy where "yyy" is the name of the optional input parameter and the
pre-condition indicates that the operation supports the named optional input parameter. Additionally, each such operation supports an exception operation_failed_unsupported_optional_input_parameter_yyy which is raised when (a) the pre-condition supported_optional_input_parameter_yyy is false and (b) the named optional input parameter is carrying information. The exception has the same entry and exit state.
Rule 3: each operation shall support a generic exception operation_failed_internal_problem which is raised when an internal problem occurs and that the operation cannot be completed. The exception has the same entry and exit state.
6.2.3 CMONOperations_1 Interface (M)
6.2.3.1 Operation readMEDescription (M)
6.2.3.1.1 Definition
The IRPManager invokes this operation to read description data of the monitored entity.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-001 REQ-EECMON-CON-002 REQ-EECMON-CON-003 |
6.2.3.1.2 Input parameters
|
Name |
Qualifier |
Matching Type |
Comment |
|
mEId |
M |
mEId of the PEEMonitoredEntity instance. |
This parameter contains the identification of the monitored entity. |
|
attributeNameList |
O |
List of attribute names (in PEEMEDescription). |
This parameter contains the list of names of attributes of the monitored entity, from PEEMEDescription. If the list is not provided, name+value pairs for all attributes of the monitored entity shall be returned. |
6.2.3.1.3 Output parameters
|
Name |
Qualifier |
Matching Information |
Comment |
|
mEId |
M |
mEId of the PEEMonitoredEntity instance. |
This parameter contains the identification of the monitored entity. |
|
attNameValueList |
M |
List of attribute name (in PEEMEDescription) and value pairs |
This parameter contains a list of attribute name+value of the monitored entity. |
|
status |
M |
ENUM (OperationSucceeded, OperationFailed) |
If allInformationReturned is true, status = OperationSucceeded. If operation_failed is true, status = OperationFailed. |
6.2.3.1.4 Pre-condition
None.
6.2.3.1.5 Post-condition
allInformationReturned.
|
Assertion Name |
Definition |
|
allInformationReturned |
For all attributes of the input parameter attributeNameList, their names and values are returned. All their values remain unchanged as the result of this operation. |
6.2.3.1.6 Exception
|
Assertion Name |
Definition |
|
operation_failed |
Condition: One of the input parameters is invalid or the post-condition is not true. Returned Information: The output parameter status. Exit state: Entry state. |
6.2.3.2 Operation writeMEDescription (M)
6.2.3.2.1 Definition
The IRPManager invokes this operation to modify description data of the monitored entity.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-007 REQ-EECMON-CON-008 REQ-EECMON-CON-009 |
6.2.3.2.2 Input parameters
|
Name |
Qualifier |
Matching Type |
Comment |
|
mEId |
M |
mEId of the PEEMonitoredEntity instance. |
This parameter contains the identification of the monitored entity. |
|
attNameValueList |
M |
List of attribute name (in PEEMEDescription) and value pairs |
This parameter contains the list of attribute name+value of the monitored entity, for attributes in PEEMEDescription. |
6.2.3.2.3 Output parameters
|
Name |
Qualifier |
Matching Information |
Comment |
|
mEId |
M |
mEId of the PEEMonitoredEntity instance. |
This parameter contains the identification of the monitored entity. |
|
attNameValueList |
M |
List of attribute name (in PEEMEDescription) and value pairs |
This parameter contains a list of attribute name+value of the modified attributes of the monitored entity after the operation has been achieved. |
|
status |
M |
ENUM (OperationSucceeded, OperationFailed) |
If allInformationReturned is true, status = OperationSucceeded. If operation_failed is true, status = OperationFailed. |
6.2.3.2.4 Pre-condition
None.
6.2.3.2.5 Post-condition
allAttributesCorrectlyModified.
|
Assertion Name |
Definition |
|
allAttributesCorrectlyModified |
All attributes of the input parameter attributeNameList have been correctly modified as requested by this operation. All their modified values are returned. |
6.2.3.2.6 Exception
|
Assertion Name |
Definition |
|
operation_failed |
Condition: One of the input parameters is invalid or the post-condition is not true. Returned Information: The output parameter status. Exit state: Entry state. |
6.2.4 CMONOperations_2 Interface (M)
6.2.4.1 Operation readMEConfiguration (M)
6.2.4.1.1 Definition
The IRPManager invokes this operation to read threshold values on PEE parameters for one monitored entity.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-007 REQ-EECMON-CON-008 REQ-EECMON-CON-009 |
6.2.4.1.2 Input parameters
|
Parameter Name |
Support Qualifier |
Information Type / Legal Values |
Comment |
|
mEId |
M |
PEEMonitoredEntity.mEId |
This parameter contains the mEId of the PEEMonitoredEntity instance. |
|
thresholdNameList |
O |
List of threshold names (in PEEMEConfiguration) |
This parameter contains the list of threshold names for the monitored entity instances, where threshold name corresponds to an attribute name in PEEConfigInformation. If the list is not provided, name+value pairs for all thresholds of the monitored entity shall be returned. |
6.2.4.1.3 Output parameters
|
Parameter Name |
Support Qualifier |
Matching Information / Information Type / Legal Values |
Comment |
|
mEId |
M |
PEEMonitoredEntity.mEId |
This parameter contains the mEId of the PEEMonitoredEntity instance whose threshold(s) have been read. |
|
thresholdNameValueList |
M |
List of threshold name and value pairs |
This parameter contains the list of threshold name+value pairs set for the monitored entity instance, where threshold name corresponds to an attribute name in PEEConfigInformation. |
|
status |
M |
ENUM (OperationSucceeded, OperationFailed) |
If allInformationReturned is true, status = OperationSucceeded. If operation_failed is true, status = OperationFailed. |
6.2.4.1.4 Pre-condition
None.
6.2.4.1.5 Post-condition
allInformationReturned.
|
Assertion Name |
Definition |
|
allInformationReturned |
For all thresholds of the input parameter thresholdNameList, their names and values are returned. All their values remain unchanged as the result of this operation. |
6.2.4.1.6 Exception
|
Assertion Name |
Definition |
|
operation_failed |
Condition: One of the input parameters is invalid or the post-condition is not true. Returned Information: The output parameter status. Exit state: Entry state. |
6.2.4.2 Operation writeMEConfiguration (M)
6.2.4.2.1 Definition
The IRPManager invokes this operation to write threshold values on PEE parameters of one monitored entity.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-007 REQ-EECMON-CON-008 REQ-EECMON-CON-009 |
6.2.4.2.2 Input parameters
|
Parameter Name |
Support Qualifier |
Information Type / Legal Values |
Comment |
|
mEId |
M |
List of <PEEMonitoredEntity.mEId> |
This parameter contains the Id of PEEMonitoredEntity instance whose threshold(s) are to be written. |
|
thresholdNameValueList |
M |
List of threshold name and value pairs |
This parameter contains the list of threshold name+value pairs for the monitored entity instance, where threshold name corresponds to an attribute name in PEEConfigInformation. Each threshold name+value pair defines the value of the monitored threshold. If the value is (a) crossed or (b) reached, a thresholdCrossing notification shall be emitted by the PEECMONIRP Agent. |
6.2.4.2.3 Output parameters
|
Parameter Name |
Support Qualifier |
Matching Information / Information Type / Legal Values |
Comment |
|
mEId |
M |
PEEMonitoredEntity.mEId |
This parameter contains the Id of the PEEMonitoredEntity instance whose threshold(s) have been written. |
|
thresholdNameValueList |
M |
List of threshold name and value pairs |
This parameter contains the list of threshold name+value pairs set for the monitored entity instance, where threshold name corresponds to an attribute name in PEEConfigInformation. |
|
status |
M |
ENUM (OperationSucceeded, OperationFailed) |
If allInformationReturned is true, status = OperationSucceeded. If operation_failed is true, status = OperationFailed. |
6.2.4.2.4 Pre-condition
None.
6.2.4.2.5 Post-condition
allThresholdsCorrectlyModified.
|
Assertion Name |
Definition |
|
allThresholdsCorrectlyModified |
All thresholds of the input parameter thresholdNameValueList have been correctly modified as requested by this operation. All their values are returned. |
6.2.4.2.6 Exception
|
Assertion Name |
Definition |
|
operation_failed |
Condition: One of the input parameters is invalid or the post-condition is not true. Returned Information: The output parameter status. Exit state: Entry state. |
6.2.5 CMONOperations_3 Interface (M)
6.2.5.1 Operation createCMONPMJob (M)
6.2.5.1.1 Definition
The IRPManager invokes this operation to create a PEE measurement job on one or more monitored entity(ies). The PEE measurement job starts immediately and run indefinitely until a stopCMONPMJob request is received by IRPAgent.
The way the address of the entity to which notifications containing measurement data are sent is provisioned, is not in the scope of this document.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-001 REQ-EECMON-CON-002 REQ-EECMON-CON-003 |
6.2.5.1.2 Input parameters
|
Parameter Name |
Support Qualifier |
Information Type / Legal Values |
Comment |
|---|---|---|---|
|
mEIdList |
M |
List of <PEEMonitoredEntity.mEId> |
This parameter contains the list of mEIds of PEEMonitoredEntity instances whose measurement(s) are to be collected. |
|
measurementNameList |
M |
List of measurement names |
This parameter contains the list of names of measurements to be collected. Each measurement name shall correspond to an attribute name of PEEMeasurementData. |
|
granularityPeriod |
M |
A number of minutes. See Comment for legal values |
It specifies the period between two successive measurements. The value can be 5 minutes, 15 minutes, 30 minutes, 1 hour, 12 hours and 24 hours. The minimum granularity period is 5 minutes in most cases, but for some measurements it may only make sense to collect data in a larger granularity period. It also specifies the period between two successive emissions of notifyMeasurementData notifications. |
6.2.5.1.3 Output parameters
|
Parameter Name |
Support Qualifier |
Matching Information / Information Type / Legal Values |
Comment |
|
jobId |
M |
Measurement job id |
Unique identifier of the measurement job among all the existing measurement jobs in a PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). The uniqueness is guaranteed by the Operator. |
|
status |
M |
ENUM (Success, Failure, PartialSuccess) |
An operation may fail because of a specified (e.g. invalid granularity period, invalid measurement name) or unspecified reason. |
6.2.5.1.4 Pre-condition
None.
6.2.5.1.5 Post-condition
None.
6.2.5.1.6 Exception
|
Assertion Name |
Definition |
|
operation_failed |
Condition: One of the input parameters is invalid. Returned Information: The output parameter status. Exit state: Entry state. |
6.2.5.1.7 Constraints
None.
6.2.5.2 Operation stopCMONPMJob (M)
6.2.5.2.1 Definition
The IRPManager invokes this operation to stop an ongoing PEE measurement job on one or more monitored entity(ies). The PEE measurement job stops immediately.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-001 REQ-EECMON-CON-002 REQ-EECMON-CON-003 |
6.2.5.2.2 Input parameters
|
Parameter Name |
Support Qualifier |
Information Type / Legal Values |
Comment |
|---|---|---|---|
|
jobId |
M |
Measurement job id |
Identifier of the measurement job among all the existing measurement jobs in a PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). |
6.2.5.2.3 Output parameters
|
Parameter Name |
Support Qualifier |
Matching Information / Information Type / Legal Values |
Comment |
|
status |
M |
ENUM (Success, Failure, PartialSuccess) |
An operation may fail because of a specified (e.g. unknown job, job cannot be stopped) or unspecified reason. |
6.2.5.2.4 Pre-condition
None.
6.2.5.2.5 Post-condition
cMONPMJobStopped.
|
Assertion Name |
Definition |
|
cMONPMJobStopped |
The PM job has been stopped. |
6.2.5.2.6 Exception
|
Assertion Name |
Definition |
|
operation_failed |
Condition: One of the input parameters is invalid or the post-condition is not true. Returned Information: The output parameter status. Exit state: Entry state. |
6.2.5.2.7 Constraints
None.
6.2.6 CMONNotifications_1 Interface (M)
6.2.6.1 Notification notifyMeasurementData (M)
6.2.6.1.1 Definition
The PEECMONIRP Agent notifies the PEECMONIRP Manager with measurement data.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-004 REQ-EECMON-CON-005 REQ-EECMON-CON-006 |
6.2.6.1.2 Input parameters
|
Parameter Name |
Support Qualifier |
Information Type / Legal Values |
Comment |
|
notificationId |
M |
Unique identifier of the notification among all the notifications issued by the PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). |
|
|
notificationHeader |
M |
This is the notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp indicating the time at which the notification is sent by PEECMONIRP Agent. |
|
|
notificationType |
M |
“Measurement data” |
|
|
jobId |
M |
Measurement job id |
Unique identifier of the measurement job. |
|
measHeader |
This is the measurement result notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp ("collectionBeginTime"). The "collectionBeginTime" is a time stamp that refers to the start of the first measurement collection interval (granularity period) that is covered by the collected measurement results that are sent in this notification. |
||
|
measData |
M |
Measurement data |
It represents the sequence of zero or more measurement result items. It can be empty in case no measurement data can be provided. The individual "measData" elements can appear in any order. Each "measData" element contains the mEId of the PEEMonitoredEntity instance, and the list of measurement results pertaining to that PEEMonitoredEntity instance ("measInfo"). Each “measInfo” is a pair of measurement name ("measName") and the corresponding result(s) ("measValues"). “measName” shall correspond to an attribute name in PEEMeasurementData. "measValues" contains the list of measurement results for the resource being measured. |
|
measFooter |
M |
The measurement result notification footer to be inserted in each notification. It includes a time stamp, which refers to the end of the overall measurement collection interval that is covered by the collected measurement results being sent in this notification. |
6.2.7 CMONNotifications_2 Interface (M)
6.2.7.1 Notification notifyAlarm (M)
6.2.7.1.1 Definition
The PEECMONIRP Agent notifies the PEECMONIRP Manager of a new alarm.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-010 REQ-EECMON-CON-011 REQ-EECMON-CON-012 |
6.2.7.1.2 Input parameters
|
Parameter Name |
Support Qualifier |
Information Type / Legal Values |
Comment |
|
notificationId |
M |
Unique identifier of the notification among all the notifications issued by the PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). |
|
|
notificationHeader |
M |
This is the notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp indicating the time at which the notification is sent by PEECMONIRP Agent. |
|
|
notificationType |
M |
“Alarm notification” |
|
|
alarmId |
M |
Unique alarm id among alarm ids generated by the PEECMONIRP Agent. |
|
|
alarmTime |
M |
All values indicating valid time. |
It indicates the date and time when the alarm is raised by the alarmed PEEMonitoredEntity instance. |
|
alarmType |
M |
See Event Types in TS 32.111-2 [8] – Annex A. |
|
|
perceivedSeverity |
M |
Critical, Major, Minor, Warning, Indeterminate, Cleared: see [10]. |
|
|
probableCause |
M |
See Probable Causes in TS 32.111-2 [8] – Annex B. |
|
|
additionalText |
O |
N/A |
It can carry semantics that is outside the scope of this IRP specification. It may provide the identification of the site from which the alarm has been originated. It may contain further information on the alarm. |
6.2.8 CMONNotifications_3 Interface (M)
6.2.8.1 Notification notifyConfigurationChange (M)
6.2.8.1.1 Definition
The PEECMONIRP Agent notifies the PEECMONIRP Manager of a change of configuration.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-013 REQ-EECMON-CON-014 REQ-EECMON-CON-015 |
6.2.8.1.2 Input parameters
|
Parameter Name |
Support Qualifier |
Information Type / Legal Values |
Comment |
|
notificationId |
M |
Unique identifier of the notification among all the notifications issued by the PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). |
|
|
notificationHeader |
M |
This is the notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp indicating the time at which the notification is sent by PEECMONIRP Agent. |
|
|
notificationType |
M |
“Configuration Change notification” |
|
|
mEId |
M |
mEId of the PEEMonitoredEntity instance. |
This parameter contains the identification of the monitored entity. |
|
attNameValueList |
M |
List of attribute name (in PEEMEDescription) and value pairs |
This parameter contains a list of attribute name+value pairs of the monitored entity, for which a value change happened. |
6.2.9 CMONNotifications_4 Interface (M)
6.2.9.1 Notification notifyThresholdCrossingOrReaching (M)
6.2.9.1.1 Definition
The PEECMONIRP Agent notifies the PEECMONIRP Manager of a threshold crossing.
|
Referenced TS |
Requirement label |
Comment |
|
3GPP TS 28.304 [9] |
REQ-EECMON-CON-013 REQ-EECMON-CON-014 REQ-EECMON-CON-015 |
6.2.9.1.2 Input parameters
|
Parameter Name |
Support Qualifier |
Information Type / Legal Values |
Comment |
|
notificationId |
M |
Unique identifier of the notification among all the notifications issued by the PEECMONIRP Agent (located in XCU/DGU or in VS-RMS or in EM/DM). |
|
|
notificationHeader |
M |
This is the notification header to be inserted in each such notification. It includes a version indicator, the name, type and vendor name of the sending network node, and a time stamp indicating the time at which the notification is sent by PEECMONIRP Agent. |
|
|
notificationType |
M |
“Threshold crossing or reaching notification” |
|
|
mEId |
M |
mEId of the PEEMonitoredEntity instance. |
This parameter contains the identification of the monitored entity. |
|
thresholdInfo |
M |
It indicates crossed threshold information such as: • The name of the threshold (corresponding to an attribute of PEEConfigInformation) whose value has crossed a threshold, • The threshold value, • The observed value that have crossed or reached the threshold value. |
Annex A (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2018-03 |
SA#79 |
Upgrade to change control version |
15.0.0 |
||||
|
2018-12 |
SA#82 |
SP-181039 |
0001 |
1 |
F |
Include information about referencers to CM, PM and FM IRPs |
15.1.0 |
|
2020-07 |
– |
– |
– |
– |
– |
Update to Rel-16 version (MCC) |
16.0.0 |
|
2022-03 |
– |
– |
– |
– |
– |
Update to Rel-17 version (MCC) |
17.0.0 |