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 | riscv32 | riscv64>` ('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 =' `cgroup v1: 1024, cgroup v2: 100`)::
 118
 119 CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
 120
 121 `--debug` `<boolean>` ('default =' `0`)::
 122
 123 Try to be more verbose. For now this only enables debug log-level on start.
 124
 125 `--description` `<string>` ::
 126
 127 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 128
 129 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 130
 131 Allow containers access to advanced features.
 132
 133 `--force` `<boolean>` ::
 134
 135 Allow to overwrite existing container.
 136
 137 `--hookscript` `<string>` ::
 138
 139 Script that will be exectued during various steps in the containers lifetime.
 140
 141 `--hostname` `<string>` ::
 142
 143 Set a host name for the container.
 144
 145 `--ignore-unpack-errors` `<boolean>` ::
 146
 147 Ignore errors when extracting the template.
 148
 149 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 150
 151 Lock/unlock the container.
 152
 153 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 154
 155 Amount of RAM for the container in MB.
 156
 157 `--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>]` ::
 158
 159 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 160
 161 `--nameserver` `<string>` ::
 162
 163 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 164
 165 `--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)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 166
 167 Specifies network interfaces for the container.
 168
 169 `--onboot` `<boolean>` ('default =' `0`)::
 170
 171 Specifies whether a container will be started during system bootup.
 172
 173 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
 174
 175 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.
 176
 177 `--password` `<password>` ::
 178
 179 Sets root password inside container.
 180
 181 `--pool` `<string>` ::
 182
 183 Add the VM to the specified pool.
 184
 185 `--protection` `<boolean>` ('default =' `0`)::
 186
 187 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 188
 189 `--restore` `<boolean>` ::
 190
 191 Mark this as restore task.
 192
 193 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 194
 195 Use volume as container root.
 196
 197 `--searchdomain` `<string>` ::
 198
 199 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 200
 201 `--ssh-public-keys` `<filepath>` ::
 202
 203 Setup public SSH keys (one key per line, OpenSSH format).
 204
 205 `--start` `<boolean>` ('default =' `0`)::
 206
 207 Start the CT after its creation finished successfully.
 208
 209 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 210
 211 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.
 212
 213 `--storage` `<string>` ('default =' `local`)::
 214
 215 Default Storage.
 216
 217 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 218
 219 Amount of SWAP for the container in MB.
 220
 221 `--tags` `<string>` ::
 222
 223 Tags of the Container. This is only meta information.
 224
 225 `--template` `<boolean>` ('default =' `0`)::
 226
 227 Enable/disable Template.
 228
 229 `--timezone` `<string>` ::
 230
 231 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
 232
 233 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 234
 235 Specify the number of tty available to the container
 236
 237 `--unique` `<boolean>` ::
 238
 239 Assign a unique random ethernet address.
 240 +
 241 NOTE: Requires option(s): `restore`
 242
 243 `--unprivileged` `<boolean>` ('default =' `0`)::
 244
 245 Makes the container run as unprivileged user. (Should not be modified manually.)
 246
 247 `--unused[n]` `[volume=]<volume>` ::
 248
 249 Reference to unused volumes. This is used internally, and should not be modified manually.
 250
 251 *pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
 252
 253 Delete a LXC snapshot.
 254
 255 `<vmid>`: `<integer> (1 - N)` ::
 256
 257 The (unique) ID of the VM.
 258
 259 `<snapname>`: `<string>` ::
 260
 261 The name of the snapshot.
 262
 263 `--force` `<boolean>` ::
 264
 265 For removal from config file, even if removing disk snapshots fails.
 266
 267 *pct destroy* `<vmid>` `[OPTIONS]`
 268
 269 Destroy the container (also delete all uses files).
 270
 271 `<vmid>`: `<integer> (1 - N)` ::
 272
 273 The (unique) ID of the VM.
 274
 275 `--destroy-unreferenced-disks` `<boolean>` ::
 276
 277 If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
 278
 279 `--force` `<boolean>` ('default =' `0`)::
 280
 281 Force destroy, even if running.
 282
 283 `--purge` `<boolean>` ('default =' `0`)::
 284
 285 Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
 286
 287 *pct df* `<vmid>`
 288
 289 Get the container's current disk usage.
 290
 291 `<vmid>`: `<integer> (1 - N)` ::
 292
 293 The (unique) ID of the VM.
 294
 295 *pct enter* `<vmid>`
 296
 297 Launch a shell for the specified container.
 298
 299 `<vmid>`: `<integer> (1 - N)` ::
 300
 301 The (unique) ID of the VM.
 302
 303 *pct exec* `<vmid> [<extra-args>]`
 304
 305 Launch a command inside the specified container.
 306
 307 `<vmid>`: `<integer> (1 - N)` ::
 308
 309 The (unique) ID of the VM.
 310
 311 `<extra-args>`: `<array>` ::
 312
 313 Extra arguments as array
 314
 315 *pct fsck* `<vmid>` `[OPTIONS]`
 316
 317 Run a filesystem check (fsck) on a container volume.
 318
 319 `<vmid>`: `<integer> (1 - N)` ::
 320
 321 The (unique) ID of the VM.
 322
 323 `--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>` ::
 324
 325 A volume on which to run the filesystem check
 326
 327 `--force` `<boolean>` ('default =' `0`)::
 328
 329 Force checking, even if the filesystem seems clean
 330
 331 *pct fstrim* `<vmid>` `[OPTIONS]`
 332
 333 Run fstrim on a chosen CT and its mountpoints, except bind or read-only
 334 mountpoints.
 335
 336 `<vmid>`: `<integer> (1 - N)` ::
 337
 338 The (unique) ID of the VM.
 339
 340 `--ignore-mountpoints` `<boolean>` ::
 341
 342 Skip all mountpoints, only do fstrim on the container root.
 343
 344 *pct help* `[OPTIONS]`
 345
 346 Get help about specified command.
 347
 348 `--extra-args` `<array>` ::
 349
 350 Shows help for a specific command
 351
 352 `--verbose` `<boolean>` ::
 353
 354 Verbose output format.
 355
 356 *pct list*
 357
 358 LXC container index (per node).
 359
 360 *pct listsnapshot* `<vmid>`
 361
 362 List all snapshots.
 363
 364 `<vmid>`: `<integer> (1 - N)` ::
 365
 366 The (unique) ID of the VM.
 367
 368 *pct migrate* `<vmid> <target>` `[OPTIONS]`
 369
 370 Migrate the container to another node. Creates a new migration task.
 371
 372 `<vmid>`: `<integer> (1 - N)` ::
 373
 374 The (unique) ID of the VM.
 375
 376 `<target>`: `<string>` ::
 377
 378 Target node.
 379
 380 `--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
 381
 382 Override I/O bandwidth limit (in KiB/s).
 383
 384 `--online` `<boolean>` ::
 385
 386 Use online/live migration.
 387
 388 `--restart` `<boolean>` ::
 389
 390 Use restart migration
 391
 392 `--target-storage` `<string>` ::
 393
 394 Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
 395
 396 `--timeout` `<integer>` ('default =' `180`)::
 397
 398 Timeout in seconds for shutdown for restart migration
 399
 400 *pct mount* `<vmid>`
 401
 402 Mount the container's filesystem on the host. This will hold a lock on the
 403 container and is meant for emergency maintenance only as it will prevent
 404 further operations on the container other than start and stop.
 405
 406 `<vmid>`: `<integer> (1 - N)` ::
 407
 408 The (unique) ID of the VM.
 409
 410 *pct move-volume* `<vmid> <volume> [<storage>] [<target-vmid>] [<target-volume>]` `[OPTIONS]`
 411
 412 Move a rootfs-/mp-volume to a different storage or to a different
 413 container.
 414
 415 `<vmid>`: `<integer> (1 - N)` ::
 416
 417 The (unique) ID of the VM.
 418
 419 `<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>` ::
 420
 421 Volume which will be moved.
 422
 423 `<storage>`: `<string>` ::
 424
 425 Target Storage.
 426
 427 `<target-vmid>`: `<integer> (1 - N)` ::
 428
 429 The (unique) ID of the VM.
 430
 431 `<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>` ::
 432
 433 The config key the volume will be moved to. Default is the source volume key.
 434
 435 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
 436
 437 Override I/O bandwidth limit (in KiB/s).
 438
 439 `--delete` `<boolean>` ('default =' `0`)::
 440
 441 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
 442
 443 `--digest` `<string>` ::
 444
 445 Prevent changes if current configuration file has different SHA1 " .
 446                     "digest. This can be used to prevent concurrent modifications.
 447
 448 `--target-digest` `<string>` ::
 449
 450 Prevent changes if current configuration file of the target " .
 451                     "container has a different SHA1 digest. This can be used to prevent " .
 452                     "concurrent modifications.
 453
 454 *pct move_volume*
 455
 456 An alias for 'pct move-volume'.
 457
 458 *pct pending* `<vmid>`
 459
 460 Get container configuration, including pending changes.
 461
 462 `<vmid>`: `<integer> (1 - N)` ::
 463
 464 The (unique) ID of the VM.
 465
 466 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
 467
 468 Copy a file from the container to the local system.
 469
 470 `<vmid>`: `<integer> (1 - N)` ::
 471
 472 The (unique) ID of the VM.
 473
 474 `<path>`: `<string>` ::
 475
 476 Path to a file inside the container to pull.
 477
 478 `<destination>`: `<string>` ::
 479
 480 Destination
 481
 482 `--group` `<string>` ::
 483
 484 Owner group name or id.
 485
 486 `--perms` `<string>` ::
 487
 488 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 489
 490 `--user` `<string>` ::
 491
 492 Owner user name or id.
 493
 494 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
 495
 496 Copy a local file to the container.
 497
 498 `<vmid>`: `<integer> (1 - N)` ::
 499
 500 The (unique) ID of the VM.
 501
 502 `<file>`: `<string>` ::
 503
 504 Path to a local file.
 505
 506 `<destination>`: `<string>` ::
 507
 508 Destination inside the container to write to.
 509
 510 `--group` `<string>` ::
 511
 512 Owner group name or id. When using a name it must exist inside the container.
 513
 514 `--perms` `<string>` ::
 515
 516 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 517
 518 `--user` `<string>` ::
 519
 520 Owner user name or id. When using a name it must exist inside the container.
 521
 522 *pct reboot* `<vmid>` `[OPTIONS]`
 523
 524 Reboot the container by shutting it down, and starting it again. Applies
 525 pending changes.
 526
 527 `<vmid>`: `<integer> (1 - N)` ::
 528
 529 The (unique) ID of the VM.
 530
 531 `--timeout` `<integer> (0 - N)` ::
 532
 533 Wait maximal timeout seconds for the shutdown.
 534
 535 *pct remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]`
 536
 537 Migrate container to a remote cluster. Creates a new migration task.
 538 EXPERIMENTAL feature!
 539
 540 `<vmid>`: `<integer> (1 - N)` ::
 541
 542 The (unique) ID of the VM.
 543
 544 `<target-vmid>`: `<integer> (1 - N)` ::
 545
 546 The (unique) ID of the VM.
 547
 548 `<target-endpoint>`: `apitoken=<A full Proxmox API token including the secret value.> ,host=<Remote Proxmox hostname or IP> [,fingerprint=<Remote host's certificate fingerprint, if not trusted by system store.>] [,port=<integer>]` ::
 549
 550 Remote target endpoint
 551
 552 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
 553
 554 Override I/O bandwidth limit (in KiB/s).
 555
 556 `--delete` `<boolean>` ('default =' `0`)::
 557
 558 Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state.
 559
 560 `--online` `<boolean>` ::
 561
 562 Use online/live migration.
 563
 564 `--restart` `<boolean>` ::
 565
 566 Use restart migration
 567
 568 `--target-bridge` `<string>` ::
 569
 570 Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself.
 571
 572 `--target-storage` `<string>` ::
 573
 574 Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
 575
 576 `--timeout` `<integer>` ('default =' `180`)::
 577
 578 Timeout in seconds for shutdown for restart migration
 579
 580 *pct rescan* `[OPTIONS]`
 581
 582 Rescan all storages and update disk sizes and unused disk images.
 583
 584 `--dryrun` `<boolean>` ('default =' `0`)::
 585
 586 Do not actually write changes out to conifg.
 587
 588 `--vmid` `<integer> (1 - N)` ::
 589
 590 The (unique) ID of the VM.
 591
 592 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
 593
 594 Resize a container mount point.
 595
 596 `<vmid>`: `<integer> (1 - N)` ::
 597
 598 The (unique) ID of the VM.
 599
 600 `<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>` ::
 601
 602 The disk you want to resize.
 603
 604 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
 605
 606 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.
 607
 608 `--digest` `<string>` ::
 609
 610 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 611
 612 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
 613
 614 Create or restore a container.
 615
 616 `<vmid>`: `<integer> (1 - N)` ::
 617
 618 The (unique) ID of the VM.
 619
 620 `<ostemplate>`: `<string>` ::
 621
 622 The OS template or backup file.
 623
 624 `--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
 625
 626 OS architecture type.
 627
 628 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
 629
 630 Override I/O bandwidth limit (in KiB/s).
 631
 632 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 633
 634 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).
 635
 636 `--console` `<boolean>` ('default =' `1`)::
 637
 638 Attach a console device (/dev/console) to the container.
 639
 640 `--cores` `<integer> (1 - 8192)` ::
 641
 642 The number of cores assigned to the container. A container can use all available cores by default.
 643
 644 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 645
 646 Limit of CPU usage.
 647 +
 648 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 649
 650 `--cpuunits` `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
 651
 652 CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
 653
 654 `--debug` `<boolean>` ('default =' `0`)::
 655
 656 Try to be more verbose. For now this only enables debug log-level on start.
 657
 658 `--description` `<string>` ::
 659
 660 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 661
 662 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 663
 664 Allow containers access to advanced features.
 665
 666 `--force` `<boolean>` ::
 667
 668 Allow to overwrite existing container.
 669
 670 `--hookscript` `<string>` ::
 671
 672 Script that will be exectued during various steps in the containers lifetime.
 673
 674 `--hostname` `<string>` ::
 675
 676 Set a host name for the container.
 677
 678 `--ignore-unpack-errors` `<boolean>` ::
 679
 680 Ignore errors when extracting the template.
 681
 682 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 683
 684 Lock/unlock the container.
 685
 686 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 687
 688 Amount of RAM for the container in MB.
 689
 690 `--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>]` ::
 691
 692 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 693
 694 `--nameserver` `<string>` ::
 695
 696 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 697
 698 `--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)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 699
 700 Specifies network interfaces for the container.
 701
 702 `--onboot` `<boolean>` ('default =' `0`)::
 703
 704 Specifies whether a container will be started during system bootup.
 705
 706 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
 707
 708 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.
 709
 710 `--password` `<password>` ::
 711
 712 Sets root password inside container.
 713
 714 `--pool` `<string>` ::
 715
 716 Add the VM to the specified pool.
 717
 718 `--protection` `<boolean>` ('default =' `0`)::
 719
 720 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 721
 722 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 723
 724 Use volume as container root.
 725
 726 `--searchdomain` `<string>` ::
 727
 728 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 729
 730 `--ssh-public-keys` `<filepath>` ::
 731
 732 Setup public SSH keys (one key per line, OpenSSH format).
 733
 734 `--start` `<boolean>` ('default =' `0`)::
 735
 736 Start the CT after its creation finished successfully.
 737
 738 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 739
 740 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.
 741
 742 `--storage` `<string>` ('default =' `local`)::
 743
 744 Default Storage.
 745
 746 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 747
 748 Amount of SWAP for the container in MB.
 749
 750 `--tags` `<string>` ::
 751
 752 Tags of the Container. This is only meta information.
 753
 754 `--template` `<boolean>` ('default =' `0`)::
 755
 756 Enable/disable Template.
 757
 758 `--timezone` `<string>` ::
 759
 760 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
 761
 762 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 763
 764 Specify the number of tty available to the container
 765
 766 `--unique` `<boolean>` ::
 767
 768 Assign a unique random ethernet address.
 769 +
 770 NOTE: Requires option(s): `restore`
 771
 772 `--unprivileged` `<boolean>` ('default =' `0`)::
 773
 774 Makes the container run as unprivileged user. (Should not be modified manually.)
 775
 776 `--unused[n]` `[volume=]<volume>` ::
 777
 778 Reference to unused volumes. This is used internally, and should not be modified manually.
 779
 780 *pct resume* `<vmid>`
 781
 782 Resume the container.
 783
 784 `<vmid>`: `<integer> (1 - N)` ::
 785
 786 The (unique) ID of the VM.
 787
 788 *pct rollback* `<vmid> <snapname>` `[OPTIONS]`
 789
 790 Rollback LXC state to specified snapshot.
 791
 792 `<vmid>`: `<integer> (1 - N)` ::
 793
 794 The (unique) ID of the VM.
 795
 796 `<snapname>`: `<string>` ::
 797
 798 The name of the snapshot.
 799
 800 `--start` `<boolean>` ('default =' `0`)::
 801
 802 Whether the container should get started after rolling back successfully
 803
 804 *pct set* `<vmid>` `[OPTIONS]`
 805
 806 Set container options.
 807
 808 `<vmid>`: `<integer> (1 - N)` ::
 809
 810 The (unique) ID of the VM.
 811
 812 `--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
 813
 814 OS architecture type.
 815
 816 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 817
 818 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).
 819
 820 `--console` `<boolean>` ('default =' `1`)::
 821
 822 Attach a console device (/dev/console) to the container.
 823
 824 `--cores` `<integer> (1 - 8192)` ::
 825
 826 The number of cores assigned to the container. A container can use all available cores by default.
 827
 828 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 829
 830 Limit of CPU usage.
 831 +
 832 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 833
 834 `--cpuunits` `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
 835
 836 CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
 837
 838 `--debug` `<boolean>` ('default =' `0`)::
 839
 840 Try to be more verbose. For now this only enables debug log-level on start.
 841
 842 `--delete` `<string>` ::
 843
 844 A list of settings you want to delete.
 845
 846 `--description` `<string>` ::
 847
 848 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 849
 850 `--digest` `<string>` ::
 851
 852 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 853
 854 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 855
 856 Allow containers access to advanced features.
 857
 858 `--hookscript` `<string>` ::
 859
 860 Script that will be exectued during various steps in the containers lifetime.
 861
 862 `--hostname` `<string>` ::
 863
 864 Set a host name for the container.
 865
 866 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 867
 868 Lock/unlock the container.
 869
 870 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 871
 872 Amount of RAM for the container in MB.
 873
 874 `--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>]` ::
 875
 876 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 877
 878 `--nameserver` `<string>` ::
 879
 880 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 881
 882 `--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)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 883
 884 Specifies network interfaces for the container.
 885
 886 `--onboot` `<boolean>` ('default =' `0`)::
 887
 888 Specifies whether a container will be started during system bootup.
 889
 890 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
 891
 892 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.
 893
 894 `--protection` `<boolean>` ('default =' `0`)::
 895
 896 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 897
 898 `--revert` `<string>` ::
 899
 900 Revert a pending change.
 901
 902 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 903
 904 Use volume as container root.
 905
 906 `--searchdomain` `<string>` ::
 907
 908 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 909
 910 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 911
 912 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.
 913
 914 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 915
 916 Amount of SWAP for the container in MB.
 917
 918 `--tags` `<string>` ::
 919
 920 Tags of the Container. This is only meta information.
 921
 922 `--template` `<boolean>` ('default =' `0`)::
 923
 924 Enable/disable Template.
 925
 926 `--timezone` `<string>` ::
 927
 928 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
 929
 930 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 931
 932 Specify the number of tty available to the container
 933
 934 `--unprivileged` `<boolean>` ('default =' `0`)::
 935
 936 Makes the container run as unprivileged user. (Should not be modified manually.)
 937
 938 `--unused[n]` `[volume=]<volume>` ::
 939
 940 Reference to unused volumes. This is used internally, and should not be modified manually.
 941
 942 *pct shutdown* `<vmid>` `[OPTIONS]`
 943
 944 Shutdown the container. This will trigger a clean shutdown of the
 945 container, see lxc-stop(1) for details.
 946
 947 `<vmid>`: `<integer> (1 - N)` ::
 948
 949 The (unique) ID of the VM.
 950
 951 `--forceStop` `<boolean>` ('default =' `0`)::
 952
 953 Make sure the Container stops.
 954
 955 `--timeout` `<integer> (0 - N)` ('default =' `60`)::
 956
 957 Wait maximal timeout seconds.
 958
 959 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
 960
 961 Snapshot a container.
 962
 963 `<vmid>`: `<integer> (1 - N)` ::
 964
 965 The (unique) ID of the VM.
 966
 967 `<snapname>`: `<string>` ::
 968
 969 The name of the snapshot.
 970
 971 `--description` `<string>` ::
 972
 973 A textual description or comment.
 974
 975 *pct start* `<vmid>` `[OPTIONS]`
 976
 977 Start the container.
 978
 979 `<vmid>`: `<integer> (1 - N)` ::
 980
 981 The (unique) ID of the VM.
 982
 983 `--debug` `<boolean>` ('default =' `0`)::
 984
 985 If set, enables very verbose debug log-level on start.
 986
 987 `--skiplock` `<boolean>` ::
 988
 989 Ignore locks - only root is allowed to use this option.
 990
 991 *pct status* `<vmid>` `[OPTIONS]`
 992
 993 Show CT status.
 994
 995 `<vmid>`: `<integer> (1 - N)` ::
 996
 997 The (unique) ID of the VM.
 998
 999 `--verbose` `<boolean>` ::
1000
1001 Verbose output format
1002
1003 *pct stop* `<vmid>` `[OPTIONS]`
1004
1005 Stop the container. This will abruptly stop all processes running in the
1006 container.
1007
1008 `<vmid>`: `<integer> (1 - N)` ::
1009
1010 The (unique) ID of the VM.
1011
1012 `--skiplock` `<boolean>` ::
1013
1014 Ignore locks - only root is allowed to use this option.
1015
1016 *pct suspend* `<vmid>`
1017
1018 Suspend the container. This is experimental.
1019
1020 `<vmid>`: `<integer> (1 - N)` ::
1021
1022 The (unique) ID of the VM.
1023
1024 *pct template* `<vmid>`
1025
1026 Create a Template.
1027
1028 `<vmid>`: `<integer> (1 - N)` ::
1029
1030 The (unique) ID of the VM.
1031
1032 *pct unlock* `<vmid>`
1033
1034 Unlock the VM.
1035
1036 `<vmid>`: `<integer> (1 - N)` ::
1037
1038 The (unique) ID of the VM.
1039
1040 *pct unmount* `<vmid>`
1041
1042 Unmount the container's filesystem.
1043
1044 `<vmid>`: `<integer> (1 - N)` ::
1045
1046 The (unique) ID of the VM.
1047
1048