vultr_server_facts – Сбор фактов о доступных серверах Vultr
Новая в версии 2.7.
УСТЕРЕЛО
| Удалено в Ansible: | |
|---|---|
| версия: 2.13 | |
| Почему: | Заменено на модуль _info . |
| Альтернатива: | Используйте vultr_server_info вместо этого. |
Описание
- Сбор фактов о доступных серверах.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- 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 servers facts
local_action:
module: vultr_server_facts
- name: Print the gathered facts
debug:
var: ansible_facts.vultr_server_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 | |
| vultr_server_facts сложный | успех | Ответ от Vultr API Пример: {'vultr_server_facts': [{'allowed_bandwidth_gb': 1000, 'auto_backup_enabled': False, 'application': None, 'cost_per_month': 5.0, 'current_bandwidth_gb': 0, 'date_created': '2018-07-19 08:23:03', 'default_password': 'p4ssw0rd!', 'disk': 'Virtual 25 GB', 'firewallgroup': None, 'id': 17241096, 'internal_ip': '', 'kvm_url': 'https://my.vultr.com/subs/vps/novnc/api.php?data=OFB...', 'name': 'ansibletest', 'os': 'CentOS 7 x64', 'pending_charges': 0.01, 'plan': '1024 MB RAM,25 GB SSD,1.00 TB BW', 'power_status': 'running', 'ram': '1024 MB', 'region': 'Амстердам', 'server_state': 'ok', 'status': 'active', 'tag': '', 'v4_gateway': '105.178.158.1', 'v4_main_ip': '105.178.158.181', 'v4_netmask': '255.255.254.0', 'v6_main_ip': '', 'v6_network': '', 'v6_network_size': '', 'v6_networks': [], 'vcpu_count': 1}]} | |
Статус
- Этот модуль будет удален в версии 2.13. [устарел]
- Для получения дополнительной информации см. УСТЕРЕЛО.
Авторы
- 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_server_facts_module.html