Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document describes the procedure for sending notifications related to VNF package management.

Precondition: The subscribed API consumer has subscribed previously for notifications related to VNF package management.

...

1.VnfPackage Onboarding Notification

When the vnf package performs the Onboarding operation onboarding VNF package successfully, Etsicatalog will filter all Subscriptions records:

...

  • VnfPackage‘s vnfdId / vnfPkgId / vnfProductsFromProviders matching subscription.filters

If there are some matching subscription records,  Etsicatalog will send a notification to the URI which is provided by the Client in its subscription request.

...

1.3 Notification API example:

POST http://URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification

For this example, the URI provided by client is http://www.vnf1.com/notification according to the subscription request above.

Code Block
curl -X POST -u username:userpwd http://www.vnf1.com/notification
  http:// 
  -H 'Content-Type: application/json' 
  -d '{
  "id":"notify_id",
  "notificationType":"VnfPackageOnboardingNotification",
  "timeStamp":"2019-12-16 14:41:16",
  "vnfPkgId":"vnfPackage_uuid",
  "vnfdId":"vnfdId_uuid",
  "subscriptionId":"subscription_id",
  "_links":{
    "subscription":{
      "href":"http://subscriptionuri"
    },
    "vnfPackage":{
      "href":"http://vnfPackageuri"
    }
  }
}'

...

2.VnfPackage Change Notification

When the vnf package performs the Deleting or Patching operation successfullyVNF package is modified or deleted, Etsicatalog will filter all Subscriptions records:

...

Code Block
languagepy
curl -X POST 
  http://{{baseUrl}}/api/vnfpkgm/v1/subscriptions 
  -H 'Content-Type: application/json' 
  -d '{
    "filters": {
        "notificationTypes": [
            "VnfPackageChangeNotification"
        ],
        "vnfdId": [
            "uuid_vnfdid"
        ]
    },
    "callbackUri": "http://www.vnf1.com/notification",
    "authentication": {
        "authType": [
            "BASIC"
        ],
        "paramsBasic": {
            "userName": "stringusername",
            "password": "stringuserpwd"
        }
    }
}'

2.3 Notification API example:

POST http://URI-is-provided-by-the-client-when-creating-the-sbuscriptionsubscription-VnfPackageChangeNotification 

For this example, the URI provided by client is http://www.vnf1.com/notification according to the subscription request above.

Code Block
curl -X POST -u username:userpwd
  http://www.vnf1.com/notification 
  -H 'Content-Type: application/json' \
  -d '{
  "id":"notify_id",
  "notificationType":"VnfPackageChangeNotification",
  "timeStamp":"2019-12-16 14:41:16",
  "vnfPkgId":"vnfPackage_uuid",
  "vnfdId":"vnfdIduuid_uuidvnfdid",
  "subscriptionId":"subscription_id",
  "changeType":"OP_STATE_CHANGE",
  "operationalState":"ENABLED",
  "_links":{
    "subscription":{
      "href":"http://subscriptionuri"
    },
    "vnfPackage":{
      "href":"http://vnfPackageuri"
    }
  }
}'

3. Client APIs 

The client should implement the followed APIs when creating the subscription:

Client_API_notify_v1.yaml