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 6.x JavaScript framework
56 [thumbnail="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 selection the
64 checkbox at the bottom. This saves some typing when you login next
71 [thumbnail="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 displays 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 [thumbnail="gui-my-settings.png"]
106 To the right of the search bar we see the identity (login name). The
107 gear symbol is a button opening the 'My Settings' dialog. There you
108 can customize some client side user interface setting (reset the saved
109 login name, reset saved layout).
111 The rightmost part of the header contains four buttons:
114 Help :: Opens a new browser window showing the reference documentation.
116 Create VM :: Opens the virtual machine creation wizard.
118 Create CT :: Open the container creation wizard.
120 Logout :: Logout, and show the login dialog again.
126 This is the main navigation tree. On top of the tree you can select
127 some predefined views, which changes the structure of the tree
128 below. The default view is *Server View*, and it shows the following
132 Datacenter:: Contains cluster wide setting (relevant for all nodes).
134 Node:: Represents the hosts inside a cluster, where the guests runs.
136 Guest:: VMs, Containers and Templates.
138 Storage:: Data Storage.
140 Pool:: It is possible to group guests using a pool to simplify
144 The following view types are available:
147 Server View:: Shows all kind of objects, grouped by nodes.
149 Folder View:: Shows all kind of objects, grouped by object type.
151 Storage View:: Only show storage objects, grouped by nodes.
153 Pool View:: Show VMs and Containers, grouped by pool.
159 The main purpose of the log panel is to show you what is currently
160 going on in your cluster. Actions like creating an new VM are executed
161 in background, and we call such background job a 'task'.
163 Any output from such task is saved into a separate log file. You can
164 view that log by simply double-click a task log entry. It is also
165 possible to abort a running task there.
167 Please note that we display most recent tasks from all cluster nodes
168 here. So you can see when somebody else is working on another cluster
171 NOTE: We remove older and finished task from the log panel to keep
172 that list short. But you can still find those tasks in the 'Task
173 History' within the node panel.
175 Some short running actions simply sends logs to all cluster
176 members. You can see those messages in the 'Cluster log' panel.
182 When you select something in the resource tree, the corresponding
183 object displays configuration and status information in the content
184 panel. The following sections give a brief overview of the
185 functionality. Please refer to the individual chapters inside the
186 reference documentation to get more detailed information.
192 [thumbnail="gui-datacenter-search.png"]
194 On the datacenter level you can access cluster wide settings and information.
196 * *Search:* it is possible to search anything in cluster
197 ,this can be a node, VM, Container, Storage or a pool.
199 * *Summary:* gives a brief overview over the cluster health.
201 * *Options:* can show and set defaults, which apply cluster wide.
203 * *Storage:* is the place where a storage will add/managed/removed.
205 * *Backup:* has the capability to schedule Backups. This is
206 cluster wide, so you do not care about where the VM/Container are on
207 your cluster at schedule time.
209 * *Permissions:* will manage user and group permission, LDAP,
210 MS-AD and Two-Factor authentication can be setup here.
212 * *HA:* will manage the {pve} High-Availability
214 * *Firewall:* on this level the Proxmox Firewall works cluster wide and
215 makes templates which are cluster wide available.
217 * *Support:* here you get all information about your support subscription.
219 If you like to have more information about this see the corresponding chapter.
225 [thumbnail="gui-node-summary.png"]
227 All belongs of a node can be managed at this level.
229 * *Search:* it is possible to search anything on the node,
230 this can be a VM, Container, Storage or a pool.
232 * *Summary:* gives a brief overview over the resource usage.
234 * *Shell:* log you in the shell of the node.
236 * *System:* is for configuring the network, dns and time, and also shows your syslog.
238 * *Updates:* will upgrade the system and informs you about new packets.
240 * *Firewall:* on this level is only for this node.
242 * *Disk:* gives you an brief overview about you physical hard drives and
245 * *Ceph:* is only used if you have installed a Ceph sever on you
246 host. Then you can manage your Ceph cluster and see the status
249 * *Task History:* here all past task are shown.
251 * *Subscription:* here you can upload you subscription key and get a
252 system overview in case of a support case.
258 [thumbnail="gui-qemu-summary.png"]
260 There are two differed kinds of VM types and both types can be converted to a template.
261 One of them are Kernel-based Virtual Machine (KVM) and the other one are Linux Containers (LXC).
262 General the navigation are the same only some option are different.
264 In the main management center the VM navigation begin if a VM is selected in the left tree.
266 The top header contains important VM operation commands like 'Start', 'Shutdown', 'Reset',
267 'Remove', 'Migrate', 'Console' and 'Help'.
268 Some of them have hidden buttons like 'Shutdown' has 'Stop' and
269 'Console' contains the different console types 'SPICE', 'noVNC' and 'xterm.js'.
271 On the right side the content switch white the focus of the option.
274 All available options are listed one below the other.
276 * *Summary:* gives a brief overview over the VM activity.
278 * *Console:* an interactive console to your VM.
280 * *(KVM)Hardware:* shows and set the Hardware of the KVM VM.
282 * *(LXC)Resources:* defines the LXC Hardware opportunities.
284 * *(LXC)Network:* the LXC Network settings.
286 * *(LXC)DNS:* the LXC DNS settings.
288 * *Options:* all VM options can be set here, this distinguishes between KVM and LXC.
290 * *Task History:* here all previous task from this VM will be shown.
292 * *(KVM) Monitor:* is the interactive communication interface to the KVM process.
294 * *Backup:* shows the available backups from this VM and also create a backupset.
296 * *Replication:* shows the replication jobs for this VM and allows to create new jobs.
298 * *Snapshots:* manage VM snapshots.
300 * *Firewall:* manage the firewall on VM level.
302 * *Permissions:* manage the user permission for this VM.
308 [thumbnail="gui-storage-summary-local.png"]
310 In this view we have a two partition split view.
311 On the left side we have the storage options
312 and on the right side the content of the selected option will shown.
314 * *Summary:* show you important information about your storage like
315 'Usage', 'Type', 'Content', 'Active' and 'Enabled'.
317 * *Content:* Here all contend will listed grouped by content.
319 * *Permissions:* manage the user permission for this storage.
325 [thumbnail="gui-pool-summary-development.png"]
327 In this view we have a two partition split view.
328 On the left side we have the logical pool options
329 and on the right side the content of the selected option will shown.
331 * *Summary:* show the description of the pool.
333 * *Members:* Here all members of this pool will listed and can be managed.
335 * *Permissions:* manage the user permission for this pool.
343 * link:/wiki/Central_Web-based_Management
350 VM, CT, Storage, Pool section