ec2_key – создание или удаление пары ключей ec2
Новая версия с 1.5.
Обзор
- создание или удаление пары ключей ec2.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key - | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key | |
| aws_secret_key - | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key | |
| ec2_url - | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая есть. | |
| force - добавлен в 2.3 | Значение по умолчанию: "да" | Принудительно перезаписывать уже существующую пару ключей, если ключ изменился. |
| key_material - | Материальные значения открытого ключа. | |
| name - / обязательно | Имя пары ключей. | |
| profile - добавлен в 1.6 | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| region - | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region | |
| security_token - добавлен в 1.6 | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| state - |
| создание или удаление пары ключей |
| validate_certs boolean добавлен в 1.5 |
| При установке в значение "нет", сертификаты SSL для boto версий >= 2.6.0 не будут проверены. |
| wait - добавлен в 1.6 | Значение по умолчанию: "нет" | Ожидать завершения указанного действия перед возвратом. Этот параметр не имеет эффекта с версии 2.5. |
| wait_timeout - добавлен в 1.6 | Значение по умолчанию: 300 | Сколько времени ждать, прежде чем ждать прекратит ожидание, в секундах. Этот параметр не имеет эффекта с версии 2.5. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это требуется, но это также можно настроить в файле конфигурации boto
Примеры
# 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...== me@example.com'
- 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...== me@example.com'
force: false
- name: remove key pair by name
ec2_key:
name: my_keypair
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| changed boolean | всегда | была ли создана/удалена пара ключей Пример: Истина | |
| key complex | всегда | детали пары ключей (устанавливается в null, когда состояние отсутствует) | |
| fingerprint строка | при состоянии present | отпечаток пары ключей Пример: b0:22:49:61:d9:44:9d:0c:7e:ac:8a:32:93:21:6c:e8:fb:59:62:43 | |
| name строка | при состоянии present | имя пары ключей Пример: my_keypair | |
| private_key строка | при создании новой пары ключей AWS (key_material не предоставлен) | приватный ключ новой пары ключей Пример: -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKC... -----END RSA PRIVATE KEY----- | |
| msg строка | всегда | краткое сообщение, описывающее выполненное действие Пример: пара ключей создана | |
Статус
- Этот модуль гарантирует отсутствие изменений интерфейса, несовместимых со старыми версиями, в дальнейшем. [stableinterface]
- Этот модуль поддерживается партнером Ansible. [certified]
Авторы
- Vincent Viallet (@zbal)
- Prasad Katti (@prasadkatti)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ec2_key_module.html