pcluster ssh - Amazon ParallelCluster
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).

pcluster ssh

Runs an ssh command with the user name and IP address of the cluster pre-populated. Arbitrary arguments are appended to the end of the ssh command. This command can be customized in the aliases section of the configuration file.

pcluster ssh [ -h ] [ -d ] [ -r REGION ] cluster_name

Positional arguments


Specifies the name of the cluster to connect to.

Named arguments

-h, --help

Shows the help text for pcluster ssh.

-d, --dryrun

Prints the command that would be run and exits.

Defaults to False.

-r REGION, --region REGION

Specifies the Amazon Web Services Region to use. Defaults to the Region specified by using the pcluster configure command.

Examples using Amazon ParallelCluster version 2.11.7:

$ pcluster ssh -d mycluster -i ~/.ssh/id_rsa SSH command: ssh ec2-user@ -i /home/user/.ssh/id_rsa
$ pcluster ssh mycluster -i ~/.ssh/id_rsa

Runs ssh command with the user name and IP address of the cluster pre-populated:

ssh ec2-user@ -i ~/.ssh/id_rsa

The ssh command is defined in the global configuration file under the [aliases] section. It can be customized as follows.

[ aliases ] ssh = ssh {CFN_USER}@{MASTER_IP} {ARGS}

Variables substituted:


The user name for the base_os that is selected.


The IP address of the head node.


Optional arguments to pass to the ssh command.