Changes

← Older edit

Man/vzctl.8

12,602 bytes added, 18:21, 23 April 2015

Automated import of articles *** existing text overwritten ***

[flags] start CTID [--wait]

[--force] [--skip-fsck][--skip-remount] </td></tr>

[flags] restart CTID

[--wait] [--force] [--fast][--skip-fsck] [--skip-remount]</td></tr>

[flags] ~~chkpnt~~suspend | ~~restore~~resumeCTID [--dumpfile name] </td></tr>

[flags] snapshot CTID

[--id uuid]

[--name name]

[--description desc]

[--skip-suspend] [--skip-config] </td></tr>

[flags] snapshot-switch CTID[--skip-resume |--must-resume][~~snapshot~~-~~delete~~ -skip-config] --id uuid</td></tr>

[flags] snapshot-delete CTID--id uuid</td></tr><tr valign="top" align="left"><td width="11%"></td><td width="7%"> vzctl</td><td width="2%"></td><td width="80%"> [flags] snapshot-mount CTID--id uuid --target dir</td></tr><tr valign="top" align="left"><td width="11%"></td><td width="7%"> vzctl</td><td width="2%"></td><td width="80%"> [flags] snapshot-umount CTID--id uuid</td></tr><tr valign="top" align="left"><td width="11%"></td><td width="7%"> vzctl</td><td width="2%"></td><td width="80%"> [flags] snapshot-listCTID[-H] [-o field[,field...][--id uuid]</td></tr>

[flags] set CTID --parameter value

[...] [--save] [--force~~] [--reset_ub~~]

[--setmode restart|ignore] </td></tr>

vzctl</td>

[flags] set CTID

--reset_ub </td></tr>

be referred to by either numeric CTID or by name (see

--name option). Note that CT ID <= 100 are

reserved for OpenVZ internal purposes. A numeric ID shouldnot be more than 2147483644.

== OPTIONS ==

[--name name]

[--description string]

[--ostemplate string]

[--stop-timeout seconds]

[--ipadd addr]

[--ipdel addr|all]

[--ram bytes]

[--swap bytes]

[--vm_overcommit float]

[--cpuunits num]

[--cpulimit num]

[--cpus num]

[--cpumask cpus|auto|all][--nodemask nodes|all]

[--meminfo none|mode:value]

[--iptables name[,...]]

[--netfilter disabled|stateless|stateful|full]

[--netdev_add ifname]

[--netdev_del ifname]

[--applyconfig name]

[--applyconfig_map group]

[--ioprio num][--iolimit mbps][--iopslimit iops] [--save]

[--force] [--reset_ub]

[--setmode restart|ignore] </td></tr>

If this flag is given together

with --save, parameters are saved even if the current

kernel doesn’t support OpenVZ. Note this flag does notmake sense without --save, so --save isrequired.

--reset_ub

the configuration file to a running container. This is

helpful in case configuration file is modified manually.

Please note this flag is exclusive, i.e. it can not ~~compatible with --save,~~be~~and it is usually a bad idea to combine it~~ combined with any otheroptionsor flags.

--setmode restart |

A few parameters can only be

applied by restarting the container. By default,

vzctl ~~warns~~ prints a warning if such parameters are ~~present~~ supplied and acontainer is running. Use --setmode restart together with --save flag torestart a container in such a case, or --setmodeignore to suppress the ~~above mentioned~~ warning.

==== Miscellaneous ====

Sets whether the container will

be started during system boot. The container will ~~not~~ bestarted~~auto-started unless~~ on boot by vz initscript if either this parameter is set to yes, or the container was running just beforelast reboot, and this parameter is not set to no.Default value is unset, meaning the container will bestarted if it was running before the last reboot.

--bootorder

exists. Note that this option is not saved in configuration

file at all (so --save flag is useless), it is

applied directly to the container (, by ~~modifying its /etc/passwd and~~running~~/etc/shadow files)~~distribution-specific programs inside the container. It isnot recommended to combine this option with any otheroptions.

In case

container ~~root filesystem is~~ was not ~~mounted~~running, it isautomatically ~~mounted,~~ started then all the appropriate ~~file~~ changesare applied, then it is ~~unmounted~~stopped.

Note that

Add a name for a container. The

name can later be used in subsequent calls to

vzctl in place of CTID. Note this option cannot be used without --save.

--description

Add a textual description for a

container.

--ostemplate

string

Sets a new value of

OSTEMPLATE parameter in container configuration file

[[Man/ctid.conf.5|ctid.conf(5)]]. Requires --save flag. Useful

after a change/upgrade of a distribution running inside

container, as vzctl uses the value of OSTEMPLATE to run

distribution-specific scripts.

--stop-timeout

seconds

Sets a time to wait for

container to stop on vzctl stop before forcibly

killing it, in seconds. Note this option can not be used

without --save flag.

Special value

of 0 means to use compiled-in default.

==== Networking ====

server values set in previous calls to vzctl are

overwritten.

A special value

of inherit can be used to auto-propagate nameserver

value(s) from the host system’s

/etc/resolv.conf file.

--searchdomain

search domain values set in previous calls to vzctl

are overwritten.

A special value

of inherit can be used to auto-propagate search

domain value(s) from the host system’s

/etc/resolv.conf file.

--netif_add

--swappages limit (the barrier is set to 0).

--vm_overcommitfloat Set VM overcommitment value tofloat. If set, it is used to calculateprivmmpages parameter in case it is not setexplicitly (see below). Default value is 0, meaningunlimited privvmpages. ~~Note that~~vzctl checks if running kernel is VSwap capable, andrefuses to use these parameters otherwise. This behavior canbebe overriden by using --force flag before

parameters.

In VSwap mode,

all beancounters other than RAM and swap become optional.

Note though that if some optional beancounters are not set,

they are calculated and set by vzctl implicitly, using the

following formulae:

•

lockedpages.barrier = oomguarpages.barrier = ram

•

lockedpages.limit = oomguarpages.limit = unlimited

•

vmguarpages.barrier = vmguarpages.limit = ram + swap

•

privvmpages.barrier = privvmpages.limit = (ram + swap) *

vm_overcommit

(if

vm_overcommit is 0 or not set,

privvmpages is set to "unlimited")

Here is an

--cpumask cpus |

auto | all

~~sets~~ Sets list of allowed CPUs for

the container. Input format is a comma-separated list of

decimal numbers and /or ranges. Consecutively set bits are shownas two hyphen-separated decimal numbers, the smallest andlargest bit numbers set in the range. For example, if youwant the container to execute on CPUs 0, 1, 2, 7, you shouldpass 0-2,7. Default value is all (thecontainer can execute on any CPU). If used with the--nodemask option, value of auto assigns allCPUs from the specified NUMA node to a container. --nodemask nodes| all Sets list of allowed NUMA nodesfor the container. Input format is the same as for--cpumask. Note that --nodemask must be usedwith the --cpumask option.

==== Memory output parameters ====

privvmpages:1.

==== Netfilter (iptables ) control parameters ==== --netfilter disabled|stateless|stateful|full Restrict access tonetfilter/iptables modules for a container. This optionreplaces obsoleted --iptables. Note thatchanging this parameter requires container restart, soconsider using --setmode option.

The followingarguments can be used: ~~--iptables~~</bbr>~~name[,~~• disabled~~...]~~

~~Allow to use the functionalityof name iptables module inside the container.Multiple comma-separated names can be specified.~~no modules are allowed

~~The defaultlist of enabled iptables modules is defined by the~~~~IPTABLES~~• stateless ~~variable in [[Man/vz.conf.5|vz.conf(5)]].~~

all modules except NAT andconntracks are allowed (i.e. filter and mangle); this is thedefault • stateful all modules except NAT areallowed <table width="100%" border="0" rules="none" frame="void" cellspacing="0" cellpadding="0"><tr valign="top" align="left"><td width="22%"></td><td width="9%"> • full</td><td width="1%"></td><td width="36%"> all modules are allowed</td><td width="32%"></td></tr></table> --iptablesname[,...] Note this option isobsoleted, --netfilter should be used instead. Allow to usethe functionality of name iptables module inside thecontainer. Multiple comma-separated names can bespecified. The defaultlist of enabled iptables modules is defined by theIPTABLES variable in [[Man/vz.conf.5|vz.conf(5)]]. You can use thefollowing values for name: iptable_filter,

iptable_mangle, ipt_limit,

ipt_multiport, ipt_tos, ipt_TOS,

For simfs layout, sets

soft and hard disk quota limits~~, in blocks~~. First parameteris soft limit, second is hard limit~~. One block is currentlyequal to 1Kb~~.

For

ploop layout, ~~sets~~ initiates the ~~size~~ procedure of resizing the ploop image fileto the new size. Since there is nosoft/hard limit concept in ploop, second num, ifspecified,is ignored. By default,ploop resize is done online, i.e. on a mounted ploop. Thisis a preferred way of doing resize. Although, in ~~kilobytes~~a rare casea container was using lots of disk space and should now beresized to a much smaller size, an offline resize might bemore appropriate. In this case, make sure the container isstopped and unmounted and use additional--offline-resize option Note that ploopresize is NOT performed on container start, so forconsistency --diskspace must be used together with--save flag.

Suffixes

G, M, K can also be specified (see

Resource limits section for more info onsuffixes).If suffix is not specified, value is in kilobytes.

--diskinodes

vps-pci configuration script is executed by

vzctl then configuring PCI devices. The script is

usually located at /usr/~~lib[64]~~libexec/vzctl/scripts/.

==== Features management ====

configuration file.

==== I/O ~~priority management~~ scheduling ====

--ioprio

priority

Assigns disk I/O priority to

container. Priority range is 0-7. The greater

priority is, the more time for I/O activity container

4.

--iolimitlimit[B|K|M|G] Assigns disk I/O bandwidthlimit for a container. Value is either a number with anoptional suffix, or a literal string unlimited. Valueof 0 means "unlimited". By default acontainer has no I/O limit. Maximum allowed limit is 2gigabytes per second; values exceeding the limit aretruncated. If no suffix isprovided, the limit is assumed to be in megabytes persecond. Available suffixes are: • b, B -- bytes per second; • k, K -- kilobytes per second; • m, M -- megabytes per second (default); • g, G -- gigabytes per second; --iopslimitiops Assigns IOPS limit for acontainer, in number of input/output operations per second.Value is a number or a literal string unlimited.Value of 0 means "unlimited". By default acontainer has no IOPS limit. === Suspending and ~~restore~~ resuming ===

Checkpointing is a feature of

OpenVZ kernel which allows to save a complete in-kernelstate of arunning container, and to restore it later.

suspend|chkpnt CTID[--dumpfile name]

This command ~~saves~~ suspends a ~~completestate of a running~~ container to a dump file~~, and stops thecontainer.~~ If an option --dumpfile is not set,default dump file name /vz/dump/Dump.CTID isused.

resume|restore CTID[--dumpfile name]

This command restores a

container from the dump file created by the ~~chkpnt~~suspend

command.

[--id uuid] [--name name]

[--description desc]

[--skip-suspend] [--skip-config]

Creates a container snapshot,i.e. saves the current container state, including its file~~If uuid is not specified~~system state, running processes state, ~~it is auto-generated~~and configurationfile.

If a container

is running, and --skip-suspend option is not

specified, a container is checkpointed and then restored,

and CT memory dump becomes the part of snapshot~~. Otherwise,only file system state is saved~~.

Unless--skip-config option is given, containerconfiguration file is saved to the snapshot. If uuidis not specified, it is auto-generated. Options

--name and --description can be used to

specify the snapshot name and description, respectively.

snapshot-switch

CTID [--skip-resume | --must-resume][--skip-config] --id uuid

Switches the container to a

snapshot identified by uuid, restoring its filesystem state, configuration (if available) and its runningstate (if available). Note that the currentstate of a container (including its file system~~container~~ state and its configuration file ~~system state~~ ) is lost! Option--skip-resume is used to ignore a CT memory dump filein a snapshot, as a result the container will end up beingin a stopped state (same as if a snapshot has been takenwith --skip-suspend). If ~~given~~option~~snapshot contains CT~~ --must-resume is set, absense of a memory dumpistreated as an error, it and the inability to restore from thememory dump is ~~restored~~treated as an error rather than warning. Option option--skip-config is used to ignore the CT configurationfile in a snapshot, ~~otherwise~~i.e. the current configuration file willit be left as is ~~stopped~~.

snapshot-delete

Removes a specified

snapshot.

snapshot-mount

CTID --id uuid --target

directory

Mounts a snapshot specified by

uuid to a directory. Note this mount is

read-only.

snapshot-umount

CTID --id uuid

Unmounts a specified

snapshot.

snapshot-list

CTID[-H] [-ofield[,field...] [--id uuid] List container’ssnapshots. You cansuppress displaying header using -H option.

~~Lists all snapshots~~You can use the-o option to display only the specifiedfield(s). ~~Active~~List of available fields can be obtained~~snapshot is marked with~~ using *-L ~~sign~~option.

=== Performing container actions ===

[--layout simfs|ploop[:{expanded|plain|raw}]]

[--diskspace kbytes]

[--diskinodes num]

[--private path]

[--root path]

[--ipadd addr]

[--hostname name]

[--name name][--local_uid uid][--local_gid gid] </td></tr>

</table>

format after a colon. Possible ploop formats are

expanded, plain and raw. Default is

expanded. Using value other than ~~raw~~expanded is not recommended and iscurrently not supported.

You can use

--diskspace ~~option~~ and --diskinodes options to specify container file systemsize. Note that forploop layout, you will not be able to change inodesvalue later. IfDISKSPACE is not specified either in the sampleconfiguration file used for creation or in globalconfiguration file [[Man/vz.conf.5|vz.conf(5)]], --diskspace~~size~~parameter is required for ploop layout. Suffixes G, M, K can also bespecified (see Resource limits section for more infoonon suffixes).

You can use

--hostname name option to set a host name for

a container.

When running

with an upstream Linux Kernel that supports user namespaces

(>= 3.8), the parameters --local_uid and

--local_gid can be used to select which uid

and gid respectively will be used as a base user in

the host system. Note that user namespaces provide a 1:1

mapping between container users and host users. If these

options are not specified, the values LOCAL_UID and

LOCAL_GID from global configuration file

[[Man/vz.conf.5|vz.conf(5)]] are used. An explicit --local_uid

value of 0 will disable user namespace support, and run the

container as a privileged user. In this case,

--local_gid is ignored.

Warning:

use --local_uid and --local_gid with care,

specially when migrating containers. In all situations, the

container’s files in the filesystem needs to be

correctly owned by the host-side users.

destroy | delete

start CTID

[--wait] [--force] [--skip-fsck][--skip-remount]

Mounts (if necessary) and

--force if you want to start a container which is

disabled (see --disabled).

Specify

--skip-fsck to skip fsck for ploop-based container

filesystem (this option is used by vz initscript).

By default, if

a container to be started happens to be already mounted, it

is unmounted and mounted again. This behavior can be turned

off by using --skip-remount flag.

Note that this

syscall instead which is faster but can lead to unclean

container shutdown.

Note that

vzctl stop is not asyncronous, in other words vzctl

waits for container’s init to exit (unless

--fast is given), which can take up to a few minutes.

Default wait timeout is 120 seconds; it can be changed

globally, by setting STOP_TIMEOUT in

[[Man/vz.conf.5|vz.conf(5)]], or per container (STOP_TIMEOUT in

[[Man/ctid.conf.5|ctid.conf(5)]], see --stop-timeout).

Note that this

restart CTID

[--wait] [--force] [--fast][--skip-fsck]

Restarts a container, i.e.

Sixth word, if

exists, is suspended. It appears if a dump file

exists for a stopped container (see ~~chkpnt~~suspend).

This command

The following

escape sequences are recognized by vzctl console.

Note that these sequences are only recognized ~~after~~at the~~Enter~~beginning of a line.

•

global and per-CT scripts. Global scripts have a literal

prefix of vps. and are executed for all containers.

Per-CT scripts have a CTID. numeric prefix and areexecuted for the given container only.

Please note

<pre style="margin-left:11%; margin-top: 1em"> # If one of these files does not exist then something

# is really broken

[ -f /etc/~~sysconfig~~vz/vz .conf ] || exit 1

[ -f $VE_CONFFILE ] || exit 1

# Source both files. Note the order is important.

Error during vzctl ~~chkpnt~~suspend</td></tr>

Error during vzctl ~~restore~~resume</td></tr>

Parameter DISKSPACE not set ~~(or set too high)~~</td></tr>

~~161~~166</td>

Error compacting ploop image</td></tr>

167</td>

Error listing ploop snapsots</td></tr>

</table>

Copyright (C)

2000-~~2011~~2013, Parallels, Inc. Licensed under GNU GPL.

Botinki Kira

Bots

2,253

edits

Changes

Man/vzctl.8

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Services

Donate

Tools