openstack.cloud.server_action модуль — Выполнение действий с экземплярами OpenStack compute (Nova)

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

Для использования в playbook, укажите: openstack.cloud.server_action.

Описание
Требования
Параметры
Примечания
Примеры

Описание

Выполнение действий с экземплярами OpenStack compute (Nova), также известными как сервера.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
действие строка / обязательно	Действие, которое нужно выполнить. По умолчанию, только владельцы сервера и администраторы могут выполнять действия `pause`, `unpause`, `suspend`, `resume`, `lock`, `unlock` и `shelve_offload`. Доступные значения: `"lock"` `"pause"` `"reboot_hard"` `"reboot_soft"` `"rebuild"` `"resume"` `"shelve"` `"shelve_offload"` `"start"` `"stop"` `"suspend"` `"unlock"` `"unpause"` `"unshelve"`
пароль_админа строка	Пароль администратора для перестроения сервера.
все_проекты булево	Искать сервер во всех проектах или только в текущем проекте. Доступные значения: `false` ← (по умолчанию) `true`
таймаут_api целое	Сколько времени должен ждать уровень сокета, прежде чем истечёт таймаут для вызовов API. Если это опущено, ничего не будет передано библиотеке запросов.
аутентификация словарь	Словарь, содержащий информацию об аутентификации, как требуется стратегией подключаемого модуля аутентификации облака. Для стандартного подключаемого модуля password, это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать те параметры, которые требуются данному подключаемому модулю аутентификации. Этот параметр не нужен, если задан параметр cloud или присутствуют переменные среды OpenStack OS_*.
тип_аутентификации строка	Имя подключаемого модуля аутентификации для использования. Если облако использует что-то помимо парольной аутентификации, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert псевдонимы: cacert строка	Путь к пакету CA Cert, который можно использовать для проверки запросов SSL API.
client_cert псевдонимы: cert строка	Путь к клиенту сертификат для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к клиентскому ключу для использования в рамках транзакции SSL.
облако любой	Именованное облако или конфигурация облака для работы с ним. Если облако — это строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или присутствуют переменные среды OpenStack OS_* . Если облако — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
образ строка	Имя или ID образа, с которым должен быть перестроен сервер.
интерфейс псевдонимы: тип_подключ_к_сервису строка	Тип URL конечной точки для извлечения из каталога сервисов. Доступные значения: `"admin"` `"internal"` `"public"` ← (по умолчанию)
имя псевдонимы: сервер строка / обязательно	Имя или ID сервера.
имя_региона строка	Имя региона.
уровень_логирования_sdk строка	Уровень логирования OpenStackSDK Доступные значения: `"INFO"` ← (по умолчанию) `"DEBUG"`
путь_к_файлу_лога_sdk строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается.
таймаут целое	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`

validate_certs aliases: verify boolean	Проверка SSL запросов API. До Ansible 2.3 по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ожидать завершения запрошенного ресурса? Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Можно использовать стандартные переменные окружения OpenStack, такие как OS_USERNAME, вместо явных значений.
Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем из явных параметров в play. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/

Примеры

- name: Pauses a compute instance
  openstack.cloud.server_action:
    cloud: devstack-admin
    action: pause
    server: vm1
    timeout: 200

Авторы

OpenStack Ansible SIG

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/server_action_module.html