vm-install-jobs(8)vm-install-jobs(8)NAMEvm-install-jobs - queries and manages VM creation jobs that were
started by vm-install
SYNOPSISvm-install-jobs [options ...]
DESCRIPTION
VMs may be created by vm-install interactively, or as backgrounded
jobs. The vm-install-jobs command manages backgrounded VM creation
jobs.
OPTIONS--cancel job-id
Cancels the specified job. If the VM is still running, it is
stopped. This command may return before the VM is completely
stopped or the vm-install process has completely exited. The
job is not implicitly deleted, so that the cancelation progress
may be observed.
--delete job-id
Deletes the specified job. The job must be in one of the FIN‐
ISHED, FAILED, or CANCELED states. The VM's configuration is
deleted, as are any disks that were created during the job.
--detach job-id
Detaches the created VM from the specified job. The job must be
in the FINISHED state. The job is deleted, but the VM's config‐
uration and its disks are left intact.
--list Lists all known VM creation jobs, by ID. One job ID is output
per line.
--status job-id
Outputs the status of the specified job.
JOB STATES
Every job is always in one of the following states:
0: SETTINGS
1: PREP_INSTALL
2: INSTALL
3: POST_INSTALL
4: RUNTIME_CONF
5: RUNTIME
6: FINISHED
7: FAILED
8: CANCELED
The normal progression is from state 0 to state 6. States 6, 7, and 8
are terminal states.
JOB STATUS
Querying the job status will print (to stdout) a number of key/value
pairs. The possible keys and their meanings are:
exit The exit code of the VM creation job. This key is only present
once the job is in one of the states FINISHED, FAILED, or CAN‐
CELED. To interpret the meaning of the exit code, see vm-
install(8)
id The job ID. Always present.
inotify
A filename to monitor (via inotify(7) ) for state changes. The
recommended inotify mask to use is IN_CLOSE_WRITE. Always
present.
log The location of the log file. Always present.
pid The process ID of the VM creation job. This key is only present
if the VM creation process is still running. The PID is used
internally to cancel the job.
state The job's current state. See JOB STATES. Always present.
uuid The VM's UUID. This key is only present once all of the VM's
settings have been gathered.
vnc The last known location to view the VM's console via VNC. Note
that the presence of this key does not guarantee that the VM is
currently running. When no authentication is necessary, the URL
will be ip::port. If authentication is necessary, the URL will
be username:password@ip::port.
DIAGNOSTICS
A zero exit code indicates success; non-zero indicates failure.
Note that the exit code of this tool indicates the success of the job
management command. It does not represent the success or failure of
the job itself.
SEE ALSO
To interpret the exit code of a job or of this command, see vm-
install(8)
To monitor state changes of jobs, see inotify(7)
To report problems with this software or its documentation, visit
http://bugzilla.novell.com
2007-02-01 vm-install-jobs(8)
