~ubuntu-branches/ubuntu/quantal/lxc/quantal-201206191543

« back to all changes in this revision

Viewing changes to doc/lxc-restart.1

  • Committer: Package Import Robot
  • Author(s): Daniel Baumann
  • Date: 2012-03-09 13:05:03 UTC
  • mto: (3.1.38 sid)
  • mto: This revision was merged to the branch mainline in revision 94.
  • Revision ID: package-import@ubuntu.com-20120309130503-j0prgw9tsp967bbv
Tags: upstream-0.8.0~rc1
ImportĀ upstreamĀ versionĀ 0.8.0~rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" This manpage has been automatically generated by docbook2man 
 
2
.\" from a DocBook document.  This tool can be found at:
 
3
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 
4
.\" Please send any bug reports, improvements, comments, patches, 
 
5
.\" etc. to Steve Cheng <steve@ggi-project.org>.
 
6
.TH "LXC-RESTART" "1" "02 March 2012" "IBM" ""
 
7
 
 
8
.SH NAME
 
9
lxc-restart \- restart a container from a file (not implemented yet)
 
10
.SH SYNOPSIS
 
11
 
 
12
\fBlxc-restart [-f
 
13
config_file][-s KEY=VAL]
 
14
--statefile=\fIFILE\fB
 
15
--statefd=\fIFD\fB\fR \fB--name=\fINAME\fB\fR
 
16
 
 
17
.SH "DESCRIPTION"
 
18
.PP
 
19
\fBlxc-restart\fR is a command
 
20
to restart an application from the state read in the specified
 
21
\fIFILE\fR, in a container with the
 
22
identifier \fINAME\fR\&.
 
23
If the option \fB--pause\fR
 
24
is specified, the application will be stopped after the
 
25
restart just before resuming execution. The command
 
26
\fBlxc-unfreeze\fR will be needed to resume its
 
27
execution.
 
28
.SH "RESTART OPTIONS"
 
29
.TP
 
30
\fB-S, --statefile=\fIFILE\fB\fR
 
31
read the state of the container in this
 
32
\fIFILE\fR\&.
 
33
This option is exclusive with \fB--statefd\fR below.
 
34
.TP
 
35
\fB-d, --statefd=\fIFD\fB\fR
 
36
read the state of the container in this
 
37
\fIFD\fR file descriptor.
 
38
This option is exclusive with above \fB--statefile\fR\&.
 
39
.TP
 
40
\fB-p\fR
 
41
Pause container processes after restart. The container will be
 
42
stopped until you resume it with the lxc-unfreeze command.
 
43
.TP
 
44
\fB-f, --rcfile=\fIconfig_file\fB\fR
 
45
Specify the configuration file to configure the
 
46
virtualization and isolation functionalities for the
 
47
container. This parameter should be specified if it was
 
48
specified for the \fBlxc-execute\fR
 
49
or \fBlxc-start\fR commands or if the
 
50
container configuration has to be changed at restart. The
 
51
latter may fail if the needed resources are not available
 
52
for the restart. If the container was created and
 
53
configured with \fBlxc-create\fR, this option
 
54
is not needed, the configuration will be automatically
 
55
found.
 
56
.TP
 
57
\fB   -s \fIKEY=VAL\fB \fR
 
58
Assign value \fIVAL\fR to configuration
 
59
variable \fIKEY\fR\&. This overrides any
 
60
assignment done in \fIconfig_file\fR\&.
 
61
.SH "COMMON OPTIONS"
 
62
.PP
 
63
These options are common to most of lxc commands.
 
64
.TP
 
65
\fB-?, -h, --help\fR
 
66
Print a longer usage message than normal.
 
67
.TP
 
68
\fB--usage\fR
 
69
Give the usage message
 
70
.TP
 
71
\fB-q, --quiet\fR
 
72
mute on
 
73
.TP
 
74
\fB-o, --logfile=\fIFILE\fB\fR
 
75
Output to an alternate log
 
76
\fIFILE\fR\&. The default is no log.
 
77
.TP
 
78
\fB-l, --logpriority=\fILEVEL\fB\fR
 
79
Set log priority to
 
80
\fILEVEL\fR\&. The default log
 
81
priority is ERROR\&. Possible values are :
 
82
FATAL, CRIT,
 
83
WARN, ERROR,
 
84
NOTICE, INFO,
 
85
DEBUG\&.
 
86
 
 
87
Note that this option is setting the priority of the events
 
88
log in the alternate log file. It do not have effect on the
 
89
ERROR events log on stderr.
 
90
.TP
 
91
\fB-n, --name=\fINAME\fB\fR
 
92
Use container identifier \fINAME\fR\&.
 
93
The container identifier format is an alphanumeric string.
 
94
.SH "EXAMPLES"
 
95
.PP
 
96
To start a new container 123 computing decimals of pi
 
97
 
 
98
.nf
 
99
      lxc-execute -n 123 -- pi1 -d 500000
 
100
      lxc-execute --name=123 -- pi1 -d 500000
 
101
    
 
102
.fi
 
103
.PP
 
104
to checkpoint the same container in \fBdump-death\fR
 
105
mode
 
106
 
 
107
.nf
 
108
      lxc-checkpoint -n 123 -S /share/123/chkpt1 -k
 
109
      lxc-checkpoint --name=123 --statefile=/share/123/chkpt1 -k
 
110
    
 
111
.fi
 
112
.PP
 
113
and to restart the same container with a different id
 
114
 
 
115
.nf
 
116
      lxc-restart -n 200 -S /share/123/chkpt1
 
117
      lxc-restart --name=200 --statefile=/share/123/chkpt1
 
118
    
 
119
.fi
 
120
.SH "NOTES"
 
121
.PP
 
122
Actually, this command does not operate. Its description
 
123
helps to define a CLI api for future Checkpoint / Restart
 
124
solution
 
125
.SH "SEE ALSO"
 
126
.PP
 
127
\fBlxc\fR(1),
 
128
\fBlxc-create\fR(1),
 
129
\fBlxc-destroy\fR(1),
 
130
\fBlxc-start\fR(1),
 
131
\fBlxc-stop\fR(1),
 
132
\fBlxc-execute\fR(1),
 
133
\fBlxc-kill\fR(1),
 
134
\fBlxc-console\fR(1),
 
135
\fBlxc-monitor\fR(1),
 
136
\fBlxc-wait\fR(1),
 
137
\fBlxc-cgroup\fR(1),
 
138
\fBlxc-ls\fR(1),
 
139
\fBlxc-ps\fR(1),
 
140
\fBlxc-info\fR(1),
 
141
\fBlxc-freeze\fR(1),
 
142
\fBlxc-unfreeze\fR(1),
 
143
\fBlxc-attach\fR(1),
 
144
\fBlxc.conf\fR(5)
 
145
.SH "AUTHOR"
 
146
.PP
 
147
Daniel Lezcano <daniel.lezcano@free.fr>