mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-04-28 19:45:44 +00:00
run make update-static
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
90682f3598
commit
e2d681b368
File diff suppressed because it is too large
Load Diff
@ -112,7 +112,7 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
|
||||
Allow containers access to advanced features.
|
||||
|
||||
@ -426,6 +426,18 @@ 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 rescan* `[OPTIONS]`
|
||||
|
||||
Rescan all storages and update disk sizes and unused disk images.
|
||||
|
||||
`--dryrun` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Do not actually write changes out to conifg.
|
||||
|
||||
`--vmid` `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
*pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
|
||||
|
||||
Resize a container mount point.
|
||||
@ -494,7 +506,7 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
|
||||
Allow containers access to advanced features.
|
||||
|
||||
@ -662,7 +674,7 @@ Container description. Only used on the configuration web interface.
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
|
||||
Allow containers access to advanced features.
|
||||
|
||||
|
||||
@ -30,10 +30,14 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`features`: `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
`features`: `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
|
||||
Allow containers access to advanced features.
|
||||
|
||||
`fuse`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Allow using 'fuse' file systems in a container. Note that interactions between fuse and the freezer cgroup can potentially cause I/O deadlocks.
|
||||
|
||||
`keyctl`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
For unprivileged containers only: Allow the use of the keyctl() system call. This is required to use docker inside a container. By default unprivileged containers will see this system call as non-existent. This is mostly a workaround for systemd-networkd, as it will treat it as a fatal error when some keyctl() operations are denied by the kernel due to lacking permissions. Essentially, you can choose between running systemd-networkd or docker.
|
||||
|
||||
@ -1,132 +1,52 @@
|
||||
*pveceph* `<COMMAND> [ARGS] [OPTIONS]`
|
||||
|
||||
*pveceph createmgr* `[OPTIONS]`
|
||||
*pveceph createmgr*
|
||||
|
||||
Create Ceph Manager
|
||||
An alias for 'pveceph mgr create'.
|
||||
|
||||
`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
|
||||
*pveceph createmon*
|
||||
|
||||
The ID for the manager, when omitted the same as the nodename
|
||||
An alias for 'pveceph mon create'.
|
||||
|
||||
*pveceph createmon* `[OPTIONS]`
|
||||
*pveceph createosd*
|
||||
|
||||
Create Ceph Monitor and Manager
|
||||
An alias for 'pveceph osd create'.
|
||||
|
||||
`--exclude-manager` `<boolean>` ('default =' `0`)::
|
||||
*pveceph createpool*
|
||||
|
||||
When set, only a monitor will be created.
|
||||
An alias for 'pveceph pool create'.
|
||||
|
||||
`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
|
||||
*pveceph destroymgr*
|
||||
|
||||
The ID for the monitor, when omitted the same as the nodename
|
||||
An alias for 'pveceph mgr destroy'.
|
||||
|
||||
`--mon-address` `<string>` ::
|
||||
*pveceph destroymon*
|
||||
|
||||
Overwrites autodetected monitor IP address. Must be in the public network of ceph.
|
||||
An alias for 'pveceph mon destroy'.
|
||||
|
||||
*pveceph createosd* `<dev>` `[OPTIONS]`
|
||||
*pveceph destroyosd*
|
||||
|
||||
Create OSD
|
||||
An alias for 'pveceph osd destroy'.
|
||||
|
||||
`<dev>`: `<string>` ::
|
||||
*pveceph destroypool*
|
||||
|
||||
Block device name.
|
||||
An alias for 'pveceph pool destroy'.
|
||||
|
||||
`--bluestore` `<boolean>` ('default =' `1`)::
|
||||
*pveceph fs create* `[OPTIONS]`
|
||||
|
||||
Use bluestore instead of filestore. This is the default.
|
||||
Create a Ceph filesystem
|
||||
|
||||
`--fstype` `<ext4 | xfs>` ('default =' `xfs`)::
|
||||
`--add-storage` `<boolean>` ('default =' `0`)::
|
||||
|
||||
File system type (filestore only).
|
||||
Configure the created CephFS as storage for this cluster.
|
||||
|
||||
`--journal_dev` `<string>` ::
|
||||
`--name` `<string>` ('default =' `cephfs`)::
|
||||
|
||||
Block device name for journal (filestore) or block.db (bluestore).
|
||||
The ceph filesystem name.
|
||||
|
||||
`--wal_dev` `<string>` ::
|
||||
`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
|
||||
|
||||
Block device name for block.wal (bluestore only).
|
||||
|
||||
*pveceph createpool* `<name>` `[OPTIONS]`
|
||||
|
||||
Create POOL
|
||||
|
||||
`<name>`: `<string>` ::
|
||||
|
||||
The name of the pool. It must be unique.
|
||||
|
||||
`--add_storages` `<boolean>` ::
|
||||
|
||||
Configure VM and CT storages using the new pool.
|
||||
|
||||
`--application` `<cephfs | rbd | rgw>` ::
|
||||
|
||||
The application of the pool, 'rbd' by default.
|
||||
|
||||
`--crush_rule` `<string>` ::
|
||||
|
||||
The rule to use for mapping object placement in the cluster.
|
||||
|
||||
`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
|
||||
|
||||
Minimum number of replicas per object
|
||||
|
||||
`--pg_num` `<integer> (8 - 32768)` ('default =' `64`)::
|
||||
|
||||
Number of placement groups.
|
||||
|
||||
`--size` `<integer> (1 - 7)` ('default =' `3`)::
|
||||
|
||||
Number of replicas per object
|
||||
|
||||
*pveceph destroymgr* `<id>`
|
||||
|
||||
Destroy Ceph Manager.
|
||||
|
||||
`<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
|
||||
|
||||
The ID of the manager
|
||||
|
||||
*pveceph destroymon* `<monid>` `[OPTIONS]`
|
||||
|
||||
Destroy Ceph Monitor and Manager.
|
||||
|
||||
`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
|
||||
|
||||
Monitor ID
|
||||
|
||||
`--exclude-manager` `<boolean>` ('default =' `0`)::
|
||||
|
||||
When set, removes only the monitor, not the manager
|
||||
|
||||
*pveceph destroyosd* `<osdid>` `[OPTIONS]`
|
||||
|
||||
Destroy OSD
|
||||
|
||||
`<osdid>`: `<integer>` ::
|
||||
|
||||
OSD ID
|
||||
|
||||
`--cleanup` `<boolean>` ('default =' `0`)::
|
||||
|
||||
If set, we remove partition table entries.
|
||||
|
||||
*pveceph destroypool* `<name>` `[OPTIONS]`
|
||||
|
||||
Destroy pool
|
||||
|
||||
`<name>`: `<string>` ::
|
||||
|
||||
The name of the pool. It must be unique.
|
||||
|
||||
`--force` `<boolean>` ('default =' `0`)::
|
||||
|
||||
If true, destroys pool even if in use
|
||||
|
||||
`--remove_storages` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Remove all pveceph-managed storages configured for this pool
|
||||
Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
|
||||
|
||||
*pveceph help* `[OPTIONS]`
|
||||
|
||||
@ -144,6 +64,12 @@ Verbose output format.
|
||||
|
||||
Create initial ceph default configuration and setup symlinks.
|
||||
|
||||
`--cluster-network` `<string>` ::
|
||||
|
||||
Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it
|
||||
+
|
||||
NOTE: Requires option(s): `network`
|
||||
|
||||
`--disable_cephx` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Disable cephx authentification.
|
||||
@ -178,6 +104,158 @@ no description available
|
||||
|
||||
*pveceph lspools*
|
||||
|
||||
An alias for 'pveceph pool ls'.
|
||||
|
||||
*pveceph mds create* `[OPTIONS]`
|
||||
|
||||
Create Ceph Metadata Server (MDS)
|
||||
|
||||
`--hotstandby` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources.
|
||||
|
||||
`--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::
|
||||
|
||||
The ID for the mds, when omitted the same as the nodename
|
||||
|
||||
*pveceph mds destroy* `<name>`
|
||||
|
||||
Destroy Ceph Metadata Server
|
||||
|
||||
`<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
|
||||
|
||||
The name (ID) of the mds
|
||||
|
||||
*pveceph mgr create* `[OPTIONS]`
|
||||
|
||||
Create Ceph Manager
|
||||
|
||||
`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
|
||||
|
||||
The ID for the manager, when omitted the same as the nodename
|
||||
|
||||
*pveceph mgr destroy* `<id>`
|
||||
|
||||
Destroy Ceph Manager.
|
||||
|
||||
`<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
|
||||
|
||||
The ID of the manager
|
||||
|
||||
*pveceph mon create* `[OPTIONS]`
|
||||
|
||||
Create Ceph Monitor and Manager
|
||||
|
||||
`--exclude-manager` `<boolean>` ('default =' `0`)::
|
||||
|
||||
When set, only a monitor will be created.
|
||||
|
||||
`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
|
||||
|
||||
The ID for the monitor, when omitted the same as the nodename
|
||||
|
||||
`--mon-address` `<string>` ::
|
||||
|
||||
Overwrites autodetected monitor IP address. Must be in the public network of ceph.
|
||||
|
||||
*pveceph mon destroy* `<monid>` `[OPTIONS]`
|
||||
|
||||
Destroy Ceph Monitor and Manager.
|
||||
|
||||
`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
|
||||
|
||||
Monitor ID
|
||||
|
||||
`--exclude-manager` `<boolean>` ('default =' `0`)::
|
||||
|
||||
When set, removes only the monitor, not the manager
|
||||
|
||||
*pveceph osd create* `<dev>` `[OPTIONS]`
|
||||
|
||||
Create OSD
|
||||
|
||||
`<dev>`: `<string>` ::
|
||||
|
||||
Block device name.
|
||||
|
||||
`--bluestore` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Use bluestore instead of filestore. This is the default.
|
||||
|
||||
`--fstype` `<ext4 | xfs>` ('default =' `xfs`)::
|
||||
|
||||
File system type (filestore only).
|
||||
|
||||
`--journal_dev` `<string>` ::
|
||||
|
||||
Block device name for journal (filestore) or block.db (bluestore).
|
||||
|
||||
`--wal_dev` `<string>` ::
|
||||
|
||||
Block device name for block.wal (bluestore only).
|
||||
|
||||
*pveceph osd destroy* `<osdid>` `[OPTIONS]`
|
||||
|
||||
Destroy OSD
|
||||
|
||||
`<osdid>`: `<integer>` ::
|
||||
|
||||
OSD ID
|
||||
|
||||
`--cleanup` `<boolean>` ('default =' `0`)::
|
||||
|
||||
If set, we remove partition table entries.
|
||||
|
||||
*pveceph pool create* `<name>` `[OPTIONS]`
|
||||
|
||||
Create POOL
|
||||
|
||||
`<name>`: `<string>` ::
|
||||
|
||||
The name of the pool. It must be unique.
|
||||
|
||||
`--add_storages` `<boolean>` ::
|
||||
|
||||
Configure VM and CT storage using the new pool.
|
||||
|
||||
`--application` `<cephfs | rbd | rgw>` ::
|
||||
|
||||
The application of the pool, 'rbd' by default.
|
||||
|
||||
`--crush_rule` `<string>` ::
|
||||
|
||||
The rule to use for mapping object placement in the cluster.
|
||||
|
||||
`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
|
||||
|
||||
Minimum number of replicas per object
|
||||
|
||||
`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
|
||||
|
||||
Number of placement groups.
|
||||
|
||||
`--size` `<integer> (1 - 7)` ('default =' `3`)::
|
||||
|
||||
Number of replicas per object
|
||||
|
||||
*pveceph pool destroy* `<name>` `[OPTIONS]`
|
||||
|
||||
Destroy pool
|
||||
|
||||
`<name>`: `<string>` ::
|
||||
|
||||
The name of the pool. It must be unique.
|
||||
|
||||
`--force` `<boolean>` ('default =' `0`)::
|
||||
|
||||
If true, destroys pool even if in use
|
||||
|
||||
`--remove_storages` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Remove all pveceph-managed storages configured for this pool
|
||||
|
||||
*pveceph pool ls*
|
||||
|
||||
List all pools.
|
||||
|
||||
*pveceph purge*
|
||||
@ -188,7 +266,7 @@ Destroy ceph related data and configuration files.
|
||||
|
||||
Start ceph services.
|
||||
|
||||
`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ::
|
||||
`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
|
||||
|
||||
Ceph service name.
|
||||
|
||||
@ -200,7 +278,7 @@ Get ceph status.
|
||||
|
||||
Stop ceph services.
|
||||
|
||||
`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ::
|
||||
`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
|
||||
|
||||
Ceph service name.
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ Number of votes for this node
|
||||
|
||||
*pvecm addnode* `<node>` `[OPTIONS]`
|
||||
|
||||
Adds a node to the cluster configuration.
|
||||
Adds a node to the cluster configuration. This call is for internal use.
|
||||
|
||||
`<node>`: `<string>` ::
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
Create a new storage.
|
||||
|
||||
`<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
|
||||
`<type>`: `<cephfs | cifs | dir | drbd | fake | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
|
||||
|
||||
Storage type.
|
||||
|
||||
@ -72,7 +72,7 @@ iscsi provider
|
||||
|
||||
`--krbd` `<boolean>` ::
|
||||
|
||||
Access rbd through krbd kernel module.
|
||||
Always access rbd through krbd kernel module.
|
||||
|
||||
`--lio_tpg` `<string>` ::
|
||||
|
||||
@ -214,25 +214,9 @@ no description available
|
||||
+
|
||||
NOTE: Requires option(s): `size`
|
||||
|
||||
*pvesm cifsscan* `<server>` `[OPTIONS]`
|
||||
*pvesm cifsscan*
|
||||
|
||||
Scan remote CIFS server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
The server address (name or IP).
|
||||
|
||||
`--domain` `<string>` ::
|
||||
|
||||
SMB domain (Workgroup).
|
||||
|
||||
`--password` `<password>` ::
|
||||
|
||||
User password.
|
||||
|
||||
`--username` `<string>` ::
|
||||
|
||||
User name.
|
||||
An alias for 'pvesm scan cifs'.
|
||||
|
||||
*pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
|
||||
|
||||
@ -282,13 +266,9 @@ Volume identifier
|
||||
|
||||
The storage identifier.
|
||||
|
||||
*pvesm glusterfsscan* `<server>`
|
||||
*pvesm glusterfsscan*
|
||||
|
||||
Scan remote GlusterFS server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
The server address (name or IP).
|
||||
An alias for 'pvesm scan glusterfs'.
|
||||
|
||||
*pvesm help* `[OPTIONS]`
|
||||
|
||||
@ -330,13 +310,9 @@ A snapshot to delete on success
|
||||
|
||||
Whether the stream includes intermediate snapshots
|
||||
|
||||
*pvesm iscsiscan* `<portal>`
|
||||
*pvesm iscsiscan*
|
||||
|
||||
Scan remote iSCSI server.
|
||||
|
||||
`<portal>`: `<string>` ::
|
||||
|
||||
The iSCSI portal (IP or DNS name with optional port).
|
||||
An alias for 'pvesm scan iscsi'.
|
||||
|
||||
*pvesm list* `<storage>` `[OPTIONS]`
|
||||
|
||||
@ -356,23 +332,15 @@ Only list images for this VM
|
||||
|
||||
*pvesm lvmscan*
|
||||
|
||||
List local LVM volume groups.
|
||||
An alias for 'pvesm scan lvm'.
|
||||
|
||||
*pvesm lvmthinscan* `<vg>`
|
||||
*pvesm lvmthinscan*
|
||||
|
||||
List local LVM Thin Pools.
|
||||
An alias for 'pvesm scan lvmthin'.
|
||||
|
||||
`<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
|
||||
*pvesm nfsscan*
|
||||
|
||||
no description available
|
||||
|
||||
*pvesm nfsscan* `<server>`
|
||||
|
||||
Scan remote NFS server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
The server address (name or IP).
|
||||
An alias for 'pvesm scan nfs'.
|
||||
|
||||
*pvesm path* `<volume>`
|
||||
|
||||
@ -390,6 +358,66 @@ Delete storage configuration.
|
||||
|
||||
The storage identifier.
|
||||
|
||||
*pvesm scan cifs* `<server>` `[OPTIONS]`
|
||||
|
||||
Scan remote CIFS server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
The server address (name or IP).
|
||||
|
||||
`--domain` `<string>` ::
|
||||
|
||||
SMB domain (Workgroup).
|
||||
|
||||
`--password` `<password>` ::
|
||||
|
||||
User password.
|
||||
|
||||
`--username` `<string>` ::
|
||||
|
||||
User name.
|
||||
|
||||
*pvesm scan glusterfs* `<server>`
|
||||
|
||||
Scan remote GlusterFS server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
The server address (name or IP).
|
||||
|
||||
*pvesm scan iscsi* `<portal>`
|
||||
|
||||
Scan remote iSCSI server.
|
||||
|
||||
`<portal>`: `<string>` ::
|
||||
|
||||
The iSCSI portal (IP or DNS name with optional port).
|
||||
|
||||
*pvesm scan lvm*
|
||||
|
||||
List local LVM volume groups.
|
||||
|
||||
*pvesm scan lvmthin* `<vg>`
|
||||
|
||||
List local LVM Thin Pools.
|
||||
|
||||
`<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
|
||||
|
||||
no description available
|
||||
|
||||
*pvesm scan nfs* `<server>`
|
||||
|
||||
Scan remote NFS server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
The server address (name or IP).
|
||||
|
||||
*pvesm scan zfs*
|
||||
|
||||
Scan zfs pool list on local node.
|
||||
|
||||
*pvesm set* `<storage>` `[OPTIONS]`
|
||||
|
||||
Update storage configuration.
|
||||
@ -450,7 +478,7 @@ Assume the given path is an externally managed mountpoint and consider the stora
|
||||
|
||||
`--krbd` `<boolean>` ::
|
||||
|
||||
Access rbd through krbd kernel module.
|
||||
Always access rbd through krbd kernel module.
|
||||
|
||||
`--lio_tpg` `<string>` ::
|
||||
|
||||
@ -564,6 +592,6 @@ If target is different to 'node', we only lists shared storages which content is
|
||||
|
||||
*pvesm zfsscan*
|
||||
|
||||
Scan zfs pool list on local node.
|
||||
An alias for 'pvesm scan zfs'.
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
*pveum* `<COMMAND> [ARGS] [OPTIONS]`
|
||||
|
||||
*pveum acldel* `<path> --roles <string>` `[OPTIONS]`
|
||||
*pveum acl delete* `<path> --roles <string>` `[OPTIONS]`
|
||||
|
||||
Update Access Control List (add or remove permissions).
|
||||
|
||||
@ -24,7 +24,7 @@ List of roles.
|
||||
|
||||
List of users.
|
||||
|
||||
*pveum aclmod* `<path> --roles <string>` `[OPTIONS]`
|
||||
*pveum acl modify* `<path> --roles <string>` `[OPTIONS]`
|
||||
|
||||
Update Access Control List (add or remove permissions).
|
||||
|
||||
@ -48,7 +48,15 @@ List of roles.
|
||||
|
||||
List of users.
|
||||
|
||||
*pveum groupadd* `<groupid>` `[OPTIONS]`
|
||||
*pveum acldel*
|
||||
|
||||
An alias for 'pveum acl delete'.
|
||||
|
||||
*pveum aclmod*
|
||||
|
||||
An alias for 'pveum acl modify'.
|
||||
|
||||
*pveum group add* `<groupid>` `[OPTIONS]`
|
||||
|
||||
Create new group.
|
||||
|
||||
@ -60,7 +68,7 @@ no description available
|
||||
|
||||
no description available
|
||||
|
||||
*pveum groupdel* `<groupid>`
|
||||
*pveum group delete* `<groupid>`
|
||||
|
||||
Delete group.
|
||||
|
||||
@ -68,7 +76,7 @@ Delete group.
|
||||
|
||||
no description available
|
||||
|
||||
*pveum groupmod* `<groupid>` `[OPTIONS]`
|
||||
*pveum group modify* `<groupid>` `[OPTIONS]`
|
||||
|
||||
Update group data.
|
||||
|
||||
@ -80,6 +88,18 @@ no description available
|
||||
|
||||
no description available
|
||||
|
||||
*pveum groupadd*
|
||||
|
||||
An alias for 'pveum group add'.
|
||||
|
||||
*pveum groupdel*
|
||||
|
||||
An alias for 'pveum group delete'.
|
||||
|
||||
*pveum groupmod*
|
||||
|
||||
An alias for 'pveum group modify'.
|
||||
|
||||
*pveum help* `[OPTIONS]`
|
||||
|
||||
Get help about specified command.
|
||||
@ -100,7 +120,7 @@ Change user password.
|
||||
|
||||
User ID
|
||||
|
||||
*pveum roleadd* `<roleid>` `[OPTIONS]`
|
||||
*pveum role add* `<roleid>` `[OPTIONS]`
|
||||
|
||||
Create new role.
|
||||
|
||||
@ -112,7 +132,7 @@ no description available
|
||||
|
||||
no description available
|
||||
|
||||
*pveum roledel* `<roleid>`
|
||||
*pveum role delete* `<roleid>`
|
||||
|
||||
Delete role.
|
||||
|
||||
@ -120,9 +140,9 @@ Delete role.
|
||||
|
||||
no description available
|
||||
|
||||
*pveum rolemod* `<roleid> --privs <string>` `[OPTIONS]`
|
||||
*pveum role modify* `<roleid>` `[OPTIONS]`
|
||||
|
||||
Create new role.
|
||||
Update an existing role.
|
||||
|
||||
`<roleid>`: `<string>` ::
|
||||
|
||||
@ -138,6 +158,18 @@ NOTE: Requires option(s): `privs`
|
||||
|
||||
no description available
|
||||
|
||||
*pveum roleadd*
|
||||
|
||||
An alias for 'pveum role add'.
|
||||
|
||||
*pveum roledel*
|
||||
|
||||
An alias for 'pveum role delete'.
|
||||
|
||||
*pveum rolemod*
|
||||
|
||||
An alias for 'pveum role modify'.
|
||||
|
||||
*pveum ticket* `<username>` `[OPTIONS]`
|
||||
|
||||
Create or verify authentication ticket.
|
||||
@ -166,7 +198,7 @@ NOTE: Requires option(s): `path`
|
||||
|
||||
You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
|
||||
|
||||
*pveum useradd* `<userid>` `[OPTIONS]`
|
||||
*pveum user add* `<userid>` `[OPTIONS]`
|
||||
|
||||
Create new user.
|
||||
|
||||
@ -184,7 +216,7 @@ no description available
|
||||
|
||||
`--enable` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Enable the account (default). You can set this to '0' to disable the accout
|
||||
Enable the account (default). You can set this to '0' to disable the account
|
||||
|
||||
`--expire` `<integer> (0 - N)` ::
|
||||
|
||||
@ -206,11 +238,11 @@ Keys for two factor auth (yubico).
|
||||
|
||||
no description available
|
||||
|
||||
`--password` `<password>` ::
|
||||
`--password` `<string>` ::
|
||||
|
||||
Initial password.
|
||||
|
||||
*pveum userdel* `<userid>`
|
||||
*pveum user delete* `<userid>`
|
||||
|
||||
Delete user.
|
||||
|
||||
@ -218,7 +250,7 @@ Delete user.
|
||||
|
||||
User ID
|
||||
|
||||
*pveum usermod* `<userid>` `[OPTIONS]`
|
||||
*pveum user modify* `<userid>` `[OPTIONS]`
|
||||
|
||||
Update user configuration.
|
||||
|
||||
@ -240,9 +272,9 @@ no description available
|
||||
|
||||
no description available
|
||||
|
||||
`--enable` `<boolean>` ::
|
||||
`--enable` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Enable/disable the account.
|
||||
Enable the account (default). You can set this to '0' to disable the account
|
||||
|
||||
`--expire` `<integer> (0 - N)` ::
|
||||
|
||||
@ -264,4 +296,16 @@ Keys for two factor auth (yubico).
|
||||
|
||||
no description available
|
||||
|
||||
*pveum useradd*
|
||||
|
||||
An alias for 'pveum user add'.
|
||||
|
||||
*pveum userdel*
|
||||
|
||||
An alias for 'pveum user delete'.
|
||||
|
||||
*pveum usermod*
|
||||
|
||||
An alias for 'pveum user modify'.
|
||||
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ Specify IP addresses and gateways for the corresponding interface.
|
||||
IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
|
||||
SLAAC is not supported by cloud-init but at least netplan activates SLAAC when selecting 'dhcp' so it should work with up-to-date netplan versions.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
|
||||
|
||||
|
||||
@ -4,6 +4,23 @@
|
||||
|
||||
An alias for 'qm guest cmd'.
|
||||
|
||||
*qm cleanup* `<vmid> <clean-shutdown> <guest-requested>`
|
||||
|
||||
Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts
|
||||
down, crashes, etc.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<clean-shutdown>`: `<boolean>` ::
|
||||
|
||||
Indicates if qemu shutdown cleanly.
|
||||
|
||||
`<guest-requested>`: `<boolean>` ::
|
||||
|
||||
Indicates if the shutdown was requested by the guest or via qmp.
|
||||
|
||||
*qm clone* `<vmid> <newid>` `[OPTIONS]`
|
||||
|
||||
Create a copy of virtual machine/template.
|
||||
@ -77,6 +94,10 @@ Enable/disable ACPI.
|
||||
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
|
||||
`--arch` `<aarch64 | x86_64>` ::
|
||||
|
||||
Virtual processor architecture. Defaults to the host.
|
||||
|
||||
`--archive` `<string>` ::
|
||||
|
||||
The backup file.
|
||||
@ -159,7 +180,7 @@ NOTE: Requires option(s): `archive`
|
||||
|
||||
Freeze CPU at startup (use 'c' monitor command to start execution).
|
||||
|
||||
`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
|
||||
Map host PCI devices into guest.
|
||||
|
||||
@ -202,7 +223,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)?)` ::
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
@ -348,9 +369,9 @@ Configure an USB device (n is 0 to 4).
|
||||
|
||||
Number of hotplugged vcpus.
|
||||
|
||||
`--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ::
|
||||
`--vga` `[[type=]<enum>] [,memory=<integer>]` ::
|
||||
|
||||
Select the VGA type.
|
||||
Configure the VGA hardware.
|
||||
|
||||
`--virtio[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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
@ -731,6 +752,10 @@ Enable/disable ACPI.
|
||||
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
|
||||
`--arch` `<aarch64 | x86_64>` ::
|
||||
|
||||
Virtual processor architecture. Defaults to the host.
|
||||
|
||||
`--args` `<string>` ::
|
||||
|
||||
Arbitrary arguments passed to kvm.
|
||||
@ -813,7 +838,7 @@ NOTE: Requires option(s): `delete`
|
||||
|
||||
Freeze CPU at startup (use 'c' monitor command to start execution).
|
||||
|
||||
`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
|
||||
Map host PCI devices into guest.
|
||||
|
||||
@ -856,7 +881,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)?)` ::
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
@ -992,9 +1017,9 @@ Configure an USB device (n is 0 to 4).
|
||||
|
||||
Number of hotplugged vcpus.
|
||||
|
||||
`--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ::
|
||||
`--vga` `[[type=]<enum>] [,memory=<integer>]` ::
|
||||
|
||||
Select the VGA type.
|
||||
Configure the VGA hardware.
|
||||
|
||||
`--virtio[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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
@ -1078,7 +1103,7 @@ Start virtual machine.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
|
||||
@ -14,6 +14,10 @@ Enable/disable Qemu GuestAgent.
|
||||
|
||||
Run fstrim after cloning/moving a disk.
|
||||
|
||||
`arch`: `<aarch64 | x86_64>` ::
|
||||
|
||||
Virtual processor architecture. Defaults to the host.
|
||||
|
||||
`args`: `<string>` ::
|
||||
|
||||
Arbitrary arguments passed to kvm, for example:
|
||||
@ -112,7 +116,7 @@ Disk size. This is purely informational and has no effect.
|
||||
|
||||
Freeze CPU at startup (use 'c' monitor command to start execution).
|
||||
|
||||
`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
|
||||
Map host PCI devices into guest.
|
||||
+
|
||||
@ -130,6 +134,12 @@ of PCI virtual functions of the host. HOSTPCIID syntax is:
|
||||
+
|
||||
You can us the 'lspci' command to list existing PCI devices.
|
||||
|
||||
`mdev`=`<string>` ;;
|
||||
|
||||
The type of mediated device to use.
|
||||
An instance of this type will be created on startup of the VM and
|
||||
will be cleaned up when the VM stops.
|
||||
|
||||
`pcie`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Choose the PCI-express bus (needs the 'q35' machine model).
|
||||
@ -375,7 +385,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)?)` ::
|
||||
`machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
@ -983,9 +993,18 @@ Specifies whether if given host option is a USB3 device or port (this does curre
|
||||
|
||||
Number of hotplugged vcpus.
|
||||
|
||||
`vga`: `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ::
|
||||
`vga`: `[[type=]<enum>] [,memory=<integer>]` ::
|
||||
|
||||
Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.
|
||||
Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.
|
||||
You can also run without any graphic card, using a serial device as terminal.
|
||||
|
||||
`memory`=`<integer> (4 - 512)` ;;
|
||||
|
||||
Sets the VGA memory (in MiB). Has no effect with serial display.
|
||||
|
||||
`type`=`<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
|
||||
|
||||
Select the VGA type.
|
||||
|
||||
`virtio[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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user