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