Difference between revisions of "CLI"

From CRIU
Jump to navigation Jump to search
m (+ live migration and diskless live migration links)
(add deprecated stuff)
 
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Since the tools and overall concept are still under heavy development, there are some known limitations applied, in particular only pure x86-64 environment is supported, no IA32 emulation allowed.
+
This is a collection of articles describing specific CRIU command line options.
  
== Synopsis ==
+
== Actions ==
<pre>
+
{{Special:PrefixIndex/CLI/cmd/|stripprefix=1}}
'crtools' [-c] [-s] [-f <file>] [-d] [-n] [-o <path>] [-D <path>] [-v [num]] [--help] <command> (-p|-t) <pid>
 
</pre>
 
 
 
== Description ==
 
'crtools' is command line utility to steer checkpoint and restore procedure.
 
  
 
== Options ==
 
== Options ==
<pre>
+
{{Special:PrefixIndex/CLI/opt/|stripprefix=1}}
<command>::
 
    One of the follwong commands
 
        * 'dump'
 
                to initiate checkpoint procedure
 
        * 'restore'
 
                to restore previously checkpointed processes
 
        * 'show'
 
                to decode binary dump files and show their contents in human
 
                readable format
 
        * 'check'
 
                to test whether the kernel support is up-to-date
 
        * 'exec'
 
                to execute a system call from another task's context
 
 
 
-c::
 
    In case of 'show' command the dumped pages content will be shown in hex format.
 
 
 
-D <path>::
 
    Use path 'path' as a base directory where to look for dump files set. This
 
    commands allpies to any <command>.
 
 
 
-s::
 
    Leave tasks in stopped state after checkpoint instead of killing them.
 
 
 
-f <file>::
 
    This option is valid for 'show' command only and allows to see content of
 
    the <file> specified.
 
 
 
-t <pid>::
 
    Checkpoint the whole process tree starting from 'pid'.
 
 
 
-d::
 
    Detach 'crtools' itself once restore is complete.
 
 
 
-n <ns>::
 
    Checkpoint namespaces. Namespaces must be separated by comma.
 
    We now support all namespaces -- uts, ipc, net and mnt
 
  
-o <file>::
+
== Deprecated stuff ==
    Write logging messages to 'file'.
 
  
-v <num>::
+
=== Actions ===
    Set logging level to 'num'. Valid options are: 0 - (silent, error messages
+
{{Special:PrefixIndex/CLI/deprecated/cmd/|stripprefix=1}}
    only), 1 - informative (default), 2 - debug messages.
 
</pre>
 
  
== Further reading ==
+
=== Options ===
 +
{{Special:PrefixIndex/CLI/deprecated/opt/|stripprefix=1}}
  
Refer to [[Advanced usage]] article for more options.
+
== See also ==
  
Also check the [[Remote syscall execution]] article for 'exec' command info.
+
* [[Advanced usage]] article for more options
 +
* [[RPC]] -- an API to C/R functionality
 +
* [[API compliance]]
 +
* [[:Category:HOWTO]]
  
[[Live migration]] and [[Disk-less migration]]
+
[[Category: API]]

Latest revision as of 19:32, 20 September 2016