Spec-Zone.ru › Ansible

ngine_io.cloudstack.cs_vmsnapshot модуль — Управление снимками виртуальных машин в облаках на основе Apache CloudStack.

Примечание

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

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

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

Для использования в playbook укажите: ngine_io.cloudstack.cs_vmsnapshot.

Новый в ngine_io.cloudstack 0.1.0

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

Описание

  • Создание, удаление и восстановление виртуальных машин из снимков.

Требования

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

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account

строка

Аккаунт, к которому относится снимок виртуальной машины.

api_http_method

строка

Метод HTTP, используемый для запроса к API-точке.

Если не указано, используется значение переменной среды CLOUDSTACK_METHOD.

Варианты:

  • "get" ← (по умолчанию)
  • "post"

api_key

строка / обязательно

API-ключ CloudStack API.

Если не указано, используется значение переменной среды CLOUDSTACK_KEY.

api_secret

строка / обязательно

Секретный ключ CloudStack API.

Если не задан, используется значение переменной среды CLOUDSTACK_SECRET.

api_timeout

целое число

Таймаут HTTP-запроса в секундах.

Если не указано, используется значение переменной среды CLOUDSTACK_TIMEOUT.

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

api_url

строка / обязательно

URL CloudStack API, например, https://cloud.example.com/client/api.

Если не указано, используется значение переменной среды CLOUDSTACK_ENDPOINT.

api_verify_ssl_cert

строка

Проверка файла сертификата авторитета CA.

Если не указано, используется значение переменной среды CLOUDSTACK_VERIFY.

description

строка

Описание снимка.

domain

строка

Домен, к которому относится снимок виртуальной машины.

name

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

строка / обязательно

Уникальное имя снимка. В CloudStack — отображаемое имя.

poll_async

логическое

Ожидать завершения асинхронных задач.

Варианты:

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

project

строка

Имя проекта, к которому назначена виртуальная машина.

snapshot_memory

логическое

Снимок памяти, если значение равно true.

Варианты:

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

state

строка

Состояние снимка.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "revert"

tags

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

список / элементы=словарь

Список тегов. Теги представляют собой список словарей с ключами key и value.

Чтобы удалить все теги, задайте пустой список, например, tags: [].

validate_certs

логическое

добавлен в ngine_io.cloudstack 2.4.0

Если false, сертификаты SSL не будут проверяться.

Если не задано, используется значение переменной среды CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY.

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

Варианты:

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

vm

строка / обязательно

Имя виртуальной машины.

zone

строка / обязательно

Имя зоны, в которой находится виртуальная машина. Если не задано.

Примечания

Примечание

  • Подробное руководство по модулям cloudstack можно найти в Руководстве по CloudStack.
  • Этот модуль поддерживает режим проверки.

Примеры

- name: Create a VM snapshot of disk and memory before an upgrade
  ngine_io.cloudstack.cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    zone: zone01
    snapshot_memory: yes

- name: Revert a VM to a snapshot after a failed upgrade
  ngine_io.cloudstack.cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    zone: zone01
    state: revert

- name: Remove a VM snapshot after successful upgrade
  ngine_io.cloudstack.cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    zone: zone01
    state: absent

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ

Описание

account

строка

Аккаунт, к которому относится моментальный снимок виртуальной машины.

Возвращено: success

Пример: "example account"

created

строка

Дата создания моментального снимка.

Возвращено: success

Пример: "2015-03-29T14:57:06+0200"

current

булево

true, если моментальный снимок является текущим

Возвращено: success

Пример: true

description

строка

Описание моментального снимка виртуальной машины.

Возвращено: success

Пример: "snapshot brought to you by Ansible"

display_name

строка

Используемое имя моментального снимка.

Возвращено: success

Пример: "snapshot before update"

domain

строка

Домен, к которому относится моментальный снимок виртуальной машины.

Возвращено: success

Пример: "example domain"

id

строка

UUID моментального снимка.

Возвращено: success

Пример: "a6f7a5fc-43f8-11e5-a151-feff819cdc9f"

name

строка

Имя моментального снимка.

Возвращено: success

Пример: "snapshot before update"

project

строка

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

Возвращено: success

Пример: "Production"

state

строка

Состояние моментального снимка виртуальной машины.

Возвращено: success

Пример: "Allocated"

type

строка

Тип моментального снимка виртуальной машины.

Возвращено: success

Пример: "DiskAndMemory"

Авторы

  • René Moser (@resmo)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 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/ngine_io/cloudstack/cs_vmsnapshot_module.html

Spec-Zone.ru

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