proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-04-28 12:12:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update static files

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2018-07-10 11:35:10 +02:00
parent 8119f671e1
commit 5da3d723c1
8 changed files with 169 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
api-viewer/apidata.js
View File

@ -2267,6 +2267,12 @@ var pveapi = [
},
"returns" : {
"properties" : {
"ebtables" : {
"default" : 1,
"description" : "Enable ebtables rules cluster wide.",
"optional" : 1,
"type" : "boolean"
},
"enable" : {
"description" : "Enable or disable the firewall cluster wide.",
"minimum" : 0,
@ -2318,6 +2324,13 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"ebtables" : {
"default" : 1,
"description" : "Enable ebtables rules cluster wide.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"enable" : {
"description" : "Enable or disable the firewall cluster wide.",
"minimum" : 0,
@ -4019,6 +4032,9 @@ var pveapi = [
}
}
},
"permissions" : {
"user" : "all"
},
"returns" : {
"description" : "ACME TermsOfService URL.",
"type" : "string"
@ -4038,6 +4054,9 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0
},
"permissions" : {
"user" : "all"
},
"returns" : {
"items" : {
"additionalProperties" : 0,
@ -7993,7 +8012,7 @@ var pveapi = [
},
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.",
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
"enum" : [
"de",
"de-ch",
@ -8983,7 +9002,7 @@ var pveapi = [
},
"shares" : {
"default" : 1000,
"description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning",
"description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.",
"maximum" : 50000,
"minimum" : 0,
"optional" : 1,
@ -10052,7 +10071,7 @@ var pveapi = [
},
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.",
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
"enum" : [
"de",
"de-ch",
@ -11042,7 +11061,7 @@ var pveapi = [
},
"shares" : {
"default" : 1000,
"description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning",
"description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.",
"maximum" : 50000,
"minimum" : 0,
"optional" : 1,
@ -14241,7 +14260,7 @@ var pveapi = [
},
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.",
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
"enum" : [
"de",
"de-ch",
@ -15231,7 +15250,7 @@ var pveapi = [
},
"shares" : {
"default" : 1000,
"description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning",
"description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.",
"maximum" : 50000,
"minimum" : 0,
"optional" : 1,
@ -15269,6 +15288,13 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"start" : {
"default" : 0,
"description" : "Start VM after it was created successfully.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"startdate" : {
"default" : "now",
"description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.",
@ -20034,6 +20060,13 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"start" : {
"default" : 0,
"description" : "Start the CT after its creation finished successfully.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"startup" : {
"description" : "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.",
"format" : "pve-startup-order",
@ -27479,7 +27512,9 @@ var pveapi = [
]
]
},
"returns" : {}
"returns" : {
"type" : "object"
}
},
"PUT" : {
"description" : "Update storage configuration.",
@ -27591,6 +27626,12 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"fuse" : {
"description" : "Mount CephFS through FUSE.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"is_mountpoint" : {
"default" : "no",
"description" : "Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.",
@ -27701,10 +27742,14 @@ var pveapi = [
"typetext" : "<boolean>"
},
"smbversion" : {
"description" : "",
"description" : "SMB protocol version",
"enum" : [
"2.0",
"2.1",
"3.0"
],
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"type" : "string"
},
"sparse" : {
"description" : "use sparse volumes",
@ -27718,6 +27763,13 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"subdir" : {
"description" : "Subdir to mount.",
"format" : "pve-storage-path",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"tagged_only" : {
"description" : "Only use logical volumes tagged with 'pve-vm-ID'.",
"optional" : 1,
@ -27774,6 +27826,7 @@ var pveapi = [
"type" : {
"description" : "Only list storage of specific type",
"enum" : [
"cephfs",
"cifs",
"dir",
"drbd",
@ -27930,6 +27983,12 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"fuse" : {
"description" : "Mount CephFS through FUSE.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"is_mountpoint" : {
"default" : "no",
"description" : "Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.",
@ -28066,10 +28125,14 @@ var pveapi = [
"typetext" : "<boolean>"
},
"smbversion" : {
"description" : "",
"description" : "SMB protocol version",
"enum" : [
"2.0",
"2.1",
"3.0"
],
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"type" : "string"
},
"sparse" : {
"description" : "use sparse volumes",
@ -28083,6 +28146,13 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"subdir" : {
"description" : "Subdir to mount.",
"format" : "pve-storage-path",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"tagged_only" : {
"description" : "Only use logical volumes tagged with 'pve-vm-ID'.",
"optional" : 1,
@ -28115,6 +28185,7 @@ var pveapi = [
"type" : {
"description" : "Storage type.",
"enum" : [
"cephfs",
"cifs",
"dir",
"drbd",

12
pct.1-synopsis.adoc
View File

@ -148,7 +148,7 @@ Specifies whether a VM will be started during system bootup.
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.
`--password` ::
`--password` `<password>` ::
Sets root password inside container.
@ -176,6 +176,10 @@ Sets DNS search domains for a container. Create will automatically use the setti
Setup public SSH keys (one key per line, OpenSSH format).
`--start` `<boolean>` ('default =' `0`)::
Start the CT after its creation finished successfully.
`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
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.
@ -522,7 +526,7 @@ Specifies whether a VM will be started during system bootup.
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.
`--password` ::
`--password` `<password>` ::
Sets root password inside container.
@ -546,6 +550,10 @@ Sets DNS search domains for a container. Create will automatically use the setti
Setup public SSH keys (one key per line, OpenSSH format).
`--start` `<boolean>` ('default =' `0`)::
Start the CT after its creation finished successfully.
`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
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.

4
pve-firewall-cluster-opts.adoc
View File

@ -1,3 +1,7 @@
`ebtables`: `<boolean>` ('default =' `1`)::
Enable ebtables rules cluster wide.
`enable`: `<integer> (0 - N)` ::
Enable or disable the firewall cluster wide.

36
pvenode.1-synopsis.adoc
View File

@ -137,4 +137,40 @@ Shows help for a specific command
Verbose output format.
*pvenode migrateall* `<target>` `[OPTIONS]`
Migrate all VMs and Containers.
`<target>`: `<string>` ::
Target node.
`--maxworkers` `<integer> (1 - N)` ::
Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!
`--vms` `<string>` ::
Only consider Guests with these IDs.
*pvenode startall* `[OPTIONS]`
Start all VMs and containers (when onboot=1).
`--force` `<boolean>` ::
force if onboot=0.
`--vms` `<string>` ::
Only consider Guests with these IDs.
*pvenode stopall* `[OPTIONS]`
Stop all VMs and Containers.
`--vms` `<string>` ::
Only consider Guests with these IDs.

32
pvesm.1-synopsis.adoc
View File

@ -4,7 +4,7 @@
Create a new storage.
`<type>`: `<cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
`<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
Storage type.
@ -58,6 +58,10 @@ NFS export path.
Default image format.
`--fuse` `<boolean>` ::
Mount CephFS through FUSE.
`--is_mountpoint` `<string>` ('default =' `no`)::
Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.
@ -94,7 +98,7 @@ disable write caching on the target
NFS mount options (see 'man nfs')
`--password` ::
`--password` `<password>` ::
Password for CIFS share.
@ -140,14 +144,18 @@ CIFS share.
Mark storage as shared.
`--smbversion` `<string>` ::
`--smbversion` `<2.0 | 2.1 | 3.0>` ::
no description available
SMB protocol version
`--sparse` `<boolean>` ::
use sparse volumes
`--subdir` `<string>` ::
Subdir to mount.
`--tagged_only` `<boolean>` ::
Only use logical volumes tagged with 'pve-vm-ID'.
@ -214,7 +222,7 @@ no description available
no description available
`--password` ::
`--password` `<password>` ::
no description available
@ -428,6 +436,10 @@ CIFS domain.
Default image format.
`--fuse` `<boolean>` ::
Mount CephFS through FUSE.
`--is_mountpoint` `<string>` ('default =' `no`)::
Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.
@ -460,7 +472,7 @@ disable write caching on the target
NFS mount options (see 'man nfs')
`--password` ::
`--password` `<string>` ::
Password for CIFS share.
@ -494,14 +506,18 @@ NOTE: Requires option(s): `server`
Mark storage as shared.
`--smbversion` `<string>` ::
`--smbversion` `<2.0 | 2.1 | 3.0>` ::
no description available
SMB protocol version
`--sparse` `<boolean>` ::
use sparse volumes
`--subdir` `<string>` ::
Subdir to mount.
`--tagged_only` `<boolean>` ::
Only use logical volumes tagged with 'pve-vm-ID'.

2
pveum.1-synopsis.adoc
View File

@ -206,7 +206,7 @@ Keys for two factor auth (yubico).
no description available
`--password` ::
`--password` `<password>` ::
Initial password.

12
qm.1-synopsis.adoc
View File

@ -196,7 +196,7 @@ If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, i
`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
`--kvm` `<boolean>` ('default =' `1`)::
@ -292,7 +292,7 @@ Create a serial device inside the VM (n is 0 to 3)
`--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning
Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.
`--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
@ -310,6 +310,10 @@ The number of CPU sockets.
cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
`--start` `<boolean>` ('default =' `0`)::
Start VM after it was created successfully.
`--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
@ -778,7 +782,7 @@ If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, i
`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
`--kvm` `<boolean>` ('default =' `1`)::
@ -874,7 +878,7 @@ Create a serial device inside the VM (n is 0 to 3)
`--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning
Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.
`--skiplock` `<boolean>` ::

4
qm.conf.5-opts.adoc
View File

@ -349,7 +349,7 @@ IPv6 address in CIDR format.
`keyboard`: `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
`kvm`: `<boolean>` ('default =' `1`)::
@ -867,7 +867,7 @@ CAUTION: Experimental! User reported problems with this option.
`shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning
Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.
`smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::