os_keypair – Добавление/удаление пары ключей из OpenStack
Описание
- Добавление или удаление пары ключей из OpenStack
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- openstacksdk >= 0.12.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должен ждать слой сокетов перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку запросов. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина password по умолчанию он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_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 строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| name - / обязательно | Имя, которое должно быть присвоено паре ключей | |
| public_key - | Открытый ключ, который будет загружен в nova и введён в виртуальные машины при их создании. | |
| public_key_file - | Путь к локальному файлу, содержащему открытый ключ ssh. Взаимоисключающее с public_key. | |
| region_name строка | Имя региона. | |
| state - |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должен ждать требуемый ресурс. |
| validate_certs логическое значение |
| Необходимо ли проверять запросы API SSL. До 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
- 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. [сообщество]
Авторы
- 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.9/modules/os_keypair_module.html
