Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
description: >-
Values for the collection of logged NFV-MANO service interface messages. Shall be
present if loggingType="MESSAGES".
type: object
$ref: "#/components/schemas/LoggingJobMessagesCriteria"
servicesLogDetail:
description: >-
Values for the collection of logged NFV-MANO service messages. Shall be present if loggingType="SERVICES".
type: object
$ref: "#/components/schemas/LoggingJobServicesCriteria"
systemLogDetail:
description: >-
Values for the collection of logged messages about the NFV-MANO functional entity’s system.
Shall be present if loggingType="SYSTEM".
type: object
$ref: "#/components/schemas/LoggingJobSystemCriteria"
LoggingJobMessagesCriteria:
description: >-
This type represents criteria for logging jobs to collect logged messages on NFV-MANO service interfaces.
It shall comply with the provisions defined in table 8.6.3.3-1.
type: object
required:
- direction
properties:
direction:
description: >-
The direction of the interface messages to match.
Permitted values:
- IN: input messages into the interface.
- OUT: output messages from the interface.
- ALL: both input and output messages into/from the interface.
type: string
enum: [IN, OUT,ALL]
matchingPatterns:
description: >-
Patterns to be matched in the interface message. If provided, only messages that match all the
values provided in the sub-attributes shall be logged. An API consumer can provide more than one
"matchingPattern" if combinations of patterns are to be considered to match diverse sets of interface
messages.
type: array
items:
type: object
anyOf:
- required:
- srcIpAddress
- required:
- dstIpAddress
- required:
- requestMethod
- required:
- requestUriPattern
- required:
- responseCodes
properties:
srcIpAddress:
description: >-
IP address to match the source IP address of request messages to log. The API producer
shall support this attribute.
$ref: '../definitions/SOL009_def.yaml#/definitions/IpAddress'
requestMethod:
description: >-
HTTP request method to be matched. To match, the HTTP request method of the message shall be the
same as the value of this attribute. Valid values are specified in IETF RFC 7231. The API producer
shall support this attribute.
type: string
requestUriPattern:
description: >-
Substring to be matched in the request URI. To match, the request URI shall include the value of
this attribute as a substring. This is typically used to match messages which associate to RESTful
resources, or to a specific API (e.g., by using the "apiName" of the API). The API producer shall
support this attribute.
type: string
dstIpAddress:
description: >-
IP address to match the destination IP address of response messages to log. The API
producer shall support this attribute
$ref: '../definitions/SOL009_def.yaml#/definitions/IpAddress'
responseCodes:
description: >-
HTTP response codes or patterns to match. A list of all valid HTTP response codes and their
specification documents can be obtained from the HTTP status code registry. In addition,
if supported, the following patterns may be used (case-insensitive):
- "1XX": for matching any kind of informational response.
- "2XX": for matching any kind of success response.
- "3XX": for matching any kind redirection response.
- "4XX": for matching any kind of client error response.
- "5XX": for matching any kind of server error response.
The API producer shall support this attribute
type: array
items:
type: string
headerField:
description: >-
Name of the header field to be matched. The header field name shall be one of the supported fields
in a request message as defined in clause 4.2.2 of ETSI GS NFV-SOL 013 or in a response message
as defined in clause 4.2.3 of ETSI GS NFV-SOL 013, in accordance with the "direction" criteria
input.
The API producer may support this attribute.
type: string
headerValue:
description: >-
Value in the header to be matched. To match, the value in the header field indicated by
"headerField" shall be the same as in this attribute. Shall be provided if a "headerField"
is provided. The API producer may support this attribute.
type: string
bodyValues:
description: >-
A list of strings to be matched in the body part of the interface message (e.g., the body of an
HTTP message). If provided, only messages with text in the body part containing all the values from
the list shall match the filter. In addition to a matching filter for the body of the message, a
corresponding "headerField" filter shall also be provided, with "headerField" set to "Content-Type",
to restrict matching to appropriate textual payloads such as "application/json" or "text/plain".
The API producer may support this attribute
type: string
LoggingJobServicesCriteria:
description: >-
This type represents criteria for logging jobs to collect logged messages about processes pertaining
to NFV-MANO services. It shall comply with the provisions defined in table 8.6.3.4-1.
type: object
properties:
logGarbageCollection:
description: >-
Indicates to collect logged information about garbage collection processes associated to NFV-MANO services.
type: boolean
LoggingJobSystemCriteria:
description: >-
This type represents criteria for logging jobs to collect logged system events of the NFV-MANO functional
entity. It shall comply with the provisions defined in table 8.6.3.5-1.
type: object
required:
- systemLogs
- severityLevel
properties:
systemLogs:
description: >-
Values for the provider enabled system logs.
$ref: "../definitions/SOL009_def.yaml#/definitions/KeyValuePairs"
severityLevelScheme:
description: >-
Identifies a severity level scheme.
The default value is "rfc5424", which represents the set of values specified in the clause 6.2.1,
table 2 of IETF RFC 5424. Other values may be used to signal different schemes.
type: string
severityLevel:
description: >-
The severity level, which determines the severity of the system messages to collect. The NFV-MANO
functional entity shall collect system log messages, as indicated by the "systemLogs" attribute,
with severity levels lower (i.e., more severe) or equal to the value provided by this present attribute.
type: number
LoggingJobConfig:
description: >-
This type represents configuration data for a logging job. It shall comply with the provisions
defined in table 8.6.3.6-1.
NOTE: The present document version does not specify the support for "log compilation and reporting based
on events" as specified in clause 6.6.2.2 of ETSI GS NFV-IFA 031.
type: object
required:
- reportingCondition
- securityConf
properties:
startTime:
description: >-
Specifies the time for the logging job to be started. If not provided, the logging job is
requested to start immediately.
$ref: "../definitions/SOL009_def.yaml#/definitions/DateTime"
endTime:
description: >-
Specifies the time after which the logging job will stop. Shall only be provided if the
logging job is requested to stop at a specific time.
$ref: "../definitions/SOL009_def.yaml#/definitions/DateTime"
reportingCondition:
description: >-
Specifies the condition under which the producer will report to the consumer about the compiled log data.
required:
- reportingType
properties:
reportingType:
description: >-
Specifies the type of reporting condition.
Permitted values:
- REPORTING_ON_COMPILATION: the producer shall notify the consumer once the compilation of the
collected logging data into a file is completed and a new log report is available.
- NO_REPORTING: no reporting is requested (the consumer can query the logging jobs to know about the
availability of new log reports).
type: string
enum: [REPORTING_ON_COMPILATION, NO_REPORTING]
minimumReportingPeriod:
description: >-
Specifies the minimum periodicity at which the producer will report to the consumer about the
collected log information, in seconds.
type: integer
format: int32
compileBySizeValue:
description: >-
An indicative size threshold for compiling the collected log data, in bytes. It is used when the
compilation is based on the size of the collected log data. If not present, a default value as
specified with the "defaultLogCompileBySizeValue" configuration in the "ManoEntityConfigurableParams"
shall be used
type: integer
format: int32
compileByTimerValue:
description: >-
The periodicity threshold for compiling the filtered log, in seconds. It is used when the compilation
is based on a timer (e.g., every 24 hours). If not present, a default value as specified with the
"defaultLogCompileByTimerValue" configuration in the "ManoEntityConfigurableParams" shall be used
type: integer
format: int32
securityConf:
description: >-
Configuration about the security aspects of the logging job.
type: object
properties:
logFileEncryption:
description: >-
Information about the encryption of the compiled log files. Shall be present if the log
file is requested to be encrypted.
required:
- encryptionCertificate
- cipherAlgorithm
type: object
properties:
encryptionCertificate:
description: >-
X.509 certificate with the public key to use for the encryption of the compiled log file.
type: String
cipherAlgorithm:
description: >-
Cryptographic algorithm to be used for the encryption of the compiled log file. More than
one algorithm can be provided from higher (lower array index) to lower (higher array index)
precedence. Valid values are: "AES-CBC-128", "AES-GCM-128", "AES-CBC-256", and "AES-GCM-256",
as specified in clause 6.5 of ETSI GS NFV-SEC 012
type: array
items:
type: string
minItems: 1
encryptAndSignOrder:
description: >-
Indication about the order in signing and encrypting the compiled log file. Valid values are:
"encryptFirst", to apply the order "first encrypt, then sign", and "signFirst" for the order
"first sign, then encrypt". Default value is "encryptFirst".
type: string
logTransferSecurity:
description: >-
Information about the security measures for retrieving/accessing the compiled log files.
type: object
properties:
publicKey:
description: >-
The public key of the API consumer used for the client authentication with the file server.
Shall be provided if required by the type of transfer protocol. May be omitted if the key has
been provided to the API producer by other means, or if it has already been provided in some
previous CreateLoggingJobRequest issued by the same API consumer, whose public key has not changed.
type: string