os_keypair - Добавление/удаление пары ключей из OpenStack

Новое в версии 2.0.

Описание
Требования (для хоста, выполняющего модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

Описание

Добавление или удаление пары ключей из OpenStack

Требования (для хоста, выполняющего модуль)

python >= 2.7
shade

Параметры

параметр	обязателен	значение по умолчанию	значения	комментарии
api_timeout	нет	None		Сколько времени должна ждать сокетная связь перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку requests.
auth	нет			Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, которые требуются плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type	нет	password		Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone	нет			Игнорируется. Присутствует для обратной совместимости
cacert	нет	None		Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL.
cert	нет	None		Путь к клиенту сертификату для использования в ходе SSL-транзакции.
cloud	нет			Наименованное облако для работы. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или если присутствуют переменные окружения OpenStack OS_*.
endpoint_type	нет	public	public internal admin	Тип URL конечной точки для извлечения из каталога служб.
key	нет	None		Путь к ключу клиента для использования в ходе SSL-транзакции.
name	да	None		Имя, которое должно быть присвоено паре ключей
public_key	нет	None		Открытый ключ, который будет загружен в nova и введён в виртуальные машины при их создании.
public_key_file	нет	None		Путь к локальному файлу, содержащему открытый ключ ssh. Взаимоисключительно с public_key.
region_name	нет			Название региона.
state	нет	present	present absent	Ресурс должен присутствовать или отсутствовать.
timeout	нет	180		Сколько времени Ansible должно ждать запрошенного ресурса.
validate_certs	нет			Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. Синонимы: verify
wait	нет	yes	yes no	Должен ли Ansible ждать завершения запрошенного ресурса.

Примеры

# 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	Значение открытого ключа для пары ключей.	успех	строка

Примечания

Примечание

Стандартные переменные окружения OpenStack, такие как OS_USERNAME могут быть использованы вместо явного указания значений.
Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных окружения, а затем, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config

Статус

Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.

Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Информацию о сообществе и содействии, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_keypair_module.html