Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.server_action.

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

Краткое описание

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

Требования

Следующие требования должны быть выполнены на узле, который выполняет этот модуль.

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

action

string / обязательный

Действие для выполнения.

По умолчанию только владельцы серверов и администраторы могут выполнять действия 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"

admin_password

string

Пароль администратора для пересоздания сервера.

all_projects

boolean

Искать сервер во всех проектах или только в текущем проекте.

Варианты:

  • false ← (по умолчанию)
  • true

api_timeout

integer

Время ожидания на уровне сокета перед истечением срока ожидания вызовов API. Если параметр не указан, в библиотеку requests ничего не передаётся.

auth

dictionary

Словарь с данными аутентификации, необходимыми выбранному облачному плагину аутентификации. Для плагина password, используемого по умолчанию, в нём должны содержаться auth_url, username, password, project_name и любые данные о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все данные, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*.

auth_type

string

Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина и соответствующим образом изменить содержимое параметра auth.

ca_cert

псевдонимы: cacert

string

Путь к набору сертификатов центра сертификации, который можно использовать для проверки запросов API через SSL.

client_cert

псевдонимы: cert

string

Путь к сертификату клиента, используемому при SSL-транзакции.

client_key

псевдонимы: key

string

Путь к ключу клиента, используемому при SSL-транзакции.

cloud

any

Именованное облако или конфигурация облака, с которой нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.

image

string

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

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, получаемой из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

name

псевдонимы: server

string / обязательный

Имя или идентификатор сервера.

region_name

string

Имя региона.

sdk_log_level

string

Уровень ведения журнала OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается.

timeout

integer

Время ожидания запрошенного ресурса в Ansible.

По умолчанию: 180

validate_certs

псевдонимы: verify

boolean

Проверять ли запросы API через SSL.

До 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, затем из стандартных переменных среды и, наконец, из явно заданных параметров в плейбуках. Дополнительную информацию см. на странице 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

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API