Difference between revisions of "Graphical User Interface"

From Proxmox VE
Jump to navigation Jump to search
(5 intermediate revisions by 2 users not shown)
Line 33: Line 33:
 
Based on ExtJS 6.x JavaScript framework
 
Based on ExtJS 6.x JavaScript framework
 
Login
 
Login
When you connect to the server, you will first see the longin window.
+
When you connect to the server, you will first see the login window.
 
Proxmox VE supports various authentication backends (Realm), and
 
Proxmox VE supports various authentication backends (Realm), and
you can select the langauage here. The GUI is translated to more
+
you can select the language here. The GUI is translated to more
 
than 20 languages.
 
than 20 languages.
You can save the user name on the client side by selection the
+
You can save the user name on the client side by selecting the
 
checkbox at the bottom. This saves some typing when you login next
 
checkbox at the bottom. This saves some typing when you login next
 
time.
 
time.
Line 49: Line 49:
 
specific objects.
 
specific objects.
 
Content Panel
 
Content Panel
Center region. Selected objects displays configuration
+
Center region. Selected objects display configuration
 
options and status here.
 
options and status here.
 
Log Panel
 
Log Panel
Line 70: Line 70:
 
The rightmost part of the header contains four buttons:
 
The rightmost part of the header contains four buttons:
 
Help
 
Help
Opens a new browser window showing the reference documenation.
+
Opens a new browser window showing the reference documentation.
 
Create VM
 
Create VM
 
Opens the virtual machine creation wizard.
 
Opens the virtual machine creation wizard.
Line 77: Line 77:
 
Logout
 
Logout
 
Logout, and show the login dialog again.
 
Logout, and show the login dialog again.
 +
My Settings
 +
The My Settings window allows you to set locally stored settings. These
 +
include the Dashboard Storages which allow you to enable or disable specific
 +
storages to be counted towards the total amount visible in the datacenter
 +
summary. If no storage is checked the total is the sum of all storages, same
 +
as enabling every single one.
 +
Below the dashboard settings you find the stored user name and a button to
 +
clear it as well as a button to reset every layout in the GUI to its default.
 +
On the right side there are xterm.js Settings. These contain the following
 +
options:
 +
Font-Family
 +
The font to be used in xterm.js (e.g. Arial).
 +
Font-Size
 +
The preferred font size to be used.
 +
Letter Spacing
 +
Increases or decreases spacing between letters in text.
 +
Line Height
 +
Specify the absolute height of a line.
 
Resource Tree
 
Resource Tree
 
This is the main navigation tree. On top of the tree you can select
 
This is the main navigation tree. On top of the tree you can select
some predefined views, which changes the structure of the tree
+
some predefined views, which change the structure of the tree
below. The default view is Server View, and it shows the following
+
below. The default view is the Server View, and it shows the following
 
object types:
 
object types:
 
Datacenter
 
Datacenter
Contains cluster wide setting (relevant for all nodes).
+
Contains cluster-wide settings (relevant for all nodes).
 
Node
 
Node
Represents the hosts inside a cluster, where the guests runs.
+
Represents the hosts inside a cluster, where the guests run.
 
Guest
 
Guest
VMs, Containers and Templates.
+
VMs, containers and templates.
 
Storage
 
Storage
 
Data Storage.
 
Data Storage.
Line 95: Line 113:
 
The following view types are available:
 
The following view types are available:
 
Server View
 
Server View
Shows all kind of objects, grouped by nodes.
+
Shows all kinds of objects, grouped by nodes.
 
Folder View
 
Folder View
Shows all kind of objects, grouped by object type.
+
Shows all kinds of objects, grouped by object type.
 
Storage View
 
Storage View
Only show storage objects, grouped by nodes.
+
Only shows storage objects, grouped by nodes.
 
Pool View
 
Pool View
Show VMs and Containers, grouped by pool.
+
Show VMs and containers, grouped by pool.
 
Log Panel
 
Log Panel
 
The main purpose of the log panel is to show you what is currently
 
The main purpose of the log panel is to show you what is currently
 
going on in your cluster. Actions like creating an new VM are executed
 
going on in your cluster. Actions like creating an new VM are executed
in background, and we call such background job a task.
+
in the background, and we call such a background job a task.
Any output from such task is saved into a separate log file. You can
+
Any output from such a task is saved into a separate log file. You can
 
view that log by simply double-click a task log entry. It is also
 
view that log by simply double-click a task log entry. It is also
 
possible to abort a running task there.
 
possible to abort a running task there.
Please note that we display most recent tasks from all cluster nodes
+
Please note that we display the most recent tasks from all cluster nodes
 
here. So you can see when somebody else is working on another cluster
 
here. So you can see when somebody else is working on another cluster
 
node in real-time.
 
node in real-time.
 
We remove older and finished task from the log panel to keep
 
We remove older and finished task from the log panel to keep
that list short. But you can still find those tasks in the Task
+
that list short. But you can still find those tasks within the node panel in the
History within the node panel.
+
Task History.
Some short running actions simply sends logs to all cluster
+
Some short-running actions simply send logs to all cluster
 
members. You can see those messages in the Cluster log panel.
 
members. You can see those messages in the Cluster log panel.
 
Content Panels
 
Content Panels
When you select something in the resource tree, the correnponding
+
When you select an item from the resource tree, the corresponding
 
object displays configuration and status information in the content
 
object displays configuration and status information in the content
panel. The following sections gives a brief overview of the
+
panel. The following sections provide a brief overview of this
functionality. Please refer to the individual chapters inside the
+
functionality. Please refer to the corresponding chapters in the
reference documentatin to get more detailed information.
+
reference documentation to get more detailed information.
 
Datacenter
 
Datacenter
On the datacenter level you can access cluster wide settings and information.
+
On the datacenter level, you can access cluster-wide settings and information.
Search: it is possible to search anything in cluster
+
Search: perform a cluster-wide search for nodes, VMs, containers, storage
,this can be a node, VM, Container, Storage or a pool.
+
  devices, and pools.
Summary: gives a brief overview over the cluster health.
+
Summary: gives a brief overview of the cluster’s health and resource usage.
Options: can show and set defaults, which apply cluster wide.
+
Cluster: provides the functionality and information necessary to create or
Storage: is the place where a storage will add/managed/removed.
+
  join a cluster.
Backup: has the capability to schedule Backups. This is
+
Options: view and manage cluster-wide default settings.
  cluster wide, so you do not care about where the VM/Container are on
+
Storage: provides an interface for managing cluster storage.
  your cluster at schedule time.
+
Backup: schedule backup jobs. This operates cluster wide, so it doesn’t
Permissions: will manage user and group permission, LDAP,
+
  matter where the VMs/containers are on your cluster when scheduling.
   MS-AD and Two-Factor authentication can be setup here.
+
Replication: view and manage replication jobs.
HA: will manage the Proxmox VE High-Availability
+
Permissions: manage user, group, and API token permissions, and LDAP,
Firewall: on this level the Proxmox Firewall works cluster wide and
+
   MS-AD and Two-Factor authentication.
  makes templates which are cluster wide available.
+
HA: manage Proxmox VE High Availability.
Support: here you get all information about your support subscription.
+
ACME: set up ACME (Let’s Encrypt) certificates for server nodes.
If you like to have more information about this see the corresponding chapter.
+
Firewall: configure and make templates for the Proxmox Firewall cluster wide.
 +
Metric Server: define external metric servers for Proxmox VE.
 +
Support: display information about your support subscription.
 
Nodes
 
Nodes
All belongs of a node can be managed at this level.
+
Nodes in your cluster can be managed individually at this level.
Search: it is possible to search anything on the node,
+
The top header has useful buttons such as Reboot, Shutdown, Shell,
this can be a VM, Container, Storage or a pool.
+
Bulk Actions and Help.
Summary: gives a brief overview over the resource usage.
+
Shell has the options noVNC, SPICE and xterm.js.
Shell: log you in the shell of the node.
+
Bulk Actions has the options Bulk Start, Bulk Stop and Bulk Migrate.
System: is for configuring the network, dns and time, and also shows your syslog.
+
Search: search a node for VMs, containers, storage devices, and pools.
Updates: will upgrade the system and informs you about new packets.
+
Summary: display a brief overview of the node’s resource usage.
Firewall: on this level is only for this node.
+
Notes: write custom comments in Markdown syntax.
Disk: gives you an brief overview about you physical hard drives and
+
Shell: access to a shell interface for the node.
  how they are used.
+
System: configure network, DNS and time settings, and access the syslog.
Ceph: is only used if you have installed a Ceph sever on you
+
Updates: upgrade the system and see the available new packages.
   host. Then you can manage your Ceph cluster and see the status
+
Firewall: manage the Proxmox Firewall for a specific node.
 +
Disks: get an overview of the attached disks, and manage how they are used.
 +
Ceph: is only used if you have installed a Ceph server on your
 +
   host. In this case, you can manage your Ceph cluster and see the status
 
   of it here.
 
   of it here.
Task History: here all past task are shown.
+
Replication: view and manage replication jobs.
Subscription: here you can upload you subscription key and get a
+
Task History: see a list of past tasks.
   system overview in case of a support case.
+
Subscription: upload a subscription key, and generate a system report for
 +
   use in support cases.
 
Guests
 
Guests
There are two differed kinds of VM types and both types can be converted to a template.
+
There are two different kinds of guests and both can be converted to a template.
One of them are Kernel-based Virtual Machine (KVM) and the other one are Linux Containers (LXC).
+
One of them is a Kernel-based Virtual Machine (KVM) and the other is a Linux Container (LXC).
General the navigation are the same only some option are different.
+
Navigation for these are mostly the same; only some options are different.
In the main management center the VM navigation begin if a VM is selected in the left tree.
+
To access the various guest management interfaces, select a VM or container from
The top header contains important VM operation commands like Start, Shutdown, Rest,
+
the menu on the left.
Remove, Migrate, Console and Help.
+
The header contains commands for items such as power management, migration,
Two of them have hidden buttons like Shutdown has Stop and
+
console access and type, cloning, HA, and help.
Console contains the different consolen typs SPICE or noVNC.
+
Some of these buttons contain drop-down menus, for example, Shutdown also contains
On the right side the content switch white the focus of the option.
+
other power options, and Console contains the different console types:
On the left side.
+
SPICE, noVNC and xterm.js.
All available options are listed one below the other.
+
The panel on the right contains an interface for whatever item is selected from
Summary: gives a brief overview over the VM activity.
+
the menu on the left.
Console: an interactive console to your VM.
+
The available interfaces are as follows.
(KVM)Hardware: shows and set the Hardware of the KVM VM.
+
Summary: provides a brief overview of the VM’s activity and a Notes field
(LXC)Resources: defines the LXC Hardware opportunities.
+
  for Markdown syntax comments.
(LXC)Network: the LXC Network settings.
+
Console: access to an interactive console for the VM/container.
(LXC)DNS: the LXC DNS settings.
+
(KVM)Hardware: define the hardware available to the KVM VM.
Options: all VM options can be set here, this distinguishes between KVM and LXC.
+
(LXC)Resources: define the system resources available to the LXC.
Task History: here all previous task from this VM will be shown.
+
(LXC)Network: configure a container’s network settings.
(KVM) Monitor: is the interactive communication interface to the KVM process.
+
(LXC)DNS: configure a container’s DNS settings.
Backup: shows the available backups from this VM and also create a backupset.
+
Options: manage guest options.
Snapshots: manage VM snapshots.
+
Task History: view all previous tasks related to the selected guest.
Firewall: manage the firewall on VM level.
+
(KVM) Monitor: an interactive communication interface to the KVM process.
Permissions: manage the user permission for this VM.
+
Backup: create and restore system backups.
 +
Replication: view and manage the replication jobs for the selected guest.
 +
Snapshots: create and restore VM snapshots.
 +
Firewall: configure the firewall on the VM level.
 +
Permissions: manage permissions for the selected guest.
 
Storage
 
Storage
In this view we have a two partition split view.
+
As with the guest interface, the interface for storage consists of a menu on the
 +
left for certain storage elements and an interface on the right to manage
 +
these elements.
 +
In this view we have a two partition split-view.
 
On the left side we have the storage options
 
On the left side we have the storage options
and on the right side the content of the selected option will shown.
+
and on the right side the content of the selected option will be shown.
Summary: show you important information about your storage like
+
Summary: shows important information about the storage, such as the type,
Usage, Type, Content, Active and Enabled.
+
  usage, and content which it stores.
Content: Here all contend will listed grouped by content.
+
Content: a menu item for each content type which the storage
Permissions: manage the user permission for this storage.
+
  stores, for example, Backups, ISO Images, CT Templates.
 +
Permissions: manage permissions for the storage.
 
Pools
 
Pools
In this view we have a two partition split view.
+
Again, the pools view comprises two partitions: a menu on the left,
On the left side we have the logical pool options
+
and the corresponding interfaces for each menu item on the right.
and on the right side the content of the selected option will shown.
+
Summary: shows a description of the pool.
Summary: show the description of the pool.
+
Members: display and manage pool members (guests and storage).
Members: Here all members of this pool will listed and can be managed.
+
Permissions: manage the permissions for the pool.
Permissions: manage the user permission for this pool.
 
 
See Also
 
See Also
 
link:/wiki/Central_Web-based_Management
 
link:/wiki/Central_Web-based_Management
 
</pvehide>
 
</pvehide>
 
<!--PVE_IMPORT_END_MARKER-->
 
<!--PVE_IMPORT_END_MARKER-->

Revision as of 11:56, 6 July 2021

Proxmox VE is simple. There is no need to install a separate management tool, and everything can be done through your web browser (Latest Firefox or Google Chrome is preferred). A built-in HTML5 console is used to access the guest console. As an alternative, SPICE can be used.

Because we use the Proxmox cluster file system (pmxcfs), you can connect to any node to manage the entire cluster. Each node can manage the entire cluster. There is no need for a dedicated manager node.

You can use the web-based administration interface with any modern browser. When Proxmox VE detects that you are connecting from a mobile device, you are redirected to a simpler, touch-based user interface.

The web interface can be reached via https://youripaddress:8006 (default login is: root, and the password is specified during the installation process).

Features

  • Seamless integration and management of Proxmox VE clusters

  • AJAX technologies for dynamic updates of resources

  • Secure access to all Virtual Machines and Containers via SSL encryption (https)

  • Fast search-driven interface, capable of handling hundreds and probably thousands of VMs

  • Secure HTML5 console or SPICE

  • Role based permission management for all objects (VMs, storages, nodes, etc.)

  • Support for multiple authentication sources (e.g. local, MS ADS, LDAP, …)

  • Two-Factor Authentication (OATH, Yubikey)

  • Based on ExtJS 7.x JavaScript framework

Login

screenshot/gui-login-window.png

When you connect to the server, you will first see the login window. Proxmox VE supports various authentication backends (Realm), and you can select the language here. The GUI is translated to more than 20 languages.

Note You can save the user name on the client side by selecting the checkbox at the bottom. This saves some typing when you login next time.

GUI Overview

screenshot/gui-datacenter-summary.png

The Proxmox VE user interface consists of four regions.

Header

On top. Shows status information and contains buttons for most important actions.

Resource Tree

At the left side. A navigation tree where you can select specific objects.

Content Panel

Center region. Selected objects display configuration options and status here.

Log Panel

At the bottom. Displays log entries for recent tasks. You can double-click on those log entries to get more details, or to abort a running task.

Note You can shrink and expand the size of the resource tree and log panel, or completely hide the log panel. This can be helpful when you work on small displays and want more space to view other content.

Header

On the top left side, the first thing you see is the Proxmox logo. Next to it is the current running version of Proxmox VE. In the search bar nearside you can search for specific objects (VMs, 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:

Help

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.

My Settings

screenshot/gui-my-settings.png

The My Settings window allows you to set locally stored settings. These include the Dashboard Storages which allow you to enable or disable specific storages to be counted towards the total amount visible in the datacenter summary. If no storage is checked the total is the sum of all storages, same as enabling every single one.

Below the dashboard settings you find the stored user name and a button to clear it as well as a button to reset every layout in the GUI to its default.

On the right side there are xterm.js Settings. These contain the following options:

Font-Family

The font to be used in xterm.js (e.g. Arial).

Font-Size

The preferred font size to be used.

Letter Spacing

Increases or decreases spacing between letters in text.

Line Height

Specify the absolute height of a line.

Resource Tree

This is the main navigation tree. On top of the tree you can select some predefined views, which change the structure of the tree below. The default view is the Server View, and it shows the following object types:

Datacenter

Contains cluster-wide settings (relevant for all nodes).

Node

Represents the hosts inside a cluster, where the guests run.

Guest

VMs, containers and templates.

Storage

Data Storage.

Pool

It is possible to group guests using a pool to simplify management.

The following view types are available:

Server View

Shows all kinds of objects, grouped by nodes.

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.

Log Panel

The main purpose of the log panel is to show you what is currently going on in your cluster. Actions like creating an new VM are executed in the background, and we call such a background job a task.

Any output from such a task is saved into a separate log file. You can view that log by simply double-click a task log entry. It is also possible to abort a running task there.

Please note that we display the most recent tasks from all cluster nodes here. So you can see when somebody else is working on another cluster node in real-time.

Note We remove older and finished task from the log panel to keep that list short. But you can still find those tasks within the node panel in the Task History.

Some short-running actions simply send logs to all cluster members. You can see those messages in the Cluster log panel.

Content Panels

When you select an item from the resource tree, the corresponding object displays configuration and status information in the content panel. The following sections provide a brief overview of this functionality. Please refer to the corresponding chapters in the reference documentation to get more detailed information.

Datacenter

screenshot/gui-datacenter-search.png

On the datacenter level, you can access cluster-wide settings and information.

  • Search: perform a cluster-wide search for nodes, VMs, containers, storage devices, and pools.

  • Summary: gives a brief overview of the cluster’s health and resource usage.

  • Cluster: provides the functionality and information necessary to create or join a cluster.

  • Options: view and manage cluster-wide default settings.

  • Storage: provides an interface for managing cluster storage.

  • Backup: schedule backup jobs. This operates cluster wide, so it doesn’t matter where the VMs/containers are on your cluster when scheduling.

  • Replication: view and manage replication jobs.

  • Permissions: manage user, group, and API token permissions, and LDAP, MS-AD and Two-Factor authentication.

  • HA: manage Proxmox VE High Availability.

  • ACME: set up ACME (Let’s Encrypt) certificates for server nodes.

  • Firewall: configure and make templates for the Proxmox Firewall cluster wide.

  • Metric Server: define external metric servers for Proxmox VE.

  • Support: display information about your support subscription.

Nodes

screenshot/gui-node-summary.png

Nodes in your cluster can be managed individually at this level.

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.

  • 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 comments in Markdown syntax.

  • Shell: access to a shell interface for the node.

  • System: configure network, DNS and time settings, and access the syslog.

  • Updates: upgrade the system and see the available new packages.

  • Firewall: manage the Proxmox Firewall for a specific node.

  • Disks: get an overview of the attached disks, and manage how they are used.

  • Ceph: is only used if you have installed a Ceph server on your host. In this case, you can manage your Ceph cluster and see the status of it here.

  • Replication: view and manage replication jobs.

  • Task History: see a list of past tasks.

  • Subscription: upload a subscription key, and generate a system report for use in support cases.

Guests

screenshot/gui-qemu-summary.png

There are two different kinds of guests and both can be converted to a template. One of them is a Kernel-based Virtual Machine (KVM) and the other is a Linux Container (LXC). Navigation for these are mostly the same; only some options are different.

To access the various guest management interfaces, select a VM or container from the menu on the left.

The header contains commands for items such as power management, migration, console access and type, cloning, HA, and help. Some of these buttons contain drop-down menus, for example, Shutdown also contains other power options, and Console contains the different console types: SPICE, noVNC and xterm.js.

The panel on the right contains an interface for whatever item is selected from the menu on the left.

The available interfaces are as follows.

  • Summary: provides a brief overview of the VM’s activity and a Notes field for Markdown syntax comments.

  • Console: access to an interactive console for the VM/container.

  • (KVM)Hardware: define the hardware available to the KVM VM.

  • (LXC)Resources: define the system resources available to the LXC.

  • (LXC)Network: configure a container’s network settings.

  • (LXC)DNS: configure a container’s DNS settings.

  • Options: manage guest options.

  • Task History: view all previous tasks related to the selected guest.

  • (KVM) Monitor: an interactive communication interface to the KVM process.

  • Backup: create and restore system backups.

  • Replication: view and manage the replication jobs for the selected guest.

  • Snapshots: create and restore VM snapshots.

  • Firewall: configure the firewall on the VM level.

  • Permissions: manage permissions for the selected guest.

Storage

screenshot/gui-storage-summary-local.png

As with the guest interface, the interface for storage consists of a menu on the left for certain storage elements and an interface on the right to manage these elements.

In this view we have a two partition split-view. On the left side we have the storage options and on the right side the content of the selected option will be shown.

  • Summary: shows important information about the storage, such as the type, usage, and content which it stores.

  • Content: a menu item for each content type which the storage stores, for example, Backups, ISO Images, CT Templates.

  • Permissions: manage permissions for the storage.

Pools

screenshot/gui-pool-summary-development.png

Again, the pools view comprises two partitions: a menu on the left, and the corresponding interfaces for each menu item on the right.

  • Summary: shows a description of the pool.

  • Members: display and manage pool members (guests and storage).

  • Permissions: manage the permissions for the pool.

Tags

screenshot/gui-qemu-summary-tags-edit.png

For organizational purposes, it is possible to set tags on guests. These have currently only informational value and they are display by default in the gui in two places, the Resource Tree and in the status line when a guest is selected.

They can be added, edited and removed in that status line of the guest by clicking on the pencil icon. After the tags have the desired values, you can click on the check mark button to apply the changes, or click the X button to cancel you editing.

The tags can also be set via the CLI, where multiple tags are semi-colon separated, for example:

# qm set ID --tags myfirsttag;mysecondtag

Styling

screenshot/gui-datacenter-tag-style.png

To adapt to various use cases and preferences, there are some options in the datacenter configuration that helps an admin control the behaviour and style of tags, such as the colors, ordering, and basic permission settings.

By default the tag colors are derived from their text in a deterministic way, but can be overridden in the datacenter configuration (The background color as well as the text color) as hexadecimal RGB values. You can also set these overrides 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).

You can also change the style of the tags in the tree and if the tags should be alphabetically sorted (the default) or should retain their order from the guest configuration.

Permissions

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. If you want to restrict this behaviour, it is possible to set various modes via the datacenter configuration:

  • a list of allowed tags

  • existing tags

  • no tags at all

Note that a user with Sys.Modify 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 will also require the privilege Sys.Modify on / to be added or removed independent of the mode.

For more details on the exact options, see the Datacenter Configuration.

See Also

  • link:/wiki/Central_Web-based_Management