New in version 1.5.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key | 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 | 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 | 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. | |
force (added in 2.3) | Default: yes | Force overwrite of already existing key pair if key has changed. |
key_material | Public key material. | |
name required | Name of the key pair. | |
profile (added in 1.6) | Uses a boto profile. Only works with boto >= 2.24.0. | |
region | 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) | 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 | |
state |
| create or delete keypair |
validate_certs bool (added in 1.5) |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
wait (added in 1.6) | Default: no | Wait for the specified action to complete before returning. This option has no effect since version 2.5. |
wait_timeout (added in 1.6) | Default: 300 | How long before wait gives up, in seconds. This option has no effect since version 2.5. |
Note
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
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# Note: These examples do not set authentication details, see the AWS Guide for details. - name: create a new ec2 key pair, returns generated private key ec2_key: name: my_keypair - name: create key pair using provided key_material ec2_key: name: my_keypair key_material: 'ssh-rsa AAAAxyz...== [email protected]' - name: create key pair using key_material obtained using 'file' lookup plugin ec2_key: name: my_keypair key_material: "{{ lookup('file', '/path/to/public_key/id_rsa.pub') }}" # try creating a key pair with the name of an already existing keypair # but don't overwrite it even if the key is different (force=false) - name: try creating a key pair with name of an already existing keypair ec2_key: name: my_existing_keypair key_material: 'ssh-rsa AAAAxyz...== [email protected]' force: false - name: remove key pair by name ec2_key: name: my_keypair state: absent
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
changed bool | always | whether a keypair was created/deleted Sample: True | |
key complex | always | details of the keypair (this is set to null when state is absent) | |
private_key string | when a new keypair is created by AWS (key_material is not provided) | private key of a newly created keypair Sample: -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKC... -----END RSA PRIVATE KEY----- | |
name string | when state is present | name of the keypair Sample: my_keypair | |
fingerprint string | when state is present | fingerprint of the key Sample: b0:22:49:61:d9:44:9d:0c:7e:ac:8a:32:93:21:6c:e8:fb:59:62:43 | |
msg string | always | short message describing the action taken Sample: key pair created |
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by an Ansible Partner, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ec2_key_module.html