

# Using the Amazon DCV Access Console
Using the Access Console

The following topic describes how to use the Amazon DCV Access Console.

**Topics**
+ [

# Sessions
](sessions.md)
+ [

# Session templates
](session-templates.md)
+ [

# Hosts
](hosts.md)

# Sessions


A session is a span of time when the Amazon DCV server is able to accept connections from a client. Each session has a specified owner and set of permissions. 

Before your clients can connect to a Amazon DCV session, you must create a Amazon DCV session on the Amazon DCV server. When you create a Amazon DCV session, you change the state of the server to accept connections from a client. Amazon DCV supports both console and virtual sessions.

On the **Sessions** page, you can view sessions that you created yourself, and the detailed session information. If there are no available sessions, you must choose **Create session** to begin.

**Note**  
If you experience issues accessing the sessions created outside of the console, you may need to debug that or delete that session.

You can configure the visible fields in the top navigation bar by selecting the gear icon. To view more details in a split panel view, use the picker to select a session. Then select the caret (^) icon at the bottom-right corner of the page.

By default, sessions that have been closed are hidden with a filter. You can remove the filter to see previously closed sessions.

![\[Sessions management interface showing three available virtual desktop sessions with status and owner details.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/console-dashboard.png)


## Session details


This includes the session parameters themselves. For more information, see [DescribeSessions](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeSessions.html). The details also include the Amazon DCV server information that the session is placed on. For more information, see [DescribeServers](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html).

![\[Session details showing status, specifications, and connection information for a Linux instance.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-details.png)



| Property | Description | 
| --- | --- | 
|  Session name  |  The session name. This field can't be changed after creation (`Name` in the [DescribeSessions](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeSessions.html) API).  | 
|  Level of access  |  The level of access for a particular session.  | 
|  Status  |  A session has four states associated with it. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/dcv/latest/access-console/sessions.html)  | 
|  Session owner  |  The name of the session owner (`Owner` is in the [DescribeSessions API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeSessions.html)).  | 
|  Session ID  |  The unique ID of the session (`Id` is in the [DescribeSessions API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeSessions.html)).  | 
|  Hostname  |  The hostname of the host server that the Amazon DCV server is running on (`Servers.Hostname` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html)).  | 
|  Host IP address  |  The unique IP of the Amazon DCV server (`Servers.ID` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html)).  | 
|  Operating systems  |  The name of the host server operating system that the Amazon DCV server is running on (`Host.OS.Family` in the [DescribeServers](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  CPU  |  Information about the host server’s CPU that the Amazon DCV server is running on (`Host.CpuInfo.ModelName` in the [DescribeServers](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  GPU  |  Information about the host server’s GPU that the Amazon DCV server is running on (`ModelName` in the [DescribeServers](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Memory  |  Information about the host server’s memory, in gigabytes. This information is displayed as [Used GB/Total GB] (`Memory.UsedBytes/Memory/TotalBytes` in the [DescribeServers](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Last time connected  |  The last time a user connected to this session (`LastDisconnectionTime` in the [DescribeSessions](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeSessions.html) API).  | 
|  Number of people connected  |  The number of people currently connected to this session (`NumOfConnections` in the [DescribeSessions](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeSessions.html) API).  | 
|  Created at  |  The time that the session was created at (`CreationTime` in the [DescribeSessions](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeSessions.html) API).  | 

**Topics**
+ [

## Session details
](#session-details)
+ [

# Creating a session
](creating-session.md)
+ [

# Connecting to a session
](connecting-session.md)
+ [

# Closing a session
](closing-session.md)

# Creating a session


To use this console, you must create a session. A session is a span of time when the Amazon DCV server can accept connections from a client. By creating a new session, your default level of access is **owner**, which gives you admin permissions.

To create a new session, you must select a template already provided by the administrator. Session templates are specified parameters that you can create a session with. If there are no templates available to choose from, contact the administrator to create a template and assign it to you.

1. Select **Sessions** under the **Session management** tab.

1. Select the **Create session** button.  
![\[Sessions management interface showing available virtual desktop sessions and options.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/console-dashboard-create-button.png)

1. In **Display name**, enter a user friendly name for your session.
**Note**  
 After you create a session, you can't edit this name.

1. Select a **Session template**.

1. Select the **Create session** button.  
![\[Create session interface with display name field and session template options.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/create-seesion-1.png)

The newly created session will appear in the Sessions dashboard. It may take a few minutes to create the session. In that time, you won't be able to connect to or close the session.

![\[Sessions dashboard showing three available virtual desktop sessions with their names and owners.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/create-seesion-2.png)


# Connecting to a session


You can connect to a session after it has been created. You can connect to a session from either the DCV web client, or a native Windows or macOS client application.

1. Select the **Actions** button in the session window that you want to view.  
![\[Sessions interface showing available virtual desktop sessions with Actions, Connect, and Create session buttons.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-action.png)

1. Select **Connect using** from the menu.

1. Choose from one of the following options:
   + **Web browser**— Connects to your session using a web browser.
   + **Windows client**— Connects to your session using the Windows client with the Amazon DCV app. If you don't have the appropriate local Amazon DCV Viewer application downloaded, you will be directed to the [Amazon DCV download site](http://download.amazondcv.com) where you can download the latest viewer.
   + **macOS client**— Connects to your session using the macOS client with the Amazon DCV app. If you don't have the appropriate local Amazon DCV Viewer application downloaded, you will be directed to the [Amazon DCV download site](http://download.amazondcv.com) where you can download the latest viewer.

# Closing a session


After you’re completely done with your work, you can **Close** a session and release the underlying resource back to the host server.

**Note**  
Closing a session can't be undone. All locally saved work will be lost. Closing a session doesn't shut down the underlying host server.

1. Go to the **Sessions** page.

1. Select the session that you want to close.

1. Click the **Actions** button in the session window.

1. Select **Close** from the menu.  
![\[Sessions management interface showing available virtual desktop sessions and action options.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/close-session.png)

1. Select **Close** from the window that appears.

# Session templates


A Amazon DCV session template is created by admins to define the details of the session to be created.

To create a session, you must first have an existing session template that you will use to create a session from.

On the **Session templates** page, you can view session templates that you created, and their detailed information.

You can configure the visible fields in the top navigation bar by selecting the gear icon. To view more details in a split panel view, use the picker to select a template, and then select the caret (^) icon at the bottom-right corner of the page.

![\[Session templates interface showing three templates with Linux and Windows options.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-template.png)


## Session template details


For more information see [Creating a session](creating-session.md).

![\[Details page showing template information, system specs, and additional requirements for a Linux instance.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-templates-details.png)



| Property | Description | 
| --- | --- | 
|  Template name (required)  |  The descriptive name that's shown to users.  | 
|  Template description  |  The session template description. This is to describe the intended use case for the template, and help users choose the appropriate template.  | 
|  Operation system (required)  |  The operating system family of the host server that the Amazon DCV server runs on. This must be either a Linux, Windows or macOS operating system (`Host.OS.Family` in the `DescribeServers` API).  | 
|  Operating system version  |  The version of the operating system of the host server that the Amazon DCV server is running on (`Host.Os.Version` in the `DescribeServers` API).  | 
|  Session type (required)  |  The session type, which must either be a console or a virtual session. A **console session** is supported on macOS, Linux and Windows servers, and will be the only session on the specified server. A **virtual session** is supported only on Linux servers, and allows multiple sessions on the specified server (Type in the `CreateSessions API`). For more information about the types of sessions, see [Introduction to Amazon DCV Sessions](https://docs.aws.amazon.com/dcv/latest/adminguide/managing-sessions.html#managing-sessions-intro) in the *Amazon DCV Administrator Guide*.  | 
|  OpenGL (Linux virtual only)  |  Indicates whether the virtual session is configured to use the hardware-based OpenGL. OpenGL stands for Open Graphics Library, and is a set of standard APIs used to interface with graphics processing hardware, allowing hardware acceleration through the GPU. OpenGL is supported with virtual sessions only. This parameter isn't supported with Windows Amazon DCV servers (`DcvGlEnabled` in the `CreateSessions` API).  | 
|  Instance ID  |  The ID of the Amazon EC2 instance. This parameter only applies for customers hosting on AWS, and will not be shown to customers hosting on-premises (`Host.Aws.Ec2InstanceId` in the `DescribeServers` API).  | 
|  Instance type  |  The type of Amazon EC2 instance. This parameter only applies for customers hosting on AWS, and will not be shown to customers hosting on-premise (`Host.Aws.Ec2InstanceType` in the `DescribeServers` API).  | 
|  Instance Region  |  The AWS Region of the Amazon EC2 host. This parameter only applies for customers hosting on AWS, and will not be shown to customers hosting on-premises (`Host.Aws.Region` in the `DescribeServers` API).  | 
|  Host vCPU  |  The number of virtual CPUs on the host server (`Host.CpuInfo.NumberOfCpus` in the `DescribeServers` API).  | 
|  Host memory in bytes  |  The total memory, in bytes, on the host server that the Amazon DCV server is running on (`Host.Memory.TotalBytes` in the `DescribeServers` API).  | 
|  Autorun file path (Windows and Linux virtual only)  |  The path to a file on the host server that runs inside the session. The file path is relative to the autorun directory specified for the `agent.autorun_folder` Agent configuration parameter. If the file is in the specified autorun directory, specify the file name only. If the file isn't in the specified autorun directory, specify the relative path. For more information, see [Agent configuration file](https://docs.aws.amazon.com/dcv/latest/sm-admin/agent-file.html) in the *Amazon DCV Session Manager Administrator Guide*. The file is run on behalf of the specified **owner**. The specified owner must have permission to run the file on the server. On Windows Amazon DCV servers, the file is run when the owner logs in to the session. On Linux Amazon DCV servers, the file is run when the session is created. Console sessions on Windows Amazon DCV servers and virtual sessions on Linux Amazon DCV servers are supported. Console sessions on macOS Amazon DCV servers and Linux Amazon DCV servers are not supported. (`AutorunFile` in the `CreateSessions` API).   | 
|  Autorun arguments (Linux virtual only)  |  Command line arguments passed to **AutorunFile** upon its execution inside the session. Arguments are passed in the order that they appear into the given array. Maximum allowed number of arguments and maximum allowed length of each argument can be configured. For more information, see [Broker configuration file](https://docs.aws.amazon.com/dcv/latest/sm-admin/broker-file.html) in the *Amazon DCV Session Manager Administrator Guide*. Virtual sessions on Linux Amazon DCV servers are supported. Console sessions on macOS, Windows and Linux Amazon DCV servers are not supported (`AutorunFileArguments` in the `CreateSessions` API).   | 
|  Max concurrent clients  |  The maximum number of concurrent Amazon DCV clients allowed to connect to the session at a given time. To specify that there is no maximum, enter 0. (`AutorunFileArguments` in the `CreateSessions` API).  | 
|  Init file path (Linux virtual only)  |  The path to a folder on the host server used to store custom scripts allowed to initialize Amazon DCV server sessions when they are created. The file path is relative to the init directory specified for the `agent.init_folder` Agent configuration parameter. If the file is in the specified init directory, specify the file name only. If the file isn't in the specified init directory, specify the relative path. The folder must be accessible and the files must be executable by users who use the **InitFile** request parameter of the **CreateSessions** API. For more information, see [Create Sessions](https://docs.aws.amazon.com/dcv/latest/sm-dev/CreateSessions.html#:~:text=Required%3A%20Yes-,InitFile,-Supported%20with%20virtual) in the *Amazon DCV Session Manager Developer Guide* or [Agent configuration](https://docs.aws.amazon.com/dcv/latest/sm-admin/agent-file.html) file in the *Amazon DCV Session Manager Administrator Guide*. Virtual sessions on Linux Amazon DCV servers are suppoprted. Console sessions on macOS, Windows and Linux Amazon DCV servers are not supported (`InitFile` in the `CreateSessions` API).   | 
|  Storage root  |  Specifies the path to the folder used for session storage. Session storage is a folder on the Amazon DCV server that clients can access when they're connected to a specific Amazon DCV session. When you enable session storage for a session, clients can download files from, and upload files to, the specified folder. This feature enables clients to share files while connected to a session. For more information, see [Create Sessions](https://docs.aws.amazon.com/dcv/latest/sm-dev/CreateSessions.html#:~:text=Required%3A%20No-,StorageRoot,-Specifies%20the%20path) in the *Amazon DCV Session Manager Developer Guide* or [Enabling Session Storage](https://docs.aws.amazon.com/dcv/latest/adminguide/manage-storage.html) in the *Amazon DCV Administrator Guide* (`StorageRoot` in the `CreateSessions` API).  | 
|  Additional host server requirements  |  Use this text box to set the requirements that the server must satisfy to place the session. The requirements can include server tags and/or server properties, both server tags and server properties are retrieved by calling the **DescribeServers** API. Requirements support both condition and Boolean expressions.  | 

Some of these settings you’ve already specified elsewhere in the **Configure** step (like Operating System). Those settings are pre-populated in the additional requirements box, and are immutable from the text box itself. To change those settings, you must change them from the specified UI elements. You can also add and modify additional requirements using the syntax provided in the Create Session documentation. For a complete list of supported server properties, see [Create Session](https://docs.aws.amazon.com/dcv/latest/sm-dev/CreateSessions.html#:~:text=Required%3A%20No-,Requirements,-The%20requirements%20that) in the *Amazon DCV Session Manager Developer Guide*.

**Topics**
+ [

## Session template details
](#session-template-details)
+ [

# Creating a session template
](creating-session-template.md)
+ [

# Assigning a session template to users or groups
](assigning-session-template.md)
+ [

# Duplicating a session template
](duplicating-session-template.md)
+ [

# Editing a session template
](editing-session-template.md)
+ [

# Deleting a session template
](deleting-session-template.md)

# Creating a session template


A session template is required to create sessions within the console. The session template sets the parameters and details of the session.

1. Go to the **Session templates** page.

1. Select the **Create template** button.  
![\[Session templates interface showing three templates with Linux and Windows options.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-template.png)

1. Enter the information in the **Configure template details** page.

   This page chooses the parameters of your session template. These parameters define the details of the session and create boundaries for what kind of hosts a session can be created on. See [Session template details](session-templates.md#session-template-details) for more information.

1. Assign users or user groups to the session template.

   You can assign a session template for existing users or groups when creating sessions. You can do this either during template creation or after a template has already been created. For more information, see [Assigning a session template to users or groups](assigning-session-template.md).

1. Select the **Next** button.

1. Review the template details for accuracy. To change the template, select **Edit** to go back to the **Configure template details** page.

1. Select the **Create template** button.

# Assigning a session template to users or groups


In order for users to create sessions, they must first have a session template assigned to them.

You may assign a session template to users or groups either during the original template creation process or after a template has already been created. See [Creating a session template](creating-session-template.md).

1. Select the session template that you want to assign.

1. Click on the **Actions** button.

1. Select **Assign users and groups** from the menu.  
![\[Session templates interface showing three templates with options to manage and create.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-templates-actions-assign.png)

1. Enter the name of the user in the **User** field or the name of the user group in the **Group** field.  
![\[User interface for assigning users and groups to a template, with search fields and add buttons.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-template-assign.png)

1. Click on either the **Add new user** or **Add new group** button.

1. Choose **Save**.

# Duplicating a session template


Instead of creating a new session template, you can choose to duplicate an existing session template and change its parameters to your specifications.

1. Select the session template that you want to duplicate.

1. Click on the **Actions** button.

1. Select **Duplicate** from the drop-down menu. This will take you to the **Configure template details** page.  
![\[Session templates interface showing list of templates with options to manage and create.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-templates-actions-duplicate.png)

1. Change any of the information in the **Configure template details** page.

   This page chooses the parameters of your session template. These parameters define the details of the session and create boundaries for what kind of hosts a session can be created on. See [Session template details](session-templates.md#session-template-details) for more information.

1. Assign users or user groups to the session template.

   You can assign a session template for existing users or groups to use when creating sessions. You can do this either during template creation or after a template has already been created. For more information, see [Assigning a session template to users or groups](assigning-session-template.md).

1. Select the **Create template** button.

# Editing a session template


If you need to adjust any sessions details, you can edit the parameters of an existing session template.

**Note**  
Editing an existing template could affect users already assigned to it. Any changes you make will not affect the sessions already created. However, it will affect users the next time they create a session using the modified template. If you do not want to affect users who already have this template assigned to them, [Duplicating a session template](duplicating-session-template.md) may be a better option.

1. Select the session template that you want to edit. 

1. Click on the **Actions** button.

1. Select **Edit** from the drop-down menu. This will take you to the **Configure template details** page.  
![\[Session templates interface showing list of templates with options to edit or delete.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-templates-actions-edit.png)

1. Change any of the information in the **Configure template details** page.

   This page chooses the parameters of your session template. These parameters define the details of the session and create boundaries for what kind of hosts a session can be created on. See [Session template details](session-templates.md#session-template-details) for more information.

1. Assign users or user groups to the session template.

   You can assign a session template for existing users or groups to use when creating sessions. You can do this either during template creation or after a template has already been created. For more information, see [Assigning a session template to users or groups](assigning-session-template.md).

1. Select the **Update template** button.

# Deleting a session template


You can delete a session template when you're completely done with it.

**Note**  
Deleting a session can't be undone. Active sessions that were created with a deleted template won't be affected. However, any assigned users will no longer see the template available when they create a new session.

1. Select the session template that you want to delete.

1. Click on the **Actions** button.

1. Select **Delete** from the drop-down menu.  
![\[Session templates interface showing options to manage and create templates.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/session-templates-delete.png)

1. Click on the **Delete** button in the window that appears.

# Hosts


On the **Hosts** page, you can view a list of host machines (either cloud or on-premises) you have installed Amazon DCV servers configured with Amazon DCV Session Manager.

Before your users can connect to a Amazon DCV session, you must have hosts available for users to create sessions on. You can't spin up hosts, install Amazon DCV servers on hosts, or configure them with the Amazon DCV Session Manager from the console. For more information about installing Amazon DCV servers, see [Installing the Amazon DCV server](https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing.html).

You can configure the visible fields in the top navigation bar by selecting the gear icon. To view more details in a split panel view, select a session and then click the caret (**^**) icon at the bottom-right corner of the page.

![\[Host management interface showing Windows and Linux servers with memory usage and availability status.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/hosts.png)


## Host information


For more information about the requirements and details of the Amazon DCV servers, see Amazon DCV Servers and DescribeServers.

### Host Details


![\[Host details showing Windows 10 OS information, memory usage, and swap space allocation.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/hosts-operating-sys.png)



| Property | Description | 
| --- | --- | 
|  Family  |  The host operating system family that the Amazon DCV server is running on, such as Windows, Linux or macOS (`Host.OS.Family` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Hostname  |  The hostname of the host server that the Amazon DCV server is running on (`Servers.Hostname` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Name  |  The name of the host server operating system that the Amazon DCV server is running on (`Host.OS.Name` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Version  |  The version of the host server operating system that the Amazon DCV server is running on (`Host.OS.Version` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Kernel version  |  (Linux only) The kernel version of the host server operating system that the Amazon DCV server is running on (`Host.OS.KernelVersion` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Build number  |  (Windows only) The build number of the host server operating system that the Amazon DCV server is running on (`Host.OS.BuildNumber` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  LoggedInUsers  |  The usernames of the users that are currently logged into the host server (`Host.OS.LoggedInUsers` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Memory  |  Information about the host server’s memory, in gigabytes. This information is displayed as [Used GB/Total GB] (`Memory.UsedBytes` / `Memory/TotalBytes` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html)).  | 
|  Memory - Total bytes  |  The total memory, in bytes, on the host server that the Amazon DCV server is running on (`Memory.TotalBytes` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Memory - Used bytes  |  The used memory, in bytes, on the host server that the Amazon DCV server is running on (`Memory.UsedBytes` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Swap - Total bytes  |  The total swap file size, in bytes, on the host server that the Amazon DCV server is running on (`Swap.TotalBytes` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 
|  Swap - Used bytes  |  The used swap file size, in bytes, on the host server that the Amazon DCV server is running on (`Swap.UsedBytes` in the [DescribeServers API](https://docs.aws.amazon.com/dcv/latest/sm-dev/DescribeServers.html) API).  | 

### AWS information


![\[AWS EC2 instance details showing region, instance type, ID, and image ID.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/hosts-aws.png)



| Property | Description | 
| --- | --- | 
|  Region  |  The Region of the Amazon EC2. This parameter only applies for customers hosting on AWS, and will not be shown to customers hosting on-premise (`Host.Aws.Region` in the `DescribeServers` API).  | 
|  EC2 Instance Type  |  The type of Amazon EC2 instance. This parameter only applies for customers hosting on AWS, and will not be shown to customers hosting on-premise (`Host.Aws.Ec2InstanceType` in the `DescribeServers` API).  | 
|  EC2 Image ID  |  The ID of the Amazon EC2 image. This parameter only applies for customers hosting on AWS, and will not be shown to customers hosting on-premise (`Host.Aws.Ec2IMAGEId` in the `DescribeServers` API).  | 

### Amazon DCV server


![\[DCV server details showing name, ID, IP, version, and session information.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/hosts-dcv-server.png)



| Property | Description | 
| --- | --- | 
|  ID  |  The unique ID of the Amazon DCV server (`Servers.Id` in the `DescribeServers` API).  | 
|  Availability  |  The availability of the Amazon DCV server (`Servers.Availability` in the `DescribeServers` API). Possible values include: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/dcv/latest/access-console/hosts.html)  | 
|  Version  |  The version of the Amazon DCV server (`Servers.Version` in the `DescribeServers` API).  | 
|  Session Manager agent version  |  The version Session Manager agent running on the Amazon DCV server (`Servers.SessionManagerAgentVersion` in the `DescribeServers` API).  | 
|  Console session count  |  The number of console sessions on the Amazon DCV server (`Servers.ConsoleSessionCount` in the `DescribeServers` API).  | 
|  Virtual session count  |  The number of virtual sessions on the Amazon DCV server (`Servers.ConsoleSessionCount` in the `DescribeServers` API).  | 

### CPU


![\[CPU info showing GenuineIntel Xeon E5-2686 v4 processor with 2 CPUs, 2 cores each, and 0% load.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/hosts-cpu.png)



| Property | Description | 
| --- | --- | 
|  Vendor  |  The vendor of the host server's CPU (`Host.CpuInfo.Vendor` in the `DescribeServers` API).  | 
|  Model  |  The model name of the host server's CPU (`Host.CpuInfo.ModelName` in the `DescribeServers` API).  | 
|  Architecture  |  The architecture of the host server's CPU (`Host.CpuInfo.Architecture` in the `DescribeServers` API).  | 
|  Number of vCPUs  |  The number of virtual CPUs on the host server (`Host.CpuInfo.NumberOfCpus` in the `DescribeServers` API).  | 
|  Number of physical cores per CPU  |  The number of physical CPUs on the host server.  | 
|  One minute average  |  The average CPU load over the last 1 minute period of the host server (`Host.CpuLoadAverage.OneMinute` in the `DescribeServers` API).  | 
|  Five minute average  |  The average CPU load over the last 5 minute period of the host server (`Host.CpuLoadAverage.FiveMinutes` in the `DescribeServers` API).  | 
|  Fifteen minute average  |  The average CPU load over the last 15 minute period of the host server (`Host.CpuLoadAverage.FifteenMinutes` in the `DescribeServers` API).  | 

### GPU


![\[Table showing GPU information with "No GPUs found" message displayed.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/hosts-gpu.png)



| Property | Description | 
| --- | --- | 
|  Vendor  |  The vendor of the host server's GPU (`Host.Gpus.Vendor` in the `DescribeServers` API).  | 
|  Model  |  The model name of the host server's GPU (`Host.Gpus.ModelName` in the `DescribeServers` API).  | 

### Server endpoints


![\[Server endpoints table showing IP, Protocol, Port, and Web URL Path for HTTP and QUIC connections.\]](http://docs.aws.amazon.com/dcv/latest/access-console/images/hosts-server-endpoints.png)



| Property | Description | 
| --- | --- | 
|  IP  |  The IP address of the Amazon DCV server endpoint (`Servers.Endpoints.IpAddress` in the `DescribeServers` API).  | 
|  Protocol  |  The protocol used by the Amazon DCV server endpoint (`Servers.Endpoints.Protocol` in the `DescribeServers` API). Possible values include: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/dcv/latest/access-console/hosts.html)  | 
|  Port  |  The port of the Amazon DCV server endpoint (`Servers.Endpoints.Port` in the `DescribeServers` API).  | 
|  Web URL path  |  The web URL path of the Amazon DCV server endpoint. Available for the HTTP protocol only (`Servers.Endpoints.WebUrlPath` in the `DescribeServers` API).  | 
|  Tags  |  The tags assigned to the host server that the Amazon DCV server is running on (`Host.Tags` in the `DescribeServers` API).  | 