vr_startup_script - Управляет скриптами запуска на Vultr.
Новая версия с 2.5.
Обзор
- Создать, обновить и удалить скрипты запуска.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_account | По умолчанию: default | Имя раздела ini в файле vultr.ini.Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если она определена. |
| api_endpoint | По умолчанию: https://api.vultr.com | URL конечной точки API (без конечного слэша). Переменная среды VULTR_API_ENDPOINT используется в качестве значения по умолчанию, если она определена. |
| api_key | Ключ API Vultr API. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries | По умолчанию: 5 | Количество попыток повторного выполнения в случае, если Vultr API возвращает код HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена. |
| api_timeout | По умолчанию: 60 | Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена. |
| name обязательно | Имя скрипта. | |
| script | Исходный код скрипта. Требуется, если (state=present). | |
| script_type |
| Тип скрипта, который нельзя изменить после создания. псевдонимы: type |
| state |
| Состояние скрипта. |
| validate_certs |
| Проверять SSL-сертификаты Vultr API. |
Примечания
Примечание
- См. также документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: ensure a pxe script exists, source from a file
local_action:
module: vr_startup_script
name: my_web_script
script_type: pxe
script: "{{ lookup('file', 'path/to/script') }}"
- name: ensure a boot script exists
local_action:
module: vr_startup_script
name: vr_startup_script
script: "#!/bin/bash\necho Hello World > /root/hello"
- name: ensure a script is absent
local_action:
module: vr_startup_script
name: my_web_script
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| vultr_api сложное | success | Ответ от Vultr API с несколькими дополнениями/изменениями | |
| api_endpoint строка | success | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_timeout целое число | success | Таймаут, используемый для запросов API Пример: 60 | |
| api_retries целое число | success | Максимальное количество попыток повторного выполнения запросов API Пример: 5 | |
| api_account строка | success | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| vultr_startup_script сложное | success | Ответ от Vultr API | |
| name строка | success | Имя скрипта запуска. Пример: мой скрипт запуска | |
| date_modified строка | success | Дата последнего изменения скрипта запуска. Пример: 2017-08-26 12:47:48 | |
| date_created строка | success | Дата создания скрипта запуска. Пример: 2017-08-26 12:47:48 | |
| script строка | success | Исходный код скрипта запуска. Пример: #!/bin/bash echo Hello World > /root/hello | |
| id строка | success | Идентификатор скрипта запуска. Пример: 249395 | |
| script_type строка | success | Тип скрипта запуска. Пример: pxe | |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- 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.5/modules/vr_startup_script_module.html
