vultr_ssh_key – Управление ключами ssh на Vultr
Новое в версии 2.5.
Описание
- Создание, обновление и удаление ключей ssh.
Псевдонимы: vr_ssh_key
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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_timeout целое число | Таймаут HTTP-соединения с Vultr API. Переменная окружения VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано. | |
| 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: vultr_ssh_key
name: my ssh key
ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
- name: ensure an SSH key is absent
local_action:
module: vultr_ssh_key
name: my ssh key
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращено | Описание | |
|---|---|---|---|
| vultr_api сложный тип | success | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | success | Аккаунт, использованный в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | success | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | success | Максимальное количество попыток повторного выполнения запросов API Пример: 5 | |
| api_timeout целое число | success | Таймаут, используемый для запросов API Пример: 60 | |
| 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 | |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/vultr_ssh_key_module.html
