OvfExtraConfigParams

The ExtraConfigParams structure contains the parameters with information about the vmw:ExtraConfig elements in an OVF package. vmw:ExtraConfig elements can be used to specify configuration settings that are transferred directly to the .vmx file.

The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

See LibraryItem.deploy and LibraryItem.filter.


Properties

Required Property Name Type Description
optional exclude_keys array of string

Specifies which extra configuration items in the list in the ExtraConfigParams.extra-configs field should be ignored during deployment. If set, the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.key field.

This field is optional in the input parameters when deploying an OVF package. It is an error to set both this and ExtraConfigParams.include-keys. This field is optional in the result when retrieving information about an OVF package. It is an error to set both this and ExtraConfigParams.include-keys.

optional extra_configs array of OvfExtraConfig

List of vmw:ExtraConfig elements in the OVF package. This field is optional in the input parameters when deploying an OVF package. If unset there are no extra configuration elements to use for this OVF package deployment. This field will always be present in the result when retrieving information about an OVF package. It will be an empty list if there are no extra configuration elements in the OVF package.

optional include_keys array of string

Specifies which extra configuration items in the list in the ExtraConfigParams.extra-configs field should be included during deployment. If set, all but the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.key field.

This field is optional in the input parameters when deploying an OVF package. It is an error to set both this and ExtraConfigParams.exclude-keys. This field is optional in the result when retrieving information about an OVF package. It is an error to set both this and ExtraConfigParams.exclude-keys.

optional type string

Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

JSON Example

{
    "exclude_keys": [
        "string"
    ],
    "extra_configs": [
        {
            "key": "string",
            "value": "string",
            "virtual_system_id": "string"
        }
    ],
    "include_keys": [
        "string"
    ],
    "type": "string"
}
Feedback

Was this page helpful?