mirror of
git://git.proxmox.com/git/pve-docs.git
synced 2025-03-09 08:58:19 +03:00
update static schema/synopsis definitions
this time *without* pve-network installed for now. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
parent
eebb350680
commit
5c1699e5ef
File diff suppressed because it is too large
Load Diff
@ -36,13 +36,13 @@ Set the fencing mode of the HA cluster. Hardware mode needs a valid configuratio
|
||||
+
|
||||
WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP
|
||||
|
||||
`ha`: `shutdown_policy=<freeze|failover|conditional>` ::
|
||||
`ha`: `shutdown_policy=<enum>` ::
|
||||
|
||||
Cluster wide HA settings.
|
||||
|
||||
`shutdown_policy`=`<conditional | failover | freeze>` ('default =' `conditional`);;
|
||||
`shutdown_policy`=`<conditional | failover | freeze | migrate>` ('default =' `conditional`);;
|
||||
|
||||
Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes.
|
||||
Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes. Migrate will try to move all running services to another node on both, rebootand shutdown. The poweroff process will only continue once no running services are located on the node anymore. If the node comes up again, the service will be moved back to the previously powered-off node, at least if no other migration, reloaction or recovery took place.
|
||||
|
||||
`http_proxy`: `http://.*` ::
|
||||
|
||||
|
@ -216,6 +216,10 @@ Default Storage.
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`--tags` `<string>` ::
|
||||
|
||||
Tags of the Container. This is only meta information.
|
||||
|
||||
`--template` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
@ -476,6 +480,19 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal).
|
||||
|
||||
Owner user name or id. When using a name it must exist inside the container.
|
||||
|
||||
*pct reboot* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Reboot the container by shutting it down, and starting it again. Applies
|
||||
pending changes.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--timeout` `<integer> (0 - N)` ::
|
||||
|
||||
Wait maximal timeout seconds for the shutdown.
|
||||
|
||||
*pct rescan* `[OPTIONS]`
|
||||
|
||||
Rescan all storages and update disk sizes and unused disk images.
|
||||
@ -644,6 +661,10 @@ Default Storage.
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`--tags` `<string>` ::
|
||||
|
||||
Tags of the Container. This is only meta information.
|
||||
|
||||
`--template` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
@ -798,6 +819,10 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`--tags` `<string>` ::
|
||||
|
||||
Tags of the Container. This is only meta information.
|
||||
|
||||
`--template` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
@ -236,6 +236,10 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`tags`: `<string>` ::
|
||||
|
||||
Tags of the Container. This is only meta information.
|
||||
|
||||
`template`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
@ -14,26 +14,42 @@ Log level for outgoing traffic.
|
||||
|
||||
Enable logging of conntrack information.
|
||||
|
||||
`ndp`: `<boolean>` ::
|
||||
`ndp`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable NDP.
|
||||
Enable NDP (Neighbor Discovery Protocol).
|
||||
|
||||
`nf_conntrack_allow_invalid`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Allow invalid packets on connection tracking.
|
||||
|
||||
`nf_conntrack_max`: `<integer> (32768 - N)` ::
|
||||
`nf_conntrack_max`: `<integer> (32768 - N)` ('default =' `262144`)::
|
||||
|
||||
Maximum number of tracked connections.
|
||||
|
||||
`nf_conntrack_tcp_timeout_established`: `<integer> (7875 - N)` ::
|
||||
`nf_conntrack_tcp_timeout_established`: `<integer> (7875 - N)` ('default =' `432000`)::
|
||||
|
||||
Conntrack established timeout.
|
||||
|
||||
`nf_conntrack_tcp_timeout_syn_recv`: `<integer> (30 - 60)` ('default =' `60`)::
|
||||
|
||||
Conntrack syn recv timeout.
|
||||
|
||||
`nosmurfs`: `<boolean>` ::
|
||||
|
||||
Enable SMURFS filter.
|
||||
|
||||
`protection_synflood`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable synflood protection
|
||||
|
||||
`protection_synflood_burst`: `<integer>` ('default =' `1000`)::
|
||||
|
||||
Synflood protection rate burst by ip src.
|
||||
|
||||
`protection_synflood_rate`: `<integer>` ('default =' `200`)::
|
||||
|
||||
Synflood protection rate syn/sec by ip src.
|
||||
|
||||
`smurf_log_level`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
|
||||
|
||||
Log level for SMURFS filter.
|
||||
@ -42,7 +58,7 @@ Log level for SMURFS filter.
|
||||
|
||||
Log level for illegal tcp flags filter.
|
||||
|
||||
`tcpflags`: `<boolean>` ::
|
||||
`tcpflags`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Filter illegal combinations of TCP flags.
|
||||
|
||||
|
@ -1,8 +1,8 @@
|
||||
`dhcp`: `<boolean>` ::
|
||||
`dhcp`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable DHCP.
|
||||
|
||||
`enable`: `<boolean>` ::
|
||||
`enable`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable firewall rules.
|
||||
|
||||
@ -18,13 +18,13 @@ Log level for incoming traffic.
|
||||
|
||||
Log level for outgoing traffic.
|
||||
|
||||
`macfilter`: `<boolean>` ::
|
||||
`macfilter`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable MAC address filter.
|
||||
|
||||
`ndp`: `<boolean>` ::
|
||||
`ndp`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable NDP.
|
||||
Enable NDP (Neighbor Discovery Protocol).
|
||||
|
||||
`policy_in`: `<ACCEPT | DROP | REJECT>` ::
|
||||
|
||||
|
@ -101,10 +101,14 @@ Overwrite existing custom or ACME certificate files.
|
||||
|
||||
Restart pveproxy.
|
||||
|
||||
*pvenode config get*
|
||||
*pvenode config get* `[OPTIONS]`
|
||||
|
||||
Get node configuration options.
|
||||
|
||||
`--property` `<acme | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
|
||||
|
||||
Return only a specific property from the node configuration.
|
||||
|
||||
*pvenode config set* `[OPTIONS]`
|
||||
|
||||
Set node configuration options.
|
||||
@ -125,6 +129,10 @@ Node description/comment.
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`--startall-onboot-delay` `<integer> (0 - 300)` ('default =' `0`)::
|
||||
|
||||
Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.
|
||||
|
||||
`--wakeonlan` `<string>` ::
|
||||
|
||||
MAC address for wake on LAN
|
||||
|
@ -90,6 +90,10 @@ Create the directory if it doesn't exist.
|
||||
|
||||
IP addresses of monitors (for external clusters).
|
||||
|
||||
`--mountpoint` `<string>` ::
|
||||
|
||||
mount point
|
||||
|
||||
`--nodes` `<string>` ::
|
||||
|
||||
List of cluster node names.
|
||||
@ -500,6 +504,10 @@ Create the directory if it doesn't exist.
|
||||
|
||||
IP addresses of monitors (for external clusters).
|
||||
|
||||
`--mountpoint` `<string>` ::
|
||||
|
||||
mount point
|
||||
|
||||
`--nodes` `<string>` ::
|
||||
|
||||
List of cluster node names.
|
||||
|
@ -24,6 +24,10 @@ List of roles.
|
||||
|
||||
List of users.
|
||||
|
||||
*pveum acl list* `[FORMAT_OPTIONS]`
|
||||
|
||||
Get Access Control List (ACLs).
|
||||
|
||||
*pveum acl modify* `<path> --roles <string>` `[OPTIONS]`
|
||||
|
||||
Update Access Control List (add or remove permissions).
|
||||
@ -76,6 +80,10 @@ Delete group.
|
||||
|
||||
no description available
|
||||
|
||||
*pveum group list* `[FORMAT_OPTIONS]`
|
||||
|
||||
Group index.
|
||||
|
||||
*pveum group modify* `<groupid>` `[OPTIONS]`
|
||||
|
||||
Update group data.
|
||||
@ -140,6 +148,10 @@ Delete role.
|
||||
|
||||
no description available
|
||||
|
||||
*pveum role list* `[FORMAT_OPTIONS]`
|
||||
|
||||
Role index.
|
||||
|
||||
*pveum role modify* `<roleid>` `[OPTIONS]`
|
||||
|
||||
Update an existing role.
|
||||
@ -250,6 +262,14 @@ Delete user.
|
||||
|
||||
User ID
|
||||
|
||||
*pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
User index.
|
||||
|
||||
`--enabled` `<boolean>` ::
|
||||
|
||||
Optional filter for enable property.
|
||||
|
||||
*pveum user modify* `<userid>` `[OPTIONS]`
|
||||
|
||||
Update user configuration.
|
||||
|
@ -110,7 +110,7 @@ The (unique) ID of the VM.
|
||||
|
||||
Enable/disable ACPI.
|
||||
|
||||
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
|
||||
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
|
||||
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
|
||||
@ -259,7 +259,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
@ -383,6 +383,10 @@ Default storage.
|
||||
|
||||
Enable/disable the USB tablet device.
|
||||
|
||||
`--tags` `<string>` ::
|
||||
|
||||
Tags of the VM. This is only meta information.
|
||||
|
||||
`--tdf` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable time drift fix.
|
||||
@ -813,7 +817,7 @@ The (unique) ID of the VM.
|
||||
|
||||
Enable/disable ACPI.
|
||||
|
||||
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
|
||||
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
|
||||
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
|
||||
@ -962,7 +966,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
@ -1082,6 +1086,10 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
|
||||
|
||||
Enable/disable the USB tablet device.
|
||||
|
||||
`--tags` `<string>` ::
|
||||
|
||||
Tags of the VM. This is only meta information.
|
||||
|
||||
`--tdf` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable time drift fix.
|
||||
@ -1192,7 +1200,7 @@ Start virtual machine.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
Enable/disable ACPI.
|
||||
|
||||
`agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
|
||||
`agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
|
||||
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
|
||||
@ -14,6 +14,10 @@ Enable/disable Qemu GuestAgent.
|
||||
|
||||
Run fstrim after cloning/moving a disk.
|
||||
|
||||
`type`=`<isa | virtio>` ('default =' `virtio`);;
|
||||
|
||||
Select the agent type
|
||||
|
||||
`arch`: `<aarch64 | x86_64>` ::
|
||||
|
||||
Virtual processor architecture. Defaults to the host.
|
||||
@ -437,7 +441,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
|
||||
`machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
@ -556,7 +560,7 @@ win7;; Microsoft Windows 7
|
||||
win8;; Microsoft Windows 8/2012/2012r2
|
||||
win10;; Microsoft Windows 10/2016
|
||||
l24;; Linux 2.4 Kernel
|
||||
l26;; Linux 2.6/3.X Kernel
|
||||
l26;; Linux 2.6 - 5.X Kernel
|
||||
solaris;; Solaris/OpenSolaris/OpenIndiania kernel
|
||||
|
||||
`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
|
||||
@ -1031,6 +1035,10 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
|
||||
|
||||
Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl).
|
||||
|
||||
`tags`: `<string>` ::
|
||||
|
||||
Tags of the VM. This is only meta information.
|
||||
|
||||
`tdf`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable time drift fix.
|
||||
|
Loading…
x
Reference in New Issue
Block a user