Commit 34c70299 authored by rahulkumarr's avatar rahulkumarr Committed by garciadeblas
Browse files

Documentation for feature 10999 Dual-Stack IP Support for VNFs in SOL003 VNFM Interface

parent ae6398d5
Loading
Loading
Loading
Loading
+35 −0
Original line number Diff line number Diff line
@@ -2143,3 +2143,38 @@ virtual-link-connectivity:
    constituent-cpd-id: vnf-cp0-ext
    ip-address: 192.168.1.20
```
### How to Launch NS with Dual Stack IP (IPv4/IPv6) using SOL003 VNFM Interface

First, use API endpoint `/osm/vnflcm/v1/vnf_instances` to create a VNF object with a POST message, providing all the details mentioned in below sample payload. Make sure to add "ip-address" key and value with dual stack IP addresses. Behind the scenes, this creates a VNF and a NS package in OSM.

```json
{
  "vnfdId":"cirros_vnfd",
  "vnfInstanceName":"rahul-instance",
  "vnfInstanceDescription":"Test vnfm instance description",
  "vimAccountId":"b4275db0-3d1c-46f8-a42a-2b5425b07fb1",
  "additionalParams":{
    "virtual-link-desc":[
      {
        "id":"mgmtnet",
        "mgmt-network":true,
        "vim-network-name": "IPv6"
      }
     ],
     "constituent-cpd-id":"vnf-cp0-ext",
     "ip-address": ["2001:dc9::5", "199.166.155.66"],
     "virtual-link-profile-id":"mgmtnet"
  }
}
```

Then, use instantiation API `/osm/vnflcm/v1/vnf_instances/<vnfId>/instantiate` to launch the NS. Mention all the details in payload as shown in below sample.

```json
{
   "vnfName": "sample-instance",
   "vnfDescription": "vnf package",
   "vnfId": "28c8c438-ca9a-4565-9b02-bcfd3ba6c4d6",
   "vimAccountId": "b4275db0-3d1c-46f8-a42a-2b5425b07fb1"
}
```