docs/ONAP release 2 spec/im/MonitoringParameter.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

.. Copyright 2018 (Huawei)
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

Class: MonitoringParameter
============================

+-------------------+-------------+------------------+-----------------+---------------+
| **Attribute       | **Type**    | **Multiplicity** | **Description** | **Applied     |
| Name**            |             |                  |                 | Stereotypes** |
+===================+=============+==================+=================+===============+
| id                | Identifier  | 1                | Unique          | support:      |
|                   |             |                  | identifier      | MANDATORY     |
|                   |             |                  | of the          |               |
|                   |             |                  | monitoring      |               |
|                   |             |                  | parameter.      |               |
+-------------------+-------------+------------------+-----------------+---------------+
| name              | String      | 0..1             | Human           | support:      |
|                   |             |                  | readable        | MANDATORY     |
|                   |             |                  | name of the     |               |
|                   |             |                  | monitoring      |               |
|                   |             |                  | parameter.      |               |
+-------------------+-------------+------------------+-----------------+---------------+
| performanceMetric | String      | 1                | Identifies      | support:      |
|                   |             |                  | the             | MANDATORY     |
|                   |             |                  | virtualised     |               |
|                   |             |                  | resource        |               |
|                   |             |                  | performance     |               |
|                   |             |                  | metric.         |               |
+-------------------+-------------+------------------+-----------------+---------------+
| collectionPeriod  | Not         | 0..1             | An              | support:      |
|                   | specified   |                  | attribute       | MANDATORY     |
|                   |             |                  | that            |               |
|                   | Editor's    |                  | describes       |               |
|                   | note: need  |                  | the             |               |
|                   | to be       |                  | recommended     |               |
|                   | specified   |                  | periodicity     |               |
|                   |             |                  | at which to     |               |
|                   |             |                  | collect the     |               |
|                   |             |                  | performance     |               |
|                   |             |                  | information.    |               |
|                   |             |                  |                 |               |
|                   |             |                  | VNFM            |               |
|                   |             |                  | determines      |               |
|                   |             |                  | if this         |               |
|                   |             |                  | parameter       |               |
|                   |             |                  | is              |               |
|                   |             |                  | considered.     |               |
|                   |             |                  |                 |               |
|                   |             |                  | The vendor      |               |
|                   |             |                  | may provide     |               |
|                   |             |                  | this            |               |
|                   |             |                  | information     |               |
|                   |             |                  | as a            |               |
|                   |             |                  | guidance        |               |
|                   |             |                  | for             |               |
|                   |             |                  | creating        |               |
|                   |             |                  | PmJobs if       |               |
|                   |             |                  | needed.         |               |
|                   |             |                  |                 |               |
|                   |             |                  | NOTE: The       |               |
|                   |             |                  | MANO or         |               |
|                   |             |                  | NFVI may        |               |
|                   |             |                  | not support     |               |
|                   |             |                  | the             |               |
|                   |             |                  | recommended     |               |
|                   |             |                  | collectionPeriod|               |
|                   |             |                  | based on        |               |
|                   |             |                  | their           |               |
|                   |             |                  | functionalities,|               |
|                   |             |                  | and can         |               |
|                   |             |                  | reject the      |               |
|                   |             |                  | requests        |               |
|                   |             |                  | based on        |               |
|                   |             |                  | the             |               |
|                   |             |                  | recommended     |               |
|                   |             |                  | collectionPeriod|               |
|                   |             |                  | in this         |               |
|                   |             |                  | case.           |               |
+-------------------+-------------+------------------+-----------------+---------------+