pct.1-synopsis.adoc

   1 *pct* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *pct clone* `<vmid> <newid>` `[OPTIONS]`
   4
   5 Create a container clone/copy
   6
   7 `<vmid>`: `<integer> (1 - N)` ::
   8
   9 The (unique) ID of the VM.
  10
  11 `<newid>`: `<integer> (1 - N)` ::
  12
  13 VMID for the clone.
  14
  15 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
  16
  17 Override I/O bandwidth limit (in KiB/s).
  18
  19 `--description` `<string>` ::
  20
  21 Description for the new CT.
  22
  23 `--full` `<boolean>` ::
  24
  25 Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.
  26
  27 `--hostname` `<string>` ::
  28
  29 Set a hostname for the new CT.
  30
  31 `--pool` `<string>` ::
  32
  33 Add the new CT to the specified pool.
  34
  35 `--snapname` `<string>` ::
  36
  37 The name of the snapshot.
  38
  39 `--storage` `<string>` ::
  40
  41 Target storage for full clone.
  42
  43 `--target` `<string>` ::
  44
  45 Target node. Only allowed if the original VM is on shared storage.
  46
  47 *pct config* `<vmid>` `[OPTIONS]`
  48
  49 Get container configuration.
  50
  51 `<vmid>`: `<integer> (1 - N)` ::
  52
  53 The (unique) ID of the VM.
  54
  55 `--current` `<boolean>` ('default =' `0`)::
  56
  57 Get current values (instead of pending values).
  58
  59 `--snapshot` `<string>` ::
  60
  61 Fetch config values from given snapshot.
  62
  63 *pct console* `<vmid>` `[OPTIONS]`
  64
  65 Launch a console for the specified container.
  66
  67 `<vmid>`: `<integer> (1 - N)` ::
  68
  69 The (unique) ID of the VM.
  70
  71 `--escape` `\^?[a-z]` ('default =' `^a`)::
  72
  73 Escape sequence prefix. For example to use <Ctrl+b q> as the escape sequence pass '^b'.
  74
  75 *pct cpusets*
  76
  77 Print the list of assigned CPU sets.
  78
  79 *pct create* `<vmid> <ostemplate>` `[OPTIONS]`
  80
  81 Create or restore a container.
  82
  83 `<vmid>`: `<integer> (1 - N)` ::
  84
  85 The (unique) ID of the VM.
  86
  87 `<ostemplate>`: `<string>` ::
  88
  89 The OS template or backup file.
  90
  91 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
  92
  93 OS architecture type.
  94
  95 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
  96
  97 Override I/O bandwidth limit (in KiB/s).
  98
  99 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 100
 101 Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
 102
 103 `--console` `<boolean>` ('default =' `1`)::
 104
 105 Attach a console device (/dev/console) to the container.
 106
 107 `--cores` `<integer> (1 - 8192)` ::
 108
 109 The number of cores assigned to the container. A container can use all available cores by default.
 110
 111 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 112
 113 Limit of CPU usage.
 114 +
 115 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 116
 117 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
 118
 119 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
 120 +
 121 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 122
 123 `--debug` `<boolean>` ('default =' `0`)::
 124
 125 Try to be more verbose. For now this only enables debug log-level on start.
 126
 127 `--description` `<string>` ::
 128
 129 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 130
 131 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 132
 133 Allow containers access to advanced features.
 134
 135 `--force` `<boolean>` ::
 136
 137 Allow to overwrite existing container.
 138
 139 `--hookscript` `<string>` ::
 140
 141 Script that will be exectued during various steps in the containers lifetime.
 142
 143 `--hostname` `<string>` ::
 144
 145 Set a host name for the container.
 146
 147 `--ignore-unpack-errors` `<boolean>` ::
 148
 149 Ignore errors when extracting the template.
 150
 151 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 152
 153 Lock/unlock the VM.
 154
 155 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 156
 157 Amount of RAM for the VM in MB.
 158
 159 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 160
 161 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 162
 163 `--nameserver` `<string>` ::
 164
 165 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 166
 167 `--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 168
 169 Specifies network interfaces for the container.
 170
 171 `--onboot` `<boolean>` ('default =' `0`)::
 172
 173 Specifies whether a VM will be started during system bootup.
 174
 175 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 176
 177 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 178
 179 `--password` `<password>` ::
 180
 181 Sets root password inside container.
 182
 183 `--pool` `<string>` ::
 184
 185 Add the VM to the specified pool.
 186
 187 `--protection` `<boolean>` ('default =' `0`)::
 188
 189 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 190
 191 `--restore` `<boolean>` ::
 192
 193 Mark this as restore task.
 194
 195 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 196
 197 Use volume as container root.
 198
 199 `--searchdomain` `<string>` ::
 200
 201 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 202
 203 `--ssh-public-keys` `<filepath>` ::
 204
 205 Setup public SSH keys (one key per line, OpenSSH format).
 206
 207 `--start` `<boolean>` ('default =' `0`)::
 208
 209 Start the CT after its creation finished successfully.
 210
 211 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 212
 213 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
 214
 215 `--storage` `<string>` ('default =' `local`)::
 216
 217 Default Storage.
 218
 219 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 220
 221 Amount of SWAP for the VM in MB.
 222
 223 `--tags` `<string>` ::
 224
 225 Tags of the Container. This is only meta information.
 226
 227 `--template` `<boolean>` ('default =' `0`)::
 228
 229 Enable/disable Template.
 230
 231 `--timezone` `<string>` ::
 232
 233 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
 234
 235 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 236
 237 Specify the number of tty available to the container
 238
 239 `--unique` `<boolean>` ::
 240
 241 Assign a unique random ethernet address.
 242 +
 243 NOTE: Requires option(s): `restore`
 244
 245 `--unprivileged` `<boolean>` ('default =' `0`)::
 246
 247 Makes the container run as unprivileged user. (Should not be modified manually.)
 248
 249 `--unused[n]` `[volume=]<volume>` ::
 250
 251 Reference to unused volumes. This is used internally, and should not be modified manually.
 252
 253 *pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
 254
 255 Delete a LXC snapshot.
 256
 257 `<vmid>`: `<integer> (1 - N)` ::
 258
 259 The (unique) ID of the VM.
 260
 261 `<snapname>`: `<string>` ::
 262
 263 The name of the snapshot.
 264
 265 `--force` `<boolean>` ::
 266
 267 For removal from config file, even if removing disk snapshots fails.
 268
 269 *pct destroy* `<vmid>` `[OPTIONS]`
 270
 271 Destroy the container (also delete all uses files).
 272
 273 `<vmid>`: `<integer> (1 - N)` ::
 274
 275 The (unique) ID of the VM.
 276
 277 `--destroy-unreferenced-disks` `<boolean>` ::
 278
 279 If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
 280
 281 `--force` `<boolean>` ('default =' `0`)::
 282
 283 Force destroy, even if running.
 284
 285 `--purge` `<boolean>` ('default =' `0`)::
 286
 287 Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
 288
 289 *pct df* `<vmid>`
 290
 291 Get the container's current disk usage.
 292
 293 `<vmid>`: `<integer> (1 - N)` ::
 294
 295 The (unique) ID of the VM.
 296
 297 *pct enter* `<vmid>`
 298
 299 Launch a shell for the specified container.
 300
 301 `<vmid>`: `<integer> (1 - N)` ::
 302
 303 The (unique) ID of the VM.
 304
 305 *pct exec* `<vmid> [<extra-args>]`
 306
 307 Launch a command inside the specified container.
 308
 309 `<vmid>`: `<integer> (1 - N)` ::
 310
 311 The (unique) ID of the VM.
 312
 313 `<extra-args>`: `<array>` ::
 314
 315 Extra arguments as array
 316
 317 *pct fsck* `<vmid>` `[OPTIONS]`
 318
 319 Run a filesystem check (fsck) on a container volume.
 320
 321 `<vmid>`: `<integer> (1 - N)` ::
 322
 323 The (unique) ID of the VM.
 324
 325 `--device` `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
 326
 327 A volume on which to run the filesystem check
 328
 329 `--force` `<boolean>` ('default =' `0`)::
 330
 331 Force checking, even if the filesystem seems clean
 332
 333 *pct fstrim* `<vmid>` `[OPTIONS]`
 334
 335 Run fstrim on a chosen CT and its mountpoints.
 336
 337 `<vmid>`: `<integer> (1 - N)` ::
 338
 339 The (unique) ID of the VM.
 340
 341 `--ignore-mountpoints` `<boolean>` ::
 342
 343 Skip all mountpoints, only do fstrim on the container root.
 344
 345 *pct help* `[OPTIONS]`
 346
 347 Get help about specified command.
 348
 349 `--extra-args` `<array>` ::
 350
 351 Shows help for a specific command
 352
 353 `--verbose` `<boolean>` ::
 354
 355 Verbose output format.
 356
 357 *pct list*
 358
 359 LXC container index (per node).
 360
 361 *pct listsnapshot* `<vmid>`
 362
 363 List all snapshots.
 364
 365 `<vmid>`: `<integer> (1 - N)` ::
 366
 367 The (unique) ID of the VM.
 368
 369 *pct migrate* `<vmid> <target>` `[OPTIONS]`
 370
 371 Migrate the container to another node. Creates a new migration task.
 372
 373 `<vmid>`: `<integer> (1 - N)` ::
 374
 375 The (unique) ID of the VM.
 376
 377 `<target>`: `<string>` ::
 378
 379 Target node.
 380
 381 `--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
 382
 383 Override I/O bandwidth limit (in KiB/s).
 384
 385 `--online` `<boolean>` ::
 386
 387 Use online/live migration.
 388
 389 `--restart` `<boolean>` ::
 390
 391 Use restart migration
 392
 393 `--timeout` `<integer>` ('default =' `180`)::
 394
 395 Timeout in seconds for shutdown for restart migration
 396
 397 *pct mount* `<vmid>`
 398
 399 Mount the container's filesystem on the host. This will hold a lock on the
 400 container and is meant for emergency maintenance only as it will prevent
 401 further operations on the container other than start and stop.
 402
 403 `<vmid>`: `<integer> (1 - N)` ::
 404
 405 The (unique) ID of the VM.
 406
 407 *pct move-volume* `<vmid> <volume> [<storage>] [<target-vmid>] [<target-volume>]` `[OPTIONS]`
 408
 409 Move a rootfs-/mp-volume to a different storage or to a different
 410 container.
 411
 412 `<vmid>`: `<integer> (1 - N)` ::
 413
 414 The (unique) ID of the VM.
 415
 416 `<volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99>` ::
 417
 418 Volume which will be moved.
 419
 420 `<storage>`: `<string>` ::
 421
 422 Target Storage.
 423
 424 `<target-vmid>`: `<integer> (1 - N)` ::
 425
 426 The (unique) ID of the VM.
 427
 428 `<target-volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99>` ::
 429
 430 The config key the volume will be moved to. Default is the source volume key.
 431
 432 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
 433
 434 Override I/O bandwidth limit (in KiB/s).
 435
 436 `--delete` `<boolean>` ('default =' `0`)::
 437
 438 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
 439
 440 `--digest` `<string>` ::
 441
 442 Prevent changes if current configuration file has different SHA1 " .
 443                     "digest. This can be used to prevent concurrent modifications.
 444
 445 `--target-digest` `<string>` ::
 446
 447 Prevent changes if current configuration file of the target " .
 448                     "container has a different SHA1 digest. This can be used to prevent " .
 449                     "concurrent modifications.
 450
 451 *pct move_volume*
 452
 453 An alias for 'pct move-volume'.
 454
 455 *pct pending* `<vmid>`
 456
 457 Get container configuration, including pending changes.
 458
 459 `<vmid>`: `<integer> (1 - N)` ::
 460
 461 The (unique) ID of the VM.
 462
 463 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
 464
 465 Copy a file from the container to the local system.
 466
 467 `<vmid>`: `<integer> (1 - N)` ::
 468
 469 The (unique) ID of the VM.
 470
 471 `<path>`: `<string>` ::
 472
 473 Path to a file inside the container to pull.
 474
 475 `<destination>`: `<string>` ::
 476
 477 Destination
 478
 479 `--group` `<string>` ::
 480
 481 Owner group name or id.
 482
 483 `--perms` `<string>` ::
 484
 485 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 486
 487 `--user` `<string>` ::
 488
 489 Owner user name or id.
 490
 491 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
 492
 493 Copy a local file to the container.
 494
 495 `<vmid>`: `<integer> (1 - N)` ::
 496
 497 The (unique) ID of the VM.
 498
 499 `<file>`: `<string>` ::
 500
 501 Path to a local file.
 502
 503 `<destination>`: `<string>` ::
 504
 505 Destination inside the container to write to.
 506
 507 `--group` `<string>` ::
 508
 509 Owner group name or id. When using a name it must exist inside the container.
 510
 511 `--perms` `<string>` ::
 512
 513 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 514
 515 `--user` `<string>` ::
 516
 517 Owner user name or id. When using a name it must exist inside the container.
 518
 519 *pct reboot* `<vmid>` `[OPTIONS]`
 520
 521 Reboot the container by shutting it down, and starting it again. Applies
 522 pending changes.
 523
 524 `<vmid>`: `<integer> (1 - N)` ::
 525
 526 The (unique) ID of the VM.
 527
 528 `--timeout` `<integer> (0 - N)` ::
 529
 530 Wait maximal timeout seconds for the shutdown.
 531
 532 *pct rescan* `[OPTIONS]`
 533
 534 Rescan all storages and update disk sizes and unused disk images.
 535
 536 `--dryrun` `<boolean>` ('default =' `0`)::
 537
 538 Do not actually write changes out to conifg.
 539
 540 `--vmid` `<integer> (1 - N)` ::
 541
 542 The (unique) ID of the VM.
 543
 544 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
 545
 546 Resize a container mount point.
 547
 548 `<vmid>`: `<integer> (1 - N)` ::
 549
 550 The (unique) ID of the VM.
 551
 552 `<disk>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
 553
 554 The disk you want to resize.
 555
 556 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
 557
 558 The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.
 559
 560 `--digest` `<string>` ::
 561
 562 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 563
 564 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
 565
 566 Create or restore a container.
 567
 568 `<vmid>`: `<integer> (1 - N)` ::
 569
 570 The (unique) ID of the VM.
 571
 572 `<ostemplate>`: `<string>` ::
 573
 574 The OS template or backup file.
 575
 576 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
 577
 578 OS architecture type.
 579
 580 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
 581
 582 Override I/O bandwidth limit (in KiB/s).
 583
 584 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 585
 586 Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
 587
 588 `--console` `<boolean>` ('default =' `1`)::
 589
 590 Attach a console device (/dev/console) to the container.
 591
 592 `--cores` `<integer> (1 - 8192)` ::
 593
 594 The number of cores assigned to the container. A container can use all available cores by default.
 595
 596 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 597
 598 Limit of CPU usage.
 599 +
 600 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 601
 602 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
 603
 604 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
 605 +
 606 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 607
 608 `--debug` `<boolean>` ('default =' `0`)::
 609
 610 Try to be more verbose. For now this only enables debug log-level on start.
 611
 612 `--description` `<string>` ::
 613
 614 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 615
 616 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 617
 618 Allow containers access to advanced features.
 619
 620 `--force` `<boolean>` ::
 621
 622 Allow to overwrite existing container.
 623
 624 `--hookscript` `<string>` ::
 625
 626 Script that will be exectued during various steps in the containers lifetime.
 627
 628 `--hostname` `<string>` ::
 629
 630 Set a host name for the container.
 631
 632 `--ignore-unpack-errors` `<boolean>` ::
 633
 634 Ignore errors when extracting the template.
 635
 636 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 637
 638 Lock/unlock the VM.
 639
 640 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 641
 642 Amount of RAM for the VM in MB.
 643
 644 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 645
 646 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 647
 648 `--nameserver` `<string>` ::
 649
 650 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 651
 652 `--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 653
 654 Specifies network interfaces for the container.
 655
 656 `--onboot` `<boolean>` ('default =' `0`)::
 657
 658 Specifies whether a VM will be started during system bootup.
 659
 660 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 661
 662 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 663
 664 `--password` `<password>` ::
 665
 666 Sets root password inside container.
 667
 668 `--pool` `<string>` ::
 669
 670 Add the VM to the specified pool.
 671
 672 `--protection` `<boolean>` ('default =' `0`)::
 673
 674 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 675
 676 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 677
 678 Use volume as container root.
 679
 680 `--searchdomain` `<string>` ::
 681
 682 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 683
 684 `--ssh-public-keys` `<filepath>` ::
 685
 686 Setup public SSH keys (one key per line, OpenSSH format).
 687
 688 `--start` `<boolean>` ('default =' `0`)::
 689
 690 Start the CT after its creation finished successfully.
 691
 692 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 693
 694 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
 695
 696 `--storage` `<string>` ('default =' `local`)::
 697
 698 Default Storage.
 699
 700 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 701
 702 Amount of SWAP for the VM in MB.
 703
 704 `--tags` `<string>` ::
 705
 706 Tags of the Container. This is only meta information.
 707
 708 `--template` `<boolean>` ('default =' `0`)::
 709
 710 Enable/disable Template.
 711
 712 `--timezone` `<string>` ::
 713
 714 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
 715
 716 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 717
 718 Specify the number of tty available to the container
 719
 720 `--unique` `<boolean>` ::
 721
 722 Assign a unique random ethernet address.
 723 +
 724 NOTE: Requires option(s): `restore`
 725
 726 `--unprivileged` `<boolean>` ('default =' `0`)::
 727
 728 Makes the container run as unprivileged user. (Should not be modified manually.)
 729
 730 `--unused[n]` `[volume=]<volume>` ::
 731
 732 Reference to unused volumes. This is used internally, and should not be modified manually.
 733
 734 *pct resume* `<vmid>`
 735
 736 Resume the container.
 737
 738 `<vmid>`: `<integer> (1 - N)` ::
 739
 740 The (unique) ID of the VM.
 741
 742 *pct rollback* `<vmid> <snapname>`
 743
 744 Rollback LXC state to specified snapshot.
 745
 746 `<vmid>`: `<integer> (1 - N)` ::
 747
 748 The (unique) ID of the VM.
 749
 750 `<snapname>`: `<string>` ::
 751
 752 The name of the snapshot.
 753
 754 *pct set* `<vmid>` `[OPTIONS]`
 755
 756 Set container options.
 757
 758 `<vmid>`: `<integer> (1 - N)` ::
 759
 760 The (unique) ID of the VM.
 761
 762 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
 763
 764 OS architecture type.
 765
 766 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 767
 768 Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
 769
 770 `--console` `<boolean>` ('default =' `1`)::
 771
 772 Attach a console device (/dev/console) to the container.
 773
 774 `--cores` `<integer> (1 - 8192)` ::
 775
 776 The number of cores assigned to the container. A container can use all available cores by default.
 777
 778 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 779
 780 Limit of CPU usage.
 781 +
 782 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 783
 784 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
 785
 786 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
 787 +
 788 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 789
 790 `--debug` `<boolean>` ('default =' `0`)::
 791
 792 Try to be more verbose. For now this only enables debug log-level on start.
 793
 794 `--delete` `<string>` ::
 795
 796 A list of settings you want to delete.
 797
 798 `--description` `<string>` ::
 799
 800 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 801
 802 `--digest` `<string>` ::
 803
 804 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 805
 806 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 807
 808 Allow containers access to advanced features.
 809
 810 `--hookscript` `<string>` ::
 811
 812 Script that will be exectued during various steps in the containers lifetime.
 813
 814 `--hostname` `<string>` ::
 815
 816 Set a host name for the container.
 817
 818 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 819
 820 Lock/unlock the VM.
 821
 822 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 823
 824 Amount of RAM for the VM in MB.
 825
 826 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 827
 828 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 829
 830 `--nameserver` `<string>` ::
 831
 832 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 833
 834 `--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 835
 836 Specifies network interfaces for the container.
 837
 838 `--onboot` `<boolean>` ('default =' `0`)::
 839
 840 Specifies whether a VM will be started during system bootup.
 841
 842 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 843
 844 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 845
 846 `--protection` `<boolean>` ('default =' `0`)::
 847
 848 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 849
 850 `--revert` `<string>` ::
 851
 852 Revert a pending change.
 853
 854 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 855
 856 Use volume as container root.
 857
 858 `--searchdomain` `<string>` ::
 859
 860 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 861
 862 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 863
 864 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
 865
 866 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 867
 868 Amount of SWAP for the VM in MB.
 869
 870 `--tags` `<string>` ::
 871
 872 Tags of the Container. This is only meta information.
 873
 874 `--template` `<boolean>` ('default =' `0`)::
 875
 876 Enable/disable Template.
 877
 878 `--timezone` `<string>` ::
 879
 880 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
 881
 882 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 883
 884 Specify the number of tty available to the container
 885
 886 `--unprivileged` `<boolean>` ('default =' `0`)::
 887
 888 Makes the container run as unprivileged user. (Should not be modified manually.)
 889
 890 `--unused[n]` `[volume=]<volume>` ::
 891
 892 Reference to unused volumes. This is used internally, and should not be modified manually.
 893
 894 *pct shutdown* `<vmid>` `[OPTIONS]`
 895
 896 Shutdown the container. This will trigger a clean shutdown of the
 897 container, see lxc-stop(1) for details.
 898
 899 `<vmid>`: `<integer> (1 - N)` ::
 900
 901 The (unique) ID of the VM.
 902
 903 `--forceStop` `<boolean>` ('default =' `0`)::
 904
 905 Make sure the Container stops.
 906
 907 `--timeout` `<integer> (0 - N)` ('default =' `60`)::
 908
 909 Wait maximal timeout seconds.
 910
 911 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
 912
 913 Snapshot a container.
 914
 915 `<vmid>`: `<integer> (1 - N)` ::
 916
 917 The (unique) ID of the VM.
 918
 919 `<snapname>`: `<string>` ::
 920
 921 The name of the snapshot.
 922
 923 `--description` `<string>` ::
 924
 925 A textual description or comment.
 926
 927 *pct start* `<vmid>` `[OPTIONS]`
 928
 929 Start the container.
 930
 931 `<vmid>`: `<integer> (1 - N)` ::
 932
 933 The (unique) ID of the VM.
 934
 935 `--debug` `<boolean>` ('default =' `0`)::
 936
 937 If set, enables very verbose debug log-level on start.
 938
 939 `--skiplock` `<boolean>` ::
 940
 941 Ignore locks - only root is allowed to use this option.
 942
 943 *pct status* `<vmid>` `[OPTIONS]`
 944
 945 Show CT status.
 946
 947 `<vmid>`: `<integer> (1 - N)` ::
 948
 949 The (unique) ID of the VM.
 950
 951 `--verbose` `<boolean>` ::
 952
 953 Verbose output format
 954
 955 *pct stop* `<vmid>` `[OPTIONS]`
 956
 957 Stop the container. This will abruptly stop all processes running in the
 958 container.
 959
 960 `<vmid>`: `<integer> (1 - N)` ::
 961
 962 The (unique) ID of the VM.
 963
 964 `--skiplock` `<boolean>` ::
 965
 966 Ignore locks - only root is allowed to use this option.
 967
 968 *pct suspend* `<vmid>`
 969
 970 Suspend the container. This is experimental.
 971
 972 `<vmid>`: `<integer> (1 - N)` ::
 973
 974 The (unique) ID of the VM.
 975
 976 *pct template* `<vmid>`
 977
 978 Create a Template.
 979
 980 `<vmid>`: `<integer> (1 - N)` ::
 981
 982 The (unique) ID of the VM.
 983
 984 *pct unlock* `<vmid>`
 985
 986 Unlock the VM.
 987
 988 `<vmid>`: `<integer> (1 - N)` ::
 989
 990 The (unique) ID of the VM.
 991
 992 *pct unmount* `<vmid>`
 993
 994 Unmount the container's filesystem.
 995
 996 `<vmid>`: `<integer> (1 - N)` ::
 997
 998 The (unique) ID of the VM.
 999
1000