os_server_action - Выполнение действий над виртуальными машинами из OpenStack
Новое в версии 2.0.
Описание
- Выполнение действий над существующей виртуальной машиной из OpenStack. Этот модуль не возвращает никаких данных, кроме true/false, указывающих на изменение состояния. Когда действие равно ‘rebuild’, параметр image обязателен.
Псевдонимы: os_server_actions
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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) | Образ, с которым должна быть перестроена виртуальная машина | |
| interface (добавлен в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| key | Путь к ключу клиента, который необходимо использовать в рамках SSL-транзакции. | |
| region_name | Имя региона. | |
| server обязательно | Имя или идентификатор виртуальной машины | |
| timeout | Значение по умолчанию: 180 | Время ожидания модулем выполнения виртуальной машиной запрошенного действия. |
| verify bool |
| Проверка SSL-API-запросов. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| Если модуль должен ждать выполнения действия над виртуальной машиной. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения 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
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Jesse Keating (@omgjlk)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/os_server_action_module.html
