SOAP Faults

When a function encounters an error it will emit a fault. Depending on the fault that occurred the fault structure will contain more information related to the fault. The documentation for individual functions lists the different types of faults that a function can emit.

Faults

DeploymentError

The DeploymentError fault is raised when a configuration change causes errors when attempting to apply the configuration to a running traffic manager. It would be raised in cases such as failing to bind to a port when enabling a Virtual Server.

struct DeploymentError {

# A human readable string describing the error

String errmsg;

# The name of the object that caused the fault (if appropriate)

String object;

# The configuration key that caused the fault (if appropriate)

String key;

# The value that caused the fault (if appropriate)

String value;

}

InvalidInput

The InvalidInput fault is raised when the input to a function is invalid, for example a number was out of range. This fault is also raised in cases such as VirtualServer.setPool() where the Pool doesn't exist The details in the fault contain the object, key and value that caused the fault. These might be blank if they are not relevant to the fault.

struct InvalidInput {

# A human readable string describing the error

String errmsg;

# The name of the object that caused the fault (if appropriate)

String object;

# The configuration key that caused the fault (if appropriate)

String key;

# The value that caused the fault (if appropriate)

String value;

}

InvalidObjectName

The InvalidObjectName fault is raised when attempting to create a new object (e.g. via an add, rename or copy) and the name is invalid (e.g. it contains a '/').

struct InvalidObjectName {

# A human readable string describing the error

String errmsg;

# The name of the object that caused the fault

String object;

}

InvalidOperation

The InvalidOperation fault is emitted when attempting an operation that doesn't make sense or is prohibited, for example deleting a built-in monitor, or attempting to rename an object twice in the same call.

struct InvalidOperation {

# A human readable string describing the error

String errmsg;

# The name of the object that caused the fault (if appropriate)

String object;

# The configuration key that caused the fault (if appropriate)

String key;

# The value that caused the fault (if appropriate)

String value;

}

LicenseError

The LicenseError fault is emitted when attempting to use functionality that is disabled by the license key. You will need to contact your support provider to get a new license key with the required functionality. There may be a charge for this.

struct LicenseError {

# A human readable string describing the error

String errmsg;

# The license key feature that was missing

String feature;

}

ObjectAlreadyExists

The ObjectAlreadyExists fault is raised when attempting to create an object (such as a Virtual Server) that already exists. It will also be raised in cases such as renaming and copying objects.

struct ObjectAlreadyExists {

# A human readable string describing the error

String errmsg;

# The name of the object that caused the fault

String object;

}

ObjectDoesNotExist

The ObjectDoesNotExist fault is raised when attempting to perform an operation on an object (such as Virtual Server) that doesn't exist. This fault will only be raised if the primary object in the call doesn't exist. For example if calling VirtualServer.setPool(), then this fault will be raised if the Virtual Server doesn't exist, but if the Pool doesn't exist then the "InvalidInput" fault will be raised.

struct ObjectDoesNotExist {

# A human readable string describing the error

String errmsg;

# The name of the object that caused the fault

String object;

}

ObjectInUse

The ObjectInUse fault is raised when attempting to delete an object that is referenced by another object, for example deleting a Pool that is in use by a Virtual Server.

struct ObjectInUse {

# A human readable string describing the error

String errmsg;

# The name of the object that caused the fault

String object;

}