ngine_io.vultr.vultr_startup_script – Управление скриптами запуска на Vultr.
Примечание
Этот плагин является частью коллекции ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в книге задач укажите: ngine_io.vultr.vultr_startup_script.
Новое в версии 0.1.0: модуля ngine_io.vultr
Обзор
- Создание, обновление и удаление скриптов запуска.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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 целое число | Задержка экспоненциального возврата при повторных попытках в секундах до этого максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 12 секунд. | |
| api_timeout целое число | Таймаут HTTP-запроса к Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 60 секунд, если не указано. | |
| 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
ngine_io.vultr.vultr_startup_script:
name: my_web_script
script_type: pxe
script: "{{ lookup('file', 'path/to/script') }}"
- name: ensure a boot script exists
ngine_io.vultr.vultr_startup_script:
name: vultr_startup_script
script: "#!/bin/bash\necho Hello World > /root/hello"
- name: ensure a script is absent
ngine_io.vultr.vultr_startup_script:
name: my_web_script
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный тип | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Максимальное количество повторных попыток для запросов API Пример: 5 | |
| api_retry_max_delay целое число | успех | Задержка экспоненциального возврата в секундах между повторными попытками до этого максимального значения задержки. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_startup_script сложный тип | успех | Ответ от Vultr API | |
| date_created строка | успех | Дата создания скрипта запуска. Пример: 2017-08-26 12:47:48 | |
| date_modified строка | успех | Дата изменения скрипта запуска. Пример: 2017-08-26 12:47:48 | |
| id строка | успех | ID скрипта запуска. Пример: 249395 | |
| name строка | успех | Имя скрипта запуска. Пример: мой скрипт запуска | |
| script строка | успех | Исходный код скрипта запуска. Пример: #!/bin/bash echo Hello World > /root/hello | |
| script_type строка | успех | Тип скрипта запуска. Пример: 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.10/collections/ngine_io/vultr/vultr_startup_script_module.html
