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 |
| Тип URL конечной точки для получения из каталога служб. алиасы: endpoint_type |
| key - | Путь к клиенту ключу для использования в транзакции SSL. | |
| name - / обязательно | Имя, которое должно быть присвоено паре ключей | |
| public_key - | Открытый ключ, который будет загружен в nova и внедрён в виртуальные машины при их создании. | |
| public_key_file - | Путь к локальному файлу, содержащему открытый ключ SSH. Взаимоисключающий с public_key. | |
| region_name - | Имя региона. | |
| state - |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout - | По умолчанию: 180 | Сколько времени Ansible будет ждать запрашиваемого ресурса. |
| verify boolean |
| Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. алиасы: validate_certs |
| wait boolean |
| Должен ли 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 строка | успех | Значение открытого ключа для пары ключей. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/os_keypair_module.html
