ec2-get-password

Description

Retrieves and decrypts the administrator password for the instances running Windows.

You must specify the key pair used to launch the instance.

Note

	Note
The Windows password is only generated the first time an AMI is launched. It is not generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided. There is no SOAP or Query version of the `ec2-get-password` command. Password generation and encryption takes a few moments. Please wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

The Windows password is only generated the first time an AMI is launched. It is not generated for rebundled AMIs or after the password is changed on an instance.

The password is encrypted using the key pair that you provided.

There is no SOAP or Query version of the ec2-get-password command.

Password generation and encryption takes a few moments. Please wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

The short version of this command is ec2gpass.

Syntax

ec2-get-password instanceId -k key_file

Options

Name Description Required

Name	Description	Required
`instance_id`	A Windows instance ID. Type: String Default: None Example: i-9b76d0f3	Yes
`-k, --priv-launch-key` `key_file`	The file that contains the private key used to launch the instance. Type: String Default: None Example: -k windows-keypair.pem	Yes

instance_id

A Windows instance ID.

Type: String

Default: None

Example: i-9b76d0f3

Yes

-k, --priv-launch-key key_file

The file that contains the private key used to launch the instance.

Type: String

Default: None

Example: -k windows-keypair.pem

Yes

Common Options

Option	Description
`--region` `REGION`	Overrides the Region specified in the `EC2_URL` environment variable and the URL specified by the `-U` option. Default: The `EC2_URL` environment variable, or `us-east-1` if the environment variable is not set. Example: `--region eu-west-1`
`-U, --url` `URL`	`URL` is the uniform resource locator of the Amazon EC2 web service entry point. Default: The `EC2_URL` environment variable, or https://ec2.amazonaws.com if the environment variable is not set. Example: `-U https://ec2.amazonaws.com`
`-K, --private-key` `EC2-PRIVATE-KEY`	The private key to use when constructing requests to Amazon EC2. Default: The value of the `EC2_PRIVATE_KEY` environment variable. Example: `-K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem`
`-C, --cert` `EC2-CERT`	The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the `EC2_CERT` environment variable. Example: `-C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem`
`--connection-timeout` `TIMEOUT`	Specifies a connection timeout (in seconds). Example: --connection-timeout 30
`--request-timeout` `TIMEOUT`	Specifies a request timeout (in seconds). Example: --request-timeout 45
`-v, --verbose`	Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.
`-H, --headers`	Displays column headers in the output.
`--show-empty-fields`	Shows empty columns as `(nil)`.
`--hide-tags`	Do not display tags for tagged resources.
`--debug`	Prints internal debugging information. This is useful to assist us when troubleshooting problems.
`-?, --help, -h`	Displays Help.
`-`	If `-` is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another. Example: `ec2-describe-instances \| grep stopped \| cut -f 2 \| ec2-start-instances -`

Output

The command returns a table that contains the following information:

The Windows administrator password

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example returns the administrator password for the i-2574e22a instance.

PROMPT> ec2-get-password i-2574e22a -k windows-keypair.pem
q96A40B9w