os_server_action - Выполнение действий над вычислительными экземплярами OpenStack
Новое в версии 2.0.
Описание
- Выполнение действий над существующим вычислительным экземпляром OpenStack. Этот модуль не возвращает никаких данных, кроме значений true/false, указывающих на изменения. При action равном ‘rebuild’, параметр image обязателен.
Псевдонимы: os_server_actions
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- python >= 2.7
- python-novaclient
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action |
present | Выполнение указанного действия. Действия lock и unlock всегда возвращают changed, так как API серверов не предоставляет статус блокировки. |
| api_timeout | Время ожидания сокетом перед истечением срока действия API-вызовов. Если этот параметр опущен, в библиотеку requests ничего не будет передано. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля аутентификации облака. Для стандартного подключаемого модуля password это будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type | Имя подключаемого модуля аутентификации для использования. Если облако использует что-то другое, кроме аутентификации по паролю, имя подключаемого модуля следует указать здесь, а содержимое параметра auth следует обновить соответствующим образом. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который можно использовать для проверки SSL-API-запросов. | |
| cert | Путь к клиенту сертификат для использования в рамках SSL-транзакции. | |
| cloud | Именованное облако или конфигурация облака для работы с ним. Если cloud — строка, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| image (добавлено в 2.3) | Значение по умолчанию: None | Образ, с которым должен быть перестроен сервер |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках SSL-транзакции. | |
| region_name | Имя региона. | |
| server обязательно | Имя или идентификатор экземпляра | |
| timeout | Значение по умолчанию: 180 | Время, которое модуль должен ждать, пока экземпляр выполнит запрашиваемое действие. |
| verify |
| Необходимо ли проверять SSL-API-запросы. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait |
| Если модуль должен ждать выполнения действия над экземпляром. |
Примечания
Примечание
- Могут быть использованы стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут браться из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, явных параметров в задачах. Более подробную информацию можно найти на http://docs.openstack.org/developer/os-client-config
Примеры
# Pauses a compute instance
- os_server_action:
action: pause
auth:
auth_url: https://identity.example.com
username: admin
password: admin
project_name: admin
server: vm1
timeout: 200
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Jesse Keating (@j2sol)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/os_server_action_module.html
