{ "info": { "_postman_id": "3ec71b17-e183-4c00-a9f0-cb267f61258d", "name": "SOL003 - VNF Package Management interface", "description": "SOL003 - VNF Package Management interface\n\nIMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.\n\nIn clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes to the attribute-based filtering mechanism are being considered in v2.5.1 of this GS for inclusion in the corresponding future ETSI NFV OpenAPI design.\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "subscriptions", "description": "Folder for subscriptions", "item": [ { "name": "get single subscription", "event": [ { "listen": "test", "script": { "id": "cf67f3df-72a3-442f-8b8d-2e79183906e0", "type": "text/javascript", "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "var res_schema = {\"description\":\"This type represents a subscription related to notifications about VNF package management. \",\"type\":\"object\",\"required\":[\"id\",\"callbackUri\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"filter\":{\"description\":\"This type represents a subscription filter related to notifications related to VNF package management. 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). \",\"type\":\"object\",\"properties\":{\"notificationTypes\":{\"description\":\"Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \\\"notificationTypes\\\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. \",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"VnfPackageOnboardingNotification\",\"VnfPackageChangeNotification\"]}},\"vnfProductsFromProviders\":{\"description\":\"If present, match VNF packages that contain VNF products from certain providers. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProvider\"],\"properties\":{\"vnfProvider\":{\"description\":\"Name of the VNF provider to match. \",\"type\":\"string\"},\"vnfProducts\":{\"description\":\"If present, match VNF packages that contain VNF products with certain product names, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProductName\"],\"properties\":{\"vnfProductName\":{\"description\":\"Name of the VNF product to match. \",\"type\":\"string\"},\"versions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfSoftwareVersion\"],\"properties\":{\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"description\":\"A Version. \",\"type\":\"string\"}}}}}}}}}}},\"vnfdId\":{\"description\":\"Match VNF packages with a VNFD identifier listed in the attribute. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"vnfPkgId\":{\"description\":\"Match VNF packages with a package identifier listed in the attribute. May be present if the \\\"notificationTypes\\\" attribute contains the value \\\"VnfPackageChangeNotification\\\", and shall be absent otherwise. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"}}},\"callbackUri\":{\"description\":\"String formatted according to IETF RFC 3986. \",\"type\":\"string\"},\"_links\":{\"description\":\"Links to resources related to this resource. \",\"type\":\"object\",\"required\":[\"self\"],\"properties\":{\"self\":{\"description\":\"This type represents a link to a resource. \",\"type\":\"object\",\"required\":[\"href\"],\"properties\":{\"href\":{\"description\":\"URI of the referenced resource. \",\"type\":\"string\",\"format\":\"url\"}}}}}}};", "", "pm.test('Schema is valid', function() {", " pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;", "});", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "{{Accept}}" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": {}, "url": { "raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/subscriptions/{{subscriptionId}}", "protocol": "{{scheme}}", "host": [ "{{host}}{{port}}" ], "path": [ "{{uri_prefix}}vnfpkgm", "v1", "subscriptions", "{{subscriptionId}}" ] }, "description": "The GET method reads an individual subscription.\n" }, "response": [] }, { "name": "delete subscription", "event": [ { "listen": "test", "script": { "id": "1dc0a771-37e3-4013-938e-91ccd6da1d4a", "type": "text/javascript", "exec": [ "pm.test(\"Status code is 204\", function () {", " pm.response.to.have.status(204);", "});" ] } } ], "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": {}, "url": { "raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/subscriptions/{{subscriptionId}}", "protocol": "{{scheme}}", "host": [ "{{host}}{{port}}" ], "path": [ "{{uri_prefix}}vnfpkgm", "v1", "subscriptions", "{{subscriptionId}}" ] }, "description": "The DELETE method terminates an individual subscription.\n" }, "response": [] }, { "name": "create subscription", "event": [ { "listen": "test", "script": { "id": "1f636ad7-60ae-474e-83cf-5de8865b0ed4", "type": "text/javascript", "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "var res_schema = {\"type\":\"array\",\"items\":{\"description\":\"This type represents a subscription related to notifications about VNF package management. \",\"type\":\"object\",\"required\":[\"id\",\"callbackUri\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"filter\":{\"description\":\"This type represents a subscription filter related to notifications related to VNF package management. 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). \",\"type\":\"object\",\"properties\":{\"notificationTypes\":{\"description\":\"Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \\\"notificationTypes\\\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. \",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"VnfPackageOnboardingNotification\",\"VnfPackageChangeNotification\"]}},\"vnfProductsFromProviders\":{\"description\":\"If present, match VNF packages that contain VNF products from certain providers. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProvider\"],\"properties\":{\"vnfProvider\":{\"description\":\"Name of the VNF provider to match. \",\"type\":\"string\"},\"vnfProducts\":{\"description\":\"If present, match VNF packages that contain VNF products with certain product names, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProductName\"],\"properties\":{\"vnfProductName\":{\"description\":\"Name of the VNF product to match. \",\"type\":\"string\"},\"versions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfSoftwareVersion\"],\"properties\":{\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"description\":\"A Version. \",\"type\":\"string\"}}}}}}}}}}},\"vnfdId\":{\"description\":\"Match VNF packages with a VNFD identifier listed in the attribute. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"vnfPkgId\":{\"description\":\"Match VNF packages with a package identifier listed in the attribute. May be present if the \\\"notificationTypes\\\" attribute contains the value \\\"VnfPackageChangeNotification\\\", and shall be absent otherwise. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"}}},\"callbackUri\":{\"description\":\"String formatted according to IETF RFC 3986. \",\"type\":\"string\"},\"_links\":{\"description\":\"Links to resources related to this resource. \",\"type\":\"object\",\"required\":[\"self\"],\"properties\":{\"self\":{\"description\":\"This type represents a link to a resource. \",\"type\":\"object\",\"required\":[\"href\"],\"properties\":{\"href\":{\"description\":\"URI of the referenced resource. \",\"type\":\"string\",\"format\":\"url\"}}}}}}}};", "", "pm.test('Schema is valid', function() {", " pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;", "});", "" ] } } ], "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "{{Accept}}" }, { "key": "Authorization", "value": "{{Authorization}}" }, { "key": "Content-Type", "value": "{{Content-Type}}" } ], "body": { "mode": "raw", "raw": "Representation of the created subscription resource. The HTTP response shall include a \"Location\" HTTP header that points to the created subscription resource.\n" }, "url": { "raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/subscriptions", "protocol": "{{scheme}}", "host": [ "{{host}}{{port}}" ], "path": [ "{{uri_prefix}}vnfpkgm", "v1", "subscriptions" ] }, "description": "The POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the VNFM, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the same filter and callbackUri already exists (in which case it shall return the “201 Created” response code), or may decide to not create a duplicate subscription resource (in which case it shall return a “303 See Other” response code referencing the existing subscription resource with the same filter and callbackUri).\n" }, "response": [] }, { "name": "get subscriptions", "event": [ { "listen": "test", "script": { "id": "4e29d1a0-eddd-4608-a3b8-f971ca651702", "type": "text/javascript", "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "var res_schema = {\"type\":\"array\",\"items\":{\"description\":\"This type represents a subscription related to notifications about VNF package management. \",\"type\":\"object\",\"required\":[\"id\",\"callbackUri\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"filter\":{\"description\":\"This type represents a subscription filter related to notifications related to VNF package management. 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). \",\"type\":\"object\",\"properties\":{\"notificationTypes\":{\"description\":\"Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \\\"notificationTypes\\\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. \",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"VnfPackageOnboardingNotification\",\"VnfPackageChangeNotification\"]}},\"vnfProductsFromProviders\":{\"description\":\"If present, match VNF packages that contain VNF products from certain providers. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProvider\"],\"properties\":{\"vnfProvider\":{\"description\":\"Name of the VNF provider to match. \",\"type\":\"string\"},\"vnfProducts\":{\"description\":\"If present, match VNF packages that contain VNF products with certain product names, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfProductName\"],\"properties\":{\"vnfProductName\":{\"description\":\"Name of the VNF product to match. \",\"type\":\"string\"},\"versions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"vnfSoftwareVersion\"],\"properties\":{\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersions\":{\"description\":\"If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider. \",\"type\":\"array\",\"items\":{\"description\":\"A Version. \",\"type\":\"string\"}}}}}}}}}}},\"vnfdId\":{\"description\":\"Match VNF packages with a VNFD identifier listed in the attribute. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"vnfPkgId\":{\"description\":\"Match VNF packages with a package identifier listed in the attribute. May be present if the \\\"notificationTypes\\\" attribute contains the value \\\"VnfPackageChangeNotification\\\", and shall be absent otherwise. The attributes \\\"vnfProductsFromProviders\\\", \\\"vnfdId\\\" and \\\"vnfPkgId\\\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. \",\"type\":\"array\",\"items\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"}},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"}}},\"callbackUri\":{\"description\":\"String formatted according to IETF RFC 3986. \",\"type\":\"string\"},\"_links\":{\"description\":\"Links to resources related to this resource. \",\"type\":\"object\",\"required\":[\"self\"],\"properties\":{\"self\":{\"description\":\"This type represents a link to a resource. \",\"type\":\"object\",\"required\":[\"href\"],\"properties\":{\"href\":{\"description\":\"URI of the referenced resource. \",\"type\":\"string\",\"format\":\"url\"}}}}}}}};", "", "pm.test('Schema is valid', function() {", " pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;", "});", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "{{Accept}}" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": {}, "url": { "raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/subscriptions", "protocol": "{{scheme}}", "host": [ "{{host}}{{port}}" ], "path": [ "{{uri_prefix}}vnfpkgm", "v1", "subscriptions" ] }, "description": "The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations.\n" }, "response": [] } ] }, { "name": "vnf_packages", "description": "Folder for vnf_packages", "item": [ { "name": "Fetch On-boarded VNF Package Artifacts", "event": [ { "listen": "test", "script": { "id": "9892ef77-e8e4-4cee-af70-9b92b152d923", "type": "text/javascript", "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "{{Accept}}" }, { "key": "Authorization", "value": "{{Authorization}}" }, { "key": "Range", "value": "{{Range}}" } ], "body": {}, "url": { "raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/artifacts/{{artifactPath}}", "protocol": "{{scheme}}", "host": [ "{{host}}{{port}}" ], "path": [ "{{uri_prefix}}vnfpkgm", "v1", "vnf_packages", "{{vnfPkgId}}", "artifacts", "{{artifactPath}}" ] }, "description": "The GET method fetches the content of an artifact within a VNF package.\n" }, "response": [] }, { "name": "Read on-boarded single VNF package information", "event": [ { "listen": "test", "script": { "id": "7ad41a8d-8b92-4cce-b810-450085c6139a", "type": "text/javascript", "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "var res_schema = {\"description\":\"This type represents the information of an VNF package. \",\"type\":\"object\",\"required\":[\"id\",\"operationalState\",\"usageState\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"vnfdId\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"vnfProvider\":{\"description\":\"Provider of the VNF package and the VNFD. This information is copied from the VNFD. \",\"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. \",\"type\":\"string\"},\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"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. \",\"type\":\"array\",\"items\":{\"description\":\"This type represents an artifact contained in a VNF package which represents a software image. \",\"type\":\"object\",\"required\":[\"id\",\"name\",\"provider\",\"version\",\"checksum\",\"containerFormat\",\"diskFormat\",\"createdAt\",\"minDisk\",\"minRam\",\"size\",\"imagePath\"],\"properties\":{\"id\":{\"description\":\"An identifier that is unique within a VNF descriptor. \",\"type\":\"string\"},\"name\":{\"description\":\"Name of the software image. \",\"type\":\"string\"},\"provider\":{\"description\":\"Provider of the software image. \",\"type\":\"string\"},\"version\":{\"description\":\"A Version. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"type\":\"string\"}}},\"containerFormat\":{\"description\":\"Container format indicates whether the software image is in a file format that also contains metadata about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format The list of permitted values was taken from \\\"Container formats\\\" in http://docs.openstack.org/image-guide/image-formats.html \",\"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 The list of permitted values was adapted from \\\"Disk formats\\\" in http://docs.openstack.org/image-guide/image-formats.html \",\"type\":\"string\",\"enum\":[\"AKI\",\"AMI\",\"ISO\",\"QCOW2\",\"RAW\",\"VDI\",\"VHD\",\"VHDX\",\"VMDK\"]},\"createdAt\":{\"description\":\"Date-time stamp. Representation: String formatted according to IETF RFC 3339. \",\"type\":\"string\",\"format\":\"date-time\"},\"minDisk\":{\"description\":\"The minimal disk for this software image in bytes. \",\"type\":\"integer\"},\"minRam\":{\"description\":\"The minimal RAM for this software image in bytes. \",\"type\":\"integer\"},\"size\":{\"description\":\"Size of this software image in bytes. \",\"type\":\"integer\"},\"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. \",\"type\":\"object\"},\"imagePath\":{\"description\":\"Path in the VNF package, which identifies the image artifact and also allows to access a copy of the image artifact. \",\"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. \",\"type\":\"array\",\"items\":{\"description\":\"This type represents an artifact other than a software image which is contained in a VNF package. \",\"type\":\"object\",\"required\":[\"artifactPath\",\"checksum\"],\"properties\":{\"artifactPath\":{\"description\":\"Path in the VNF package, which identifies the artifact and also allows to access a copy of the artifact. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"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. \",\"type\":\"object\"}}}},\"onboardingState\":{\"description\":\"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 has been successfully on-boarded. \",\"type\":\"string\",\"enum\":[\"CREATED\",\"UPLOADING\",\"PROCESSING\",\"ONBOARDED\"]},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"},\"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. \",\"type\":\"object\"},\"_links\":{\"description\":\"Links to resources related to this resource. \",\"type\":\"object\",\"required\":[\"self\",\"packageContent\"],\"properties\":{\"self\":{\"description\":\"This type represents a link to a resource. \",\"type\":\"object\",\"required\":[\"href\"],\"properties\":{\"href\":{\"description\":\"URI of the referenced resource. \",\"type\":\"string\",\"format\":\"url\"}}},\"vnfd\":{\"description\":\"This type represents a link to a resource. \",\"type\":\"object\",\"required\":[\"href\"],\"properties\":{\"href\":{\"description\":\"URI of the referenced resource. \",\"type\":\"string\",\"format\":\"url\"}}},\"packageContent\":{\"description\":\"This type represents a link to a resource. \",\"type\":\"object\",\"required\":[\"href\"],\"properties\":{\"href\":{\"description\":\"URI of the referenced resource. \",\"type\":\"string\",\"format\":\"url\"}}}}}}};", "", "pm.test('Schema is valid', function() {", " pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;", "});", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "{{Accept}}" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": {}, "url": { "raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages/{{vnfPkgId}}", "protocol": "{{scheme}}", "host": [ "{{host}}{{port}}" ], "path": [ "{{uri_prefix}}vnfpkgm", "v1", "vnf_packages", "{{vnfPkgId}}" ] }, "description": "The GET method reads the information of an individual VNF package.\n" }, "response": [] }, { "name": "Query On-boarded VNF Packages", "event": [ { "listen": "test", "script": { "id": "b5c38be6-04d6-4ef3-812f-4b76d8149528", "type": "text/javascript", "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "var res_schema = {\"type\":\"array\",\"items\":{\"description\":\"This type represents the information of an VNF package. \",\"type\":\"object\",\"required\":[\"id\",\"operationalState\",\"usageState\",\"_links\"],\"properties\":{\"id\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"vnfdId\":{\"description\":\"An identifier with the intention of being globally unique. \",\"type\":\"string\"},\"vnfProvider\":{\"description\":\"Provider of the VNF package and the VNFD. This information is copied from the VNFD. \",\"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. \",\"type\":\"string\"},\"vnfSoftwareVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"vnfdVersion\":{\"description\":\"A Version. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"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. \",\"type\":\"array\",\"items\":{\"description\":\"This type represents an artifact contained in a VNF package which represents a software image. \",\"type\":\"object\",\"required\":[\"id\",\"name\",\"provider\",\"version\",\"checksum\",\"containerFormat\",\"diskFormat\",\"createdAt\",\"minDisk\",\"minRam\",\"size\",\"imagePath\"],\"properties\":{\"id\":{\"description\":\"An identifier that is unique within a VNF descriptor. \",\"type\":\"string\"},\"name\":{\"description\":\"Name of the software image. \",\"type\":\"string\"},\"provider\":{\"description\":\"Provider of the software image. \",\"type\":\"string\"},\"version\":{\"description\":\"A Version. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"type\":\"string\"}}},\"containerFormat\":{\"description\":\"Container format indicates whether the software image is in a file format that also contains metadata about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format The list of permitted values was taken from \\\"Container formats\\\" in http://docs.openstack.org/image-guide/image-formats.html \",\"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 The list of permitted values was adapted from \\\"Disk formats\\\" in http://docs.openstack.org/image-guide/image-formats.html \",\"type\":\"string\",\"enum\":[\"AKI\",\"AMI\",\"ISO\",\"QCOW2\",\"RAW\",\"VDI\",\"VHD\",\"VHDX\",\"VMDK\"]},\"createdAt\":{\"description\":\"Date-time stamp. Representation: String formatted according to IETF RFC 3339. \",\"type\":\"string\",\"format\":\"date-time\"},\"minDisk\":{\"description\":\"The minimal disk for this software image in bytes. \",\"type\":\"integer\"},\"minRam\":{\"description\":\"The minimal RAM for this software image in bytes. \",\"type\":\"integer\"},\"size\":{\"description\":\"Size of this software image in bytes. \",\"type\":\"integer\"},\"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. \",\"type\":\"object\"},\"imagePath\":{\"description\":\"Path in the VNF package, which identifies the image artifact and also allows to access a copy of the image artifact. \",\"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. \",\"type\":\"array\",\"items\":{\"description\":\"This type represents an artifact other than a software image which is contained in a VNF package. \",\"type\":\"object\",\"required\":[\"artifactPath\",\"checksum\"],\"properties\":{\"artifactPath\":{\"description\":\"Path in the VNF package, which identifies the artifact and also allows to access a copy of the artifact. \",\"type\":\"string\"},\"checksum\":{\"description\":\"This type represents the checksum of a VNF package or an artifact file. \",\"type\":\"object\",\"required\":[\"algorithm\",\"hash\"],\"properties\":{\"algorithm\":{\"description\":\"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. \",\"type\":\"string\"},\"hash\":{\"description\":\"The hexadecimal value of the checksum. \",\"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. \",\"type\":\"object\"}}}},\"onboardingState\":{\"description\":\"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 has been successfully on-boarded. \",\"type\":\"string\",\"enum\":[\"CREATED\",\"UPLOADING\",\"PROCESSING\",\"ONBOARDED\"]},\"operationalState\":{\"description\":\"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances. - DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled). \",\"type\":\"string\",\"enum\":[\"ENABLED\",\"DISABLED\"]},\"usageState\":{\"description\":\"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package. \"},\"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. \",\"type\":\"object\"},\"_links\":{\"description\":\"Links to resources related to this resource. \",\"type\":\"object\",\"required\":[\"self\",\"packageContent\"],\"properties\":{\"self\":{\"description\":\"This type represents a link to a resource. \",\"type\":\"object\",\"required\":[\"href\"],\"properties\":{\"href\":{\"description\":\"URI of the referenced resource. \",\"type\":\"string\",\"format\":\"url\"}}},\"vnfd\":{\"description\":\"This type represents a link to a resource. \",\"type\":\"object\",\"required\":[\"href\"],\"properties\":{\"href\":{\"description\":\"URI of the referenced resource. \",\"type\":\"string\",\"format\":\"url\"}}},\"packageContent\":{\"description\":\"This type represents a link to a resource. \",\"type\":\"object\",\"required\":[\"href\"],\"properties\":{\"href\":{\"description\":\"URI of the referenced resource. \",\"type\":\"string\",\"format\":\"url\"}}}}}}}};", "", "pm.test('Schema is valid', function() {", " pm.expect(tv4.validate(pm.response.json(), res_schema)).to.be.true;", "});" ] } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "{{Accept}}" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": {}, "url": { "raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages", "protocol": "{{scheme}}", "host": [ "{{host}}{{port}}" ], "path": [ "{{uri_prefix}}vnfpkgm", "v1", "vnf_packages" ] }, "description": "The GET method queries the information of the VNF packages matching the filter.\n" }, "response": [] }, { "name": "Fetch On-boarded VNF Package content", "event": [ { "listen": "test", "script": { "id": "74ea2d52-1b22-4302-b718-391779763e96", "type": "text/javascript", "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "{{Accept}}" }, { "key": "Authorization", "value": "{{Authorization}}" }, { "key": "Range", "value": "{{Range}}" } ], "body": {}, "url": { "raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/package_content", "protocol": "{{scheme}}", "host": [ "{{host}}{{port}}" ], "path": [ "{{uri_prefix}}vnfpkgm", "v1", "vnf_packages", "{{vnfPkgId}}", "package_content" ] }, "description": "The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.\n" }, "response": [] }, { "name": "Reading the VNFD of an on-boarded VNF package", "event": [ { "listen": "test", "script": { "id": "08c9bab8-6c9a-4444-a6a1-28982e6f4746", "type": "text/javascript", "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ] } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "{{Accept}}" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": {}, "url": { "raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/vnfd", "protocol": "{{scheme}}", "host": [ "{{host}}{{port}}" ], "path": [ "{{uri_prefix}}vnfpkgm", "v1", "vnf_packages", "{{vnfPkgId}}", "vnfd" ] }, "description": "The GET method reads the content of the VNFD within a VNF package. The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the form of multiple files, a ZIP file embedding these files shall be returned. If the VNFD is implemented as a single file, either that file or a ZIP file embedding that file shall be returned. The selection of the format is controlled by the \"Accept\" HTTP header passed in the GET request. * If the \"Accept\" header contains only \"text/plain\" and the VNFD is implemented as a single file, the file shall be returned;\n otherwise, an error message shall be returned.\n* If the \"Accept\" header contains only \"application/zip\", the single file or the multiple files that make up the VNFD shall be returned\n embedded in a ZIP file.\n* If the \"Accept\" header contains both \"text/plain\" and \"application/zip\", it is up to the NFVO to choose the format to\n return for a single-file VNFD; for a multi-file VNFD, a ZIP file\n shall be returned.\nThe default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 004 where only the YAML files representing the VNFD, and information needed to navigate the ZIP file and to identify the file that is the entry point for parsing the VNFD (such as TOSCA-meta or manifest files or naming conventions) are included.\n" }, "response": [] } ] } ] }