{ "id": "@itentialopensource/adapter-etsi_sol005", "type": "Adapter", "export": "EtsiSol005", "title": "Etsi_sol005", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "getApiVersions", "summary": "Retrieve API version information", "description": "The GET method reads API version information. This method shall follow the provisions specified in table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not supported.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getApiVersions" }, "task": true }, { "name": "postNsDescriptors", "summary": "Create a new NS descriptor resource.", "description": "The POST method is used to create a new NS descriptor resource.", "input": [ { "name": "body", "type": "object", "info": "Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3.: {\"userDefinedData\": \"object\"}", "required": true, "schema": { "type": "object", "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 creates a completely new NS descriptor resource.\n" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postNsDescriptors" }, "task": true }, { "name": "getNsDescriptors", "summary": "Query information about multiple NS descriptor resources.", "description": "The GET method queries information about multiple NS descriptor resources.", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "type": "string", "info": "Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support this parameter.: string", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "type": "string", "info": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "type": "string", "info": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "type": "string", "info": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support t...(description truncated): string", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNsDescriptors" }, "task": true }, { "name": "getNsDescriptorsNsdInfoId", "summary": "Read information about an individual NS descriptor resource.", "description": "The GET method reads information about an individual NS descriptor.", "input": [ { "name": "nsdInfoId", "type": "string", "info": "Identifier of the individual NS descriptor resource.: string", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNsDescriptorsNsdInfoId" }, "task": true }, { "name": "patchNsDescriptorsNsdInfoId", "summary": "Modify the operational state and/or the user defined data of an individual NS descriptor resource.", "description": "The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource.\nThis method can be used to:\n1) Enable a previously disabled individual NS descriptor resource, allowing again its use for instantiation of new\nnetwork service with this descriptor. The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change as a\nresult.\n2) Disable a previously enabled individual NS descriptor resource, preventing any further use for instantiation of\nnew network servi...(description truncated)", "input": [ { "name": "nsdInfoId", "type": "string", "info": "Identifier of the individual NS descriptor resource.: string", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "Parameters for the modification of an individual NS descriptor resource, as defined in clause 5.5.2.1.\nThe Content-Type header shall be set to \"application/merge-patch+js...(description truncated): {\"nsdOperationalState\": \"Must be one of [ENABLED, DISABLED]\", \"userDefinedData\": \"array\"}", "required": true, "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" } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchNsDescriptorsNsdInfoId" }, "task": true }, { "name": "deleteNsDescriptorsNsdInfoId", "summary": "Delete an individual NS descriptor resource.", "description": "The DELETE method deletes an individual NS descriptor resource.\nAn individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState =\nNOT_IN_USE) and has been disabled already (i.e. operationalState = DISABLED). Otherwise, the DELETE method\nshall fail.", "input": [ { "name": "nsdInfoId", "type": "string", "info": "Identifier of the individual NS descriptor resource.: string", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNsDescriptorsNsdInfoId" }, "task": true }, { "name": "getNsDescriptorsNsdInfoIdNsdContent", "summary": "Fetch the content of a NSD.", "description": "The GET method fetches the content of the NSD archive.\nThe NSD archive is implemented as a single zip file.\nThe content of the NSD archive is provided as onboarded,\ni.e. depending on the security option used, the CSAR wrapped\nin a ZIP archive together with an external signature is returned,\nas defined in clause 5.1 of ETSI GS NFV-SOL 007.\n\nNOTE:\tInformation about the applicable security option can be\n obtained by evaluating the \"archiveSecurityOption\"\n attribute in the \"nsdInfo\" st...(description truncated)", "input": [ { "name": "nsdInfoId", "type": "string", "info": "Identifier of the individual NS descriptor resource.: string", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNsDescriptorsNsdInfoIdNsdContent" }, "task": true }, { "name": "putNsDescriptorsNsdInfoIdNsdContent", "summary": "Upload the content of a NSD.", "description": "The PUT method is used to upload the content of an NSD archive.\nThe NSD to be uploaded is implemented as a single ZIP file as defined in clause 5.4.4.3.2.\nThe \"Content-Type\" HTTP header in the PUT request shall be set to \"application/zip\".\nThis method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and\n5.4.4.3.3-2 for URI query parameters, request and response data structures, and response codes.", "input": [ { "name": "nsdInfoId", "type": "string", "info": "Identifier of the individual NS descriptor resource.: string", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putNsDescriptorsNsdInfoIdNsdContent" }, "task": true }, { "name": "getNsDescriptorsNsdInfoIdNsd", "summary": "The GET method reads the content of the NSD within an NSD archive.\nThe NSD can be implemented as a", "description": "The GET method reads the content of the NSD within an NSD archive.\nThe NSD can be implemented as a single file or as a collection of\nmultiple files. If the NSD is implemented in the form of multiple files,\na ZIP file embedding these files shall be returned. If the NSD is implemented\nas a single file, either that file or a ZIP file embedding that file shall be returned.\nThe selection of the format is controlled by the \"Accept\" HTTP header passed in the GET request:\n•\tIf the \"Accept\" header contai...(description truncated)", "input": [ { "name": "nsdInfoId", "type": "string", "info": "Identifier of the individual NS descriptor resource.: string", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNsDescriptorsNsdInfoIdNsd" }, "task": true }, { "name": "getNsDescriptorsNsdInfoIdManifest", "summary": "Fetch the content of the manifest in an NSD archive.", "description": "The GET method reads the content of the manifest file within an NSD archive.\nThis method shall follow the provisions specified in the Tables 5.4.4b.3.2-1\nand 5.4.4b.3.2-2 for URI query parameters, request and response data structures,\nand response codes.", "input": [ { "name": "nsdInfoId", "type": "string", "info": "Identifier of the individual NS descriptor resource.: string", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNsDescriptorsNsdInfoIdManifest" }, "task": true }, { "name": "getNsDescriptorsNsdInfoIdArtifactsArtifactPath", "summary": "The GET method fetches the content of an individual artifact within\na NSD archive.\n\nThis method sha", "description": "The GET method fetches the content of an individual artifact within\na NSD archive.\n\nThis method shall follow the provisions specified in the Tables 5.4.4c.3.2-1\nand 5.4.4c.3.2-2 for URI query parameters, request and response data structures,\nand response codes.", "input": [ { "name": "nsdInfoId", "type": "string", "info": "Identifier of the individual NS descriptor resource.: string", "required": true, "schema": { "title": "nsdInfoId", "type": "string" } }, { "name": "artifactPath", "type": "string", "info": "For an artifact contained as a file in the NSD archive, this variable shall\ncontain a sequence of one or path segments representing the path of the\nartifact within the ...(description truncated): string", "required": true, "schema": { "title": "artifactPath", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNsDescriptorsNsdInfoIdArtifactsArtifactPath" }, "task": true }, { "name": "postPnfDescriptors", "summary": "Create a new PNF descriptor resource.", "description": "The POST method is used to create a new PNF descriptor resource", "input": [ { "name": "body", "type": "object", "info": "Parameters of creating a PNF descriptor resource.: {\"userDefinedData\": \"object\"}", "required": true, "schema": { "type": "object", "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": "User-defined data for the PNF descriptor resource to be created. It shall be present when the user defined data is set for the individual PNF descriptor resource to be created.\n" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPnfDescriptors" }, "task": true }, { "name": "getPnfDescriptors", "summary": "Query information about multiple PNF descriptor resources.", "description": "\"The GET method queries information about multiple PNF descriptor\nresources.\"", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "type": "string", "info": "Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support this parameter.: string", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "type": "string", "info": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "type": "string", "info": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "type": "string", "info": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support t...(description truncated): string", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPnfDescriptors" }, "task": true }, { "name": "getPnfDescriptorsPnfdInfoId", "summary": "Read an individual PNFD resource.", "description": "The GET method reads information about an individual PNF descriptor.", "input": [ { "name": "pnfdInfoId", "type": "string", "info": "Identifier of the individual PNF descriptor resource.: string", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPnfDescriptorsPnfdInfoId" }, "task": true }, { "name": "patchPnfDescriptorsPnfdInfoId", "summary": "Modify the user defined data of an individual PNF descriptor resource.", "description": "The PATCH method modifies the user defined data of an individual PNF descriptor resource.", "input": [ { "name": "pnfdInfoId", "type": "string", "info": "Identifier of the individual PNF descriptor resource.: string", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "Parameters for the modification of an individual\nPNF descriptor resource, as defined in clause 5.5.2.4.\nThe Content-Type header shall be set to \"application/merge-patch+j...(description truncated): {\"userDefinedData\": \"object\"}", "required": true, "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" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchPnfDescriptorsPnfdInfoId" }, "task": true }, { "name": "deletePnfDescriptorsPnfdInfoId", "summary": "Delete an individual PNF descriptor resource.", "description": "The DELETE method deletes an individual PNF descriptor resource.\nAn individual PNF descriptor resource can only be deleted when t\nhere is no NS instance using it or there is NSD referencing it.\nTo delete all PNFD versions identified by a particular value of\nthe \"pnfdInvariantId\" attribute, the procedure is to first use t\nhe GET method with filter \"pnfdInvariantId\" towards the PNF\ndescriptors resource to find all versions of the PNFD. Then,\nhe API consumer uses the DELETE method described in this...(description truncated)", "input": [ { "name": "pnfdInfoId", "type": "string", "info": "Identifier of the individual PNF descriptor resource.: string", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePnfDescriptorsPnfdInfoId" }, "task": true }, { "name": "getPnfDescriptorsPnfdInfoIdPnfdContent", "summary": "Fetch the content of a PNFD.", "description": "The GET method fetches the content of the PNFD archive.\nThe content of the PNFD archive is provided as onboarded,\ni.e. depending on the security option used, the CSAR or\nthe CSAR wrapped in a ZIP archive together with an external\nsignature is returned, as defined in clause 5.1 of ETSI GS NFV-SOL 004.\n\nNOTE:\tInformation about the applicable security option can be obtained\nby evaluating the \"archiveSecurityOption\" attribute in the \"pnfdInfo\" structure.\n\nThis method shall follow the provisions spec...(description truncated)", "input": [ { "name": "pnfdInfoId", "type": "string", "info": "Identifier of the individual PNF descriptor resource.: string", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPnfDescriptorsPnfdInfoIdPnfdContent" }, "task": true }, { "name": "putPnfDescriptorsPnfdInfoIdPnfdContent", "summary": "Upload the content of a PNFD.", "description": "The PUT method is used to upload the content of a PNFD archive.\nThis resource represents the content of the individual PNF descriptor, i.e. PNFD content.\nThe client can use this resource to upload and download the content of the PNFD.", "input": [ { "name": "pnfdInfoId", "type": "string", "info": "Identifier of the individual PNF descriptor resource.: string", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putPnfDescriptorsPnfdInfoIdPnfdContent" }, "task": true }, { "name": "getPnfDescriptorsPnfdInfoIdPnfd", "summary": "The GET method reads the content of the PNFD within a PNFD archive.\nThe PNFD can be implemented as", "description": "The GET method reads the content of the PNFD within a PNFD archive.\nThe PNFD can be implemented as a single file or as a collection of\nmultiple files. If the PNFD is implemented in the form of multiple\nfiles, a ZIP file embedding these files shall be returned. If the\nPNFD is implemented as a single file, either that file or a ZIP file\nembedding that file shall be returned.\nThe selection of the format is controlled by the \"Accept\" HTTP header\npassed in the GET request:\n•\tIf the \"Accept\" header co...(description truncated)", "input": [ { "name": "pnfdInfoId", "type": "string", "info": "Identifier of the individual PNF descriptor resource.: string", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPnfDescriptorsPnfdInfoIdPnfd" }, "task": true }, { "name": "getPnfDescriptorsPnfdInfoIdManifest", "summary": "The GET method reads the content of the manifest file within a PNFD archive.\nThis method shall foll", "description": "The GET method reads the content of the manifest file within a PNFD archive.\nThis method shall follow the provisions specified in the Tables 5.4.7b.3.2-1\nand 5.4.7b.3.2-2 for URI query parameters, request and response data structures,\nand response codes.", "input": [ { "name": "pnfdInfoId", "type": "string", "info": "Identifier of the individual PNF descriptor resource.: string", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPnfDescriptorsPnfdInfoIdManifest" }, "task": true }, { "name": "getPnfDescriptorsPnfdInfoIdArtifactsArtifactPath", "summary": "The GET method fetches the content of an individual artifact within a PNFD archive.\n\nThis method sh", "description": "The GET method fetches the content of an individual artifact within a PNFD archive.\n\nThis method shall follow the provisions specified in the Tables 5.4.7c.3.2-1 and\n5.4.7c.3.2-2 for URI query parameters, request and response data structures, and\nresponse codes.", "input": [ { "name": "pnfdInfoId", "type": "string", "info": "Identifier of the individual PNF descriptor resource.: string", "required": true, "schema": { "title": "pnfdInfoId", "type": "string" } }, { "name": "artifactPath", "type": "string", "info": "For an artifact contained as a file in the PNFD archive, this variable shall contain\na sequence of one or path segments representing the path of the artifact within the ...(description truncated): string", "required": true, "schema": { "title": "artifactPath", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPnfDescriptorsPnfdInfoIdArtifactsArtifactPath" }, "task": true }, { "name": "postSubscriptions", "summary": "Subscribe to NSD and PNFD change notifications.", "description": "The POST method creates a new subscription.\nThis method shall support the URI query parameters, request and\nresponse data structures, and response codes, as specified in\nthe Tables 5.4.8.3.1-1 and 5.4.8.3.1-2.\nCreation of two subscription resources with the same callback URI\nand the same filter can result in performance degradation and will\nprovide duplicates of notifications to the OSS, and might make\nsense only in very rare use cases. Consequently, the NFVO may\neither allow creating a subscrip...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Details of the subscription to be created, as defined in clause 5.5.2.7.: {\"filter\": {\"notificationTypes\": \"array\", \"nsdInfoId\": \"array\", \"nsdId\": \"array\", \"nsdName\": \"array\", \"nsdVersion\": \"array\", \"nsdDesigner\": \"array\", \"nsdInvariantId\": \"array\", \"vnfPkgIds\": \"array\", \"pnfdInfoIds\": \"array\", \"nestedNsdInfoIds\": \"array\", \"nsdOnboardingState\": \"array\", \"nsdOperationalState\": \"array\", \"nsdUsageState\": \"array\", \"pnfdId\": \"array\", \"pnfdName\": \"array\", \"pnfdVersion\": \"array\", \"pnfdProvider\": \"array\", \"pnfdInvariantId\": \"array\", \"pnfdOnboardingState\": \"array\", \"pnfdUsageState\": \"array\"}, \"callbackUri\": \"string\", \"authentication\": {\"authType\": \"array\", \"paramsBasic\": {\"userName\": \"string\", \"password\": \"string\"}, \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}}", "required": true, "schema": { "type": "object", "required": [ "callbackUri" ], "properties": { "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": { "type": "string", "description": "The URI of the endpoint to send the notification to.\n" }, "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" } } } } } }, "description": "This type represents a subscription request related to notifications about NSD management.\n" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSubscriptions" }, "task": true }, { "name": "getSubscriptions", "summary": "Query multiple subscriptions.", "description": "TThe GET method queries the list of active subscriptions of the\nfunctional block that invokes the method. It can be used e.g.\nfor resynchronization after error situations.\nThis method shall support the URI query parameters, request and\nresponse data structures, and response codes, as specified in\nthe Tables 5.4.8.3.2-1 and 5.4.8.3.2-2.", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSubscriptions" }, "task": true }, { "name": "getSubscriptionsSubscriptionId", "summary": "Read an individual subscription resource.", "description": "This resource represents an individual subscription.\nIt can be used by the client to read and to terminate a subscription to\nnotifications related to NSD management.\n\nThe GET method retrieves information about a subscription by reading\nan individual subscription resource.\nThis resource represents an individual subscription.\nIt can be used by the client to read and to terminate a subscription to\nnotifications related to NSD management.", "input": [ { "name": "subscriptionId", "type": "string", "info": "Identifier of this subscription.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in\nthe response to a POST request creating ...(description truncated): string", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSubscriptionsSubscriptionId" }, "task": true }, { "name": "deleteSubscriptionsSubscriptionId", "summary": "Terminate Subscription", "description": "This resource represents an individual subscription.\nIt can be used by the client to read and to terminate a subscription to\nnotifications related to NSD management.\n\nThe DELETE method terminates an individual subscription.\nThis method shall support the URI query parameters, request and\nresponse data structures, and response codes, as\nspecified in the Table 5.4.9.3.3-2.", "input": [ { "name": "subscriptionId", "type": "string", "info": "Identifier of this subscription.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in\nthe response to a POST request creating ...(description truncated): string", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSubscriptionsSubscriptionId" }, "task": true }, { "name": "getAlarms", "summary": "Query alarms related to NS instances.", "description": "Get Alarm List.\nThe API consumer can use this method to retrieve information about the alarm list. This method shall follow the\nprovisions specified in the Tables 8.4.2.3.2-1 and 8.4.2.3.2-2 for URI query parameters, request and response\ndata structures, and response codes.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAlarms" }, "task": true }, { "name": "getAlarmsAlarmId", "summary": "Read individual alarm.", "description": "The API consumer can use this method to read an individual alarm. This method shall follow the provisions\nspecified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters, request and response data\nstructures, and response codes.\n", "input": [ { "name": "alarmId", "type": "string", "info": "Identifier of the alarm. This identifier can be retrieved from the \"id\" attribute of the \"alarm\" attribute\nin the AlarmNotification or AlarmClearedNotification. It can a...(description truncated): string", "required": true, "schema": { "title": "alarmId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAlarmsAlarmId" }, "task": true }, { "name": "patchAlarmsAlarmId", "summary": "Acknowledge individual alarm.", "description": "Acknowledge Alarm\nThis method modifies an individual alarm resource. This method shall follow the provisions specified in the\nTables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters, request and response data structures, and response\ncodes.\n", "input": [ { "name": "alarmId", "type": "string", "info": "Identifier of the alarm. This identifier can be retrieved from the \"id\" attribute of the \"alarm\" attribute\nin the AlarmNotification or AlarmClearedNotification. It can a...(description truncated): string", "required": true, "schema": { "title": "alarmId", "type": "string" } }, { "name": "body", "type": "object", "info": "The parameter for the alarm modification, as defined in clause 8.5.2.8.\n: {\"ackState\": \"Must be one of [ACKNOWLEDGED, UNACKNOWLEDGED]\"}", "required": true, "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" ] } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" ] } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchAlarmsAlarmId" }, "task": true }, { "name": "getVnfPackages", "summary": "Query VNF packages information.", "description": "The GET method queries the information of the VNF packages matching the filter. This method shall follow the\nprovisions specified in the Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters, request and response\ndata structures, and response codes.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "type": "string", "info": "Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support this parameter.\n: string", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "type": "string", "info": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.\n: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "type": "string", "info": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.\n: string", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "type": "string", "info": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support t...(description truncated): string", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfPackages" }, "task": true }, { "name": "postVnfPackages", "summary": "Create a new individual VNF package resource.", "description": "The POST method creates a new individual VNF package resource.\nUpon successful creation of the \"Individual VNF package\" resource, the NFVO shall set the \"onboardingState\"\nattribute in the \"VnPkgInfo\" structure to \"CREATED\", the \"operationalState\" attribute to \"DISABLED\", and the\n\"usageState\" attribute to \"NOT_IN_USE\".\n", "input": [ { "name": "body", "type": "object", "info": "IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2\n: {\"userDefinedData\": \"object\"}", "required": true, "schema": { "type": "object", "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": "IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2.\n" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVnfPackages" }, "task": true }, { "name": "getVnfPackagesVnfPkgId", "summary": "Read information about an individual VNF package.", "description": "The GET method reads the information of a VNF package.\n", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfPackagesVnfPkgId" }, "task": true }, { "name": "deleteVnfPackagesVnfPkgId", "summary": "Delete an individual VNF package.", "description": "The DELETE method deletes an individual VNF Package resource.\n", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVnfPackagesVnfPkgId" }, "task": true }, { "name": "patchVnfPackagesVnfPkgId", "summary": "Update information about an individual VNF package.", "description": "The PATCH method updates the information of a VNF package.\nThis method shall follow the provisions specified in the Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query\nparameters, request and response data structures, and response codes.\n", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "body", "type": "object", "info": "Parameters for VNF package information modifications.\n: {\"operationalState\": \"Must be one of [ENABLED, DISABLED]\", \"userDefinedData\": \"object\"}", "required": true, "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" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVnfPackagesVnfPkgId" }, "task": true }, { "name": "getVnfPackagesVnfPkgIdVnfd", "summary": "Read VNFD of an on-boarded VNF package.", "description": "The GET method reads the content of the VNFD within a VNF package.\nThe default format of the ZIP archive shall be the one specified in ETSI GS NFV-SOL 004 where only the files\nrepresenting the VNFD and information necessary to navigate the ZIP file and to identify the file that is the\nentry point for parsing the VNFD and (if requested) further security information are included. This means that\nthe structure of the ZIP archive shall correspond to the directory structure used in the VNF package an...(description truncated)", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfPackagesVnfPkgIdVnfd" }, "task": true }, { "name": "getVnfPackagesVnfPkgIdExtArtifactsAccess", "summary": "Get the content of external VNF package artifacts.", "description": "The GET method reads the access configuration information that is used by the NFVO to get the content of external\nVNF package artifacts. This method shall follow the provisions specified in the Tables 9.4.4a.3.2-1 and 9.4.4a.3.2-2\nfor URI query parameters, request and response data structures, and response codes.\n", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfPackagesVnfPkgIdExtArtifactsAccess" }, "task": true }, { "name": "putVnfPackagesVnfPkgIdExtArtifactsAccess", "summary": "Download the content of external VNF package artifacts.", "description": "The PUT method provides the access configuration information for the NFVO to download the content of external\nVNF package artifacts. As precondition for invoking this method, the individual VNF package resource shall have\nbeen created, and the value of \"onboardingState\" attribute shall equal to \"CREATED\" or \"ERROR\". The resource\nrepresentation in the payload body of the PUT request shall replace the current state of the resource. This method\nshall follow the provisions specified in the Tables 9....(description truncated)", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "body", "type": "object", "info": "The payload body contains the access configuration information based on which the NFVO can obtain the\nexternal VNF package artifact files.\n: {\"artifact\": {\"artifactUri\": \"string\", \"overrideUri\": \"string\", \"authType\": \"Must be one of [BASIC, OAUTH2_CLIENT_CREDENTIALS]\", \"username\": \"string\", \"password\": \"string\", \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}}", "required": true, "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" } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVnfPackagesVnfPkgIdExtArtifactsAccess" }, "task": true }, { "name": "getVnfPackagesVnfPkgIdManifest", "summary": "The GET method reads the content of the manifest within a VNF package.\n", "description": "The GET method reads the content of the manifest within a VNF package.\n", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfPackagesVnfPkgIdManifest" }, "task": true }, { "name": "getVnfPackagesVnfPkgIdPackageContent", "summary": "Fetch an on-boarded VNF package.", "description": "The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the\nNFVO. The content of the package is provided as onboarded, i.e. depending on the security option used, the CSAR\nor the CSAR wrapped in a ZIP archive together with an external signature is returned, as defined in clause 5.1\nof ETSI GS NFV-SOL 004 [5]. NOTE: Information about the applicable security option can be obtained by evaluating\nthe \"packageSecurityOption\" attribute in the \"VnfPkgIn...(description truncated)", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfPackagesVnfPkgIdPackageContent" }, "task": true }, { "name": "putVnfPackagesVnfPkgIdPackageContent", "summary": "Upload a VNF package by providing the content of the VNF package.", "description": "The PUT method uploads the content of a VNF package. This method shall follow the provisions specified in the\nTables 9.4.5.3.3-1 and 9.4.5.3.3-2 for URI query parameters, request and response data structures, and response\ncodes. Upon start of the upload of the package, the NFVO shall set the \"onboardingState\" attribute in the \"VnfPkgInfo\"\nstructure to \"UPLOADING\". Upon successful upload of the package, if the package references external artifacts, the\nNFVO shall obtain the external artifacts. Su...(description truncated)", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"file\": \"string\"}", "required": true, "schema": { "properties": { "file": { "type": "string", "description": "The payload body contains a ZIP file that represents the VNF package. The \"Content-Type\" HTTP header shall\nbe set according to the type of the file, i.e. to \"application/zip\" for a VNF Package as defined in ETSI GS NFV-SOL 004.\n" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVnfPackagesVnfPkgIdPackageContent" }, "task": true }, { "name": "getVnfPackagesVnfPkgIdArtifacts", "summary": "Fetch set of VNF package artifacts.", "description": "The GET method shall return an archive that contains a set of artifacts according to the provisions for\ninclusion/exclusion defined below, embedded in a directory structure being the same as in the VNF package.\nThe criteria for exclusion/inclusion of an artifact in the archive are defined as follows:\n* Artifacts that are software images shall be excluded from the archive.\n* Artifacts that are external to the VNF package shall be excluded from the archive.\n* All additional artifacts included in t...(description truncated)", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } }, { "name": "excludeAllManoArtifacts", "type": "string", "info": "Flag (i.e. parameter without value) that instructs the NFVO to exclude the set of additional MANO artifacts\n(i.e. those that are not images) from the response payload bod...(description truncated): string", "required": false, "schema": { "title": "excludeAllManoArtifacts", "type": "string" } }, { "name": "excludeAllNonManoArtifacts", "type": "string", "info": "Flag (i.e. parameter without value) that instructs the NFVO to exclude the set of non-MANO artifacts from the\nresponse payload body. The NFVO shall support this parameter...(description truncated): string", "required": false, "schema": { "title": "excludeAllNonManoArtifacts", "type": "string" } }, { "name": "selectNonManoArtifactSets", "type": "string", "info": "Comma-separated list of non-MANO artifact set identifiers for which the artifacts are to be included in the\nresponse body. The NFVO should support this parameter. If the ...(description truncated): string", "required": false, "schema": { "title": "selectNonManoArtifactSets", "type": "string" } }, { "name": "includeExternalArtifacts", "type": "string", "info": "Flag (i.e. parameter without value) that instructs the NFVO to include external artifacts in the response\npayload body. It shall not be treated as an error if this flag i...(description truncated): string", "required": false, "schema": { "title": "includeExternalArtifacts", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfPackagesVnfPkgIdArtifacts" }, "task": true }, { "name": "postVnfPackagesVnfPkgIdPackageContentUploadFromUri", "summary": "Upload a VNF package by providing the address information of the VNF package.", "description": "The POST method provides the information for the NFVO to get the content of a VNF package. This method shall\nfollow the provisions specified in the Tables 9.4.6.3.1-1 and 9.4.6.3.1-2 for URI query parameters, request\nand response data structures, and response codes. Upon start of obtaining the package, the NFVO shall set the\n\"onboardingState\" attribute in the \"VnfPkgInfo\" structure to \"UPLOADING\". Upon successfully obtaining the\npackage, if the package references external artifacts, the NFVO sha...(description truncated)", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "body", "type": "object", "info": "The payload body contains the address information based on which the NFVO can obtain the content of the VNF package.\n: {\"addressInformation\": \"string\", \"authType\": \"Must be one of [BASIC, OAUTH2_CLIENT_CREDENTIALS]\", \"username\": \"string\", \"password\": \"string\", \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}", "required": true, "schema": { "description": "This type represents the request parameters for uploading the content of a VNF package. The NFVO can obtain the VNF package content through the information provided in the request parameters. It shall comply with the provisions defined in Table 9.5.2.4-1.\n", "type": "object", "required": [ "addressInformation" ], "properties": { "addressInformation": { "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 OAuth 2.0.\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" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVnfPackagesVnfPkgIdPackageContentUploadFromUri" }, "task": true }, { "name": "getVnfPackagesVnfPkgIdArtifactsArtifactPath", "summary": "Fetch individual VNF package artifact.", "description": "The GET method fetches the content of an artifact within a VNF package. This method shall follow the provisions\nspecified in the Tables 9.4.7.3.2-1 and 9.4.7.3.2-2 for URI query parameters, request and response data structures,\nand response codes.\n", "input": [ { "name": "vnfPkgId", "type": "string", "info": "Identifier of the VNF package. The identifier is allocated by the NFVO.\n: string", "required": true, "schema": { "title": "vnfPkgId", "type": "string" } }, { "name": "artifactPath", "type": "string", "info": "For an artifact contained as a file in the VNF package, this variable shall contain a sequence of one or more path\nsegments representing the path of the artifact within t...(description truncated): string", "required": true, "schema": { "title": "artifactPath", "type": "string" } }, { "name": "includeSignatures", "type": "string", "info": "If this parameter is provided, the NFVO shall include in the ZIP archive the security information as specified above. This URI query parameter is a flag, i.e. it shall ha...(description truncated): string", "required": false, "schema": { "title": "includeSignatures", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfPackagesVnfPkgIdArtifactsArtifactPath" }, "task": true }, { "name": "postPmJobs", "summary": "Create a PM job.", "description": "The POST method creates a PM job.\nThis method shall follow the provisions specified in the \nTables 7.4.2.3.1-1 and 7.4.2.3.1-2 for URI query parameters,\nrequest and response data structures, and response codes.\nAs the result of successfully executing this method, a new \n\"Individual PM job\" resource exist as defined in\nclause 7.4.3 shall have been created.\n", "input": [ { "name": "body", "type": "object", "info": "The VNF creation parameters.\n: {\"objectType\": \"string\", \"objectInstanceIds\": \"array\", \"subObjectInstanceIds\": \"array\", \"criteria\": {\"performanceMetric\": \"array\", \"performanceMetricGroup\": \"array\", \"collectionPeriod\": 123, \"reportingPeriod\": 123, \"reportingBoundary\": \"undefined\"}, \"callbackUri\": \"string\", \"authentication\": {\"authType\": \"array\", \"paramsBasic\": {\"userName\": \"string\", \"password\": \"string\"}, \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}}", "required": true, "schema": { "description": "This type represents a request to create a PM job. It shall comply with the provisions defined in Table 7.5.2.6-1.\n", "type": "object", "required": [ "objectType", "objectInstanceIds", "criteria", "callbackUri" ], "properties": { "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 requested to be 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" }, "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" } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPmJobs" }, "task": true }, { "name": "getPmJobs", "summary": "Query PM jobs.", "description": "The API consumer can use this method to retrieve information about PM jobs.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "type": "string", "info": "Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support this parameter.\n: string", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "type": "string", "info": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.\n: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "type": "string", "info": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.\n: string", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "type": "string", "info": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support t...(description truncated): string", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPmJobs" }, "task": true }, { "name": "getPmJobsPmJobId", "summary": "Read a single PM job.", "description": "The API consumer can use this method for reading an individual PM job.\n", "input": [ { "name": "pmJobId", "type": "string", "info": "Identifier of the PM job.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response\nto a POST request creating a new PM ...(description truncated): string", "required": true, "schema": { "title": "pmJobId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPmJobsPmJobId" }, "task": true }, { "name": "patchPmJobsPmJobId", "summary": "Modify a PM job.", "description": "This method allows to modify an \"individual PM job\" resource.\nThis method shall follow the provisions specified in the\nTables 7.4.3.3.4-1 and 7.4.3.3.4-2 for URI query parameters,\nrequest and response data structures, and response codes.\n", "input": [ { "name": "pmJobId", "type": "string", "info": "Identifier of the PM job.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response\nto a POST request creating a new PM ...(description truncated): string", "required": true, "schema": { "title": "pmJobId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"callbackUri\": \"string\", \"authentication\": {\"authType\": \"array\", \"paramsBasic\": {\"userName\": \"string\", \"password\": \"string\"}, \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}}", "required": true, "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" } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchPmJobsPmJobId" }, "task": true }, { "name": "deletePmJobsPmJobId", "summary": "Delete a PM job.", "description": "This method terminates an individual PM job.\nThis method shall follow the provisions specified in the Tables 7.4.3.3.5-1 \nand 7.4.3.3.5-2 for URI query parameters, request and response data structures, \nand response codes. \nAs the result of successfully executing this method, the \"Individual PM job\" \nresource shall not exist any longer.\n", "input": [ { "name": "pmJobId", "type": "string", "info": "Identifier of the PM job.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response\nto a POST request creating a new PM ...(description truncated): string", "required": true, "schema": { "title": "pmJobId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePmJobsPmJobId" }, "task": true }, { "name": "getPmJobsPmJobIdReportsReportId", "summary": "Read an individual performance report.", "description": "The API consumer can use this method for reading an individual performance\nreport.\n", "input": [ { "name": "pmJobId", "type": "string", "info": "Identifier of the PM job.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response\nto a POST request creating a new PM ...(description truncated): string", "required": true, "schema": { "title": "pmJobId", "type": "string" } }, { "name": "reportId", "type": "string", "info": "Identifier of the performance report.\n: string", "required": true, "schema": { "title": "reportId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPmJobsPmJobIdReportsReportId" }, "task": true }, { "name": "postThresholds", "summary": "Create a threshold.", "description": "The POST method can be used by the API consumer to create\na threshold.\n\nThis method shall follow the provisions specified in the \ntable 7.4.5.3.1-2 for URI query parameters,\nrequest and response data structures, and response codes. \n\nAs the result of successfully executing this method, a new \n\"Individual threshold\" resource as defined\nin clause 7.4.6 shall have been created.\n", "input": [ { "name": "body", "type": "object", "info": "Request parameters to create a new \"Individual threshold\" resource.\n: {\"objectType\": \"string\", \"objectInstanceId\": \"string\", \"subObjectInstanceIds\": \"array\", \"criteria\": {\"performanceMetric\": \"string\", \"thresholdType\": \"Must be one of [SIMPLE]\", \"simpleThresholdDetails\": {\"thresholdValue\": 123, \"hysteresis\": 123}}, \"authentication\": {\"authType\": \"array\", \"paramsBasic\": {\"userName\": \"string\", \"password\": \"string\"}, \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}}", "required": true, "schema": { "description": "This type represents a request to create a threshold.\n", "type": "object", "required": [ "objectType", "objectInstanceId", "criteria" ], "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" }, "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 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" } } } } }, "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" } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postThresholds" }, "task": true }, { "name": "getThresholds", "summary": "Query thresholds.", "description": "The API consumer can use this method to query information about thresholds.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getThresholds" }, "task": true }, { "name": "getThresholdsThresholdId", "summary": "Query a single threshold.", "description": "The API consumer can use this method for reading an individual\nthreshold.\nThis method shall follow the provisions specified in the \nTables 7.4.6.3.2-1 and 7.4.6.3.2-2 for URI query parameters,\nrequest and response data structures, and response codes.\n", "input": [ { "name": "thresholdId", "type": "string", "info": "Identifier of the threshold.\nThis identifier can be retrieved from the resource referenced by the\n\"Location\" HTTP header in the response to a POST request creating a\nnew ...(description truncated): string", "required": true, "schema": { "title": "thresholdId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getThresholdsThresholdId" }, "task": true }, { "name": "patchThresholdsThresholdId", "summary": "Modify a Threshold", "description": "This method allows to modify an \"Individual threshold\" resource.\nThis method shall follow the provisions specified in the Tables\n7.4.6.3.4-1 and 7.4.6.3.4-2 for URI query parameters, request\nand response data structures, and response codes.\n", "input": [ { "name": "thresholdId", "type": "string", "info": "Identifier of the threshold.\nThis identifier can be retrieved from the resource referenced by the\n\"Location\" HTTP header in the response to a POST request creating a\nnew ...(description truncated): string", "required": true, "schema": { "title": "thresholdId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"callbackUri\": \"string\", \"authentication\": {\"authType\": \"array\", \"paramsBasic\": {\"userName\": \"string\", \"password\": \"string\"}, \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}}", "required": true, "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" } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchThresholdsThresholdId" }, "task": true }, { "name": "deleteThresholdsThresholdId", "summary": "Delete a Threshold.", "description": "This method allows to delete a threshold.\n\nAs the result of successfully executing this method, the \n\"Individual threshold\" resource shall not exist any longer.\n", "input": [ { "name": "thresholdId", "type": "string", "info": "Identifier of the threshold.\nThis identifier can be retrieved from the resource referenced by the\n\"Location\" HTTP header in the response to a POST request creating a\nnew ...(description truncated): string", "required": true, "schema": { "title": "thresholdId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThresholdsThresholdId" }, "task": true }, { "name": "getNfviCapacityInfos", "summary": "Query NFVI capacity information", "description": "The API consumer can use this method to retrieve information about NFVI capacity information.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "type": "string", "info": "Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support this parameter.\n: string", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "type": "string", "info": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.\n: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "type": "string", "info": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.\n: string", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "type": "string", "info": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support t...(description truncated): string", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNfviCapacityInfos" }, "task": true }, { "name": "getNfviCapacityInfosVimId", "summary": "Query NFVI capacity information for a specific VIM", "description": "The API consumer can use this method for reading an individual VIM’s NFVI capacity information.\n", "input": [ { "name": "vimId", "type": "string", "info": "Identifier of the VIM with associated NFVI capacity information.\nThis identifier can be retrieved from the \"vimId\" attribute in the CapacityShortageNotification.\nIt can a...(description truncated): string", "required": true, "schema": { "title": "vimId", "type": "string" } }, { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNfviCapacityInfosVimId" }, "task": true }, { "name": "getCapacityThresholds", "summary": "Query NFVI capacity thresholds", "description": "This resource represents NFVI capacity thresholds.\nThe API consumer can use this resource to create and query NFVI capacity thresholds.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCapacityThresholds" }, "task": true }, { "name": "postCapacityThresholds", "summary": "Create a NFVI capacity threshold", "description": "The POST method creates a new NFVI capacity threshold.\nAs a result of successfully executing this method, a new \"Individual capacity threshold\" resource as defined\nin clause 10.4.5 shall have been created.\n", "input": [ { "name": "body", "type": "object", "info": "Request parameters to create a new \"Individual capacity threshold\" resource.\n: {\"objectInstanceId\": \"string\", \"subObjectInstanceIds\": \"array\", \"criteria\": {\"capacityMetric\": {\"resourceType\": \"Must be one of [VR_COMPUTE, VR_NETWORK, VR_STORAGE, HOST_COMPUTE]\", \"capacityMeasurementName\": \"string\", \"capacityType\": \"Must be one of [TOTAL, ALLOCATED, RESERVED, AVAILABLE]\"}, \"thresholdType\": \"Must be one of [SIMPLE]\", \"simpleThresholdDetails\": [{\"thresholdValue\": 123, \"hysteresis\": 123}]}, \"callbackUri\": \"string\", \"authentication\": {\"authType\": \"array\", \"paramsBasic\": {\"userName\": \"string\", \"password\": \"string\"}, \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}}", "required": true, "schema": { "type": "object", "description": "This type represents a request to create a capacity threshold. It shall comply with the provisions defined in\ntable 10.5.2.3-1.\n", "required": [ "objectInstanceId", "criteria" ], "properties": { "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 will be 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" }, "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" } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCapacityThresholds" }, "task": true }, { "name": "getCapacityThresholdsCapacityThresholdId", "summary": "Query Individual NFVI capacity threshold", "description": "The API consumer can use this method for reading information about an NFVI capacity threshold.\nThis method shall follow the provisions specified in the tables 10.4.5.3.2-1 and 10.4.5.3.2-2 for URI query\nparameters, request and response data structures, and response codes.\n", "input": [ { "name": "capacityThresholdId", "type": "string", "info": "Identifier of the capacity threshold.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to\na POST request creati...(description truncated): string", "required": true, "schema": { "title": "capacityThresholdId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCapacityThresholdsCapacityThresholdId" }, "task": true }, { "name": "patchCapacityThresholdsCapacityThresholdId", "summary": "Modify an \"Individual capacity threshold\" resource", "description": "This method iallows to modify an \"Individual capacity threshold\" resource.\nThis method shall follow the provisions specified in the Tables 10.4.5.3.4-1 and 10.4.5.3.4-2 for URI query\nparameters, request and response data structures, and response codes.\n", "input": [ { "name": "capacityThresholdId", "type": "string", "info": "Identifier of the capacity threshold.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to\na POST request creati...(description truncated): string", "required": true, "schema": { "title": "capacityThresholdId", "type": "string" } }, { "name": "body", "type": "object", "info": "Parameters for the capacity threshold modification.\nThe Content-Type header shall be set to \"application/merge-patch+json\" according to IETF RFC 7396.\n: {\"callbackUri\": \"string\", \"authentication\": {\"authType\": \"array\", \"paramsBasic\": {\"userName\": \"string\", \"password\": \"string\"}, \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}}", "required": true, "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" } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCapacityThresholdsCapacityThresholdId" }, "task": true }, { "name": "deleteCapacityThresholdsCapacityThresholdId", "summary": "Delete an NFVI capacity threshold", "description": "This method allows to delete an NFVI capacity threshold.\nAs a result of successfully executing this method, the \"Individual capacity threshold\" resource shall not exist\nany longer.\n", "input": [ { "name": "capacityThresholdId", "type": "string", "info": "Identifier of the capacity threshold.\nThis identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to\na POST request creati...(description truncated): string", "required": true, "schema": { "title": "capacityThresholdId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteCapacityThresholdsCapacityThresholdId" }, "task": true }, { "name": "postVnfSnapshotPackages", "summary": "The POST method creates a new \"Individual VNF snapshot package\" resource.\n", "description": "The POST method creates a new \"Individual VNF snapshot package\" resource.\n", "input": [ { "name": "body", "type": "object", "info": "\"VNF snapshot package\" resource creation parameters, as defined in clause 11.5.2.2.\n: {\"name\": \"string\", \"userDefinedData\": \"object\"}", "required": true, "schema": { "description": "This type represents the request parameters for creating a new \"Individual VNF snapshot package\" resource. It shall comply with the provisions defined in table 11.5.2.2-1.\n", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "Human-readable name of the VNF snapshot package.\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" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVnfSnapshotPackages" }, "task": true }, { "name": "getVnfSnapshotPackages", "summary": "The GET method queries the information of the VNF packages matching the filter.\n", "description": "The GET method queries the information of the VNF packages matching the filter.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "type": "string", "info": "Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support this parameter.\n: string", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "type": "string", "info": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.\n: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "type": "string", "info": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.\n: string", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "type": "string", "info": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support t...(description truncated): string", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfSnapshotPackages" }, "task": true }, { "name": "getVnfSnapshotPackagesVnfSnapshotPkgId", "summary": "The GET method reads the information of an individual VNF snapshot package.\n", "description": "The GET method reads the information of an individual VNF snapshot package.\n", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfSnapshotPackagesVnfSnapshotPkgId" }, "task": true }, { "name": "patchVnfSnapshotPackagesVnfSnapshotPkgId", "summary": "The PATCH method updates the information of a VNF snapshot package.\n", "description": "The PATCH method updates the information of a VNF snapshot package.\n", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } }, { "name": "body", "type": "object", "info": "\"VNF snapshot package\" resource modification parameters, as defined in clause 11.5.2.4.\n: {\"name\": \"string\", \"userDefinedData\": \"object\", \"state\": \"Must be one of [AVAILABLE]\"}", "required": true, "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" ] } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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" ] } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVnfSnapshotPackagesVnfSnapshotPkgId" }, "task": true }, { "name": "deleteVnfSnapshotPackagesVnfSnapshotPkgId", "summary": "The DELETE method deletes an \"Individual VNF snapshot package\" resource.\n", "description": "The DELETE method deletes an \"Individual VNF snapshot package\" resource.\n", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVnfSnapshotPackagesVnfSnapshotPkgId" }, "task": true }, { "name": "getVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent", "summary": "The GET method fetches the content of a VNF snapshot package.\n\nThe content of the package is provid", "description": "The GET method fetches the content of a VNF snapshot package.\n\nThe content of the package is provided as onboarded to the NFVO, \nor as built by the NFVO.\n", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent" }, "task": true }, { "name": "putVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent", "summary": "The PUT method uploads the content of a VNF package.\n\nThe payload body contains a ZIP file that rep", "description": "The PUT method uploads the content of a VNF package.\n\nThe payload body contains a ZIP file that represents the VNF snapshot package.\n\nThe \"Content-Type\" HTTP header shall be set according to the type of the file, i.e. \nto \"application/zip\" for a VNF snapshot package. The VNF snapshot package format \nis defined in ETSI GS NFV-SOL 010.\n", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVnfSnapshotPackagesVnfSnapshotPkgIdPackageContent" }, "task": true }, { "name": "postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentUploadFromUri", "summary": "The POST method provides the information for the NFVO to get the content of \na VNF snapshot package", "description": "The POST method provides the information for the NFVO to get the content of \na VNF snapshot package.\n", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } }, { "name": "body", "type": "object", "info": "Request parameters for uploading the content of a VNF snapshot package, as defined in clause 11.5.2.5.\n: {\"addressInformation\": \"string\", \"authType\": \"Must be one of [BASIC, OAUTH2_CLIENT_CREDENTIALS]\", \"username\": \"string\", \"password\": \"string\", \"paramsOauth2ClientCredentials\": {\"clientId\": \"string\", \"clientPassword\": \"string\", \"tokenEndpoint\": \"string\"}}", "required": true, "schema": { "description": "This type represents the request parameters for uploading the content of a VNF snapshot package. The NFVO can obtain the VNF snapshot package content through the information provided in the request parameters. It shall comply with the provisions defined in table 11.5.2.5-1.\n", "type": "object", "required": [ "addressInformation" ], "properties": { "addressInformation": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" }, "authType": { "description": "Defines the type of authentication / authorization for downloading the VNF snapshot package.\nPermitted values: - BASIC: Only the \"username\" and \"password\" attributes shall be present. - OAUTH2_CLIENT_CREDENTIALS: Only the \"paramsOauth2ClientCredentials\" attribute shall be present.\nThis attribute shall not be present if the credentials were provisioned out of band.\n", "type": "string", "enum": [ "BASIC", "OAUTH2_CLIENT_CREDENTIALS" ] }, "username": { "description": "Username to be used for authentication. Shall be present if user name is needed and has not been provisioned out of band.\n", "type": "string" }, "password": { "description": "Password to be used for authentication. Shall be present if password is needed and has not been provisioned out of band.\n", "type": "string" }, "paramsOauth2ClientCredentials": { "description": "Parameters for authentication/authorization using OAuth 2.0.\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.\n", "type": "string" }, "tokenEndpoint": { "description": "The token endpoint from which the access token can be obtained.\n", "type": "string" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentUploadFromUri" }, "task": true }, { "name": "postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentBuild", "summary": "The POST method provides the information for the NFVO to start building \nthe content of a VNF snaps", "description": "The POST method provides the information for the NFVO to start building \nthe content of a VNF snapshot package.\n\nIf the request to build the content of a VNF snapshot package is accepted, the NFVO \nshall allocate a globally unique identifier to the VNF snapshot package (i.e., \n\"vnfSnapshotPkgUniqueId\"). To proceed with the packaging process, the NFVO shall \ncollect the constituent information and artifacts as indicated by the input information \nin the request:\n- \"vnfSnapshotInfoId\": references t...(description truncated)", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } }, { "name": "body", "type": "object", "info": "Request parameters for building the content of a VNF snapshot package, as defined in clause 11.5.2.6.\n: {\"vnfSnapshotInfoId\": \"string\", \"vnfcSnapshotsInfoIds\": \"array\", \"overrideImportForVnfcSnapshotIds\": \"array\", \"importSnapshotResource\": \"boolean\"}", "required": true, "schema": { "description": "This type represents the request parameters for building the content of a VNF snapshot package. The NFVO can obtain the VNF snapshot data through the information provided in the request parameters. It shall comply with the provisions defined in table 11.5.2.6-1.\n", "type": "object", "required": [ "vnfSnapshotInfoId" ], "properties": { "vnfSnapshotInfoId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfcSnapshotsInfoIds": { "description": "List of identifiers of information held by the NFVO about VNFC snapshots to be packaged into the VNF snapshot package. Shall be present when it is requested to build a \"partial” VNF snapshot package by packaging specific VNFC snapshots of the VNF snapshot. If not present, a \"full\" VNF snapshot package is requested to be built including all the constituents of the VNF snapshot.\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" } }, "overrideImportForVnfcSnapshotIds": { "description": "If present, it indicates the list of VNFC snapshots to which the VNF snapshot-level \nimport snapshot resource policy indicated by the \"importSnapshotResource\" attribute \ndoes not apply and the opposite value shall be considered. \n\nThe \"overrideImportForVnfcSnapshotIds\" provides the list of VNFC snapshots for which the \nVNF snapshot-level snapshot resource import policy is overridden. See also examples in the \npresent clause.\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" } }, "importSnapshotResource": { "description": "The Boolean is a data type having two values (TRUE and FALSE).\n", "type": "boolean" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentBuild" }, "task": true }, { "name": "postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentExtract", "summary": "The POST method provides the information for the NFVO to start extracting the content of \na VNF sna", "description": "The POST method provides the information for the NFVO to start extracting the content of \na VNF snapshot package.\n\nTo proceed with the extraction process, the NFVO shall have been provided either with:\n- a valid \"Individual VNF snapshot\" identifier, indicated by the input parameter \"vnfSnapshotInfoId\". \nThis identifier corresponds to a known \"Individual VNF snapshot\" resource of the VNF LCM interface \nthat the NFVO can obtain from the VNFM., or\n- a valid \"Individual VNF instance\" identifier, ind...(description truncated)", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } }, { "name": "body", "type": "object", "info": "Request parameters for extracting the content of a VNF snapshot package, as defined in clause 11.5.2.7.\n: {\"vnfSnapshotInfoId\": \"string\", \"vnfInstanceId\": \"string\"}", "required": true, "schema": { "description": "This type represents the request parameters for extracting the content of a VNF snapshot package. It shall comply with the provisions defined in table 11.5.2.7-1.\n", "type": "object", "properties": { "vnfSnapshotInfoId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "vnfInstanceId": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentExtract" }, "task": true }, { "name": "postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentCancel", "summary": "The POST method provides the information for the NFVO to cancel the ongoing operation related to \nt", "description": "The POST method provides the information for the NFVO to cancel the ongoing operation related to \nthe content of a VNF snapshot package.\n\nIn case of success of processing the asynchronous request:\n1) If the request has been processed in \"UPLOADING\", \"BUILDING\" or \"PROCESSING\" state, the \"state\"\nattribute in the representation of the \"Individual VNF snapshot package\" resource shall be changed \nto\"ERROR\".\n2) If the request has been processed in \"EXTRACTING\" state, the \"state\" attribute in the repr...(description truncated)", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } }, { "name": "body", "type": "object", "info": "Request parameters for cancelling an ongoing operation related to the content of a VNF snapshot package, \nas defined in clause 11.5.2.8.\n: {\"cause\": \"string\"}", "required": true, "schema": { "description": "This type represents the request parameters for cancelling an ongoing operation related to the content of a VNF snapshot package. It shall comply with the provisions defined in table 11.5.2.8-1.\n", "type": "object", "properties": { "cause": { "description": "Description about the reason for cancelling the operation. If this attribute is present, the NFVO shall add such information into the \"failureDetails\" of the representation of the \"Individual VNF snapshot package\" resource.\n", "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVnfSnapshotPackagesVnfSnapshotPkgIdPackageContentCancel" }, "task": true }, { "name": "getVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess", "summary": "The GET method reads the access configuration information that is used by the NFVO to get \nthe cont", "description": "The GET method reads the access configuration information that is used by the NFVO to get \nthe content of external VNF snapshot package artifacts.\n", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess" }, "task": true }, { "name": "putVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess", "summary": "The PUT method provides the access configuration information for the NFVO to download \nthe content", "description": "The PUT method provides the access configuration information for the NFVO to download \nthe content of external VNF package artifacts.\n\nAs precondition for invoking this method, the \"Individual VNF snapshot package\" resource \nshall have been created, and the value of \"state\" attribute in the representation of the \n\"Individual VNF snapshot package\" resource shall equal to \"CREATED\" or \"ERROR\".\n\nThe resource representation in the payload body of the PUT request shall replace the current \nstate of t...(description truncated)", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } }, { "name": "body", "type": "string", "info": "VOID: string", "required": true, "schema": { "description": "VnfSnapshotPkgExtArtifactsAccessInfo description !\n", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVnfSnapshotPackagesVnfSnapshotPkgIdExtArtifactsAccess" }, "task": true }, { "name": "getVnfSnapshotPackagesVnfSnapshotPkgIdArtifactsArtifactPath", "summary": "The GET method fetches the content of an artifact within the VNF snapshot package.\n\nIf the VNF snap", "description": "The GET method fetches the content of an artifact within the VNF snapshot package.\n\nIf the VNF snapshot package is a result of a building process (refer to \n\"Build VNF snapshot package content task\" resource in clause 11.4.6), and the referred \n\"Individual VNF snapshot package artifact\" is external to the main VNF snapshot package\nfile, the NFVO shall return a \"302 Found\" response code referencing the external artifact\nresource. To fetch the \"Individual VNF snapshot package artifact\" from URI in...(description truncated)", "input": [ { "name": "vnfSnapshotPkgId", "type": "string", "info": "Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.\nThis identifier can be retrieved from the \"id\" attribute of the applicable \"VnfSnapshotPk...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotPkgId", "type": "string" } }, { "name": "artifactPath", "type": "string", "info": "For an artifact contained as a file in the VNF snapshot package, this variable shall contain a sequence \nof one or path segments representing the path of the artifact wit...(description truncated): string", "required": true, "schema": { "title": "artifactPath", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVnfSnapshotPackagesVnfSnapshotPkgIdArtifactsArtifactPath" }, "task": true }, { "name": "querymultipleNSinstances", "summary": "Query multiple NS instances.", "description": "Query NS Instances.\nThe GET method queries information about multiple NS instances. This method shall support the URI query parameters,\nrequest and response data structures, and response codes, as specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "type": "string", "info": "Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support this parameter.: string", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "type": "string", "info": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "type": "string", "info": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "type": "string", "info": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support t...(description truncated): string", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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": "" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/querymultipleNSinstances" }, "task": true }, { "name": "createaNSinstanceresource", "summary": "Create a NS instance resource.", "description": "The POST method creates a new NS instance resource. As the result of successfully executing this method, a new\n\"Individual NS instance\" resource as defined in clause 6.4.3 shall have been created, and the value of the\n\"instantiationState\" attribute in the representation of that resource shall be \"NOT_INSTANTIATED\". A notification\nof type NsIdentifierCreationNotification shall be triggered as part of successfully executing this method as defined\nin clause 6.5.2.6.\n", "input": [ { "name": "body", "type": "object", "info": "The NS creation parameters, as defined in clause 6.5.2.7.: {\"nsdId\": \"string\", \"nsName\": \"string\", \"nsDescription\": \"string\"}", "required": true, "schema": { "title": "NsInstancesRequest", "required": [ "nsdId", "nsName", "nsDescription" ], "type": "object", "properties": { "nsdId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "nsName": { "type": "string", "description": "Human-readable name of the NS instance to be created." }, "nsDescription": { "type": "string", "description": "Human-readable description of the NS instance to be created." } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createaNSinstanceresource" }, "task": true }, { "name": "readanindividualNSinstanceresource", "summary": "Read an individual NS instance resource.", "description": "The GET method retrieves information about a NS instance by reading an individual NS instance resource.\n", "input": [ { "name": "nsInstanceId", "type": "string", "info": "Identifier of the NS instance.: string", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/readanindividualNSinstanceresource" }, "task": true }, { "name": "deleteNSinstanceresource", "summary": "Delete NS instance resource.", "description": "Delete NS Identifier\nThis method deletes an individual NS instance resource. As the result of successfully executing this method, the\n\"Individual NS instance\" resource shall not exist any longer. A notification of type \"NsIdentifierDeletionNotification\"\nshall be triggered as part of successfully executing this method as defined in clause 6.5.2.7.\n", "input": [ { "name": "nsInstanceId", "type": "string", "info": "Identifier of the NS instance.: string", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNSinstanceresource" }, "task": true }, { "name": "instantiateaNS", "summary": "Instantiate a NS.", "description": "The POST method requests to instantiate a NS instance resource. The steps and conditions that apply as the result\nof successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully\ncompleted the underlying NS LCM operation occurrence, it shall set the \"nsState\" attribute to the value \"INSTANTIATED\"\nin the representation of the \"Individual NS instance\" resource.\n", "input": [ { "name": "nsInstanceId", "type": "string", "info": "Identifier of the NS instance.: string", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "Parameters for the instantiate NS operation, as defined in clause 6.5.2.11.: {\"nsFlavourId\": \"string\", \"sapData\": [{\"sapdId\": \"string\", \"sapName\": \"string\", \"description\": \"string\", \"sapProtocolData\": [{\"layerProtocol\": \"Must be one of [IP_OVER_ETHERNET]\", \"ipOverEthernet\": \"undefined\"}]}], \"addpnfData\": [{\"pnfId\": \"string\", \"pnfName\": \"string\", \"pnfdId\": \"string\", \"pnfProfileId\": \"string\", \"cpData\": [{\"cpInstanceId\": \"string\", \"cpdId\": \"string\", \"cpProtocolData\": [{\"layerProtocol\": \"Must be one of [IP_OVER_ETHERNET]\", \"ipOverEthernet\": \"undefined\"}]}]}], \"vnfInstanceData\": [{\"vnfInstanceId\": \"string\", \"vnfProfileId\": \"string\"}], \"nestedNsInstanceData\": [{\"nestedNsInstanceId\": \"string\", \"nsProfileId\": \"string\"}], \"locationConstraints\": [{\"vnfProfileId\": \"string\", \"locationConstraints\": {\"countryCode\": \"string\", \"civicAddressElement\": [{\"caType\": 123, \"caValue\": \"string\"}], \"area\": \"object\"}}], \"nestedNslocationConstraints\": \"array\", \"additionalParamsForNs\": \"object\", \"additionalParamForNestedNs\": [{\"nsProfileId\": \"string\", \"additionalParam\": \"array\"}], \"additionalParamsForVnf\": [{\"vnfProfileId\": \"string\", \"vnfInstanceName\": \"string\", \"vnfInstanceDescription\": \"string\", \"vnfConfigurableProperties\": \"object\", \"metadata\": \"object\", \"extensions\": \"object\", \"additionalParams\": \"object\"}], \"startTime\": \"undefined\", \"nsInstantiationLevelId\": \"string\", \"wanConnectionData\": \"array\", \"additionalAffinityOrAntiAffinityRule\": [{\"vnfdId\": \"array\", \"vnfProfileId\": \"array\", \"vnfInstanceId\": \"array\", \"affinityOrAntiAffiinty\": \"Must be one of [AFFINITY, ANTI_AFFINITY]\", \"scope\": \"Must be one of [NFVI_POP, ZONE, ZONE_GROUP, NFVI_NODE]\"}]}", "required": true, "schema": { "title": "NsInstancesInstantiateRequest", "required": [ "nsFlavourId" ], "type": "object", "properties": { "nsFlavourId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "sapData": { "type": "array", "items": { "title": "SapDatum", "required": [ "sapdId", "sapName", "description" ], "type": "object", "properties": { "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." }, "description": { "type": "string", "description": "Human readable description for the SAP." }, "sapProtocolData": { "type": "array", "items": { "title": "SapProtocolDatum", "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 SAP." } }, "description": "This type represents the information related to a SAP of a NS. It shall comply with the provisions defined in Table 6.5.3.10-1." }, "description": "Create data concerning the SAPs of this NS." }, "addpnfData": { "type": "array", "items": { "title": "AddpnfDatum", "required": [ "pnfId", "pnfName", "pnfdId", "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." }, "pnfProfileId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "cpData": { "type": "array", "items": { "title": "CpDatum", "required": [ "cpProtocolData" ], "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": "Address assigned for this CP." } }, "description": "This type represents the configuration data on the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.16-1." }, "description": "Address assigned for the PNF external CP(s)." } }, "description": "This type specifies an PNF to be added to the NS instance and the PNF Profile to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1." }, "description": "Information on the PNF(s) that are part of this NS." }, "vnfInstanceData": { "type": "array", "items": { "title": "VnfInstanceDatum", "required": [ "vnfInstanceId", "vnfProfileId" ], "type": "object", "properties": { "vnfInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "vnfProfileId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." } }, "description": "This type specifies an existing VNF instance to be used in the NS instance and if needed, the VNF Profile to use for this VNF instance. It shall comply with the provisions defined in Table 6.5.3.19-1." }, "description": "Specify an existing VNF instance to be used in the NS. If needed, the VNF Profile to be used for this VNF instance is also provided. The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile." }, "nestedNsInstanceData": { "type": "array", "items": { "title": "NestedNsInstanceDatum", "required": [ "nestedNsInstanceId" ], "type": "object", "properties": { "nestedNsInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "nsProfileId": { "type": "string", "description": "An identifier that is unique with respect to a NS. Representation: string of variable length." } }, "description": "This type specifies an existing nested NS instance to be used in the NS instance and if needed, the NsProfile to use for this nested NS instance. It shall comply with the provisions defined in Table 6.5.3.19a-1." }, "description": "Specify an existing NS instance to be used as a nested NS within the NS. If needed, the NS Profile to be used for this nested NS instance is also provided. NOTE 2: The NS DF of each nested NS shall be one of the allowed flavours in the associated NSD (as referenced in the nestedNsd attribute of the NSD of the NS to be instantiated). NOTE 3: The NSD of each referenced NSs (i.e. each nestedInstanceId) shall match the one of the nested NSD in the composite NSD." }, "locationConstraints": { "type": "array", "items": { "title": "LocationConstraints3", "required": [ "vnfProfileId" ], "type": "object", "properties": { "vnfProfileId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "locationConstraints": { "title": "LocationConstraints", "type": "object", "properties": { "countryCode": { "type": "string", "description": "The two-letter ISO 3166 [29] country code in capital letters. Shall be present in case the \"area\" attribute is absent. May be absent if the \"area\" attribute is present. If both \"countryCode\" and \"area\" are present, no conflicts should exist between the values of these two attributes. In case of conflicts, the API producer (i.e. the NFVO) shall disregard parts of the geographic area signalled by \"area\" that are outside the boundaries of the country signalled by \"countryCode\". If \"countryCode\" is absent, it is solely the \"area\" attribute that defines the location constraint." }, "civicAddressElement": { "type": "array", "items": { "title": "CivicAddressElement", "required": [ "caType", "caValue" ], "type": "object", "properties": { "caType": { "type": "integer", "description": "Describe the content type of caValue. The value of caType shall comply with Section 3.4 of IETF RFC 4776 [13]." }, "caValue": { "type": "string", "description": "Content of civic address element corresponding to the caType. The format caValue shall comply with Section 3.4 of IETF RFC 4776 [13]." } } }, "description": "Zero or more elements comprising the civic address. Shall be absent if the \"area\" attribute is present." }, "area": { "type": "object", "description": "Geographic area. Shall be absent if the \"civicAddressElement\" attribute is present. The content of this attribute shall follow the provisions for the \"Polygon\" geometry object as defined in IETF RFC 7946, for which the \"type\" member shall be set to the value \"Polygon\". If both \"countryCode\" and \"area\" are present, no conflicts should exist between the values of these two attributes. In case of conflicts, the API producer (i.e. the NFVO) shall disregard parts of the geographic area signalled by \"area\" that are outside the boundaries of the country signalled by \"countryCode\". If \"countryCode\" is absent, it is solely the \"area\" attribute that defines the location constraint." } }, "description": "This type represents location constraints for a VNF to be instantiated. The location constraints can be represented as follows: •\tas a country code •\tas a civic address combined with a country code •\tas an area, conditionally combined with a country code The LocationConstraints data type shall comply with the provisions defined in Table 6.5.3.21-1." } }, "description": "This type represents the association of location constraints to a VNF instance to be created according to a specific VNF profile. It shall comply with the provisions defined in Table 6.5.3.20-1." }, "description": "Defines the location constraints for the VNF to be instantiated as part of the NS instantiation. An example can be a constraint for the VNF to be in a specific geographic location.." }, "nestedNslocationConstraints": { "type": "array", "items": { "type": "object" }, "description": "Defines the location constraints for the nested NS to be instantiated as part of the NS instantiation. An example can be a constraint for the nested NS to be in a specific geographic location." }, "additionalParamsForNs": { "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." }, "additionalParamForNestedNs": { "type": "array", "items": { "title": "AdditionalParamForNestedN", "required": [ "nsProfileId" ], "type": "object", "properties": { "nsProfileId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "additionalParam": { "type": "array", "items": { "type": "object" }, "description": "Additional parameters that are to be applied on a per nested NS instance." } }, "description": "This type specifies additional parameters on a per-nested NS instance basis. It shall comply with the provisions defined in Table 6.5.3.21a-1." }, "description": "Allows the OSS/BSS to provide additional parameter(s) per nested NS instance (as opposed to the composite NS level, which is covered in additionalParamForNs, and as opposed to the VNF level, which is covered in additionalParamForVnf). This is for nested NS instances that are to be created by the NFVO as part of the NS instantiation and not for existing nested NS instances that are referenced for reuse." }, "additionalParamsForVnf": { "type": "array", "items": { "title": "AdditionalParamsForVnf", "required": [ "vnfProfileId" ], "type": "object", "properties": { "vnfProfileId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "vnfInstanceName": { "type": "string", "description": "Human-readable name of the VNF instance to be created." }, "vnfInstanceDescription": { "type": "string", "description": "Human-readable description of the VNF instance to be created." }, "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." }, "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." }, "additionalParams": { "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 defines the additional parameters for the VNF instance to be created associated with an NS instance. It shall comply with the provisions defined in Table 6.5.3.22-1." }, "description": "Allows the OSS/BSS to provide additional parameter(s) per VNF instance (as opposed to the composite NS level, which is covered in additionalParamsForNs and as opposed to the nested NS level, which is covered in additionalParamForNestedNs). This is for VNFs that are to be created by the NFVO as part of the NS instantiation and not for existing VNF that are referenced for reuse." }, "startTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339." }, "nsInstantiationLevelId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "wanConnectionData": { "type": "array", "items": {}, "description": "Information for connecting VNs to the WAN when VLs are deployed across a WAN. When the NS is deployed over several sites, the VLs of this NS will include VNs in each site connected over the WAN. In this case, the \"wanConnectionData\" provides the needed information required to connect each VN to the WAN. Annex E provides additional information and guidelines about the usage of the \"wanConnectionData\" attribute." }, "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": "Specifies additional affinity or anti-affinity constraint for the VNF instances to be instantiated as part of the NS instantiation. Shall not conflict with rules already specified in the NSD." } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/instantiateaNS" }, "task": true }, { "name": "scaleaNSinstance", "summary": "Scale a NS instance.", "description": "The POST method requests to scale a NS instance resource. The steps and conditions that apply as the result of\nsuccessfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully\ncompleted the underlying NS LCM operation occurrence, it shall reflect the result of scaling the NS instance by\nupdating the \"nsScaleStatus\" attribute in the representation of the \"Individual NS instance\" resource.\n", "input": [ { "name": "nsInstanceId", "type": "string", "info": "Identifier of the NS instance.: string", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "Parameters for the scale NS operation, as defined in clause 6.5.2.14.: object", "required": true, "schema": { "description": "Parameters for the scale NS operation, as defined in clause 6.5.2.14." } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/scaleaNSinstance" }, "task": true }, { "name": "updatesaNSinstance", "summary": "Updates a NS instance.", "description": "The POST method updates an NS instance.\n", "input": [ { "name": "nsInstanceId", "type": "string", "info": "Identifier of the NS instance.: string", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "Parameters for the update NS operation, as defined in clause 6.5.2.12.: {\"updateType\": \"Must be one of [ADD_VNF, REMOVE_VNF, INSTANTIATE_VNF, CHANGE_VNF_DF, OPERATE_VNF, MODIFY_VNF_INFORMATION, CHANGE_EXTERNAL_VNF_CONNECTIVITY, CHANGE_VNFPKG, ADD SAP, REMOVE_SAP, ADD_NESTED_NS, REMOVE_NESTED_NS, ASSOC_NEW_NSD_VERSION, MOVE_VNF, ADD_VNFFG, REMOVE_VNFFG, UPDATE_VNFFG, CHANGE_NS_DF, ADD_PNF, MODIFY_PNF, REMOVE_PNF, CREATE_VNF_SNAPSHOT, REVERT_VNF_TO_SNAPSHOT, DELETE_VNF_SNAPSHOT_INFO, MODIFY_WAN_CONNECTION_INFO, CREATE_NS_VIRTUAL_LINK, DELETE_NS_VIRTUAL_LINK]\", \"addVnfIstance\": [{\"vnfInstanceId\": \"string\", \"vnfProfileId\": \"string\"}], \"removeVnfInstanceId\": \"array\", \"instantiateVnfData\": [{\"vnfdId\": \"string\", \"vnfFlavourId\": \"string\", \"vnfInstantiationLevelId\": \"string\", \"vnfInstanceName\": \"string\", \"vnfInstanceDescription\": \"string\", \"extVirtualLinks\": [{\"extVirtualLinkId\": \"string\", \"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"extCps\": [{\"cpdId\": \"string\", \"cpConfig\": \"object\"}], \"extLinkPorts\": [{\"id\": \"string\", \"resourceHandle\": {\"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vimLevelResourceType\": \"string\"}}]}], \"extManagedVirtualLinks\": [{\"extManagedVirtualLinkId\": \"string\", \"vnfVirtualLinkDescId\": \"string\", \"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vnfLinkPort\": [{\"vnfLinkPortId\": \"string\", \"resourceHandle\": {\"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vimLevelResourceType\": \"string\"}}], \"extManagedMultisiteVirtualLinkId\": \"string\"}], \"localizationLanguage\": \"string\", \"vnfConfigurableProperties\": \"object\", \"additionalParams\": \"object\", \"metadata\": \"object\", \"extensions\": \"object\", \"locationConstraints\": {\"vnfProfileId\": \"string\", \"locationConstraints\": {\"countryCode\": \"string\", \"civicAddressElement\": [{\"caType\": 123, \"caValue\": \"string\"}], \"area\": \"object\"}}}], \"changeVnfFlavourData\": [{\"vnfInstanceId\": \"string\", \"newFlavourId\": \"string\", \"instantiationLevelId\": \"string\", \"extVirtualLinks\": [{\"extVirtualLinkId\": \"string\", \"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"extCps\": [{\"cpdId\": \"string\", \"cpConfig\": \"object\"}], \"extLinkPorts\": [{\"id\": \"string\", \"resourceHandle\": {\"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vimLevelResourceType\": \"string\"}}]}], \"extManagedVirtualLinks\": [{\"extManagedVirtualLinkId\": \"string\", \"vnfVirtualLinkDescId\": \"string\", \"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vnfLinkPort\": [{\"vnfLinkPortId\": \"string\", \"resourceHandle\": {\"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vimLevelResourceType\": \"string\"}}], \"extManagedMultisiteVirtualLinkId\": \"string\"}], \"additionalParams\": \"object\", \"extensions\": \"object\", \"vnfConfigurableProperties\": \"object\"}], \"operateVnfData\": [{\"vnfInstanceId\": \"string\", \"changeStateTo\": \"Must be one of [STARTED, STOPPED]\", \"stopType\": \"Must be one of [FORCEFUL, GRACEFUL]\", \"gracefulStopTimeout\": 123, \"additionalParam\": \"object\"}], \"modifyVnfInfoData\": [{\"vnfInstanceId\": \"string\", \"vnfInstanceName\": \"string\", \"vnfInstanceDescription\": \"string\", \"vnfdId\": \"string\", \"vnfConfigurableProperties\": \"object\", \"metadata\": \"object\", \"extensions\": \"object\"}], \"changeExtVnfConnectivityData\": [{\"vnfInstanceId\": \"string\", \"extVirtualLinks\": [{\"extVirtualLinkId\": \"string\", \"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"extCps\": [{\"cpdId\": \"string\", \"cpConfig\": \"object\"}], \"extLinkPorts\": [{\"id\": \"string\", \"resourceHandle\": {\"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vimLevelResourceType\": \"string\"}}]}], \"additionalParams\": \"object\"}], \"changeVnfPackageData\": [{\"vnfInstanceId\": \"string\", \"vnfdId\": \"string\", \"extVirtualLinks\": [{\"extVirtualLinkId\": \"string\", \"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"extCps\": [{\"cpdId\": \"string\", \"cpConfig\": \"object\"}], \"extLinkPorts\": [{\"id\": \"string\", \"resourceHandle\": {\"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vimLevelResourceType\": \"string\"}}]}], \"extManagedVirtualLinks\": [{\"extManagedVirtualLinkId\": \"string\", \"vnfVirtualLinkDescId\": \"string\", \"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vnfLinkPort\": [{\"vnfLinkPortId\": \"string\", \"resourceHandle\": {\"vimId\": \"string\", \"resourceProviderId\": \"string\", \"resourceId\": \"string\", \"vimLevelResourceType\": \"string\"}}], \"extManagedMultisiteVirtualLinkId\": \"string\"}], \"additionalParams\": \"object\", \"extensions\": \"object\", \"vnfConfigurableProperties\": \"object\"}], \"addSap\": [{\"sapdId\": \"string\", \"sapName\": \"string\", \"description\": \"string\", \"sapProtocolData\": [{\"layerProtocol\": \"Must be one of [IP_OVER_ETHERNET]\", \"ipOverEthernet\": \"undefined\"}]}], \"removeSapId\": \"array\", \"addNestedNsData\": [{\"nestedNsInstanceId\": \"string\", \"nsProfileId\": \"string\"}], \"removeNestedNsId\": \"array\", \"assocNewNsdVersionData\": {\"newNsdId\": \"string\", \"sync\": \"boolean\"}, \"moveVnfInstanceData\": [{\"targetNsInstanceId\": \"string\", \"vnfInstanceId\": \"array\"}], \"addVnffg\": [{\"targetNsInstanceId\": \"string\", \"vnffgName\": \"string\", \"description\": \"string\"}], \"removeVnffgId\": \"array\", \"updateVnffg\": [{\"vnffgInfoId\": \"string\", \"nfp\": [{\"nfpInfoId\": \"string\", \"nfpName\": \"string\", \"description\": \"string\", \"cpGroup\": [{\"cpPairInfo\": [{\"vnfExtCpIds\": \"array\", \"pnfExtCpIds\": \"array\", \"sapIds\": \"array\"}], \"forwardingBehaviour\": \"Must be one of [ALL, LB]\", \"forwardingBehaviourInputParameters\": {\"algortihmName\": \"Must be one of [ROUND_ROBIN, LEAST_CONNECTION, LEAST_TRAFFIC, LEAST_RESPONSE_TIME, CHAINED_FAILOVER, SOURCE_IP_HASH, SOURCE_MAC_HASH]\", \"algorithmWeights\": \"array\"}}], \"nfpRule\": \"undefined\"}], \"nfpInfoId\": \"array\"}], \"changeNsFlavourData\": {\"newNsFlavourId\": \"string\", \"instantiationLevelId\": \"string\"}, \"addPnfData\": [{\"pnfId\": \"string\", \"pnfName\": \"string\", \"pnfdId\": \"string\", \"pnfProfileId\": \"string\", \"cpData\": [{\"cpInstanceId\": \"string\", \"cpdId\": \"string\", \"cpProtocolData\": [{\"layerProtocol\": \"Must be one of [IP_OVER_ETHERNET]\", \"ipOverEthernet\": \"undefined\"}]}]}], \"modifyPnfData\": \"array\", \"removePnfId\": \"array\", \"modifyWanConnectionInfoData\": [{\"wanConnectionInfoId\": \"string\", \"mscsName\": \"string\", \"mscsDescription\": \"string\", \"mscsEndpoints\": [{\"mscsEndpointId\": \"string\", \"directionality\": \"Must be one of [INBOUND, OUTBOUND, BOTH]\", \"connectivityServiceEndpoinId\": \"array\"}], \"removeMscsEndpointIds\": \"array\", \"connectivityServiceEndpoints\": [{\"connectivityServiceEndpointId\": \"string\", \"vimId\": \"string\", \"siteToWanLayer2ProtocolData\": {\"layer2ConnectionInfo\": {\"connectionType\": \"Must be one of [CSE, AGGREGATE_CSE]\", \"interfaceType\": \"Must be one of [PARENT, LOGICAL]\", \"interfaceTagging\": \"Must be one of [UNTAGGED, TAGGED]\", \"encapsulationType\": \"Must be one of [ETH, VLAN, VXLAN]\", \"vlanTaggingType\": \"Must be one of [DOT1Q, QINQ, QINANY]\", \"wanSegmentIds\": {\"wanSegmentIdValue\": \"string\", \"wanSegmentIdUpperRange\": \"string\"}, \"vxlanConfig\": {\"peerMode\": \"Must be one of [STATIC, BGP_EVPN]\", \"peers\": \"array\"}, \"lagInterfaceData\": {\"aggregatedEndpoints\": \"array\", \"lacpActivation\": \"boolean\", \"lacpConfig\": \"object\"}, \"layer2ControlProtocol\": \"object\"}, \"mtuL2\": 123, \"virtualRoutingAndForwarding\": {\"macVrfName\": \"string\"}, \"forwardingConfig\": \"undefined\"}, \"siteToWanLayer3ProtocolData\": {\"logicalInterfaceIpAddress\": {\"ipAddress\": \"string\", \"associatedSegmentId\": \"string\"}, \"routingInfo\": {\"routingProtocol\": \"Must be one of [BGP, RIP, OSPF, STATIC, DIRECT, VRRP]\", \"staticRouting\": {\"ipVersion\": \"Must be one of [IPV4, IPV6]\", \"ipPrefix\": \"string\", \"prefixSize\": 123, \"nextHop\": \"string\"}, \"routingAddressFamily\": \"Must be one of [IPV4, IPv6]\", \"ospfRouting\": {\"areaId\": \"string\"}, \"bgpRouting\": {\"bgpAs\": \"object\", \"bgpNeighbour\": \"string\", \"bgpAdditionalParam\": \"object\"}, \"routeMapsDistribution\": {\"policy\": \"Must be one of [PERMIT, DENY]\", \"sequence\": 123, \"matchAndSetRule\": \"object\"}}, \"mtuL3\": 123, \"virtualRoutingAndForwarding\": {\"vrfName\": \"string\"}, \"bfdConfig\": \"object\"}}], \"removeConnectivityServiceEndpoints\": \"array\"}], \"updateTime\": \"undefined\", \"createSnapshotData\": {\"vnfInstanceId\": \"string\", \"additionalParams\": \"object\", \"userDefinedData\": \"object\"}, \"revertVnfToSnapshotData\": {\"vnfInstanceId\": \"string\", \"vnfSnapshotInfoId\": \"string\", \"additionalParams\": \"object\"}, \"deleteVnfSnapshotData\": {\"vnfInstanceId\": \"string\", \"vnfSnapshotInfoId\": \"string\"}, \"addNsVirtualLinkData\": [{\"nsVirtualLinkProfileId\": \"string\"}], \"deleteNsVirtualLinkId\": \"array\"}", "required": true, "schema": { "title": "NsInstancesUpdateRequest", "required": [ "updateType" ], "type": "object", "properties": { "updateType": { "title": "UpdateType", "enum": [ "ADD_VNF", "REMOVE_VNF", "INSTANTIATE_VNF", "CHANGE_VNF_DF", "OPERATE_VNF", "MODIFY_VNF_INFORMATION", "CHANGE_EXTERNAL_VNF_CONNECTIVITY", "CHANGE_VNFPKG", "ADD SAP", "REMOVE_SAP", "ADD_NESTED_NS", "REMOVE_NESTED_NS", "ASSOC_NEW_NSD_VERSION", "MOVE_VNF", "ADD_VNFFG", "REMOVE_VNFFG", "UPDATE_VNFFG", "CHANGE_NS_DF", "ADD_PNF", "MODIFY_PNF", "REMOVE_PNF", "CREATE_VNF_SNAPSHOT", "REVERT_VNF_TO_SNAPSHOT", "DELETE_VNF_SNAPSHOT_INFO", "MODIFY_WAN_CONNECTION_INFO", "CREATE_NS_VIRTUAL_LINK", "DELETE_NS_VIRTUAL_LINK" ], "type": "string", "description": "The type of update. It determines also which one of the following parameters is present in the operation. Possible values include: * ADD_VNF: Adding existing VNF instance(s) * REMOVE_VNF: Removing VNF instance(s) * INSTANTIATE_VNF: Instantiating new VNF(s) * CHANGE_VNF_DF: Changing VNF DF * OPERATE_VNF: Changing VNF state, * MODIFY_VNF_INFORMATION: Modifying VNF information and/or the configurable properties of VNF instance(s) * CHANGE_EXTERNAL_VNF_CONNECTIVITY: Changing the external connectivity of VNF instance(s) * CHANGE_VNFPKG: Changing the VNF package(s) on which (a) VNF instance(s) is/are based * ADD_SAP: Adding SAP(s) * REMOVE_SAP: Removing SAP(s) * ADD_NESTED_NS: Adding existing NS instance(s) as nested NS(s) * REMOVE_NESTED_NS: Removing existing nested NS instance(s) * ASSOC_NEW_NSD_VERSION: Associating a new NSD version to the NS instance * MOVE_VNF: Moving VNF instance(s) from one origin NS instance to another target NS instance * ADD_VNFFG: Adding VNFFG(s) * REMOVE_VNFFG: Removing VNFFG(s) * UPDATE_VNFFG: Updating VNFFG(s) * CHANGE_NS_DF: Changing NS DF * ADD_PNF: Adding PNF * MODIFY_PNF: Modifying PNF * REMOVE_PNF: Removing PNF *\tCREATE_VNF_SNAPSHOT: Creating VNF Snapshots of VNF instances belonging to the NS instance.\n It depends on the VNF capabilities, and is declared in the VNFD whether the operation is supported for a particular VNF.\n*\tREVERT_VNF_TO_SNAPSHOT: Reverting a VNF instance belonging to the NS instance to a VNF Snapshot.\n It depends on the VNF capabilities, and is declared in the VNFD whether the operation is supported for a particular VNF.\n The operation might be service-disruptive.\n*\tDELETE_VNF_SNAPSHOT_INFO: Deleting available VNF Snapshot information for a VNF instance belonging to the NS instance.\n It depends on the VNF capabilities, and is declared in the VNFD whether the operation is supported for a particular VNF.\n*\tMODIFY_WAN_CONNECTION_INFO: Modify WAN related connectivity information. *\tCREATE_NS_VIRTUAL_LINK: Create an NsVirtualLink instance. *\tDELETE_NS_VIRTUAL_LINK: Delete an NsVirtualLink instance.", "example": "ADD_VNF" }, "addVnfIstance": { "type": "array", "items": { "title": "AddVnfIstance", "required": [ "vnfInstanceId", "vnfProfileId" ], "type": "object", "properties": { "vnfInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "vnfProfileId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." } }, "description": "This type specifies an existing VNF instance to be used in the NS instance and if needed, the VNF Profile to use for this VNF instance. It shall comply with the provisions defined in Table 6.5.3.19-1." }, "description": "Identifies an existing VNF instance to be added to the NS instance. It shall be present only if updateType = \"ADD_VNF\"." }, "removeVnfInstanceId": { "type": "array", "items": { "type": "string" }, "description": "Identifies an existing VNF instance to be removed from the NS instance. It contains the identifier(s) of the VNF instances to be removed. It shall be present only if updateType = \"REMOVE_VNF.\" Note: If a VNF instance is removed from a NS and this NS was the last one for which this VNF instance was a part, the VNF instance is terminated by the NFVO." }, "instantiateVnfData": { "type": "array", "items": { "title": "InstantiateVnfDatum", "required": [ "vnfdId", "vnfFlavourId" ], "type": "object", "properties": { "vnfdId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "vnfFlavourId": { "type": "string", "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD." }, "vnfInstantiationLevelId": { "type": "string", "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD." }, "vnfInstanceName": { "type": "string", "description": "Human-readable name of the VNF instance to be created." }, "vnfInstanceDescription": { "type": "string", "description": "Human-readable description of the VNF instance to be created." }, "extVirtualLinks": { "type": "array", "items": { "title": "ExtVirtualLink", "required": [ "resourceId", "extCps" ], "type": "object", "properties": { "extVirtualLinkId": { "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." }, "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." }, "extCps": { "type": "array", "items": { "title": "ExtCp", "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": "External CPs of the VNF to be connected to this external VL." }, "extLinkPorts": { "type": "array", "items": { "title": "ExtLinkPort3", "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." } }, "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL." }, "description": "Externally provided link ports to be used to connect external connection points to this external VL." } }, "description": "This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1." }, "description": "Information about external VLs to connect the VNF to." }, "extManagedVirtualLinks": { "type": "array", "items": { "title": "ExtManagedVirtualLink", "required": [ "vnfVirtualLinkDescId", "resourceId" ], "type": "object", "properties": { "extManagedVirtualLinkId": { "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." }, "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." }, "vnfLinkPort": { "type": "array", "items": { "title": "VnfLinkPort6", "required": [ "vnfLinkPortId", "resourceHandle" ], "type": "object", "properties": { "vnfLinkPortId": { "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." } }, "description": "This type represents an externally provided link port to be used to connect a VNFC connection point to an externally-managed VL. It shall comply with the provisions defined in table 6.5.3.78-1." }, "description": "Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL on this network resource. If this attribute is not present, the VNFM shall create the link ports on the externally-managed VL." }, "extManagedMultisiteVirtualLinkId": { "type": "string", "description": "An identifier with the intention of being globally unique." } }, "description": "This type represents an externally-managed internal VL. It shall comply with the provisions defined in Table 6.5.3.27-1." }, "description": "Information about internal VLs that are managed by other entities than the VNFM. It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData 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.27)." }, "localizationLanguage": { "type": "string", "description": "Localization language of the VNF to be instantiated. The value shall comply with the format defined in IETF RFC 5646." }, "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." }, "additionalParams": { "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." }, "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." }, "locationConstraints": { "title": "LocationConstraints3", "required": [ "vnfProfileId" ], "type": "object", "properties": { "vnfProfileId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "locationConstraints": { "title": "LocationConstraints", "type": "object", "properties": { "countryCode": { "type": "string", "description": "The two-letter ISO 3166 [29] country code in capital letters. Shall be present in case the \"area\" attribute is absent. May be absent if the \"area\" attribute is present. If both \"countryCode\" and \"area\" are present, no conflicts should exist between the values of these two attributes. In case of conflicts, the API producer (i.e. the NFVO) shall disregard parts of the geographic area signalled by \"area\" that are outside the boundaries of the country signalled by \"countryCode\". If \"countryCode\" is absent, it is solely the \"area\" attribute that defines the location constraint." }, "civicAddressElement": { "type": "array", "items": { "title": "CivicAddressElement", "required": [ "caType", "caValue" ], "type": "object", "properties": { "caType": { "type": "integer", "description": "Describe the content type of caValue. The value of caType shall comply with Section 3.4 of IETF RFC 4776 [13]." }, "caValue": { "type": "string", "description": "Content of civic address element corresponding to the caType. The format caValue shall comply with Section 3.4 of IETF RFC 4776 [13]." } } }, "description": "Zero or more elements comprising the civic address. Shall be absent if the \"area\" attribute is present." }, "area": { "type": "object", "description": "Geographic area. Shall be absent if the \"civicAddressElement\" attribute is present. The content of this attribute shall follow the provisions for the \"Polygon\" geometry object as defined in IETF RFC 7946, for which the \"type\" member shall be set to the value \"Polygon\". If both \"countryCode\" and \"area\" are present, no conflicts should exist between the values of these two attributes. In case of conflicts, the API producer (i.e. the NFVO) shall disregard parts of the geographic area signalled by \"area\" that are outside the boundaries of the country signalled by \"countryCode\". If \"countryCode\" is absent, it is solely the \"area\" attribute that defines the location constraint." } }, "description": "This type represents location constraints for a VNF to be instantiated. The location constraints can be represented as follows: •\tas a country code •\tas a civic address combined with a country code •\tas an area, conditionally combined with a country code The LocationConstraints data type shall comply with the provisions defined in Table 6.5.3.21-1." } }, "description": "This type represents the association of location constraints to a VNF instance to be created according to a specific VNF profile. It shall comply with the provisions defined in Table 6.5.3.20-1." } }, "description": "This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF update operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with the provisions defined in Table 6.5.3.24-1." }, "description": "Identifies the new VNF to be instantiated. It can be used e.g. for the bottom-up NS creation. It shall be present only if updateType = \"INSTANTIATE_VNF\"." }, "changeVnfFlavourData": { "type": "array", "items": { "title": "ChangeVnfFlavourDatum", "required": [ "vnfInstanceId", "newFlavourId" ], "type": "object", "properties": { "vnfInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "newFlavourId": { "type": "string", "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD." }, "instantiationLevelId": { "type": "string", "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD." }, "extVirtualLinks": { "type": "array", "items": { "title": "ExtVirtualLink", "required": [ "resourceId", "extCps" ], "type": "object", "properties": { "extVirtualLinkId": { "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." }, "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." }, "extCps": { "type": "array", "items": { "title": "ExtCp", "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": "External CPs of the VNF to be connected to this external VL." }, "extLinkPorts": { "type": "array", "items": { "title": "ExtLinkPort3", "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." } }, "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL." }, "description": "Externally provided link ports to be used to connect external connection points to this external VL." } }, "description": "This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1." }, "description": "Information about external VLs to connect the VNF to." }, "extManagedVirtualLinks": { "type": "array", "items": { "title": "ExtManagedVirtualLink", "required": [ "vnfVirtualLinkDescId", "resourceId" ], "type": "object", "properties": { "extManagedVirtualLinkId": { "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." }, "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." }, "vnfLinkPort": { "type": "array", "items": { "title": "VnfLinkPort6", "required": [ "vnfLinkPortId", "resourceHandle" ], "type": "object", "properties": { "vnfLinkPortId": { "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." } }, "description": "This type represents an externally provided link port to be used to connect a VNFC connection point to an externally-managed VL. It shall comply with the provisions defined in table 6.5.3.78-1." }, "description": "Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL on this network resource. If this attribute is not present, the VNFM shall create the link ports on the externally-managed VL." }, "extManagedMultisiteVirtualLinkId": { "type": "string", "description": "An identifier with the intention of being globally unique." } }, "description": "This type represents an externally-managed internal VL. It shall comply with the provisions defined in Table 6.5.3.27-1." }, "description": "information about internal VLs that are managed by NFVO. The indication of externally-managed internal VLs is needed in case networks have been pre-configured for use with certain VNFs, for instance to ensure that these networks have certain properties such as security or acceleration features, or to address particular network topologies. The present document assumes that xternally-managed internal VLs are managed by the NFVO and created towards the VIM. It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData 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.27)." }, "additionalParams": { "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." }, "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." } }, "description": "The type represents the information that is requested to be changed deployment flavor for an existing VNF instance. It shall comply with the provisions defined in Table 6.5.3.25-1." }, "description": "Identifies the new DF of the VNF instance to be changed to. It shall be present only if updateType = \"CHANGE_VNF_DF\"." }, "operateVnfData": { "type": "array", "items": { "title": "OperateVnfDatum", "required": [ "vnfInstanceId", "changeStateTo" ], "type": "object", "properties": { "vnfInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "changeStateTo": { "title": "ChangeStateTo", "enum": [ "STARTED", "STOPPED" ], "type": "string", "description": "STARTED - The VNF instance is up and running. STOPPED - The VNF instance has been shut down.", "example": "STARTED" }, "stopType": { "title": "StopType", "enum": [ "FORCEFUL", "GRACEFUL" ], "type": "string", "description": "* FORCEFUL: The VNFM will stop the VNF immediately after accepting the\n request.\n* GRACEFUL: The VNFM will first arrange to take the VNF out of service\n after accepting the request. Once that operation is successful or once\n the timer value specified in the \"gracefulStopTimeout\" attribute\n expires, the VNFM will stop the VNF.", "example": "FORCEFUL" }, "gracefulStopTimeout": { "type": "integer", "description": "The time interval (in seconds) to wait for the VNF to be taken out of service during graceful stop, before stopping the VNF." }, "additionalParam": { "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 for which the operational state needs to be changed and the requested new state. It shall comply with the provisions defined in Table 6.5.3.31-1." }, "description": "Identifies the state of the VNF instance to be changed. It shall be present only if updateType = \"OPERATE_VNF\"." }, "modifyVnfInfoData": { "type": "array", "items": { "title": "ModifyVnfInfoDatum", "required": [ "vnfInstanceId" ], "type": "object", "properties": { "vnfInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "vnfInstanceName": { "type": "string", "description": "New value of the \"vnfInstanceName\" attribute in \"VnfInstance\", or \"null\" to remove the attribute." }, "vnfInstanceDescription": { "type": "string", "description": "New value of the \"vnfInstanceDescription\" attribute in \"VnfInstance\", or \"null\" to remove the attribute." }, "vnfdId": { "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." }, "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 the information that is requested to be modified for a VNF instance. The information to be modified shall comply with the associated NSD. EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD." }, "description": "Identifies the VNF information parameters and/or the configurable properties of VNF instance to be modified. It shall be present only if updateType = \"MODIFY_VNF_INFORMATION\"." }, "changeExtVnfConnectivityData": { "type": "array", "items": { "title": "ChangeExtVnfConnectivityDatum", "required": [ "vnfInstanceId", "extVirtualLinks" ], "type": "object", "properties": { "vnfInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "extVirtualLinks": { "type": "array", "items": { "title": "ExtVirtualLink", "required": [ "resourceId", "extCps" ], "type": "object", "properties": { "extVirtualLinkId": { "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." }, "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." }, "extCps": { "type": "array", "items": { "title": "ExtCp", "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": "External CPs of the VNF to be connected to this external VL." }, "extLinkPorts": { "type": "array", "items": { "title": "ExtLinkPort3", "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." } }, "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL." }, "description": "Externally provided link ports to be used to connect external connection points to this external VL." } }, "description": "This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1." }, "description": "Information about external VLs to change (e.g. connect the VNF to)." }, "additionalParams": { "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 describes the information invoked by the NFVO to change the external VNF connectivity information maintained by the VNFM. The types of changes that this operation supports are: 1) Disconnect the external CPs that are connected to a particular external VL, and connect them to a different\n external VL.\n2) Disconnect and delete external CPs that are connected to a particular external VL and that represent subports\n in a trunk, i.e. CP instances that are created from external CPDs that have trunk mode configured according to\n clause 7.1.6.3 in ETSI GS NFV-IFA 011. If the parent port is exposed as an \"extCp\", the VNFM shall ensure that\n the parent port is not deleted. If the parent port is exposed as an \"extCp\" and there are other subports connected,\n the VNFM shall ensure that the parent port is not disconnected, unless it is reconnected to a different external\n VL in the same operation.\n3) Change the connectivity parameters of the existing external CPs, including changing addresses.\nNOTE:\tDepending on the capabilities of the underlying VIM resources, certain changes (e.g. modifying the IP address\n assignment) might not be supported without deleting the resource and creating another one with the modified\n configuration.\n\n4) Create new CPs that represent supports in a trunk, i.e. CP instances that are created from external CPDs that\n have trunk mode configured according to clause 7.1.6.3 in ETSI GS NFV-IFA 011, and connect them to a particular\n external VL. Creation of the parent port with this operation is not supported. This type shall comply with the\n provisions defined in Table 6.5.3.33-1." }, "description": "Specifies the new external connectivity data of the VNF instance to be changed. It shall be present only if updateType = \"CHANGE_EXTERNAL_VNF_CONNECTIVITY\"." }, "changeVnfPackageData": { "type": "array", "items": { "title": "ChangeVnfPackageDatum", "required": [ "vnfInstanceId", "vnfdId" ], "type": "object", "properties": { "vnfInstanceId": { "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." }, "extVirtualLinks": { "type": "array", "items": { "title": "ExtVirtualLink", "required": [ "resourceId", "extCps" ], "type": "object", "properties": { "extVirtualLinkId": { "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." }, "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." }, "extCps": { "type": "array", "items": { "title": "ExtCp", "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": "External CPs of the VNF to be connected to this external VL." }, "extLinkPorts": { "type": "array", "items": { "title": "ExtLinkPort3", "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." } }, "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL." }, "description": "Externally provided link ports to be used to connect external connection points to this external VL." } }, "description": "This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1." }, "description": "Information about external VLs to connect the VNF to. Entries in the list that are unchanged need not be supplied as part of this request." }, "extManagedVirtualLinks": { "type": "array", "items": { "title": "ExtManagedVirtualLink", "required": [ "vnfVirtualLinkDescId", "resourceId" ], "type": "object", "properties": { "extManagedVirtualLinkId": { "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." }, "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." }, "vnfLinkPort": { "type": "array", "items": { "title": "VnfLinkPort6", "required": [ "vnfLinkPortId", "resourceHandle" ], "type": "object", "properties": { "vnfLinkPortId": { "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." } }, "description": "This type represents an externally provided link port to be used to connect a VNFC connection point to an externally-managed VL. It shall comply with the provisions defined in table 6.5.3.78-1." }, "description": "Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL on this network resource. If this attribute is not present, the VNFM shall create the link ports on the externally-managed VL." }, "extManagedMultisiteVirtualLinkId": { "type": "string", "description": "An identifier with the intention of being globally unique." } }, "description": "This type represents an externally-managed internal VL. It shall comply with the provisions defined in Table 6.5.3.27-1." }, "description": "Information about internal VLs that are managed by the NFVO." }, "additionalParams": { "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." }, "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." } }, "description": "This type specifies the information needed to change the current VNF package for a VNF instance. Clause B.3 of the\nETSI GS NFV-IFA 007 illustrates the variants of changes to the current VNF Package and information flow procedures.\nThis operation encompasses the following scenarios:\n*\tChanges of the VNF virtualised resources, such as requirements, composition and structure between the VNF versions,\n without changing the VNF software version.\n*\tChanges of both the VNF software version and the VNF virtualised resources. This case includes replacing the VNF\n software version by means of virtualised resources management, such as terminating the current virtualized resource\n instances running the current software version and instantiating new virtualized resource instances with the\n destination VNF software version. The new virtualized resource instances may have the same characteristics as the\n current virtualized resource instances.\n*\tChanges related to the VNFD, such as correction of bugs in the VNFD, changes in the naming scheme of VNFD components\n (e.g. name of the VDU, vduId), and adding/removing descriptors of VNF Package changes (VnfPackageChangeInfo).\nNOTE:\tFor software updates that are executed by functional entities outside NFV-MANO and that require synchronization\n of the information held by the NFV-MANO entities with a new VNF package that reflects the same changes, an\n alternative procedure using the PATCH method on the \"Individual VNF instance\" resource has been defined, as\n illustrated in annex B.2 of ETSI GS NFV-IFA 007 [19]. This procedure assumes certain restrictions on the\n characteristics of the new VNF package, as defined in note 1 in table 5.5.2.2-1 of ETSI GS NFV-SOL 003.\nThis type shall comply with the provisions defined in Table 6.5.3.54-1." }, "description": "Specifies the details to change the VNF package on which the VNF instance is based. It shall be present only if updateType = \"CHANGE_VNFPKG\"." }, "addSap": { "type": "array", "items": { "title": "AddSap", "required": [ "sapdId", "sapName", "description" ], "type": "object", "properties": { "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." }, "description": { "type": "string", "description": "Human readable description for the SAP." }, "sapProtocolData": { "type": "array", "items": { "title": "SapProtocolDatum", "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 SAP." } }, "description": "This type represents the information related to a SAP of a NS. It shall comply with the provisions defined in Table 6.5.3.10-1." }, "description": "Identifies a new SAP to be added to the NS instance. It shall be present only if updateType = \"ADD_SAP.\"" }, "removeSapId": { "type": "array", "items": { "type": "string" }, "description": "The identifier an existing SAP to be removed from the NS instance. It shall be present only if updateType = \"REMOVE_SAP.\"" }, "addNestedNsData": { "type": "array", "items": { "title": "AddNestedNsDatum", "required": [ "nestedNsInstanceId" ], "type": "object", "properties": { "nestedNsInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "nsProfileId": { "type": "string", "description": "An identifier that is unique with respect to a NS. Representation: string of variable length." } }, "description": "This type specifies an existing nested NS instance to be used in the NS instance and if needed, the NsProfile to use for this nested NS instance. It shall comply with the provisions defined in Table 6.5.3.19a-1." }, "description": "The identifier of an existing nested NS instance to be added to (nested within) the NS instance. It shall be present only if updateType = \"ADD_NESTED_NS\"." }, "removeNestedNsId": { "type": "array", "items": { "type": "string" }, "description": "The identifier of an existing nested NS instance to be removed from the NS instance. It shall be present only if updateType = \"REMOVE_NESTED_NS\"." }, "assocNewNsdVersionData": { "title": "AssocNewNsdVersionData", "required": [ "newNsdId" ], "type": "object", "properties": { "newNsdId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "sync": { "type": "boolean", "description": "Specify whether the NS instance shall be automatically synchronized to the new NSD by the NFVO (in case of true value) or the NFVO shall not do any action (in case of a false value) and wait for further guidance from OSS/BSS (i.e. waiting for OSS/BSS to issue NS lifecycle management operation to explicitly add/remove VNFs and modify information of VNF instances according to the new NSD). The synchronization to the new NSD means e.g. instantiating/adding those VNFs whose VNFD is referenced by the new NSD version but not referenced by the old one, terminating/removing those VNFs whose VNFD is referenced by the old NSD version but not referenced by the new NSD version, modifying information of VNF instances to the new applicable VNFD provided in the new NSD version. A cardinality of 0 indicates that synchronization shall not be done." } }, "description": "This type specifies a new NSD version that is associated to the NS instance. After issuing the Update NS operation with updateType = \"AssocNewNsdVersion\", the NFVO shall use the referred NSD as a basis for the given NS instance. Different versions of the same NSD have same nsdInvariantId, but different nsdId attributes, therefore if the nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This data type shall comply with the provisions defined in Table 6.5.3.34-1." }, "moveVnfInstanceData": { "type": "array", "items": { "title": "MoveVnfInstanceDatum", "required": [ "targetNsInstanceId" ], "type": "object", "properties": { "targetNsInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "vnfInstanceId": { "type": "array", "items": { "type": "string" }, "description": "Specify the VNF instance that is moved." } }, "description": "This type specifies existing VNF instances to be moved from one NS instance (source) to another NS instance (destination). The NS instance defined in the Update NS operation indicates the source NS instance and the destination NS instance is specified in this data type (referred to targetNsInstanceId). It shall comply with the provisions defined in Table 6.5.3.35-1." }, "description": "Specify existing VNF instance to be moved from one NS instance to another NS instance. It shall be present only if updateType = MOVE_VNF\"." }, "addVnffg": { "type": "array", "items": { "title": "AddVnffg", "required": [ "vnffgName", "description" ], "type": "object", "properties": { "targetNsInstanceId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "vnffgName": { "type": "string", "description": "Human readable name for the VNFFG." }, "description": { "type": "string", "description": "Human readable description for the VNFFG." } }, "description": "This type specifies the parameters used for the creation of a new VNFFG instance. It shall comply with the provisions defined in Table 6.5.3.36-1." }, "description": "Specify the new VNFFG to be created to the NS Instance. It shall be present only if updateType = \"ADD_VNFFG\"." }, "removeVnffgId": { "type": "array", "items": { "type": "string" }, "description": "Identifier of an existing VNFFG to be removed from the NS Instance. It shall be present only if updateType = \"REMOVE_VNFFG\"." }, "updateVnffg": { "type": "array", "items": { "title": "UpdateVnffg", "required": [ "vnffgInfoId" ], "type": "object", "properties": { "vnffgInfoId": { "type": "string", "description": "An identifier that is unique with respect to a NS. Representation: string of variable length." }, "nfp": { "type": "array", "items": { "title": "Nfp", "type": "object", "properties": { "nfpInfoId": { "type": "string", "description": "An identifier that is unique with respect to a NS. Representation: string of variable length." }, "nfpName": { "type": "string", "description": "Human readable name for the NFP. It shall be present for the new NFP, and it may be present otherwise. It shall be present for the new NFP, and it may be present otherwise." }, "description": { "type": "string", "description": "Human readable description for the NFP. It shall be present for the new NFP, and it may be present otherwise. It shall be present for the new NFP, and it may be present otherwise." }, "cpGroup": { "type": "array", "items": { "title": "CpGroup", "type": "object", "properties": { "cpPairInfo": { "minItems": 1, "type": "array", "items": { "title": "CpPairInfo", "type": "object", "properties": { "vnfExtCpIds": { "maxItems": 2, "type": "array", "items": { "type": "string" }, "description": "Identifier(s) of the VNF CP(s) which form the pair. The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position." }, "pnfExtCpIds": { "maxItems": 2, "type": "array", "items": { "type": "string" }, "description": "Identifier(s) of the PNF CP(s) which form the pair. The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position." }, "sapIds": { "maxItems": 2, "type": "array", "items": { "type": "string" }, "description": "Identifier(s) of the SAP(s) which form the pair. The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position." } }, "description": "This type represents describes a pair of ingress and egress CPs or SAPs which the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1." }, "description": "One or more pair(s) of ingress and egress CPs or SAPs which the NFP passes by. All CP or SAP pairs in a group shall be instantiated from connection point descriptors or service access point descriptors referenced in the corresponding NfpPositionDesc." }, "forwardingBehaviour": { "title": "ForwardingBehaviour", "enum": [ "ALL", "LB" ], "type": "string", "description": "Identifies a rule to apply to forward traffic to the ingress CPs or SAPs of the group. Permitted values: * ALL = Traffic flows shall be forwarded simultaneously to all CPs or SAPs of the group. * LB = Traffic flows shall be forwarded to one CP or SAP of the group selected based on a loadbalancing algorithm.", "example": "ALL" }, "forwardingBehaviourInputParameters": { "title": "ForwardingBehaviourInputParameters", "type": "object", "properties": { "algortihmName": { "title": "AlgortihmName", "enum": [ "ROUND_ROBIN", "LEAST_CONNECTION", "LEAST_TRAFFIC", "LEAST_RESPONSE_TIME", "CHAINED_FAILOVER", "SOURCE_IP_HASH", "SOURCE_MAC_HASH" ], "type": "string", "description": "May be included if forwarding behaviour is equal to LB. Shall not be included otherwise. Permitted values: * ROUND_ROBIN * LEAST_CONNECTION * LEAST_TRAFFIC * LEAST_RESPONSE_TIME * CHAINED_FAILOVER * SOURCE_IP_HASH * SOURCE_MAC_HASH", "example": "ROUND_ROBIN" }, "algorithmWeights": { "type": "array", "items": { "type": "integer" }, "description": "Percentage of messages sent to a CP instance. May be included if applicable to the algorithm. If applicable to the algorithm but not provided, default values determined by the VIM or NFVI are expected to be used. Weight applies to the CP instances in the order they have been created." } }, "description": "This type represents provides input parameters to configure the forwarding behaviour. It shall comply with the provisions defined in Table 6.5.3.73-1." } }, "description": "This type represents describes a group of CPs and/or SAPs pairs associated to the same position in an NFP. It shall comply with the provisions defined in Table 6.5.3.71-1." }, "description": "Group(s) of CPs and/or SAPs which the NFP passes by. Cardinality can be 0 if only updated or newly created NFP classification and selection rule which applied to an existing NFP is provided. At least a CP or an nfpRule shall be present. When multiple identifiers are included, the position of the identifier in the cpGroup value specifies the position of the group in the path." }, "nfpRule": { "description": "The NfpRule data type is an expression of the conditions that shall be met in order for the NFP to be applicable to the packet. The condition acts as a flow classifier and it is met only if all the values expressed in the condition are matched by those in the packet. It shall comply with the provisions defined in Table 6.5.3.40-1." } }, "description": "This type contains information used to create or modify NFP instance parameters for the update of an existing VNFFG instance. It shall comply with the provisions defined in Table 6.5.3.38-1." }, "description": "Indicate the desired new NFP(s) for a given VNFFG after the operations of addition/removal of NS components (e.g. VNFs, VLs, etc.) have been completed, or indicate the updated or newly created NFP classification and selection rule which applied to an existing NFP." }, "nfpInfoId": { "type": "array", "items": { "type": "string" }, "description": "Identifier(s) of the NFP to be deleted from a given VNFFG." } }, "description": "This type specifies the parameters used for the update of an existing VNFFG instance. It shall comply with the provisions defined in Table 6.5.3.37-1." }, "description": "Specify the new VNFFG Information data to be updated for a VNFFG of the NS Instance. It shall be present only if updateType = \"UPDATE_VNFFG\"." }, "changeNsFlavourData": { "title": "ChangeNsFlavourData", "required": [ "newNsFlavourId" ], "type": "object", "properties": { "newNsFlavourId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "instantiationLevelId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." } }, "description": "This type specifies an existing NS instance for which the DF needs to be changed. This specifies the new DF, the instantiationLevel of the new DF that may be used and the additional parameters as input for the flavour change. It shall comply with the provisions defined in Table 6.5.3.39-1." }, "addPnfData": { "type": "array", "items": { "title": "AddpnfDatum", "required": [ "pnfId", "pnfName", "pnfdId", "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." }, "pnfProfileId": { "type": "string", "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length." }, "cpData": { "type": "array", "items": { "title": "CpDatum", "required": [ "cpProtocolData" ], "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": "Address assigned for this CP." } }, "description": "This type represents the configuration data on the external CP of the PNF. It shall comply with the provisions defined in Table 6.5.3.16-1." }, "description": "Address assigned for the PNF external CP(s)." } }, "description": "This type specifies an PNF to be added to the NS instance and the PNF Profile to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1." }, "description": "specifies the PNF to be added into the NS instance. It shall be present only if updateType = \"ADD_PNF\"." }, "modifyPnfData": { "type": "array", "items": {}, "description": "Specifies the PNF to be modified in the NS instance. It shall be present only if updateType = \"MODIFY_PNF\"." }, "removePnfId": { "type": "array", "items": { "type": "string" }, "description": "Identifier of the PNF to be deleted from the NS instance. It shall be present only if updateType = \"REMOVE_PNF\"." }, "modifyWanConnectionInfoData": { "type": "array", "items": { "title": "ModifyWanConnectionInfoDatum", "required": [ "wanConnectionInfoId" ], "type": "object", "properties": { "wanConnectionInfoId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "mscsName": { "type": "string", "description": "New value of the \"mscsName\" attribute in \"MscsInfo\", or \"null\" to remove the attribute." }, "mscsDescription": { "type": "string", "description": "New value of the \"mscsDescription\" attribute in \"MscsInfo\", or \"null\" to remove the attribute." }, "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": "New content of certain entries of MSCS endpoints in the \"mscsEndpoints\" attribute in \"MscsInfo\", as defined below this table." }, "removeMscsEndpointIds": { "type": "array", "items": { "type": "string" }, "description": "List of identifier entries to be deleted from the \"mscsEndpoints\" attribute array in \"MscsInfo\", to be used as \"deleteIdList\" as defined below this table." }, "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": "New content of certain entries of connectivity service endpoints in the \"connectivityServiceEndpointInfos\" attribute in \"WanConnectionProtocolInfo\", as defined below this table." }, "removeConnectivityServiceEndpoints": { "type": "array", "items": { "type": "string" }, "description": "List of identifier entries to be deleted from the \"connectivityServiceEndpointInfos\" attribute array in \"WanConnectionProtocolInfo\", to be used as \"deleteIdList\" as defined below this table." } }, "description": "This type represents attribute modifications for WAN connection information. The attributes of the \"WanConnectionInfo\" that can be modified according to the provisions of the \"UpdateNsRequest\" in clause 6.5.2.12 related to WAN connection information are included in the \"ModifyWanConnectionInfoData\" data type. It shall comply with the provisions defined in table 6.5.3.92-1." }, "description": "Specifies the data to modify about WAN related connectivity information. It shall be present only if updateType = \"MODIFY_WAN_CONNECTION_INFO\"." }, "updateTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339." }, "createSnapshotData": { "title": "CreateSnapshotData", "required": [ "vnfInstanceId" ], "type": "object", "properties": { "vnfInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "additionalParams": { "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." }, "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 the information that are needed for VNF snapshot creation. When the NFVO invokes the Create VNF snapshot operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with the provisions defined in Table 6.5.3.76-1." }, "revertVnfToSnapshotData": { "title": "RevertVnfToSnapshotData", "required": [ "vnfInstanceId", "vnfSnapshotInfoId" ], "type": "object", "properties": { "vnfInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "vnfSnapshotInfoId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "additionalParams": { "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 specifies the identifier of an existing VNF instance of the NS instance to be reverted and the identifier of an existing VNF Snapshot to be reverted to. It shall comply with the provisions defined in Table 6.5.3.75-1." }, "deleteVnfSnapshotData": { "title": "DeleteVnfSnapshotData", "required": [ "vnfInstanceId", "vnfSnapshotInfoId" ], "type": "object", "properties": { "vnfInstanceId": { "type": "string", "description": "An identifier with the intention of being globally unique." }, "vnfSnapshotInfoId": { "type": "string", "description": "An identifier with the intention of being globally unique." } }, "description": "This type specifies the identifier of information of an available VNF Snapshot to be deleted and the identifier of the related VNF instance of the NS instance. It shall comply with the provisions defined in Table 6.5.3.74-1." }, "addNsVirtualLinkData": { "type": "array", "items": { "title": "AddNsVirtualLinkDatum", "required": [ "nsVirtualLinkProfileId" ], "type": "object", "properties": { "nsVirtualLinkProfileId": { "type": "string", "description": "An identifier with the intention of being globally unique." } }, "description": "This type specifies the parameters used for the creation of a new NsVirtualLink instance. It shall comply with the provisions defined in table 6.5.3.95-1." }, "description": "Specify data to be used to create a new NsVirtualLink instance. This parameter shall be present only if updateType = “CREATE_NS_VIRTUAL_LINK”." }, "deleteNsVirtualLinkId": { "type": "array", "items": { "type": "string" }, "description": "Identify an existing NsVirtualLink instance to be deleted. The parameter shall be present only if updateType = “DELETE_NS_VIRTUAL_LINK”." } }, "description": "This operation supports the update of a NS instance, It shall comply with the provisions defined in Table 6.5.2.12-1." } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updatesaNSinstance" }, "task": true }, { "name": "healaNSinstance", "summary": "Heal a NS instance.", "description": "The POST method requests to heal an NS instance. This method shall follow the provisions specified in the Tables\n6.4.7.3.1-1 and 6.4.7.3.1-2 for URI query parameters, request and response data structures, and response codes.\nThe steps and conditions that apply as the result of successfully executing this method are specified in clause\n6.4.1.2.\n", "input": [ { "name": "nsInstanceId", "type": "string", "info": "Identifier of the NS instance.: string", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "Parameters for the heal NS operation, as defined in clause 6.5.2.13.: object", "required": true, "schema": { "description": "Parameters for the heal NS operation, as defined in clause 6.5.2.13." } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/healaNSinstance" }, "task": true }, { "name": "terminateaNSinstance", "summary": "Terminate a NS instance.", "description": "Terminate NS task. The POST method terminates an NS instance. This method shall follow the provisions specified\nin the Tables 6.4.8.3.1-1 and 6.4.8.3.1-2 for URI query parameters, request and response data structures, and\nresponse codes. The steps and conditions that apply as the result of successfully executing this method are\nspecified in clause 6.4.1.2. In addition, once the NFVO has successfully completed the underlying NS LCM operation\noccurrence, it shall set the \"nsState\" attribute in t...(description truncated)", "input": [ { "name": "nsInstanceId", "type": "string", "info": "Identifier of the NS instance.: string", "required": true, "schema": { "title": "nsInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "The terminate NS request parameters, as defined in clause 6.5.2.15.: {\"terminationTime\": \"undefined\"}", "required": true, "schema": { "title": "NsInstancesTerminateRequest", "type": "object", "properties": { "terminationTime": { "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339." } }, "description": "This type represents a NS termination request. It shall comply with the provisions defined in Table 6.5.2.15-1." } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/terminateaNSinstance" }, "task": true }, { "name": "querymultipleNSLCMoperationoccurrences", "summary": "Query multiple NS LCM operation occurrences.", "description": "Get Operation Status. Shall be returned upon the following error: The operation cannot be executed currently,\ndue to a conflict with the state of the resource. Typically, this is due to the fact that the NS instance resource\nis in NOT_INSTANTIATED state, or that another lifecycle management operation is ongoing. The response body shall\ncontain a ProblemDetails structure, in which the \"detail\" attribute shall convey more information about the error.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "fields", "type": "string", "info": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "type": "string", "info": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "type": "string", "info": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support t...(description truncated): string", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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": "" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/querymultipleNSLCMoperationoccurrences" }, "task": true }, { "name": "readanindividualNSLCMoperationoccurrenceresource", "summary": "Read an individual NS LCM operation occurrence resource.", "description": "The API consumer can use this method to read status information about a NS lifecycle management operation\noccurrence by reading an individual \"NS LCM operation occurrence\" resource. This method shall follow the provisions\nspecified in the Tables 6.4.10.3.2-1 and 6.4.10.3.2-2 for URI query parameters, request and response data structures,\nand response codes.\n", "input": [ { "name": "nsLcmOpOccId", "type": "string", "info": "Identifier of a NS lifecycle management operation occurrence.: string", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/readanindividualNSLCMoperationoccurrenceresource" }, "task": true }, { "name": "retryaNSlifecyclemanagementoperationoccurrence", "summary": "Retry a NS lifecycle management operation occurrence.", "description": "The POST method initiates retrying a NS lifecycle management operation if that operation has experienced a\ntemporary failure, i.e. the related \"NS LCM operation occurrence\" is in \"FAILED_TEMP\" state. This method shall\nfollow the provisions specified in the Tables 6.4.11.3.1-1 and 6.4.11.3.1-2 for URI query parameters, request\nand response data structures, and response codes.\n", "input": [ { "name": "nsLcmOpOccId", "type": "string", "info": "Identifier of a NS lifecycle management operation occurrence.: string", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/retryaNSlifecyclemanagementoperationoccurrence" }, "task": true }, { "name": "rollbackaNSlifecyclemanagementoperationoccurrence", "summary": "Rollback a NS lifecycle management operation occurrence.", "description": "The POST method initiates rolling back a NS lifecycle operation if that operation has experienced a temporary\nfailure, i.e. the related \"NS LCM operation occurrence\" is in \"FAILED_TEMP\" state. This method shall follow the\nprovisions specified in the Tables 6.4.12.3.1-1 and 6.4.12.3.1-2 for URI query parameters, request and response\ndata structures, and response codes.\n", "input": [ { "name": "nsLcmOpOccId", "type": "string", "info": "Identifier of a NS lifecycle management operation occurrence.: string", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rollbackaNSlifecyclemanagementoperationoccurrence" }, "task": true }, { "name": "continueaNSlifecyclemanagementoperationoccurrence", "summary": "Continue a NS lifecycle management operation occurrence.", "description": "The POST method initiates continuing an NS lifecycle operation if that operation has experienced a temporary\nfailure, i.e. the related \"NS LCM operation occurrence\" is in \"FAILED_TEMP\" state. This method shall follow the\nprovisions specified in the Tables 6.4.13.3.1-1 and 6.4.13.3.1-2 for URI query parameters, request and response\ndata structures, and response codes.\n", "input": [ { "name": "nsLcmOpOccId", "type": "string", "info": "Identifier of a NS lifecycle management operation occurrence.: string", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/continueaNSlifecyclemanagementoperationoccurrence" }, "task": true }, { "name": "markaNSlifecyclemanagementoperationoccurrenceasfailed", "summary": "Mark a NS lifecycle management operation occurrence as failed.", "description": "The POST method marks a NS lifecycle management operation occurrence as \"finally failed\" if that operation\noccurrence is in \"FAILED_TEMP\" state.\n", "input": [ { "name": "nsLcmOpOccId", "type": "string", "info": "Identifier of a NS lifecycle management operation occurrence.: string", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/markaNSlifecyclemanagementoperationoccurrenceasfailed" }, "task": true }, { "name": "cancelaNSlifecyclemanagementoperationoccurrence", "summary": "Cancel a NS lifecycle management operation occurrence.", "description": "The POST method initiates cancelling an ongoing NS lifecycle management operation while it is being executed or\nrolled back, i.e. the related NS LCM operation occurrence\\\" is either in \"PROCESSING\" or \"ROLLING_BACK\" state.\nThis method shall follow the provisions specified in the Tables 6.4.15.3.1-1 and 6.4.15.3.1-2 for URI query\nparameters, request and response data structures, and response codes. Before returning the \"202 Accepted\" response,\nthe NFVO shall update the \"isCancelPending\" and \"canc...(description truncated)", "input": [ { "name": "nsLcmOpOccId", "type": "string", "info": "Identifier of a NS lifecycle management operation occurrence.: string", "required": true, "schema": { "title": "nsLcmOpOccId", "type": "string" } }, { "name": "body", "type": "object", "info": "The POST request to this resource shall include a CancelMode structure in the payload body to choose between\n\"graceful\" and \"forceful\" cancellation.: {\"cancelMode\": \"Must be one of [GRACEFUL, FORCEFUL]\"}", "required": true, "schema": { "title": "NslcmV1NsLcmOpOccsCancelRequest", "required": [ "cancelMode" ], "type": "object", "properties": { "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" } }, "description": "This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence. It shall comply with the provisions defined in Table 6.5.2.16-1." } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelaNSlifecyclemanagementoperationoccurrence" }, "task": true }, { "name": "queryVNFsnapshots", "summary": "Query VNF snapshots", "description": "The GET method queries information about multiple VNF snapshots.\n", "input": [ { "name": "filter", "type": "string", "info": "Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support receiving this parameter as part of the ...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "allFields", "type": "string", "info": "Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support this parameter.: string", "required": false, "schema": { "title": "allFields", "type": "string" } }, { "name": "fields", "type": "string", "info": "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "excludeFields", "type": "string", "info": "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity should support this parameter.: string", "required": false, "schema": { "title": "excludeFields", "type": "string" } }, { "name": "excludeDefault", "type": "string", "info": "Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity shall support t...(description truncated): string", "required": false, "schema": { "title": "excludeDefault", "type": "string" } }, { "name": "nextpageOpaqueMarker", "type": "string", "info": "Marker to obtain the next page of a paged response. Shall be supported by the NFV-MANO functional entity if the entity supports alternative 2 (paging) according to clause...(description truncated): string", "required": false, "schema": { "title": "nextpageOpaqueMarker", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "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": "" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/queryVNFsnapshots" }, "task": true }, { "name": "queryanIndividualVNFsnapshot", "summary": "Query an Individual VNF snapshot", "description": "The GET method retrieves information about a VNF snapshot by reading an \"Individual VNF snapshot\" resource.\n", "input": [ { "name": "vnfSnapshotInfoId", "type": "string", "info": "Identifier of the \"Individual VNF snapshot\" resource.\nThis identifier can be retrieved from the \"id\" attribute in the payload body of a response to a query to\n\"VNF snapsh...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/queryanIndividualVNFsnapshot" }, "task": true }, { "name": "deleteanIndividualVNFsnapshot", "summary": "Delete an Individual VNF snapshot", "description": "This method deletes an \"Individual VNF snapshot\" resource and the associated VNF snapshot information managed by\nthe NFVO and corresponding VNFM, and any resource associated to the VNF snapshot managed by the VIM.\nAs the result of successfully executing this method, the \"Individual VNF snapshot\" resource shall not exist any\nlonger. In addition, the NFVO shall delete any references pointing to the \"Individual VNF snapshot\" resource from\nthe \"NsInstance\" data structures representing the \"Individua...(description truncated)", "input": [ { "name": "vnfSnapshotInfoId", "type": "string", "info": "Identifier of the \"Individual VNF snapshot\" resource.\nThis identifier can be retrieved from the \"id\" attribute in the payload body of a response to a query to\n\"VNF snapsh...(description truncated): string", "required": true, "schema": { "title": "vnfSnapshotInfoId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteanIndividualVNFsnapshot" }, "task": true } ], "views": [] }