vr_ssh_key - Управляет ключами ssh на Vultr.
Новая версия 2.5.
Обзор
- Создание, обновление и удаление ключей ssh.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_account | По умолчанию: default | Имя раздела ini в файле vultr.ini. Переменная среды VULTR_API_ACCOUNT используется по умолчанию, если определена. |
| api_endpoint | По умолчанию: https://api.vultr.com | URL конечной точки API (без конечного слеша). Переменная среды VULTR_API_ENDPOINT используется по умолчанию, если определена. |
| api_key | Ключ API Vultr API. Переменная среды VULTR_API_KEY используется по умолчанию, если определена. | |
| api_retries | По умолчанию: 5 | Количество попыток повторного выполнения в случае, если Vultr API возвращает код HTTP 503. Переменная среды VULTR_API_RETRIES используется по умолчанию, если определена. |
| api_timeout | По умолчанию: 60 | Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется по умолчанию, если определена. |
| name обязательно | Имя ключа ssh. | |
| ssh_key | Открытый ключ SSH. Требуется, если state=present. | |
| state |
| Состояние ключа ssh. |
| validate_certs |
| Проверять SSL-сертификаты Vultr API. |
Примечания
Примечание
- Также см. документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: ensure an SSH key is present
local_action:
module: vr_ssh_key
name: my ssh key
ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
- name: ensure an SSH key is absent
local_action:
module: vr_ssh_key
name: my ssh key
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный | success | Ответ от Vultr API с некоторыми дополнениями/изменениями. | |
| api_endpoint строка | success | Конечная точка, используемая для запросов API. Пример: https://api.vultr.com | |
| api_timeout целое число | success | Таймаут, используемый для запросов API. Пример: 60 | |
| api_retries целое число | success | Максимальное количество попыток повторного выполнения запросов API. Пример: 5 | |
| api_account строка | success | Аккаунт, используемый в файле ini для выбора ключа. Пример: default | |
| vultr_ssh_key сложный | success | Ответ от Vultr API. | |
| date_created строка | success | Дата создания ключа ssh. Пример: 2017-08-26 12:47:48 | |
| id строка | success | Идентификатор ключа ssh. Пример: 5904bc6ed9234 | |
| name строка | success | Имя ключа ssh. Пример: мой ключ ssh | |
| ssh_key строка | success | Открытый ключ SSH. Пример: ssh-rsa AA... someother@example.com | |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.
Автор
- 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.5/modules/vr_ssh_key_module.html
