2 Graphical User Interface
3 ========================
8 {pve} is simple. There is no need to install a separate management
9 tool, and everything can be done through your web browser (Latest
10 Firefox or Google Chrome is preferred). A built-in HTML5 console is
11 used to access the guest console. As an alternative,
12 https://www.spice-space.org/[SPICE] can be used.
14 Because we use the Proxmox cluster file system (pmxcfs), you can
15 connect to any node to manage the entire cluster. Each node can manage
16 the entire cluster. There is no need for a dedicated manager node.
18 You can use the web-based administration interface with any modern
19 browser. When {pve} detects that you are connecting from a mobile
20 device, you are redirected to a simpler, touch-based user interface.
22 The web interface can be reached via https://youripaddress:8006
23 (default login is: 'root', and the password is specified during the
24 installation process).
30 * Seamless integration and management of {pve} clusters
32 * AJAX technologies for dynamic updates of resources
34 * Secure access to all Virtual Machines and Containers via SSL
37 * Fast search-driven interface, capable of handling hundreds and
38 probably thousands of VMs
40 * Secure HTML5 console or SPICE
42 * Role based permission management for all objects (VMs, storages,
45 * Support for multiple authentication sources (e.g. local, MS ADS,
48 * Two-Factor Authentication (OATH, Yubikey)
50 * Based on ExtJS 7.x JavaScript framework
56 [thumbnail="screenshot/gui-login-window.png"]
58 When you connect to the server, you will first see the login window.
59 {pve} supports various authentication backends ('Realm'), and
60 you can select the language here. The GUI is translated to more
63 NOTE: You can save the user name on the client side by selecting the
64 checkbox at the bottom. This saves some typing when you login next
71 [thumbnail="screenshot/gui-datacenter-summary.png"]
73 The {pve} user interface consists of four regions.
77 Header:: On top. Shows status information and contains buttons for
78 most important actions.
80 Resource Tree:: At the left side. A navigation tree where you can select
83 Content Panel:: Center region. Selected objects display configuration
84 options and status here.
86 Log Panel:: At the bottom. Displays log entries for recent tasks. You
87 can double-click on those log entries to get more details, or to abort
90 NOTE: You can shrink and expand the size of the resource tree and log
91 panel, or completely hide the log panel. This can be helpful when you
92 work on small displays and want more space to view other content.
98 On the top left side, the first thing you see is the Proxmox
99 logo. Next to it is the current running version of {pve}. In the
100 search bar nearside you can search for specific objects (VMs,
101 containers, nodes, ...). This is sometimes faster than selecting an
102 object in the resource tree.
104 To the right of the search bar we see the identity (login name). The
105 gear symbol is a button opening the 'My Settings' dialog. There you
106 can customize some client side user interface setting (reset the saved
107 login name, reset saved layout).
109 The rightmost part of the header contains four buttons:
112 Help :: Opens a new browser window showing the reference documentation.
114 Create VM :: Opens the virtual machine creation wizard.
116 Create CT :: Open the container creation wizard.
118 Logout :: Logout, and show the login dialog again.
125 [thumbnail="screenshot/gui-my-settings.png"]
127 The 'My Settings' window allows you to set locally stored settings. These
128 include the 'Dashboard Storages' which allow you to enable or disable specific
129 storages to be counted towards the total amount visible in the datacenter
130 summary. If no storage is checked the total is the sum of all storages, same
131 as enabling every single one.
133 Below the dashboard settings you find the stored user name and a button to
134 clear it as well as a button to reset every layout in the GUI to its default.
136 On the right side there are 'xterm.js Settings'. These contain the following
140 Font-Family :: The font to be used in xterm.js (e.g. Arial).
142 Font-Size :: The preferred font size to be used.
144 Letter Spacing :: Increases or decreases spacing between letters in text.
146 Line Height :: Specify the absolute height of a line.
153 This is the main navigation tree. On top of the tree you can select
154 some predefined views, which change the structure of the tree
155 below. The default view is the *Server View*, and it shows the following
159 Datacenter:: Contains cluster-wide settings (relevant for all nodes).
161 Node:: Represents the hosts inside a cluster, where the guests run.
163 Guest:: VMs, containers and templates.
165 Storage:: Data Storage.
167 Pool:: It is possible to group guests using a pool to simplify
171 The following view types are available:
174 Server View:: Shows all kinds of objects, grouped by nodes.
176 Folder View:: Shows all kinds of objects, grouped by object type.
178 Pool View:: Show VMs and containers, grouped by pool.
184 The main purpose of the log panel is to show you what is currently
185 going on in your cluster. Actions like creating an new VM are executed
186 in the background, and we call such a background job a 'task'.
188 Any output from such a task is saved into a separate log file. You can
189 view that log by simply double-click a task log entry. It is also
190 possible to abort a running task there.
192 Please note that we display the most recent tasks from all cluster nodes
193 here. So you can see when somebody else is working on another cluster
196 NOTE: We remove older and finished task from the log panel to keep
197 that list short. But you can still find those tasks within the node panel in the
200 Some short-running actions simply send logs to all cluster
201 members. You can see those messages in the 'Cluster log' panel.
207 When you select an item from the resource tree, the corresponding
208 object displays configuration and status information in the content
209 panel. The following sections provide a brief overview of this
210 functionality. Please refer to the corresponding chapters in the
211 reference documentation to get more detailed information.
217 [thumbnail="screenshot/gui-datacenter-search.png"]
219 On the datacenter level, you can access cluster-wide settings and information.
221 * *Search:* perform a cluster-wide search for nodes, VMs, containers, storage
224 * *Summary:* gives a brief overview of the cluster's health and resource usage.
226 * *Cluster:* provides the functionality and information necessary to create or
229 * *Options:* view and manage cluster-wide default settings.
231 * *Storage:* provides an interface for managing cluster storage.
233 * *Backup:* schedule backup jobs. This operates cluster wide, so it doesn't
234 matter where the VMs/containers are on your cluster when scheduling.
236 * *Replication:* view and manage replication jobs.
238 * *Permissions:* manage user, group, and API token permissions, and LDAP,
239 MS-AD and Two-Factor authentication.
241 * *HA:* manage {pve} High Availability.
243 * *ACME:* set up ACME (Let's Encrypt) certificates for server nodes.
245 * *Firewall:* configure and make templates for the Proxmox Firewall cluster wide.
247 * *Metric Server:* define external metric servers for {pve}.
249 * *Support:* display information about your support subscription.
255 [thumbnail="screenshot/gui-node-summary.png"]
257 Nodes in your cluster can be managed individually at this level.
259 The top header has useful buttons such as 'Reboot', 'Shutdown', 'Shell',
260 'Bulk Actions' and 'Help'.
261 'Shell' has the options 'noVNC', 'SPICE' and 'xterm.js'.
262 'Bulk Actions' has the options 'Bulk Start', 'Bulk Shutdown' and 'Bulk Migrate'.
264 * *Search:* search a node for VMs, containers, storage devices, and pools.
266 * *Summary:* display a brief overview of the node's resource usage.
268 * *Notes:* write custom comments in xref:markdown_basics[Markdown syntax].
270 * *Shell:* access to a shell interface for the node.
272 * *System:* configure network, DNS and time settings, and access the syslog.
274 * *Updates:* upgrade the system and see the available new packages.
276 * *Firewall:* manage the Proxmox Firewall for a specific node.
278 * *Disks:* get an overview of the attached disks, and manage how they are used.
280 * *Ceph:* is only used if you have installed a Ceph server on your
281 host. In this case, you can manage your Ceph cluster and see the status
284 * *Replication:* view and manage replication jobs.
286 * *Task History:* see a list of past tasks.
288 * *Subscription:* upload a subscription key, and generate a system report for
289 use in support cases.
295 [thumbnail="screenshot/gui-qemu-summary.png"]
297 There are two different kinds of guests and both can be converted to a template.
298 One of them is a Kernel-based Virtual Machine (KVM) and the other is a Linux Container (LXC).
299 Navigation for these are mostly the same; only some options are different.
301 To access the various guest management interfaces, select a VM or container from
302 the menu on the left.
304 The header contains commands for items such as power management, migration,
305 console access and type, cloning, HA, and help.
306 Some of these buttons contain drop-down menus, for example, 'Shutdown' also contains
307 other power options, and 'Console' contains the different console types:
308 'SPICE', 'noVNC' and 'xterm.js'.
310 The panel on the right contains an interface for whatever item is selected from
311 the menu on the left.
313 The available interfaces are as follows.
315 * *Summary:* provides a brief overview of the VM's activity and a `Notes` field
316 for xref:markdown_basics[Markdown syntax] comments.
318 * *Console:* access to an interactive console for the VM/container.
320 * *(KVM)Hardware:* define the hardware available to the KVM VM.
322 * *(LXC)Resources:* define the system resources available to the LXC.
324 * *(LXC)Network:* configure a container's network settings.
326 * *(LXC)DNS:* configure a container's DNS settings.
328 * *Options:* manage guest options.
330 * *Task History:* view all previous tasks related to the selected guest.
332 * *(KVM) Monitor:* an interactive communication interface to the KVM process.
334 * *Backup:* create and restore system backups.
336 * *Replication:* view and manage the replication jobs for the selected guest.
338 * *Snapshots:* create and restore VM snapshots.
340 * *Firewall:* configure the firewall on the VM level.
342 * *Permissions:* manage permissions for the selected guest.
348 [thumbnail="screenshot/gui-storage-summary-local.png"]
350 As with the guest interface, the interface for storage consists of a menu on the
351 left for certain storage elements and an interface on the right to manage
354 In this view we have a two partition split-view.
355 On the left side we have the storage options
356 and on the right side the content of the selected option will be shown.
358 * *Summary:* shows important information about the storage, such as the type,
359 usage, and content which it stores.
361 * *Content:* a menu item for each content type which the storage
362 stores, for example, Backups, ISO Images, CT Templates.
364 * *Permissions:* manage permissions for the storage.
370 [thumbnail="screenshot/gui-pool-summary-development.png"]
372 Again, the pools view comprises two partitions: a menu on the left,
373 and the corresponding interfaces for each menu item on the right.
375 * *Summary:* shows a description of the pool.
377 * *Members:* display and manage pool members (guests and storage).
379 * *Permissions:* manage the permissions for the pool.
385 [thumbnail="screenshot/gui-qemu-summary-tags-edit.png", float="left"]
387 For organizational purposes, it is possible to set `tags` for guests.
388 Currently, these only provide informational value to users.
389 Tags are displayed in two places in the web interface: in the `Resource Tree` and
390 in the status line when a guest is selected.
392 Tags can be added, edited, and removed in the status line of the guest by
393 clicking on the `pencil` icon. You can add multiple tags by pressing the `+`
394 button and remove them by pressing the `-` button. To save or cancel the changes,
395 you can use the `✓` and `x` button respectively.
397 Tags can also be set via the CLI, where multiple tags are separated by semicolons.
401 # qm set ID --tags myfirsttag;mysecondtag
407 [thumbnail="screenshot/gui-datacenter-tag-style.png"]
409 By default, the tag colors are derived from their text in a deterministic way.
410 The color, shape in the resource tree, and case-sensitivity, as well as how tags
411 are sorted, can be customized. This can be done via the web interface under
412 __Datacenter -> Options -> Tag Style Override__. Alternatively, this can be done
413 via the CLI. For example:
416 # pvesh set /cluster/options --tag-style color-map=example:000000:FFFFFF
419 sets the background color of the tag `example` to black (#000000) and the text
420 color to white (#FFFFFF).
425 [thumbnail="screenshot/gui-datacenter-options.png"]
427 By default, users with the privilege `VM.Config.Options` on a guest (`/vms/ID`)
428 can set any tags they want (see
429 xref:pveum_permission_management[Permission Management]). If you want to
430 restrict this behavior, appropriate permissions can be set under
431 __Datacenter -> Options -> User Tag Access__:
433 * `free`: users are not restricted in setting tags (Default)
434 * `list`: users can set tags based on a predefined list of tags
435 * `existing`: like list but users can also use already existing tags
436 * `none`: users are restricted from using tags
438 The same can also be done via the CLI.
440 Note that a user with the `Sys.Modify` privileges on `/` is always able to set
441 or delete any tags, regardless of the settings here. Additionally, there is a
442 configurable list of `registered tags` which can only be added and removed by
443 users with the privilege `Sys.Modify` on `/`. The list of registered tags can be
444 edited under __Datacenter -> Options -> Registered Tags__ or via the CLI.
447 For more details on the exact options and how to invoke them in the CLI, see
448 xref:datacenter_configuration_file[Datacenter Configuration].
455 * link:/wiki/Central_Web-based_Management