Diagnose
URI: http://soap.zeus.com/zxtm/1.1/Diagnose/
The Diagnose interface provides information about errors and problems in the system.
Methods
activateTrafficManagers( hostnames ) throws InvalidInput
Activate traffic managers that have recovered from failures and are ready to start taking Traffic IPs.
void activateTrafficManagers(
String[] hostnames
)diagnoseSystem()
Provides all diagnostic information about the system.
Diagnose.ErrorInfo diagnoseSystem()getInactiveTrafficManagers()
List the traffic managers that have recovered from failures and are ready to start taking Traffic IPs.
String[] getInactiveTrafficManagers()getTechnicalSupportReport()
Download a technical support report suitable for providing to your support provider to help diagnose problems.
Binary Data getTechnicalSupportReport()Structures
Diagnose.AgeError
This structure combines an error message with its age in seconds
struct Diagnose.AgeError {
# Seconds since the error occurred
Integer age;
# error message
String error;
}Diagnose.ConfigError
This structure contains information about configuration errors.
struct Diagnose.ConfigError {
# The file where the error has occurred.
String filename;
# The faulty configuration key
String ConfigKey;
# Severity of the error
Diagnose.ErrLevel severity;
# Date when the error occurred
Time DetectionDate;
# A human readable description of the error
String description;
}Diagnose.ErrorInfo
This structure combines configuration, node, and flipper errors as well as a list of statuses (for an appliance).
struct Diagnose.ErrorInfo {
# The list of traffic managers that could not be contacted.
String[] NotReachableTrafficManagers;
# The list of configuration errors.
Diagnose.ConfigError[] ConfigErrors;
# The list of flipper errors.
Diagnose.FlipperError[] FlipperErrors;
# The list of failed nodes.
Diagnose.FailedNode[] FailedNodes;
# The list of system status values.
Diagnose.SystemStatus[] SystemStatuses;
}Diagnose.FailedNode
This structure contains information about node failures.
struct Diagnose.FailedNode {
# The name of the node that has failed.
String node;
# IP address in standard IPv4 or IPv6 notation.
String IPAddress;
# The port number of the node that has failed.
Integer port;
# The pool in which this node exists.
String pool;
# Time that the failure first occurred.
Time InitialFailureTime;
# The last time an attempt was made to connect to the node.
Time LastConnectionAttempt;
# The last received error message.
String ErrorMessage;
}Diagnose.FlipperError
This structure contains information about Flipper errors.
struct Diagnose.FlipperError {
# The name of the affected machine.
String machine;
# IP address in standard IPv4 or IPv6 notation.
String IPAddress;
# All error messages for that machine.
Diagnose.AgeError[] errors;
}Diagnose.SystemStatus
Status information about the hardware in an appliance is reported by instances of this structure.
struct Diagnose.SystemStatus {
# The component this object refers to
String component;
# The severity level
Diagnose.ErrLevel severity;
# Human-readable description of the status
String message;
}Enumerations
Diagnose.ErrLevel
This enumeration defines the possible severity levels of an error.
enum Diagnose.ErrLevel {
# A fatal error, causes program to die/crash/fail to startup.
ERR_FATAL,
# A serious, unexpected error that shouldn't occur under normal conditions.
# Conditions which will prevent the server from operating properly and should
# be brought to the webmaster's attention immediately
ERR_SERIOUS,
# something which should be brought to the attention of the webmaster, but
# not immediately.
ERR_WARN,
# Minor things that might be of interest e.g. access denied.
ERR_INFO
}