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 bool |
| Проверять 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 complex | success | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | success | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_timeout целое число | success | Таймаут, используемый для запросов API Пример: 60 | |
| api_retries целое число | success | Максимальное количество попыток повтора для запросов API Пример: 5 | |
| api_endpoint строка | success | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| vultr_ssh_key complex | success | Ответ от Vultr API | |
| id строка | success | ID ключа SSH Пример: 5904bc6ed9234 | |
| name строка | success | Имя ключа SSH Пример: мой ключ ssh | |
| date_created строка | success | Дата создания ключа SSH Пример: 2017-08-26 12:47:48 | |
| ssh_key строка | success | Открытый ключ SSH Пример: ssh-rsa AA... someother@example.com | |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. в разделе здесь.
Автор
- 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.6/modules/vr_ssh_key_module.html
