Spec-Zone.ru › Ansible 2.6

vsphere_guest — Создание/удаление/управление гостевой VM через VMware vSphere.

Новая в версии 1.6.

  • УСТЕРЕЛО
  • Описание
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Статус
    • Автор

УСТЕРЕЛО

Удалено в Ansible:
версия: 2.9
Почему: Заменено модулем vmware_guest. Кроме того, ‘Pysphere’ устарел в пользу официальных Python-библиотек VMware — ‘Pyvmomi’.
Альтернатива: Используйте модуль vmware_guest и другие модули, относящиеся к гостевым VM VMware.

Описание

  • Создание/удаление/переконфигурация гостевой VM через VMware vSphere. Этот модуль зависит от pysphere >= 1.7

Требования

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

  • python >= 2.6
  • pysphere

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
cluster
Имя кластера, в котором должна быть создана VM. По умолчанию определяется по хосту, на котором модуль создаёт гостевую VM.
esxi
Словарь, содержащий центры обработки данных и имя хоста, на котором должна быть создана VM. Для автономных ESXi-хостов имя центра обработки данных должно быть ha-datacenter.
force
bool
    Варианты:
  • нет ←
  • да
Логическое значение. Разрешает выполнение команд, которые могут изменить состояние запущенной гостевой VM. Также используется для переконфигурации и уничтожения.
from_template
bool

(добавлено в 1.9)
    Варианты:
  • нет ←
  • да
Указывает, должна ли VM быть развернута из шаблона (исключительно с параметром 'state'). При запуске из шаблона нельзя изменять настройки гостевой VM, такие как процессор, ОЗУ, сетевые адаптеры или диски.
guest
обязательно
Имя виртуального сервера, которым вы хотите управлять.
password
обязательно
Пароль пользователя для подключения к vCenter.
power_on_after_clone
bool
    Варианты:
  • нет
  • да ←
Указывает, должна ли VM быть включена после клонирования.
resource_pool
Имя пула ресурсов, в котором должна быть создана VM.
snapshot_to_clone
(добавлено в 2.0)
Строка, которая, при указании, создаст связанную клонированную копию VM. Снимок должен быть уже сделан в vCenter.
state
    Варианты:
  • present ←
  • выключена
  • отсутствует
  • включена
  • перезагружена
  • переконфигурирована
  • перезагрузка гостя
  • выключение гостя
Указывает желаемое состояние VM. 'переконфигурирована' применяет изменения только к 'vm_cdrom', 'memory_mb' и 'num_cpus' в параметре vm_hardware. Изменения 'memory_mb' и 'num_cpus' применяются к включённым VM при включённой функции горячей загрузки для гостя.
template_src
(добавлено в 1.9)
Имя шаблона-источника для развертывания.
username
обязательно
Имя пользователя для подключения к vCenter.
validate_certs
bool

(добавлено в 2.1)
    Варианты:
  • нет
  • да ←
Проверять сертификаты SSL. Обратите внимание, что если выполняется на python без поддержки SSLContext (обычно, python < 2.7.9), необходимо установить значение no, так как pysphere не поддерживает проверку сертификатов в старых версиях python. До версии 2.1 этот модуль всегда проверял сертификаты на python >= 2.7.9 и никогда не проверял на python <= 2.7.8.
vcenter_hostname
обязательно
Имя хоста vCenter сервера, к которому модуль подключится для создания гостевой VM.
vm_disk
Список ключей и значений дисков, их размеров и хранилища данных.
vm_extra_config
Список пар "ключ-значение" для дополнительных настроек файла vmx VM. Полезно для установки расширенных параметров VM.
vm_hardware
Список ключей и значений настроек конфигурации VM. Должен включать ['memory_mb', 'num_cpus', 'osid', 'scsi'].
vm_hw_version
(добавлено в 1.7)
Идентификатор желаемой версии оборудования (например, "vmx-08" для VM, которые нужно управлять с помощью vSphere Client). Обратите внимание, что изменение версии оборудования существующей VM не поддерживается.
vm_nic
Список пар "ключ-значение" сетевых адаптеров, их типов и сетевых подключений.
Также, необязательно, с их MAC-адресами.
vmware_guest_facts
bool
    Варианты:
  • нет
  • да
Сбор фактов из vCenter по определённой VM.

Примечания

Примечание

  • Этот модуль должен выполняться с системы, которая имеет прямой доступ к vSphere. Либо с помощью local_action, либо с помощью delegate_to.

Примеры

---
# Create a new VM on an ESX server
# Returns changed = False when the VM already exists
# Returns changed = True and a adds ansible_facts from the new VM
# State will set the power status of a guest upon creation. Use powered_on to create and boot.
# Options ['state', 'vm_extra_config', 'vm_disk', 'vm_nic', 'vm_hardware', 'esxi'] are required together
# Note: vm_floppy support added in 2.0

- vsphere_guest:
    vcenter_hostname: vcenter.mydomain.local
    username: myuser
    password: mypass
    guest: newvm001
    state: powered_on
    vm_extra_config:
      vcpu.hotadd: yes
      mem.hotadd:  yes
      notes: This is a test VM
      folder: MyFolder
    vm_disk:
      disk1:
        size_gb: 10
        type: thin
        datastore: storage001
        # VMs can be put into folders. The value given here is either the full path
        # to the folder (e.g. production/customerA/lamp) or just the last component
        # of the path (e.g. lamp):
        folder: production/customerA/lamp
    vm_nic:
      nic1:
        type: vmxnet3
        network: VM Network
        network_type: standard
      nic2:
        type: vmxnet3
        network: dvSwitch Network
        network_type: dvs
    vm_hardware:
      memory_mb: 2048
      num_cpus: 2
      osid: centos64Guest
      scsi: paravirtual
      vm_cdrom:
        type: "iso"
        iso_path: "DatastoreName/cd-image.iso"
      vm_floppy:
        type: "image"
        image_path: "DatastoreName/floppy-image.flp"
    esxi:
      datacenter: MyDatacenter
      hostname: esx001.mydomain.local

# Reconfigure the CPU and Memory on the newly created VM
# Will return the changes made

- vsphere_guest:
    vcenter_hostname: vcenter.mydomain.local
    username: myuser
    password: mypass
    guest: newvm001
    state: reconfigured
    vm_extra_config:
      vcpu.hotadd: yes
      mem.hotadd:  yes
      notes: This is a test VM
    vm_disk:
      disk1:
        size_gb: 10
        type: thin
        datastore: storage001
    vm_nic:
      nic1:
        type: vmxnet3
        network: VM Network
        network_type: standard
    vm_hardware:
      memory_mb: 4096
      num_cpus: 4
      osid: centos64Guest
      scsi: paravirtual
    esxi:
      datacenter: MyDatacenter
      hostname: esx001.mydomain.local

# Deploy a guest from a template
- vsphere_guest:
    vcenter_hostname: vcenter.mydomain.local
    username: myuser
    password: mypass
    guest: newvm001
    from_template: yes
    template_src: centosTemplate
    cluster: MainCluster
    resource_pool: "/Resources"
    vm_extra_config:
      folder: MyFolder

# Task to gather facts from a vSphere cluster only if the system is a VMware guest

- vsphere_guest:
    vcenter_hostname: vcenter.mydomain.local
    username: myuser
    password: mypass
    guest: newvm001
    vmware_guest_facts: yes

---
# Typical output of a vsphere_facts run on a guest
# If vmware tools is not installed, ipadresses with return None

- hw_eth0:
  - addresstype: "assigned"
    label: "Network adapter 1"
    macaddress: "00:22:33:33:44:55"
    macaddress_dash: "00-22-33-33-44-55"
    ipaddresses: ['192.0.2.100', '2001:DB8:56ff:feac:4d8a']
    summary: "VM Network"
  hw_guest_full_name: "newvm001"
  hw_guest_id: "rhel6_64Guest"
  hw_memtotal_mb: 2048
  hw_name: "centos64Guest"
  hw_power_status: "POWERED ON"
  hw_processor_count: 2
  hw_product_uuid: "ef50bac8-2845-40ff-81d9-675315501dac"

# hw_power_status will be one of the following values:
#   - POWERED ON
#   - POWERED OFF
#   - SUSPENDED
#   - POWERING ON
#   - POWERING OFF
#   - SUSPENDING
#   - RESETTING
#   - BLOCKED ON MSG
#   - REVERTING TO SNAPSHOT
#   - UNKNOWN
# as seen in the VMPowerState-Class of PySphere: http://git.io/vlwOq

---
# Remove a vm from vSphere
# The VM must be powered_off or you need to use force to force a shutdown
- vsphere_guest:
    vcenter_hostname: vcenter.mydomain.local
    username: myuser
    password: mypass
    guest: newvm001
    state: absent
    force: yes

Статус

Этот модуль помечен как устаревший и будет удалён в версии 2.9. Для получения дополнительной информации см. УСТЕРЕЛО.

Автор

  • Richard Hoop (@rhoop) <wrhoop@gmail.com>

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vsphere_guest_module.html

Spec-Zone.ru

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