* Two-Factor Authentication (OATH, Yubikey)
-* Based on ExtJS 6.x JavaScript framework
+* Based on ExtJS 7.x JavaScript framework
Login
containers, nodes, ...). This is sometimes faster than selecting an
object in the resource tree.
-To the right of the search bar we see the identity (login name). The
-gear symbol is a button opening the 'My Settings' dialog. There you
-can customize some client side user interface setting (reset the saved
-login name, reset saved layout).
-
-The rightmost part of the header contains four buttons:
+The right part of the header contains four buttons:
[horizontal]
-Help :: Opens a new browser window showing the reference documentation.
+Documentation :: Opens a new browser window showing the reference documentation.
Create VM :: Opens the virtual machine creation wizard.
Create CT :: Open the container creation wizard.
-Logout :: Logout, and show the login dialog again.
+User Menu :: Displays the identity of the user you're currently logged in
+with, and clicking it opens a menu with user-specific options.
++
+In the user menu, you'll find the 'My Settings' dialog, which provides local UI
+settings. Below that, there are shortcuts for 'TFA' (Two-Factor Authentication)
+and 'Password' self-service. You'll also find options to change the 'Language'
+and the 'Color Theme.' Finally, at the bottom of the menu is the 'Logout'
+option.
[[gui_my_settings]]
Folder View:: Shows all kinds of objects, grouped by object type.
-Storage View:: Only shows storage objects, grouped by nodes.
-
Pool View:: Show VMs and containers, grouped by pool.
* *Metric Server:* define external metric servers for {pve}.
+* *Notifications:* configurate notification behavior and targets for {pve}.
+
* *Support:* display information about your support subscription.
The top header has useful buttons such as 'Reboot', 'Shutdown', 'Shell',
'Bulk Actions' and 'Help'.
'Shell' has the options 'noVNC', 'SPICE' and 'xterm.js'.
-'Bulk Actions' has the options 'Bulk Start', 'Bulk Stop' and 'Bulk Migrate'.
+'Bulk Actions' has the options 'Bulk Start', 'Bulk Shutdown' and 'Bulk Migrate'.
* *Search:* search a node for VMs, containers, storage devices, and pools.
* *Summary:* display a brief overview of the node's resource usage.
-* *Notes:* write custom notes in Markdown syntax about a node.
+* *Notes:* write custom comments in xref:markdown_basics[Markdown syntax].
* *Shell:* access to a shell interface for the node.
The available interfaces are as follows.
* *Summary:* provides a brief overview of the VM's activity and a `Notes` field
- for Markdown formatted comments.
+ for xref:markdown_basics[Markdown syntax] comments.
* *Console:* access to an interactive console for the VM/container.
* *Permissions:* manage the permissions for the pool.
+Tags
+----
+
+[thumbnail="screenshot/gui-qemu-summary-tags-edit.png", float="left"]
+
+For organizational purposes, it is possible to set `tags` for guests.
+Currently, these only provide informational value to users.
+Tags are displayed in two places in the web interface: in the `Resource Tree` and
+in the status line when a guest is selected.
+
+Tags can be added, edited, and removed in the status line of the guest by
+clicking on the `pencil` icon. You can add multiple tags by pressing the `+`
+button and remove them by pressing the `-` button. To save or cancel the changes,
+you can use the `✓` and `x` button respectively.
+
+Tags can also be set via the CLI, where multiple tags are separated by semicolons.
+For example:
+
+----
+# qm set ID --tags myfirsttag;mysecondtag
+----
+
+Style Configuration
+~~~~~~~~~~~~~~~~~~~
+
+[thumbnail="screenshot/gui-datacenter-tag-style.png"]
+
+By default, the tag colors are derived from their text in a deterministic way.
+The color, shape in the resource tree, and case-sensitivity, as well as how tags
+are sorted, can be customized. This can be done via the web interface under
+__Datacenter -> Options -> Tag Style Override__. Alternatively, this can be done
+via the CLI. For example:
+
+----
+# pvesh set /cluster/options --tag-style color-map=example:000000:FFFFFF
+----
+
+sets the background color of the tag `example` to black (#000000) and the text
+color to white (#FFFFFF).
+
+Permissions
+~~~~~~~~~~~
+
+[thumbnail="screenshot/gui-datacenter-options.png"]
+
+By default, users with the privilege `VM.Config.Options` on a guest (`/vms/ID`)
+can set any tags they want (see
+xref:pveum_permission_management[Permission Management]). If you want to
+restrict this behavior, appropriate permissions can be set under
+__Datacenter -> Options -> User Tag Access__:
+
+* `free`: users are not restricted in setting tags (Default)
+* `list`: users can set tags based on a predefined list of tags
+* `existing`: like list but users can also use already existing tags
+* `none`: users are restricted from using tags
+
+The same can also be done via the CLI.
+
+Note that a user with the `Sys.Modify` privileges on `/` is always able to set
+or delete any tags, regardless of the settings here. Additionally, there is a
+configurable list of `registered tags` which can only be added and removed by
+users with the privilege `Sys.Modify` on `/`. The list of registered tags can be
+edited under __Datacenter -> Options -> Registered Tags__ or via the CLI.
+
+
+For more details on the exact options and how to invoke them in the CLI, see
+xref:datacenter_configuration_file[Datacenter Configuration].
+
ifdef::wiki[]
See Also
projects / pve-docs.git / blobdiff