openstack.cloud.os_server_action – Выполнение действий над виртуальными машинами OpenStack
Примечание
Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в плейбуке укажите: openstack.cloud.os_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. Если этот параметр опущен, в библиотеку запросов ничего не будет передано. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password это будет содержать auth_url, username, password, project_name и любую информацию о домене (например, user_domain_name или project_domain_name), если облако её поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, здесь следует указать имя плагина, и содержимое параметра auth должно быть обновлено соответствующим образом. | |
| availability_zone строка | Игнорируется. Наличие для обеспечения обратной совместимости | |
| ca_cert строка | Путь к пакету CA Cert, который может быть использован для проверки запросов SSL API. псевдонимы: 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, затем из стандартных переменных окружения, и, наконец, из явных параметров в плейбуках. Более подробная информация доступна на странице 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/os_server_action_module.html
