Модуль vultr.cloud.ssh_key — Управление ключами SSH на Vultr.

Примечание

Этот модуль является частью коллекции vultr.cloud (версия 1.13.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install vultr.cloud.

Чтобы использовать его в playbook, укажите: vultr.cloud.ssh_key.

Добавлен в vultr.cloud 1.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Создание, обновление и удаление ключей SSH.

Параметры

Параметр	Комментарии
api_endpoint строка	URL конечной точки API (без заключительного слэша). Переменная среды по умолчанию `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API Vultr API. Переменная среды по умолчанию `VULTR_API_KEY`.
api_retries целое число	Количество попыток повторного выполнения в случае, если API Vultr возвращает HTTP код ошибки, такой как - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Время ожидания шлюза Переменная среды по умолчанию `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка отката при повторном выполнении в секундах, экспоненциально возрастающая до максимального значения. Переменная среды по умолчанию `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Таймаут HTTP запроса к API Vultr. Переменная среды по умолчанию `VULTR_API_TIMEOUT`. По умолчанию: `180`
name строка / обязательно	Имя ключа SSH.
ssh_key строка	Открытый ключ SSH. Обязательно, если `state=present`.
state строка	Состояние ключа SSH. Доступные значения: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое значение	Проверять SSL сертификаты API Vultr. Доступные значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Также см. документацию API по адресу https://www.vultr.com/api/.

Примеры

- name: ensure an SSH key is present
  vultr.cloud.ssh_key:
    name: my ssh key
    ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"

- name: ensure an SSH key is absent
  vultr.cloud.ssh_key:
    name: my ssh key
    state: absent

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
vultr_api словарь	Ответ от API Vultr с некоторыми дополнениями/модификациями. Возвращено: успех
api_endpoint строка	Точка входа, используемая для запросов API. Возвращено: успех Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Максимальное количество попыток повторных запросов к API. Возвращено: успех Пример: `5`
api_retry_max_delay целое число	Экспоненциальная задержка обратного отсчета в секундах между повторами до этой максимальной задержки. Возвращено: успех Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращено: успех Пример: `60`
vultr_ssh_key словарь	Ответ от API Vultr. Возвращено: успех
date_created строка	Дата создания ключа ssh. Возвращено: успех Пример: `"2020-10-10T01:56:20+00:00"`
id строка	Идентификатор ключа ssh. Возвращено: успех Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
name строка	Имя ключа ssh. Возвращено: успех Пример: `"my ssh key"`
ssh_key строка	Открытый ключ SSH. Возвращено: успех Пример: `"ssh-rsa AA... someother@example.com"`

Авторы

René Moser (@resmo)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/ssh_key_module.html