ec2_win_password – gets the default administrator password for ec2 windows instances — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ec2_win_password – gets the default administrator password for ec2 windows instances

New in version 2.0.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Gets the default administrator password from any EC2 Windows instance. The instance is referenced by its id (e.g. `i-XXXXXXX`). This module has a dependency on python-boto.

## Requirements

The below requirements are needed on the host that executes this module.

- boto
- cryptography
- python >= 2.6

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
aws_access_key string |  | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key string |  | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs boolean added in 2.8 | Choices: no ← yes | Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
ec2_url string |  | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
instance_id - / required |  | The instance id to get the password data from.
key_data - added in 2.8 |  | Variable that references the private key (usually stored in vault), conflicts with key_file.
key_file - |  | Path to the file containing the key pair used on the instance, conflicts with key_data.
key_passphrase - added in 2.0 |  | The passphrase for the instance key pair. The key must use DES or 3DES encryption for this module to decrypt it. You can use openssl to convert your password protected keys if they do not use DES or 3DES. ex) `openssl rsa -in current_key -out new_key -des3`.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
region string |  | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region aliases: aws_region, ec2_region
security_token string |  | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
wait boolean added in 2.0 | Choices: no ← yes | Whether or not to wait for the password to be available before returning.
wait_timeout - added in 2.0 | Default: 120 | Number of seconds to wait before giving up.

## Notes

Note

- As of Ansible 2.4, this module requires the python cryptography module rather than the older pycrypto module.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence `AWS_URL` or `EC2_URL`, `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` or `EC2_ACCESS_KEY`, `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` or `EC2_SECRET_KEY`, `AWS_SECURITY_TOKEN` or `EC2_SECURITY_TOKEN`, `AWS_REGION` or `EC2_REGION`
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
- `AWS_REGION` or `EC2_REGION` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

## Examples

    # Example of getting a password
    - name: get the Administrator password
      ec2_win_password:
        profile: my-boto-profile
        instance_id: i-XXXXXX
        region: us-east-1
        key_file: "~/aws-creds/my_test_key.pem"

    # Example of getting a password using a variable
    - name: get the Administrator password
      ec2_win_password:
        profile: my-boto-profile
        instance_id: i-XXXXXX
        region: us-east-1
        key_data: "{{ ec2_private_key }}"

    # Example of getting a password with a password protected key
    - name: get the Administrator password
      ec2_win_password:
        profile: my-boto-profile
        instance_id: i-XXXXXX
        region: us-east-1
        key_file: "~/aws-creds/my_protected_test_key.pem"
        key_passphrase: "secret"

    # Example of waiting for a password
    - name: get the Administrator password
      ec2_win_password:
        profile: my-boto-profile
        instance_id: i-XXXXXX
        region: us-east-1
        key_file: "~/aws-creds/my_test_key.pem"
        wait: yes
        wait_timeout: 45

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Rick Mendes (@rickmendes)

Hint

If you notice any issues in this documentation you can edit this document to improve it.