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 bool |
| Проверять 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 сложный | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| api_retries целое число | успех | Максимальное количество попыток повторной обработки для запросов API Пример: 5 | |
| api_endpoint строка | успех | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| vultr_startup_script сложный | успех | Ответ от Vultr API | |
| id строка | успех | ID скрипта запуска. Пример: 249395 | |
| name строка | успех | Имя скрипта запуска. Пример: мой скрипт запуска | |
| script строка | успех | Исходный код скрипта запуска. Пример: #!/bin/bash echo Hello World > /root/hello | |
| script_type строка | успех | Тип скрипта запуска. Пример: pxe | |
| date_created строка | успех | Дата создания скрипта запуска. Пример: 2017-08-26 12:47:48 | |
| date_modified строка | успех | Дата изменения скрипта запуска. Пример: 2017-08-26 12:47:48 | |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется как обратная совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. в Поддержка модулей и техническое обслуживание.
Список других модулей, также поддерживаемых сообществом Ansible, см. в здесь.
Автор
- 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.6/modules/vr_startup_script_module.html
