# 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.