Модуль openstack.cloud.keypair — добавление/удаление пары ключей в OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.keypair.
Краткое описание
- Добавление или удаление пары ключей в OpenStack
Требования
Следующие требования необходимы на узле, который выполняет этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Описание |
|---|---|
api_timeout integer | Сколько времени уровень сокетов должен ожидать ответа перед истечением времени ожидания вызовов API. Если параметр не указан, в библиотеку requests ничего не передаётся. |
auth dictionary | Словарь с данными аутентификации, необходимыми для выбранной стратегии плагина аутентификации облака. Для плагина password, используемого по умолчанию, здесь указываются auth_url, username, password, project_name и любые сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все необходимые им параметры. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина и соответствующим образом обновить содержимое параметра auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому при SSL-соединении. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому при SSL-соединении. |
cloud any | Именованное облако или конфигурация облака, с которой будет выполняться работа. Если cloud — строка, она указывает на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
name string / обязательный | Имя, присваиваемое паре ключей |
public_key string | Открытый ключ, который будет загружен в Nova и внедрён в виртуальные машины при их создании. |
public_key_file string | Путь к локальному файлу с открытым ключом SSH. Не может использоваться одновременно с public_key. |
region_name string | Название региона. |
sdk_log_level string | Уровень журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если не задан, журнал не записывается. |
state string | Должен ли ресурс присутствовать или отсутствовать. Если для state задано значение replace и ключ существует, но его содержимое отличается, удалите его и создайте заново с новым содержимым. Варианты:
|
timeout integer | Сколько времени Ansible должен ожидать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы API SSL. До Ansible 2.3 значение по умолчанию было Варианты:
|
wait boolean | Должен ли 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
keypair dictionary | Словарь с описанием пары ключей. Возвращается: При успешном выполнении, если state имеет значение ‘present’ |
|
created_at string |
Дата создания пары ключей Возвращается: при успешном выполнении |
|
fingerprint string |
Короткий отпечаток, связанный с открытым ключом public_key этой пары ключей. Возвращается: при успешном выполнении |
|
id string |
Уникальный UUID. Возвращается: при успешном выполнении |
|
is_deleted boolean |
Удалена ли пара ключей Возвращается: при успешном выполнении |
|
name string |
Имя, присвоенное паре ключей. Возвращается: при успешном выполнении |
|
private_key string |
Значение закрытого ключа пары ключей. Возвращается: Только если пара ключей создана для пользователя (например, при её создании, если открытый ключ не указан). |
|
public_key string |
Значение открытого ключа пары ключей. Возвращается: при успешном выполнении |
|
type string |
Тип пары ключей Возвращается: при успешном выполнении |
|
user_id string |
Идентификатор пользователя, которому принадлежит пара ключей Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/keypair_module.html
