openstack.cloud.server_action – Выполнение действий с вычислительными экземплярами OpenStack
Примечание
Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в playbook, укажите: openstack.cloud.server_action.
Обзор
- Выполнение действий над сервером на существующем вычислительном экземпляре OpenStack. Этот модуль не возвращает никакие данные, кроме true/false, указывающих на изменение. Когда action равен ‘rebuild’, параметр image является обязательным.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action строка / обязательный |
| Выполнение указанного действия. Действия lock и unlock всегда возвращают changed, так как API серверов не предоставляет статус блокировки. |
| admin_password строка | Пароль администратора для перезагрузки сервера | |
| api_timeout целое число | Сколько времени уровень сокета должен ждать перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано библиотеке requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации, который нужно использовать. Если облако использует что-то помимо парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. Псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификат, который нужно использовать в рамках SSL-транзакции. Псевдонимы: cert | |
| client_key строка | Путь к ключу клиента, который нужно использовать в рамках SSL-транзакции. Псевдонимы: key | |
| cloud сырой | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| image строка | Изображение, с которым должен быть перестроен сервер | |
| interface строка |
| Тип URL конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type |
| region_name строка | Имя региона. | |
| server строка / обязательный | Имя или идентификатор экземпляра | |
| timeout целое число | По умолчанию: 180 | Время, в течение которого модуль должен ожидать, пока экземпляр выполнит запрошенное действие. |
| validate_certs булево |
| Нужно ли проверять запросы API SSL. Перед Ansible 2.3 это по умолчанию было yes.Псевдонимы: verify |
| wait булево |
| Если модуль должен ждать выполнения действия над экземпляром. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в playbooks. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Pauses a compute instance
- openstack.cloud.server_action:
action: pause
auth:
auth_url: https://identity.example.com
username: admin
password: admin
project_name: admin
server: vm1
timeout: 200
Авторы
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/server_action_module.html
