Модуль vultr.cloud.ssh_key_info — получение информации о ключах SSH Vultr

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install vultr.cloud.

Чтобы использовать её в плейбуке, укажите: vultr.cloud.ssh_key_info.

Добавлено в vultr.cloud 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Получение информации о доступных ключах SSH.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без завершающей косой черты). Резервная переменная среды `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательный	Ключ API для Vultr API. Резервная переменная среды `VULTR_API_KEY`.
api_results_per_page integer добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов следует возвращать за один вызов API. Этот параметр не определяет общее количество возвращаемых результатов: возвращаются все ресурсы, соответствующие другим фильтрам. Максимальное значение для Vultr API — 500. Резервная переменная среды `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries integer	Количество повторных попыток в случае, если Vultr API возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out. Резервная переменная среды `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay integer	Задержка между повторными попытками увеличивается экспоненциально и ограничивается этим максимальным значением в секундах. Резервная переменная среды `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout integer	Тайм-аут HTTP-запросов к Vultr API. Резервная переменная среды `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs boolean	Проверять SSL-сертификаты Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

См. также документацию API на странице https://www.vultr.com/api/.

Примеры

- name: Get Vultr SSH keys infos
  vultr.cloud.ssh_key_info:
  register: result

- name: Print the infos
  ansible.builtin.debug:
    var: result.vultr_ssh_key_info

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
vultr_api dictionary	Ответ Vultr API с некоторыми дополнениями и изменениями. Возвращается: success
api_endpoint string	Конечная точка, использованная для запросов API. Возвращается: success Пример: `"https://api.vultr.com/v2"`
api_results_per_page integer	Количество результатов, возвращаемых за один вызов API. Возвращается: success Пример: `100`
api_retries integer	Максимальное количество повторных попыток запросов API. Возвращается: success Пример: `5`
api_retry_max_delay integer	Максимальная задержка в секундах между повторными попытками при экспоненциальном увеличении интервала. Возвращается: success Пример: `12`
api_timeout integer	Тайм-аут, используемый для запросов API. Возвращается: success Пример: `60`
vultr_ssh_key_info list / elements=string	Ответ Vultr API в виде списка. Возвращается: success
date_created string	Дата создания ключа SSH. Возвращается: success Пример: `"2021-11-07T05:57:59-05:00"`
id string	Идентификатор ключа SSH. Возвращается: success Пример: `"7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"`
name string	Имя ключа SSH. Возвращается: success Пример: `"my ssh key"`
ssh_key string	Открытый ключ SSH. Возвращается: success Пример: `"ssh-rsa AA... someother@example.com"`

Авторы

Yanis Guenane (@Spredzy)
René Moser (@resmo)

Ссылки на коллекцию

© 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/vultr/cloud/ssh_key_info_module.html