[dcv] section - Amazon ParallelCluster
access_fromenableport
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

[dcv] section

Defines configuration settings for the NICE DCV server running on the head node.

To create and configure a NICE DCV server, specify the cluster dcv_settings with the name you define in the dcv section, and set enable to master, and base_os to alinux2, centos7, ubuntu1804 or ubuntu2004. If the head node is an ARM instance, set base_os to alinux2, centos7, or ubuntu1804.

The format is [dcv dcv-name]. dcv-name must start with a letter, contain no more than 30 characters, and only contain letters, numbers, hyphens (-), and underscores (_).

[dcv custom-dcv]
enable = master
port = 8443
access_from = 0.0.0.0/0

For more information, see Connect to the head node through NICE DCV

Important

By default the NICE DCV port setup by Amazon ParallelCluster is open to all IPv4 addresses. However, you can connect to a NICE DCV port only if you have the URL for the NICE DCV session and connect to the NICE DCV session within 30 seconds of when the URL is returned from pcluster dcv connect. Use the access_from setting to further restrict access to the NICE DCV port with a CIDR-formatted IP range, and use the port setting to set a nonstandard port.

Note

Support for the [dcv] sectionon centos8 was removed in Amazon ParallelCluster version 2.10.4. Support for the [dcv] section on centos8 was added in Amazon ParallelCluster version 2.10.0. Support for the [dcv] section on Amazon Graviton-based instances was added in Amazon ParallelCluster version 2.9.0. Support for the [dcv] section on alinux2 and ubuntu1804 was added in Amazon ParallelCluster version 2.6.0. Support for the [dcv] sectionon centos7 was added in Amazon ParallelCluster version 2.5.0.

access_from

(Optional, Recommended) Specifies the CIDR-formatted IP range for connections to NICE DCV. This setting is used only when Amazon ParallelCluster creates the security group.

The default value is 0.0.0.0/0, which allows access from any internet address.

access_from = 0.0.0.0/0

Update policy: This setting can be changed during an update.

enable

(Required) Indicates whether NICE DCV is enabled on the head node. To enable NICE DCV on the head node and configure the required security group rule, set the enable setting to master.

The following example enables NICE DCV on the head node.

enable = master
Note

NICE DCV automatically generates a self-signed certificate that's used to secure traffic between the NICE DCV client and NICE DCV server running on the head node. To configure your own certificate, see NICE DCV HTTPS certificate.

Update policy: If this setting is changed, the update is not allowed.

port

(Optional) Specifies the port for NICE DCV.

The default value is 8443.

port = 8443

Update policy: If this setting is changed, the update is not allowed.