10.5 HP StoreVirtual LeftHand OS Command Line Interface User Guide (AX696-96242, March 2013)

10| HP StoreVirtual CLI| Return Codes
Return Codes
All GAUCHE commands return an XML response containing a 32-bit result code, and a description of the
result. Example:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<gauche version="1.0">
<response description="Succeeded" result="0"/>
</gauche>
Success results are nonnegative values, while negative values indicate an error. Many errors returned by
LeftHand OS and Hydra unfortunately do not return ordinal values that can be conveniently mapped into an
API and CLI return code. In all cases, we can return the error description string, but it won't be feasible to
return a sensible ordinate value (other than GaucheGeneralError) without parsing the description string.
Result Value OS Status Description
CliqSuccess 0 0 Everything succeeded normally
CliqNothingDone 1 1 Operation has succeeded, but
nothing was done (the system was
already in the requested state).
CliqOperationPending 2 2 Operation has not failed, but is
not yet complete. The "handle"
parameter contains a value that can
be used to query and cancel the
operation.
CliqOperationAbandoned 3 3 Operation was cancelled or
abandonded.
CliqNothingFound 4 4 Operation found no objects.
CliqSnapshotSet 5 5 This snapshot was a part of the
snapshot set.
CliqVssSnapshotWarning 6 6 Warning: The writer operation
failed.
CliqPITSnapshotWarning 7 7 Warning: Point in time snapshot is
created.
CliqParameterIgnored 8 8 The operation succeeded but a
parameter was ignored as it is not
applicable.
CliqUnexpected 0x80001001 128 An unexpected error has occurred.
CliqXmlError 0x80001002 129 The XML given is not well-formed.
CliqParameterFormat 0x80001003 130 The parameter is not specified
correctly.
CliqParameterRepeat 0x80001004 131 A parameter is repeated.
CliqMissingMethod 0x80001005 132 The command method is missing.
CliqMissingParameter 0x80001006 133 One or more expected parameters
are missing.
CliqUnrecognizedCommand 0x80001007 134 This command is unrecognized.