1. Types
  2. vcenter
  3. ovf

vcenter ovf: parse issue

The parse_issue structure contains the information about the issue found when parsing an OVF package during deployment or exporting an OVF package including:
  • Parsing and validation error on OVF descriptor (which is an XML document), manifest and certificate files.
  • OVF descriptor generating and device error.
  • Unexpected server error.

Representation:

{
    "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" : [
            {
                "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"
            }
        ]
    }
}

Attributes:

Name Type Description
Required
-.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:

  • OVF descriptor parsing errors, for example, syntax errors or schema errors.
  • Manifest file parsing and verification errors.
  • Certificate file parsing and verification errors.

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.
-.file string The name of the file in which the parse issue was found.
-.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).
-.column_number long The position in the line (see vcenter.ovf.parse_issue.line_number) (or -1 if not applicable).
-.message localizable_message A localizable message describing the parse issue.
-.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.
Optional
-.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.