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_retry_max_delay целое число добавлен в 2.9 | Задержка повторного выполнения в секундах экспоненциально возрастает до этого максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 12 секунд. | |
| 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
vultr_ssh_key:
name: my ssh key
ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
- name: ensure an SSH key is absent
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_retry_max_delay целое число добавлен в 2.9 | success | Экспоненциальная задержка повторного выполнения в секундах между попытками до этого максимального значения задержки. Пример: 12 | |
| 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. [сообщество]
Авторы
- 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.9/modules/vultr_ssh_key_module.html
