os_server_action – Выполнение действий над виртуальными машинами из OpenStack
Новое в версии 2.0.
Обзор
- Выполнение действий над виртуальной машиной из OpenStack. Данный модуль не возвращает никаких данных, кроме значений true/false, указывающих на изменения. Если действие равно ‘rebuild’, то параметр image обязателен.
Псевдонимы: os_server_actions
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| действие - |
"present" | Выполнение заданного действия. Действия lock и unlock всегда возвращают changed, так как API сервера не предоставляет состояние lock. |
| api_timeout - | Время ожидания сокета при таймауте API-запросов. Если этот параметр опущен, то он не будет передан библиотеке requests. | |
| auth - | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля аутентификации облака. Для модуля аутентификации по паролю (по умолчанию) он должен содержать auth_url, username, password, project_name и любые сведения о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не требуется, если задан параметр cloud или присутствуют переменные среды OpenStack OS_*. | |
| auth_type - | Имя подключаемого модуля аутентификации для использования. Если облако использует аутентификацию, отличную от аутентификации по паролю, то здесь должно быть указано имя подключаемого модуля, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| cacert - | Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. | |
| 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 boolean |
| Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| Должен ли модуль ждать выполнения действия над виртуальной машиной. |
Примечания
Примечание
- Могут использоваться стандартные переменные среды 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
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/os_server_action_module.html
