exception documentation

class QuitGanetiException(Exception):

View In Hierarchy

Signal Ganeti that it must quit.

This is not necessarily an error (and thus not a subclass of GenericError), but it's an exceptional circumstance and it is thus treated. This exception should be instantiated with two values. The first one will specify the return code to the caller, and the second one will be the returned result (either as an error or as a normal result). Usually only the leave cluster rpc call should return status True (as there it's expected we quit), every other call will return status False (as a critical error was encountered).

Examples:

  # Return a result of "True" to the caller, but quit ganeti afterwards
  raise QuitGanetiException(True, None)
  # Send an error to the caller, and quit ganeti
  raise QuitGanetiException(False, "Fatal safety violation, shutting down")