ngine_io.vultr.vultr_ssh_key – Управляет ключами SSH на Vultr.
Примечание
Этот плагин входит в состав коллекции ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в playbook укажите: ngine_io.vultr.vultr_ssh_key.
Введено в версии 0.1.0: модуля ngine_io.vultr
Обзор
- Создание, обновление и удаление ключей SSH.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 целое число | Задержка повторных попыток в секундах экспоненциально увеличивается до этого максимального значения. Переменная среды 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
ngine_io.vultr.vultr_ssh_key:
name: my ssh key
ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
- name: ensure an SSH key is absent
ngine_io.vultr.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 целое число | 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 | ID ключа 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.10/collections/ngine_io/vultr/vultr_ssh_key_module.html
