os_server_action – Выполнение действий над виртуальными машинами OpenStack
Описание
- Выполнение действий над существующей виртуальной машиной OpenStack. Этот модуль не возвращает никаких данных, кроме true/false, указывающих на изменение. При action = ‘rebuild’ параметр image является обязательным.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action - |
"present" | Выполнение заданного действия. Действия lock и unlock всегда возвращают changed, так как API сервера не предоставляет статус блокировки. |
| api_timeout integer | Время ожидания сокета при вызове API перед истечением срока ожидания. Если этот параметр опущен, к библиотеке запросов ничего не будет передано. | |
| auth dictionary | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменных зонах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type string | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert string | Путь к пакету сертификатов CA, который можно использовать для проверки запросов SSL API. псевдонимы: cacert | |
| client_cert string | Путь к клиенту сертификату для использования в рамках транзакции SSL. псевдонимы: cert | |
| client_key string | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | |
| cloud raw | Именованное облако или конфигурация облака для работы с ним. Если cloud является строкой, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| image - | Изображение, с которым должна быть перестроена виртуальная машина | |
| interface string |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| region_name string | Имя региона. | |
| server - / обязательный | Имя или идентификатор виртуальной машины | |
| timeout integer | Значение по умолчанию: 180 | Время, которое модуль должен ждать, пока виртуальная машина выполнит запрашиваемое действие. |
| validate_certs boolean |
| Требуется ли проверка запросов SSL API. Перед Ansible 2.3 это имело значение yes. псевдонимы: verify |
| wait boolean |
| Должен ли модуль ждать выполнения действия виртуальной машины. |
Примечания
Примечание
- Стандартные переменные окружения OpenStack, такие как
OS_USERNAME, могут быть использованы вместо явных значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных окружения, и наконец, явных параметров в заданиях. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# 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]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/os_server_action_module.html
