Difference between revisions of "CLI"

From CRIU
Jump to navigation Jump to search
(add deprecated stuff)
 
(29 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' <command> -t <pid> [<options>]
 
−
</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>::
 
−
    Write logging messages to 'file'.
 
−
 
 
−
-v <num>::
 
−
    Set logging level to 'num'. Valid options are: 0 - (silent, error messages
 
−
    only), 1 - informative (default), 2 - debug messages.
 
−
</pre>
 
−
 
 
−
== Examples ==
 
−
 
 
−
To checkpoint a program with pid 1234 and write all image files into directory checkpoint one should type
 
−
 
 
−
<pre>
 
−
# crtools dump -D checkpoint -t 1234
 
−
</pre>
 
−
 
 
−
To restore this program detaching crtools itself, one should type
 
−
 
 
−
<pre>
 
−
crtools restore -d -D checkpoint -t 1234
 
−
</pre>
 
−
 
 
−
"Detaching" (the <code>-d</code> option) here means, that crtools will exit after restoring the processes
 
−
and the latter will get re-parent-ed to the init task.
 
−
 
 
−
To close a file descriptor number 1 in task with pid 1234 run
 
−
 
 
−
<pre>
 
−
crtools exec -t 1234 close 1
 
−
</pre>
 
  
−
To open a file named /foo/bar for read-write in the task with pid 1234 run
+
== Deprecated stuff ==
  
−
<pre>
+
=== Actions ===
−
crtools exec -t 1234 open '&/foo/bar' 2
+
{{Special:PrefixIndex/CLI/deprecated/cmd/|stripprefix=1}}
−
</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

This is a collection of articles describing specific CRIU command line options.

Actions[edit]

Options[edit]

Deprecated stuff[edit]

Actions[edit]

Options[edit]

See also[edit]

Retrieved from "https://criu.org/index.php?title=CLI&oldid=3461"