Documentation

ec2_win_password - gets the default administrator password for ec2 windows instances

New in version 2.0.

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 (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
aws_access_key
no
    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
    no
      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
      ec2_url
      no
        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
        yes
          The instance id to get the password data from.
          key_file
          yes
            Path to the file containing the key pair used on the instance.
            key_passphrase
            (added in 2.0)
            no
              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
              (added in 1.6)
              no
                uses a boto profile. Only works with boto >= 2.24.0
                region
                no
                  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
                  (added in 1.6)
                  no
                    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
                    (added in 1.5)
                    no yes
                    • yes
                    • no
                    When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
                    wait
                    (added in 2.0)
                    no no
                    • yes
                    • no
                    Whether or not to wait for the password to be available before returning.
                    wait_timeout
                    (added in 2.0)
                    no 120
                      Number of seconds to wait before giving up.

                      Examples

                      # Example of getting a password
                      tasks:
                      - 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 with a password protected key
                      tasks:
                      - 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
                      tasks:
                      - 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
                      

                      Notes

                      Note

                      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

                      Note

                      Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html

                      Note

                      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

                      This is an Extras Module

                      For more information on what this means please read Extras Modules

                      For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.