ngine_io.vultr.vultr_ssh_key_info – Получение информации о доступных ключах SSH Vultr.
Примечание
Этот плагин является частью коллекции ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в playbook укажите: ngine_io.vultr.vultr_ssh_key_info.
Новое в версии 0.1.0: плагина ngine_io.vultr
Обзор
- Получение информации о доступных ключах 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 целое число | Задержка экспоненциального возврата при повторных попытках в секундах до этого максимального значения. Переменная среды 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
ngine_io.vultr.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 целое число | успешно | Задержка экспоненциального возврата в секундах между повторными попытками до этого максимального значения. Пример: 12 | |
| api_timeout целое число | успешно | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_ssh_key_info сложный | успешно | Ответ от Vultr API в виде списка | |
| date_created строка | успешно | Дата создания ключа ssh Пример: 2017-08-26 12:47:48 | |
| id строка | успешно | ID ключа ssh Пример: 5904bc6ed9234 | |
| name строка | успешно | Имя ключа ssh Пример: мой ключ ssh | |
| ssh_key строка | успешно | Открытый ключ SSH Пример: ssh-rsa AA... someother@example.com | |
Авторы
- Yanis Guenane (@Spredzy)
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_ssh_key_info_module.html
