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

Примечание

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

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

Для использования в книге задач укажите: openstack.cloud.os_keypair.

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

Описание

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

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать подсистема сокетов, прежде чем произойдёт таймаут вызовов API. Если этот параметр опущен, он не будет передан библиотеке запросов.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые данному плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина следует указать здесь, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. псевдонимы: 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 логический тип	Варианты: no ← yes	Нужно ли проверять запросы API SSL. До Ansible 2.3 это имело значение по умолчанию `yes`. псевдонимы: verify
wait логический тип	Варианты: no yes ←	Должен ли 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/os_keypair_module.html