pct.1-synopsis.adoc

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