openapi: 3.0.0 info: title: adapter-etsi_sol005 contact: {} version: '1.0.0' servers: - url: https://{defaultHost} variables: defaultHost: default: www.example.com paths: /nsd/v2/api_versions: get: summary: getApiVersions description: '' operationId: getApiVersions parameters: [] responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsdV2ApiVersionsResponse' - description: > This type represents API version information. deprecated: false /nsd/v2/ns_descriptors: post: summary: postNsDescriptors description: '' operationId: postNsDescriptors parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsdV2NsDescriptorsResponse' - description: > This type represents a response for the query NSD operation. deprecated: false get: summary: getNsDescriptors description: '' operationId: getNsDescriptors parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: allFields in: query description: '' style: form explode: true schema: type: string - name: fields in: query description: '' style: form explode: true schema: type: string - name: excludeFields in: query description: '' style: form explode: true schema: type: string - name: excludeDefault in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NsdV2NsDescriptorsResponse' description: '' deprecated: false /nsd/v2/ns_descriptors/{nsdInfoId}: get: summary: getNsDescriptorsNsdInfoId description: '' operationId: getNsDescriptorsNsdInfoId parameters: - name: nsdInfoId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsdV2NsDescriptorsResponse' - description: > This type represents a response for the query NSD operation. deprecated: false patch: summary: patchNsDescriptorsNsdInfoId description: '' operationId: patchNsDescriptorsNsdInfoId parameters: - name: nsdInfoId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsdV2NsDescriptorsResponse3' - description: > This type represents attribute modifications for an individual NS descriptor resource based on the NsdInfo data type. The attributes of NsdInfo that can be modified are included in the NsdInfoModifications data type.NOTE: At least one of the attributes - nsdOperationalState and userDefinedData - shall be present. deprecated: false delete: summary: deleteNsDescriptorsNsdInfoId description: '' operationId: deleteNsDescriptorsNsdInfoId parameters: - name: nsdInfoId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/ns_descriptors/{nsdInfoId}/nsd_content: get: summary: getNsDescriptorsNsdInfoIdNsdContent description: '' operationId: getNsDescriptorsNsdInfoIdNsdContent parameters: - name: nsdInfoId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: putNsDescriptorsNsdInfoIdNsdContent description: '' operationId: putNsDescriptorsNsdInfoIdNsdContent parameters: - name: nsdInfoId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/ns_descriptors/{nsdInfoId}/nsd: get: summary: getNsDescriptorsNsdInfoIdNsd description: '' operationId: getNsDescriptorsNsdInfoIdNsd parameters: - name: nsdInfoId in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/ns_descriptors/{nsdInfoId}/manifest: get: summary: getNsDescriptorsNsdInfoIdManifest description: '' operationId: getNsDescriptorsNsdInfoIdManifest parameters: - name: nsdInfoId in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}: get: summary: getNsDescriptorsNsdInfoIdArtifactsArtifactPath description: '' operationId: getNsDescriptorsNsdInfoIdArtifactsArtifactPath parameters: - name: nsdInfoId in: path description: '' required: true style: simple schema: type: string - name: artifactPath in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/pnf_descriptors: post: summary: postPnfDescriptors description: '' operationId: postPnfDescriptors parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsdV2PnfDescriptorsResponse' - description: > This type represents a response for the query PNFD operation. deprecated: false get: summary: getPnfDescriptors description: '' operationId: getPnfDescriptors parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: allFields in: query description: '' style: form explode: true schema: type: string - name: fields in: query description: '' style: form explode: true schema: type: string - name: excludeFields in: query description: '' style: form explode: true schema: type: string - name: excludeDefault in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NsdV2PnfDescriptorsResponse' description: > Information about zero or more PNF descriptors. The response body shall contain a representation in an array the representations of zero or more PNF descriptors, as defined in clause 5.5.2.2. If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. deprecated: false /nsd/v2/pnf_descriptors/{pnfdInfoId}: get: summary: getPnfDescriptorsPnfdInfoId description: '' operationId: getPnfDescriptorsPnfdInfoId parameters: - name: pnfdInfoId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsdV2PnfDescriptorsResponse' - description: > This type represents a response for the query PNFD operation. deprecated: false patch: summary: patchPnfDescriptorsPnfdInfoId description: '' operationId: patchPnfDescriptorsPnfdInfoId parameters: - name: pnfdInfoId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsdV2PnfDescriptorsResponse3' - description: > This type represents attribute modifications for an individual PNF descriptor resource based on the "PnfdInfo" data type. The attributes of "PnfdInfo" that can be modified are included in the "PnfdInfoModifications" data type. deprecated: false delete: summary: deletePnfDescriptorsPnfdInfoId description: '' operationId: deletePnfDescriptorsPnfdInfoId parameters: - name: pnfdInfoId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/pnf_descriptors/{pnfdInfoId}/pnfd_content: get: summary: getPnfDescriptorsPnfdInfoIdPnfdContent description: '' operationId: getPnfDescriptorsPnfdInfoIdPnfdContent parameters: - name: pnfdInfoId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: putPnfDescriptorsPnfdInfoIdPnfdContent description: '' operationId: putPnfDescriptorsPnfdInfoIdPnfdContent parameters: - name: pnfdInfoId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/pnf_descriptors/{pnfdInfoId}/pnfd: get: summary: getPnfDescriptorsPnfdInfoIdPnfd description: '' operationId: getPnfDescriptorsPnfdInfoIdPnfd parameters: - name: pnfdInfoId in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/pnf_descriptors/{pnfdInfoId}/manifest: get: summary: getPnfDescriptorsPnfdInfoIdManifest description: '' operationId: getPnfDescriptorsPnfdInfoIdManifest parameters: - name: pnfdInfoId in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/pnf_descriptors/{pnfdInfoId}/artifacts/{artifactPath}: get: summary: getPnfDescriptorsPnfdInfoIdArtifactsArtifactPath description: '' operationId: getPnfDescriptorsPnfdInfoIdArtifactsArtifactPath parameters: - name: pnfdInfoId in: path description: '' required: true style: simple schema: type: string - name: artifactPath in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsd/v2/subscriptions: post: summary: postSubscriptions description: '' operationId: postSubscriptions parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsdV2SubscriptionsResponse' - description: > This type represents a subscription related to notifications about NSD management. deprecated: false get: summary: getSubscriptions description: '' operationId: getSubscriptions parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NsdV2SubscriptionsResponse' description: > The list of subscriptions was queried successfully. The response body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method, i.e., zero or more representations of NSD management subscriptions as defined in clause 5.5.2.8. If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. deprecated: false /nsd/v2/subscriptions/{subscriptionId}: get: summary: getSubscriptionsSubscriptionId description: '' operationId: getSubscriptionsSubscriptionId parameters: - name: subscriptionId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsdV2SubscriptionsResponse' - description: > This type represents a subscription related to notifications about NSD management. deprecated: false delete: summary: deleteSubscriptionsSubscriptionId description: '' operationId: deleteSubscriptionsSubscriptionId parameters: - name: subscriptionId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nsfm/v1/alarms: get: summary: getAlarms description: '' operationId: getAlarms parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NsfmV1AlarmsResponse' description: '' deprecated: false /nsfm/v1/alarms/{alarmId}: get: summary: getAlarmsAlarmId description: '' operationId: getAlarmsAlarmId parameters: - name: alarmId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsfmV1AlarmsResponse' - description: > The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in Table 8.5.2.4-1 deprecated: false patch: summary: patchAlarmsAlarmId description: '' operationId: patchAlarmsAlarmId parameters: - name: alarmId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NsfmV1AlarmsResponse2' - description: > This type represents attribute modifications for an "Individual alarm" resource, i.e. modifications to a resource representation based on the "Alarm" data type. The attributes of "Alarm" that can be modified according to the provisions in clause 8.5.2.4 are included in the "AlarmModifications" data type. The "AlarmModifications" data type shall comply with the provisions defined in Table 8.5.2.8-1. deprecated: false /vnfpkgm/v2/vnf_packages: get: summary: getVnfPackages description: '' operationId: getVnfPackages parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: allFields in: query description: '' style: form explode: true schema: type: string - name: fields in: query description: '' style: form explode: true schema: type: string - name: excludeFields in: query description: '' style: form explode: true schema: type: string - name: excludeDefault in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/VnfpkgmV2VnfPackagesResponse' description: '' deprecated: false post: summary: postVnfPackages description: '' operationId: postVnfPackages parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/VnfpkgmV2VnfPackagesResponse' deprecated: false /vnfpkgm/v2/vnf_packages/{vnfPkgId}: get: summary: getVnfPackagesVnfPkgId description: '' operationId: getVnfPackagesVnfPkgId parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/VnfpkgmV2VnfPackagesResponse' deprecated: false delete: summary: deleteVnfPackagesVnfPkgId description: '' operationId: deleteVnfPackagesVnfPkgId parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false patch: summary: patchVnfPackagesVnfPkgId description: '' operationId: patchVnfPackagesVnfPkgId parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/VnfpkgmV2VnfPackagesResponse3' - description: > This type represents modifications to the information of a VNF package. It shall comply with the provisions defined in Table 9.5.2.3-1. deprecated: false /vnfpkgm/v2/vnf_packages/{vnfPkgId}/vnfd: get: summary: getVnfPackagesVnfPkgIdVnfd description: '' operationId: getVnfPackagesVnfPkgIdVnfd parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfpkgm/v2/vnf_packages/{vnfPkgId}/ext_artifacts_access: get: summary: getVnfPackagesVnfPkgIdExtArtifactsAccess description: '' operationId: getVnfPackagesVnfPkgIdExtArtifactsAccess parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/VnfpkgmV2VnfPackagesExtArtifactsAccessResponse' - description: > This type represents the access configuration information for downloading external VNF package artifacts. The NFVO can obtain the external VNF package artifact file through the information provided in this structure, together with information provided in the manifest / VNFD. The data structure shall comply with the provisions defined in Table 9.5.2.10-1. If the data structure is part of a response body, security-sensitive attributes shall be excluded as specified in Table 9.5.2.10-1. deprecated: false put: summary: putVnfPackagesVnfPkgIdExtArtifactsAccess description: '' operationId: putVnfPackagesVnfPkgIdExtArtifactsAccess parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/VnfpkgmV2VnfPackagesExtArtifactsAccessResponse' - description: > This type represents the access configuration information for downloading external VNF package artifacts. The NFVO can obtain the external VNF package artifact file through the information provided in this structure, together with information provided in the manifest / VNFD. The data structure shall comply with the provisions defined in Table 9.5.2.10-1. If the data structure is part of a response body, security-sensitive attributes shall be excluded as specified in Table 9.5.2.10-1. deprecated: false /vnfpkgm/v2/vnf_packages/{vnfPkgId}/manifest: get: summary: getVnfPackagesVnfPkgIdManifest description: '' operationId: getVnfPackagesVnfPkgIdManifest parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfpkgm/v2/vnf_packages/{vnfPkgId}/package_content: get: summary: getVnfPackagesVnfPkgIdPackageContent description: '' operationId: getVnfPackagesVnfPkgIdPackageContent parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: putVnfPackagesVnfPkgIdPackageContent description: '' operationId: putVnfPackagesVnfPkgIdPackageContent parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfpkgm/v2/vnf_packages/{vnfPkgId}/artifacts: get: summary: getVnfPackagesVnfPkgIdArtifacts description: '' operationId: getVnfPackagesVnfPkgIdArtifacts parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string - name: excludeAllManoArtifacts in: query description: '' style: form explode: true schema: type: string - name: excludeAllNonManoArtifacts in: query description: '' style: form explode: true schema: type: string - name: selectNonManoArtifactSets in: query description: '' style: form explode: true schema: type: string - name: includeExternalArtifacts in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfpkgm/v2/vnf_packages/{vnfPkgId}/package_content/upload_from_uri: post: summary: postVnfPackagesVnfPkgIdPackageContentUploadFromUri description: '' operationId: postVnfPackagesVnfPkgIdPackageContentUploadFromUri parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfpkgm/v2/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}: get: summary: getVnfPackagesVnfPkgIdArtifactsArtifactPath description: '' operationId: getVnfPackagesVnfPkgIdArtifactsArtifactPath parameters: - name: vnfPkgId in: path description: '' required: true style: simple schema: type: string - name: artifactPath in: path description: '' required: true style: simple schema: type: string - name: includeSignatures in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nspm/v2/pm_jobs: post: summary: postPmJobs description: '' operationId: postPmJobs parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NspmV2PmJobsResponse' - description: > This type represents a PM job. deprecated: false get: summary: getPmJobs description: '' operationId: getPmJobs parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: allFields in: query description: '' style: form explode: true schema: type: string - name: fields in: query description: '' style: form explode: true schema: type: string - name: excludeFields in: query description: '' style: form explode: true schema: type: string - name: excludeDefault in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NspmV2PmJobsResponse' description: '' deprecated: false /nspm/v2/pm_jobs/{pmJobId}: get: summary: getPmJobsPmJobId description: '' operationId: getPmJobsPmJobId parameters: - name: pmJobId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NspmV2PmJobsResponse' - description: > This type represents a PM job. deprecated: false patch: summary: patchPmJobsPmJobId description: '' operationId: patchPmJobsPmJobId parameters: - name: pmJobId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NspmV2PmJobsResponse3' - description: > This type represents modifications to a PM job. It shall comply with the provisions defined in Table 7.5.2.12-1. deprecated: false delete: summary: deletePmJobsPmJobId description: '' operationId: deletePmJobsPmJobId parameters: - name: pmJobId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nspm/v2/pm_jobs/{pmJobId}/reports/{reportId}: get: summary: getPmJobsPmJobIdReportsReportId description: '' operationId: getPmJobsPmJobIdReportsReportId parameters: - name: pmJobId in: path description: '' required: true style: simple schema: type: string - name: reportId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NspmV2PmJobsReportsResponse' - description: > This type defines the format of a performance report provided by the NFVO to the OSS/BSS as a result of collecting performance information as part of a PM job. The type shall comply with the provisions defined in Table 7.5.2.10-1. deprecated: false /nspm/v2/thresholds: post: summary: postThresholds description: '' operationId: postThresholds parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NspmV2ThresholdsResponse' - description: > This type represents a threshold. deprecated: false get: summary: getThresholds description: '' operationId: getThresholds parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NspmV2ThresholdsResponse' description: '' deprecated: false /nspm/v2/thresholds/{thresholdId}: get: summary: getThresholdsThresholdId description: '' operationId: getThresholdsThresholdId parameters: - name: thresholdId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NspmV2ThresholdsResponse' - description: > This type represents a threshold. deprecated: false patch: summary: patchThresholdsThresholdId description: '' operationId: patchThresholdsThresholdId parameters: - name: thresholdId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NspmV2ThresholdsResponse3' - description: > This type represents modifications to a threshold. It shall comply with the provisions defined in Table 7.5.2.11-1. deprecated: false delete: summary: deleteThresholdsThresholdId description: '' operationId: deleteThresholdsThresholdId parameters: - name: thresholdId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nfvici/v1/nfvi_capacity_infos: get: summary: getNfviCapacityInfos description: '' operationId: getNfviCapacityInfos parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: allFields in: query description: '' style: form explode: true schema: type: string - name: fields in: query description: '' style: form explode: true schema: type: string - name: excludeFields in: query description: '' style: form explode: true schema: type: string - name: excludeDefault in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NfviciV1NfviCapacityInfosResponse' description: '' deprecated: false /nfvici/v1/nfvi_capacity_infos/{vimId}: get: summary: getNfviCapacityInfosVimId description: '' operationId: getNfviCapacityInfosVimId parameters: - name: vimId in: path description: '' required: true style: simple schema: type: string - name: filter in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NfviciV1NfviCapacityInfosResponse' - description: > This type defines the format of the NFVI capacity information. The type shall comply with the provisions defined in Table 10.5.2.4-1. deprecated: false /nfvici/v1/capacity_thresholds: get: summary: getCapacityThresholds description: '' operationId: getCapacityThresholds parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NfviciV1CapacityThresholdsResponse' description: '' deprecated: false post: summary: postCapacityThresholds description: '' operationId: postCapacityThresholds parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NfviciV1CapacityThresholdsResponse' - description: > This type represents a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1. deprecated: false /nfvici/v1/capacity_thresholds/{capacityThresholdId}: get: summary: getCapacityThresholdsCapacityThresholdId description: '' operationId: getCapacityThresholdsCapacityThresholdId parameters: - name: capacityThresholdId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NfviciV1CapacityThresholdsResponse' - description: > This type represents a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1. deprecated: false patch: summary: patchCapacityThresholdsCapacityThresholdId description: '' operationId: patchCapacityThresholdsCapacityThresholdId parameters: - name: capacityThresholdId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/NfviciV1CapacityThresholdsResponse3' - description: > This type represents modifications to a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1. deprecated: false delete: summary: deleteCapacityThresholdsCapacityThresholdId description: '' operationId: deleteCapacityThresholdsCapacityThresholdId parameters: - name: capacityThresholdId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfsnapshotpkgm/v1/vnf_snapshot_packages: post: summary: postVnfSnapshotPackages description: '' operationId: postVnfSnapshotPackages parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/VnfsnapshotpkgmV1VnfSnapshotPackagesResponse' - description: > This type represents the information of a VNF snapshot package. It shall comply with the provisions defined in table 11.5.2.3-1. deprecated: false get: summary: getVnfSnapshotPackages description: '' operationId: getVnfSnapshotPackages parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: allFields in: query description: '' style: form explode: true schema: type: string - name: fields in: query description: '' style: form explode: true schema: type: string - name: excludeFields in: query description: '' style: form explode: true schema: type: string - name: excludeDefault in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/VnfsnapshotpkgmV1VnfSnapshotPackagesResponse' description: '' deprecated: false /vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}: get: summary: getVnfSnapshotPackagesVnfSnapshotPkgId description: '' operationId: getVnfSnapshotPackagesVnfSnapshotPkgId parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/VnfsnapshotpkgmV1VnfSnapshotPackagesResponse' - description: > This type represents the information of a VNF snapshot package. It shall comply with the provisions defined in table 11.5.2.3-1. deprecated: false patch: summary: patchVnfSnapshotPackagesVnfSnapshotPkgId description: '' operationId: patchVnfSnapshotPackagesVnfSnapshotPkgId parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/VnfsnapshotpkgmV1VnfSnapshotPackagesResponse3' - description: > This type represents modifications to the information of a VNF snapshot package. It shall comply with the provisions defined in table 11.5.2.4-1. deprecated: false delete: summary: deleteVnfSnapshotPackagesVnfSnapshotPkgId description: '' operationId: deleteVnfSnapshotPackagesVnfSnapshotPkgId parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content: get: summary: getVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent description: '' operationId: getVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: putVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent description: '' operationId: putVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/upload_from_uri: post: summary: postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentUploadFromUri description: '' operationId: postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentUploadFromUri parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/build: post: summary: postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentBuild description: '' operationId: postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentBuild parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/extract: post: summary: postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentExtract description: '' operationId: postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentExtract parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/cancel: post: summary: postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentCancel description: '' operationId: postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentCancel parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/ext_artifacts_access: get: summary: getVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess description: '' operationId: getVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: putVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess description: '' operationId: putVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/artifacts/{artifactPath}: get: summary: getVnfSnapshotPackagesVnfSnapshotPkgIdArtifactsArtifactPath description: '' operationId: getVnfSnapshotPackagesVnfSnapshotPkgIdArtifactsArtifactPath parameters: - name: vnfSnapshotPkgId in: path description: '' required: true style: simple schema: type: string - name: artifactPath in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_instances: get: summary: querymultipleNSinstances description: '' operationId: querymultipleNSinstances parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: allFields in: query description: '' style: form explode: true schema: type: string - name: fields in: query description: '' style: form explode: true schema: type: string - name: excludeFields in: query description: '' style: form explode: true schema: type: string - name: excludeDefault in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NsInstancesResponse' description: '' deprecated: false post: summary: createaNSinstanceresource description: '' operationId: createaNSinstanceresource parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_instances/{nsInstanceId}: get: summary: readanindividualNSinstanceresource description: '' operationId: readanindividualNSinstanceresource parameters: - name: nsInstanceId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: deleteNSinstanceresource description: '' operationId: deleteNSinstanceresource parameters: - name: nsInstanceId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_instances/{nsInstanceId}/instantiate: post: summary: instantiateaNS description: '' operationId: instantiateaNS parameters: - name: nsInstanceId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_instances/{nsInstanceId}/scale: post: summary: scaleaNSinstance description: '' operationId: scaleaNSinstance parameters: - name: nsInstanceId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_instances/{nsInstanceId}/update: post: summary: updatesaNSinstance description: '' operationId: updatesaNSinstance parameters: - name: nsInstanceId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_instances/{nsInstanceId}/heal: post: summary: healaNSinstance description: '' operationId: healaNSinstance parameters: - name: nsInstanceId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_instances/{nsInstanceId}/terminate: post: summary: terminateaNSinstance description: '' operationId: terminateaNSinstance parameters: - name: nsInstanceId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_lcm_op_occs: get: summary: querymultipleNSLCMoperationoccurrences description: '' operationId: querymultipleNSLCMoperationoccurrences parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: fields in: query description: '' style: form explode: true schema: type: string - name: excludeFields in: query description: '' style: form explode: true schema: type: string - name: excludeDefault in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/NsLcmOpOccsResponse' description: '' deprecated: false /nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}: get: summary: readanindividualNSLCMoperationoccurrenceresource description: '' operationId: readanindividualNSLCMoperationoccurrenceresource parameters: - name: nsLcmOpOccId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/retry: post: summary: retryaNSlifecyclemanagementoperationoccurrence description: '' operationId: retryaNSlifecyclemanagementoperationoccurrence parameters: - name: nsLcmOpOccId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/rollback: post: summary: rollbackaNSlifecyclemanagementoperationoccurrence description: '' operationId: rollbackaNSlifecyclemanagementoperationoccurrence parameters: - name: nsLcmOpOccId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/continue: post: summary: continueaNSlifecyclemanagementoperationoccurrence description: '' operationId: continueaNSlifecyclemanagementoperationoccurrence parameters: - name: nsLcmOpOccId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail: post: summary: markaNSlifecyclemanagementoperationoccurrenceasfailed description: '' operationId: markaNSlifecyclemanagementoperationoccurrenceasfailed parameters: - name: nsLcmOpOccId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel: post: summary: cancelaNSlifecyclemanagementoperationoccurrence description: '' operationId: cancelaNSlifecyclemanagementoperationoccurrence parameters: - name: nsLcmOpOccId in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /nslcm/v1/vnf_snapshots: get: summary: queryVNFsnapshots description: '' operationId: queryVNFsnapshots parameters: - name: filter in: query description: '' style: form explode: true schema: type: string - name: allFields in: query description: '' style: form explode: true schema: type: string - name: fields in: query description: '' style: form explode: true schema: type: string - name: excludeFields in: query description: '' style: form explode: true schema: type: string - name: excludeDefault in: query description: '' style: form explode: true schema: type: string - name: nextpageOpaqueMarker in: query description: '' style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/VnfSnapshotsResponse' description: '' deprecated: false /nslcm/v1/vnf_snapshots/{vnfSnapshotInfoId}: get: summary: queryanIndividualVNFsnapshot description: '' operationId: queryanIndividualVNFsnapshot parameters: - name: vnfSnapshotInfoId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: deleteanIndividualVNFsnapshot description: '' operationId: deleteanIndividualVNFsnapshot parameters: - name: vnfSnapshotInfoId in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false components: schemas: NsdV2ApiVersionsResponse: title: NsdV2ApiVersionsResponse required: - uriPrefix - apiVersions type: object properties: uriPrefix: type: string description: Specifies the URI prefix for the API, in the following form {apiRoot}/{apiName}/{apiMajorVersion}/. apiVersions: type: array items: $ref: '#/components/schemas/ApiVersion' description: Version(s) supported for the API signalled by the uriPrefix attribute. description: This type represents API version information. ApiVersion: title: ApiVersion required: - version type: object properties: version: type: string description: Identifies a supported version. The value of the version attribute shall be a version identifier as specified in clause 4.6.1. isDeprecated: type: boolean description: The Boolean is a data type having two values (TRUE and FALSE). retirementDate: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' NsdV2NsDescriptorsResponse: title: NsdV2NsDescriptorsResponse required: - id - nsdOnboardingState - nsdOperationalState - nsdUsageState - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. nsdId: type: string description: An identifier with the intention of being globally unique. nsdName: type: string description: Name of the on boarded NSD. This information is copied from the NSD content and shall be present after the NSD content is on-boarded. nsdVersion: type: string description: 'A Version. Representation: string of variable length.' nsdDesigner: type: string description: Designer of the on-boarded NSD. This information is copied from the NSD content and shall be present after the NSD content is on-boarded. nsdInvariantId: type: string description: An identifier with the intention of being globally unique. vnfPkgIds: type: array items: type: string description: Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource. pnfdInfoIds: type: array items: type: string description: Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource. nestedNsdInfoIds: type: array items: type: string description: Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource. archiveSecurityOption: allOf: - $ref: '#/components/schemas/ArchiveSecurityOption' - description: 'Signals the security option used by the NSD archive as defined in clause 5.1 of ETSI GS NFV SOL 007. Valid values: OPTION_1, OPTION_2' signingCertificate: type: string description: A string as defined in IETF RFC 8259. artifacts: type: array items: $ref: '#/components/schemas/Artifact' description: Information about NSD archive artifacts contained in the NSD archive. This attribute shall not be present before the NSD archive content is on-boarded. Otherwise, this attribute shall be present if the NSD archive contains artifacts. nsdOnboardingState: allOf: - $ref: '#/components/schemas/NsdOnboardingState' - description: The enumeration NsdOnboardingStateType shall comply with the provisions defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding state of the NSD. CREATED = The NSD information object has been created. UPLOADING = The associated NSD content is being uploaded. PROCESSING = The associated NSD content is being processed, e.g. validation. ONBOARDED = The associated NSD content has been on-boarded. ERROR = There was an error during upload or processing of the NSD content. onboardingFailureDetails: allOf: - $ref: '#/components/schemas/OnboardingFailureDetails' - description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced in this 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]. nsdOperationalState: allOf: - $ref: '#/components/schemas/NsdOperationalState' - description: The enumeration NsdOperationalStateType shall comply with the provisions defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational state of the resource. ENABLED = The operational state of the resource is enabled. DISABLED = The operational state of the resource is disabled. nsdUsageState: allOf: - $ref: '#/components/schemas/NsdUsageState' - description: The enumeration NsdUsageStateType shall comply with the provisions defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state of the resource.IN_USE = The resource is in use.NOT_IN_USE = The resource is not-in-use. userDefinedData: type: object 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. _links: allOf: - $ref: '#/components/schemas/Links' - description: Links to resources related to this resource. description: This type represents a response for the query NSD operation. ArchiveSecurityOption: title: ArchiveSecurityOption enum: - OPTION_1 - OPTION_2 type: string description: 'Signals the security option used by the NSD archive as defined in clause 5.1 of ETSI GS NFV SOL 007. Valid values: OPTION_1, OPTION_2' Artifact: title: Artifact required: - artifactPath - checksum type: object properties: artifactPath: type: string description: A string as defined in IETF RFC 8259. checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. metadata: type: object 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. description: This type represents an artifact contained in an NSD archive. It shall comply with provisions defined in Table 5.5.3.5-1. Checksum: title: Checksum required: - algorithm - hash type: object properties: algorithm: type: string description: Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512. hash: type: string description: The hexadecimal value of the checksum. description: This type represents the checksum of a VNF package or an artifact file. NsdOnboardingState: title: NsdOnboardingState enum: - CREATED - UPLOADING - PROCESSING - ONBOARDED - ERROR type: string description: The enumeration NsdOnboardingStateType shall comply with the provisions defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding state of the NSD. CREATED = The NSD information object has been created. UPLOADING = The associated NSD content is being uploaded. PROCESSING = The associated NSD content is being processed, e.g. validation. ONBOARDED = The associated NSD content has been on-boarded. ERROR = There was an error during upload or processing of the NSD content. OnboardingFailureDetails: title: OnboardingFailureDetails required: - status - detail type: object properties: type: type: string 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". title: type: string 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). status: type: integer 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. format: int32 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced. description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced in this 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]. NsdOperationalState: title: NsdOperationalState enum: - ENABLED - DISABLED type: string description: The enumeration NsdOperationalStateType shall comply with the provisions defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational state of the resource. ENABLED = The operational state of the resource is enabled. DISABLED = The operational state of the resource is disabled. NsdUsageState: title: NsdUsageState enum: - IN_USE - NOT_IN_USE type: string description: The enumeration NsdUsageStateType shall comply with the provisions defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state of the resource.IN_USE = The resource is in use.NOT_IN_USE = The resource is not-in-use. Links: title: Links required: - self - nsd_content type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. nsd_content: allOf: - $ref: '#/components/schemas/NsdContent' - description: This type represents a link to a resource. description: Links to resources related to this resource. Self: title: Self required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. NsdContent: title: NsdContent required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. NsdV2NsDescriptorsResponse3: title: NsdV2NsDescriptorsResponse3 type: object properties: nsdOperationalState: allOf: - $ref: '#/components/schemas/NsdOperationalState' - description: The enumeration NsdOperationalStateType shall comply with the provisions defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational state of the resource. ENABLED = The operational state of the resource is enabled. DISABLED = The operational state of the resource is disabled. userDefinedData: type: array items: type: object description: Modifications of the userDefinedData attribute in NsdInfo data type. See note. If present, these modifications shall be applied according to the rules of JSON Merge Patch (see IETF RFC 7396). NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present. description: 'This type represents attribute modifications for an individual NS descriptor resource based on the NsdInfo data type. The attributes of NsdInfo that can be modified are included in the NsdInfoModifications data type.NOTE: At least one of the attributes - nsdOperationalState and userDefinedData - shall be present.' NsdV2PnfDescriptorsResponse: title: NsdV2PnfDescriptorsResponse required: - id - pnfdOnboardingState - pnfdUsageState - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. pnfdId: type: string description: An identifier with the intention of being globally unique. pnfdName: type: string description: Name of the on-boarded PNFD. This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded. pnfdersion: type: string description: 'A Version. Representation: string of variable length.' pnfdProvider: type: string description: Provider of the on-boarded PNFD. This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded. pnfdInvariantId: type: string description: An identifier with the intention of being globally unique. archiveSecurityOption: allOf: - $ref: '#/components/schemas/ArchiveSecurityOption3' - description: 'Signals the security option used by the PNFD archive as defined in clause 5.1 of ETSI GS NFV SOL 004. Valid values: OPTION_1, OPTION_2' signingCertificate: type: string description: A string as defined in IETF RFC 8259. artifacts: type: array items: $ref: '#/components/schemas/Artifact3' description: Information about PNFD archive artifacts contained in the PNFD archive. This attribute shall not be present before the PNFD archive content is on-boarded. Otherwise, this attribute shall be present if the PNFD archive contains artifacts. pnfdOnboardingState: allOf: - $ref: '#/components/schemas/PnfdOnboardingState' - description: The enumeration PnfdOnboardingStateType shall comply with the provisions defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state of the individual PNF descriptor resource. CREATED = The PNF descriptor resource has been created. UPLOADING = The associated PNFD content is being uploaded. PROCESSING = The associated PNFD content is being processed, e.g. validation. ONBOARDED = The associated PNFD content has been on-boarded. ERROR = There was an error during upload or processing of the associated PNFD content. onboardingFailureDetails: allOf: - $ref: '#/components/schemas/OnboardingFailureDetails' - description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced in this 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]. pnfdUsageState: allOf: - $ref: '#/components/schemas/PnfdUsageState' - description: The enumeration PnfdUsageStateType shall comply with the provisions defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state of the resource.IN-USE = The resource is in use.NOT_IN_USE = The resource is not-in-use. userDefinedData: type: object 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. _links: allOf: - $ref: '#/components/schemas/Links3' - description: Links to resources related to this resource. description: This type represents a response for the query PNFD operation. ArchiveSecurityOption3: title: ArchiveSecurityOption3 enum: - OPTION_1 - OPTION_2 type: string description: 'Signals the security option used by the PNFD archive as defined in clause 5.1 of ETSI GS NFV SOL 004. Valid values: OPTION_1, OPTION_2' Artifact3: title: Artifact3 required: - artifactPath - checksum type: object properties: artifactPath: type: string description: A string as defined in IETF RFC 8259. checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. nonManoArtifactSetId: type: string description: A string as defined in IETF RFC 8259. metadata: type: object 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. description: This type represents an artifact contained in a PNFD archive. It shall comply with provisions defined in Table 5.5.3.6-1. PnfdOnboardingState: title: PnfdOnboardingState enum: - CREATED - UPLOADING - PROCESSING - ONBOARDING - ERROR type: string description: The enumeration PnfdOnboardingStateType shall comply with the provisions defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state of the individual PNF descriptor resource. CREATED = The PNF descriptor resource has been created. UPLOADING = The associated PNFD content is being uploaded. PROCESSING = The associated PNFD content is being processed, e.g. validation. ONBOARDED = The associated PNFD content has been on-boarded. ERROR = There was an error during upload or processing of the associated PNFD content. PnfdUsageState: title: PnfdUsageState enum: - IN_USE - NOT_IN_USE type: string description: The enumeration PnfdUsageStateType shall comply with the provisions defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state of the resource.IN-USE = The resource is in use.NOT_IN_USE = The resource is not-in-use. Links3: title: Links3 required: - self - pnfd_content type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. pnfd_content: allOf: - $ref: '#/components/schemas/PnfdContent' - description: This type represents a link to a resource. description: Links to resources related to this resource. PnfdContent: title: PnfdContent required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. NsdV2PnfDescriptorsResponse3: title: NsdV2PnfDescriptorsResponse3 required: - userDefinedData type: object properties: userDefinedData: type: object 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. description: This type represents attribute modifications for an individual PNF descriptor resource based on the "PnfdInfo" data type. The attributes of "PnfdInfo" that can be modified are included in the "PnfdInfoModifications" data type. NsdV2SubscriptionsResponse: title: NsdV2SubscriptionsResponse required: - id - callbackUri - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. filter: allOf: - $ref: '#/components/schemas/Filter' - description: >- This type represents a subscription filter related to notifications about NSD management. It shall comply with the provisions defined in Table 5.5.3.2-1 of GS NFV-SOL 005. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). NOTE 1: The attributes "nsdId" and "nsdInfoId" are alternatives to reference to a particular NSD in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. NOTE 2: The attributes "pnfdId" and "pnfdInfoId" are alternatives to reference to a particular PNFD in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. callbackUri: type: string description: String formatted according to IETF RFC 3986. _links: allOf: - $ref: '#/components/schemas/Links6' - description: Links to resources related to this resource. description: This type represents a subscription related to notifications about NSD management. Filter: title: Filter type: object properties: notificationTypes: type: array items: $ref: '#/components/schemas/NotificationType' description: 'Match particular notification types. Permitted values: NsdOnBoardingNotification, NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification. The permitted values of the "notificationTypes" ] attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.' nsdInfoId: type: array items: type: string description: Match the NsdInfo identifier which is allocated by the NFVO. nsdId: type: array items: type: string description: Match the NSD identifier, which is allocated by the NSD designer. nsdName: type: array items: type: string description: Match the name of the on boarded NSD. nsdVersion: type: array items: type: string description: Match the NSD version listed as part of this attribute. nsdDesigner: type: array items: type: string description: Match the NSD designer of the on-boarded NSD. nsdInvariantId: type: array items: type: string description: Match the NSD invariant identifier which is allocated by the NSD designer and identifies an NSD in a version independent manner. vnfPkgIds: type: array items: type: string description: Match VNF packages with a package identifier listed in the attribute. pnfdInfoIds: type: array items: type: string description: Match the PnfdInfo identifier for the PNFD referenced by the on-boarded NSD. nestedNsdInfoIds: type: array items: type: string description: Match the NsdInfo identifier for the nested NSD referenced by the on-boarded NSD. nsdOnboardingState: type: array items: $ref: '#/components/schemas/NsdOnboardingState' description: Match particular on-boarding state of the NSD. nsdOperationalState: type: array items: $ref: '#/components/schemas/NsdOperationalState' description: Match particular operational state of the on-boarded NSD. nsdUsageState: type: array items: $ref: '#/components/schemas/NsdUsageState' description: Match particular usage state of the on-boarded NSD. pnfdId: type: array items: type: string description: Match the PNFD identifier which is copied from the PNFD content. pnfdName: type: array items: type: string description: Match the name of the on-boarded PNFD. pnfdVersion: type: array items: type: string description: Match the PNFD designer of the on-boarded PNFD. pnfdProvider: type: array items: type: string description: Match the provider of the on-boarded PNFD. pnfdInvariantId: type: array items: type: string description: Match the PNFD in a version independent manner. pnfdOnboardingState: type: array items: $ref: '#/components/schemas/PnfdOnboardingState' description: Match particular on-boarding state of the PNFD. pnfdUsageState: type: array items: $ref: '#/components/schemas/PnfdUsageState' description: Match the usage state of the individual PNF descriptor resource. description: >- This type represents a subscription filter related to notifications about NSD management. It shall comply with the provisions defined in Table 5.5.3.2-1 of GS NFV-SOL 005. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). NOTE 1: The attributes "nsdId" and "nsdInfoId" are alternatives to reference to a particular NSD in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. NOTE 2: The attributes "pnfdId" and "pnfdInfoId" are alternatives to reference to a particular PNFD in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. NotificationType: title: NotificationType enum: - NsdOnBoardingNotification - NsdOnboardingFailureNotification - NsdChangeNotification - NsdDeletionNotification - PnfdOnBoardingNotification - PnfdOnBoardingFailureNotification - PnfdDeletionNotification type: string Links6: title: Links6 type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. description: Links to resources related to this resource. NsfmV1AlarmsResponse: title: NsfmV1AlarmsResponse required: - id - managedObjectId - alarmRaisedTime - ackState - perceivedSeverity - eventTime - eventType - probableCause - isRootCause - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. managedObjectId: type: string description: An identifier with the intention of being globally unique. rootCauseFaultyComponent: allOf: - $ref: '#/components/schemas/RootCauseFaultyComponent' - description: This type represents the faulty component that has a negative impact on an NS. It shall comply with the provisions defined in Table 8.5.3.4-1. rootCauseFaultyResource: allOf: - $ref: '#/components/schemas/RootCauseFaultyResource' - description: This type represents the faulty virtual resources that have a negative impact on a NS. alarmRaisedTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' alarmChangedTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' alarmClearedTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' alarmAcknowledgedTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' ackState: allOf: - $ref: '#/components/schemas/AckState' - description: 'Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED' perceivedSeverity: allOf: - $ref: '#/components/schemas/PerceivedSeverity' - description: >- Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability needs to be restored (ITU-T Recommendation X.733). * MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability needs to be restored (ITU-T Recommendation X.733). * MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object (ITU-T Recommendation X.733). * WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault (ITU-T Recommendation X.733). * INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733). * CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given) (ITU-T Recommendation X.733). eventTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' eventType: allOf: - $ref: '#/components/schemas/EventType' - description: >- The enumeration EventType represents those types of events that trigger an alarm. - COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point to another (ITU-T Recommendation X.733). - PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733). - ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides (ITU-T Recommendation X.733). - QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733). - EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733). faultType: type: string description: Additional information to clarify the type of the fault. probableCause: type: string description: Information about the probable cause of the fault. isRootCause: type: boolean description: Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault. correlatedAlarmIds: type: array items: type: string description: List of identifiers of other alarms correlated to this fault. faultDetails: type: string description: Provides additional information about the fault.. _links: allOf: - $ref: '#/components/schemas/Links9' - description: Links for this resource. description: The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in Table 8.5.2.4-1 RootCauseFaultyComponent: title: RootCauseFaultyComponent type: object properties: faultyNestedNsInstanceId: type: string description: An identifier with the intention of being globally unique. faultyResourceType: type: string description: An identifier with the intention of being globally unique. faultyNsVirtualLinkInstanceId: type: string description: An identifier with the intention of being globally unique. description: This type represents the faulty component that has a negative impact on an NS. It shall comply with the provisions defined in Table 8.5.3.4-1. RootCauseFaultyResource: title: RootCauseFaultyResource required: - faultyResource - faultyResourceType type: object properties: faultyResource: allOf: - $ref: '#/components/schemas/FaultyResource' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. faultyResourceType: allOf: - $ref: '#/components/schemas/FaultyResourceType' - description: 'The enumeration FaultyResourceType represents those types of faulty resource. Acceptable values are: - COMPUTE - Virtual compute resource. - STORAGE - Virtual storage resource. - NETWORK - Virtual network resource.' description: This type represents the faulty virtual resources that have a negative impact on a NS. FaultyResource: title: FaultyResource required: - resourceId type: object properties: vimId: type: string description: An identifier with the intention of being globally unique. resourceProviderId: type: string description: An identifier with the intention of being globally unique. resourceId: type: string description: 'An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.' vimLevelResourceType: type: string description: Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the "vimLevelResourceType" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. FaultyResourceType: title: FaultyResourceType enum: - COMPUTE - STORAGE - NETWORK type: string description: 'The enumeration FaultyResourceType represents those types of faulty resource. Acceptable values are: - COMPUTE - Virtual compute resource. - STORAGE - Virtual storage resource. - NETWORK - Virtual network resource.' AckState: title: AckState enum: - UNACKNOWLEDGED - ACKNOWLEDGED type: string description: 'Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED' PerceivedSeverity: title: PerceivedSeverity enum: - CRITICAL - MAJOR - MINOR - WARNING - INDETERMINATE - CLEARED type: string description: >- Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability needs to be restored (ITU-T Recommendation X.733). * MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability needs to be restored (ITU-T Recommendation X.733). * MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object (ITU-T Recommendation X.733). * WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault (ITU-T Recommendation X.733). * INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733). * CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given) (ITU-T Recommendation X.733). EventType: title: EventType enum: - COMMUNICATIONS_ALARM - PROCESSING_ERROR_ALARM - ENVIRONMENTAL_ALARM - QOS_ALARM - EQUIPMENT_ALARM type: string description: >- The enumeration EventType represents those types of events that trigger an alarm. - COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point to another (ITU-T Recommendation X.733). - PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733). - ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides (ITU-T Recommendation X.733). - QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733). - EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733). Links9: title: Links9 required: - self type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. description: Links for this resource. NsfmV1AlarmsResponse2: title: NsfmV1AlarmsResponse2 required: - ackState type: object properties: ackState: allOf: - $ref: '#/components/schemas/AckState2' - description: 'New value of the "ackState" attribute in "Alarm". Permitted values: - ACKNOWLEDGED - UNACKNOWLEDGED' description: This type represents attribute modifications for an "Individual alarm" resource, i.e. modifications to a resource representation based on the "Alarm" data type. The attributes of "Alarm" that can be modified according to the provisions in clause 8.5.2.4 are included in the "AlarmModifications" data type. The "AlarmModifications" data type shall comply with the provisions defined in Table 8.5.2.8-1. AckState2: title: AckState2 enum: - ACKNOWLEDGED - UNACKNOWLEDGED type: string description: 'New value of the "ackState" attribute in "Alarm". Permitted values: - ACKNOWLEDGED - UNACKNOWLEDGED' VnfpkgmV2VnfPackagesResponse: title: VnfpkgmV2VnfPackagesResponse required: - id - packageSecurityOption - onboardingState - operationalState - usageState - vnfmInfo - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. vnfdId: type: string description: An identifier with the intention of being globally unique. vnfProvider: type: string description: Provider of the VNF package and the VNFD. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise. vnfProductName: type: string description: Name to identify the VNF product.Invariant for the VNF product lifetime. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise. vnfSoftwareVersion: type: string description: 'A Version. Representation: string of variable length.' vnfdVersion: type: string description: 'A Version. Representation: string of variable length.' compatibleSpecificationVersions: type: string description: 'A Version. Representation: string of variable length.' checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. packageSecurityOption: allOf: - $ref: '#/components/schemas/PackageSecurityOption' - description: 'Signals the security option used by the package as defined in clause 5.1 of ETSI GS NFV-SOL 004 [5]. Valid values: OPTION_1, OPTION_2' signingCertificate: type: string description: The singleton signing certificate if it is included as a file in the VNF package. softwareImages: type: array items: $ref: '#/components/schemas/SoftwareImage' description: Information about VNF package artifacts that are software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector. additionalArtifacts: type: array items: $ref: '#/components/schemas/AdditionalArtifact' description: Information about VNF package artifacts contained in the VNF package that are not software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present if the VNF package contains additional artifacts. onboardingState: allOf: - $ref: '#/components/schemas/OnboardingState' - description: 'The enumeration PackageOnboardingStateType shall comply with the provisions defined in Table 9.5.4.3-1. Permitted values: - CREATED: The VNF package resource has been created. - UPLOADING: The associated VNF package content is being uploaded. - PROCESSING: The associated VNF package content is being processed, e.g. validation. - ONBOARDED: The associated VNF package content is successfully on-boarded. - ERROR: There was an error during upload of the VNF package content or external artifacts, or during VNF package processing.' operationalState: allOf: - $ref: '#/components/schemas/OperationalState' - description: >- "The enumeration PackageOperationalStateType shall comply with the provisions defined in Table 9.5.4.4-1." Acceptable values are: - ENABLED - The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED - The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). usageState: allOf: - $ref: '#/components/schemas/UsageState' - description: '"The enumeration PackageUsageStateType shall comply with the provisions. Acceptable values are: - IN_USE: "Individual VNF instance" resources created from this VNF package exist. - NOT_IN_USE: No "individual VNF instance" resource created from this VNF package exists.' vnfmInfo: type: array items: type: string description: Specifies VNFMs compatible with the VNF. This information is copied from the VNFD. See note 4. userDefinedData: type: object 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. onboardingFailureDetails: allOf: - $ref: '#/components/schemas/OnboardingFailureDetails' - description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced in this 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]. _links: allOf: - $ref: '#/components/schemas/Links11' - description: Links to resources related to this resource. PackageSecurityOption: title: PackageSecurityOption enum: - OPTION_1 - OPTION_2 type: string description: 'Signals the security option used by the package as defined in clause 5.1 of ETSI GS NFV-SOL 004 [5]. Valid values: OPTION_1, OPTION_2' SoftwareImage: title: SoftwareImage required: - id - name - provider - version - checksum - isEncrypted - containerFormat - diskFormat - createdAt - minDisk - minRam - size - imagePath type: object properties: id: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. name: type: string description: Name of the software image. provider: type: string description: Provider of the software image. version: type: string description: 'A Version. Representation: string of variable length.' checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. isEncrypted: type: boolean description: Reflects whether the image is encrypted (true) or not (false). containerFormat: allOf: - $ref: '#/components/schemas/ContainerFormat' - description: 'Container format indicates whether the software image is in a file format that also contains meta-data about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ram disk image format - BARE: the image does not have a container or meta-data envelope - DOCKER: docker container format - OVA: OVF package in a tar file - OVF: OVF container format' diskFormat: allOf: - $ref: '#/components/schemas/DiskFormat' - description: 'Disk format of a software image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM - QCOW2: a common disk image format, which can expand dynamically and supports copy on write - RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format' createdAt: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' minDisk: minimum: 0 type: integer description: The minimal disk for this software image in bytes. format: int32 minRam: minimum: 0 type: integer description: The minimal RAM for this software image in bytes. format: int32 size: minimum: 0 type: integer description: Size of this software image in bytes. format: int32 userMetadata: type: object 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. imagePath: type: string description: >- Path, which identifies the image artifact and also allows to access a copy of the image artifact. For a software image contained as a file in the VNF package, this attribute shall be present, and the value of this attribute shall start with the name of the first segment in the path in the package, i.e., it shall not be prefixed by path separator characters such as "." and "/". EXAMPLE: foo/bar/m%40ster.vhd For an external software image represented as a URI in the VNF descriptor, this attribute shall be present if the image artifact has been downloaded by the NFVO and shall be absent otherwise. If present, it shall contain the artifactPath under which the image artifact can be obtained using the "Individual artifact in a VNF package" resource defined in clause 9.4.7. It is the responsibility of the NFVO to synthesize this path in a manner that avoids any collision of the synthesized artifact path with the paths and names of image artifacts included in the package. imageUri: type: string description: String formatted according to IETF RFC 3986. description: This type represents an artifact contained in or external to a VNF package which represents a software image. ContainerFormat: title: ContainerFormat enum: - AKI - AMI - ARI - BARE - DOCKER - OVA - OVF type: string description: 'Container format indicates whether the software image is in a file format that also contains meta-data about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ram disk image format - BARE: the image does not have a container or meta-data envelope - DOCKER: docker container format - OVA: OVF package in a tar file - OVF: OVF container format' DiskFormat: title: DiskFormat enum: - AKI - AMI - ARI - ISO - QCOW2 - RAW - VDI - VHD - VHDX - VMDK type: string description: 'Disk format of a software image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM - QCOW2: a common disk image format, which can expand dynamically and supports copy on write - RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format' AdditionalArtifact: title: AdditionalArtifact required: - checksum - isEncrypted type: object properties: artifactPath: type: string description: A string as defined in IETF RFC 8259. artifactURI: type: string description: String formatted according to IETF RFC 3986. checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. artifactClassification: allOf: - $ref: '#/components/schemas/ArtifactClassification' - description: 'Marks specific types of artifacts as defined in the VNF package. If none of the specific classes listed below applies, the attribute shall not be present. Valid values: - HISTORY: a history artifact as per clause 4.3.3 in ETSI GS NFV-SOL 004 [5] - TESTING: a testing artifact as per clause 4.3.4 in ETSI GS NFV-SOL 004 [5] - LICENSE: a license artifact as per clause 4.3.5 in ETSI GS NFV-SOL 004 [5]' isEncrypted: type: boolean description: Reflects whether the artifact is encrypted (true) or not (false). nonManoArtifactSetId: type: string description: Non-MANO artifact set identifier of the non-MANO artifact set to which the artifact belongs, as defined in clause 4.3.7 of ETSI GS NFV-SOL 004 [5]. Shall be provided if the artifact is a non-MANO artifact, and shall be omitted otherwise. metadata: type: object 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. description: This type represents an artifact other than a software image which is contained in or external to a VNF package. It shall comply with provisions defined in Table 9.5.3.3-1. ArtifactClassification: title: ArtifactClassification enum: - HISTORY - TESTING - LICENSE type: string description: 'Marks specific types of artifacts as defined in the VNF package. If none of the specific classes listed below applies, the attribute shall not be present. Valid values: - HISTORY: a history artifact as per clause 4.3.3 in ETSI GS NFV-SOL 004 [5] - TESTING: a testing artifact as per clause 4.3.4 in ETSI GS NFV-SOL 004 [5] - LICENSE: a license artifact as per clause 4.3.5 in ETSI GS NFV-SOL 004 [5]' OnboardingState: title: OnboardingState enum: - CREATED - UPLOADING - PROCESSING - ONBOARDED - ERROR type: string description: 'The enumeration PackageOnboardingStateType shall comply with the provisions defined in Table 9.5.4.3-1. Permitted values: - CREATED: The VNF package resource has been created. - UPLOADING: The associated VNF package content is being uploaded. - PROCESSING: The associated VNF package content is being processed, e.g. validation. - ONBOARDED: The associated VNF package content is successfully on-boarded. - ERROR: There was an error during upload of the VNF package content or external artifacts, or during VNF package processing.' OperationalState: title: OperationalState enum: - ENABLED - DISABLED type: string description: >- "The enumeration PackageOperationalStateType shall comply with the provisions defined in Table 9.5.4.4-1." Acceptable values are: - ENABLED - The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED - The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). UsageState: title: UsageState enum: - IN_USE - NOT_IN_USE type: string description: '"The enumeration PackageUsageStateType shall comply with the provisions. Acceptable values are: - IN_USE: "Individual VNF instance" resources created from this VNF package exist. - NOT_IN_USE: No "individual VNF instance" resource created from this VNF package exists.' Links11: title: Links11 required: - self - vnfd - packageContent type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. vnfd: allOf: - $ref: '#/components/schemas/Vnfd' - description: This type represents a link to a resource. packageContent: allOf: - $ref: '#/components/schemas/PackageContent' - description: This type represents a link to a resource. description: Links to resources related to this resource. Vnfd: title: Vnfd required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. PackageContent: title: PackageContent required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. VnfpkgmV2VnfPackagesResponse3: title: VnfpkgmV2VnfPackagesResponse3 type: object properties: operationalState: allOf: - $ref: '#/components/schemas/OperationalState' - description: >- "The enumeration PackageOperationalStateType shall comply with the provisions defined in Table 9.5.4.4-1." Acceptable values are: - ENABLED - The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED - The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). userDefinedData: type: object 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. description: This type represents modifications to the information of a VNF package. It shall comply with the provisions defined in Table 9.5.2.3-1. VnfpkgmV2VnfPackagesExtArtifactsAccessResponse: title: VnfpkgmV2VnfPackagesExtArtifactsAccessResponse type: object properties: artifact: allOf: - $ref: '#/components/schemas/Artifact6' - description: Access configuration information for an external artifact. description: This type represents the access configuration information for downloading external VNF package artifacts. The NFVO can obtain the external VNF package artifact file through the information provided in this structure, together with information provided in the manifest / VNFD. The data structure shall comply with the provisions defined in Table 9.5.2.10-1. If the data structure is part of a response body, security-sensitive attributes shall be excluded as specified in Table 9.5.2.10-1. Artifact6: title: Artifact6 required: - artifactUri type: object properties: artifactUri: type: string description: String formatted according to IETF RFC 3986. overrideUri: type: string description: String formatted according to IETF RFC 3986. authType: allOf: - $ref: '#/components/schemas/AuthType' - description: 'Defines the type of authentication / authorization for downloading the VNF package. Permitted values: - BASIC: Only the "username" and "password" attributes shall be present. - OAUTH2_CLIENT_CREDENTIAL S: Only the "paramsOauth2ClientCredentials" attribute shall be present. This attribute shall not be present if no credentials are provided for the artifact.' username: type: string description: User name to be used for authentication. password: type: string description: Password to be used for authentication. Shall not be present in response bodies. paramsOauth2ClientCredentials: allOf: - $ref: '#/components/schemas/ParamsOauth2ClientCredentials' - description: Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. description: Access configuration information for an external artifact. AuthType: title: AuthType enum: - BASIC - OAUTH2_CLIENT_CREDENTIALS type: string description: 'Defines the type of authentication / authorization for downloading the VNF package. Permitted values: - BASIC: Only the "username" and "password" attributes shall be present. - OAUTH2_CLIENT_CREDENTIAL S: Only the "paramsOauth2ClientCredentials" attribute shall be present. This attribute shall not be present if no credentials are provided for the artifact.' ParamsOauth2ClientCredentials: title: ParamsOauth2ClientCredentials required: - clientId - clientPassword - tokenEndpoint type: object properties: clientId: type: string description: Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. clientPassword: type: string description: Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall not be present in response bodies. tokenEndpoint: type: string description: String formatted according to IETF RFC 3986. description: Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. NspmV2PmJobsResponse: title: NspmV2PmJobsResponse required: - id - objectType - objectInstanceIds - criteria - callbackUri type: object properties: id: type: string description: An identifier with the intention of being globally unique. objectType: type: string description: A string as defined in IETF RFC 8259. objectInstanceIds: type: array items: type: string description: Identifiers of the NS instances for which performance information is collected. subObjectInstanceIds: type: array items: type: string description: Identifiers of the sub-object instances of the measured object instance for which performance information is requested to be collected. May be present if a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027 for the related measured object type. If this attribute is present, the cardinality of the "objectInstanceIds" attribute shall be 1. If this attribute is absent and a sub-object is defined in clause 6.2 of ETSI GS NFV IFA 027 for the related measured object type, measurements will be taken for all sub-object instances of the measured object instance. criteria: allOf: - $ref: '#/components/schemas/Criteria' - description: This type represents collection criteria for PM jobs. It shall comply with the provisions defined in Table 7.5.3.3-1. callbackUri: type: string description: String formatted according to IETF RFC 3986. reports: allOf: - $ref: '#/components/schemas/Reports' - description: Information about available reports collected by this PM job. description: This type represents a PM job. Criteria: title: Criteria required: - collectionPeriod - reportingPeriod type: object properties: performanceMetric: type: array items: type: string description: This defines the types of performance metrics for the specified object instances. Valid values are specified as "Measurement Name" values in clause 7.3 of ETSI GS NFV-IFA 027. At least one of the two attributes (performance metric or group) shall be present. performanceMetricGroup: type: array items: type: string description: Group of performance metrics. A metric group is a pre-defined list of metrics, known to the API producer that it can decompose to individual metrics. Valid values are specified as "Measurement Group" values in clause 7.3 of ETSI GS NFV-IFA 027. At least one of the two attributes (performance metric or group) shall be present. collectionPeriod: minimum: 0 type: integer description: Specifies the periodicity at which the API producer will collect performance information. The unit shall be seconds. At the end of each reportingPeriod, the API producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. In particular when choosing short collection and reporting periods, the number of PM jobs that can be supported depends on the capability of the producing entity. format: int32 reportingPeriod: minimum: 0 type: integer description: Specifies the periodicity at which the API producer will report to the API consumer. about performance information. The unit shall be seconds. At the end of each reportingPeriod, the API producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. In particular when choosing short collection and reporting periods, the number of PM jobs that can be supported depends on the capability of the producing entity. format: int32 reportingBoundary: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' description: This type represents collection criteria for PM jobs. It shall comply with the provisions defined in Table 7.5.3.3-1. Reports: title: Reports required: - href - readyTime - _links type: object properties: href: type: string description: String formatted according to IETF RFC 3986. readyTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' expiryTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' fileSize: type: integer description: The size of the report file in bytes, if known. format: int32 _links: allOf: - $ref: '#/components/schemas/Links14' - description: Links for this resource. description: Information about available reports collected by this PM job. Links14: title: Links14 required: - self type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. objects: type: array items: $ref: '#/components/schemas/Object' description: Links to resources representing the measured object instances for which performance information is collected. Shall be present if the measured object instance information is accessible as a resource. description: Links for this resource. Object: title: Object required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. NspmV2PmJobsResponse3: title: NspmV2PmJobsResponse3 type: object properties: callbackUri: type: string description: String formatted according to IETF RFC 3986. authentication: $ref: '#/components/schemas/Authentication' description: This type represents modifications to a PM job. It shall comply with the provisions defined in Table 7.5.2.12-1. Authentication: title: Authentication required: - authType type: object properties: authType: type: array items: $ref: '#/components/schemas/AuthType2' description: >- Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: - BASIC: In every HTTP request to the notification endpoint, use HTTP Basic authentication with the client credentials. - OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained using the client credentials grant type. - TLS_CERT: Every HTTP request to the notification endpoint is sent over a mutually authenticated TLS session, i.e. not only the server is authenticated, but also the client is authenticated during the TLS tunnel setup. paramsBasic: allOf: - $ref: '#/components/schemas/ParamsBasic' - description: Parameters for authentication/authorization using BASIC. Shall be present if authType is "BASIC" and the contained information has not been provisioned out of band. Shall be absent otherwise. paramsOauth2ClientCredentials: allOf: - $ref: '#/components/schemas/ParamsOauth2ClientCredentials2' - description: Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be absent otherwise. AuthType2: title: AuthType2 enum: - BASIC - OAUTH2_CLIENT_CREDENTIALS - TLS_CERT type: string ParamsBasic: title: ParamsBasic type: object properties: userName: type: string description: Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. password: type: string description: Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. description: Parameters for authentication/authorization using BASIC. Shall be present if authType is "BASIC" and the contained information has not been provisioned out of band. Shall be absent otherwise. ParamsOauth2ClientCredentials2: title: ParamsOauth2ClientCredentials2 type: object properties: clientId: type: string description: Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. clientPassword: type: string description: Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process. tokenEndpoint: type: string description: String formatted according to IETF RFC 3986. description: Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be absent otherwise. NspmV2PmJobsReportsResponse: title: NspmV2PmJobsReportsResponse required: - entries type: object properties: entries: type: array items: $ref: '#/components/schemas/Entry' description: List of performance information entries. Each performance report entry is for a given metric of a given object (i.e. NS instance), but can include multiple collected values. description: This type defines the format of a performance report provided by the NFVO to the OSS/BSS as a result of collecting performance information as part of a PM job. The type shall comply with the provisions defined in Table 7.5.2.10-1. Entry: title: Entry required: - objectType - objectInstanceId - performanceMetric type: object properties: objectType: type: string description: A string as defined in IETF RFC 8259. objectInstanceId: type: string description: An identifier with the intention of being globally unique. subObjectInstanceId: type: array items: type: string description: >- Identifier of the sub-object instance of the measured object instance for which the performance metric is reported. Shall be present if this is required in clause 6.2 of ETSI GS NFV-IFA 027 for the related measured object type. The sub-object allows to structure the measured object but is not to be confused with sub-counters which allow to structure the measurement value. EXAMPLE: Measured object: VnfInstanceXYZ Sub-object: VnfcInstance1 Measurement: vCPU_utilization Sub-counters: vCPU utilization of each of the vCPUs of VnfcInstance1 (vCPU utilization.vCPU1, vCPU_utilization.vCPU2, etc.). performanceMetric: type: string description: A string as defined in IETF RFC 8259. performanceValues: type: array items: $ref: '#/components/schemas/PerformanceValue' description: List of performance values with associated timestamp. PerformanceValue: title: PerformanceValue required: - timeStamp type: object properties: timeStamp: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' value: type: object description: Value of the metric collected. The type of this attribute shall correspond to the related "Measurement Unit" as defined in clause 7.3 of ETSI GS NFV-IFA 027. context: type: object 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. NspmV2ThresholdsResponse: title: NspmV2ThresholdsResponse required: - id - objectType - objectInstanceId - criteria - callbackUri - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. objectType: description: Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.3 of ETSI GS NFV IFA 027. objectInstanceId: type: string description: An identifier with the intention of being globally unique. subObjectInstanceIds: type: array items: type: string description: Identifiers of the sub-object instances of the measured object instance associated with the threshold. May be present if a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027 for the related measurement type. If this attribute is absent and a sub-object is defined n clause 6.2 of ETSI GS NFV-IFA 027 for the related measured object type, measurements will be taken for all sub-object instances of the measured object instance. criteria: allOf: - $ref: '#/components/schemas/Criteria3' - description: This type represents criteria that define a threshold. callbackUri: type: string description: String formatted according to IETF RFC 3986. _links: allOf: - $ref: '#/components/schemas/Links17' - description: Links for this resource. description: This type represents a threshold. Criteria3: title: Criteria3 required: - performanceMetric - thresholdType type: object properties: performanceMetric: type: string description: Defines the performance metric associated with the threshold. Valid values are specified as "Measurement Name" values in clause 7.2 of ETSI GS NFV IFA 027. thresholdType: enum: - SIMPLE type: string description: 'Type of threshold. This attribute determines which other attributes are present in the data structure. Permitted values: * SIMPLE: Single-valued static threshold In the present document, simple thresholds are defined. The definition of additional threshold types is left for future specification.' simpleThresholdDetails: allOf: - $ref: '#/components/schemas/SimpleThresholdDetails' - description: Details of a simple threshold. Shall be present if thresholdType="SIMPLE". description: This type represents criteria that define a threshold. SimpleThresholdDetails: title: SimpleThresholdDetails required: - thresholdValue - hysteresis type: object properties: thresholdValue: type: integer description: The threshold value. Shall be represented as a floating point number. format: int32 hysteresis: type: integer description: The hysteresis of the threshold. Shall be represented as a non-negative floating point number. A notification with crossing direction "UP" will be generated if the measured value reaches or exceeds "thresholdValue" + "hysteresis". A notification with crossing direction "DOWN" will be generated if the measured value reaches or undercuts "thresholdValue" - "hysteresis". The hysteresis is defined to prevent storms of threshold crossing notifications. When processing a request to create a threshold, implementations should enforce a suitable minimum value for this attribute (e.g. override the value or reject the request). format: int32 description: Details of a simple threshold. Shall be present if thresholdType="SIMPLE". Links17: title: Links17 required: - self type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. object: description: Link to a resource representing the NS instance for which performance information is collected. Shall be present if the NS instance information is accessible as a resource. description: Links for this resource. NspmV2ThresholdsResponse3: title: NspmV2ThresholdsResponse3 type: object properties: callbackUri: type: string description: String formatted according to IETF RFC 3986. authentication: $ref: '#/components/schemas/Authentication' description: This type represents modifications to a threshold. It shall comply with the provisions defined in Table 7.5.2.11-1. NfviciV1NfviCapacityInfosResponse: title: NfviciV1NfviCapacityInfosResponse required: - id - vimId - capacityInfoPerZone type: object properties: id: type: string description: An identifier with the intention of being globally unique. vimId: type: string description: An identifier with the intention of being globally unique. capacityInfoPerZone: type: array items: $ref: '#/components/schemas/CapacityInfoPerZone' description: Capacity information on a per resource zone basis under control by the associated VIM. totalCapacityInfo: allOf: - $ref: '#/components/schemas/TotalCapacityInfo' - description: >- This type defines the format of the NFVI capacity information on a per resource type basis. The type shall comply with the provisions defined in table 10.5.2.6-1. timeInterval: allOf: - $ref: '#/components/schemas/TimeInterval' - description: This type defines the format of a time interval. The type shall comply with the provisions defined in table 10.5.2.7-1. description: >- This type defines the format of the NFVI capacity information. The type shall comply with the provisions defined in Table 10.5.2.4-1. CapacityInfoPerZone: title: CapacityInfoPerZone required: - capacityMeasurements type: object properties: resourceZoneId: type: string description: An identifier with the intention of being globally unique. capacityMeasurements: type: array items: $ref: '#/components/schemas/CapacityMeasurement' description: Capacity measurement on a per resource type basis. description: >- This type defines the format of the NFVI capacity information on a per resource zone basis. The type shall comply with the provisions defined in table 10.5.2.5-1. CapacityMeasurement: title: CapacityMeasurement required: - resourceType - capacityMeasurementName - totalCapacity - allocatedCapacity - availableCapacity type: object properties: resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: >- The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1. * VR_COMPUTE: For virtualised compute resource. * VR_NETWORK: For virtualised network resource. * VR_STORAGE: For virtualised storage resource. * HOST_COMPUTE: For host compute resource. capacityMeasurementName: type: string description: >- Name of the capacity measurement. Different resource types can have different associated capacity measurements, typically associated to different sub-types of the resource type. The present document and referred documents do not specify the capacity measurements, thus the capacity measurement names are not specified in the present document version. totalCapacity: type: object description: The total capacity. allocatedCapacity: type: object description: The allocated/used capacity. reservedCapacity: type: object description: >- The reserved capacity. Shall be present if the capacity measurement relates to a resource type and (and sub-type) that is reservable. availableCapacity: type: object description: The available capacity. description: >- This type defines the format of the NFVI capacity information on a per resource type basis. The type shall comply with the provisions defined in table 10.5.2.6-1. ResourceType: title: ResourceType enum: - VR_COMPUTE - VR_NETWORK - VR_STORAGE - HOST_COMPUTE type: string description: >- The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1. * VR_COMPUTE: For virtualised compute resource. * VR_NETWORK: For virtualised network resource. * VR_STORAGE: For virtualised storage resource. * HOST_COMPUTE: For host compute resource. TotalCapacityInfo: title: TotalCapacityInfo required: - resourceType - capacityMeasurementName - totalCapacity - allocatedCapacity - availableCapacity type: object properties: resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: >- The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1. * VR_COMPUTE: For virtualised compute resource. * VR_NETWORK: For virtualised network resource. * VR_STORAGE: For virtualised storage resource. * HOST_COMPUTE: For host compute resource. capacityMeasurementName: type: string description: >- Name of the capacity measurement. Different resource types can have different associated capacity measurements, typically associated to different sub-types of the resource type. The present document and referred documents do not specify the capacity measurements, thus the capacity measurement names are not specified in the present document version. totalCapacity: type: object description: The total capacity. allocatedCapacity: type: object description: The allocated/used capacity. reservedCapacity: type: object description: >- The reserved capacity. Shall be present if the capacity measurement relates to a resource type and (and sub-type) that is reservable. availableCapacity: type: object description: The available capacity. description: >- This type defines the format of the NFVI capacity information on a per resource type basis. The type shall comply with the provisions defined in table 10.5.2.6-1. TimeInterval: title: TimeInterval required: - aTime type: object properties: aTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' bTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' description: This type defines the format of a time interval. The type shall comply with the provisions defined in table 10.5.2.7-1. NfviciV1CapacityThresholdsResponse: title: NfviciV1CapacityThresholdsResponse required: - id - objectInstanceId - criteria - callbackUri - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. objectInstanceId: type: string description: An identifier with the intention of being globally unique. subObjectInstanceIds: type: array items: type: string description: >- Identifiers of the sub-object instances of the measured object instance associate with this capacity threshold. If this attribute is absent, measurements are taken for all sub-object instances of the measured object instance. criteria: allOf: - $ref: '#/components/schemas/Criteria6' - description: >- This type represents criteria that define a capacity threshold. It shall comply with the provisions defined in table 10.5.3.3-1. callbackUri: type: string description: String formatted according to IETF RFC 3986. _links: allOf: - $ref: '#/components/schemas/Links20' - description: Links for this resource. description: This type represents a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1. Criteria6: title: Criteria6 required: - capacityMetric - thresholdType type: object properties: capacityMetric: allOf: - $ref: '#/components/schemas/CapacityMetric' - description: Defines the capacity metric for which the threshold applies. thresholdType: enum: - SIMPLE type: string description: >- Type of capacity threshold. This attribute determines which other attributes are present in the data structure. Permitted values: - SIMPLE: Single-valued static threshold. In the present document, simple thresholds are defined. The definition of additional threshold types is left for future specification. simpleThresholdDetails: type: array items: $ref: '#/components/schemas/SimpleThresholdDetails3' description: Details of a simple threshold. Shall be present if thresholdType="SIMPLE". description: >- This type represents criteria that define a capacity threshold. It shall comply with the provisions defined in table 10.5.3.3-1. CapacityMetric: title: CapacityMetric required: - resourceType - capacityMeasurementName - capacityType type: object properties: resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: >- The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1. * VR_COMPUTE: For virtualised compute resource. * VR_NETWORK: For virtualised network resource. * VR_STORAGE: For virtualised storage resource. * HOST_COMPUTE: For host compute resource. capacityMeasurementName: type: string description: >- Name of the capacity measurement. Different resource types can have different associated capacity measurements, typically associated to different sub-types of the resource type. capacityType: allOf: - $ref: '#/components/schemas/CapacityType' - description: >- The type of capacity for the threshold. Permitted values: - TOTAL: for total capacity. - ALLOCATED: for allocated/used capacity. - RESERVED: for reserved capacity. - AVAILABLE: for available capacity. description: Defines the capacity metric for which the threshold applies. CapacityType: title: CapacityType enum: - TOTAL - ALLOCATED - RESERVED - AVAILABLE type: string description: >- The type of capacity for the threshold. Permitted values: - TOTAL: for total capacity. - ALLOCATED: for allocated/used capacity. - RESERVED: for reserved capacity. - AVAILABLE: for available capacity. SimpleThresholdDetails3: title: SimpleThresholdDetails3 required: - thresholdValue - hysteresis type: object properties: thresholdValue: type: number description: The threshold value. Shall be represented as a floating point number. hysteresis: type: number description: >- The hysteresis of the threshold. Shall be represented as a non-negative floating point number. A notification with crossing direction "UP" will be generated if the measured value reaches or exceeds "thresholdValue" + "hysteresis". A notification with crossing direction "DOWN" will be generated if the measured value reaches or undercuts "thresholdValue" - "hysteresis". The hysteresis is defined to prevent storms of threshold crossing notifications. When processing a request to create a threshold, implementations should enforce a suitable minimum value for this attribute (e.g. override the value or reject the request). Links20: title: Links20 required: - self type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. object: allOf: - $ref: '#/components/schemas/Object' - description: This type represents a link to a resource. description: Links for this resource. NfviciV1CapacityThresholdsResponse3: title: NfviciV1CapacityThresholdsResponse3 type: object properties: callbackUri: type: string description: String formatted according to IETF RFC 3986. authentication: $ref: '#/components/schemas/Authentication' description: This type represents modifications to a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1. VnfsnapshotpkgmV1VnfSnapshotPackagesResponse: title: VnfsnapshotpkgmV1VnfSnapshotPackagesResponse required: - id - name - isFullSnapshot - state - isCancelPending - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. vnfSnapshotPkgUniqueId: type: string description: An identifier with the intention of being globally unique. name: type: string description: Human-readable name of the VNF snapshot package. checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. createdAt: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' vnfSnapshotId: type: string description: An identifier with the intention of being globally unique. vnfcSnapshotInfoIds: type: array items: type: string description: >- Identifier of information held by the VNFM about specific VNFC snapshot(s) part of the VNF snapshot and contained in the VNF snapshot package. This identifier is allocated by the VNFM during the VNF snapshot creation. The attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector. isFullSnapshot: type: boolean description: The Boolean is a data type having two values (TRUE and FALSE). vnfdInfo: allOf: - $ref: '#/components/schemas/VnfdInfo' - description: This type represents the VNFD which is contained in a VNF snapshot package. It shall comply with provisions defined in Table 11.5.3.4-1. vnfsr: allOf: - $ref: '#/components/schemas/Vnfsr' - description: This type represents the VNF snapshot record which is contained in a VNF snapshot package. It shall comply with provisions defined in Table 11.5.3.5-1. vnfcSnapshotImages: type: array items: $ref: '#/components/schemas/VnfcSnapshotImage' description: "Information about VNF snapshot artifacts that are VNFC snapshot images. Every local and external snapshot image shall be included. No other artifacts shall be included. \nThe attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector." additionalArtifacts: type: array items: $ref: '#/components/schemas/AdditionalArtifact3' description: "Information about VNF snapshot artifacts that are not VNFC snapshot images. \nThe attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector." state: allOf: - $ref: '#/components/schemas/State' - description: >- State of the VNF snapshot package. Permitted values: - CREATED: the VNF snapshot package information has been created. - BUILDING: the VNF snapshot package is being built. - UPLOADING: the VNF snapshot package is being uploaded. - EXTRACTING: the VNF snapshot package’s content is being extracted. - AVAILABLE: the VNF snapshot package is available (i.e., build or upload is completed). - ERROR: failure during the VNF snapshot package building, uploading or processing. - ERROR_EXTRACTING: failure during the VNF snapshot package extraction task. isCancelPending: type: boolean description: The Boolean is a data type having two values (TRUE and FALSE). failureDetails: allOf: - $ref: '#/components/schemas/FailureDetails' - description: Failure details associated to current error state of the VNF snapshot package state. If "state" is "ERROR" or "ERROR_EXTRACTING", this attribute shall be present unless it has been requested to be excluded via an attribute selector. userDefinedData: type: object 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. _links: allOf: - $ref: '#/components/schemas/Links23' - description: Links to resources related to this resource. description: This type represents the information of a VNF snapshot package. It shall comply with the provisions defined in table 11.5.2.3-1. VnfdInfo: title: VnfdInfo required: - vnfdId - vnfdPath - checksum - isEncrypted type: object properties: vnfdId: type: string description: An identifier with the intention of being globally unique. vnfdPath: type: string description: >- Path which allows to access a copy of the VNFD. The VNFD is implemented as a collection of one or more files, and the path refers to the ZIP archive file embedding these files. The VNF snapshot package format is defined in the ETSI GS NFV-SOL 010. The value of this attribute shall start with the name of the first segment of the path in the package, i.e. it shall not be prefixed by path separator characters such as "." and "/". EXAMPLE: foo/bar/m@ster checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. isEncrypted: type: boolean description: The Boolean is a data type having two values (TRUE and FALSE). description: This type represents the VNFD which is contained in a VNF snapshot package. It shall comply with provisions defined in Table 11.5.3.4-1. Vnfsr: title: Vnfsr required: - recordPath - checksum - isEncrypted type: object properties: recordPath: type: string description: >- Path which identifies the VNF snapshot record and allows to access a copy of the VNF snapshot record for the extraction. The value of this attribute shall start with the name of the first segment of the path in the package, i.e. it shall not be prefixed by path separator characters such as "." and "/". EXAMPLE: foo/bar/m@ster checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. isEncrypted: type: boolean description: The Boolean is a data type having two values (TRUE and FALSE). description: This type represents the VNF snapshot record which is contained in a VNF snapshot package. It shall comply with provisions defined in Table 11.5.3.5-1. VnfcSnapshotImage: title: VnfcSnapshotImage required: - id - name - checksum - isEncrypted - vnfcInstanceId - containerFormat - diskFormat - createdAt - minDisk - minRam - size type: object properties: id: type: string description: 'An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.' name: type: string description: Name of the VNFC snapshot image. checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. isEncrypted: type: boolean description: The Boolean is a data type having two values (TRUE and FALSE). vnfcInstanceId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. containerFormat: allOf: - $ref: '#/components/schemas/ContainerFormat3' - description: >- Container format indicates whether the snapshot image is in a file format that also contains metadata about the actual snapshot. Permitted values: - AKI: a kernel image format. - AMI: a machine image format. - ARI: a ramdisk image format. - BARE: the image does not have a container or metadata envelope. - DOCKER: docker container format. - OVA: OVF package in a tarfile. - OVF: OVF container format. The list of permitted values was taken from "Container formats" in OpenStack®: "Disk and container formats for images" (Available from https://docs.openstack.org/glance/pike/user/formats.html) diskFormat: allOf: - $ref: '#/components/schemas/DiskFormat3' - description: >- Disk format of a snapshot image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format. - AMI: a machine image format. - ARI: a ramdisk image format. - ISO: an archive format for the data contents of an optical disc, such as CD-ROM. - QCOW2: a common disk image format, which can expand dynamically and supports copy on write. - RAW: an unstructured disk image format. - VDI: a common disk image format. - VHD: a common disk image format. - VHDX: enhanced version of VHD format. - VMDK: a common disk image format. The list of permitted values was adapted from "Disk formats" in OpenStack®: "Disk and container formats for images" (Available from https://docs.openstack.org/glance/pike/user/formats.html) createdAt: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' minDisk: minimum: 0 type: integer description: Unsigned integer number format: int32 minRam: minimum: 0 type: integer description: Unsigned integer number format: int32 size: minimum: 0 type: integer description: Unsigned integer number format: int32 userMetadata: type: object 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. imagePath: type: string description: "Path which identifies the image artifact and also allows to access a copy of the image artifact. \nFor an image artifact contained as a file in the VNF snapshot package, this attribute shall be present, and the value of this attribute shall start with the name of the first segment in the path in the package, i.e., it shall not be prefixed by path separator characters such as \".\" and \"/\".\nEXAMPLE: foo/bar/m%40ster.vhd\nFor an external image artifact represented as a URI in the manifest file, this attribute shall be present if the artifact has been downloaded by the NFVO or the artifact has been processed after building the VNF snapshot package and shall be absent otherwise. If present, it shall contain the artifactPath under which the image artifact can be obtained using the \"Individual artifact in a VNF snapshot package\" resource defined in clause 11.4.10. It is the responsibility of the NFVO to synthesize this path in a manner that avoids any collision of the synthesized artifact path with the paths and names of artifacts included in the snapshot package." imageUri: type: string description: String formatted according to IETF RFC 3986. description: This type represents an artifact contained in or external to a VNF snapshot package which represents a snapshot image. It shall comply with the provisions defined in table 11.5.3.2-1. ContainerFormat3: title: ContainerFormat3 enum: - AKI - AMI - ARI - BARE - DOCKER - OVA - OVF type: string description: >- Container format indicates whether the snapshot image is in a file format that also contains metadata about the actual snapshot. Permitted values: - AKI: a kernel image format. - AMI: a machine image format. - ARI: a ramdisk image format. - BARE: the image does not have a container or metadata envelope. - DOCKER: docker container format. - OVA: OVF package in a tarfile. - OVF: OVF container format. The list of permitted values was taken from "Container formats" in OpenStack®: "Disk and container formats for images" (Available from https://docs.openstack.org/glance/pike/user/formats.html) DiskFormat3: title: DiskFormat3 enum: - AKI - AMI - ARI - ISO - QCOW2 - RAW - VDI - VHD - VHDX - VMDK type: string description: >- Disk format of a snapshot image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format. - AMI: a machine image format. - ARI: a ramdisk image format. - ISO: an archive format for the data contents of an optical disc, such as CD-ROM. - QCOW2: a common disk image format, which can expand dynamically and supports copy on write. - RAW: an unstructured disk image format. - VDI: a common disk image format. - VHD: a common disk image format. - VHDX: enhanced version of VHD format. - VMDK: a common disk image format. The list of permitted values was adapted from "Disk formats" in OpenStack®: "Disk and container formats for images" (Available from https://docs.openstack.org/glance/pike/user/formats.html) AdditionalArtifact3: title: AdditionalArtifact3 required: - checksum - isEncrypted type: object properties: artifactPath: type: string description: >- Path which identifies the artifact and also allows to access a copy of the artifact. For an artifact contained as a file in the VNF snapshot package, this attribute shall be present, and the value of this attribute shall start with the name of the first segment in the path in the package, i.e. it shall not be prefixed by path separator characters such as "." and "/". EXAMPLE: foo/bar/m%40ster.sh For an external artifact represented as a URI in the manifest file, this attribute shall be present if the artifact has been downloaded by the NFVO or the artifact has been processed after building the VNF snapshot package and shall be absent otherwise. If present, it shall contain the artifactPath under which the artifact can be obtained using the "Individual artifact in a VNF snapshot package" resource defined in clause 11.4.10. It is the responsibility of the NFVO to synthesize this path in a manner that avoids any collision of the synthesized artifact path with the paths and names of artifacts included in the snapshot package. artifactUri: type: string description: String formatted according to IETF RFC 3986. checksum: allOf: - $ref: '#/components/schemas/Checksum' - description: This type represents the checksum of a VNF package or an artifact file. isEncrypted: type: boolean description: The Boolean is a data type having two values (TRUE and FALSE). metadata: type: object 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. description: This type represents an artifact other than a software image which is contained in a VNF snapshot package. It shall comply with provisions defined in table 11.5.3.3-1. State: title: State enum: - CREATED - BUILDING - UPLOADING - EXTRACTING - AVAILABLE - ERROR - ERROR_EXTRACTING type: string description: >- State of the VNF snapshot package. Permitted values: - CREATED: the VNF snapshot package information has been created. - BUILDING: the VNF snapshot package is being built. - UPLOADING: the VNF snapshot package is being uploaded. - EXTRACTING: the VNF snapshot package’s content is being extracted. - AVAILABLE: the VNF snapshot package is available (i.e., build or upload is completed). - ERROR: failure during the VNF snapshot package building, uploading or processing. - ERROR_EXTRACTING: failure during the VNF snapshot package extraction task. FailureDetails: title: FailureDetails required: - errorType - details type: object properties: errorType: allOf: - $ref: '#/components/schemas/ErrorType' - description: 'Type of error, when the failure happened (building, upload, processing, extracting). Permitted values: - BUILD_ERROR - UPLOAD_ERROR - PROCESS_ERROR - CANCELLED - EXTRACTION_ERROR' details: allOf: - $ref: '#/components/schemas/Details' - description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced in this 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]. description: Failure details associated to current error state of the VNF snapshot package state. If "state" is "ERROR" or "ERROR_EXTRACTING", this attribute shall be present unless it has been requested to be excluded via an attribute selector. ErrorType: title: ErrorType enum: - BUILD_ERROR - UPLOAD_ERROR - PROCESS_ERROR - CANCELLED - EXTRACTION_ERROR type: string description: 'Type of error, when the failure happened (building, upload, processing, extracting). Permitted values: - BUILD_ERROR - UPLOAD_ERROR - PROCESS_ERROR - CANCELLED - EXTRACTION_ERROR' Details: title: Details required: - status - detail type: object properties: type: type: string 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". title: type: string 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). status: type: integer 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. format: int32 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced. description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced in this 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]. Links23: title: Links23 required: - self - packageContent type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. packageContent: allOf: - $ref: '#/components/schemas/PackageContent' - description: This type represents a link to a resource. description: Links to resources related to this resource. VnfsnapshotpkgmV1VnfSnapshotPackagesResponse3: title: VnfsnapshotpkgmV1VnfSnapshotPackagesResponse3 type: object properties: name: type: string description: "New value of the human-readable name of the VNF snapshot package. \nAt least one of the three parameters shall be present. If the VNF snapshot package is not uploaded or built, the operation is used only to update existing or add additional user defined data using the userDefinedData attribute." userDefinedData: type: object 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. state: allOf: - $ref: '#/components/schemas/State3' - description: "New value of the \"state\" of the VNF snapshot package.\nPermitted values: - AVAILABLE: to change the \"Individual VNF snapshot package\" resource state to \"AVAILABLE\".\nExplicit change of state is only permitted from the following states: - ERROR_EXTRACTING \nAt least one of the three parameters shall be present. If the VNF snapshot package is not uploaded or built, the operation is used only to update existing or add additional user defined data using the userDefinedData attribute." description: This type represents modifications to the information of a VNF snapshot package. It shall comply with the provisions defined in table 11.5.2.4-1. State3: title: State3 enum: - AVAILABLE type: string description: "New value of the \"state\" of the VNF snapshot package.\nPermitted values: - AVAILABLE: to change the \"Individual VNF snapshot package\" resource state to \"AVAILABLE\".\nExplicit change of state is only permitted from the following states: - ERROR_EXTRACTING \nAt least one of the three parameters shall be present. If the VNF snapshot package is not uploaded or built, the operation is used only to update existing or add additional user defined data using the userDefinedData attribute." NsInstancesResponse: title: NsInstancesResponse required: - id - nsInstanceName - nsInstanceDescription - nsdId - nsdInfoId - nsState - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. nsInstanceName: type: string description: Human readable name of the NS instance. nsInstanceDescription: type: string description: Human readable description of the NS instance. nsdId: type: string description: An identifier with the intention of being globally unique. nsdInfoId: type: string description: An identifier with the intention of being globally unique. flavourId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' vnfInstance: type: array items: $ref: '#/components/schemas/VnfInstance' description: Information on constituent VNF(s) of the NS instance. pnfInfo: type: array items: $ref: '#/components/schemas/PnfInfo' description: Information on the PNF(s) that are part of the NS instance. virtualLinkInfo: type: array items: $ref: '#/components/schemas/VirtualLinkInfo' description: Information on the VL(s) of the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED and if the NS instance has specified connectivity. vnffgInfo: type: array items: $ref: '#/components/schemas/VnffgInfo' description: Information on the VNFFG(s) of the NS instance. sapInfo: type: array items: $ref: '#/components/schemas/SapInfo' description: Information on the SAP(s) of the NS instance. nestedNsInstanceId: type: array items: type: string description: Identifier of the nested NS(s) of the NS instance. vnfSnapshotInfoIds: type: array items: type: string description: Identifier of information on VNF snapshots of VNF instances that are part of this NS instance. nsState: allOf: - $ref: '#/components/schemas/NsState' - description: 'The state of the NS instance. Permitted values: NOT_INSTANTIATED: The NS instance is terminated or not instantiated. INSTANTIATED: The NS instance is instantiated.' example: NOT_INSTANTIATED monitoringParameter: type: array items: $ref: '#/components/schemas/MonitoringParameter1' description: Performance metrics tracked by the NFVO (e.g. for auto-scaling purposes) as identified by the NS designer in the NSD. nsScaleStatus: type: array items: $ref: '#/components/schemas/NsScaleStatus' description: Status of each NS scaling aspect declared in the applicable DF, how "big" the NS instance has been scaled w.r.t. that aspect. This attribute shall be present if the nsState attribute value is INSTANTIATED. additionalAffinityOrAntiAffinityRule: type: array items: $ref: '#/components/schemas/AdditionalAffinityOrAntiAffinityRule' description: Information on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD. wanConnectionInfo: type: array items: {} description: Information about WAN related connectivity enabling multi-site VLs. _links: allOf: - $ref: '#/components/schemas/Links26' - description: Links to resources related to this resource. description: This type represents a response for Query NS operation. It shall comply with the provisions defined in Table 6.5.2.10-1. VnfInstance: title: VnfInstance required: - id - vnfdId - vnfProvider - vnfProductName - vnfSoftwareVersion - vnfdVersion - vnfPkgId - instantiationState type: object properties: id: type: string description: An identifier with the intention of being globally unique. vnfInstanceName: type: string description: Name of the VNF instance. Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure. vnfInstanceDescription: type: string description: Human-readable description of the VNF instance. Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure. vnfdId: type: string description: An identifier with the intention of being globally unique. vnfProvider: type: string description: Provider of the VNF and the VNFD. The value is copied from the VNFD. vnfProductName: type: string description: Name to identify the VNF Product. The value is copied from the VNFD. vnfSoftwareVersion: type: string description: 'A Version. Representation: string of variable length.' vnfdVersion: type: string description: 'A Version. Representation: string of variable length.' vnfPkgId: type: string description: An identifier with the intention of being globally unique. vnfConfigurableProperties: type: object 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. vimId: type: string description: An identifier with the intention of being globally unique. instantiationState: allOf: - $ref: '#/components/schemas/InstantiationState' - description: The instantiation state of the VNF. example: NOT_INSTANTIATED instantiatedVnfInfo: allOf: - $ref: '#/components/schemas/InstantiatedVnfInfo' - description: Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED. metadata: type: object 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. extensions: type: object 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. description: This type represents a VNF instance. Clause B.3.2 of ETSI GS NFV-SOL 003 [4] provides examples illustrating the relationship among the different run-time information elements (CP, VL and link ports) used to represent the connectivity of a VNF. InstantiationState: title: InstantiationState enum: - NOT_INSTANTIATED - INSTANTIATED type: string description: The instantiation state of the VNF. example: NOT_INSTANTIATED InstantiatedVnfInfo: title: InstantiatedVnfInfo required: - flavourId - vnfState - extCpInfo type: object properties: flavourId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. vnfState: allOf: - $ref: '#/components/schemas/VnfState' - example: STARTED scaleStatus: type: array items: $ref: '#/components/schemas/ScaleStatus' description: Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how "big" the VNF has been scaled w.r.t. that aspect. maxScaleLevels: type: array items: $ref: '#/components/schemas/MaxScaleLevel' description: Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling. extCpInfo: minItems: 1 type: array items: {} description: Information about the external CPs exposed by the VNF instance. When trunking is enabled, the list of entries includes both, external CPs corresponding to parent ports of a trunk, and external CPs associated to sub-ports of a trunk. extVirtualLinkInfo: type: array items: $ref: '#/components/schemas/ExtVirtualLinkInfo' description: Information about the external VLs the VNF instance is connected to. extManagedVirtualLinkInfo: type: array items: $ref: '#/components/schemas/ExtManagedVirtualLinkInfo' description: External virtual links the VNF instance is connected to. It is possible to have several ExtManagedVirtualLinkInfo for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkInfo corresponding to the same VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance (refer to clause 6.5.3.59). monitoringParameters: type: array items: $ref: '#/components/schemas/MonitoringParameter' description: Performance metrics tracked by the VNFM (e.g. for auto-scaling purposes) as identified by the VNF provider in the VNFD. localizationLanguage: type: string description: Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646. vnfcResourceInfo: type: array items: $ref: '#/components/schemas/VnfcResourceInfo' description: Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance. virtualLinkResourceInfo: type: array items: $ref: '#/components/schemas/VirtualLinkResourceInfo' description: Information about the virtualised network resources used by the VLs of the VNF instance. virtualStorageResourceInfo: type: array items: $ref: '#/components/schemas/VirtualStorageResourceInfo' description: Information on the virtualised storage resource(s) used as storage for the VNF instance. description: Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED. VnfState: title: VnfState enum: - STARTED - STOPPED type: string example: STARTED ScaleStatus: title: ScaleStatus required: - aspectId - scaleLevel type: object properties: aspectId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. vnfdId: type: string description: An identifier with the intention of being globally unique. scaleLevel: type: integer description: Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD. format: int32 MaxScaleLevel: title: MaxScaleLevel required: - aspectId - scaleLevel type: object properties: aspectId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. vnfdId: type: string description: An identifier with the intention of being globally unique. scaleLevel: type: integer description: Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD. format: int32 ExtVirtualLinkInfo: title: ExtVirtualLinkInfo required: - id - resourceHandle type: object properties: id: type: string description: An identifier with the intention of being globally unique. resourceHandle: allOf: - $ref: '#/components/schemas/ResourceHandle' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. extLinkPorts: type: array items: $ref: '#/components/schemas/ExtLinkPort' description: Link ports of this VL. currentVnfExtCpData: allOf: - $ref: '#/components/schemas/CurrentVnfExtCpData' - description: This type represents configuration information for external CPs created from a CPD. ResourceHandle: title: ResourceHandle required: - resourceId type: object properties: vimId: type: string description: An identifier with the intention of being globally unique. resourceProviderId: type: string description: An identifier with the intention of being globally unique. resourceId: type: string description: 'An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.' vimLevelResourceType: type: string description: Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the "vimLevelResourceType" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. ExtLinkPort: title: ExtLinkPort required: - id - resourceHandle type: object properties: id: type: string description: An identifier with the intention of being globally unique. resourceHandle: allOf: - $ref: '#/components/schemas/ResourceHandle' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. cpInstanceId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. description: This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL. CurrentVnfExtCpData: title: CurrentVnfExtCpData required: - cpdId type: object properties: cpdId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. cpConfig: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/CpConfig' - $ref: '#/components/schemas/CpConfig1' description: Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). The map entry value shall be set to "null" in order to delete a "VnfExtCpConfig" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the "VnfExtCpData" structure from its parent data structure. Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the “cpdId’ attribute, there shall be one “cpConfig” entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk. description: This type represents configuration information for external CPs created from a CPD. CpConfig: title: CpConfig required: - linkPortId type: object properties: parentCpConfigId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. linkPortId: type: string description: An identifier with the intention of being globally unique. cpProtocolData: type: array items: $ref: '#/components/schemas/CpProtocolDatum' description: >- Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes "linkPortId" and "cpProtocolData": * At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for a to-be-created external CP instance or an existing external CP instance. * If the "linkPortId" attribute is absent, the VNFM shall create a link port. * If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a pre-created link port, and the VNFM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port. * If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by "linkPortId". CpProtocolDatum: title: CpProtocolDatum required: - layerProtocol type: object properties: layerProtocol: enum: - IP_OVER_ETHERNET type: string description: 'Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.' example: IP_OVER_ETHERNET ipOverEthernet: description: This type represents network address data for IP over Ethernet. description: This type represents network protocol data. CpConfig1: title: CpConfig1 required: - cpProtocolData type: object properties: parentCpConfigId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. linkPortId: type: string description: An identifier with the intention of being globally unique. cpProtocolData: type: array items: $ref: '#/components/schemas/CpProtocolDatum' description: >- Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes "linkPortId" and "cpProtocolData": * At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for a to-be-created external CP instance or an existing external CP instance. * If the "linkPortId" attribute is absent, the VNFM shall create a link port. * If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a pre-created link port, and the VNFM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port. * If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by "linkPortId". CpConfig2: title: CpConfig2 type: object properties: parentCpConfigId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. linkPortId: type: string description: An identifier with the intention of being globally unique. cpProtocolData: type: array items: $ref: '#/components/schemas/CpProtocolDatum' description: >- Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes "linkPortId" and "cpProtocolData": * At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for a to-be-created external CP instance or an existing external CP instance. * If the "linkPortId" attribute is absent, the VNFM shall create a link port. * If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a pre-created link port, and the VNFM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port. * If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by "linkPortId". ExtManagedVirtualLinkInfo: title: ExtManagedVirtualLinkInfo required: - id - vnfVirtualLinkDescId type: object properties: id: type: string description: An identifier with the intention of being globally unique. vnfdId: type: string description: An identifier with the intention of being globally unique. vnfVirtualLinkDescId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. networkResource: allOf: - $ref: '#/components/schemas/NetworkResource' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. vnfLinkPorts: type: array items: $ref: '#/components/schemas/VnfLinkPort' description: Link ports of this VL. extManagedMultisiteVirtualLinkId: type: string description: An identifier with the intention of being globally unique. NetworkResource: title: NetworkResource required: - resourceId type: object properties: vimId: type: string description: An identifier with the intention of being globally unique. resourceProviderId: type: string description: An identifier with the intention of being globally unique. resourceId: type: string description: 'An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.' vimLevelResourceType: type: string description: Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the "vimLevelResourceType" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. VnfLinkPort: title: VnfLinkPort required: - id - resourceHandle type: object properties: id: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. resourceHandle: allOf: - $ref: '#/components/schemas/ResourceHandle' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. cpInstanceId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. cpInstanceType: allOf: - $ref: '#/components/schemas/CpInstanceType' - description: 'Type of the CP instance that is identified by cpInstanceId. Shall be present if "cpInstanceId" is present, and shall be absent otherwise. Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP.' example: VNFC_CP CpInstanceType: title: CpInstanceType enum: - VNFC_CP - EXT_CP type: string description: 'Type of the CP instance that is identified by cpInstanceId. Shall be present if "cpInstanceId" is present, and shall be absent otherwise. Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP.' example: VNFC_CP MonitoringParameter: title: MonitoringParameter required: - id - performanceMetric type: object properties: id: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' vnfdId: type: string description: An identifier with the intention of being globally unique. name: type: string description: Human readable name of the monitoring parameter, as defined in the VNFD. performanceMetric: type: string description: Performance metric that is monitored. This attribute shall contain the related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027. description: This type represents a monitoring parameter that is tracked by the VNFM, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.69-1. VnfcResourceInfo: title: VnfcResourceInfo required: - id - vduId - computeResource type: object properties: id: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. vnfdId: type: string description: An identifier with the intention of being globally unique. vduId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. computeResource: allOf: - $ref: '#/components/schemas/ComputeResource' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. storageResourceIds: type: array items: type: string description: References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance. reservationId: type: string description: An identifier with the intention of being globally unique. vnfcCpInfo: type: array items: $ref: '#/components/schemas/VnfcCpInfo' description: CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance or is connected to an external CP of the VNF instance. A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. May be present otherwise. metadata: type: object 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. description: This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance. ComputeResource: title: ComputeResource required: - resourceId type: object properties: vimId: type: string description: An identifier with the intention of being globally unique. resourceProviderId: type: string description: An identifier with the intention of being globally unique. resourceId: type: string description: 'An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.' vimLevelResourceType: type: string description: Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the "vimLevelResourceType" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. VnfcCpInfo: title: VnfcCpInfo required: - id - cpdId type: object properties: id: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. cpdId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. vnfExtCpId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. cpProtocolInfo: type: array items: $ref: '#/components/schemas/CpProtocolInfo' description: Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. The information can be omitted because it is already available as part of the external CP information. vnfLinkPortId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. metadata: type: object 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. CpProtocolInfo: title: CpProtocolInfo required: - layerProtocol - ipOverEthernet type: object properties: layerProtocol: enum: - IP_OVER_ETHERNET type: string description: 'The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.' example: IP_OVER_ETHERNET ipOverEthernet: description: This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1. description: This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1. VirtualLinkResourceInfo: title: VirtualLinkResourceInfo required: - id - vnfVirtualLinkDescId - networkResource type: object properties: id: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. vnfdId: type: string description: An identifier with the intention of being globally unique. vnfVirtualLinkDescId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. networkResource: allOf: - $ref: '#/components/schemas/NetworkResource' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. reservationId: type: string description: An identifier with the intention of being globally unique. vnfLinkPorts: type: array items: $ref: '#/components/schemas/VnfLinkPort' description: Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise. metadata: type: object 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. description: This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance. VirtualStorageResourceInfo: title: VirtualStorageResourceInfo required: - id - virtualStorageDescId - storageResource type: object properties: id: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. virtualStorageDescId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. vnfdId: type: string description: An identifier with the intention of being globally unique. storageResource: allOf: - $ref: '#/components/schemas/StorageResource' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. reservationId: type: string description: An identifier with the intention of being globally unique. metadata: type: object 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. description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. StorageResource: title: StorageResource required: - resourceId type: object properties: vimId: type: string description: An identifier with the intention of being globally unique. resourceProviderId: type: string description: An identifier with the intention of being globally unique. resourceId: type: string description: 'An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.' vimLevelResourceType: type: string description: Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the "vimLevelResourceType" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. PnfInfo: title: PnfInfo required: - pnfId - pnfdId - pnfdInfoId - pnfProfileId type: object properties: pnfId: type: string description: An identifier with the intention of being globally unique. pnfName: type: string description: Name of the PNF. pnfdId: type: string description: An identifier with the intention of being globally unique. pnfdInfoId: type: string description: An identifier with the intention of being globally unique. pnfProfileId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' cpInfo: allOf: - $ref: '#/components/schemas/CpInfo' - description: This type represents the information about the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.17-1. description: This type represents the information about a PNF that is part of an NS instance. It shall comply with the provisions defined in Table 6.5.3.13-1. CpInfo: title: CpInfo required: - cpInstanceId - cpdId type: object properties: cpInstanceId: type: string description: 'An Identifier that is unique within respect to a PNF. Representation: string of variable length.' cpdId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' cpProtocolData: type: array items: $ref: '#/components/schemas/CpProtocolDatum' description: Parameters for configuring the network protocols on the CP. description: This type represents the information about the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.17-1. VirtualLinkInfo: title: VirtualLinkInfo required: - id - nsVirtualLinkDescId - nsVirtualLinkProfileId type: object properties: id: type: string description: 'An identifier that is unique with respect to a NS. Representation: string of variable length.' nsVirtualLinkDescId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' nsVirtualLinkProfileId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' resourceHandle: type: array items: $ref: '#/components/schemas/ResourceHandle' description: Identifier(s) of the virtualised network resource(s) and/or multi-site connectivity service(s) realizing the VL instance. As an NS can include NFs deployed in NFVI PoPs under the control of several different VIMs, therefore deploying an NS VL can involve several VIMs, each allocating different virtualised network resources, as well as WIMs handling the connectivity in between the NFVI-PoPs in the form of multi-site connectivity services. When this NsVirtualLink is provided as an ExtVirtualLink as input of a VNF LCM operation, the id of the ExtVirtualLink shall be the same as the corresponding NsVirtualLink. linkPort: type: array items: $ref: '#/components/schemas/LinkPort' description: Link ports of the VL instance. Cardinality of zero indicates that no port has yet been created for the VL instance. description: This type specifies the information about an NS VL instance. It shall comply with the provisions defined in Table 6.5.3.53-1 LinkPort: title: LinkPort required: - id - resourceHandle type: object properties: id: type: string description: An identifier with the intention of being globally unique. resourceHandle: allOf: - $ref: '#/components/schemas/ResourceHandle' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. nsCpHandle: type: array items: {} description: Identifier of the CP/SAP instance to be connected to this link port. The value refers to a vnfExtCpInfo item in the VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a sapInfo item in the NS instance. There shall be at most one link port associated with any connection point instance. description: This type represents information about a link port of a VL instance. It shall comply with the provisions defined in Table 6.5.3.55-1. VnffgInfo: title: VnffgInfo required: - id - vnffgdId - vnfInstanceId type: object properties: id: type: string description: An identifier with the intention of being globally unique. vnffgdId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' vnfInstanceId: type: array items: type: string description: Identifier(s) of the constituent VNF instance(s) of this VNFFG instance. pnfdInfoId: type: array items: type: string description: Identifier(s) of the constituent PNF instance(s) of this VNFFG instance. nsVirtualLinkInfoId: type: array items: type: string description: Identifier(s) of the constituent VL instance(s) of this VNFFG instance. nsCpHandle: type: array items: {} description: Identifiers of the CP instances attached to the constituent VNFs and PNFs or the SAP instances of the VNFFG. See note. description: Information on the VNFFG(s) of the NS instance. SapInfo: title: SapInfo required: - id - sapdId - sapName - sapProtocolInfo type: object properties: id: type: string description: 'An identifier that is unique with respect to a NS. Representation: string of variable length.' sapdId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' sapName: type: string description: Human readable name for the SAP instance. description: type: string description: Human readable description for the SAP instance. sapProtocolInfo: type: array items: $ref: '#/components/schemas/SapProtocolInfo' description: Network protocol information for this SAP. description: This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1. SapProtocolInfo: title: SapProtocolInfo required: - layerProtocol - ipOverEthernet type: object properties: layerProtocol: enum: - IP_OVER_ETHERNET type: string description: 'The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.' example: IP_OVER_ETHERNET ipOverEthernet: description: This type represents information about a network address that has been assigned. It shall comply with the provisions defined in Table 6.5.3.18-1. description: This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1. NsState: title: NsState enum: - NOT_INSTANTIATED - INSTANTIATED type: string description: 'The state of the NS instance. Permitted values: NOT_INSTANTIATED: The NS instance is terminated or not instantiated. INSTANTIATED: The NS instance is instantiated.' example: NOT_INSTANTIATED MonitoringParameter1: title: MonitoringParameter1 required: - id - performanceMetric type: object properties: id: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' name: type: string description: Human readable name of the monitoring parameter, as defined in the NSD. performanceMetric: type: string description: Performance metric that is monitored. This attribute shall contain the related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027. description: This type represents a monitoring parameter that is tracked by the NFVO, for example, for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.68-1. NsScaleStatus: title: NsScaleStatus required: - nsScalingAspectId - nsScaleLevelId type: object properties: nsScalingAspectId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' nsScaleLevelId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' description: This type represents the target NS Scale level for each NS scaling aspect of the current deployment flavor. AdditionalAffinityOrAntiAffinityRule: title: AdditionalAffinityOrAntiAffinityRule required: - affinityOrAntiAffiinty - scope type: object properties: vnfdId: type: array items: type: string description: Reference to a VNFD. When the VNFD which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VNFD presents is not necessary as a part of the NS to be instantiated. vnfProfileId: type: array items: type: string description: Reference to a vnfProfile defined in the NSD. At least one VnfProfile which is used to instantiate VNF for the NS to be instantiated as the subject of the affinity or anti-affinity rule shall be present. When the VnfProfile which is not used to instantiate VNF, it presents all VNF instances of this type as the subjects of the affinity or anti-affinity rule. The VNF instance which the VnfProfile presents is not necessary as a part of the NS to be instantiated. vnfInstanceId: type: array items: type: string description: Reference to the existing VNF instance as the subject of the affinity or anti-affinity rule. The existing VNF instance is not necessary as a part of the NS to be instantiated. affinityOrAntiAffiinty: allOf: - $ref: '#/components/schemas/AffinityOrAntiAffiinty' - description: 'The type of the constraint. Permitted values: AFFINITY ANTI_AFFINITY.' example: AFFINITY scope: allOf: - $ref: '#/components/schemas/Scope' - description: 'Specifies the scope of the rule where the placement constraint applies. Permitted values: NFVI_POP ZONE ZONE_GROUP NFVI_NODE.' example: NFVI_POP description: This type describes the additional affinity or anti-affinity rule applicable between the VNF instances to be instantiated in the NS instantiation operation request or between the VNF instances to be instantiated in the NS instantiation operation request and the existing VNF instances.. AffinityOrAntiAffiinty: title: AffinityOrAntiAffiinty enum: - AFFINITY - ANTI_AFFINITY type: string description: 'The type of the constraint. Permitted values: AFFINITY ANTI_AFFINITY.' example: AFFINITY Scope: title: Scope enum: - NFVI_POP - ZONE - ZONE_GROUP - NFVI_NODE type: string description: 'Specifies the scope of the rule where the placement constraint applies. Permitted values: NFVI_POP ZONE ZONE_GROUP NFVI_NODE.' example: NFVI_POP Links26: title: Links26 required: - self type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. nestedNsInstances: type: array items: $ref: '#/components/schemas/NestedNsInstance' description: Links to resources related to this notification. vnfSnapshotInfos: type: array items: $ref: '#/components/schemas/VnfSnapshotInfo' description: Links to the VNF snapshots associated to VNF instances which are part of this NS instance. instantiate: allOf: - $ref: '#/components/schemas/Instantiate' - description: This type represents a link to a resource. terminate: allOf: - $ref: '#/components/schemas/Terminate' - description: This type represents a link to a resource. update: allOf: - $ref: '#/components/schemas/Update' - description: This type represents a link to a resource. scale: allOf: - $ref: '#/components/schemas/Scale' - description: This type represents a link to a resource. heal: allOf: - $ref: '#/components/schemas/Heal' - description: This type represents a link to a resource. description: Links to resources related to this resource. NestedNsInstance: title: NestedNsInstance required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. VnfSnapshotInfo: title: VnfSnapshotInfo required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Instantiate: title: Instantiate required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Terminate: title: Terminate required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Update: title: Update required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Scale: title: Scale required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Heal: title: Heal required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. NsLcmOpOccsResponse: title: NsLcmOpOccsResponse required: - id - operationState - statusEnteredTime - nsInstanceId - lcmOperationType - startTime - isAutomaticInvocation - isCancelPending - _links type: object properties: id: type: string description: An identifier with the intention of being globally unique. operationState: allOf: - $ref: '#/components/schemas/OperationState' - description: The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1. Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible. example: PROCESSING statusEnteredTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' nsInstanceId: type: string description: An identifier with the intention of being globally unique. lcmOperationType: allOf: - $ref: '#/components/schemas/LcmOperationType' - description: The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the "Instantiate NS" LCM operation. SCALE | Represents the "Scale NS" LCM operation. UPDATE | Represents the "Update NS" LCM operation. TERMINATE | Represents the "Terminate NS" LCM operation. HEAL | Represents the "Heal NS" LCM operation. example: INSTANTIATE startTime: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' isAutomaticInvocation: type: boolean description: Set to true if this NS LCM operation occurrence has been automatically triggered by the NFVO. This occurs in the case of auto-scaling, auto-healing and when a nested NS is modified as a result of an operation on its composite NS. Set to false otherwise. operationParams: allOf: - $ref: '#/components/schemas/OperationParams' - description: 'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between lcmOperationType and the data type of this attribute shall apply: - INSTANTIATE: InstantiateNsRequest - SCALE: ScaleNsRequest - UPDATE: UpdateNsRequest - HEAL: HealNsRequest - TERMINATE: TerminateNsRequest This attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.' example: INSTANTIATE isCancelPending: type: boolean description: If the LCM operation occurrence is in "PROCESSING" or "ROLLING_BACK" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false. cancelMode: allOf: - $ref: '#/components/schemas/CancelMode' - description: >- Cancellation mode. The NFVO shall not start any new VNF lifecycle management and resource management operation, and shall wait for the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, to finish execution or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state. The NFVO shall not start any new VNF lifecycle management and resource management operation, shall cancel the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state. example: GRACEFUL error: allOf: - $ref: '#/components/schemas/Error' - description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced in this 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]. resourceChanges: allOf: - $ref: '#/components/schemas/ResourceChanges' - description: This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable _links: allOf: - $ref: '#/components/schemas/Links31' - description: Links to resources related to this resource. description: This type represents a request a NS lifecycle operation occurrence. It shall comply with the provisions defined in Table 6.5.2.3-1. OperationState: title: OperationState enum: - PROCESSING - COMPLETED - FAILED_TEMP - FAILED - ROLLING_BACK - ROLLED_BACK type: string description: The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1. Value | Description ------|------------ PROCESSING | The LCM operation is currently in execution. COMPLETED | The LCM operation has been completed successfully. PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. OLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible. example: PROCESSING LcmOperationType: title: LcmOperationType enum: - INSTANTIATE - SCALE - UPDATE - TERMINATE - HEAL type: string description: The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation occurrence notification. Value | Description ------|------------ INSTANTIATE | Represents the "Instantiate NS" LCM operation. SCALE | Represents the "Scale NS" LCM operation. UPDATE | Represents the "Update NS" LCM operation. TERMINATE | Represents the "Terminate NS" LCM operation. HEAL | Represents the "Heal NS" LCM operation. example: INSTANTIATE OperationParams: title: OperationParams enum: - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE type: string description: 'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between lcmOperationType and the data type of this attribute shall apply: - INSTANTIATE: InstantiateNsRequest - SCALE: ScaleNsRequest - UPDATE: UpdateNsRequest - HEAL: HealNsRequest - TERMINATE: TerminateNsRequest This attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.' example: INSTANTIATE CancelMode: title: CancelMode enum: - GRACEFUL - FORCEFUL type: string description: >- Cancellation mode. The NFVO shall not start any new VNF lifecycle management and resource management operation, and shall wait for the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, to finish execution or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state. The NFVO shall not start any new VNF lifecycle management and resource management operation, shall cancel the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state. example: GRACEFUL Error: title: Error required: - status - detail type: object properties: type: type: string 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". title: type: string 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). status: type: integer 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. format: int32 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced. description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is reproduced in this 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]. ResourceChanges: title: ResourceChanges type: object properties: affectedVnfs: type: array items: {} description: Information about the VNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. affectedPnfs: type: array items: $ref: '#/components/schemas/AffectedPnf' description: Information about the PNF instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. affectedVls: type: array items: $ref: '#/components/schemas/AffectedVl' description: Information about the VL instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. affectedVnffgs: type: array items: $ref: '#/components/schemas/AffectedVnffg' description: Information about the VNFFG instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note affectedNss: type: array items: $ref: '#/components/schemas/AffectedNss' description: Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note. affectedSaps: type: array items: $ref: '#/components/schemas/AffectedSap' description: Information about the nested NS instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation. See note. description: This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable AffectedPnf: title: AffectedPnf required: - pnfId - pnfdId - pnfProfileId - cpInstanceId type: object properties: pnfId: type: string description: An identifier with the intention of being globally unique. pnfdId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' pnfProfileId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' pnfName: type: string description: Name of the PNF. cpInstanceId: type: array items: type: string description: Identifier of the CP in the scope of the PNF. changeType: allOf: - $ref: '#/components/schemas/ChangeType1' - description: 'Signals the type of change. Permitted values: - ADD - REMOVE - MODIFY' example: ADD changeResult: allOf: - $ref: '#/components/schemas/ChangeResult' - description: 'Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED' example: COMPLETED description: This type provides information about added, deleted and modified PNFs. It shall comply with the provisions in Table 6.5.3.3-1. ChangeType1: title: ChangeType1 enum: - ADD - REMOVE - MODIFY type: string description: 'Signals the type of change. Permitted values: - ADD - REMOVE - MODIFY' example: ADD ChangeResult: title: ChangeResult enum: - COMPLETED - ROLLED_BACK - FAILED type: string description: 'Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED' example: COMPLETED AffectedVl: title: AffectedVl required: - id - virtualLinkDescId - changeType - networkResource type: object properties: id: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. virtualLinkDescId: type: string description: Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. changeType: allOf: - $ref: '#/components/schemas/ChangeType2' - description: 'Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.' example: ADDED linkPortIds: type: array items: type: string description: Identifiers of the link ports of the affected VL related to the change. Each identifier references an "NsLinkPortInfo" structure. Shall be set when changeType is equal to "ADD_LINK_PORT" or "REMOVE_LINK_PORT", and the related "NsLinkPortInfo" structures are present (case "add") or have been present (case "remove") in the NsVirtualLinkInfo structure that is represented by the "virtualLink¬Info" attribute in the "NsInstance" structure. The resource handles of the affected NS link ports can be found by dereferencing the identifiers in the "linkPortIds" attribute. networkResource: allOf: - $ref: '#/components/schemas/NetworkResource' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. metadata: type: object 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. description: This type provides information about added, deleted, modified and temporary VLs. ChangeType2: title: ChangeType2 enum: - ADDED - REMOVED - MODIFIED - TEMPORARY - LINK_PORT_ADDED - LINK_PORT_REMOVED type: string description: 'Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.' example: ADDED AffectedVnffg: title: AffectedVnffg required: - vnffgInstanceId - vnffgdId type: object properties: vnffgInstanceId: type: string description: 'An identifier that is unique with respect to a NS. Representation: string of variable length.' vnffgdId: type: string description: 'An identifier that is unique within a NS descriptor. Representation: string of variable length.' changeType: allOf: - $ref: '#/components/schemas/ChangeType3' - description: 'Signals the type of change. Permitted values: - ADD - DELETE - MODIFY' example: ADD changeResult: allOf: - $ref: '#/components/schemas/ChangeResult' - description: 'Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED' example: COMPLETED description: This type provides information about added, deleted and modified VNFFG instances. It shall comply with the provisions in Table 6.5.3.5-1. ChangeType3: title: ChangeType3 enum: - ADD - DELETE - MODIFY type: string description: 'Signals the type of change. Permitted values: - ADD - DELETE - MODIFY' example: ADD AffectedNss: title: AffectedNss required: - nsInstanceId - nsdId - changeType - changeResult type: object properties: nsInstanceId: type: string description: An identifier with the intention of being globally unique. nsdId: type: string description: An identifier with the intention of being globally unique. changeType: allOf: - $ref: '#/components/schemas/ChangeType4' - description: 'Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE' example: ADD changeResult: allOf: - $ref: '#/components/schemas/ChangeResult3' - description: 'Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED - PARTIALLY_COMPLETED' example: COMPLETED changedInfo: allOf: - $ref: '#/components/schemas/ChangedInfo6' - description: Information about the changed NS instance information, if applicable. description: This type provides information about added, deleted and modified nested NSs. It shall comply with the provisions in Table 6.5.3.6-1. ChangeType4: title: ChangeType4 enum: - ADD - REMOVE - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE type: string description: 'Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE' example: ADD ChangeResult3: title: ChangeResult3 enum: - COMPLETED - ROLLED_BACK - FAILED - PARTIALLY_COMPLETED type: string description: 'Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED - PARTIALLY_COMPLETED' example: COMPLETED ChangedInfo6: title: ChangedInfo6 type: object properties: wanConnectionInfoModifications: type: array items: $ref: '#/components/schemas/WanConnectionInfoModification' description: Information about the modified WAN related connectivity information, if applicable. description: Information about the changed NS instance information, if applicable. WanConnectionInfoModification: title: WanConnectionInfoModification required: - wanConnectionInfoId type: object properties: wanConnectionInfoId: type: string description: An identifier with the intention of being globally unique. mscsName: type: string description: If present, this attribute signals modifications of the "mscsName" attribute in "MscsInfo" as defined in clause 6.5.3.82. mscsDescription: type: string description: If present, this attribute signals modifications of the "mscsDescription" attribute in "MscsInfo" as defined in clause 6.5.3.82. mscsEndpoints: type: array items: $ref: '#/components/schemas/MscsEndpoint' description: If present, this attribute signals modifications of certain entries in the "mscsEndpoints" attribute array in "MscsInfo", as defined in clause 6.5.3.82. removeMscsEndpointIds: type: array items: type: string description: If present, this attribute signals the deletion of certain entries in the "mscsEndpoints" attribute array in "MscsInfo", as defined in clause 6.5.3.82. connectivityServiceEndpoints: type: array items: $ref: '#/components/schemas/ConnectivityServiceEndpoint' description: If present, this attribute signals modifications of certain entries in the "connectivityServiceEndpoints" attribute array in "WanConnectionProtocolInfo", as defined in clause 6.5.3.91. removeConnectivityServiceEndpoints: type: array items: type: string description: If present, this attribute signals the deletion of certain entries in the "connectivityServiceEndpoints" attribute array in "WanConnectionProtocolInfo", as defined in clause 6.5.3.91. description: This type represents attribute modifications that were performed on WAN connection information. The attributes that can be included consist of those requested to be modified explicitly with the "UpdateNsRequest" data structure. It shall comply with the provisions defined in table 6.5.3.93-1. MscsEndpoint: title: MscsEndpoint required: - mscsEndpointId - directionality - connectivityServiceEndpoinId type: object properties: mscsEndpointId: type: string description: An identifier with the intention of being globally unique. directionality: allOf: - $ref: '#/components/schemas/Directionality' - description: 'Directionality of the data traffic in the context of the terminating MSCS endpoint from WAN’s perspective. Permitted values: - INBOUND: to indicate into the WAN. - OUTBOUND: to indicate from the WAN. - BOTH: to indicate bidirectional data traffic to/from the WAN.' example: INBOUND connectivityServiceEndpoinId: type: array items: type: string description: References the connectivity service endpoint configuration information applicable to support the MSCS endpoint. More than one connectivity service endpoint can be referred when endpoints are in LAG mode. description: This type provides encapsulates information about an MSCS endpoint of the MSCS. It shall comply with the provisions defined in table 6.5.3.83-1. Directionality: title: Directionality enum: - INBOUND - OUTBOUND - BOTH type: string description: 'Directionality of the data traffic in the context of the terminating MSCS endpoint from WAN’s perspective. Permitted values: - INBOUND: to indicate into the WAN. - OUTBOUND: to indicate from the WAN. - BOTH: to indicate bidirectional data traffic to/from the WAN.' example: INBOUND ConnectivityServiceEndpoint: title: ConnectivityServiceEndpoint required: - connectivityServiceEndpointId - vimId type: object properties: connectivityServiceEndpointId: type: string description: An identifier with the intention of being globally unique. vimId: type: string description: An identifier with the intention of being globally unique. siteToWanLayer2ProtocolData: allOf: - $ref: '#/components/schemas/SiteToWanLayer2ProtocolData' - description: This type provides information about Layer 2 protocol specific information for the configuration of the NFVI-PoP network gateway to enable the stitching of the intra-site VN to the MSCS over the WAN. It shall comply with the provisions defined in Table 6.5.3.85-1. siteToWanLayer3ProtocolData: allOf: - $ref: '#/components/schemas/SiteToWanLayer3ProtocolData' - description: This type provides information about Layer 3 protocol specific information for the stitching of the intra-site VN to the multi-site connectivity service over the WAN. It shall comply with the provisions defined in Table 6.5.3.86-1. description: This type provides configuration data for the NFVI-PoP network gateway providing connectivity service endpoints. The connectivity service endpoints are used as endpoints by an MSCS. It shall comply with the provisions defined in Table 6.5.3.84-1. SiteToWanLayer2ProtocolData: title: SiteToWanLayer2ProtocolData required: - layer2ConnectionInfo type: object properties: layer2ConnectionInfo: allOf: - $ref: '#/components/schemas/Layer2ConnectionInfo' - description: Layer 2 protocol parameters of the connectivity service endpoint (CSE). mtuL2: type: number description: Maximum Transmission Unit (MTU) that can be forwarded at layer 2 (in bytes). Default value is "1500" (bytes). virtualRoutingAndForwarding: allOf: - $ref: '#/components/schemas/VirtualRoutingAndForwarding' - description: Configuration related to the L2 virtual routing and forwarding (MAC-VRF). forwardingConfig: description: Information related to the forwarding of the VN in the NFVI-PoP to the connectivity service endpoint, if information about the VN to "stitch" is already known. . by the OSS/BSS. Shall not be provided otherwise, in which case the NFVO will infer the forwarding configuration based on the NS VL, or external VL, or externally-managed VL provisioning. description: This type provides information about Layer 2 protocol specific information for the configuration of the NFVI-PoP network gateway to enable the stitching of the intra-site VN to the MSCS over the WAN. It shall comply with the provisions defined in Table 6.5.3.85-1. Layer2ConnectionInfo: title: Layer2ConnectionInfo required: - connectionType - interfaceType - interfaceTagging - encapsulationType type: object properties: connectionType: allOf: - $ref: '#/components/schemas/ConnectionType' - description: 'The type of connection to be established on the connectivity service point. Permitted values: - CSE: defined by the characteristics of the existing referred connectivity service point. - AGGREGATE_CSE: create an aggregation of the connectivity service endpoints.' example: CSE interfaceType: allOf: - $ref: '#/components/schemas/InterfaceType' - description: 'To indicate whether to create logical interfaces on the referred connectivity service endpoint or new aggregated connectivity service endpoint. Permitted values: - PARENT: use the mapped interface to the connectivity service endpoint as is, i.e., do not create logical interfaces. - LOGICAL: create logical interfaces.' example: PARENT interfaceTagging: allOf: - $ref: '#/components/schemas/InterfaceTagging' - description: 'The type of frames to forward on the connectivity service point. Permitted values: - UNTAGGED: an interface where frames are not tagged. - TAGGED: an interface configured to forward tagged frames (i.e., enabled for VLAN tagging).' example: UNTAGGED encapsulationType: allOf: - $ref: '#/components/schemas/EncapsulationType' - description: 'The type of encapsulation. If the interfaceTagging="TAGGED", either "VLAN" or "VXLAN" shall be set. Permitted values: - ETH: generic Ethernet encapsulation. - VLAN: encapsulation based on VLAN. - VXLAN: encapsulation based on VXLAN.' example: ETH vlanTaggingType: allOf: - $ref: '#/components/schemas/VlanTaggingType' - description: >- Type of encapsulation method for VLAN tagging. Shall be present if interfaceTagging="TAGGED" and encapsulationType="VLAN". Permitted values: - DOT1Q: used when packets on the CSE are encapsulated with one or a set of customer VLAN identifiers. - QINQ: used when packets on the CSE are encapsulated with multiple customer VLAN identifiers and a single service VLAN identifier. - QINANY: used when packets on the CSE have no specific customer VLAN and a service VLAN identifier is used. example: DOT1Q wanSegmentIds: allOf: - $ref: '#/components/schemas/WanSegmentIds' - description: Segment identifiers to pass on the tagged interface. Shall be present if encapsulationType="VLAN" or “VXLAN". vxlanConfig: allOf: - $ref: '#/components/schemas/VxlanConfig' - description: Additional configuration needed when using VXLAN encapsulation. Shall be present if interfaceTagging="TAGGED" and encapsulationType="VXLAN". lagInterfaceData: allOf: - $ref: '#/components/schemas/LagInterfaceData' - description: Information for setting up a LAG interface aggregating multiple connectivity service endpoints. layer2ControlProtocol: type: object 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. description: Layer 2 protocol parameters of the connectivity service endpoint (CSE). ConnectionType: title: ConnectionType enum: - CSE - AGGREGATE_CSE type: string description: 'The type of connection to be established on the connectivity service point. Permitted values: - CSE: defined by the characteristics of the existing referred connectivity service point. - AGGREGATE_CSE: create an aggregation of the connectivity service endpoints.' example: CSE InterfaceType: title: InterfaceType enum: - PARENT - LOGICAL type: string description: 'To indicate whether to create logical interfaces on the referred connectivity service endpoint or new aggregated connectivity service endpoint. Permitted values: - PARENT: use the mapped interface to the connectivity service endpoint as is, i.e., do not create logical interfaces. - LOGICAL: create logical interfaces.' example: PARENT InterfaceTagging: title: InterfaceTagging enum: - UNTAGGED - TAGGED type: string description: 'The type of frames to forward on the connectivity service point. Permitted values: - UNTAGGED: an interface where frames are not tagged. - TAGGED: an interface configured to forward tagged frames (i.e., enabled for VLAN tagging).' example: UNTAGGED EncapsulationType: title: EncapsulationType enum: - ETH - VLAN - VXLAN type: string description: 'The type of encapsulation. If the interfaceTagging="TAGGED", either "VLAN" or "VXLAN" shall be set. Permitted values: - ETH: generic Ethernet encapsulation. - VLAN: encapsulation based on VLAN. - VXLAN: encapsulation based on VXLAN.' example: ETH VlanTaggingType: title: VlanTaggingType enum: - DOT1Q - QINQ - QINANY type: string description: >- Type of encapsulation method for VLAN tagging. Shall be present if interfaceTagging="TAGGED" and encapsulationType="VLAN". Permitted values: - DOT1Q: used when packets on the CSE are encapsulated with one or a set of customer VLAN identifiers. - QINQ: used when packets on the CSE are encapsulated with multiple customer VLAN identifiers and a single service VLAN identifier. - QINANY: used when packets on the CSE have no specific customer VLAN and a service VLAN identifier is used. example: DOT1Q WanSegmentIds: title: WanSegmentIds required: - wanSegmentIdValue type: object properties: wanSegmentIdValue: type: string description: Identifier of the network segment (e.g., VLAN id or VNI). wanSegmentIdUpperRange: type: string description: Identifier of the upper range network segment, in case the "wanSegmentIds" is used to define a range. description: Segment identifiers to pass on the tagged interface. Shall be present if encapsulationType="VLAN" or “VXLAN". VxlanConfig: title: VxlanConfig required: - peerMode type: object properties: peerMode: allOf: - $ref: '#/components/schemas/PeerMode' - description: >- Type of VXLAN access mode. Default value is "STATIC". Permitted values: - STATIC - BGP_EVPN example: STATIC peers: type: array items: type: string description: List of IP addresses of VTEP peers when using static mode. description: Additional configuration needed when using VXLAN encapsulation. Shall be present if interfaceTagging="TAGGED" and encapsulationType="VXLAN". PeerMode: title: PeerMode enum: - STATIC - BGP_EVPN type: string description: >- Type of VXLAN access mode. Default value is "STATIC". Permitted values: - STATIC - BGP_EVPN example: STATIC LagInterfaceData: title: LagInterfaceData required: - aggregatedEndpoints - lacpActivation - lacpConfig type: object properties: aggregatedEndpoints: type: array items: type: string description: List of the connectivity service endpoints that are to be aggregated. Shall be present if connectionType="AGGREGATE_CSE". In case of aggregating connectivity service endpoints, only one SiteToWanLayer2ProtocolData shall be provided for the whole set of aggregated endpoints. lacpActivation: type: boolean description: Indicates whether to activate LACP on the interface. If "TRUE", the LACP is to be activated, or "FALSE" otherwise. Default value is "FALSE". lacpConfig: type: object 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. description: Information for setting up a LAG interface aggregating multiple connectivity service endpoints. VirtualRoutingAndForwarding: title: VirtualRoutingAndForwarding required: - macVrfName type: object properties: macVrfName: type: string description: Name (or identifier) of the MAC-VRF instance. description: Configuration related to the L2 virtual routing and forwarding (MAC-VRF). SiteToWanLayer3ProtocolData: title: SiteToWanLayer3ProtocolData required: - routingInfo type: object properties: logicalInterfaceIpAddress: allOf: - $ref: '#/components/schemas/LogicalInterfaceIpAddress' - description: IP addressing information associated to a logical interface. Shall be present if the "interfaceType" of the SiteToWanLayer2ProtocolData is equal to "LOGICAL". routingInfo: allOf: - $ref: '#/components/schemas/RoutingInfo' - description: The routing information that is activated on the connectivity service endpoint. More than one "routingInfo" is allowed to enable stacking different routing protocols (e.g., one routing protocol for IPv4 and another one for IPv6). mtuL3: type: number description: Maximum Transmission Unit (MTU) that can be forwarded at layer 3 (in bytes). Default value is "1500" (bytes). virtualRoutingAndForwarding: allOf: - $ref: '#/components/schemas/VirtualRoutingAndForwarding1' - description: Configuration related to the virtual routing and forwarding (VRF). bfdConfig: type: object 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. description: This type provides information about Layer 3 protocol specific information for the stitching of the intra-site VN to the multi-site connectivity service over the WAN. It shall comply with the provisions defined in Table 6.5.3.86-1. LogicalInterfaceIpAddress: title: LogicalInterfaceIpAddress required: - ipAddress - associatedSegmentId type: object properties: ipAddress: type: string 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.' associatedSegmentId: type: string description: The associated segment identifier that has triggered the creation of the logical interface. The value shall be one of the values listed in the "wanSegmentIds" of the "siteToWanLayer2ProtocolData". description: IP addressing information associated to a logical interface. Shall be present if the "interfaceType" of the SiteToWanLayer2ProtocolData is equal to "LOGICAL". RoutingInfo: title: RoutingInfo required: - routingProtocol - routingAddressFamily type: object properties: routingProtocol: allOf: - $ref: '#/components/schemas/RoutingProtocol' - description: >- The routing protocol that is activated on the connectivity service endpoint. Permitted values: - BGP: used for dynamic routing BGPv4. - RIP: used for dynamic routing RIPv2. - OSPF: used for dynamic routing (OSPF version 2 for IPv4; and OSPF version 3 for IPv6). - STATIC: used for static routing. - DIRECT: used when the NFVI-PoP network is directly connected to the WAN provider network. - VRRP: used when the NFVI-PoP network is directly connected to the WAN provider network with virtual router redundancy protocol support (VRRP). example: BGP staticRouting: allOf: - $ref: '#/components/schemas/StaticRouting' - description: Defines a static route. It shall only be present if the routingProtocol="STATIC". routingAddressFamily: allOf: - $ref: '#/components/schemas/RoutingAddressFamily' - description: 'The IP version applicable to the dynamic routing protocol. Shall be present for dynamic routing protocols. Permitted values: - IPV4 - IPV6' example: IPV4 ospfRouting: allOf: - $ref: '#/components/schemas/OspfRouting' - description: Defines parameters for OSPF routing. It shall only be present if the routingProtocol="OSPF". bgpRouting: allOf: - $ref: '#/components/schemas/BgpRouting' - description: Defines parameters for BGP routing. It shall only be present if the routingProtocol="BGP". routeMapsDistribution: allOf: - $ref: '#/components/schemas/RouteMapsDistribution' - description: Maps of routes that are permitted or denied for redistribution. description: The routing information that is activated on the connectivity service endpoint. More than one "routingInfo" is allowed to enable stacking different routing protocols (e.g., one routing protocol for IPv4 and another one for IPv6). RoutingProtocol: title: RoutingProtocol enum: - BGP - RIP - OSPF - STATIC - DIRECT - VRRP type: string description: >- The routing protocol that is activated on the connectivity service endpoint. Permitted values: - BGP: used for dynamic routing BGPv4. - RIP: used for dynamic routing RIPv2. - OSPF: used for dynamic routing (OSPF version 2 for IPv4; and OSPF version 3 for IPv6). - STATIC: used for static routing. - DIRECT: used when the NFVI-PoP network is directly connected to the WAN provider network. - VRRP: used when the NFVI-PoP network is directly connected to the WAN provider network with virtual router redundancy protocol support (VRRP). example: BGP StaticRouting: title: StaticRouting required: - ipVersion - ipPrefix - prefixSize - nextHop type: object properties: ipVersion: allOf: - $ref: '#/components/schemas/IpVersion' - description: 'The IP version applicable to the routing entry. Permitted values: - IPV4 - IPV6' example: IPV4 ipPrefix: type: string 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.' prefixSize: type: number description: The IP prefix size. nextHop: type: string 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.' description: Defines a static route. It shall only be present if the routingProtocol="STATIC". IpVersion: title: IpVersion enum: - IPV4 - IPV6 type: string description: 'The IP version applicable to the routing entry. Permitted values: - IPV4 - IPV6' example: IPV4 RoutingAddressFamily: title: RoutingAddressFamily enum: - IPV4 - IPv6 type: string description: 'The IP version applicable to the dynamic routing protocol. Shall be present for dynamic routing protocols. Permitted values: - IPV4 - IPV6' example: IPV4 OspfRouting: title: OspfRouting required: - areaId type: object properties: areaId: type: string description: The routing area identifier, e.g., a number or an IP address. description: Defines parameters for OSPF routing. It shall only be present if the routingProtocol="OSPF". BgpRouting: title: BgpRouting required: - bgpAs type: object properties: bgpAs: type: object description: The Autonomous System (AS) identification applicable to the BGP routing info entry. bgpNeighbour: type: string 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.' bgpAdditionalParam: type: object 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. description: Defines parameters for BGP routing. It shall only be present if the routingProtocol="BGP". RouteMapsDistribution: title: RouteMapsDistribution required: - policy - sequence - matchAndSetRule type: object properties: policy: allOf: - $ref: '#/components/schemas/Policy' - description: >- The policy to apply to the route distribution. Permitted values: - PERMIT - DENY example: PERMIT sequence: type: number description: Sequence or index number assigned to the route-map. matchAndSetRule: type: object 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. description: Maps of routes that are permitted or denied for redistribution. Policy: title: Policy enum: - PERMIT - DENY type: string description: >- The policy to apply to the route distribution. Permitted values: - PERMIT - DENY example: PERMIT VirtualRoutingAndForwarding1: title: VirtualRoutingAndForwarding1 required: - vrfName type: object properties: vrfName: type: string description: Name (or identifier) of the VRF instance. description: Configuration related to the virtual routing and forwarding (VRF). AffectedSap: title: AffectedSap required: - sapInstanceId - sapdId type: object properties: sapInstanceId: type: string description: An identifier with the intention of being globally unique. sapdId: type: string description: An identifier with the intention of being globally unique. sapName: type: string description: Human readable name for the SAP. changeType: allOf: - $ref: '#/components/schemas/ChangeType5' - description: 'Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - MODIFY' example: ADD changeResult: allOf: - $ref: '#/components/schemas/ChangeResult' - description: 'Signals the result of change identified by the "changeType" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED' example: COMPLETED description: This type provides information about added, deleted and modified SAP of a NS. It shall comply with the provisions in Table 6.5.3.7-1. ChangeType5: title: ChangeType5 enum: - ADD - REMOVE - MODIFY type: string description: 'Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - MODIFY' example: ADD Links31: title: Links31 required: - self - nsInstance type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. nsInstance: allOf: - $ref: '#/components/schemas/NsInstance' - description: This type represents a link to a resource. cancel: allOf: - $ref: '#/components/schemas/Cancel' - description: This type represents a link to a resource. retry: allOf: - $ref: '#/components/schemas/Retry' - description: This type represents a link to a resource. rollback: allOf: - $ref: '#/components/schemas/Rollback' - description: This type represents a link to a resource. continue: allOf: - $ref: '#/components/schemas/Continue' - description: This type represents a link to a resource. fail: allOf: - $ref: '#/components/schemas/Fail' - description: This type represents a link to a resource. description: Links to resources related to this resource. NsInstance: title: NsInstance required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Cancel: title: Cancel required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Retry: title: Retry required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Rollback: title: Rollback required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Continue: title: Continue required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. Fail: title: Fail required: - href type: object properties: href: type: string description: URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available. description: This type represents a link to a resource. VnfSnapshotsResponse: title: VnfSnapshotsResponse required: - id type: object properties: id: type: string description: An identifier with the intention of being globally unique. vnfSnapshotPkgId: type: string description: An identifier with the intention of being globally unique. vnfSnapshot: allOf: - $ref: '#/components/schemas/VnfSnapshot' - description: This type represents a VNF Snapshot. It shall comply with the provisions defined in table 6.5.2.18-1. _links: allOf: - $ref: '#/components/schemas/Links61' - description: Links to resources related to this resource. description: >- This type represents an "Individual VNF snapshot" resource. The "id" attributed is used by the NFVO to index and identify the VNF snapshots information resources that are accessible via the NFVO. The identifier is still generated by the VNFM and copied into the present "VnfSnapshotInfo" representing the "Individual VNF snapshot" resource hold by the NFVO. VnfSnapshot: title: VnfSnapshot required: - id - vnfInstanceId - vnfdId - vnfInstance - vnfcSnapshots type: object properties: id: type: string description: An identifier with the intention of being globally unique. vnfInstanceId: type: string description: An identifier with the intention of being globally unique. creationStartedAt: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' creationFinishedAt: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' vnfdId: type: string description: An identifier with the intention of being globally unique. vnfInstance: allOf: - $ref: '#/components/schemas/VnfInstance' - description: This type represents a VNF instance. Clause B.3.2 of ETSI GS NFV-SOL 003 [4] provides examples illustrating the relationship among the different run-time information elements (CP, VL and link ports) used to represent the connectivity of a VNF. vnfcSnapshots: type: array items: $ref: '#/components/schemas/VnfcSnapshot' description: Information about VNFC Snapshots constituting this VNF Snapshot. userDefinedData: type: object 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. description: This type represents a VNF Snapshot. It shall comply with the provisions defined in table 6.5.2.18-1. VnfcSnapshot: title: VnfcSnapshot required: - id - vnfcInstanceId type: object properties: id: type: string description: An identifier with the intention of being globally unique. vnfcInstanceId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. creationStartedAt: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' creationFinishedAt: description: 'Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.' vnfcResourceInfoId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. computeSnapshotResource: allOf: - $ref: '#/components/schemas/ComputeSnapshotResource' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. storageSnapshotResources: type: array items: $ref: '#/components/schemas/StorageSnapshotResource' description: Reference to the "VirtualStorageResourceInfo" structure in the "VnfInstance" structure that represents the virtual storage resource. userDefinedData: type: object 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. description: This type represents a VNFC Snapshot. It shall comply with the provisions defined in table 6.5.3.77-1. ComputeSnapshotResource: title: ComputeSnapshotResource required: - resourceId type: object properties: vimId: type: string description: An identifier with the intention of being globally unique. resourceProviderId: type: string description: An identifier with the intention of being globally unique. resourceId: type: string description: 'An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.' vimLevelResourceType: type: string description: Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the "vimLevelResourceType" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. StorageSnapshotResource: title: StorageSnapshotResource required: - storageResourceId type: object properties: storageResourceId: type: string description: An identifier that is unique for the respective type within a VNF instance, but may not be globally unique. storageSnapshotResources: allOf: - $ref: '#/components/schemas/StorageSnapshotResources' - description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. StorageSnapshotResources: title: StorageSnapshotResources required: - resourceId type: object properties: vimId: type: string description: An identifier with the intention of being globally unique. resourceProviderId: type: string description: An identifier with the intention of being globally unique. resourceId: type: string description: 'An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.' vimLevelResourceType: type: string description: Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the "vimLevelResourceType" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. description: This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. Links61: title: Links61 required: - self type: object properties: self: allOf: - $ref: '#/components/schemas/Self' - description: This type represents a link to a resource. description: Links to resources related to this resource. tags: []