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

Новая версия 2.9.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором будет выполняться данный модуль.

python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_account строка	Значение по умолчанию: "default"	Имя раздела ini в файле `vultr.ini`. Переменная среды `VULTR_API_ACCOUNT` используется в качестве значения по умолчанию, если она определена.
api_endpoint строка		URL конечной точки API (без заключительного слэша). Переменная среды `VULTR_API_ENDPOINT` используется в качестве значения по умолчанию, если она определена. Значение по умолчанию — https://api.vultr.com, если не указано.
api_key строка		Ключ API Vultr API. Переменная среды `VULTR_API_KEY` используется в качестве значения по умолчанию, если она определена.
api_retries целое число		Количество попыток повторного выполнения в случае, если Vultr API возвращает код HTTP 503. Переменная среды `VULTR_API_RETRIES` используется в качестве значения по умолчанию, если она определена. Значение по умолчанию — 5 попыток, если не указано.
api_retry_max_delay целое число добавлен в 2.9		Задержка отложенного повторного выполнения в секундах — экспоненциально возрастает до этого максимального значения в секундах. Переменная среды `VULTR_API_RETRY_MAX_DELAY` используется в качестве значения по умолчанию, если она определена. Значение по умолчанию — 12 секунд.
api_timeout целое число		Таймаут HTTP для Vultr API. Переменная среды `VULTR_API_TIMEOUT` используется в качестве значения по умолчанию, если она определена. Значение по умолчанию — 60 секунд, если не указано.
validate_certs булево	Варианты: нет да ←	Проверять SSL-сертификаты Vultr API.

Примечания

Примечание

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

Примеры

- name: Get Vultr SSH keys infos
  vultr_ssh_key_info:
  register: result

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

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

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

Ключ		Возвращаемое	Описание
vultr_api сложное		успех	Ответ от Vultr API с некоторыми дополнениями/изменениями
	api_account строка	успех	Аккаунт, используемый в файле ini для выбора ключа Пример: default
	api_endpoint строка	успех	Конечная точка, используемая для запросов API Пример: https://api.vultr.com
	api_retries целое число	успех	Максимальное количество повторных попыток для запросов API Пример: 5
	api_retry_max_delay целое число добавлен в 2.9	успех	Задержка экспоненциального отложенного повторного выполнения в секундах между повторными попытками до максимального значения задержки. Пример: 12
	api_timeout целое число	успех	Таймаут, используемый для запросов API Пример: 60
vultr_ssh_key_info сложное		успех	Ответ от Vultr API в виде списка
	date_created строка	успех	Дата создания ключа SSH Пример: 2017-08-26 12:47:48
	id строка	успех	Идентификатор ключа SSH Пример: 5904bc6ed9234
	name строка	успех	Имя ключа SSH Пример: мой ключ SSH
	ssh_key строка	успех	Открытый ключ SSH Пример: ssh-rsa AA... someother@example.com

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vultr_ssh_key_info_module.html