iOCName

M

The IOC name defined of the NRMs (e.g., as defined in TS 28.541 [3]), or the class name defined locally in the performance data related specifications (e.g., TS 28.552 [2], TS 28.554 [21]).

It specifies one object class name. The consumer requests to collect one or more measurement type(s) of the instances of this class.

iOCInstanceList

M

List of DN

It specifies the list of DNs of object instances whose measurements or KPIs of the corresponding type(s) are to be collected.

An empty list means that for all instances (including the object instances existing at the time of measurement job creation, and the instances added later) known by the management service producer the measurements or KPIs will be collected.

If the MnS consumer represents a tenant, the object instances to be collected measurements should satisfy the conditions listed in Clause 4.4.

measurementCategoryList

M

List of measurement type names (see TS 28.552 [2]) or KPI names (see TS 28.554 [21]).

It specifies the measurement type(s) or KPI(s) to be measured.

If the measurement job is for the collection of performance measurement(s), the elements of the measurementCategoryList shall be one of the following forms:
– The form "family.measurementName.subcounter" can be used in order to retrieve a specified subcounter of a measurement type.

– The form "family.measurementName" can be used in order to retrieve a specific measurement type. In case the measurement type includes subcounters, all subcounters will be retrieved.

– The form "family" can be used in order to retrieve all measurement types in this family.

If the measurement job is for the collection of KPI(s), the elements of the measurementCategoryList shall be the KPI name defined in TS 28.554 [21].

reportingMethod

M

The reporting method of the collected performance data.

It specifies the method for the collected performance data to be reported. One of the following methods can be selected:

– by performance data file

– by performance data streaming (optional).

granularityPeriod

M

The period between generation of two successive measurements.

The management service producer will produce the value of the measurements or KPIs at the end of each granularityPeriod.

For performance measurements collection:

If the reportingMethod is performance data file reporting:

– The value of granularityPeriod can be 5 minutes, 15 minutes, 30 minutes, 1 hour, 12 hours or 24 hours or other values (see Note 1 below).

If the reportingMethod is performance data streaming:

– The value of granularityPeriod is an integer value in seconds (see Note 1 below).

For KPIs collection:

– The value of granularityPeriod can be 5 minutes, 15 minutes, 30 minutes, 1 hour, 12 hours or 24 hours or other values (see Note 1 below).

reportingPeriod

M

The period between two successive performance data reporting.

Applicable when the reportingMethod is performance data file reporting.

The performance data report(s) are produced when the reporting period arrives.

The reportingPeriod shall be one or multiple of granularityPeriod. The measurement or KPI value of each granularityPeriod will be made available to the performance data reporting related service producer, who will prepare the performance data file(s) for each reportingPeriod.

If the consumer has subscribed to the notifyFileReady and notifyFilePreparationError notifications from the performance data reporting related service producer, the consumer will receive the notifications about the result of the performance data file preparation from that producer with the interval as defined by reportPeriod;

startTime

O

It specifies the begin time from which the measurement job will be active.

All values that indicate valid timestamp.

Default value is "start now". If startTime is in the past, the current time will be used and the job will start immediately.

When a measurement job becomes active, it does not mean that the measurement job immediately starts generation of the measurements or KPIs. The consumer can set the detailed time frame (e.g. dailySchedule or weeklySchedule) by schedule parameter for a measurement job to generate the measurements or KPIs. If there is no time frame scheduled, the measurement job immediately starts generation of the measurements or KPIs when it becomes active.

stopTime

O

It specifies the end time after which the measurement job will be stopped.

The value indicates valid timestamp and shall be later than startTime and current time.

This attribute may carry the value "indefinitely".

Default value is to run indefinitely.

schedule

O

It specifies the detailed time frames (within the startTime and stopTime) during which the measurement job is active and monitors the measurement type(s) or KPI(s).

Its value is only one of the following, dailyScheduling or weeklyScheduling. The legal values for them refer to ITU-T Recommendation X.721 [4].

The legal values for them are as follows.

dailyScheduling:

{{ intervalStart {hour 0, minute 0},

intervalEnd {hour 23, minute 59}}}

weeklyScheduling:

{{ daysOfWeek ‘1111111’B,

intervalsOfDay dailyScheduling}}

Default value is "daily".

streamTarget

M

It specifies the target of performance data streams carrying the performance data stream unit(s).

Applicable when the reportingMethod is performance data streaming.

priority

O

It specifies the priority of measurement job

Its value should be one of the following:

Low,

Medium,

High

Default value is “Medium”

reliability

O

It specifies the reliability of measurement job

Its value is vendor specific.

See NOTE 2.

jobId

M

It identifies the measurement job instance (and distinguishes it from all other ongoing and stopped measurement job instances that have been created for the subject consumer).

Unique identifier of the measurement job from all the ongoing and stopped Measurement jobs that have been created for the subject consumer.

unsupportedList

M

List of <

iOC instance,

measurement type or KPI name,

reason

>

To create a measurement job, best-effort is required. The parameter of ‘unsupportedList’ has to be returned if status = PartialSuccess.

The reason can be any of:

– Measurement type or KPI name is unknown.

– Measurement type or KPI name is invalid.

– Measurement type or KPI name is not supported in the specific implementation.

– Measurement type or KPI name is already monitored for the IOC instance with a different granularityPeriod.

– The related IOC instance is unknown (e.g. it does not exist at the time of this operation invocation).

– Insufficient capacity to monitor the related IOC instance(s).

– (For KPI only) At least one related measurement job is not activated.

– The object instance listed in iOCInstanceList does not satisfy the condition in clause 4.4 in multiple tenant environment.

status

M

ENUM (Success, Failure, PartialSuccess)

An operation may fail because of a specified or unspecified reason.

invalidStartTime

Condition: startTime is invalid.

Returned Information: Name of the exception; status is set to ‘Failure’.

invalidStopTime

Condition: stopTime is invalid.

Returned Information: Name of the exception; status is set to ‘Failure’.

invalidSchedule

Condition: schedule is invalid.

Returned Information: Name of the exception; status is set to ‘Failure’.

invalidReportingMethod

Condition: reportingMethod is invalid.

Returned Information: Name of the exception; status is set to ‘Failure’.

invalidGranularityPeriod

Condition: granularityPeriod is invalid.

Returned Information: Name of the exception; status is set to ‘Failure’.

invalidReportingPeriod

Condition: reportingPeriod is invalid.

Returned Information: Name of the exception; status is set to ‘Failure’.

highWorkLoad

Condition: no sufficient capacity

Returned Information: Name of the exception and the detailed reason which is one of: CpuBusy; DiskShortage, LowMemory, maxJobReached, otherReason; status is set to ‘Failure’.

noValidMeasurementType

Condition: all measurement type or KPI names are invalid (i.e. none of the measurement type or KPI names are valid).

Returned information: output parameter status is set to ‘Failure’.

invalidPriority

Condition: priority is invalid.

Returned Information: Name of the exception; status is set to ‘Failure’.

invalidReliability

Condition: reliability is invalid.

Returned Information: Name of the exception; status is set to ‘Failure’.

lackofMeasurementJobs

Condition: At least one related measurement job is not activated.

Returned Information: Name of the exception and the name(s) of the measurement(s) whose job is not activated; status is set to ‘Failure’.

jobId

M

See subclause 6.1.1.3

It specifies the measurement job to be stopped.

Status

M

ENUM (Success, Failure)

An operation may fail because of a specified or unspecified reason.

unknownJob

Condition: the jobId does not exist.

Returned information: output parameter status is set to ‘Failure’.

jobCannotBeStopped

Condition: the measurement job cannot be stopped.

Returned information: output parameter status is set to ‘Failure’.

jobIdList

M

List of jobId of the measurement jobs

This parameter specifies the criteria to list the measurement jobs.

If the parameter specifies the list of jobId to be retrieved, then the corresponding information of measurement jobs will be returned.

If the parameter contains no information, all the measurement jobs are retrieved.

jobInfoList

M

List of <attributes (refer to input and output parameter of operation createMeasurementJob in clause 6.1.1.2 and clause 6.1.1.3) of measurement job:

– jobId

– iOCName

– iOCInstanceList

– measurementCategoryList

– granularityPeriod

– reportingMethod

– reportingPeriod

– startTime

– stopTime

– streamTarget

– schedule

– priority

– reliability>

Returned information of corresponding Measurement Jobs matching the input criteria. If no match, then the length of the jobInfolist will be 0 (with status == Success).

If the measurement job is created using non-empty iOCInstanceList in createMeasurementJob, then iOCInstanceList here shall contain the DNs of the supported IOC instances.

If the measurement job is created using empty iOCInstanceList, then iOCInstanceList here shall be empty as well.

status

M

ENUM (Success, Failure)

An operation may fail because of a specified or unspecified reason.

invalidJobIdList

Condition: jobIdList specified in the input parameter is valid.

Returned information: output parameter status is set to ‘Failure’.