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

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.13.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 строка	URL конечной точки API (без конечного слэша). Переменная окружения по умолчанию `VULTR_API_ENDPOINT`. Значение по умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API Vultr API. Переменная окружения по умолчанию `VULTR_API_KEY`.
api_retries целое число	Количество попыток повторного подключения в случае, если API Vultr возвращает HTTP-код ошибки, например: - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Время ожидания шлюза истекло Переменная окружения по умолчанию `VULTR_API_RETRIES`. Значение по умолчанию: `5`
api_retry_max_delay целое число	Задержка экспоненциального повышения повторного подключения в секундах до максимального значения. Переменная окружения по умолчанию `VULTR_API_RETRY_MAX_DELAY`. Значение по умолчанию: `12`
api_timeout целое число	Таймаут HTTP для Vultr API. Переменная окружения по умолчанию `VULTR_API_TIMEOUT`. Значение по умолчанию: `180`
validate_certs логическое значение	Проверка 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

END_OF_DOCUMENT_MARKER

Значения возврата

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

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

Авторы

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

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

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