vcenter ovf: ovf error
The
ovf_error structure describes an error related to accessing, validating, deploying, or exporting an OVF package.Representation:
{
"name" : "string",
"category" : "VALIDATION",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"error" : {
"data" : {},
"error_type" : "ERROR",
"messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
]
},
"issues" : [
{
"file" : "string",
"line_number" : 1,
"column_number" : 1,
"category" : "VALUE_ILLEGAL",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"file" : "string",
"line_number" : 1,
"column_number" : 1,
"category" : "VALUE_ILLEGAL",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"value" : "string"
}
"name" : "string",
"category" : "VALIDATION",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"error" : {
"data" : {},
"error_type" : "ERROR",
"messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
]
},
"issues" : [
{
"file" : "string",
"line_number" : 1,
"column_number" : 1,
"category" : "VALUE_ILLEGAL",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"file" : "string",
"line_number" : 1,
"column_number" : 1,
"category" : "VALUE_ILLEGAL",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"value" : "string"
}
{
"name" : "string",
"category" : "VALIDATION",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"error" : {
"@class" : "com.vmware.vapi.std.errors.error",
"data" : {
"@class" : "dynamic_structure"
},
"error_type" : "ERROR",
"messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
]
},
"issues" : [
{
"file" : "string",
"line_number" : 1,
"column_number" : 1,
"category" : "VALUE_ILLEGAL",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"file" : "string",
"line_number" : 1,
"column_number" : 1,
"category" : "VALUE_ILLEGAL",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"value" : "string"
}
"name" : "string",
"category" : "VALIDATION",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"error" : {
"@class" : "com.vmware.vapi.std.errors.error",
"data" : {
"@class" : "dynamic_structure"
},
"error_type" : "ERROR",
"messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
]
},
"issues" : [
{
"file" : "string",
"line_number" : 1,
"column_number" : 1,
"category" : "VALUE_ILLEGAL",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"file" : "string",
"line_number" : 1,
"column_number" : 1,
"category" : "VALUE_ILLEGAL",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"value" : "string"
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| -.category | string | The message category. Defines the categories of messages (see vcenter.ovf.ovf_message). Value is one of: VALIDATION: The OVF descriptor is invalid, for example, syntax errors or schema errors. INPUT: The user provided input parameters are invalid. SERVER: Server error. |
| -.issues[].category | string | The category of the parse issue. Defines the categories of issues that can be found when parsing files inside an OVF package (see vcenter.ovf.parse_issue) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package. Value is one of: VALUE_ILLEGAL: Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on. ATTRIBUTE_REQUIRED: Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor. ATTRIBUTE_ILLEGAL: Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue. ELEMENT_REQUIRED: Required element error. It indicates that a required element is missing from the OVF descriptor. ELEMENT_ILLEGAL: Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor. ELEMENT_UNKNOWN: Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor. SECTION_UNKNOWN: Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor. SECTION_RESTRICTION: Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed. PARSE_ERROR: OVF package parsing error, including:
GENERATE_ERROR: OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions. VALIDATION_ERROR: An issue with the manifest and signing. EXPORT_ERROR: Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found. INTERNAL_ERROR: Server encountered an unexpected error which prevented it from fulfilling the request. |
| -.issues[].file | string | The name of the file in which the parse issue was found. |
| -.issues[].line_number | long | The line number of the line in the file (see vcenter.ovf.parse_issue.file) where the parse issue was found (or -1 if not applicable). |
| -.issues[].column_number | long | The position in the line (see vcenter.ovf.parse_issue.line_number) (or -1 if not applicable). |
| -.issues[].message | localizable_message | A localizable message describing the parse issue. |
| -.issues[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| -.issues[].message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| -.issues[].message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| -.message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| -.message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| -.message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| -.error.messages | localizable_message[] | Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked. Each subsequent message in the stack describes the "cause" of the prior message. |
| Optional | ||
| -.issues | parse_issue[] | Array of parse issues (see vcenter.ovf.parse_issue). Optional. It is only relevant when category has value VALIDATION. This field is optional and it is only relevant when the value of category is VALIDATION. |
| -.name | string | The name of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of category is INPUT. |
| -.value | string | The value of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of category is INPUT. |
| -.message | localizable_message | A localizable message. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of category is INPUT. |
| -.message.params | object | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
| -.message.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
| -.error | object | Represents a server vapi.std.errors.error. Optional. It is only relevant when category has value SERVER. This field is optional and it is only relevant when the value of category is SERVER.When clients pass a value of this structure as a parameter, the field must contain all the attributes defined in vapi.std.errors.error. When operations return a value of this structure as a result, the field will contain all the attributes defined in vapi.std.errors.error. |
| -.error.data | object | Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports. The vapi.std.errors.argument_locations, vapi.std.errors.file_locations, and vapi.std.errors.transient_indication structures are intended as possible values for this field. vapi.std.dynamic_ID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations. Optional. Some operations will not set this field when reporting errors. |
| -.error.error_type | string | Discriminator field to help API consumers identify the structure type. This attribute was added in vSphere API 6.7.2. Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST. This enumeration was added in vSphere API 6.7.2. Value is one of: ERROR: Discriminator for the vapi.std.errors.error type. This constant was added in vSphere API 6.7.2. ALREADY_EXISTS: Discriminator for the vapi.std.errors.already_exists type. This constant was added in vSphere API 6.7.2. ALREADY_IN_DESIRED_STATE: Discriminator for the vapi.std.errors.already_in_desired_state type. This constant was added in vSphere API 6.7.2. CANCELED: Discriminator for the vapi.std.errors.canceled type. This constant was added in vSphere API 6.7.2. CONCURRENT_CHANGE: Discriminator for the vapi.std.errors.concurrent_change type. This constant was added in vSphere API 6.7.2. FEATURE_IN_USE: Discriminator for the vapi.std.errors.feature_in_use type. This constant was added in vSphere API 6.7.2. INTERNAL_SERVER_ERROR: Discriminator for the vapi.std.errors.internal_server_error type. This constant was added in vSphere API 6.7.2. INVALID_ARGUMENT: Discriminator for the vapi.std.errors.invalid_argument type. This constant was added in vSphere API 6.7.2. INVALID_ELEMENT_CONFIGURATION: Discriminator for the vapi.std.errors.invalid_element_configuration type. This constant was added in vSphere API 6.7.2. INVALID_ELEMENT_TYPE: Discriminator for the vapi.std.errors.invalid_element_type type. This constant was added in vSphere API 6.7.2. INVALID_REQUEST: Discriminator for the vapi.std.errors.invalid_request type. This constant was added in vSphere API 6.7.2. NOT_ALLOWED_IN_CURRENT_STATE: Discriminator for the vapi.std.errors.not_allowed_in_current_state type. This constant was added in vSphere API 6.7.2. NOT_FOUND: Discriminator for the vapi.std.errors.not_found type. This constant was added in vSphere API 6.7.2. OPERATION_NOT_FOUND: Discriminator for the vapi.std.errors.operation_not_found type. This constant was added in vSphere API 6.7.2. RESOURCE_BUSY: Discriminator for the vapi.std.errors.resource_busy type. This constant was added in vSphere API 6.7.2. RESOURCE_IN_USE: Discriminator for the vapi.std.errors.resource_in_use type. This constant was added in vSphere API 6.7.2. RESOURCE_INACCESSIBLE: Discriminator for the vapi.std.errors.resource_inaccessible type. This constant was added in vSphere API 6.7.2. SERVICE_UNAVAILABLE: Discriminator for the vapi.std.errors.service_unavailable type. This constant was added in vSphere API 6.7.2. TIMED_OUT: Discriminator for the vapi.std.errors.timed_out type. This constant was added in vSphere API 6.7.2. UNABLE_TO_ALLOCATE_RESOURCE: Discriminator for the vapi.std.errors.unable_to_allocate_resource type. This constant was added in vSphere API 6.7.2. UNAUTHENTICATED: Discriminator for the vapi.std.errors.unauthenticated type. This constant was added in vSphere API 6.7.2. UNAUTHORIZED: Discriminator for the vapi.std.errors.unauthorized type. This constant was added in vSphere API 6.7.2. UNEXPECTED_INPUT: Discriminator for the vapi.std.errors.unexpected_input type. This constant was added in vSphere API 6.7.2. UNSUPPORTED: Discriminator for the vapi.std.errors.unsupported type. This constant was added in vSphere API 6.7.2. UNVERIFIED_PEER: Discriminator for the vapi.std.errors.unverified_peer type. This constant was added in vSphere API 6.7.2.Optional. Can be unset for compatibility with preceding implementations. |
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| category | string | The message category. Defines the categories of messages (see vcenter.ovf.ovf_message). Value is one of: VALIDATION: The OVF descriptor is invalid, for example, syntax errors or schema errors. INPUT: The user provided input parameters are invalid. SERVER: Server error. |
| issues[].category | string | The category of the parse issue. Defines the categories of issues that can be found when parsing files inside an OVF package (see vcenter.ovf.parse_issue) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package. Value is one of: VALUE_ILLEGAL: Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on. ATTRIBUTE_REQUIRED: Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor. ATTRIBUTE_ILLEGAL: Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue. ELEMENT_REQUIRED: Required element error. It indicates that a required element is missing from the OVF descriptor. ELEMENT_ILLEGAL: Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor. ELEMENT_UNKNOWN: Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor. SECTION_UNKNOWN: Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor. SECTION_RESTRICTION: Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed. PARSE_ERROR: OVF package parsing error, including:
GENERATE_ERROR: OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions. VALIDATION_ERROR: An issue with the manifest and signing. EXPORT_ERROR: Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found. INTERNAL_ERROR: Server encountered an unexpected error which prevented it from fulfilling the request. |
| issues[].file | string | The name of the file in which the parse issue was found. |
| issues[].line_number | long | The line number of the line in the file (see vcenter.ovf.parse_issue.file) where the parse issue was found (or -1 if not applicable). |
| issues[].column_number | long | The position in the line (see vcenter.ovf.parse_issue.line_number) (or -1 if not applicable). |
| issues[].message | localizable_message | A localizable message describing the parse issue. |
| issues[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| issues[].message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| issues[].message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| error.messages | localizable_message[] | Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked. Each subsequent message in the stack describes the "cause" of the prior message. |
| Optional | ||
| issues | parse_issue[] | Array of parse issues (see vcenter.ovf.parse_issue). Optional. It is only relevant when category has value VALIDATION. This field is optional and it is only relevant when the value of category is VALIDATION. |
| name | string | The name of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of category is INPUT. |
| value | string | The value of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of category is INPUT. |
| message | localizable_message | A localizable message. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of category is INPUT. |
| message.params | list | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
| message.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
| error | object | Represents a server vapi.std.errors.error. Optional. It is only relevant when category has value SERVER. This field is optional and it is only relevant when the value of category is SERVER.When clients pass a value of this structure as a parameter, the field must contain all the attributes defined in vapi.std.errors.error. When operations return a value of this structure as a result, the field will contain all the attributes defined in vapi.std.errors.error. |
| error.data | object | Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports. The vapi.std.errors.argument_locations, vapi.std.errors.file_locations, and vapi.std.errors.transient_indication structures are intended as possible values for this field. vapi.std.dynamic_ID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations. Optional. Some operations will not set this field when reporting errors. |
| error.error_type | string | Discriminator field to help API consumers identify the structure type. This attribute was added in vSphere API 6.7.2. Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST. This enumeration was added in vSphere API 6.7.2. Value is one of: ERROR: Discriminator for the vapi.std.errors.error type. This constant was added in vSphere API 6.7.2. ALREADY_EXISTS: Discriminator for the vapi.std.errors.already_exists type. This constant was added in vSphere API 6.7.2. ALREADY_IN_DESIRED_STATE: Discriminator for the vapi.std.errors.already_in_desired_state type. This constant was added in vSphere API 6.7.2. CANCELED: Discriminator for the vapi.std.errors.canceled type. This constant was added in vSphere API 6.7.2. CONCURRENT_CHANGE: Discriminator for the vapi.std.errors.concurrent_change type. This constant was added in vSphere API 6.7.2. FEATURE_IN_USE: Discriminator for the vapi.std.errors.feature_in_use type. This constant was added in vSphere API 6.7.2. INTERNAL_SERVER_ERROR: Discriminator for the vapi.std.errors.internal_server_error type. This constant was added in vSphere API 6.7.2. INVALID_ARGUMENT: Discriminator for the vapi.std.errors.invalid_argument type. This constant was added in vSphere API 6.7.2. INVALID_ELEMENT_CONFIGURATION: Discriminator for the vapi.std.errors.invalid_element_configuration type. This constant was added in vSphere API 6.7.2. INVALID_ELEMENT_TYPE: Discriminator for the vapi.std.errors.invalid_element_type type. This constant was added in vSphere API 6.7.2. INVALID_REQUEST: Discriminator for the vapi.std.errors.invalid_request type. This constant was added in vSphere API 6.7.2. NOT_ALLOWED_IN_CURRENT_STATE: Discriminator for the vapi.std.errors.not_allowed_in_current_state type. This constant was added in vSphere API 6.7.2. NOT_FOUND: Discriminator for the vapi.std.errors.not_found type. This constant was added in vSphere API 6.7.2. OPERATION_NOT_FOUND: Discriminator for the vapi.std.errors.operation_not_found type. This constant was added in vSphere API 6.7.2. RESOURCE_BUSY: Discriminator for the vapi.std.errors.resource_busy type. This constant was added in vSphere API 6.7.2. RESOURCE_IN_USE: Discriminator for the vapi.std.errors.resource_in_use type. This constant was added in vSphere API 6.7.2. RESOURCE_INACCESSIBLE: Discriminator for the vapi.std.errors.resource_inaccessible type. This constant was added in vSphere API 6.7.2. SERVICE_UNAVAILABLE: Discriminator for the vapi.std.errors.service_unavailable type. This constant was added in vSphere API 6.7.2. TIMED_OUT: Discriminator for the vapi.std.errors.timed_out type. This constant was added in vSphere API 6.7.2. UNABLE_TO_ALLOCATE_RESOURCE: Discriminator for the vapi.std.errors.unable_to_allocate_resource type. This constant was added in vSphere API 6.7.2. UNAUTHENTICATED: Discriminator for the vapi.std.errors.unauthenticated type. This constant was added in vSphere API 6.7.2. UNAUTHORIZED: Discriminator for the vapi.std.errors.unauthorized type. This constant was added in vSphere API 6.7.2. UNEXPECTED_INPUT: Discriminator for the vapi.std.errors.unexpected_input type. This constant was added in vSphere API 6.7.2. UNSUPPORTED: Discriminator for the vapi.std.errors.unsupported type. This constant was added in vSphere API 6.7.2. UNVERIFIED_PEER: Discriminator for the vapi.std.errors.unverified_peer type. This constant was added in vSphere API 6.7.2.Optional. Can be unset for compatibility with preceding implementations. |