Модуль vultr.cloud.ssh_key — управление ключами SSH в Vultr.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install vultr.cloud.

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

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

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

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

Создание, обновление и удаление ключей SSH.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательный	Ключ API Vultr. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page integer добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться при каждом обращении к API. Этот параметр не определяет общее количество возвращаемых результатов; все ресурсы возвращаются с учётом других фильтров. Максимальное значение для API Vultr — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries integer	Количество повторных попыток в случае, если API Vultr возвращает код ошибки 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-запроса к API Vultr. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
name string / обязательный	Имя ключа SSH.
ssh_key string	Открытый ключ SSH. Обязательный параметр, если `state=present`.
state string	Состояние ключа SSH. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять сертификаты SSL API Vultr. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: ensure an SSH key is present
  vultr.cloud.ssh_key:
    name: my ssh key
    ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"

- name: ensure an SSH key is absent
  vultr.cloud.ssh_key:
    name: my ssh key
    state: absent

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

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

Ключ	Описание
vultr_api dictionary	Ответ API Vultr с несколькими дополнениями и изменениями. Возвращается: при успешном выполнении
api_endpoint string	Конечная точка, использованная для запросов к API. Возвращается: при успешном выполнении Пример: `"https://api.vultr.com/v2"`
api_results_per_page integer	Количество результатов, возвращаемых при каждом обращении к API. Возвращается: при успешном выполнении Пример: `100`
api_retries integer	Максимальное количество повторных попыток запросов к API. Возвращается: при успешном выполнении Пример: `5`
api_retry_max_delay integer	Максимальная задержка в секундах между повторными попытками при экспоненциальном увеличении интервала. Возвращается: при успешном выполнении Пример: `12`
api_timeout integer	Тайм-аут, используемый для запросов к API. Возвращается: при успешном выполнении Пример: `60`
vultr_ssh_key dictionary	Ответ API Vultr. Возвращается: при успешном выполнении
date_created string	Дата создания ключа SSH. Возвращается: при успешном выполнении Пример: `"2020-10-10T01:56:20+00:00"`
id string	Идентификатор ключа SSH. Возвращается: при успешном выполнении Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
name string	Имя ключа SSH. Возвращается: при успешном выполнении Пример: `"my ssh key"`
ssh_key string	Открытый ключ SSH. Возвращается: при успешном выполнении Пример: `"ssh-rsa AA... someother@example.com"`

Авторы

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_module.html