Esx.Settings.Hosts.Configuration.DetailedValidationError

Esx.Settings.Hosts.Configuration.DetailedValidationError
Esx.Settings.Hosts.Configuration.DetailedValidationError

The SchemaValidationError schema contains details of validation errors for a property.

Warning: this schema is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

JSON Example
{
    "message": "Vapi.Std.LocalizableMessage Object",
    "type": "string",
    "pattern": "string",
    "expected_type": "string",
    "instance_id": "string",
    "property_name": "string",
    "maximum_length": 0,
    "minimum_length": 0,
    "maximum_value": 0,
    "minimum_value": 0,
    "dependency_error": {
        "required_value": "string",
        "current_value": "string",
        "possible_values": "string"
    },
    "component": "string",
    "group": "string",
    "key": "string",
    "path": "string",
    "required_property": "string"
}
message
Required

A user-friendly description of the error.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

string
type
Required

The type of error. Additional information may be set for some types of errors.

Possible values:

  • GENERIC: A generic error. Check the message property for more information.
  • ADDITIONAL_PROPERTY: A property that is not specified in the schema was found.
  • INVALID_ENUM_OPTION: The value of an enum property does not match one of the allowed values.
  • INVALID_TYPE: The value of a property is not the expected type.
  • MAX_STRING_LENGTH: The length of a string is larger than the maximum allowed.
  • MIN_STRING_LENGTH: The length of a string is smaller than the minimum allowed.
  • MISSING_REQUIRED: A required property is missing.
  • INVALID_UNION_TAG: A property that is dependent on another property is invalid.
  • DUPLICATE_INSTANCE_ID: An instance has an instance ID that was already used in another instance.
  • MAX_ARRAY_LENGTH: The length of an array is larger than the maximum allowed.
  • MIN_ARRAY_LENGTH: The length of an array is smaller than the minimum allowed.
  • MAX_VALUE: The value of a numeric property is larger than the maximum allowed.
  • MIN_VALUE: The value of a numeric property is smaller than the minimum allowed.
  • PATTERN_MISMATCH: The value of a string property does not match the allowed pattern.
  • SCHEMA_NOT_FOUND: A configuration was found for software that is not in the image associated with the host.
  • NULL_VALUE: A property has a null value.
  • INVALID_DELETE_DEFAULT: The property is only valid for mutable default configurations.
  • HOST_SPECIFIC_IN_PROFILE: The property is host-specific, but was found in the profile section.
  • NOT_HOST_SPECIFIC: The property is not host-specific, but was found in the host-specific section.
  • MISSING_INSTANCE_ID: An instance does not have the required ID property.
  • EMPTY_PROPERTY: An object or array property is empty.
  • KEY_IN_HOST_OVERRIDE: The configuration exists in both host-override and host-specific sections.
  • PLACEHOLDER_FOUND: The property contains a placeholder that must be replaced.
  • PROPERTY_NAME_MISMATCH: A property name does not match the required pattern.
  • MISSING_REQUIRED_PROFILE_INSTANCE: The host-specific configuration refers to an instance that does not exist in the profile section.
  • MISSING_REQUIRED_PROFILE_KEY: The host-specific configuration refers to a configuration key that does not exist in the profile section.
  • HOST_SPECIFIC_KEY_IN_OVERRIDE: A host-specific configuration was found in the host-override section.
  • UNION_CASE_WITHOUT_UNION_TAG: A union-case property was provided, but the corresponding union tag property was not set.
  • MISSING_UNION_CASE: A union-case property is missing when the corresponding union tag property is set.

Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

For more information see: Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

string
pattern
Optional

The pattern the property is required to match.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is one of Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.PATTERN_MISMATCH or Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.PROPERTY_NAME_MISMATCH.

string
expected_type
Optional

The expected type of the property.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.INVALID_TYPE.

string
instance_id
Optional

The instance ID that was duplicated or is missing from the profile section.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is one of Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.DUPLICATE_INSTANCE_ID or Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE.

string
property_name
Optional

The name of the property that holds the instance ID.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MISSING_INSTANCE_ID.

integer As int64 As int64
maximum_length
Optional

The maximum length allowed for a string or array property.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is one of Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MAX_STRING_LENGTH or Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MAX_ARRAY_LENGTH.

integer As int64 As int64
minimum_length
Optional

The minimum length allowed for a string or array property.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is one of Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MIN_STRING_LENGTH or Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MIN_ARRAY_LENGTH.

integer As int64 As int64
maximum_value
Optional

The maximum allowed value for a property.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MAX_VALUE.

integer As int64 As int64
minimum_value
Optional

The minimum allowed value for a property.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MIN_VALUE.

dependency_error
Optional

The dependency required by a union tag.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is one of Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.INVALID_UNION_TAG or Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.UNION_CASE_WITHOUT_UNION_TAG.

string
component
Optional

For SCHEMA_NOT_FOUND errors, this will be the component portion of the unknown configuration.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND.

string
group
Optional

For SCHEMA_NOT_FOUND errors, this will be the group portion of the unknown configuration.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND.

string
key
Optional

For SCHEMA_NOT_FOUND errors, this will be the key portion of the unknown configuration.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND.

string
path
Optional

The JSON-pointer to the configuration key in the profile section where the instance/key needs to be added.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is one of Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE or Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY.

string
required_property
Optional

The name of the required property that is missing from the profile section for this instance/key.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of type is one of Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE or Esx.Settings.Hosts.Configuration.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY.

Property Of