openstack.cloud.keypair – Добавление/удаление пары ключей из OpenStack

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Чтобы использовать его в плейбуке, укажите: openstack.cloud.keypair.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени (в секундах) должен ждать сокет-слой перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для стандартного плагина password в нем будут содержаться auth_url, username, password, project_name и любая информация о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры соответствующего плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя плагина авторизации для использования. Если облако использует что-то помимо аутентификации по паролю, здесь следует указать имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету сертификатов CA, который может быть использован для проверки SSL запросов API. псевдонимы: cacert
client_cert строка		Путь к клиенту сертификату для использования в рамках SSL транзакции. псевдонимы: cert
client_key строка		Путь к ключу клиента для использования в рамках SSL транзакции. псевдонимы: key
cloud необработанные данные		Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
interface строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type
name строка / требуется		Имя, которое должно быть задано для пары ключей
public_key строка		Открытый ключ, который будет загружен в nova и внедрен в виртуальные машины при их создании.
public_key_file строка		Путь к локальному файлу, содержащему открытый ключ ssh. Взаимоисключительно с public_key.
region_name строка		Имя региона.
state строка	Варианты: present ← absent replace	Должен ли ресурс быть присутствующим или отсутствующим. Если state равен replace, и ключ существует, но имеет другое содержимое, он будет удалён и пересоздан с новым содержимым.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должен ждать запрошенного ресурса.
validate_certs логическое значение	Варианты: нет ← да	Должны ли проверяться SSL запросы API. До Ansible 2.3 по умолчанию было `yes`. псевдонимы: verify
wait логическое значение	Варианты: нет да ←	Должен ли Ansible ждать, пока запрошенный ресурс не будет завершен.

Примечания

Примечание

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

Примеры

# Creates a key pair with the running users public key
- openstack.cloud.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.
- openstack.cloud.keypair:
      cloud: rax-dfw
      state: present
      name: ansible_key

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
id строка	успех	Уникальный UUID.
name строка	успех	Имя, заданное для пары ключей.
private_key строка	Только при генерации пары ключей для пользователя (например, при создании, когда открытый ключ не указан).	Значение закрытого ключа для пары ключей.
public_key строка	успех	Значение открытого ключа для пары ключей.

Авторы

OpenStack Ansible SIG

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