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