os_server_action - Выполнение действий над виртуальными машинами OpenStack

Новая версия 2.0.

Описание
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Примечания
- Статус

Описание

Выполнение действий над существующей виртуальной машиной OpenStack. Данный модуль не возвращает никаких данных, кроме значений true/false, указывающих на изменение состояния. Когда action равен ‘rebuild’, то параметр image является обязательным.

Требования (к хосту, на котором выполняется модуль)

python >= 2.6
python >= 2.7
python-novaclient
shade

Параметры

параметр	обязательный	значение по умолчанию	выбор	комментарии
action	нет	присутствует	stop start pause unpause lock unlock suspend resume rebuild	Выполняет заданное действие. Действия lock и unlock всегда возвращают changed, так как API сервера не предоставляет информацию о статусе блокировки.
api_timeout	нет	None		Время ожидания сокетом при вызове API. Если этот параметр опущен, он не передается библиотеке requests.
auth	нет			Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любые данные о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые для них параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type	нет	password		Имя подключаемого модуля авторизации. Если облако использует что-то другое, помимо парольной авторизации, то здесь нужно указать имя подключаемого модуля, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone	нет			Игнорируется. Присутствует для совместимости со старыми версиями.
cacert	нет	None		Путь к пакету CA Cert, который может быть использован для проверки запросов SSL к API.
cert	нет	None		Путь к клиенту сертификату, который нужно использовать в рамках транзакции SSL.
cloud	нет			Имя облака, к которому нужно обратиться. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_*.
endpoint_type	нет	public	public internal admin	Тип URL конечной точки для получения из каталога служб.
image (добавлен в 2.3)	нет			Образ, с которым должна быть перестроена виртуальная машина.
key	нет	None		Путь к клиентскому ключу, который нужно использовать в рамках транзакции SSL.
region_name	нет			Имя региона.
server	да			Имя или ID виртуальной машины.
timeout	нет	180		Время, которое модуль должен подождать, пока виртуальная машина выполнит запрошенное действие.
validate_certs	нет			Необходимо ли проверять запросы SSL к API. До версии 2.3 по умолчанию было True. псевдонимы: verify
wait	нет	да		Нужно ли ждать выполнения действия виртуальной машины.

Примеры

# Pauses a compute instance
- os_server_action:
      action: pause
      auth:
        auth_url: https://mycloud.openstack.blueboxgrid.com:5001/v2.0
        username: admin
        password: admin
        project_name: admin
      server: vm1
      timeout: 200

Примечания

Примечание

Можно использовать стандартные переменные окружения 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

Статус

Этот модуль помечен как предварительный, что означает, что гарантии обратной совместимости интерфейса нет.

Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информацией о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_server_action_module.html