InstantiateNsRequest

InstantiateNsRequest
InstantiateNsRequest
JSON Example
{
    "addpnfData": [
        {
            "pnfName": "pnfName",
            "pnfProfileId": "pnfProfileId",
            "pnfdId": "pnfdId",
            "cpData": [
                {
                    "cpdId": "cpdId",
                    "cpProtocolData": [
                        {
                            "ipOverEthernet": {
                                "macAddress": "macAddress",
                                "ipAddresses": [
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    },
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    }
                                ]
                            },
                            "layerProtocol": "IP_OVER_ETHERNET"
                        },
                        {
                            "ipOverEthernet": {
                                "macAddress": "macAddress",
                                "ipAddresses": [
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    },
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    }
                                ]
                            },
                            "layerProtocol": "IP_OVER_ETHERNET"
                        }
                    ],
                    "cpInstanceId": "cpInstanceId"
                },
                {
                    "cpdId": "cpdId",
                    "cpProtocolData": [
                        {
                            "ipOverEthernet": {
                                "macAddress": "macAddress",
                                "ipAddresses": [
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    },
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    }
                                ]
                            },
                            "layerProtocol": "IP_OVER_ETHERNET"
                        },
                        {
                            "ipOverEthernet": {
                                "macAddress": "macAddress",
                                "ipAddresses": [
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    },
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    }
                                ]
                            },
                            "layerProtocol": "IP_OVER_ETHERNET"
                        }
                    ],
                    "cpInstanceId": "cpInstanceId"
                }
            ],
            "pnfId": "pnfId"
        },
        {
            "pnfName": "pnfName",
            "pnfProfileId": "pnfProfileId",
            "pnfdId": "pnfdId",
            "cpData": [
                {
                    "cpdId": "cpdId",
                    "cpProtocolData": [
                        {
                            "ipOverEthernet": {
                                "macAddress": "macAddress",
                                "ipAddresses": [
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    },
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    }
                                ]
                            },
                            "layerProtocol": "IP_OVER_ETHERNET"
                        },
                        {
                            "ipOverEthernet": {
                                "macAddress": "macAddress",
                                "ipAddresses": [
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    },
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    }
                                ]
                            },
                            "layerProtocol": "IP_OVER_ETHERNET"
                        }
                    ],
                    "cpInstanceId": "cpInstanceId"
                },
                {
                    "cpdId": "cpdId",
                    "cpProtocolData": [
                        {
                            "ipOverEthernet": {
                                "macAddress": "macAddress",
                                "ipAddresses": [
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    },
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    }
                                ]
                            },
                            "layerProtocol": "IP_OVER_ETHERNET"
                        },
                        {
                            "ipOverEthernet": {
                                "macAddress": "macAddress",
                                "ipAddresses": [
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    },
                                    {
                                        "fixedAddresses": [
                                            null,
                                            null
                                        ],
                                        "subnetId": "subnetId",
                                        "addressRange": {
                                            "maxAddress": "maxAddress",
                                            "minAddress": "minAddress"
                                        },
                                        "type": "IPV4",
                                        "numDynamicAddresses": 6
                                    }
                                ]
                            },
                            "layerProtocol": "IP_OVER_ETHERNET"
                        }
                    ],
                    "cpInstanceId": "cpInstanceId"
                }
            ],
            "pnfId": "pnfId"
        }
    ],
    "additionalParamsForVnf": [
        {
            "metadata": "{}",
            "extensions": {
                "key": "extensions"
            },
            "additionalParams": null,
            "vnfConfigurableProperties": {
                "key": "vnfConfigurableProperties"
            },
            "vnfProfileId": "vnfProfileId",
            "vnfInstanceName": "vnfInstanceName",
            "vnfInstanceDescription": "vnfInstanceDescription"
        },
        {
            "metadata": "{}",
            "extensions": {
                "key": "extensions"
            },
            "additionalParams": null,
            "vnfConfigurableProperties": {
                "key": "vnfConfigurableProperties"
            },
            "vnfProfileId": "vnfProfileId",
            "vnfInstanceName": "vnfInstanceName",
            "vnfInstanceDescription": "vnfInstanceDescription"
        }
    ],
    "sapData": [
        {
            "sapdId": "sapdId",
            "description": "description",
            "sapName": "sapName",
            "sapProtocolData": [
                {
                    "ipOverEthernet": {
                        "macAddress": "macAddress",
                        "ipAddresses": [
                            {
                                "fixedAddresses": [
                                    null,
                                    null
                                ],
                                "subnetId": "subnetId",
                                "addressRange": {
                                    "maxAddress": "maxAddress",
                                    "minAddress": "minAddress"
                                },
                                "type": "IPV4",
                                "numDynamicAddresses": 6
                            },
                            {
                                "fixedAddresses": [
                                    null,
                                    null
                                ],
                                "subnetId": "subnetId",
                                "addressRange": {
                                    "maxAddress": "maxAddress",
                                    "minAddress": "minAddress"
                                },
                                "type": "IPV4",
                                "numDynamicAddresses": 6
                            }
                        ]
                    },
                    "layerProtocol": "IP_OVER_ETHERNET"
                },
                {
                    "ipOverEthernet": {
                        "macAddress": "macAddress",
                        "ipAddresses": [
                            {
                                "fixedAddresses": [
                                    null,
                                    null
                                ],
                                "subnetId": "subnetId",
                                "addressRange": {
                                    "maxAddress": "maxAddress",
                                    "minAddress": "minAddress"
                                },
                                "type": "IPV4",
                                "numDynamicAddresses": 6
                            },
                            {
                                "fixedAddresses": [
                                    null,
                                    null
                                ],
                                "subnetId": "subnetId",
                                "addressRange": {
                                    "maxAddress": "maxAddress",
                                    "minAddress": "minAddress"
                                },
                                "type": "IPV4",
                                "numDynamicAddresses": 6
                            }
                        ]
                    },
                    "layerProtocol": "IP_OVER_ETHERNET"
                }
            ]
        },
        {
            "sapdId": "sapdId",
            "description": "description",
            "sapName": "sapName",
            "sapProtocolData": [
                {
                    "ipOverEthernet": {
                        "macAddress": "macAddress",
                        "ipAddresses": [
                            {
                                "fixedAddresses": [
                                    null,
                                    null
                                ],
                                "subnetId": "subnetId",
                                "addressRange": {
                                    "maxAddress": "maxAddress",
                                    "minAddress": "minAddress"
                                },
                                "type": "IPV4",
                                "numDynamicAddresses": 6
                            },
                            {
                                "fixedAddresses": [
                                    null,
                                    null
                                ],
                                "subnetId": "subnetId",
                                "addressRange": {
                                    "maxAddress": "maxAddress",
                                    "minAddress": "minAddress"
                                },
                                "type": "IPV4",
                                "numDynamicAddresses": 6
                            }
                        ]
                    },
                    "layerProtocol": "IP_OVER_ETHERNET"
                },
                {
                    "ipOverEthernet": {
                        "macAddress": "macAddress",
                        "ipAddresses": [
                            {
                                "fixedAddresses": [
                                    null,
                                    null
                                ],
                                "subnetId": "subnetId",
                                "addressRange": {
                                    "maxAddress": "maxAddress",
                                    "minAddress": "minAddress"
                                },
                                "type": "IPV4",
                                "numDynamicAddresses": 6
                            },
                            {
                                "fixedAddresses": [
                                    null,
                                    null
                                ],
                                "subnetId": "subnetId",
                                "addressRange": {
                                    "maxAddress": "maxAddress",
                                    "minAddress": "minAddress"
                                },
                                "type": "IPV4",
                                "numDynamicAddresses": 6
                            }
                        ]
                    },
                    "layerProtocol": "IP_OVER_ETHERNET"
                }
            ]
        }
    ],
    "nsFlavourId": "nsFlavourId",
    "nsInstantiationLevelId": "nsInstantiationLevelId",
    "locationConstraints": [
        {
            "locationConstraints": {
                "countryCode": "countryCode",
                "civicAddressElement": [
                    {
                        "caType": 0,
                        "caValue": "caValue"
                    },
                    {
                        "caType": 0,
                        "caValue": "caValue"
                    }
                ]
            },
            "vnfProfileId": "vnfProfileId"
        },
        {
            "locationConstraints": {
                "countryCode": "countryCode",
                "civicAddressElement": [
                    {
                        "caType": 0,
                        "caValue": "caValue"
                    },
                    {
                        "caType": 0,
                        "caValue": "caValue"
                    }
                ]
            },
            "vnfProfileId": "vnfProfileId"
        }
    ],
    "additionalAffinityOrAntiAffinityRule": [
        {
            "vnfInstanceId": [
                null,
                null
            ],
            "scope": "NFVI_POP",
            "vnfdId": [
                null,
                null
            ],
            "vnfProfileId": [
                null,
                null
            ],
            "affinityOrAntiAffiinty": "AFFINITY"
        },
        {
            "vnfInstanceId": [
                null,
                null
            ],
            "scope": "NFVI_POP",
            "vnfdId": [
                null,
                null
            ],
            "vnfProfileId": [
                null,
                null
            ],
            "affinityOrAntiAffiinty": "AFFINITY"
        }
    ],
    "nestedNsInstanceData": [
        {
            "nsProfileId": "nsProfileId",
            "nestedNsInstanceId": "nestedNsInstanceId"
        },
        {
            "nsProfileId": "nsProfileId",
            "nestedNsInstanceId": "nestedNsInstanceId"
        }
    ],
    "startTime": "2000-01-23T04:56:07.000Z",
    "vnfInstanceData": [
        {
            "vnfInstanceId": "vnfInstanceId",
            "vnfProfileId": "vnfProfileId"
        },
        {
            "vnfInstanceId": "vnfInstanceId",
            "vnfProfileId": "vnfProfileId"
        }
    ],
    "additionalParamForNestedNs": [
        {
            "nsProfileId": "nsProfileId",
            "additionalParam": [
                null,
                null
            ]
        },
        {
            "nsProfileId": "nsProfileId",
            "additionalParam": [
                null,
                null
            ]
        }
    ],
    "additionalParamsForNs": null
}
string
nsFlavourId
Required

An identifier that is unique within a NS descriptor. Representation: string of variable length.

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

additionalParamsForNs

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.

string As date-time As date-time
startTime
Optional

Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.

string
nsInstantiationLevelId
Optional

An identifier that is unique within a NS descriptor. Representation: string of variable length.

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