OvfManagerCommonParams

OvfManagerCommonParams
OvfManagerCommonParams

A common super-class for basic OVF descriptor parameters

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "locale": "string",
    "deploymentOption": "string",
    "msgBundle": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "importOption": [
        "string"
    ]
}
string
locale
Required

The locale-identifier to choose from the descriptor.

If empty, the default locale on the server is used.

string
deploymentOption
Required

The key of the chosen deployment option.

If empty, the default option is chosen. The list of possible deployment options is returned in the result of parseDescriptor.

array of KeyValue
msgBundle
Optional

An optional set of localization strings to be used.

The server will use these message strings to localize information in the result and in error and warning messages.

This argument allows a client to pass messages from external string bundles. The client is responsible for selecting the right string bundle (based on locale) and parsing the external string bundle. The passed in key/value pairs are looked up before any messages included in the OVF descriptor itself.

array of string
importOption
Optional

An optional argument for modifing the OVF parsing.

When the server parses an OVF descriptor a set of options can be used to modify the parsing. The argument is a list of keywords.

To get a list of supported keywords see ovfImportOption. Unknown options will be ignored by the server.