Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в книге задач укажите: ngine_io.cloudstack.cs_template.

Добавлен в ngine_io.cloudstack 0.1.0

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

Обзор

  • Регистрация шаблонов из URL.
  • Создание шаблонов из корневого тома остановленной виртуальной машины или её моментального снимка.
  • Обновление, извлечение и удаление шаблонов.

Требования

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

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account

string

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

api_http_method

string

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

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

Варианты:

  • "get" ← (default)
  • "post"

api_key

string / required

API-ключ CloudStack API.

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

api_secret

string / required

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

Если не указано, используется переменная окружения CLOUDSTACK_SECRET.

api_timeout

integer

Таймаут HTTP в секундах.

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

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

api_url

string / required

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

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

api_verify_ssl_cert

string

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

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

bits

integer

Поддержка 32 или 64 бит.

Варианты:

  • 32
  • 64 ← (default)

checksum

string

Значение контрольной суммы MD5 этого шаблона.

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

cross_zones

boolean

Следует ли синхронизировать или удалять шаблон в разных зонах.

Используется только если state имеет значение present или absent.

Варианты:

  • false ← (default)
  • true

details

string

Подробная информация о шаблоне в виде пар ключ/значение.

display_text

string

Отображаемый текст шаблона.

domain

string

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

format

string

Формат шаблона.

Учитывается только если state=present.

Варианты:

  • "QCOW2"
  • "RAW"
  • "VHD"
  • "OVA"

hypervisor

string

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

Актуально при использовании state=present.

Возможные значения: KVM, VMware, BareMetal, XenServer, LXC, HyperV, UCS, OVM, Simulator.

is_dynamically_scalable

boolean

Зарегистрировать шаблон с установленными инструментами XS/VMware для поддержки динамического масштабирования ЦП/памяти виртуальной машины.

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

Варианты:

  • false
  • true

is_extractable

boolean

Разрешает извлечение шаблона или его производных.

Варианты:

  • false
  • true

is_featured

boolean

Зарегистрировать шаблон как рекомендуемый.

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

Варианты:

  • false
  • true

is_public

boolean

Зарегистрировать шаблон как общедоступный для всех пользователей.

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

Варианты:

  • false
  • true

is_routing

boolean

Устанавливает тип шаблона на маршрутизацию, т.е. если шаблон используется для развертывания маршрутизаторов.

Рассматривается только если используется url.

Варианты:

  • false
  • true

mode

string

Режим извлечения шаблона.

Используется только если state=extracted.

Варианты:

  • "http_download" ← (по умолчанию)
  • "ftp_upload"

name

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

Имя шаблона.

os_type

string

Тип ОС, наиболее точно описывающий ОС данного шаблона.

password_enabled

boolean

Включить поддержку сброса пароля шаблона.

Варианты:

  • false
  • true

poll_async

boolean

Проверить асинхронные задания, пока задание не завершится.

Варианты:

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

project

string

Имя проекта, в котором должен быть зарегистрирован шаблон.

requires_hvm

boolean

Требуется ли HVM для шаблона.

Рассматривается только при создании шаблона.

Варианты:

  • false
  • true

snapshot

string

Имя моментальной копии, созданной из тома корня ВМ, из которого будет создан шаблон.

vm требуется вместе с этим аргументом.

sshkey_enabled

boolean

Истина, если шаблон поддерживает функцию загрузки sshkey.

Рассматривается только если используется url (ограничение API).

Варианты:

  • false
  • true

state

string

Состояние шаблона.

Варианты:

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

tags

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

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

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

Для удаления всех тегов задайте пустой список, например, tags: [].

template_filter

string

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

Фильтр all был добавлен в версии 2.7.

Варианты:

  • "all"
  • "featured"
  • "self" ← (по умолчанию)
  • "selfexecutable"
  • "sharedexecutable"
  • "executable"
  • "community"

template_find_options

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

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

Параметры для уникального поиска шаблона.

Допускается более одного.

Варианты:

  • "display_text"
  • "checksum"
  • "cross_zones"

По умолчанию: []

template_tag

string

Тег для данного шаблона.

url

string

URL местоположения шаблона при state=present.

URL, куда шаблон будет извлечен при state=extracted.

Взаимоисключающий с vm.

validate_certs

boolean

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

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

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

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

Варианты:

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

vm

string

Имя ВМ, из тома или моментальной копии которой будет создан шаблон.

ВМ должна быть в состоянии остановки, если создается из тома.

Взаимоисключающий с url.
END_OF_DOCUMENT_MARKER

zone

string

Название зоны, в которой вы хотите зарегистрировать или удалить шаблон.

Требуется, когда cross_zones равно no

Примечания

Примечание

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

Примеры

- name: register a systemvm template
  ngine_io.cloudstack.cs_template:
    name: systemvm-vmware-4.5
    url: "http://packages.shapeblue.com/systemvmtemplate/4.5/systemvm64template-4.5-vmware.ova"
    hypervisor: VMware
    format: OVA
    cross_zones: yes
    os_type: Debian GNU/Linux 7(64-bit)

- name: Create a template from a stopped virtual machine's volume
  ngine_io.cloudstack.cs_template:
    name: Debian 9 (64-bit) 20GB ({{ ansible_date_time.date }})
    vm: debian-9-base-vm
    os_type: Debian GNU/Linux 9 (64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes


# Note: Use template_find_option(s) when a template name is not unique
- name: Create a template from a stopped virtual machine's volume
  ngine_io.cloudstack.cs_template:
    name: Debian 9 (64-bit)
    display_text: Debian 9 (64-bit) 20GB ({{ ansible_date_time.date }})
    template_find_option: display_text
    vm: debian-9-base-vm
    os_type: Debian GNU/Linux 9 (64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes

- name: create a template from a virtual machine's root volume snapshot
  ngine_io.cloudstack.cs_template:
    name: Debian 9 (64-bit) Snapshot ROOT-233_2015061509114
    snapshot: ROOT-233_2015061509114
    os_type: Debian GNU/Linux 9 (64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes

- name: Remove a template
  ngine_io.cloudstack.cs_template:
    name: systemvm-4.2
    cross_zones: yes
    state: absent

Возвращаемые значения

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

Ключ

Описание

account

string

Учётная запись, к которой относится шаблон.

Возвращается: успех

Пример: "example account"

checksum

string

MD5 контрольная сумма шаблона.

Возвращается: если доступно

Пример: "0b31bccccb048d20b551f70830bb7ad0"

created

string

Дата регистрации.

Возвращается: успех

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

cross_zones

boolean

true, если шаблон управляется во всех зонах, false в противном случае.

Возвращается: если доступно

Пример: false

display_text

string

Отображаемый текст шаблона.

Возвращается: если доступно

Пример: "Debian 7.7 64-bit minimal 2015-03-19"

domain

string

Домен, к которому относится шаблон.

Возвращается: успех

Пример: "example domain"

format

string

Формат шаблона.

Возвращается: если доступно

Пример: "OVA"

hypervisor

string

Гипервизор, связанный с этим шаблоном.

Возвращается: если доступно

Пример: "VMware"

id

string

UUID шаблона или извлечённого объекта.

Возвращается: успех

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

is_extractable

boolean

True, если шаблон извлекаем.

Возвращается: если доступно

Пример: true

is_featured

boolean

True, если шаблон показан.

Возвращается: если доступно

Пример: true

is_public

boolean

True, если шаблон является общедоступным.

Возвращается: если доступно

Пример: true

is_ready

boolean

True, если шаблон готов к развертыванию.

Возвращается: если доступно

Пример: true

mode

string

Режим извлечения

Возвращается: при state=extracted

Пример: "http_download"

name

string

Имя шаблона или извлечённого объекта.

Возвращается: успех

Пример: "Debian 7 64-bit"

os_type

string

Тип ОС.

Возвращается: если доступно

Пример: "CentOS 6.5 (64-bit)"

password_enabled

boolean

True, если функция сброса пароля включена, false в противном случае.

Возвращается: если доступно

Пример: false

project

string

Имя проекта, к которому относится шаблон.

Возвращается: успех

Пример: "Production"

sshkey_enabled

boolean

true, если шаблон поддерживает sshkey, иначе false.

Возвращается: при наличии

Пример: false

state

string

Состояние извлеченного шаблона

Возвращается: при state=extracted

Пример: "DOWNLOAD_URL_CREATED"

status

string

Статус шаблона или извлеченного объекта.

Возвращается: success

Пример: "Download Complete"

tags

list / elements=string

Список тегов ресурсов, связанных с шаблоном.

Возвращается: при наличии

Пример: ["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]

template_tag

string

Тег шаблона, связанный с этим шаблоном.

Возвращается: при наличии

Пример: "special"

template_type

string

Тип шаблона.

Возвращается: при наличии

Пример: "USER"

url

string

URL, по которому извлекается шаблон

Возвращается: при state=extracted

Пример: "http://1.2.3.4/userdata/eb307f13-4aca-45e8-b157-a414a14e6b04.ova"

zone

string

Имя зоны, в которой зарегистрирован шаблон.

Возвращается: success

Пример: "zuerich"

Авторы

  • 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_template_module.html

Spec-Zone.ru

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