1. Types
  2. vcenter
  3. ovf

vcenter ovf: extra config params

The extra_config_params 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 deploy and filter.

Representations:

{
    "exclude_keys": [
        "string",
        "string"
    ],
    "extra_configs": [
        {
            "key": "string",
            "value": "string",
            "virtual_system_id": "string"
        },
        {
            "key": "string",
            "value": "string",
            "virtual_system_id": "string"
        }
    ],
    "include_keys": [
        "string",
        "string"
    ],
    "type": "string"
}
<?xml version="1.0" ?>
<ns0:ExtraConfigParams xmlns:ns0="http://vmware.com/vcenter/ovf" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <exclude_keys-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </exclude_keys-array>
  <extra_configs-array>
    <array-item>
      <virtual_system_id>string</virtual_system_id>
      <value>string</value>
      <key>string</key>
    </array-item>
    <array-item>
      <virtual_system_id>string</virtual_system_id>
      <value>string</value>
      <key>string</key>
    </array-item>
  </extra_configs-array>
  <include_keys-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </include_keys-array>
  <type>string</type>
</ns0:ExtraConfigParams>

Attributes:

Name Type Description
Optional
extra_configs extra_config[] Array of vmw:ExtraConfig elements in the OVF package.

Optional. 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 array if there are no extra configuration elements in the OVF package.
exclude_keys string[] Specifies which extra configuration items in the array in the 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 vcenter.ovf.extra_config.key field.

Optional. This field is optional in the input parameters when deploying an OVF package. It is an error to set both this and vcenter.ovf.extra_config_params.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 vcenter.ovf.extra_config_params.include_keys.
include_keys string[] Specifies which extra configuration items in the array in the 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 vcenter.ovf.extra_config.key field.

Optional. This field is optional in the input parameters when deploying an OVF package. It is an error to set both this and vcenter.ovf.extra_config_params.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 vcenter.ovf.extra_config_params.exclude_keys.
type string Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure.

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