SOL002-VNFConfiguration-API.json 102 KB
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 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
              "type": "object",
              "required": [
                "status",
                "detail"
              ],
              "properties": {
                "type": {
                  "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
                  "type": "string",
                  "format": "URI"
                },
                "title": {
                  "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type.  It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
                  "type": "string"
                },
                "status": {
                  "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
                  "type": "integer"
                },
                "detail": {
                  "description": "A human-readable explanation specific to this occurrence of the problem.\n",
                  "type": "string"
                },
                "instance": {
                  "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
                  "type": "string",
                  "format": "URI"
                }
              }
            }
          },
          "503": {
            "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
            "headers": {
              "Content-Type": {
                "description": "The MIME type of the body of the response.",
                "type": "string",
                "maximum": 1,
                "minimum": 1
              }
            },
            "schema": {
              "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
              "type": "object",
              "required": [
                "status",
                "detail"
              ],
              "properties": {
                "type": {
                  "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
                  "type": "string",
                  "format": "URI"
                },
                "title": {
                  "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type.  It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
                  "type": "string"
                },
                "status": {
                  "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
                  "type": "integer"
                },
                "detail": {
                  "description": "A human-readable explanation specific to this occurrence of the problem.\n",
                  "type": "string"
                },
                "instance": {
                  "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
                  "type": "string",
                  "format": "URI"
                }
              }
            }
          }
        }
      }
    }
  },
  "definitions": {
    "VnfConfiguration": {
      "description": "This type represents configuration parameters of a VNF instance and its VNFC instances.\n",
      "type": "object",
      "required": [
        "vnfConfigurationData"
      ],
      "properties": {
        "vnfConfigurationData": {
          "description": "This type represents configuration parameters of a VNF instance.\n",
          "type": "object",
          "properties": {
            "extCpConfig": {
              "description": "This type represents configuration parameters of a CP instance.\n",
              "type": "object",
              "required": [
                "cpId",
                "cpdId",
                "addresses"
              ],
              "properties": {
                "cpId": {
                  "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
                  "type": "string"
                },
                "cpdId": {
                  "description": "An identifier that is unique within a VNF descriptor.\n",
                  "type": "string"
                },
                "addresses": {
                  "description": "Network address and port assigned to the CP.\n",
                  "type": "array",
                  "items": {
                    "description": "This type represents configuration parameters of a CP instance address.   *  NOTE 1: Either \"address\" or \"useDynamicAddress\" shall be present.\n   *  NOTE 2: At least one of \"macAddress\" and \"ipAddress\" shall be present.\n",
                    "type": "object",
                    "properties": {
                      "address": {
                        "description": "Network address that has been configured on the CP. See NOTE 1.\n",
                        "type": "object",
                        "properties": {
                          "macAddress": {
                            "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
                            "type": "string",
                            "format": "MAC"
                          },
                          "ipAddress": {
                            "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that  consists of groups of zero to four hexadecimal digits, separated by colons.\n",
                            "type": "string",
                            "format": "IP"
                          }
                        }
                      },
                      "useDynamicAddress": {
                        "description": "Set to true if an address shall be assigned dynamically. Otherwise set to false. The default value shall be false. See NOTE 1.\n",
                        "type": "boolean"
                      },
                      "port": {
                        "description": "The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).\n",
                        "type": "integer"
                      }
                    }
                  }
                }
              }
            },
            "dhcpServer": {
              "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that  consists of groups of zero to four hexadecimal digits, separated by colons.\n",
              "type": "string",
              "format": "IP"
            },
            "vnfSpecificData": {
              "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions  defined in clause 4 of IETF RFC 7159.\n",
              "type": "object"
            }
          }
        },
        "vnfcConfigurationData": {
          "description": "Configuration parameters of the VNFC instances.\n",
          "type": "array",
          "items": {
            "description": "This type represents configuration parameters of a VNFC instance.\n",
            "type": "object",
            "required": [
              "vnfcInstanceId"
            ],
            "properties": {
              "vnfcInstanceId": {
                "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
                "type": "string"
              },
              "intCpConfig": {
                "description": "Configuration parameters for the internal CPs of the VNFC instance.\n",
                "type": "array",
                "items": {
                  "description": "This type represents configuration parameters of a CP instance.\n",
                  "type": "object",
                  "required": [
                    "cpId",
                    "cpdId",
                    "addresses"
                  ],
                  "properties": {
                    "cpId": {
                      "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
                      "type": "string"
                    },
                    "cpdId": {
                      "description": "An identifier that is unique within a VNF descriptor.\n",
                      "type": "string"
                    },
                    "addresses": {
                      "description": "Network address and port assigned to the CP.\n",
                      "type": "array",
                      "items": {
                        "description": "This type represents configuration parameters of a CP instance address.   *  NOTE 1: Either \"address\" or \"useDynamicAddress\" shall be present.\n   *  NOTE 2: At least one of \"macAddress\" and \"ipAddress\" shall be present.\n",
                        "type": "object",
                        "properties": {
                          "address": {
                            "description": "Network address that has been configured on the CP. See NOTE 1.\n",
                            "type": "object",
                            "properties": {
                              "macAddress": {
                                "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
                                "type": "string",
                                "format": "MAC"
                              },
                              "ipAddress": {
                                "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that  consists of groups of zero to four hexadecimal digits, separated by colons.\n",
                                "type": "string",
                                "format": "IP"
                              }
                            }
                          },
                          "useDynamicAddress": {
                            "description": "Set to true if an address shall be assigned dynamically. Otherwise set to false. The default value shall be false. See NOTE 1.\n",
                            "type": "boolean"
                          },
                          "port": {
                            "description": "The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).\n",
                            "type": "integer"
                          }
                        }
                      }
                    }
                  }
                }
              },
              "dhcpServer": {
                "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that  consists of groups of zero to four hexadecimal digits, separated by colons.\n",
                "type": "string",
                "format": "IP"
              },
              "vnfcSpecificData": {
                "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions  defined in clause 4 of IETF RFC 7159.\n",
                "type": "object"
              }
            }
          }
        }
      }
    },
    "VnfConfigModifications": {
      "description": "This type represents request parameters for the \"Set Configuration\" operation.  * NOTE 1: At least one of \"vnfConfigurationData\" and \"vnfcConfigurationData\"\n            shall be present.\n  * NOTE 2: The VnfcConfiguration data type can only be used to modify the configuration\n            of existing VNFC instances.\n",
      "type": "object",
      "properties": {
        "vnfConfigurationData": {
          "description": "This type represents configuration parameters of a VNF instance.\n",
          "type": "object",
          "properties": {
            "extCpConfig": {
              "description": "This type represents configuration parameters of a CP instance.\n",
              "type": "object",
              "required": [
                "cpId",
                "cpdId",
                "addresses"
              ],
              "properties": {
                "cpId": {
                  "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
                  "type": "string"
                },
                "cpdId": {
                  "description": "An identifier that is unique within a VNF descriptor.\n",
                  "type": "string"
                },
                "addresses": {
                  "description": "Network address and port assigned to the CP.\n",
                  "type": "array",
                  "items": {
                    "description": "This type represents configuration parameters of a CP instance address.   *  NOTE 1: Either \"address\" or \"useDynamicAddress\" shall be present.\n   *  NOTE 2: At least one of \"macAddress\" and \"ipAddress\" shall be present.\n",
                    "type": "object",
                    "properties": {
                      "address": {
                        "description": "Network address that has been configured on the CP. See NOTE 1.\n",
                        "type": "object",
                        "properties": {
                          "macAddress": {
                            "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
                            "type": "string",
                            "format": "MAC"
                          },
                          "ipAddress": {
                            "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that  consists of groups of zero to four hexadecimal digits, separated by colons.\n",
                            "type": "string",
                            "format": "IP"
                          }
                        }
                      },
                      "useDynamicAddress": {
                        "description": "Set to true if an address shall be assigned dynamically. Otherwise set to false. The default value shall be false. See NOTE 1.\n",
                        "type": "boolean"
                      },
                      "port": {
                        "description": "The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).\n",
                        "type": "integer"
                      }
                    }
                  }
                }
              }
            },
            "dhcpServer": {
              "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that  consists of groups of zero to four hexadecimal digits, separated by colons.\n",
              "type": "string",
              "format": "IP"
            },
            "vnfSpecificData": {
              "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions  defined in clause 4 of IETF RFC 7159.\n",
              "type": "object"
            }
          }
        },
        "vnfcConfigurationData": {
          "description": "Modifications to configuration data for certain VNFC instances. See NOTE 1 and NOTE 2. If present, the modifications of the \"vnfcConfigurationData\" attribute shall follow these  provisions:  Modifying an attribute that is an array of objects of type \"VnfcConfigurationData\".\n    Assumptions:\n        1) \"oldList\" is the \"VnfcConfigurationData\" array to be modified and \"newList\"\n           is the \"VnfcConfigurationData\" array that contains the changes.\n        2) \"oldEntry\" is an entry in \"oldList\" and \"newEntry\" is an entry in \"newList\".\n        3) A \"newEntry\" has a \"corresponding entry\" if there exists an \"oldEntry\" that \n           has the same content of the \"vnfcInstanceId\" attribute as the \"newEntry\"; \n           a \"newEntry\" has no corresponding entry if no such \"oldEntry\" exists.\n        4) In any array of \"VnfcConfigurationData\" structures, the content of \"vnfcInstanceId\"\n           is unique (i.e. there shall be no two entries with the same content of \"vnfcInstanceId\").\n    Provisions:\n        1) For each \"newEntry\" in \"newList\" that has no corresponding entry in \"oldList\", \n           the \"oldList\" array shall be modified by adding that \"newEntry\".\n\n        2) For each \"newEntry\" in \"newList\" that has a corresponding \"oldEntry\" in \"oldList\",\n           the value of \"oldEntry\" shall be updated with the value of \"newEntry\" according to\n          the rules of JSON Merge PATCH (see IETF RFC 7396 ).\n",
          "type": "array",
          "items": {
            "description": "This type represents configuration parameters of a VNFC instance.\n",
            "type": "object",
            "required": [
              "vnfcInstanceId"
            ],
            "properties": {
              "vnfcInstanceId": {
                "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
                "type": "string"
              },
              "intCpConfig": {
                "description": "Configuration parameters for the internal CPs of the VNFC instance.\n",
                "type": "array",
                "items": {
                  "description": "This type represents configuration parameters of a CP instance.\n",
                  "type": "object",
                  "required": [
                    "cpId",
                    "cpdId",
                    "addresses"
                  ],
                  "properties": {
                    "cpId": {
                      "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
                      "type": "string"
                    },
                    "cpdId": {
                      "description": "An identifier that is unique within a VNF descriptor.\n",
                      "type": "string"
                    },
                    "addresses": {
                      "description": "Network address and port assigned to the CP.\n",
                      "type": "array",
                      "items": {
                        "description": "This type represents configuration parameters of a CP instance address.   *  NOTE 1: Either \"address\" or \"useDynamicAddress\" shall be present.\n   *  NOTE 2: At least one of \"macAddress\" and \"ipAddress\" shall be present.\n",
                        "type": "object",
                        "properties": {
                          "address": {
                            "description": "Network address that has been configured on the CP. See NOTE 1.\n",
                            "type": "object",
                            "properties": {
                              "macAddress": {
                                "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
                                "type": "string",
                                "format": "MAC"
                              },
                              "ipAddress": {
                                "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that  consists of groups of zero to four hexadecimal digits, separated by colons.\n",
                                "type": "string",
                                "format": "IP"
                              }
                            }
                          },
                          "useDynamicAddress": {
                            "description": "Set to true if an address shall be assigned dynamically. Otherwise set to false. The default value shall be false. See NOTE 1.\n",
                            "type": "boolean"
                          },
                          "port": {
                            "description": "The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).\n",
                            "type": "integer"
                          }
                        }
                      }
                    }
                  }
                }
              },
              "dhcpServer": {
                "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that  consists of groups of zero to four hexadecimal digits, separated by colons.\n",
                "type": "string",
                "format": "IP"
              },
              "vnfcSpecificData": {
                "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions  defined in clause 4 of IETF RFC 7159.\n",
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}