# 02110-1301, USA.
+# pylint: disable-msg=W0401,W0614
+# W0401: Wildcard import ganeti.cli
+# W0614: Unused import %s from wildcard import (since we need cli)
+
import sys
-import os
-import itertools
-import time
-from optparse import make_option
-from cStringIO import StringIO
from ganeti.cli import *
-from ganeti import opcodes
-from ganeti import logger
from ganeti import constants
-from ganeti import utils
from ganeti import errors
+from ganeti import utils
+#: default list of fields for L{ListJobs}
_LIST_DEF_FIELDS = ["id", "status", "summary"]
+#: map converting the job status contants to user-visible
+#: names
_USER_JOB_STATUS = {
constants.JOB_STATUS_QUEUED: "queued",
+ constants.JOB_STATUS_WAITLOCK: "waiting",
+ constants.JOB_STATUS_CANCELING: "canceling",
constants.JOB_STATUS_RUNNING: "running",
constants.JOB_STATUS_CANCELED: "canceled",
constants.JOB_STATUS_SUCCESS: "success",
def ListJobs(opts, args):
"""List the jobs
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should be an empty list
+ @rtype: int
+ @return: the desired exit code
+
"""
if opts.output is None:
selected_fields = _LIST_DEF_FIELDS
else:
selected_fields = opts.output.split(",")
- output = GetClient().QueryJobs(None, selected_fields)
+ output = GetClient().QueryJobs(args, selected_fields)
if not opts.no_headers:
# TODO: Implement more fields
headers = {
else:
headers = None
- # we don't have yet unitfields here
- unitfields = None
- numfields = None
-
# change raw values to nicer strings
for row in output:
for idx, field in enumerate(selected_fields):
row[idx] = str(val)
data = GenerateTable(separator=opts.separator, headers=headers,
- fields=selected_fields, unitfields=unitfields,
- numfields=numfields, data=output)
+ fields=selected_fields, data=output)
for line in data:
- print line
+ ToStdout(line)
return 0
def ArchiveJobs(opts, args):
+ """Archive jobs.
+
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain the job IDs to be archived
+ @rtype: int
+ @return: the desired exit code
+
+ """
client = GetClient()
for job_id in args:
return 0
+def AutoArchiveJobs(opts, args):
+ """Archive jobs based on age.
+
+ This will archive jobs based on their age, or all jobs if a 'all' is
+ passed.
+
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the age as a time spec
+ that can be parsed by L{ganeti.cli.ParseTimespec} or the
+ keyword I{all}, which will cause all jobs to be archived
+ @rtype: int
+ @return: the desired exit code
+
+ """
+ client = GetClient()
+
+ age = args[0]
+
+ if age == 'all':
+ age = -1
+ else:
+ age = ParseTimespec(age)
+
+ (archived_count, jobs_left) = client.AutoArchiveJobs(age)
+ ToStdout("Archived %s jobs, %s unchecked left", archived_count, jobs_left)
+
+ return 0
+
+
def CancelJobs(opts, args):
+ """Cancel not-yet-started jobs.
+
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain the job IDs to be cancelled
+ @rtype: int
+ @return: the desired exit code
+
+ """
client = GetClient()
for job_id in args:
- client.CancelJob(job_id)
+ (success, msg) = client.CancelJob(job_id)
+ ToStdout(msg)
+ # TODO: Different exit value if not all jobs were canceled?
return 0
def ShowJobs(opts, args):
- """List the jobs
+ """Show detailed information about jobs.
+
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain the job IDs to be queried
+ @rtype: int
+ @return: the desired exit code
"""
def format(level, text):
"""Display the text indented."""
- print "%s%s" % (" " * level, text)
+ ToStdout("%s%s", " " * level, text)
def result_helper(value):
"""Format a result field in a nice way."""
first = True
- for entry, arg_job in zip(result, args):
+ for idx, entry in enumerate(result):
if not first:
format(0, "")
else:
first = False
if entry is None:
- format(0, "Job ID %s not found" % arg_job)
+ if idx <= len(args):
+ format(0, "Job ID %s not found" % args[idx])
+ else:
+ # this should not happen, when we don't pass args it will be a
+ # valid job returned
+ format(0, "Job ID requested as argument %s not found" % (idx + 1))
continue
(job_id, status, ops, opresult, opstatus, oplog,
if status in _USER_JOB_STATUS:
status = _USER_JOB_STATUS[status]
else:
- raise errors.ProgrammerError("Unknown job status code '%s'" % val)
+ raise errors.ProgrammerError("Unknown job status code '%s'" % status)
format(1, "Status: %s" % status)
if key == "OP_ID":
continue
if isinstance(val, (tuple, list)):
- val = ",".join(val)
+ val = ",".join([str(item) for item in val])
format(4, "%s: %s" % (key, val))
if result is None:
format(3, "No output data")
format(3, "Execution log:")
for serial, log_ts, log_type, log_msg in log:
time_txt = FormatTimestamp(log_ts)
- encoded = str(log_msg).encode('string_escape')
+ encoded = utils.SafeEncode(log_msg)
format(4, "%s:%s:%s %s" % (serial, time_txt, log_type, encoded))
return 0
commands = {
- 'list': (ListJobs, ARGS_NONE,
- [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT],
- "", "List the jobs and their status. The available fields are"
+ 'list': (ListJobs, ARGS_ANY,
+ [DEBUG_OPT, NOHDR_OPT, SEP_OPT, FIELDS_OPT],
+ "[job_id ...]",
+ "List the jobs and their status. The available fields are"
" (see the man page for details): id, status, op_list,"
" op_status, op_result."
" The default field"
[DEBUG_OPT],
"<job-id> [<job-id> ...]",
"Archive specified jobs"),
+ 'autoarchive': (AutoArchiveJobs, ARGS_ONE,
+ [DEBUG_OPT],
+ "<age>",
+ "Auto archive jobs older than the given age"),
'cancel': (CancelJobs, ARGS_ANY,
[DEBUG_OPT],
"<job-id> [<job-id> ...]",
projects / ganeti-local / blobdiff