mirror of
git://git.proxmox.com/git/pve-docs.git
synced 2025-03-19 18:50:06 +03:00
run make update for static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
a10a91c288
commit
e9cd3bd4d9
File diff suppressed because it is too large
Load Diff
@ -42,7 +42,7 @@ Cluster wide HA settings.
|
||||
|
||||
`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. 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.
|
||||
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 when a reboot or shutdown was triggered. 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://.*` ::
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@
|
||||
|===========================================================
|
||||
|
||||
[horizontal]
|
||||
'Ceph':: Ceph Storage Cluster traffic (Ceph Monitors, OSD & MDS Daemons)
|
||||
'Ceph':: Ceph Storage Cluster traffic (Ceph Monitors, OSD & MDS Deamons)
|
||||
|
||||
[width="100%",options="header"]
|
||||
|===========================================================
|
||||
@ -452,6 +452,15 @@
|
||||
|PARAM|tcp|5631|
|
||||
|===========================================================
|
||||
|
||||
[horizontal]
|
||||
'PMG':: Proxmox Mail Gateway web interface
|
||||
|
||||
[width="100%",options="header"]
|
||||
|===========================================================
|
||||
|Action|proto|dport|sport
|
||||
|PARAM|tcp|8006|
|
||||
|===========================================================
|
||||
|
||||
[horizontal]
|
||||
'POP3':: POP3 traffic
|
||||
|
||||
|
||||
@ -165,6 +165,10 @@ Maximal number of parallel migration job. If not set use 'max_workers' from data
|
||||
|
||||
Only consider Guests with these IDs.
|
||||
|
||||
`--with-local-disks` `<boolean>` ::
|
||||
|
||||
Enable live storage migration for local disk
|
||||
|
||||
*pvenode startall* `[OPTIONS]`
|
||||
|
||||
Start all VMs and containers located on this node (by default only those
|
||||
|
||||
@ -20,6 +20,10 @@ Allow to propagate (inherit) permissions.
|
||||
|
||||
List of roles.
|
||||
|
||||
`--tokens` `<string>` ::
|
||||
|
||||
List of API tokens.
|
||||
|
||||
`--users` `<string>` ::
|
||||
|
||||
List of users.
|
||||
@ -48,6 +52,10 @@ Allow to propagate (inherit) permissions.
|
||||
|
||||
List of roles.
|
||||
|
||||
`--tokens` `<string>` ::
|
||||
|
||||
List of API tokens.
|
||||
|
||||
`--users` `<string>` ::
|
||||
|
||||
List of users.
|
||||
@ -270,6 +278,10 @@ User index.
|
||||
|
||||
Optional filter for enable property.
|
||||
|
||||
`--full` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Include group and token information.
|
||||
|
||||
*pveum user modify* `<userid>` `[OPTIONS]`
|
||||
|
||||
Update user configuration.
|
||||
@ -316,6 +328,103 @@ Keys for two factor auth (yubico).
|
||||
|
||||
no description available
|
||||
|
||||
*pveum user permissions* `[<userid>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
Retrieve effective permissions of given user/token.
|
||||
|
||||
`<userid>`: `(?^:^(?^:[^\s:/]+)\@(?^:[A-Za-z][A-Za-z0-9\.\-_]+)(?:!(?^:[A-Za-z][A-Za-z0-9\.\-_]+))?$)` ::
|
||||
|
||||
User ID or full API token ID
|
||||
|
||||
`--path` `<string>` ::
|
||||
|
||||
Only dump this specific path, not the whole tree.
|
||||
|
||||
*pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
Generate a new API token for a specific user. NOTE: returns API token
|
||||
value, which needs to be stored as it cannot be retrieved afterwards!
|
||||
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
|
||||
|
||||
User-specific token identifier.
|
||||
|
||||
`--comment` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`--expire` `<integer> (0 - N)` ('default =' `same as user`)::
|
||||
|
||||
API token expiration date (seconds since epoch). '0' means no expiration date.
|
||||
|
||||
`--privsep` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
|
||||
|
||||
*pveum user token list* `<userid>` `[FORMAT_OPTIONS]`
|
||||
|
||||
Get user API tokens.
|
||||
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
*pveum user token modify* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
Update API token for a specific user.
|
||||
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
|
||||
|
||||
User-specific token identifier.
|
||||
|
||||
`--comment` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`--expire` `<integer> (0 - N)` ('default =' `same as user`)::
|
||||
|
||||
API token expiration date (seconds since epoch). '0' means no expiration date.
|
||||
|
||||
`--privsep` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
|
||||
|
||||
*pveum user token permissions* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
Retrieve effective permissions of given token.
|
||||
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
|
||||
|
||||
User-specific token identifier.
|
||||
|
||||
`--path` `<string>` ::
|
||||
|
||||
Only dump this specific path, not the whole tree.
|
||||
|
||||
*pveum user token remove* `<userid> <tokenid>` `[FORMAT_OPTIONS]`
|
||||
|
||||
Remove API token for a specific user.
|
||||
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
|
||||
|
||||
User-specific token identifier.
|
||||
|
||||
*pveum useradd*
|
||||
|
||||
An alias for 'pveum user add'.
|
||||
|
||||
@ -83,8 +83,9 @@ Config type.
|
||||
|
||||
*qm config* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Get current virtual machine configuration. This does not include pending
|
||||
configuration changes (see 'pending' API).
|
||||
Get the virtual machine configuration with pending configuration changes
|
||||
applied. Set the 'current' parameter to get the current configuration
|
||||
instead.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
@ -325,7 +326,7 @@ Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
|
||||
|
||||
`--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
|
||||
|
||||
`--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
|
||||
|
||||
@ -654,7 +655,7 @@ Move volume to different storage.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
|
||||
The disk you want to move.
|
||||
|
||||
@ -692,7 +693,7 @@ The (unique) ID of the VM.
|
||||
|
||||
*qm pending* `<vmid>`
|
||||
|
||||
Get virtual machine configuration, including pending changes.
|
||||
Get the virtual machine configuration with both current and pending values.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
@ -743,7 +744,7 @@ Extend volume size.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
|
||||
The disk you want to resize.
|
||||
|
||||
@ -1032,7 +1033,7 @@ Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
|
||||
|
||||
`--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
|
||||
|
||||
`--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
|
||||
|
||||
@ -1228,6 +1229,10 @@ Some command save/restore state from this location.
|
||||
|
||||
Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
|
||||
|
||||
`--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`)::
|
||||
|
||||
Wait maximal timeout seconds.
|
||||
|
||||
*qm status* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Show VM status.
|
||||
@ -1295,7 +1300,7 @@ Create a Template.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
`--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
|
||||
If you want to convert only 1 disk to base image.
|
||||
|
||||
|
||||
@ -755,7 +755,7 @@ The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
|
||||
|
||||
`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
|
||||
|
||||
`aio`=`<native | threads>` ;;
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user