EnvironmentBrowser_ConfigOptionDescriptors_Summary

EnvironmentBrowser_ConfigOptionDescriptors_Summary
EnvironmentBrowser_ConfigOptionDescriptors_Summary

Contains the definition of a unique key that can be used to retrieve a ConfigOption (vim.vm.ConfigOption) object.

JSON Example
{
    "config_option": "string",
    "description": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": {
                    "id": "string",
                    "params": {
                        "params": "Std_LocalizationParam Object"
                    }
                },
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "hosts": [
        "string"
    ],
    "create_supported": false,
    "default_config_option": false,
    "run_supported": false,
    "upgrade_supported": false
}
string
config_option
Required

A unique key used to identify a ConfigOption object. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.config_option. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.config_option.

description
Optional

The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

array of string
hosts
Optional

List of hosts to which this descriptor applies. List of hosts is not set when descriptor is returned for a Datacenter. when unset When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

boolean
create_supported
Required

Indicates whether the associated set of configuration options can be used for virtual machine creation on a given host or cluster.

boolean
default_config_option
Required

Indicates whether the associated set of virtual machine configuration options is the default one for a given host or cluster. Latest version is marked as default unless other version is specified via the vim.ComputeResource.ConfigInfo or vim.Datacenter.ConfigInfo defaultHardwareVersionKey. If this setting is TRUE, virtual machine creates will use the associated set of configuration options, unless a config version is explicitly specified in the vim.vm.ConfigSpec.

boolean
run_supported
Required

Indicates whether the associated set of configuration options can be used to power on a virtual machine on a given host or cluster.

boolean
upgrade_supported
Required

Indicates whether the associated set of configuration options can be used as a virtual hardware upgrade target.