Spec-Zone.ru › Ansible 2.5

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

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

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

УСТАРЕВШИЙ

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

Описание

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

Требования

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

  • python >= 2.6
  • pysphere

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
cluster Значение по умолчанию:
None
Имя кластера, в котором должна быть создана виртуальная машина. По умолчанию определяется по хосту, на котором модуль должен создать гостевую машину.
esxi Значение по умолчанию:
None
Словарь, содержащий цент датацентра и имя хоста, на котором должна быть создана виртуальная машина. Для автономных ESXi-хостов в качестве имени датацентра следует использовать ha-datacenter
force
    Варианты:
  • no ←
  • yes
Булево значение. Разрешает выполнение команд, которые могут изменить состояние работающей гостевой машины. Также используется для переконфигурации и удаления.
from_template
(добавлено в 1.9)
    Варианты:
  • no ←
  • yes
Указывает, должна ли виртуальная машина быть развернута из шаблона (исключает параметр 'state'). При запуске из шаблона невозможно внести изменения в настройки гостевой машины, такие как ЦП, ОЗУ, сетевые карты или диски.
guest
обязательно
Имя виртуального сервера, которое вы хотите управлять.
password
обязательно
Значение по умолчанию:
None
Пароль пользователя для подключения к vcenter.
power_on_after_clone
    Варианты:
  • no
  • yes ←
Указывает, должна ли виртуальная машина быть включена после клонирования.
resource_pool Значение по умолчанию:
None
Имя пула ресурсов для создания виртуальной машины.
snapshot_to_clone
(добавлено в 2.0)
Значение по умолчанию:
none
Строка, при указании которой создаётся связанная клонированная копия виртуальной машины. Снимок должен быть уже сделан в vCenter.
state
    Варианты:
  • present ←
  • powered_off
  • absent
  • powered_on
  • restarted
  • reconfigured
Указывает желаемое состояние виртуальной машины. 'reconfigured' применяется только к изменениям 'vm_cdrom', 'memory_mb' и 'num_cpus' в параметре vm_hardware. Изменения 'memory_mb' и 'num_cpus' применяются к включённым виртуальным машинам, если для гостевой машины включена горячая подкачка.
template_src
(добавлено в 1.9)
Значение по умолчанию:
None
Имя исходного шаблона для развертывания.
username
обязательно
Значение по умолчанию:
None
Имя пользователя для подключения к vcenter.
validate_certs
(добавлено в 2.1)
    Варианты:
  • no
  • yes ←
Проверка SSL-сертификатов. Обратите внимание, если выполняется на Python без поддержки SSLContext (обычно, Python < 2.7.9), вам нужно установить это в no, так как pysphere не поддерживает проверку сертификатов в более старых версиях Python. До версии 2.1 этот модуль всегда проверял сертификаты на Python >= 2.7.9 и никогда не проверял на Python <= 2.7.8.
vcenter_hostname
обязательно
Значение по умолчанию:
None
Имя хоста сервера vcenter, к которому будет подключиться модуль для создания гостевой машины.
vm_disk Значение по умолчанию:
None
Список пар "ключ-значение" дисков, их размеров и хранилища данных.
vm_extra_config Значение по умолчанию:
None
Список пар "ключ-значение" дополнительных значений, которые вы хотите установить или изменить в файле vmx виртуальной машины. Полезно для установки расширенных параметров виртуальной машины.
vm_hardware Значение по умолчанию:
None
Список пар "ключ-значение" параметров конфигурации виртуальной машины. Должен содержать ['memory_mb', 'num_cpus', 'osid', 'scsi'].
vm_hw_version
(добавлено в 1.7)
Значение по умолчанию:
None
Идентификатор желаемой версии оборудования (например, "vmx-08" для виртуальных машин, которые нужно управлять через vSphere Client). Обратите внимание, что изменение версии оборудования существующей виртуальной машины не поддерживается.
vm_nic Значение по умолчанию:
None
Список пар "ключ-значение" сетевых карт, их типов и сетевых подключений.
vmware_guest_facts
    Варианты:
  • no
  • yes
Значение по умолчанию:
None
Сбор фактов из vCenter о конкретной виртуальной машине.

Примечания

Примечание

  • Этот модуль должен выполняться с системы, которая имеет прямой доступ к 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.5/modules/vsphere_guest_module.html

Spec-Zone.ru

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