pcluster dcv - AWS ParallelCluster
Named argumentsSub-commands

pcluster dcv

Interacts with the Amazon DCV server running on the head node.

pcluster dcv [ -h ] ( connect )
pcluster dcv command

Possible choices: connect

Note

OS support changes for the pcluster dcv command in different AWS ParallelCluster versions:

  • Support for the pcluster dcv command on centos8 was added in AWS ParallelCluster version 2.10.0.

  • Support for the pcluster dcv command on AWS Graviton-based instances was added in AWS ParallelCluster version 2.9.0.

  • Support for the pcluster dcv command on ubuntu1804 was added in AWS ParallelCluster version 2.6.0.

  • Support for the pcluster dcv command on centos7 was added in AWS ParallelCluster version 2.5.0.

Named arguments

-h, --help

Shows the help text for pcluster dcv.

Sub-commands

pcluster dcv connect

pcluster dcv connect [ -h ] [ -k SSH_KEY_PATH ] [ -r REGION ] cluster_name
Important

The URL expires 30 seconds after it's issued. If the connection isn't made before the URL expires, run pcluster dcv connect again to generate a new URL.

Positional arguments

cluster_name

Specifies the name of the cluster to connect to.

Named arguments

-h, --help

Shows the help text for pcluster dcv connect.

-k SSH_KEY_PATH, --key-path SSH_KEY_PATH

Key path of the SSH key to use for the connection.

The key must be the one specified at cluster creation time in the key_name configuration parameter. This argument is optional, but if it's not specified, then the key must be available by default for the SSH client. For example, add it to the ssh-agent with ssh-add.

-r REGION, --region REGION

Specifies the AWS Region to use. Defaults to the AWS Region specified by using the pcluster configure command.

-s, --show-url

Displays a one-time URL for connecting to the Amazon DCV session. The default browser isn't opened when this option is specified.

Note

Support for the --show-url argument was added in AWS ParallelCluster version 2.5.1.

Example using AWS ParallelCluster version 2.11.7:

$ pcluster dcv connect -k ~/.ssh/id_rsa mycluster

Opens the default browser to connect to the Amazon DCV session running on the head node.

A new Amazon DCV session is created if one isn't already started.

A screenshot of the DCV console.