InstantiateNsRequest

InstantiateNsRequest
InstantiateNsRequest
JSON Example
{
    "nsFlavourId": "string",
    "sapData": [
        {
            "sapdId": "string",
            "sapName": "string",
            "description": "string",
            "sapProtocolData": [
                {
                    "layerProtocol": "string",
                    "ipOverEthernet": {
                        "macAddress": "string",
                        "ipAddresses": [
                            {
                                "type": "string",
                                "fixedAddresses": [
                                    "string"
                                ],
                                "numDynamicAddresses": 0,
                                "addressRange": {
                                    "minAddress": "string",
                                    "maxAddress": "string"
                                },
                                "subnetId": "string"
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "addpnfData": [
        {
            "pnfId": "string",
            "pnfName": "string",
            "pnfdId": "string",
            "pnfProfileId": "string",
            "cpData": [
                {
                    "cpInstanceId": "string",
                    "cpdId": "string",
                    "cpProtocolData": [
                        {
                            "layerProtocol": "string",
                            "ipOverEthernet": {
                                "macAddress": "string",
                                "ipAddresses": [
                                    {
                                        "type": "string",
                                        "fixedAddresses": [
                                            "string"
                                        ],
                                        "numDynamicAddresses": 0,
                                        "addressRange": {
                                            "minAddress": "string",
                                            "maxAddress": "string"
                                        },
                                        "subnetId": "string"
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "vnfInstanceData": [
        {
            "vnfInstanceId": "string",
            "vnfProfileId": "string"
        }
    ],
    "nestedNsInstanceData": [
        {
            "nestedNsInstanceId": "string",
            "nsProfileId": "string"
        }
    ],
    "locationConstraints": [
        {
            "vnfProfileId": "string",
            "locationConstraints": {
                "countryCode": "string",
                "civicAddressElement": [
                    {
                        "caType": 0,
                        "caValue": "string"
                    }
                ]
            }
        }
    ],
    "additionalParamsForNs": {
        "entityPrefix": "string"
    },
    "additionalParamForNestedNs": [
        {
            "nsProfileId": "string",
            "additionalParam": [
                {}
            ]
        }
    ],
    "additionalParamsForVnf": [
        {
            "vnfProfileId": "string",
            "vnfInstanceName": "string",
            "vnfInstanceDescription": "string",
            "additionalParams": {
                "nfType": "string",
                "entityPrefix": "string",
                "useVAppTemplates": false,
                "catalogName": "string",
                "catalogId": "string",
                "vduParams": [
                    {
                        "vduName": "string",
                        "vduId": "string",
                        "deploymentProfileId": "string",
                        "chartName": "string",
                        "namespace": "string",
                        "repoUrl": "string",
                        "username": "string",
                        "password": "string",
                        "extensionId": "string",
                        "overrides": "string",
                        "metadata": [
                            {}
                        ],
                        "catalogName": "string",
                        "catalogId": "string"
                    }
                ],
                "instantiationLevelId": "string",
                "extVirtualLinks": [
                    {
                        "extVirtualLinkId": "string",
                        "vimId": "string",
                        "resourceProviderId": "string",
                        "resourceId": "string",
                        "extCps": [
                            {
                                "cpdId": "string",
                                "cpConfig": [
                                    {
                                        "cpInstanceId": "string",
                                        "linkPortId": "string",
                                        "cpProtocolData": [
                                            {
                                                "layerProtocol": "string",
                                                "ipOverEthernet": {
                                                    "macAddress": "string",
                                                    "ipAddresses": [
                                                        {
                                                            "type": "string",
                                                            "fixedAddresses": [
                                                                "string"
                                                            ],
                                                            "numDynamicAddresses": 0,
                                                            "addressRange": {
                                                                "minAddress": "string",
                                                                "maxAddress": "string"
                                                            },
                                                            "subnetId": "string"
                                                        }
                                                    ]
                                                }
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "extLinkPorts": [
                            {
                                "id": "string",
                                "resourceHandle": {
                                    "vimId": "string",
                                    "resourceProviderId": "string",
                                    "resourceId": "string",
                                    "vimLevelResourceType": "string"
                                }
                            }
                        ]
                    }
                ],
                "nodeProfileName": "string",
                "vimConnectionInfo": [
                    {
                        "id": "string",
                        "vimId": "string",
                        "vimType": "string",
                        "extra": {
                            "deploymentProfileId": "string",
                            "nodeProfileName": "string",
                            "nodePoolId": "string",
                            "nodePoolName": "string",
                            "vimName": "string",
                            "nodePools": [
                                "string"
                            ],
                            "nodePoolBatchSize": 0
                        }
                    }
                ],
                "lcmInterfaces": {
                    "lcmInterfaces": {
                        "scale_start": [
                            {
                                "name": "USER",
                                "type": "string",
                                "value": "root"
                            },
                            {
                                "name": "PWD",
                                "type": "password",
                                "value": "Y2EkaGMwdw=="
                            },
                            {
                                "name": "HOSTNAME",
                                "type": "string",
                                "value": "10.176.160.54"
                            },
                            {
                                "name": "CMD",
                                "type": "string",
                                "value": "uptime"
                            },
                            {
                                "name": "VIM_LOCATION",
                                "type": "location",
                                "value": "vmware_641917F756584A7FA21F455F775D5F66"
                            }
                        ],
                        "scale_end": [
                            {
                                "name": "USER",
                                "type": "string",
                                "value": "root"
                            },
                            {
                                "name": "PWD",
                                "type": "password",
                                "value": "Y2EkaGMwdw=="
                            },
                            {
                                "name": "HOSTNAME",
                                "type": "string",
                                "value": "10.176.160.54"
                            },
                            {
                                "name": "CMD",
                                "type": "string",
                                "value": "uptime"
                            },
                            {
                                "name": "VIM_LOCATION",
                                "type": "location",
                                "value": "vmware_641917F756584A7FA21F455F775D5F66"
                            }
                        ]
                    }
                },
                "isVnfVAppTemplate": false,
                "vAppTemplateName": "string",
                "storageProfiles": [
                    "string"
                ]
            }
        }
    ],
    "startTime": "string",
    "nsInstantiationLevelId": "string",
    "additionalAffinityOrAntiAffinityRule": [
        {
            "vnfdId": [
                "string"
            ],
            "vnfProfileId": [
                "string"
            ],
            "vnfInstanceId": [
                "string"
            ],
            "affinityOrAntiAffiinty": "string",
            "scope": "string"
        }
    ]
}
nsFlavourId
Required

nsFlavourId

array of SapData
sapData
Optional

Create data concerning the SAPs of this NS.

array of AddPnfData
addpnfData
Optional

Information on the PNF(s) that are part of this NS.

vnfInstanceData
Optional

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
Optional

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
Optional

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..

additionalParamsForNs
Optional

Allows the OSS/BSS to provide additional parameter(s) at the composite NS level (as opposed to the VNF level, which is covered in additionalParamsForVnf), and as opposed to the nested NS level, which is covered in additionalParamForNestedNs.

additionalParamForNestedNs
Optional

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
Optional

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
Optional

startTime

nsInstantiationLevelId
Optional

nsInstantiationLevelId

additionalAffinityOrAntiAffinityRule
Optional

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.

Parameter To