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

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

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Обслуживание
- Автор

Описание

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

Требования

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

python >= 2.7
openstacksdk

Параметры

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

Примечания

Примечание

Могут использоваться стандартные переменные среды 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

Примеры

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

Статус

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

Обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Поддержка и обслуживание модулей для получения дополнительной информации.

Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.

Автор

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.6/modules/os_keypair_module.html