vultr_ssh_key_facts – Сбор фактов о ключах SSH Vultr
Новое в версии 2.7.
УСТАРЕЛО
| Удалено в Ansible: | |
|---|---|
| версия: 2.12 | |
| Почему: | Преобразовано в модуль информации. |
| Альтернатива: | Используйте vultr_ssh_key_info вместо этого. |
Описание
- Сбор фактов о доступных ключах 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
целое число
добавлено в 2.9
|
Задержка повторной отправки в секундах экспоненциально возрастает до этого максимального значения.
Переменная среды
VULTR_API_RETRY_MAX_DELAY используется по умолчанию, если она определена.Значение по умолчанию — 12 секунд.
|
|
| api_timeout
целое число
|
Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано. |
|
| validate_certs
логическое значение
|
|
Проверка SSL-сертификатов Vultr API. |
Примечания
Примечание
- Также см. документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: Gather Vultr SSH keys facts
local_action:
module: vultr_ssh_key_facts
- name: Print the gathered facts
debug:
var: ansible_facts.vultr_ssh_key_facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращено | Описание | |
|---|---|---|---|
| vultr_api
сложный тип
|
успех |
Ответ от Vultr API с некоторыми дополнениями/изменениями
|
|
| api_account
строка
|
успех |
Аккаунт, использованный в файле ini для выбора ключа
Пример:
default
|
|
| api_endpoint
строка
|
успех | Эндпоинт, используемый для запросов API Пример: https://api.vultr.com |
|
| api_retries
целое число
|
успех | Максимальное количество повторных попыток для запросов API Пример: 5 |
|
| api_retry_max_delay
целое число
добавлено в 2.9
|
успех | Задержка экспоненциального уменьшения в секундах между повторными попытками до этого максимального значения задержки. Пример: 12 |
|
| api_timeout
целое число
|
успех | Таймаут, используемый для запросов API Пример: 60 |
|
Статус
- Этот модуль будет удален в версии 2.12. [устарело]
- Для получения дополнительной информации см. УСТАРЕЛО.
Авторы
- Yanis Guenane (@Spredzy)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_facts_module.html