ganeti.client.gnt

module documentation

Job related commands

Function	`ArchiveJobs`	Archive jobs.
Function	`AutoArchiveJobs`	Archive jobs based on age.
Function	`CancelJobs`	Cancel not-yet-started jobs.
Function	`ChangePriority`	Change priority of jobs.
Function	`ListJobFields`	List job fields.
Function	`ListJobs`	List the jobs
Function	`Main`	Undocumented
Function	`ShowJobs`	Show detailed information about jobs.
Function	`WaitJob`	Wait for a job to finish, not producing any output.
Function	`WatchJob`	Follow a job and print its output as it arrives.
Variable	`aliases`	Undocumented
Variable	`commands`	Undocumented
Function	`_CalcDelta`	Calculates the delta between two timestamps.
Function	`_FormatStatus`	Formats a job status.
Function	`_FormatSummary`	Formats a job's summary.
Function	`_ListJobTimestamp`	Adds the job timestamp to the given container.
Function	`_ListOpcodeTimestamp`	Adds the opcode timestamp to the given container.
Function	`_MultiJobAction`	Applies a function to multiple jobs.
Function	`_ParseJobIds`	Parses a list of string job IDs into integers.
Constant	`_ARCHIVED_OPT`	Undocumented
Constant	`_ERROR_OPT`	Undocumented
Constant	`_FINISHED_OPT`	Undocumented
Constant	`_JOB_LIST_FORMAT`	Undocumented
Constant	`_KILL_OPT`	Undocumented
Constant	`_LIST_DEF_FIELDS`	Undocumented
Constant	`_PENDING_OPT`	Undocumented
Constant	`_QUEUED_OPT`	Undocumented
Constant	`_RUNNING_OPT`	Undocumented
Constant	`_USER_JOB_STATUS`	Undocumented
Constant	`_WAITING_OPT`	Undocumented
Constant	`_YES_DOIT_OPT`	Undocumented

def ArchiveJobs(opts, args): ¶

Archive jobs.

Parameters
opts	the command line options selected by the user
args:list	should contain the job IDs to be archived
Returns
int	the desired exit code

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.

Parameters
opts	the command line options selected by the user
args:list	should contain only one element, the age as a time spec that can be parsed by `ganeti.cli.ParseTimespec` or the keyword all, which will cause all jobs to be archived
Returns
int	the desired exit code

def CancelJobs(opts, args, cl=None, _stdout_fn=ToStdout, _ask_fn=AskUser): ¶

Cancel not-yet-started jobs.

Parameters
opts	the command line options selected by the user
args:list	should contain the job IDs to be cancelled
cl	Undocumented
_stdout_fn	Undocumented
_ask_fn	Undocumented
Returns
int	the desired exit code

def ChangePriority(opts, args): ¶

Change priority of jobs.

Parameters
opts	Command line options
args:list	Job IDs
Returns
int	Exit code

def ListJobFields(opts, args): ¶

List job fields.

Parameters
opts	the command line options selected by the user
args:list	fields to list, or empty for all
Returns
int	the desired exit code

def ListJobs(opts, args): ¶

List the jobs

Parameters
opts	the command line options selected by the user
args:list	should be an empty list
Returns
int	the desired exit code

def Main(): ¶

Undocumented

def ShowJobs(opts, args): ¶

Show detailed information about jobs.

Parameters
opts	the command line options selected by the user
args:list	should contain the job IDs to be queried
Returns
int	the desired exit code

def WaitJob(opts, args): ¶

Wait for a job to finish, not producing any output.

Parameters
opts	the command line options selected by the user
args:list	Contains the job ID
Returns
int	the desired exit code

def WatchJob(opts, args): ¶

Follow a job and print its output as it arrives.

Parameters
opts	the command line options selected by the user
args:list	Contains the job ID
Returns
int	the desired exit code

aliases: dict[str, str] = ¶

Undocumented

commands = ¶

Undocumented

def _CalcDelta(from_ts, to_ts): ¶

Calculates the delta between two timestamps.

def _FormatStatus(value): ¶

Formats a job status.

def _FormatSummary(value): ¶

Formats a job's summary.

def _ListJobTimestamp(name, ts, container, prior_ts=None): ¶

Adds the job timestamp to the given container.

Parameters
name	Undocumented
ts	Undocumented
container	Undocumented
prior_ts	The timestamp used to calculate the amount of time that passed since the given timestamp.

def _ListOpcodeTimestamp(name, ts, container): ¶

Adds the opcode timestamp to the given container.

def _MultiJobAction(opts, args, cl, stdout_fn, ask_fn, question, action_fn): ¶

Applies a function to multiple jobs.

Parameters
opts	Command line options
args:list	Job IDs
cl	Undocumented
stdout_fn	Undocumented
ask_fn	Undocumented
question	Undocumented
action_fn	Undocumented
Returns
int	Exit code

def _ParseJobIds(args): ¶

Parses a list of string job IDs into integers.

Parameters
args	list of strings
Returns
list of integers
Raises
`OpPrereqError`	in case of invalid values

_ARCHIVED_OPT = ¶

Undocumented

Value

cli_option('--archived',
           default=False,
           action='store_true',
           dest='archived',
           help='Include archived jobs in list (slow and expensive)')

_ERROR_OPT = ¶

Undocumented

Value

cli_option('--error',
           default=None,
           action='store_const',
           dest='status_filter',
           const=frozenset([constants.JOB_STATUS_ERROR]),
           help='Show failed jobs only')

_FINISHED_OPT = ¶

Undocumented

Value

cli_option('--finished',
           default=None,
           action='store_const',
           dest='status_filter',
           const=constants.JOBS_FINALIZED,
           help='Show finished jobs only')

_JOB_LIST_FORMAT = ¶

Undocumented

Value

{'status': (_FormatStatus, False), 'summary': (_FormatSummary, False)}

_KILL_OPT = ¶

Undocumented

Value

cli_option('--kill',
           default=False,
           action='store_true',
           dest='kill',
           help='Kill running jobs with SIGKILL')

_LIST_DEF_FIELDS: list[str] = ¶

Undocumented

Value

['id', 'status', 'summary']

_PENDING_OPT = ¶

Undocumented

Value

cli_option('--pending',
           default=None,
           action='store_const',
           dest='status_filter',
           const=constants.JOBS_PENDING,
           help='Select jobs pending execution or being cancelled')

_QUEUED_OPT = ¶

Undocumented

Value

cli_option('--queued',
           default=None,
           action='store_const',
           dest='status_filter',
           const=frozenset([constants.JOB_STATUS_QUEUED]),
           help='Select queued jobs only')

_RUNNING_OPT = ¶

Undocumented

Value

cli_option('--running',
           default=None,
           action='store_const',
           dest='status_filter',
           const=frozenset([constants.JOB_STATUS_RUNNING]),
           help='Show jobs currently running only')

_USER_JOB_STATUS = ¶

Undocumented

Value

{constants.JOB_STATUS_QUEUED: 'queued',
 constants.JOB_STATUS_WAITING: 'waiting',
 constants.JOB_STATUS_CANCELING: 'canceling',
 constants.JOB_STATUS_RUNNING: 'running',
 constants.JOB_STATUS_CANCELED: 'canceled',
 constants.JOB_STATUS_SUCCESS: 'success',
 constants.JOB_STATUS_ERROR: 'error'}

_WAITING_OPT = ¶

Undocumented

Value

cli_option('--waiting',
           default=None,
           action='store_const',
           dest='status_filter',
           const=frozenset([constants.JOB_STATUS_WAITING]),
           help='Select waiting jobs only')

_YES_DOIT_OPT = ¶

Undocumented

Value

cli_option('--yes-do-it', '--ya-rly',
           dest='yes_do_it', help='Really use --kill', action='store_true')

ganeti.client.gnt_job

`ganeti.client.gnt_job`