pcluster dcv-connect - AWS ParallelCluster
Named arguments

pcluster dcv-connect

Permits to connect to the head node through an interactive session by using Amazon DCV.

pcluster dcv-connect [-h]
                 --cluster-name CLUSTER_NAME 
                [--debug]
                [--key-path KEY_PATH]
                [--login-node-ip LOGIN_NODE_IP]
                [--region REGION]
                [--show-url]

Named arguments

-h, --help

Shows the help text for pcluster dcv-connect.

--cluster-name, -n CLUSTER_NAME

Specifies the name of the cluster.

--debug

Enables debug logging.

--key-path KEY_PATH

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

--login-node-ip

Specifies the public or private IP address of a login node in the cluster. Using this argument allows connection to a login node in the cluster with DCV enabled.

Note

This argument is added in AWS ParallelCluster version 3.11.0.

--region, -r REGION

Specifies the AWS Region to use. The AWS Region must be specified, using the AWS_DEFAULT_REGION environment variable, the region setting in the [default] section of the ~/.aws/config file, or the --region parameter.

--show-url

Prints the URL that would be used for the DCV connection and exits.

Example using AWS ParallelCluster version 3.11

$ pcluster dcv-connect -n cluster-3Dcv --login-node-ip 198.51.100.44 -r us-east-1 --key-path /home/user/.ssh/key.pem

A screenshot of the DCV console.