InstantiateVnfRequest

InstantiateVnfRequest
InstantiateVnfRequest
JSON Example
{
    "extManagedVirtualLinks": [
        {
            "resourceId": "resourceId",
            "vimConnectionId": "vimConnectionId",
            "id": "id",
            "vnfVirtualLinkDescId": "vnfVirtualLinkDescId",
            "resourceProviderId": "resourceProviderId"
        },
        {
            "resourceId": "resourceId",
            "vimConnectionId": "vimConnectionId",
            "id": "id",
            "vnfVirtualLinkDescId": "vnfVirtualLinkDescId",
            "resourceProviderId": "resourceProviderId"
        }
    ],
    "flavourId": "flavourId",
    "instantiationLevelId": "instantiationLevelId",
    "vimConnectionInfo": [
        {
            "vimType": "vimType",
            "vimId": "vimId",
            "extra": {
                "deploymentProfileId": "deploymentProfileId",
                "nodePoolId": "nodePoolId",
                "vimName": "vimName",
                "nodeProfileName": "nodeProfileName",
                "nodePoolName": "nodePoolName"
            },
            "interfaceInfo": "{}",
            "id": "id",
            "accessInfo": "{}"
        },
        {
            "vimType": "vimType",
            "vimId": "vimId",
            "extra": {
                "deploymentProfileId": "deploymentProfileId",
                "nodePoolId": "nodePoolId",
                "vimName": "vimName",
                "nodeProfileName": "nodeProfileName",
                "nodePoolName": "nodePoolName"
            },
            "interfaceInfo": "{}",
            "id": "id",
            "accessInfo": "{}"
        }
    ],
    "extensions": "{}",
    "additionalParams": {
        "vduParams": [
            {
                "deploymentProfileId": "deploymentProfileId",
                "repoUrl": "repoUrl",
                "metadata": [
                    "{}",
                    "{}"
                ],
                "imageName": "imageName",
                "ignoreGrantFailure": true,
                "vduName": "vduName",
                "overrides": "overrides",
                "vduId": "vduId",
                "timeoutInSecs": 0,
                "catalogName": "catalogName",
                "password": "password",
                "catalogId": "catalogId",
                "chartName": "chartName",
                "helmName": "helmName",
                "disableAutoRollback": true,
                "namespace": "namespace",
                "extensionId": "extensionId",
                "disableGrant": true,
                "disableHelmInstall": true,
                "username": "username"
            },
            {
                "deploymentProfileId": "deploymentProfileId",
                "repoUrl": "repoUrl",
                "metadata": [
                    "{}",
                    "{}"
                ],
                "imageName": "imageName",
                "ignoreGrantFailure": true,
                "vduName": "vduName",
                "overrides": "overrides",
                "vduId": "vduId",
                "timeoutInSecs": 0,
                "catalogName": "catalogName",
                "password": "password",
                "catalogId": "catalogId",
                "chartName": "chartName",
                "helmName": "helmName",
                "disableAutoRollback": true,
                "namespace": "namespace",
                "extensionId": "extensionId",
                "disableGrant": true,
                "disableHelmInstall": true,
                "username": "username"
            }
        ],
        "isVnfVAppTemplate": true,
        "ignoreGrantFailure": true,
        "storageProfiles": [
            "storageProfiles",
            "storageProfiles"
        ],
        "timeoutInSecs": 6,
        "skipNodeCustomization": "{}",
        "nodepoolName": "nodepoolName",
        "catalogName": "catalogName",
        "entityPrefix": "entityPrefix",
        "lcmInterfaces": [
            {
                "interfaceName": "interfaceName",
                "parameters": [
                    {
                        "name": "name",
                        "type": "type",
                        "value": "{}"
                    },
                    {
                        "name": "name",
                        "type": "type",
                        "value": "{}"
                    }
                ]
            },
            {
                "interfaceName": "interfaceName",
                "parameters": [
                    {
                        "name": "name",
                        "type": "type",
                        "value": "{}"
                    },
                    {
                        "name": "name",
                        "type": "type",
                        "value": "{}"
                    }
                ]
            }
        ],
        "catalogId": "catalogId",
        "disableAutoRollback": true,
        "vAppTemplateName": "vAppTemplateName",
        "skipGrant": true,
        "useVAppTemplates": true,
        "disableGrant": true,
        "disableHelmInstall": true
    },
    "extVirtualLinks": [
        {
            "resourceId": "resourceId",
            "vimConnectionId": "vimConnectionId",
            "extLinkPorts": [
                {
                    "resourceHandle": {
                        "resourceId": "resourceId",
                        "vimConnectionId": "vimConnectionId",
                        "vimLevelResourceType": "vimLevelResourceType",
                        "resourceProviderId": "resourceProviderId"
                    },
                    "id": "id"
                },
                {
                    "resourceHandle": {
                        "resourceId": "resourceId",
                        "vimConnectionId": "vimConnectionId",
                        "vimLevelResourceType": "vimLevelResourceType",
                        "resourceProviderId": "resourceProviderId"
                    },
                    "id": "id"
                }
            ],
            "id": "id",
            "resourceProviderId": "resourceProviderId",
            "extCps": [
                {
                    "cpdId": "cpdId",
                    "cpConfig": [
                        {
                            "linkPortId": "linkPortId",
                            "cpProtocolData": [
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                },
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                }
                            ],
                            "cpInstanceId": "cpInstanceId"
                        },
                        {
                            "linkPortId": "linkPortId",
                            "cpProtocolData": [
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                },
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                }
                            ],
                            "cpInstanceId": "cpInstanceId"
                        }
                    ]
                },
                {
                    "cpdId": "cpdId",
                    "cpConfig": [
                        {
                            "linkPortId": "linkPortId",
                            "cpProtocolData": [
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                },
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                }
                            ],
                            "cpInstanceId": "cpInstanceId"
                        },
                        {
                            "linkPortId": "linkPortId",
                            "cpProtocolData": [
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                },
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                }
                            ],
                            "cpInstanceId": "cpInstanceId"
                        }
                    ]
                }
            ]
        },
        {
            "resourceId": "resourceId",
            "vimConnectionId": "vimConnectionId",
            "extLinkPorts": [
                {
                    "resourceHandle": {
                        "resourceId": "resourceId",
                        "vimConnectionId": "vimConnectionId",
                        "vimLevelResourceType": "vimLevelResourceType",
                        "resourceProviderId": "resourceProviderId"
                    },
                    "id": "id"
                },
                {
                    "resourceHandle": {
                        "resourceId": "resourceId",
                        "vimConnectionId": "vimConnectionId",
                        "vimLevelResourceType": "vimLevelResourceType",
                        "resourceProviderId": "resourceProviderId"
                    },
                    "id": "id"
                }
            ],
            "id": "id",
            "resourceProviderId": "resourceProviderId",
            "extCps": [
                {
                    "cpdId": "cpdId",
                    "cpConfig": [
                        {
                            "linkPortId": "linkPortId",
                            "cpProtocolData": [
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                },
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                }
                            ],
                            "cpInstanceId": "cpInstanceId"
                        },
                        {
                            "linkPortId": "linkPortId",
                            "cpProtocolData": [
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                },
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                }
                            ],
                            "cpInstanceId": "cpInstanceId"
                        }
                    ]
                },
                {
                    "cpdId": "cpdId",
                    "cpConfig": [
                        {
                            "linkPortId": "linkPortId",
                            "cpProtocolData": [
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                },
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                }
                            ],
                            "cpInstanceId": "cpInstanceId"
                        },
                        {
                            "linkPortId": "linkPortId",
                            "cpProtocolData": [
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                },
                                {
                                    "ipOverEthernet": {
                                        "macAddress": "macAddress",
                                        "ipAddresses": [
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            },
                                            {
                                                "fixedAddresses": [
                                                    null,
                                                    null
                                                ],
                                                "subnetId": "subnetId",
                                                "addressRange": {
                                                    "maxAddress": "maxAddress",
                                                    "minAddress": "minAddress"
                                                },
                                                "type": "IPV4",
                                                "numDynamicAddresses": 1
                                            }
                                        ]
                                    },
                                    "layerProtocol": "IP_OVER_ETHERNET"
                                }
                            ],
                            "cpInstanceId": "cpInstanceId"
                        }
                    ]
                }
            ]
        }
    ],
    "localizationLanguage": "localizationLanguage",
    "vnfConfigurableProperties": "{}"
}
string
flavourId
Required

An identifier that is unique within a VNF descriptor.

string
instantiationLevelId
Optional

An identifier that is unique within a VNF descriptor.

extVirtualLinks
Optional

Information about external VLs to connect the VNF to.

extManagedVirtualLinks
Optional

Information about internal VLs that are managed by the NFVO.

vimConnectionInfo
Optional

Information about VIM connections to be used for managing the resources for the VNF instance, or refer to external / externally-managed virtual links. This attribute shall only be supported and may be present if VNF-related resource management in direct mode is applicable.

string
localizationLanguage
Optional

A string defined in IETF RFC 8259.

additionalParams
Optional

additionalParams

object
extensions
Optional

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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys ("aString", "aNumber", "anArray" and "anObject") is provided to illustrate that the values associated with different keys can be of different type.

object
vnfConfigurableProperties
Optional

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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys ("aString", "aNumber", "anArray" and "anObject") is provided to illustrate that the values associated with different keys can be of different type.

Parameter To