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