os_keypair - Добавление/удаление пары ключей из OpenStack
Новая версия с 2.0.
Описание
- Добавить или удалить пару ключей из OpenStack
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени слой сокетов должен ждать перед истечением времени ожидания для API-вызовов. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, которые требуются плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификата CA, который может использоваться для проверки SSL-API-запросов. | |
| cert | Путь к клиенту сертификату для использования в рамках SSL-транзакции. | |
| cloud | Имя облака или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml. | |
| interface (добавлено в 2.3) |
| Тип URL-адреса конечной точки для извлечения из каталога служб. алиасы: endpoint_type |
| key | Путь к клиентскому ключу для использования в рамках SSL-транзакции. | |
| name обязательно | Значение по умолчанию: None | Имя, которое должно быть присвоено паре ключей |
| public_key | Значение по умолчанию: None | Открытый ключ, который будет загружен в nova и введён в VM при создании. |
| public_key_file | Значение по умолчанию: None | Путь к локальному файлу, содержащему открытый ключ ssh. Взаимоисключающие с public_key. |
| region_name | Имя региона. | |
| state |
| Ресурс должен присутствовать или отсутствовать. |
| timeout | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| verify |
| Нужно ли проверять запросы SSL API. До версии 2.3 по умолчанию было True. алиасы: validate_certs |
| wait |
| Ansible должен ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем явных параметров в play. Более подробную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# Creates a key pair with the running users public key
- os_keypair:
cloud: mordred
state: present
name: ansible_key
public_key_file: /home/me/.ssh/id_rsa.pub
# Creates a new key pair and the private key returned after the run.
- os_keypair:
cloud: rax-dfw
state: present
name: ansible_key
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| id строка | успешно | Уникальный UUID. |
| name строка | успешно | Имя, присвоенное паре ключей. |
| private_key строка | Только при генерации пары ключей для пользователя (например, при создании, когда открытый ключ не указан). | Значение закрытого ключа для пары ключей. |
| public_key строка | успешно | Значение открытого ключа для пары ключей. |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Benno Joy (@bennojoy)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/os_keypair_module.html
