{ "openapi": "3.0.2", "info": { "title": "adapter-etsi_sol005", "version": "1.0.0" }, "paths": { "/nsd/v2/api_versions": { "get": { "operationId": "getApiVersions", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "This type represents API version information.\n", "type": "object", "required": [ "uriPrefix", "apiVersions" ], "properties": { "uriPrefix": { "description": "Specifies the URI prefix for the API, in the following form {apiRoot}/{apiName}/{apiMajorVersion}/.\n", "type": "string" }, "apiVersions": { "description": "Version(s) supported for the API signalled by the uriPrefix attribute.\n", "type": "array", "items": { "type": "object", "required": [ "version" ], "properties": { "version": { "description": "Identifies a supported version. The value of the version attribute shall be a version identifier as specified in clause 4.6.1.\n", "type": "string" }, "isDeprecated": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "retirementDate": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" } } } } } } } } } } } }, "/nsd/v2/ns_descriptors": { "post": { "operationId": "postNsDescriptors", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "nsdOnboardingState", "nsdOperationalState", "nsdUsageState", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "nsdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "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.\n" }, "nsdVersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "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.\n" }, "nsdInvariantId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfPkgIds": { "description": "Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdInfoIds": { "description": "Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nestedNsdInfoIds": { "description": "Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "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\n", "type": "string", "enum": [ "OPTION_1", "OPTION_2" ] }, "signingCertificate": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "artifacts": { "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.\n", "type": "array", "items": { "type": "object", "description": "This type represents an artifact contained in an NSD archive. It shall comply with provisions defined in Table 5.5.3.5-1.\n", "required": [ "artifactPath", "checksum" ], "properties": { "artifactPath": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "nsdOnboardingState": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR" ] }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } }, "nsdOperationalState": { "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.\n", "enum": [ "ENABLED", "DISABLED" ] }, "nsdUsageState": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "_links": { "type": "object", "required": [ "self", "nsd_content" ], "description": "Links to resources related to this resource.\n", "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "nsd_content": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } }, "description": "This type represents a response for the query NSD operation.\n" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "operationId": "getNsDescriptors", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "nsdOnboardingState", "nsdOperationalState", "nsdUsageState", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "nsdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "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.\n" }, "nsdVersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "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.\n" }, "nsdInvariantId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfPkgIds": { "description": "Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdInfoIds": { "description": "Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nestedNsdInfoIds": { "description": "Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "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\n", "type": "string", "enum": [ "OPTION_1", "OPTION_2" ] }, "signingCertificate": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "artifacts": { "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.\n", "type": "array", "items": { "type": "object", "description": "This type represents an artifact contained in an NSD archive. It shall comply with provisions defined in Table 5.5.3.5-1.\n", "required": [ "artifactPath", "checksum" ], "properties": { "artifactPath": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "nsdOnboardingState": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR" ] }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } }, "nsdOperationalState": { "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.\n", "enum": [ "ENABLED", "DISABLED" ] }, "nsdUsageState": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "_links": { "type": "object", "required": [ "self", "nsd_content" ], "description": "Links to resources related to this resource.\n", "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "nsd_content": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } }, "description": "This type represents a response for the query NSD operation.\n" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "in": "query", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "in": "query", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "in": "query", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/nsd/v2/ns_descriptors/{nsdInfoId}": { "get": { "operationId": "getNsDescriptorsNsdInfoId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "nsdOnboardingState", "nsdOperationalState", "nsdUsageState", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "nsdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "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.\n" }, "nsdVersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "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.\n" }, "nsdInvariantId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfPkgIds": { "description": "Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdInfoIds": { "description": "Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nestedNsdInfoIds": { "description": "Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "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\n", "type": "string", "enum": [ "OPTION_1", "OPTION_2" ] }, "signingCertificate": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "artifacts": { "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.\n", "type": "array", "items": { "type": "object", "description": "This type represents an artifact contained in an NSD archive. It shall comply with provisions defined in Table 5.5.3.5-1.\n", "required": [ "artifactPath", "checksum" ], "properties": { "artifactPath": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "nsdOnboardingState": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR" ] }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } }, "nsdOperationalState": { "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.\n", "enum": [ "ENABLED", "DISABLED" ] }, "nsdUsageState": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "_links": { "type": "object", "required": [ "self", "nsd_content" ], "description": "Links to resources related to this resource.\n", "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "nsd_content": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } }, "description": "This type represents a response for the query NSD operation.\n" } } } } }, "parameters": [ { "name": "nsdInfoId", "in": "path", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } } ] }, "patch": { "operationId": "patchNsDescriptorsNsdInfoId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "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.\n", "properties": { "nsdOperationalState": { "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.\n", "enum": [ "ENABLED", "DISABLED" ] }, "userDefinedData": { "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.\n", "type": "array", "items": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } } } } } }, "parameters": [ { "name": "nsdInfoId", "in": "path", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteNsDescriptorsNsdInfoId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsdInfoId", "in": "path", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } } ] } }, "/nsd/v2/ns_descriptors/{nsdInfoId}/nsd_content": { "get": { "operationId": "getNsDescriptorsNsdInfoIdNsdContent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsdInfoId", "in": "path", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } } ] }, "put": { "operationId": "putNsDescriptorsNsdInfoIdNsdContent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsdInfoId", "in": "path", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nsd/v2/ns_descriptors/{nsdInfoId}/nsd": { "get": { "operationId": "getNsDescriptorsNsdInfoIdNsd", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsdInfoId", "in": "path", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ] } }, "/nsd/v2/ns_descriptors/{nsdInfoId}/manifest": { "get": { "operationId": "getNsDescriptorsNsdInfoIdManifest", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsdInfoId", "in": "path", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ] } }, "/nsd/v2/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}": { "get": { "operationId": "getNsDescriptorsNsdInfoIdArtifactsArtifactPath", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsdInfoId", "in": "path", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } }, { "name": "artifactPath", "in": "path", "required": true, "schema": { "title": "artifactPath", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ] } }, "/nsd/v2/pnf_descriptors": { "post": { "operationId": "postPnfDescriptors", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "pnfdOnboardingState", "pnfdUsageState", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "pnfdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "pnfdName": { "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.\n", "type": "string" }, "pnfdersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "pnfdProvider": { "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.\n", "type": "string" }, "pnfdInvariantId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "archiveSecurityOption": { "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\n", "type": "string", "enum": [ "OPTION_1", "OPTION_2" ] }, "signingCertificate": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "artifacts": { "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.\n", "type": "array", "items": { "type": "object", "description": "This type represents an artifact contained in a PNFD archive. It shall comply with provisions defined in Table 5.5.3.6-1.\n", "required": [ "artifactPath", "checksum" ], "properties": { "artifactPath": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "nonManoArtifactSetId": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "pnfdOnboardingState": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDING", "ERROR" ] }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } }, "pnfdUsageState": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "_links": { "required": [ "pnfd_content", "self" ], "type": "object", "description": "Links to resources related to this resource.\n", "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "pnfd_content": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } }, "description": "This type represents a response for the query PNFD operation.\n" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "operationId": "getPnfDescriptors", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "Information about zero or more PNF descriptors.\nThe response body shall contain a representation in an array the representations\nof zero or more PNF descriptors, as defined in clause 5.5.2.2.\nIf the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,\ninclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.\n", "type": "array", "items": { "type": "object", "required": [ "id", "pnfdOnboardingState", "pnfdUsageState", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "pnfdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "pnfdName": { "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.\n", "type": "string" }, "pnfdersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "pnfdProvider": { "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.\n", "type": "string" }, "pnfdInvariantId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "archiveSecurityOption": { "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\n", "type": "string", "enum": [ "OPTION_1", "OPTION_2" ] }, "signingCertificate": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "artifacts": { "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.\n", "type": "array", "items": { "type": "object", "description": "This type represents an artifact contained in a PNFD archive. It shall comply with provisions defined in Table 5.5.3.6-1.\n", "required": [ "artifactPath", "checksum" ], "properties": { "artifactPath": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "nonManoArtifactSetId": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "pnfdOnboardingState": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDING", "ERROR" ] }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } }, "pnfdUsageState": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "_links": { "required": [ "pnfd_content", "self" ], "type": "object", "description": "Links to resources related to this resource.\n", "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "pnfd_content": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } }, "description": "This type represents a response for the query PNFD operation.\n" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "in": "query", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "in": "query", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "in": "query", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/nsd/v2/pnf_descriptors/{pnfdInfoId}": { "get": { "operationId": "getPnfDescriptorsPnfdInfoId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "pnfdOnboardingState", "pnfdUsageState", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "pnfdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "pnfdName": { "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.\n", "type": "string" }, "pnfdersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "pnfdProvider": { "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.\n", "type": "string" }, "pnfdInvariantId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "archiveSecurityOption": { "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\n", "type": "string", "enum": [ "OPTION_1", "OPTION_2" ] }, "signingCertificate": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "artifacts": { "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.\n", "type": "array", "items": { "type": "object", "description": "This type represents an artifact contained in a PNFD archive. It shall comply with provisions defined in Table 5.5.3.6-1.\n", "required": [ "artifactPath", "checksum" ], "properties": { "artifactPath": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "nonManoArtifactSetId": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "pnfdOnboardingState": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDING", "ERROR" ] }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } }, "pnfdUsageState": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "_links": { "required": [ "pnfd_content", "self" ], "type": "object", "description": "Links to resources related to this resource.\n", "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "pnfd_content": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } }, "description": "This type represents a response for the query PNFD operation.\n" } } } } }, "parameters": [ { "name": "pnfdInfoId", "in": "path", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } } ] }, "patch": { "operationId": "patchPnfDescriptorsPnfdInfoId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "userDefinedData" ], "properties": { "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } }, "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.\n" } } } } }, "parameters": [ { "name": "pnfdInfoId", "in": "path", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deletePnfDescriptorsPnfdInfoId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pnfdInfoId", "in": "path", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } } ] } }, "/nsd/v2/pnf_descriptors/{pnfdInfoId}/pnfd_content": { "get": { "operationId": "getPnfDescriptorsPnfdInfoIdPnfdContent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pnfdInfoId", "in": "path", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } } ] }, "put": { "operationId": "putPnfDescriptorsPnfdInfoIdPnfdContent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pnfdInfoId", "in": "path", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nsd/v2/pnf_descriptors/{pnfdInfoId}/pnfd": { "get": { "operationId": "getPnfDescriptorsPnfdInfoIdPnfd", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pnfdInfoId", "in": "path", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ] } }, "/nsd/v2/pnf_descriptors/{pnfdInfoId}/manifest": { "get": { "operationId": "getPnfDescriptorsPnfdInfoIdManifest", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pnfdInfoId", "in": "path", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ] } }, "/nsd/v2/pnf_descriptors/{pnfdInfoId}/artifacts/{artifactPath}": { "get": { "operationId": "getPnfDescriptorsPnfdInfoIdArtifactsArtifactPath", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pnfdInfoId", "in": "path", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } }, { "name": "artifactPath", "in": "path", "required": true, "schema": { "title": "artifactPath", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ] } }, "/nsd/v2/subscriptions": { "post": { "operationId": "postSubscriptions", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "callbackUri", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "filter": { "type": "object", "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).\nNOTE 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.\nNOTE 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.\n", "properties": { "notificationTypes": { "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.\n", "type": "array", "items": { "type": "string", "enum": [ "NsdOnBoardingNotification", "NsdOnboardingFailureNotification", "NsdChangeNotification", "NsdDeletionNotification", "PnfdOnBoardingNotification", "PnfdOnBoardingFailureNotification", "PnfdDeletionNotification" ] } }, "nsdInfoId": { "description": "Match the NsdInfo identifier which is allocated by the NFVO.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nsdId": { "description": "Match the NSD identifier, which is allocated by the NSD designer.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nsdName": { "description": "Match the name of the on boarded NSD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "nsdVersion": { "description": "Match the NSD version listed as part of this attribute.\n", "type": "array", "items": { "description": "A Version. Representation: string of variable length.\n", "type": "string" } }, "nsdDesigner": { "description": "Match the NSD designer of the on-boarded NSD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "nsdInvariantId": { "description": "Match the NSD invariant identifier which is allocated by the NSD designer and identifies an NSD in a version independent manner.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "vnfPkgIds": { "description": "Match VNF packages with a package identifier listed in the attribute.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdInfoIds": { "description": "Match the PnfdInfo identifier for the PNFD referenced by the on-boarded NSD.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nestedNsdInfoIds": { "description": "Match the NsdInfo identifier for the nested NSD referenced by the on-boarded NSD.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nsdOnboardingState": { "description": "Match particular on-boarding state of the NSD.\n", "type": "array", "items": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR" ] } }, "nsdOperationalState": { "description": "Match particular operational state of the on-boarded NSD.\n", "type": "array", "items": { "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.\n", "enum": [ "ENABLED", "DISABLED" ] } }, "nsdUsageState": { "description": "Match particular usage state of the on-boarded NSD.\n", "type": "array", "items": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] } }, "pnfdId": { "description": "Match the PNFD identifier which is copied from the PNFD content.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdName": { "description": "Match the name of the on-boarded PNFD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "pnfdVersion": { "description": "Match the PNFD designer of the on-boarded PNFD.\n", "type": "array", "items": { "description": "A Version. Representation: string of variable length.\n", "type": "string" } }, "pnfdProvider": { "description": "Match the provider of the on-boarded PNFD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "pnfdInvariantId": { "description": "Match the PNFD in a version independent manner.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdOnboardingState": { "description": "Match particular on-boarding state of the PNFD.\n", "type": "array", "items": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDING", "ERROR" ] } }, "pnfdUsageState": { "description": "Match the usage state of the individual PNF descriptor resource.\n", "type": "array", "items": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] } } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "_links": { "type": "object", "description": "Links to resources related to this resource.\n", "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } }, "description": "This type represents a subscription related to notifications about NSD management.\n" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "operationId": "getSubscriptions", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "The list of subscriptions was queried successfully.\nThe response body shall contain in an array the representations of all active subscriptions\nof the functional block that invokes the method, i.e., zero or more representations of NSD management\nsubscriptions as defined in clause 5.5.2.8.\nIf the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,\ninclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.\n", "type": "array", "items": { "type": "object", "required": [ "id", "callbackUri", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "filter": { "type": "object", "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).\nNOTE 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.\nNOTE 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.\n", "properties": { "notificationTypes": { "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.\n", "type": "array", "items": { "type": "string", "enum": [ "NsdOnBoardingNotification", "NsdOnboardingFailureNotification", "NsdChangeNotification", "NsdDeletionNotification", "PnfdOnBoardingNotification", "PnfdOnBoardingFailureNotification", "PnfdDeletionNotification" ] } }, "nsdInfoId": { "description": "Match the NsdInfo identifier which is allocated by the NFVO.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nsdId": { "description": "Match the NSD identifier, which is allocated by the NSD designer.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nsdName": { "description": "Match the name of the on boarded NSD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "nsdVersion": { "description": "Match the NSD version listed as part of this attribute.\n", "type": "array", "items": { "description": "A Version. Representation: string of variable length.\n", "type": "string" } }, "nsdDesigner": { "description": "Match the NSD designer of the on-boarded NSD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "nsdInvariantId": { "description": "Match the NSD invariant identifier which is allocated by the NSD designer and identifies an NSD in a version independent manner.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "vnfPkgIds": { "description": "Match VNF packages with a package identifier listed in the attribute.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdInfoIds": { "description": "Match the PnfdInfo identifier for the PNFD referenced by the on-boarded NSD.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nestedNsdInfoIds": { "description": "Match the NsdInfo identifier for the nested NSD referenced by the on-boarded NSD.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nsdOnboardingState": { "description": "Match particular on-boarding state of the NSD.\n", "type": "array", "items": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR" ] } }, "nsdOperationalState": { "description": "Match particular operational state of the on-boarded NSD.\n", "type": "array", "items": { "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.\n", "enum": [ "ENABLED", "DISABLED" ] } }, "nsdUsageState": { "description": "Match particular usage state of the on-boarded NSD.\n", "type": "array", "items": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] } }, "pnfdId": { "description": "Match the PNFD identifier which is copied from the PNFD content.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdName": { "description": "Match the name of the on-boarded PNFD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "pnfdVersion": { "description": "Match the PNFD designer of the on-boarded PNFD.\n", "type": "array", "items": { "description": "A Version. Representation: string of variable length.\n", "type": "string" } }, "pnfdProvider": { "description": "Match the provider of the on-boarded PNFD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "pnfdInvariantId": { "description": "Match the PNFD in a version independent manner.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdOnboardingState": { "description": "Match particular on-boarding state of the PNFD.\n", "type": "array", "items": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDING", "ERROR" ] } }, "pnfdUsageState": { "description": "Match the usage state of the individual PNF descriptor resource.\n", "type": "array", "items": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] } } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "_links": { "type": "object", "description": "Links to resources related to this resource.\n", "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } }, "description": "This type represents a subscription related to notifications about NSD management.\n" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/nsd/v2/subscriptions/{subscriptionId}": { "get": { "operationId": "getSubscriptionsSubscriptionId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "callbackUri", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "filter": { "type": "object", "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).\nNOTE 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.\nNOTE 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.\n", "properties": { "notificationTypes": { "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.\n", "type": "array", "items": { "type": "string", "enum": [ "NsdOnBoardingNotification", "NsdOnboardingFailureNotification", "NsdChangeNotification", "NsdDeletionNotification", "PnfdOnBoardingNotification", "PnfdOnBoardingFailureNotification", "PnfdDeletionNotification" ] } }, "nsdInfoId": { "description": "Match the NsdInfo identifier which is allocated by the NFVO.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nsdId": { "description": "Match the NSD identifier, which is allocated by the NSD designer.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nsdName": { "description": "Match the name of the on boarded NSD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "nsdVersion": { "description": "Match the NSD version listed as part of this attribute.\n", "type": "array", "items": { "description": "A Version. Representation: string of variable length.\n", "type": "string" } }, "nsdDesigner": { "description": "Match the NSD designer of the on-boarded NSD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "nsdInvariantId": { "description": "Match the NSD invariant identifier which is allocated by the NSD designer and identifies an NSD in a version independent manner.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "vnfPkgIds": { "description": "Match VNF packages with a package identifier listed in the attribute.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdInfoIds": { "description": "Match the PnfdInfo identifier for the PNFD referenced by the on-boarded NSD.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nestedNsdInfoIds": { "description": "Match the NsdInfo identifier for the nested NSD referenced by the on-boarded NSD.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "nsdOnboardingState": { "description": "Match particular on-boarding state of the NSD.\n", "type": "array", "items": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR" ] } }, "nsdOperationalState": { "description": "Match particular operational state of the on-boarded NSD.\n", "type": "array", "items": { "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.\n", "enum": [ "ENABLED", "DISABLED" ] } }, "nsdUsageState": { "description": "Match particular usage state of the on-boarded NSD.\n", "type": "array", "items": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] } }, "pnfdId": { "description": "Match the PNFD identifier which is copied from the PNFD content.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdName": { "description": "Match the name of the on-boarded PNFD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "pnfdVersion": { "description": "Match the PNFD designer of the on-boarded PNFD.\n", "type": "array", "items": { "description": "A Version. Representation: string of variable length.\n", "type": "string" } }, "pnfdProvider": { "description": "Match the provider of the on-boarded PNFD.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "pnfdInvariantId": { "description": "Match the PNFD in a version independent manner.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "pnfdOnboardingState": { "description": "Match particular on-boarding state of the PNFD.\n", "type": "array", "items": { "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.\n", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDING", "ERROR" ] } }, "pnfdUsageState": { "description": "Match the usage state of the individual PNF descriptor resource.\n", "type": "array", "items": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] } } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "_links": { "type": "object", "description": "Links to resources related to this resource.\n", "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } }, "description": "This type represents a subscription related to notifications about NSD management.\n" } } } } }, "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ] }, "delete": { "operationId": "deleteSubscriptionsSubscriptionId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ] } }, "/nsfm/v1/alarms": { "get": { "operationId": "getAlarms", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in Table 8.5.2.4-1\n", "type": "object", "required": [ "id", "managedObjectId", "alarmRaisedTime", "ackState", "perceivedSeverity", "eventTime", "eventType", "probableCause", "isRootCause", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "managedObjectId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "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.\n", "type": "object", "properties": { "faultyNestedNsInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "faultyResourceType": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "faultyNsVirtualLinkInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } } }, "rootCauseFaultyResource": { "description": "This type represents the faulty virtual resources that have a negative impact on a NS.\n", "type": "object", "required": [ "faultyResource", "faultyResourceType" ], "properties": { "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.\n", "type": "object", "required": [ "resourceId" ], "properties": { "vimId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "resourceProviderId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "resourceId": { "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.\n", "type": "string" }, "vimLevelResourceType": { "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.\n", "type": "string" } } }, "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.\n", "type": "string", "enum": [ "COMPUTE", "STORAGE", "NETWORK" ] } } }, "alarmRaisedTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "alarmChangedTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "alarmClearedTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "alarmAcknowledgedTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "ackState": { "description": "Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED\n", "type": "string", "enum": [ "UNACKNOWLEDGED", "ACKNOWLEDGED" ] }, "perceivedSeverity": { "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service\n affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting\n condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a\n non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a\n potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the\n severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or\n more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n", "type": "string", "enum": [ "CRITICAL", "MAJOR", "MINOR", "WARNING", "INDETERMINATE", "CLEARED" ] }, "eventTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "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\n procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n- PROCESSING_ERROR_ALARM: An alarm of this type is associated with a\n software or processing fault (ITU-T Recommendation X.733).\n- ENVIRONMENTAL_ALARM: An alarm of this type is associated with a\n condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n- QOS_ALARM: An alarm of this type is associated with degradation in the\n quality of a service (ITU-T Recommendation X.733).\n- EQUIPMENT_ALARM: An alarm of this type is associated with an equipment\n fault (ITU-T Recommendation X.733).\n", "type": "string", "enum": [ "COMMUNICATIONS_ALARM", "PROCESSING_ERROR_ALARM", "ENVIRONMENTAL_ALARM", "QOS_ALARM", "EQUIPMENT_ALARM" ] }, "faultType": { "description": "Additional information to clarify the type of the fault.\n", "type": "string" }, "probableCause": { "description": "Information about the probable cause of the fault.\n", "type": "string" }, "isRootCause": { "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.\n", "type": "boolean" }, "correlatedAlarmIds": { "description": "List of identifiers of other alarms correlated to this fault.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "faultDetails": { "description": "Provides additional information about the fault..\n", "type": "string" }, "_links": { "description": "Links for this resource.\n", "type": "object", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/nsfm/v1/alarms/{alarmId}": { "get": { "operationId": "getAlarmsAlarmId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in Table 8.5.2.4-1\n", "type": "object", "required": [ "id", "managedObjectId", "alarmRaisedTime", "ackState", "perceivedSeverity", "eventTime", "eventType", "probableCause", "isRootCause", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "managedObjectId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "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.\n", "type": "object", "properties": { "faultyNestedNsInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "faultyResourceType": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "faultyNsVirtualLinkInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } } }, "rootCauseFaultyResource": { "description": "This type represents the faulty virtual resources that have a negative impact on a NS.\n", "type": "object", "required": [ "faultyResource", "faultyResourceType" ], "properties": { "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.\n", "type": "object", "required": [ "resourceId" ], "properties": { "vimId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "resourceProviderId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "resourceId": { "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.\n", "type": "string" }, "vimLevelResourceType": { "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.\n", "type": "string" } } }, "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.\n", "type": "string", "enum": [ "COMPUTE", "STORAGE", "NETWORK" ] } } }, "alarmRaisedTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "alarmChangedTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "alarmClearedTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "alarmAcknowledgedTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "ackState": { "description": "Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED\n", "type": "string", "enum": [ "UNACKNOWLEDGED", "ACKNOWLEDGED" ] }, "perceivedSeverity": { "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service\n affecting condition has occurred and an immediate corrective action\n is required. Such a severity can be reported, for example, when a\n managed object becomes totally out of service and its capability needs\n to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting\n condition has developed and an urgent corrective action is required.\n Such a severity can be reported, for example, when there is a severe\n degradation in the capability of the managed object and its full\n capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a\n non-service affecting fault condition and that corrective action\n should be taken in order to prevent a more serious (for example,\n service affecting) fault. Such a severity can be reported, for\n example, when the detected alarm condition is not currently degrading\n the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a\n potential or impending service affecting fault, before any significant\n effects have been felt. Action should be taken to further diagnose (if\n necessary) and correct the problem in order to prevent it from\n becoming a more serious service affecting fault (ITU-T Recommendation\n X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the\n severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or\n more previously reported alarms. This alarm clears all alarms for this\n managed object that have the same Alarm type, Probable cause and\n Specific problems (if given) (ITU-T Recommendation X.733).\n", "type": "string", "enum": [ "CRITICAL", "MAJOR", "MINOR", "WARNING", "INDETERMINATE", "CLEARED" ] }, "eventTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "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\n procedure and/or process required conveying information from one point\n to another (ITU-T Recommendation X.733).\n- PROCESSING_ERROR_ALARM: An alarm of this type is associated with a\n software or processing fault (ITU-T Recommendation X.733).\n- ENVIRONMENTAL_ALARM: An alarm of this type is associated with a\n condition related to an enclosure in which the equipment resides\n (ITU-T Recommendation X.733).\n- QOS_ALARM: An alarm of this type is associated with degradation in the\n quality of a service (ITU-T Recommendation X.733).\n- EQUIPMENT_ALARM: An alarm of this type is associated with an equipment\n fault (ITU-T Recommendation X.733).\n", "type": "string", "enum": [ "COMMUNICATIONS_ALARM", "PROCESSING_ERROR_ALARM", "ENVIRONMENTAL_ALARM", "QOS_ALARM", "EQUIPMENT_ALARM" ] }, "faultType": { "description": "Additional information to clarify the type of the fault.\n", "type": "string" }, "probableCause": { "description": "Information about the probable cause of the fault.\n", "type": "string" }, "isRootCause": { "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.\n", "type": "boolean" }, "correlatedAlarmIds": { "description": "List of identifiers of other alarms correlated to this fault.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "faultDetails": { "description": "Provides additional information about the fault..\n", "type": "string" }, "_links": { "description": "Links for this resource.\n", "type": "object", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "alarmId", "in": "path", "required": true, "schema": { "title": "alarmId", "type": "string" } } ] }, "patch": { "operationId": "patchAlarmsAlarmId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "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.\n", "type": "object", "required": [ "ackState" ], "properties": { "ackState": { "description": "New value of the \"ackState\" attribute in \"Alarm\". Permitted values: - ACKNOWLEDGED - UNACKNOWLEDGED\n", "type": "string", "enum": [ "ACKNOWLEDGED", "UNACKNOWLEDGED" ] } } } } } } }, "parameters": [ { "name": "alarmId", "in": "path", "required": true, "schema": { "title": "alarmId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfpkgm/v2/vnf_packages": { "get": { "operationId": "getVnfPackages", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "packageSecurityOption", "onboardingState", "operationalState", "usageState", "vnfmInfo", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfProvider": { "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.\n", "type": "string" }, "vnfProductName": { "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.\n", "type": "string" }, "vnfSoftwareVersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "vnfdVersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "compatibleSpecificationVersions": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "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\n", "type": "string", "enum": [ "OPTION_1", "OPTION_2" ] }, "signingCertificate": { "description": "The singleton signing certificate if it is included as a file in the VNF package.\n", "type": "string" }, "softwareImages": { "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.\n", "type": "array", "items": { "description": "This type represents an artifact contained in or external to a VNF package which represents a software image.\n", "required": [ "id", "name", "provider", "version", "checksum", "isEncrypted", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size", "imagePath" ], "type": "object", "properties": { "id": { "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", "type": "string" }, "name": { "description": "Name of the software image.\n", "type": "string" }, "provider": { "description": "Provider of the software image.\n", "type": "string" }, "version": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "Reflects whether the image is encrypted (true) or not (false).\n", "type": "boolean" }, "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\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF" ] }, "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\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK" ] }, "createdAt": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "minDisk": { "description": "The minimal disk for this software image in bytes.\n", "type": "integer", "minimum": 0 }, "minRam": { "description": "The minimal RAM for this software image in bytes.\n", "type": "integer", "minimum": 0 }, "size": { "description": "Size of this software image in bytes.\n", "type": "integer", "minimum": 0 }, "userMetadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "imagePath": { "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 \"/\".\nEXAMPLE:\tfoo/bar/m%40ster.vhd\nFor 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.\n", "type": "string" }, "imageUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } }, "additionalArtifacts": { "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.\n", "type": "array", "items": { "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.\n", "required": [ "isEncrypted", "checksum" ], "type": "object", "properties": { "artifactPath": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "artifactURI": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "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]\n", "type": "string", "enum": [ "HISTORY", "TESTING", "LICENSE" ] }, "isEncrypted": { "description": "Reflects whether the artifact is encrypted (true) or not (false).\n", "type": "boolean" }, "nonManoArtifactSetId": { "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.\n", "type": "string" }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "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.\n", "type": "string", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR" ] }, "operationalState": { "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\n (unless and until the VNF package is re-enabled).\n", "enum": [ "ENABLED", "DISABLED" ] }, "usageState": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] }, "vnfmInfo": { "description": "Specifies VNFMs compatible with the VNF. This information is copied from the VNFD. See note 4.\n", "type": "array", "items": { "type": "string" } }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } }, "_links": { "type": "object", "description": "Links to resources related to this resource.\n", "required": [ "self", "packageContent", "vnfd" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "vnfd": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "packageContent": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "in": "query", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "in": "query", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "in": "query", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] }, "post": { "operationId": "postVnfPackages", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "packageSecurityOption", "onboardingState", "operationalState", "usageState", "vnfmInfo", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfProvider": { "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.\n", "type": "string" }, "vnfProductName": { "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.\n", "type": "string" }, "vnfSoftwareVersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "vnfdVersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "compatibleSpecificationVersions": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "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\n", "type": "string", "enum": [ "OPTION_1", "OPTION_2" ] }, "signingCertificate": { "description": "The singleton signing certificate if it is included as a file in the VNF package.\n", "type": "string" }, "softwareImages": { "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.\n", "type": "array", "items": { "description": "This type represents an artifact contained in or external to a VNF package which represents a software image.\n", "required": [ "id", "name", "provider", "version", "checksum", "isEncrypted", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size", "imagePath" ], "type": "object", "properties": { "id": { "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", "type": "string" }, "name": { "description": "Name of the software image.\n", "type": "string" }, "provider": { "description": "Provider of the software image.\n", "type": "string" }, "version": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "Reflects whether the image is encrypted (true) or not (false).\n", "type": "boolean" }, "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\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF" ] }, "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\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK" ] }, "createdAt": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "minDisk": { "description": "The minimal disk for this software image in bytes.\n", "type": "integer", "minimum": 0 }, "minRam": { "description": "The minimal RAM for this software image in bytes.\n", "type": "integer", "minimum": 0 }, "size": { "description": "Size of this software image in bytes.\n", "type": "integer", "minimum": 0 }, "userMetadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "imagePath": { "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 \"/\".\nEXAMPLE:\tfoo/bar/m%40ster.vhd\nFor 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.\n", "type": "string" }, "imageUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } }, "additionalArtifacts": { "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.\n", "type": "array", "items": { "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.\n", "required": [ "isEncrypted", "checksum" ], "type": "object", "properties": { "artifactPath": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "artifactURI": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "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]\n", "type": "string", "enum": [ "HISTORY", "TESTING", "LICENSE" ] }, "isEncrypted": { "description": "Reflects whether the artifact is encrypted (true) or not (false).\n", "type": "boolean" }, "nonManoArtifactSetId": { "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.\n", "type": "string" }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "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.\n", "type": "string", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR" ] }, "operationalState": { "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\n (unless and until the VNF package is re-enabled).\n", "enum": [ "ENABLED", "DISABLED" ] }, "usageState": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] }, "vnfmInfo": { "description": "Specifies VNFMs compatible with the VNF. This information is copied from the VNFD. See note 4.\n", "type": "array", "items": { "type": "string" } }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } }, "_links": { "type": "object", "description": "Links to resources related to this resource.\n", "required": [ "self", "packageContent", "vnfd" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "vnfd": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "packageContent": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfpkgm/v2/vnf_packages/{vnfPkgId}": { "get": { "operationId": "getVnfPackagesVnfPkgId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "packageSecurityOption", "onboardingState", "operationalState", "usageState", "vnfmInfo", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfProvider": { "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.\n", "type": "string" }, "vnfProductName": { "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.\n", "type": "string" }, "vnfSoftwareVersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "vnfdVersion": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "compatibleSpecificationVersions": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "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\n", "type": "string", "enum": [ "OPTION_1", "OPTION_2" ] }, "signingCertificate": { "description": "The singleton signing certificate if it is included as a file in the VNF package.\n", "type": "string" }, "softwareImages": { "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.\n", "type": "array", "items": { "description": "This type represents an artifact contained in or external to a VNF package which represents a software image.\n", "required": [ "id", "name", "provider", "version", "checksum", "isEncrypted", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size", "imagePath" ], "type": "object", "properties": { "id": { "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n", "type": "string" }, "name": { "description": "Name of the software image.\n", "type": "string" }, "provider": { "description": "Provider of the software image.\n", "type": "string" }, "version": { "description": "A Version. Representation: string of variable length.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "Reflects whether the image is encrypted (true) or not (false).\n", "type": "boolean" }, "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\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF" ] }, "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\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK" ] }, "createdAt": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "minDisk": { "description": "The minimal disk for this software image in bytes.\n", "type": "integer", "minimum": 0 }, "minRam": { "description": "The minimal RAM for this software image in bytes.\n", "type": "integer", "minimum": 0 }, "size": { "description": "Size of this software image in bytes.\n", "type": "integer", "minimum": 0 }, "userMetadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "imagePath": { "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 \"/\".\nEXAMPLE:\tfoo/bar/m%40ster.vhd\nFor 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.\n", "type": "string" }, "imageUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } }, "additionalArtifacts": { "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.\n", "type": "array", "items": { "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.\n", "required": [ "isEncrypted", "checksum" ], "type": "object", "properties": { "artifactPath": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "artifactURI": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "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]\n", "type": "string", "enum": [ "HISTORY", "TESTING", "LICENSE" ] }, "isEncrypted": { "description": "Reflects whether the artifact is encrypted (true) or not (false).\n", "type": "boolean" }, "nonManoArtifactSetId": { "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.\n", "type": "string" }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "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.\n", "type": "string", "enum": [ "CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR" ] }, "operationalState": { "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\n (unless and until the VNF package is re-enabled).\n", "enum": [ "ENABLED", "DISABLED" ] }, "usageState": { "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.\n", "enum": [ "IN_USE", "NOT_IN_USE" ] }, "vnfmInfo": { "description": "Specifies VNFMs compatible with the VNF. This information is copied from the VNFD. See note 4.\n", "type": "array", "items": { "type": "string" } }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } }, "_links": { "type": "object", "description": "Links to resources related to this resource.\n", "required": [ "self", "packageContent", "vnfd" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "vnfd": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "packageContent": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ] }, "delete": { "operationId": "deleteVnfPackagesVnfPkgId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ] }, "patch": { "operationId": "patchVnfPackagesVnfPkgId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "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.\n", "properties": { "operationalState": { "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\n (unless and until the VNF package is re-enabled).\n", "enum": [ "ENABLED", "DISABLED" ] }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfpkgm/v2/vnf_packages/{vnfPkgId}/vnfd": { "get": { "operationId": "getVnfPackagesVnfPkgIdVnfd", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ] } }, "/vnfpkgm/v2/vnf_packages/{vnfPkgId}/ext_artifacts_access": { "get": { "operationId": "getVnfPackagesVnfPkgIdExtArtifactsAccess", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "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.\n", "type": "object", "properties": { "artifact": { "description": "Access configuration information for an external artifact.\n", "type": "object", "required": [ "artifactUri" ], "properties": { "artifactUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "overrideUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "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.\n", "type": "string", "enum": [ "BASIC", "OAUTH2_CLIENT_CREDENTIALS" ] }, "username": { "description": "User name to be used for authentication.\n", "type": "string" }, "password": { "description": "Password to be used for authentication. Shall not be present in response bodies.\n", "type": "string" }, "paramsOauth2ClientCredentials": { "description": "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.\n", "type": "object", "required": [ "clientId", "clientPassword", "tokenEndpoint" ], "properties": { "clientId": { "description": "Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type.\n", "type": "string" }, "clientPassword": { "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.\n", "type": "string" }, "tokenEndpoint": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ] }, "put": { "operationId": "putVnfPackagesVnfPkgIdExtArtifactsAccess", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "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.\n", "type": "object", "properties": { "artifact": { "description": "Access configuration information for an external artifact.\n", "type": "object", "required": [ "artifactUri" ], "properties": { "artifactUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "overrideUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "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.\n", "type": "string", "enum": [ "BASIC", "OAUTH2_CLIENT_CREDENTIALS" ] }, "username": { "description": "User name to be used for authentication.\n", "type": "string" }, "password": { "description": "Password to be used for authentication. Shall not be present in response bodies.\n", "type": "string" }, "paramsOauth2ClientCredentials": { "description": "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.\n", "type": "object", "required": [ "clientId", "clientPassword", "tokenEndpoint" ], "properties": { "clientId": { "description": "Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type.\n", "type": "string" }, "clientPassword": { "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.\n", "type": "string" }, "tokenEndpoint": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfpkgm/v2/vnf_packages/{vnfPkgId}/manifest": { "get": { "operationId": "getVnfPackagesVnfPkgIdManifest", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ] } }, "/vnfpkgm/v2/vnf_packages/{vnfPkgId}/package_content": { "get": { "operationId": "getVnfPackagesVnfPkgIdPackageContent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ] }, "put": { "operationId": "putVnfPackagesVnfPkgIdPackageContent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfpkgm/v2/vnf_packages/{vnfPkgId}/artifacts": { "get": { "operationId": "getVnfPackagesVnfPkgIdArtifacts", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } }, { "name": "excludeAllManoArtifacts", "in": "query", "required": false, "schema": { "title": "excludeAllManoArtifacts", "type": "string" } }, { "name": "excludeAllNonManoArtifacts", "in": "query", "required": false, "schema": { "title": "excludeAllNonManoArtifacts", "type": "string" } }, { "name": "selectNonManoArtifactSets", "in": "query", "required": false, "schema": { "title": "selectNonManoArtifactSets", "type": "string" } }, { "name": "includeExternalArtifacts", "in": "query", "required": false, "schema": { "title": "includeExternalArtifacts", "type": "string" } } ] } }, "/vnfpkgm/v2/vnf_packages/{vnfPkgId}/package_content/upload_from_uri": { "post": { "operationId": "postVnfPackagesVnfPkgIdPackageContentUploadFromUri", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfpkgm/v2/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}": { "get": { "operationId": "getVnfPackagesVnfPkgIdArtifactsArtifactPath", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfPkgId", "in": "path", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "artifactPath", "in": "path", "required": true, "schema": { "title": "artifactPath", "type": "string" } }, { "name": "includeSignatures", "in": "query", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ] } }, "/nspm/v2/pm_jobs": { "post": { "operationId": "postPmJobs", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "This type represents a PM job.\n", "type": "object", "required": [ "id", "objectType", "objectInstanceIds", "criteria", "callbackUri" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "objectType": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "objectInstanceIds": { "description": "Identifiers of the NS instances for which performance information is collected.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "subObjectInstanceIds": { "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.\n", "type": "array", "items": { "description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n", "type": "string" } }, "criteria": { "description": "This type represents collection criteria for PM jobs. It shall comply with the provisions defined in Table 7.5.3.3-1.\n", "type": "object", "required": [ "collectionPeriod", "reportingPeriod" ], "properties": { "performanceMetric": { "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.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "performanceMetricGroup": { "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.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "collectionPeriod": { "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.\n", "type": "integer", "minimum": 0, "default": 0 }, "reportingPeriod": { "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. \n", "type": "integer", "minimum": 0, "default": 0 }, "reportingBoundary": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "reports": { "description": "Information about available reports collected by this PM job.\n", "type": "object", "required": [ "href", "readyTime", "_links" ], "properties": { "href": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "readyTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "expiryTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "fileSize": { "description": "The size of the report file in bytes, if known.\n", "type": "integer" }, "_links": { "description": "Links for this resource.\n", "type": "object", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "objects": { "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.\n", "type": "array", "items": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "operationId": "getPmJobs", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "This type represents a PM job.\n", "type": "object", "required": [ "id", "objectType", "objectInstanceIds", "criteria", "callbackUri" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "objectType": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "objectInstanceIds": { "description": "Identifiers of the NS instances for which performance information is collected.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "subObjectInstanceIds": { "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.\n", "type": "array", "items": { "description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n", "type": "string" } }, "criteria": { "description": "This type represents collection criteria for PM jobs. It shall comply with the provisions defined in Table 7.5.3.3-1.\n", "type": "object", "required": [ "collectionPeriod", "reportingPeriod" ], "properties": { "performanceMetric": { "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.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "performanceMetricGroup": { "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.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "collectionPeriod": { "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.\n", "type": "integer", "minimum": 0, "default": 0 }, "reportingPeriod": { "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. \n", "type": "integer", "minimum": 0, "default": 0 }, "reportingBoundary": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "reports": { "description": "Information about available reports collected by this PM job.\n", "type": "object", "required": [ "href", "readyTime", "_links" ], "properties": { "href": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "readyTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "expiryTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "fileSize": { "description": "The size of the report file in bytes, if known.\n", "type": "integer" }, "_links": { "description": "Links for this resource.\n", "type": "object", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "objects": { "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.\n", "type": "array", "items": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "in": "query", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "in": "query", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "in": "query", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/nspm/v2/pm_jobs/{pmJobId}": { "get": { "operationId": "getPmJobsPmJobId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "This type represents a PM job.\n", "type": "object", "required": [ "id", "objectType", "objectInstanceIds", "criteria", "callbackUri" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "objectType": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "objectInstanceIds": { "description": "Identifiers of the NS instances for which performance information is collected.\n", "type": "array", "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } }, "subObjectInstanceIds": { "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.\n", "type": "array", "items": { "description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n", "type": "string" } }, "criteria": { "description": "This type represents collection criteria for PM jobs. It shall comply with the provisions defined in Table 7.5.3.3-1.\n", "type": "object", "required": [ "collectionPeriod", "reportingPeriod" ], "properties": { "performanceMetric": { "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.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "performanceMetricGroup": { "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.\n", "type": "array", "items": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" } }, "collectionPeriod": { "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.\n", "type": "integer", "minimum": 0, "default": 0 }, "reportingPeriod": { "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. \n", "type": "integer", "minimum": 0, "default": 0 }, "reportingBoundary": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "reports": { "description": "Information about available reports collected by this PM job.\n", "type": "object", "required": [ "href", "readyTime", "_links" ], "properties": { "href": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "readyTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "expiryTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "fileSize": { "description": "The size of the report file in bytes, if known.\n", "type": "integer" }, "_links": { "description": "Links for this resource.\n", "type": "object", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "objects": { "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.\n", "type": "array", "items": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } } } } }, "parameters": [ { "name": "pmJobId", "in": "path", "required": true, "schema": { "title": "pmJobId", "type": "string" } } ] }, "patch": { "operationId": "patchPmJobsPmJobId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "This type represents modifications to a PM job. It shall comply with the provisions defined in Table 7.5.2.12-1.\n", "type": "object", "properties": { "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "authentication": { "type": "object", "required": [ "authType" ], "properties": { "authType": { "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\n HTTP Basic authentication with the client credentials.\n- OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the\n notification endpoint, use an OAuth 2.0 Bearer token, obtained\n using the client credentials grant type.\n- TLS_CERT: Every HTTP request to the notification endpoint is sent\n over a mutually authenticated TLS session, i.e. not only the\n server is authenticated, but also the client is authenticated\n during the TLS tunnel setup.\n", "type": "array", "items": { "type": "string", "enum": [ "BASIC", "OAUTH2_CLIENT_CREDENTIALS", "TLS_CERT" ] } }, "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.\n", "type": "object", "properties": { "userName": { "description": "Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n", "type": "string" }, "password": { "description": "Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n", "type": "string" } } }, "paramsOauth2ClientCredentials": { "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.\n", "type": "object", "properties": { "clientId": { "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.\n", "type": "string" }, "clientPassword": { "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.\n", "type": "string" }, "tokenEndpoint": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "pmJobId", "in": "path", "required": true, "schema": { "title": "pmJobId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deletePmJobsPmJobId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pmJobId", "in": "path", "required": true, "schema": { "title": "pmJobId", "type": "string" } } ] } }, "/nspm/v2/pm_jobs/{pmJobId}/reports/{reportId}": { "get": { "operationId": "getPmJobsPmJobIdReportsReportId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "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.\n", "type": "object", "required": [ "entries" ], "properties": { "entries": { "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.\n", "type": "array", "items": { "type": "object", "required": [ "objectType", "objectInstanceId", "performanceMetric", "performanceValue" ], "properties": { "objectType": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "objectInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "subObjectInstanceId": { "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.\nThe sub-object allows to structure the measured object but is not to be confused with sub-counters which allow to structure the measurement value.\n\n\tEXAMPLE:\n\t\tMeasured object:\tVnfInstanceXYZ\n\t\tSub-object:\t\tVnfcInstance1\n\t\tMeasurement: \tvCPU_utilization\n\t\tSub-counters: \tvCPU utilization of each of the vCPUs of VnfcInstance1\n\t\t\t\t\t\t(vCPU utilization.vCPU1, vCPU_utilization.vCPU2, etc.).\n", "type": "array", "items": { "description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n", "type": "string" } }, "performanceMetric": { "description": "A string as defined in IETF RFC 8259.\n", "type": "string" }, "performanceValues": { "description": "List of performance values with associated timestamp.\n", "type": "array", "items": { "type": "object", "required": [ "timeStamp", "performanceValue" ], "properties": { "timeStamp": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "value": { "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.\n", "type": "object" }, "context": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } } } } } } } } } } }, "parameters": [ { "name": "pmJobId", "in": "path", "required": true, "schema": { "title": "pmJobId", "type": "string" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "title": "reportId", "type": "string" } } ] } }, "/nspm/v2/thresholds": { "post": { "operationId": "postThresholds", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "This type represents a threshold.\n", "type": "object", "required": [ "id", "objectType", "objectInstanceId", "criteria", "callbackUri", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "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.\n" }, "objectInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "subObjectInstanceIds": { "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.\n", "type": "array", "items": { "description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n", "type": "string" } }, "criteria": { "description": "This type represents criteria that define a threshold.\n", "type": "object", "required": [ "performanceMetric", "thresholdType" ], "properties": { "performanceMetric": { "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.\n", "type": "string" }, "thresholdType": { "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.\n", "type": "string", "enum": [ "SIMPLE" ] }, "simpleThresholdDetails": { "description": "Details of a simple threshold. Shall be present if thresholdType=\"SIMPLE\".\n", "type": "object", "required": [ "thresholdValue", "hysteresis" ], "properties": { "thresholdValue": { "description": "The threshold value. Shall be represented as a floating point number. \n", "type": "integer" }, "hysteresis": { "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).\n", "type": "integer" } } } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "_links": { "description": "Links for this resource.\n", "type": "object", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "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.\n" } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "operationId": "getThresholds", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "This type represents a threshold.\n", "type": "object", "required": [ "id", "objectType", "objectInstanceId", "criteria", "callbackUri", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "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.\n" }, "objectInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "subObjectInstanceIds": { "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.\n", "type": "array", "items": { "description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n", "type": "string" } }, "criteria": { "description": "This type represents criteria that define a threshold.\n", "type": "object", "required": [ "performanceMetric", "thresholdType" ], "properties": { "performanceMetric": { "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.\n", "type": "string" }, "thresholdType": { "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.\n", "type": "string", "enum": [ "SIMPLE" ] }, "simpleThresholdDetails": { "description": "Details of a simple threshold. Shall be present if thresholdType=\"SIMPLE\".\n", "type": "object", "required": [ "thresholdValue", "hysteresis" ], "properties": { "thresholdValue": { "description": "The threshold value. Shall be represented as a floating point number. \n", "type": "integer" }, "hysteresis": { "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).\n", "type": "integer" } } } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "_links": { "description": "Links for this resource.\n", "type": "object", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "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.\n" } } } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/nspm/v2/thresholds/{thresholdId}": { "get": { "operationId": "getThresholdsThresholdId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "This type represents a threshold.\n", "type": "object", "required": [ "id", "objectType", "objectInstanceId", "criteria", "callbackUri", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "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.\n" }, "objectInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "subObjectInstanceIds": { "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.\n", "type": "array", "items": { "description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n", "type": "string" } }, "criteria": { "description": "This type represents criteria that define a threshold.\n", "type": "object", "required": [ "performanceMetric", "thresholdType" ], "properties": { "performanceMetric": { "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.\n", "type": "string" }, "thresholdType": { "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.\n", "type": "string", "enum": [ "SIMPLE" ] }, "simpleThresholdDetails": { "description": "Details of a simple threshold. Shall be present if thresholdType=\"SIMPLE\".\n", "type": "object", "required": [ "thresholdValue", "hysteresis" ], "properties": { "thresholdValue": { "description": "The threshold value. Shall be represented as a floating point number. \n", "type": "integer" }, "hysteresis": { "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).\n", "type": "integer" } } } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "_links": { "description": "Links for this resource.\n", "type": "object", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "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.\n" } } } } } } } } }, "parameters": [ { "name": "thresholdId", "in": "path", "required": true, "schema": { "title": "thresholdId", "type": "string" } } ] }, "patch": { "operationId": "patchThresholdsThresholdId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "This type represents modifications to a threshold. It shall comply with the provisions defined in Table 7.5.2.11-1.\n", "type": "object", "properties": { "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "authentication": { "type": "object", "required": [ "authType" ], "properties": { "authType": { "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\n HTTP Basic authentication with the client credentials.\n- OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the\n notification endpoint, use an OAuth 2.0 Bearer token, obtained\n using the client credentials grant type.\n- TLS_CERT: Every HTTP request to the notification endpoint is sent\n over a mutually authenticated TLS session, i.e. not only the\n server is authenticated, but also the client is authenticated\n during the TLS tunnel setup.\n", "type": "array", "items": { "type": "string", "enum": [ "BASIC", "OAUTH2_CLIENT_CREDENTIALS", "TLS_CERT" ] } }, "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.\n", "type": "object", "properties": { "userName": { "description": "Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n", "type": "string" }, "password": { "description": "Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n", "type": "string" } } }, "paramsOauth2ClientCredentials": { "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.\n", "type": "object", "properties": { "clientId": { "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.\n", "type": "string" }, "clientPassword": { "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.\n", "type": "string" }, "tokenEndpoint": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "thresholdId", "in": "path", "required": true, "schema": { "title": "thresholdId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteThresholdsThresholdId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "thresholdId", "in": "path", "required": true, "schema": { "title": "thresholdId", "type": "string" } } ] } }, "/nfvici/v1/nfvi_capacity_infos": { "get": { "operationId": "getNfviCapacityInfos", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "This type defines the format of the NFVI capacity information. The type shall comply with the provisions defined\nin Table 10.5.2.4-1.\n", "required": [ "id", "vimId", "capacityInfoPerZone" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vimId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "capacityInfoPerZone": { "description": "Capacity information on a per resource zone basis under control by the associated VIM.\n", "type": "array", "items": { "type": "object", "description": "This type defines the format of the NFVI capacity information on a per resource zone basis.\nThe type shall comply with the provisions defined in table 10.5.2.5-1.\n", "required": [ "capacityMeasurements" ], "properties": { "resourceZoneId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "capacityMeasurements": { "description": "Capacity measurement on a per resource type basis.\n", "type": "array", "items": { "type": "object", "description": "This type defines the format of the NFVI capacity information on a per resource type basis.\nThe type shall comply with the provisions defined in table 10.5.2.6-1.\n", "required": [ "resourceType", "capacityMeasurementName", "totalCapacity", "allocatedCapacity", "availableCapacity" ], "properties": { "resourceType": { "type": "string", "description": "The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1.\n* VR_COMPUTE: For virtualised compute resource.\n* VR_NETWORK: For virtualised network resource.\n* VR_STORAGE: For virtualised storage resource.\n* HOST_COMPUTE: For host compute resource.\n", "enum": [ "VR_COMPUTE", "VR_NETWORK", "VR_STORAGE", "HOST_COMPUTE" ] }, "capacityMeasurementName": { "description": "Name of the capacity measurement. Different resource types can have different associated capacity measurements,\ntypically associated to different sub-types of the resource type.\nThe present document and referred documents do not specify the capacity measurements, thus the capacity\nmeasurement names are not specified in the present document version.\n", "type": "string" }, "totalCapacity": { "description": "The total capacity.\n", "type": "object" }, "allocatedCapacity": { "description": "The allocated/used capacity.\n", "type": "object" }, "reservedCapacity": { "description": "The reserved capacity. Shall be present if the capacity measurement relates to a resource type and\n(and sub-type) that is reservable.\n", "type": "object" }, "availableCapacity": { "description": "The available capacity.\n", "type": "object" } } } } } } }, "totalCapacityInfo": { "type": "object", "description": "This type defines the format of the NFVI capacity information on a per resource type basis.\nThe type shall comply with the provisions defined in table 10.5.2.6-1.\n", "required": [ "resourceType", "capacityMeasurementName", "totalCapacity", "allocatedCapacity", "availableCapacity" ], "properties": { "resourceType": { "type": "string", "description": "The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1.\n* VR_COMPUTE: For virtualised compute resource.\n* VR_NETWORK: For virtualised network resource.\n* VR_STORAGE: For virtualised storage resource.\n* HOST_COMPUTE: For host compute resource.\n", "enum": [ "VR_COMPUTE", "VR_NETWORK", "VR_STORAGE", "HOST_COMPUTE" ] }, "capacityMeasurementName": { "description": "Name of the capacity measurement. Different resource types can have different associated capacity measurements,\ntypically associated to different sub-types of the resource type.\nThe present document and referred documents do not specify the capacity measurements, thus the capacity\nmeasurement names are not specified in the present document version.\n", "type": "string" }, "totalCapacity": { "description": "The total capacity.\n", "type": "object" }, "allocatedCapacity": { "description": "The allocated/used capacity.\n", "type": "object" }, "reservedCapacity": { "description": "The reserved capacity. Shall be present if the capacity measurement relates to a resource type and\n(and sub-type) that is reservable.\n", "type": "object" }, "availableCapacity": { "description": "The available capacity.\n", "type": "object" } } }, "timeInterval": { "type": "object", "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.\n", "required": [ "aTime" ], "properties": { "aTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "bTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" } } } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "in": "query", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "in": "query", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "in": "query", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/nfvici/v1/nfvi_capacity_infos/{vimId}": { "get": { "operationId": "getNfviCapacityInfosVimId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "This type defines the format of the NFVI capacity information. The type shall comply with the provisions defined\nin Table 10.5.2.4-1.\n", "required": [ "id", "vimId", "capacityInfoPerZone" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vimId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "capacityInfoPerZone": { "description": "Capacity information on a per resource zone basis under control by the associated VIM.\n", "type": "array", "items": { "type": "object", "description": "This type defines the format of the NFVI capacity information on a per resource zone basis.\nThe type shall comply with the provisions defined in table 10.5.2.5-1.\n", "required": [ "capacityMeasurements" ], "properties": { "resourceZoneId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "capacityMeasurements": { "description": "Capacity measurement on a per resource type basis.\n", "type": "array", "items": { "type": "object", "description": "This type defines the format of the NFVI capacity information on a per resource type basis.\nThe type shall comply with the provisions defined in table 10.5.2.6-1.\n", "required": [ "resourceType", "capacityMeasurementName", "totalCapacity", "allocatedCapacity", "availableCapacity" ], "properties": { "resourceType": { "type": "string", "description": "The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1.\n* VR_COMPUTE: For virtualised compute resource.\n* VR_NETWORK: For virtualised network resource.\n* VR_STORAGE: For virtualised storage resource.\n* HOST_COMPUTE: For host compute resource.\n", "enum": [ "VR_COMPUTE", "VR_NETWORK", "VR_STORAGE", "HOST_COMPUTE" ] }, "capacityMeasurementName": { "description": "Name of the capacity measurement. Different resource types can have different associated capacity measurements,\ntypically associated to different sub-types of the resource type.\nThe present document and referred documents do not specify the capacity measurements, thus the capacity\nmeasurement names are not specified in the present document version.\n", "type": "string" }, "totalCapacity": { "description": "The total capacity.\n", "type": "object" }, "allocatedCapacity": { "description": "The allocated/used capacity.\n", "type": "object" }, "reservedCapacity": { "description": "The reserved capacity. Shall be present if the capacity measurement relates to a resource type and\n(and sub-type) that is reservable.\n", "type": "object" }, "availableCapacity": { "description": "The available capacity.\n", "type": "object" } } } } } } }, "totalCapacityInfo": { "type": "object", "description": "This type defines the format of the NFVI capacity information on a per resource type basis.\nThe type shall comply with the provisions defined in table 10.5.2.6-1.\n", "required": [ "resourceType", "capacityMeasurementName", "totalCapacity", "allocatedCapacity", "availableCapacity" ], "properties": { "resourceType": { "type": "string", "description": "The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1.\n* VR_COMPUTE: For virtualised compute resource.\n* VR_NETWORK: For virtualised network resource.\n* VR_STORAGE: For virtualised storage resource.\n* HOST_COMPUTE: For host compute resource.\n", "enum": [ "VR_COMPUTE", "VR_NETWORK", "VR_STORAGE", "HOST_COMPUTE" ] }, "capacityMeasurementName": { "description": "Name of the capacity measurement. Different resource types can have different associated capacity measurements,\ntypically associated to different sub-types of the resource type.\nThe present document and referred documents do not specify the capacity measurements, thus the capacity\nmeasurement names are not specified in the present document version.\n", "type": "string" }, "totalCapacity": { "description": "The total capacity.\n", "type": "object" }, "allocatedCapacity": { "description": "The allocated/used capacity.\n", "type": "object" }, "reservedCapacity": { "description": "The reserved capacity. Shall be present if the capacity measurement relates to a resource type and\n(and sub-type) that is reservable.\n", "type": "object" }, "availableCapacity": { "description": "The available capacity.\n", "type": "object" } } }, "timeInterval": { "type": "object", "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.\n", "required": [ "aTime" ], "properties": { "aTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "bTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" } } } } } } } } }, "parameters": [ { "name": "vimId", "in": "path", "required": true, "schema": { "title": "vimId", "type": "string" } }, { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } } ] } }, "/nfvici/v1/capacity_thresholds": { "get": { "operationId": "getCapacityThresholds", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "This type represents a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1.\n", "required": [ "id", "objectInstanceId", "criteria", "callbackUri", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "objectInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "subObjectInstanceIds": { "description": "Identifiers of the sub-object instances of the measured object instance associate with this capacity threshold.\nIf this attribute is absent, measurements are taken for all sub-object instances of the measured object instance.\n", "type": "array", "items": { "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.\n", "type": "string" } }, "criteria": { "type": "object", "description": "This type represents criteria that define a capacity threshold.\nIt shall comply with the provisions defined in table 10.5.3.3-1.\n", "required": [ "capacityMetric", "thresholdType" ], "properties": { "capacityMetric": { "description": "Defines the capacity metric for which the threshold applies.\n", "type": "object", "required": [ "resourceType", "capacityMeasurementName", "capacityType" ], "properties": { "resourceType": { "type": "string", "description": "The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1.\n* VR_COMPUTE: For virtualised compute resource.\n* VR_NETWORK: For virtualised network resource.\n* VR_STORAGE: For virtualised storage resource.\n* HOST_COMPUTE: For host compute resource.\n", "enum": [ "VR_COMPUTE", "VR_NETWORK", "VR_STORAGE", "HOST_COMPUTE" ] }, "capacityMeasurementName": { "description": "Name of the capacity measurement. Different resource types can have different associated capacity measurements,\ntypically associated to different sub-types of the resource type.\n", "type": "string" }, "capacityType": { "description": "The type of capacity for the threshold.\nPermitted values:\n-\tTOTAL: for total capacity.\n-\tALLOCATED: for allocated/used capacity.\n-\tRESERVED: for reserved capacity.\n-\tAVAILABLE: for available capacity.\n", "type": "string", "enum": [ "TOTAL", "ALLOCATED", "RESERVED", "AVAILABLE" ] } } }, "thresholdType": { "description": "Type of capacity threshold. This attribute determines which other attributes are present in the data structure.\nPermitted values:\n-\tSIMPLE: Single-valued static threshold.\nIn the present document, simple thresholds are defined. The definition of additional threshold types is left\nfor future specification.\n", "type": "string", "enum": [ "SIMPLE" ] }, "simpleThresholdDetails": { "description": "Details of a simple threshold. Shall be present if thresholdType=\"SIMPLE\".\n", "type": "array", "items": { "type": "object", "required": [ "thresholdValue", "hysteresis" ], "properties": { "thresholdValue": { "description": "The threshold value. Shall be represented as a floating point number.\n", "type": "number" }, "hysteresis": { "description": "The hysteresis of the threshold.\nShall be represented as a non-negative floating point number.\nA notification with crossing direction \"UP\" will be generated if the measured value reaches or\nexceeds \"thresholdValue\" + \"hysteresis\". A notification with crossing direction \"DOWN\" will be\ngenerated if the measured value reaches or undercuts \"thresholdValue\" - \"hysteresis\".\nThe hysteresis is defined to prevent storms of threshold crossing notifications.\nWhen processing a request to create a threshold, implementations should enforce a suitable minimum\nvalue for this attribute (e.g. override the value or reject the request).\n", "type": "number" } } } } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "_links": { "type": "object", "description": "Links for this resource.\n", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "object": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] }, "post": { "operationId": "postCapacityThresholds", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "This type represents a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1.\n", "required": [ "id", "objectInstanceId", "criteria", "callbackUri", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "objectInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "subObjectInstanceIds": { "description": "Identifiers of the sub-object instances of the measured object instance associate with this capacity threshold.\nIf this attribute is absent, measurements are taken for all sub-object instances of the measured object instance.\n", "type": "array", "items": { "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.\n", "type": "string" } }, "criteria": { "type": "object", "description": "This type represents criteria that define a capacity threshold.\nIt shall comply with the provisions defined in table 10.5.3.3-1.\n", "required": [ "capacityMetric", "thresholdType" ], "properties": { "capacityMetric": { "description": "Defines the capacity metric for which the threshold applies.\n", "type": "object", "required": [ "resourceType", "capacityMeasurementName", "capacityType" ], "properties": { "resourceType": { "type": "string", "description": "The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1.\n* VR_COMPUTE: For virtualised compute resource.\n* VR_NETWORK: For virtualised network resource.\n* VR_STORAGE: For virtualised storage resource.\n* HOST_COMPUTE: For host compute resource.\n", "enum": [ "VR_COMPUTE", "VR_NETWORK", "VR_STORAGE", "HOST_COMPUTE" ] }, "capacityMeasurementName": { "description": "Name of the capacity measurement. Different resource types can have different associated capacity measurements,\ntypically associated to different sub-types of the resource type.\n", "type": "string" }, "capacityType": { "description": "The type of capacity for the threshold.\nPermitted values:\n-\tTOTAL: for total capacity.\n-\tALLOCATED: for allocated/used capacity.\n-\tRESERVED: for reserved capacity.\n-\tAVAILABLE: for available capacity.\n", "type": "string", "enum": [ "TOTAL", "ALLOCATED", "RESERVED", "AVAILABLE" ] } } }, "thresholdType": { "description": "Type of capacity threshold. This attribute determines which other attributes are present in the data structure.\nPermitted values:\n-\tSIMPLE: Single-valued static threshold.\nIn the present document, simple thresholds are defined. The definition of additional threshold types is left\nfor future specification.\n", "type": "string", "enum": [ "SIMPLE" ] }, "simpleThresholdDetails": { "description": "Details of a simple threshold. Shall be present if thresholdType=\"SIMPLE\".\n", "type": "array", "items": { "type": "object", "required": [ "thresholdValue", "hysteresis" ], "properties": { "thresholdValue": { "description": "The threshold value. Shall be represented as a floating point number.\n", "type": "number" }, "hysteresis": { "description": "The hysteresis of the threshold.\nShall be represented as a non-negative floating point number.\nA notification with crossing direction \"UP\" will be generated if the measured value reaches or\nexceeds \"thresholdValue\" + \"hysteresis\". A notification with crossing direction \"DOWN\" will be\ngenerated if the measured value reaches or undercuts \"thresholdValue\" - \"hysteresis\".\nThe hysteresis is defined to prevent storms of threshold crossing notifications.\nWhen processing a request to create a threshold, implementations should enforce a suitable minimum\nvalue for this attribute (e.g. override the value or reject the request).\n", "type": "number" } } } } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "_links": { "type": "object", "description": "Links for this resource.\n", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "object": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nfvici/v1/capacity_thresholds/{capacityThresholdId}": { "get": { "operationId": "getCapacityThresholdsCapacityThresholdId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "description": "This type represents a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1.\n", "required": [ "id", "objectInstanceId", "criteria", "callbackUri", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "objectInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "subObjectInstanceIds": { "description": "Identifiers of the sub-object instances of the measured object instance associate with this capacity threshold.\nIf this attribute is absent, measurements are taken for all sub-object instances of the measured object instance.\n", "type": "array", "items": { "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.\n", "type": "string" } }, "criteria": { "type": "object", "description": "This type represents criteria that define a capacity threshold.\nIt shall comply with the provisions defined in table 10.5.3.3-1.\n", "required": [ "capacityMetric", "thresholdType" ], "properties": { "capacityMetric": { "description": "Defines the capacity metric for which the threshold applies.\n", "type": "object", "required": [ "resourceType", "capacityMeasurementName", "capacityType" ], "properties": { "resourceType": { "type": "string", "description": "The enumeration NfviCapacityResourceTypeEnumeration shall comply with the provisions in table 10.5.4.3-1.\n* VR_COMPUTE: For virtualised compute resource.\n* VR_NETWORK: For virtualised network resource.\n* VR_STORAGE: For virtualised storage resource.\n* HOST_COMPUTE: For host compute resource.\n", "enum": [ "VR_COMPUTE", "VR_NETWORK", "VR_STORAGE", "HOST_COMPUTE" ] }, "capacityMeasurementName": { "description": "Name of the capacity measurement. Different resource types can have different associated capacity measurements,\ntypically associated to different sub-types of the resource type.\n", "type": "string" }, "capacityType": { "description": "The type of capacity for the threshold.\nPermitted values:\n-\tTOTAL: for total capacity.\n-\tALLOCATED: for allocated/used capacity.\n-\tRESERVED: for reserved capacity.\n-\tAVAILABLE: for available capacity.\n", "type": "string", "enum": [ "TOTAL", "ALLOCATED", "RESERVED", "AVAILABLE" ] } } }, "thresholdType": { "description": "Type of capacity threshold. This attribute determines which other attributes are present in the data structure.\nPermitted values:\n-\tSIMPLE: Single-valued static threshold.\nIn the present document, simple thresholds are defined. The definition of additional threshold types is left\nfor future specification.\n", "type": "string", "enum": [ "SIMPLE" ] }, "simpleThresholdDetails": { "description": "Details of a simple threshold. Shall be present if thresholdType=\"SIMPLE\".\n", "type": "array", "items": { "type": "object", "required": [ "thresholdValue", "hysteresis" ], "properties": { "thresholdValue": { "description": "The threshold value. Shall be represented as a floating point number.\n", "type": "number" }, "hysteresis": { "description": "The hysteresis of the threshold.\nShall be represented as a non-negative floating point number.\nA notification with crossing direction \"UP\" will be generated if the measured value reaches or\nexceeds \"thresholdValue\" + \"hysteresis\". A notification with crossing direction \"DOWN\" will be\ngenerated if the measured value reaches or undercuts \"thresholdValue\" - \"hysteresis\".\nThe hysteresis is defined to prevent storms of threshold crossing notifications.\nWhen processing a request to create a threshold, implementations should enforce a suitable minimum\nvalue for this attribute (e.g. override the value or reject the request).\n", "type": "number" } } } } } }, "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "_links": { "type": "object", "description": "Links for this resource.\n", "required": [ "self" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "object": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "capacityThresholdId", "in": "path", "required": true, "schema": { "title": "capacityThresholdId", "type": "string" } } ] }, "patch": { "operationId": "patchCapacityThresholdsCapacityThresholdId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "description": "This type represents modifications to a capacity threshold. It shall comply with the provisions defined in table 10.5.2.8-1.\n", "type": "object", "properties": { "callbackUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "authentication": { "type": "object", "required": [ "authType" ], "properties": { "authType": { "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\n HTTP Basic authentication with the client credentials.\n- OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the\n notification endpoint, use an OAuth 2.0 Bearer token, obtained\n using the client credentials grant type.\n- TLS_CERT: Every HTTP request to the notification endpoint is sent\n over a mutually authenticated TLS session, i.e. not only the\n server is authenticated, but also the client is authenticated\n during the TLS tunnel setup.\n", "type": "array", "items": { "type": "string", "enum": [ "BASIC", "OAUTH2_CLIENT_CREDENTIALS", "TLS_CERT" ] } }, "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.\n", "type": "object", "properties": { "userName": { "description": "Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n", "type": "string" }, "password": { "description": "Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n", "type": "string" } } }, "paramsOauth2ClientCredentials": { "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.\n", "type": "object", "properties": { "clientId": { "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.\n", "type": "string" }, "clientPassword": { "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.\n", "type": "string" }, "tokenEndpoint": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "capacityThresholdId", "in": "path", "required": true, "schema": { "title": "capacityThresholdId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteCapacityThresholdsCapacityThresholdId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "capacityThresholdId", "in": "path", "required": true, "schema": { "title": "capacityThresholdId", "type": "string" } } ] } }, "/vnfsnapshotpkgm/v1/vnf_snapshot_packages": { "post": { "operationId": "postVnfSnapshotPackages", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "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.\n", "type": "object", "required": [ "id", "name", "isFullSnapshot", "state", "isCancelPending", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfSnapshotPkgUniqueId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "name": { "description": "Human-readable name of the VNF snapshot package.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "createdAt": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "vnfSnapshotId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfcSnapshotInfoIds": { "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.\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.\n", "type": "array", "items": { "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.\n", "type": "string" } }, "isFullSnapshot": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "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.\n", "type": "object", "required": [ "vnfdId", "vnfdPath", "checksum", "isEncrypted" ], "properties": { "vnfdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfdPath": { "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.\nThe 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 \"/\".\nEXAMPLE: foo/bar/m@ster\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" } } }, "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.\n", "type": "object", "required": [ "recordPath", "checksum", "isEncrypted" ], "properties": { "recordPath": { "description": "Path which identifies the VNF snapshot record and allows to access a copy of the VNF snapshot record for the extraction.\nThe 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 \"/\".\nEXAMPLE: foo/bar/m@ster\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" } } }, "vnfcSnapshotImages": { "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.\n", "type": "array", "items": { "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.\n", "type": "object", "required": [ "id", "name", "checksum", "isEncrypted", "vnfcInstanceId", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size" ], "properties": { "id": { "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.\n", "type": "string" }, "name": { "description": "Name of the VNFC snapshot image.", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "vnfcInstanceId": { "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", "type": "string" }, "containerFormat": { "description": "Container format indicates whether the snapshot image is in a file format that also contains metadata about the actual snapshot.\nPermitted 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.\nThe 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)\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF" ] }, "diskFormat": { "description": "Disk format of a snapshot image is the format of the underlying disk image.\nPermitted 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.\nThe 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)\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK" ] }, "createdAt": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "minDisk": { "description": "Unsigned integer number\n", "type": "integer", "minimum": 0 }, "minRam": { "description": "Unsigned integer number\n", "type": "integer", "minimum": 0 }, "size": { "description": "Unsigned integer number\n", "type": "integer", "minimum": 0 }, "userMetadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "imagePath": { "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.\n", "type": "string" }, "imageUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } }, "additionalArtifacts": { "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.\n", "type": "array", "items": { "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.\n", "type": "object", "required": [ "checksum", "isEncrypted" ], "properties": { "artifactPath": { "description": "Path which identifies the artifact and also allows to access a copy of the artifact.\nFor 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 \"/\".\nEXAMPLE: foo/bar/m%40ster.sh\nFor 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.\n", "type": "string" }, "artifactUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "state": { "description": "State of the VNF snapshot package.\nPermitted 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.\n", "type": "string", "enum": [ "CREATED", "BUILDING", "UPLOADING", "EXTRACTING", "AVAILABLE", "ERROR", "ERROR_EXTRACTING" ] }, "isCancelPending": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "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.\n", "type": "object", "required": [ "errorType", "details" ], "properties": { "errorType": { "description": "Type of error, when the failure happened (building, upload, processing, extracting). Permitted values: - BUILD_ERROR - UPLOAD_ERROR - PROCESS_ERROR - CANCELLED - EXTRACTION_ERROR\n", "type": "string", "enum": [ "BUILD_ERROR", "UPLOAD_ERROR", "PROCESS_ERROR", "CANCELLED", "EXTRACTION_ERROR" ] }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } } } }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "_links": { "description": "Links to resources related to this resource.\n", "type": "object", "required": [ "self", "packageContent" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "packageContent": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "operationId": "getVnfSnapshotPackages", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "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.\n", "type": "object", "required": [ "id", "name", "isFullSnapshot", "state", "isCancelPending", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfSnapshotPkgUniqueId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "name": { "description": "Human-readable name of the VNF snapshot package.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "createdAt": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "vnfSnapshotId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfcSnapshotInfoIds": { "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.\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.\n", "type": "array", "items": { "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.\n", "type": "string" } }, "isFullSnapshot": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "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.\n", "type": "object", "required": [ "vnfdId", "vnfdPath", "checksum", "isEncrypted" ], "properties": { "vnfdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfdPath": { "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.\nThe 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 \"/\".\nEXAMPLE: foo/bar/m@ster\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" } } }, "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.\n", "type": "object", "required": [ "recordPath", "checksum", "isEncrypted" ], "properties": { "recordPath": { "description": "Path which identifies the VNF snapshot record and allows to access a copy of the VNF snapshot record for the extraction.\nThe 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 \"/\".\nEXAMPLE: foo/bar/m@ster\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" } } }, "vnfcSnapshotImages": { "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.\n", "type": "array", "items": { "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.\n", "type": "object", "required": [ "id", "name", "checksum", "isEncrypted", "vnfcInstanceId", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size" ], "properties": { "id": { "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.\n", "type": "string" }, "name": { "description": "Name of the VNFC snapshot image.", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "vnfcInstanceId": { "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", "type": "string" }, "containerFormat": { "description": "Container format indicates whether the snapshot image is in a file format that also contains metadata about the actual snapshot.\nPermitted 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.\nThe 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)\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF" ] }, "diskFormat": { "description": "Disk format of a snapshot image is the format of the underlying disk image.\nPermitted 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.\nThe 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)\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK" ] }, "createdAt": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "minDisk": { "description": "Unsigned integer number\n", "type": "integer", "minimum": 0 }, "minRam": { "description": "Unsigned integer number\n", "type": "integer", "minimum": 0 }, "size": { "description": "Unsigned integer number\n", "type": "integer", "minimum": 0 }, "userMetadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "imagePath": { "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.\n", "type": "string" }, "imageUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } }, "additionalArtifacts": { "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.\n", "type": "array", "items": { "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.\n", "type": "object", "required": [ "checksum", "isEncrypted" ], "properties": { "artifactPath": { "description": "Path which identifies the artifact and also allows to access a copy of the artifact.\nFor 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 \"/\".\nEXAMPLE: foo/bar/m%40ster.sh\nFor 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.\n", "type": "string" }, "artifactUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "state": { "description": "State of the VNF snapshot package.\nPermitted 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.\n", "type": "string", "enum": [ "CREATED", "BUILDING", "UPLOADING", "EXTRACTING", "AVAILABLE", "ERROR", "ERROR_EXTRACTING" ] }, "isCancelPending": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "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.\n", "type": "object", "required": [ "errorType", "details" ], "properties": { "errorType": { "description": "Type of error, when the failure happened (building, upload, processing, extracting). Permitted values: - BUILD_ERROR - UPLOAD_ERROR - PROCESS_ERROR - CANCELLED - EXTRACTION_ERROR\n", "type": "string", "enum": [ "BUILD_ERROR", "UPLOAD_ERROR", "PROCESS_ERROR", "CANCELLED", "EXTRACTION_ERROR" ] }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } } } }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "_links": { "description": "Links to resources related to this resource.\n", "type": "object", "required": [ "self", "packageContent" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "packageContent": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "in": "query", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "in": "query", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "in": "query", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}": { "get": { "operationId": "getVnfSnapshotPackagesVnfSnapshotPkgId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "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.\n", "type": "object", "required": [ "id", "name", "isFullSnapshot", "state", "isCancelPending", "_links" ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfSnapshotPkgUniqueId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "name": { "description": "Human-readable name of the VNF snapshot package.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "createdAt": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "vnfSnapshotId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfcSnapshotInfoIds": { "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.\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.\n", "type": "array", "items": { "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.\n", "type": "string" } }, "isFullSnapshot": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "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.\n", "type": "object", "required": [ "vnfdId", "vnfdPath", "checksum", "isEncrypted" ], "properties": { "vnfdId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfdPath": { "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.\nThe 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 \"/\".\nEXAMPLE: foo/bar/m@ster\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" } } }, "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.\n", "type": "object", "required": [ "recordPath", "checksum", "isEncrypted" ], "properties": { "recordPath": { "description": "Path which identifies the VNF snapshot record and allows to access a copy of the VNF snapshot record for the extraction.\nThe 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 \"/\".\nEXAMPLE: foo/bar/m@ster\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" } } }, "vnfcSnapshotImages": { "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.\n", "type": "array", "items": { "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.\n", "type": "object", "required": [ "id", "name", "checksum", "isEncrypted", "vnfcInstanceId", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size" ], "properties": { "id": { "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.\n", "type": "string" }, "name": { "description": "Name of the VNFC snapshot image.", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "vnfcInstanceId": { "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", "type": "string" }, "containerFormat": { "description": "Container format indicates whether the snapshot image is in a file format that also contains metadata about the actual snapshot.\nPermitted 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.\nThe 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)\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF" ] }, "diskFormat": { "description": "Disk format of a snapshot image is the format of the underlying disk image.\nPermitted 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.\nThe 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)\n", "type": "string", "enum": [ "AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK" ] }, "createdAt": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n" }, "minDisk": { "description": "Unsigned integer number\n", "type": "integer", "minimum": 0 }, "minRam": { "description": "Unsigned integer number\n", "type": "integer", "minimum": 0 }, "size": { "description": "Unsigned integer number\n", "type": "integer", "minimum": 0 }, "userMetadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "imagePath": { "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.\n", "type": "string" }, "imageUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } } } }, "additionalArtifacts": { "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.\n", "type": "array", "items": { "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.\n", "type": "object", "required": [ "checksum", "isEncrypted" ], "properties": { "artifactPath": { "description": "Path which identifies the artifact and also allows to access a copy of the artifact.\nFor 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 \"/\".\nEXAMPLE: foo/bar/m%40ster.sh\nFor 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.\n", "type": "string" }, "artifactUri": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n", "required": [ "algorithm", "hash" ], "type": "object", "properties": { "algorithm": { "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.\n", "type": "string" }, "hash": { "description": "The hexadecimal value of the checksum.\n", "type": "string" } } }, "isEncrypted": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "metadata": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" } } } }, "state": { "description": "State of the VNF snapshot package.\nPermitted 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.\n", "type": "string", "enum": [ "CREATED", "BUILDING", "UPLOADING", "EXTRACTING", "AVAILABLE", "ERROR", "ERROR_EXTRACTING" ] }, "isCancelPending": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" }, "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.\n", "type": "object", "required": [ "errorType", "details" ], "properties": { "errorType": { "description": "Type of error, when the failure happened (building, upload, processing, extracting). Permitted values: - BUILD_ERROR - UPLOAD_ERROR - PROCESS_ERROR - CANCELLED - EXTRACTION_ERROR\n", "type": "string", "enum": [ "BUILD_ERROR", "UPLOAD_ERROR", "PROCESS_ERROR", "CANCELLED", "EXTRACTION_ERROR" ] }, "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].\n", "type": "object", "required": [ "status", "detail" ], "properties": { "type": { "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", "type": "string" }, "status": { "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string" } } } } }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "_links": { "description": "Links to resources related to this resource.\n", "type": "object", "required": [ "self", "packageContent" ], "properties": { "self": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } }, "packageContent": { "description": "This type represents a link to a resource.\n", "type": "object", "required": [ "href" ], "properties": { "href": { "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.\n", "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ] }, "patch": { "operationId": "patchVnfSnapshotPackagesVnfSnapshotPkgId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "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.\n", "type": "object", "properties": { "name": { "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.\n", "type": "string" }, "userDefinedData": { "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n", "type": "object" }, "state": { "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.\n", "type": "string", "enum": [ "AVAILABLE" ] } } } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteVnfSnapshotPackagesVnfSnapshotPkgId", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ] } }, "/vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content": { "get": { "operationId": "getVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ] }, "put": { "operationId": "putVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/upload_from_uri": { "post": { "operationId": "postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentUploadFromUri", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/build": { "post": { "operationId": "postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentBuild", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/extract": { "post": { "operationId": "postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentExtract", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/cancel": { "post": { "operationId": "postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentCancel", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/ext_artifacts_access": { "get": { "operationId": "getVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ] }, "put": { "operationId": "putVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfsnapshotpkgm/v1/vnf_snapshot_packages/{vnfSnapshotPkgId}/artifacts/{artifactPath}": { "get": { "operationId": "getVnfSnapshotPackagesVnfSnapshotPkgIdArtifactsArtifactPath", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotPkgId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } }, { "name": "artifactPath", "in": "path", "required": true, "schema": { "title": "artifactPath", "type": "string" } } ] } }, "/nslcm/v1/ns_instances": { "get": { "operationId": "querymultipleNSinstances", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "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": { "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": { "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": { "title": "VnfState", "enum": [ "STARTED", "STOPPED" ], "type": "string", "example": "STARTED" }, "scaleStatus": { "type": "array", "items": { "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." } } }, "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": { "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." } } }, "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": { "title": "ExtVirtualLinkInfo", "required": [ "id", "resourceHandle" ], "type": "object", "properties": { "id": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "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." }, "extLinkPorts": { "type": "array", "items": { "title": "ExtLinkPort", "required": [ "id", "resourceHandle" ], "type": "object", "properties": { "id": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "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." }, "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." }, "description": "Link ports of this 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": [ { "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": { "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." }, "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\n shall be present for a to-be-created external CP instance or an\n existing external CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\"." } } }, { "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": { "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." }, "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\n shall be present for a to-be-created external CP instance or an\n existing external CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\"." } } } ] }, "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." } } }, "description": "Information about the external VLs the VNF instance is connected to." }, "extManagedVirtualLinkInfo": { "type": "array", "items": { "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": { "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." }, "vnfLinkPorts": { "type": "array", "items": { "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": { "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." }, "cpInstanceId": { "type": "string", "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique." }, "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" } } }, "description": "Link ports of this VL." }, "extManagedMultisiteVirtualLinkId": { "type": "string", "description": "An identifier with the intention of being globally unique." } } }, "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": { "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." }, "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": { "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": { "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." }, "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": { "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": { "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." }, "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." } } }, "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." }, "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance." }, "virtualLinkResourceInfo": { "type": "array", "items": { "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": { "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." }, "reservationId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "vnfLinkPorts": { "type": "array", "items": { "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": { "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." }, "cpInstanceId": { "type": "string", "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique." }, "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" } } }, "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." }, "description": "Information about the virtualised network resources used by the VLs of the VNF instance." }, "virtualStorageResourceInfo": { "type": "array", "items": { "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": { "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." }, "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." }, "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." }, "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." }, "description": "Information on constituent VNF(s) of the NS instance." }, "pnfInfo": { "type": "array", "items": { "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": { "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": { "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." }, "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." } }, "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." }, "description": "Information on the PNF(s) that are part of the NS instance." }, "virtualLinkInfo": { "type": "array", "items": { "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": { "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." }, "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": { "title": "LinkPort", "required": [ "id", "resourceHandle" ], "type": "object", "properties": { "id": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "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." }, "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." }, "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" }, "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": { "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." }, "description": "Information on the VNFFG(s) of the NS instance." }, "sapInfo": { "type": "array", "items": { "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": { "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." }, "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." }, "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": { "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" }, "monitoringParameter": { "type": "array", "items": { "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." }, "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": { "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." }, "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": { "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": { "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" } }, "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.." }, "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": { "title": "Links", "required": [ "self" ], "type": "object", "properties": { "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." }, "nestedNsInstances": { "type": "array", "items": { "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." }, "description": "Links to resources related to this notification." }, "vnfSnapshotInfos": { "type": "array", "items": { "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." }, "description": "Links to the VNF snapshots associated to VNF instances which are part of this NS instance." }, "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." } }, "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." }, "description": "" } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "in": "query", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "in": "query", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "in": "query", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] }, "post": { "operationId": "createaNSinstanceresource", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_instances/{nsInstanceId}": { "get": { "operationId": "readanindividualNSinstanceresource", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsInstanceId", "in": "path", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } } ] }, "delete": { "operationId": "deleteNSinstanceresource", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsInstanceId", "in": "path", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } } ] } }, "/nslcm/v1/ns_instances/{nsInstanceId}/instantiate": { "post": { "operationId": "instantiateaNS", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsInstanceId", "in": "path", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_instances/{nsInstanceId}/scale": { "post": { "operationId": "scaleaNSinstance", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsInstanceId", "in": "path", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_instances/{nsInstanceId}/update": { "post": { "operationId": "updatesaNSinstance", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsInstanceId", "in": "path", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_instances/{nsInstanceId}/heal": { "post": { "operationId": "healaNSinstance", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsInstanceId", "in": "path", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_instances/{nsInstanceId}/terminate": { "post": { "operationId": "terminateaNSinstance", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsInstanceId", "in": "path", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_lcm_op_occs": { "get": { "operationId": "querymultipleNSLCMoperationoccurrences", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "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": { "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" }, "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": { "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" }, "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": { "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" }, "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": { "title": "CancelMode", "enum": [ "GRACEFUL", "FORCEFUL" ], "type": "string", "description": "Cancellation mode.\nThe 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.\nThe 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." }, "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": { "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": { "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" } }, "description": "This type provides information about added, deleted and modified PNFs. It shall comply with the provisions in Table 6.5.3.3-1." }, "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": { "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": { "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" }, "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": { "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." }, "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." }, "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": { "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": { "title": "ChangeType3", "enum": [ "ADD", "DELETE", "MODIFY" ], "type": "string", "description": "Signals the type of change. Permitted values: - ADD - DELETE - 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" } }, "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." }, "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": { "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": { "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" }, "changeResult": { "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" }, "changedInfo": { "title": "ChangedInfo6", "type": "object", "properties": { "wanConnectionInfoModifications": { "type": "array", "items": { "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": { "title": "MscsEndpoint", "required": [ "mscsEndpointId", "directionality", "connectivityServiceEndpoinId" ], "type": "object", "properties": { "mscsEndpointId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "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: -\tINBOUND: to indicate into the WAN. -\tOUTBOUND: to indicate from the WAN. -\tBOTH: 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." }, "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": { "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": { "title": "SiteToWanLayer2ProtocolData", "required": [ "layer2ConnectionInfo" ], "type": "object", "properties": { "layer2ConnectionInfo": { "title": "Layer2ConnectionInfo", "required": [ "connectionType", "interfaceType", "interfaceTagging", "encapsulationType" ], "type": "object", "properties": { "connectionType": { "title": "ConnectionType", "enum": [ "CSE", "AGGREGATE_CSE" ], "type": "string", "description": "The type of connection to be established on the connectivity service point. Permitted values: -\tCSE: defined by the characteristics of the existing referred connectivity service point. -\tAGGREGATE_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: -\tPARENT: use the mapped interface to the connectivity service endpoint as is, i.e., do not create logical interfaces. -\tLOGICAL: 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: -\tUNTAGGED: an interface where frames are not tagged. -\tTAGGED: 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: -\tETH: generic Ethernet encapsulation. -\tVLAN: encapsulation based on VLAN. -\tVXLAN: 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: -\tDOT1Q: used when packets on the CSE are encapsulated with one or a set of customer VLAN identifiers. -\tQINQ: used when packets on the CSE are encapsulated with multiple customer VLAN identifiers and a single\n service VLAN identifier.\n- 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": { "title": "PeerMode", "enum": [ "STATIC", "BGP_EVPN" ], "type": "string", "description": "Type of VXLAN access mode. Default value is \"STATIC\".\nPermitted values: -\tSTATIC -\tBGP_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\"." }, "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." }, "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)." }, "mtuL2": { "type": "number", "description": "Maximum Transmission Unit (MTU) that can be forwarded at layer 2 (in bytes). Default value is \"1500\" (bytes)." }, "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)." }, "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." }, "siteToWanLayer3ProtocolData": { "title": "SiteToWanLayer3ProtocolData", "required": [ "routingInfo" ], "type": "object", "properties": { "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": { "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: -\tBGP: used for dynamic routing BGPv4. -\tRIP: used for dynamic routing RIPv2. -\tOSPF: used for dynamic routing (OSPF version 2 for IPv4; and OSPF version 3 for IPv6). -\tSTATIC: used for static routing. -\tDIRECT: used when the NFVI-PoP network is directly connected to the WAN provider network. -\tVRRP: used when the NFVI-PoP network is directly connected to the WAN provider network with virtual\n router redundancy protocol support (VRRP).", "example": "BGP" }, "staticRouting": { "title": "StaticRouting", "required": [ "ipVersion", "ipPrefix", "prefixSize", "nextHop" ], "type": "object", "properties": { "ipVersion": { "title": "IpVersion", "enum": [ "IPV4", "IPV6" ], "type": "string", "description": "The IP version applicable to the routing entry. Permitted values: -\tIPV4 -\tIPV6", "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\"." }, "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: -\tIPV4 -\tIPV6", "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": { "title": "Policy", "enum": [ "PERMIT", "DENY" ], "type": "string", "description": "The policy to apply to the route distribution.\nPermitted values: -\tPERMIT -\tDENY", "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." } }, "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": { "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)." }, "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." } }, "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." }, "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." }, "description": "Information about the modified WAN related connectivity information, if applicable." } }, "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." }, "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": { "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": { "title": "ChangeType5", "enum": [ "ADD", "REMOVE", "MODIFY" ], "type": "string", "description": "Signals the type of lifecycle 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" } }, "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." }, "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" }, "_links": { "title": "Links3", "required": [ "self", "nsInstance" ], "type": "object", "properties": { "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." }, "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." } }, "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." }, "description": "" } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "in": "query", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "in": "query", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}": { "get": { "operationId": "readanindividualNSLCMoperationoccurrenceresource", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsLcmOpOccId", "in": "path", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ] } }, "/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/retry": { "post": { "operationId": "retryaNSlifecyclemanagementoperationoccurrence", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsLcmOpOccId", "in": "path", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/rollback": { "post": { "operationId": "rollbackaNSlifecyclemanagementoperationoccurrence", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsLcmOpOccId", "in": "path", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/continue": { "post": { "operationId": "continueaNSlifecyclemanagementoperationoccurrence", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsLcmOpOccId", "in": "path", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail": { "post": { "operationId": "markaNSlifecyclemanagementoperationoccurrenceasfailed", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsLcmOpOccId", "in": "path", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel": { "post": { "operationId": "cancelaNSlifecyclemanagementoperationoccurrence", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "nsLcmOpOccId", "in": "path", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/nslcm/v1/vnf_snapshots": { "get": { "operationId": "queryVNFsnapshots", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "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": { "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": { "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": { "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": { "title": "VnfState", "enum": [ "STARTED", "STOPPED" ], "type": "string", "example": "STARTED" }, "scaleStatus": { "type": "array", "items": { "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." } } }, "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": { "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." } } }, "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": { "title": "ExtVirtualLinkInfo", "required": [ "id", "resourceHandle" ], "type": "object", "properties": { "id": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "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." }, "extLinkPorts": { "type": "array", "items": { "title": "ExtLinkPort", "required": [ "id", "resourceHandle" ], "type": "object", "properties": { "id": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "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." }, "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." }, "description": "Link ports of this 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": [ { "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": { "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." }, "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\n shall be present for a to-be-created external CP instance or an\n existing external CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\"." } } }, { "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": { "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." }, "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\n shall be present for a to-be-created external CP instance or an\n existing external CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\"." } } } ] }, "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." } } }, "description": "Information about the external VLs the VNF instance is connected to." }, "extManagedVirtualLinkInfo": { "type": "array", "items": { "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": { "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." }, "vnfLinkPorts": { "type": "array", "items": { "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": { "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." }, "cpInstanceId": { "type": "string", "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique." }, "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" } } }, "description": "Link ports of this VL." }, "extManagedMultisiteVirtualLinkId": { "type": "string", "description": "An identifier with the intention of being globally unique." } } }, "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": { "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." }, "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": { "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": { "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." }, "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": { "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": { "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." }, "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." } } }, "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." }, "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance." }, "virtualLinkResourceInfo": { "type": "array", "items": { "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": { "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." }, "reservationId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "vnfLinkPorts": { "type": "array", "items": { "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": { "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." }, "cpInstanceId": { "type": "string", "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique." }, "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" } } }, "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." }, "description": "Information about the virtualised network resources used by the VLs of the VNF instance." }, "virtualStorageResourceInfo": { "type": "array", "items": { "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": { "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." }, "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." }, "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." }, "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." }, "vnfcSnapshots": { "type": "array", "items": { "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": { "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." }, "storageSnapshotResources": { "type": "array", "items": { "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": { "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." } } }, "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." }, "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." }, "_links": { "title": "Links6", "required": [ "self" ], "type": "object", "properties": { "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." } }, "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\nidentify the VNF snapshots information resources that are accessible via the NFVO. The identifier is still\ngenerated by the VNFM and copied into the present \"VnfSnapshotInfo\" representing the \"Individual VNF snapshot\"\nresource hold by the NFVO." }, "description": "" } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "in": "query", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "in": "query", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "in": "query", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ] } }, "/nslcm/v1/vnf_snapshots/{vnfSnapshotInfoId}": { "get": { "operationId": "queryanIndividualVNFsnapshot", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotInfoId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotInfoId", "type": "string" } } ] }, "delete": { "operationId": "deleteanIndividualVNFsnapshot", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "vnfSnapshotInfoId", "in": "path", "required": true, "schema": { "title": "vnfSnapshotInfoId", "type": "string" } } ] } } }, "components": { "schemas": {} } }