os_server_action – Выполнение действий над виртуальными машинами OpenStack
Новая в версии 2.0.
Обзор
- Выполнение действий над существующей виртуальной машиной OpenStack. Модуль возвращает только значения true/false, указывающие на изменение состояния. Если action равен ‘rebuild’, то параметр image обязателен.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться данный модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action - |
"present" | Выполнение заданного действия. Действия lock и unlock всегда возвращают changed, так как API серверов не предоставляет статус блокировки. |
| api_timeout integer | Время ожидания сокета до истечения срока ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| 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 - добавлено в 2.3 | Образ, с которым должна быть перестроена виртуальная машина | |
| interface string добавлено в 2.3 |
| Тип 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
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/os_server_action_module.html
