Spec-Zone.ru › Ansible 2.5

vmware_guest — Управляет виртуальными машинами в vCenter

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

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

Обзор

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

Требования

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

  • python >= 2.6
  • PyVmomi

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
annotation
(добавлено в 2.3)
Заметка или аннотация для включения в виртуальную машину.
cdrom
(добавлено в 2.5)
Настройка CD-ROM для ВМ.
Допустимые атрибуты:
- type (строка): Тип CD-ROM, допустимые варианты — none, client или iso. С none CD-ROM будет отключен, но присутствовать.
- iso_path (строка): Путь к хранилищу ISO-файла для использования в формате [datastore1] path/to/file.iso. Требуется, если тип установлен iso.
cluster
(добавлено в 2.3)
Имя кластера, в котором будет запущена виртуальная машина.
Этот параметр чувствителен к регистру.
customization
(добавлено в 2.3)
Параметры настройки ОС при клонировании из шаблона.
Все параметры и имена объектов VMware чувствительны к регистру.
Общие параметры (Linux/Windows):
- dns_servers (список): Список DNS-серверов для настройки.
- dns_suffix (список): Список доменных суффиксов, т.е. путь поиска DNS (по умолчанию: параметр domain).
- domain (строка): Имя домена DNS для использования.
- hostname (строка): Имя хоста компьютера (по умолчанию: укороченный параметр name).
Параметры, связанные с настройкой Windows:
- autologon (булево): Автоматический вход после настройки ВМ (по умолчанию: False).
- autologoncount (целое число): Количество автоматических входов после перезагрузки (по умолчанию: 1).
- domainadmin (строка): Пользователь, используемый для присоединения к домену AD (обязательно с joindomain).
- domainadminpassword (строка): Пароль, используемый для присоединения к домену AD (обязательно с joindomain).
- fullname (строка): Имя владельца сервера (по умолчанию: Administrator).
- joindomain (строка): Домен AD для присоединения (несовместимо с joinworkgroup).
- joinworkgroup (строка): Рабочая группа для присоединения (несовместимо с joindomain, по умолчанию: WORKGROUP).
- orgname (строка): Название организации (по умолчанию: ACME).
- password (строка): Пароль локального администратора.
- productid (строка): Идентификатор продукта.
- runonce (список): Список команд, которые нужно выполнить при первом входе пользователя.
- timezone (целое число): Часовой пояс (см. https://msdn.microsoft.com/en-us/library/ms912391.aspx).
customvalues
(добавлено в 2.3)
Определяет список пользовательских значений для установки на виртуальную машину.
Объект пользовательского значения принимает два поля key и value.
Неправильные ключи и значения будут проигнорированы.
datacenter По умолчанию:
ha-datacenter
Целевой центр обработки данных для операции развертывания.
Этот параметр чувствителен к регистру.
disk
Список дисков для добавления.
Этот параметр чувствителен к регистру.
Изменение размера дисков не поддерживается.
Удаление существующих дисков виртуальной машины не поддерживается.
Допустимые атрибуты:
- size_[tb,gb,mb,kb] (целое число): Размер хранилища диска в указанных единицах.
- type (строка): Допустимые значения:
- thin тонкий диск
- eagerzeroedthick диск eagerzerothick, добавлен в версию 2.5
По умолчанию: None толстый диск, без eagerzero.
- datastore (строка): Хранилище данных для использования для диска. Если autoselect_datastore включен, отфильтровывается выбор хранилища данных.
- autoselect_datastore (булево): выбрать менее используемое хранилище. Указывается только если datastore не указано.
esxi_hostname
Имя хоста ESXi, на котором будет запущена виртуальная машина.
Этот параметр чувствителен к регистру.
folder
Целевой каталог, абсолютный путь для поиска существующего гостевого или создания новой виртуальной машины.
Каталог должен содержать центр обработки данных. Центр обработки данных ESX — ha-datacenter.
Этот параметр чувствителен к регистру.
Примеры:
folder: /ha-datacenter/vm
folder: ha-datacenter/vm
folder: /datacenter1/vm
folder: datacenter1/vm
folder: /datacenter1/vm/folder1
folder: datacenter1/vm/folder1
folder: /folder1/datacenter1/vm
folder: folder1/datacenter1/vm
folder: /folder1/datacenter1/vm/folder2
force
    Варианты:
  • нет ←
  • да
Игнорировать предупреждения и выполнить действия.
Этот параметр полезен при удалении виртуальной машины, которая находится в состоянии включения.
guest_id
(добавлено в 2.3)
Установить идентификатор гостя.
Этот параметр чувствителен к регистру.
Примеры:
ВМ с RHEL7 64 бит, будет 'rhel7_64Guest'
ВМ с CentOS 64 бит, будет 'centos64Guest'
ВМ с Ubuntu 64 бит, будет 'ubuntu64Guest'
Это поле обязательно при создании ВМ.
Допустимые значения приведены здесь: https://www.vmware.com/support/developer/converter-sdk/conv55_apireference/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
hardware
Управление атрибутами аппаратного обеспечения виртуальной машины.
Все параметры чувствительны к регистру.
Допустимые атрибуты:
- hotadd_cpu (булево): Разрешить добавление виртуальных ЦП во время работы ВМ.
- hotremove_cpu (булево): Разрешить удаление виртуальных ЦП во время работы ВМ. version_added: 2.5
- hotadd_memory (булево): Разрешить добавление памяти во время работы ВМ.
- memory_mb (целое число): Количество памяти в МБ.
- nested_virt (булево): Включить вложенную виртуализацию. version_added: 2.5
- num_cpus (целое число): Количество ЦП.
- num_cpu_cores_per_socket (целое число): Количество ядер на сокет. Значение должно быть кратно num_cpus.
- scsi (строка): Допустимые значения buslogic, lsilogic, lsilogicsas и paravirtual (по умолчанию).
- memory_reservation (целое число): Количество памяти в МБ для установки лимитов ресурсов памяти. version_added: 2.5
- memory_reservation_lock (булево): Если установлено в значение true, зарезервированное ресурс памяти для ВМ всегда будет равно размеру памяти ВМ. version_added: 2.5
- max_connections (целое число): Максимальное количество активных подключений удаленного дисплея для виртуальных машин. version_added: 2.5.
- mem_limit (целое число): Использование памяти виртуальной машины не превысит этот предел. Единица измерения — МБ. version_added: 2.5
- mem_reservation (целое число): Количество ресурсов памяти, гарантированно доступных виртуальной машине. Единица измерения — МБ. version_added: 2.5
- cpu_limit (целое число): Использование ЦП виртуальной машины не превысит этот предел. Единица измерения — МГц. version_added: 2.5
- cpu_reservation (целое число): Количество ресурсов ЦП, гарантированно доступных виртуальной машине. Единица измерения — МГц. version_added: 2.5
hostname
Имя хоста или IP-адрес сервера vCenter vSphere или ESXi.
Если значение не указано в задании, вместо него используется значение переменной среды VMWARE_HOST.
Поддержка переменных среды добавлена в версии 2.6.
is_template
(добавлено в 2.3)
    Варианты:
  • нет ←
  • да
Отметить экземпляр как шаблон.
Это позволит отметить ВМ как шаблон.
linked_clone
(добавлено в 2.4)
    Варианты:
  • нет ←
  • да
Создавать ли связанный клон из указанного момента сохранения.
name
обязательно
Имя ВМ для работы.
Имена ВМ в vCenter не обязательно уникальны, что может быть проблематично, см. name_match.
Этот параметр чувствителен к регистру.
name_match
    Варианты:
  • первый ←
  • последний
Если несколько ВМ соответствуют имени, использовать первую или последнюю найденную.
сети
(добавлено в 2.3)
Список сетей (в порядке подключения сетевых адаптеров).
Все параметры и имена объектов VMware чувствительны к регистру.
Требуется один из следующих параметров на запись:
- name (строка): Имя группы портов для этого интерфейса.
- vlan (целое число): Номер VLAN для этого интерфейса.
Необязательные параметры на запись (используются для виртуального оборудования):
- device_type (строка): Виртуальное сетевое устройство (одно из e1000, e1000e, pcnet32, vmxnet2, vmxnet3 (по умолчанию), sriov).
- mac (строка): Настройка MAC-адреса.
Необязательные параметры на запись (используются для настройки ОС):
- type (строка): Тип назначения IP-адреса (либо dhcp или static). dhcp — по умолчанию.
- ip (строка): Статический IP-адрес (подразумевает type: static).
- netmask (строка): Статическая маска сети, необходимая для ip.
- gateway (строка): Статический шлюз.
- dns_servers (строка): DNS-серверы для этого сетевого интерфейса (Windows).
- domain (строка): Имя домена для этого сетевого интерфейса (Windows).
- wake_on_lan (логическое значение): Указывает, включен ли Wake-on-LAN для этого виртуального сетевого адаптера. version_added: 2.5
- start_connected (логическое значение): Указывает, что виртуальный сетевой адаптер запускается вместе с включением связанной виртуальной машины. version_added: 2.5
- allow_guest_control (логическое значение): Включает контроль гостя над подключением устройства. version_added: 2.5
пароль
Пароль от сервера vCenter или ESXi vSphere.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PASSWORD.
Поддержка переменной среды добавлена в версии 2.6.

псевдонимы: pass, pwd
порт
(добавлено в 2.5)
По умолчанию:
443
Номер порта сервера vCenter или ESXi vSphere.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PORT.
Поддержка переменной среды добавлена в версии 2.6.
пул_ресурсов
(добавлено в 2.3)
Привязывает машину к указанному пулу ресурсов.
Этот параметр чувствителен к регистру.
Пул ресурсов должен быть дочерним по отношению к выбранному родительскому хосту.
источник_снэпшота
(добавлено в 2.4)
Имя существующего моментальной копии для создания клона ВМ.
Этот параметр чувствителен к регистру.
состояние
    Варианты:
  • present ←
  • absent
  • включено
  • выключено
  • перезапущено
  • приостановлено
  • выключено_гость
  • перезапуск_гостя
Укажите желаемое состояние виртуальной машины.
Если state установлено в present, и ВМ существует, убедитесь, что конфигурация ВМ соответствует аргументам задачи.
шаблон
Шаблон или существующая ВМ, используемые для создания ВМ.
Если это значение не задано, ВМ создается без использования шаблона.
Если ВМ уже существует, это значение будет проигнорировано.
Этот параметр чувствителен к регистру.

псевдонимы: источник_шаблона
имя_пользователя
Имя пользователя сервера vCenter или ESXi vSphere.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_USER.
Поддержка переменной среды добавлена в версии 2.6.

псевдонимы: user, admin
uuid
UUID экземпляра для управления, если известен, это уникальный идентификатор VMware.
Требуется, если имя не предоставлено.
Обратите внимание, что предоставленный UUID будет проигнорирован при создании ВМ, так как VMware создаёт UUID внутри системы.
проверять_сертификаты
    Варианты:
  • нет
  • да
По умолчанию:
True
Разрешает подключение, когда SSL-сертификаты недействительны. Установите в false, когда сертификаты не доверяются.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.
Поддержка переменной среды добавлена в версии 2.6.
ждать_ip_адрес
    Варианты:
  • нет ←
  • да
Ожидать, пока vCenter обнаружит IP-адрес для ВМ.
Для правильной работы требуется vmware-tools (vmtoolsd) после создания.
vmware-tools необходимо установить на данной виртуальной машине для работы с этим параметром.

Примечания

Примечание

  • Тестировалось на vSphere 5.5, 6.0 и 6.5

Примеры

- name: Create a VM from a template
  vmware_guest:
    hostname: 192.0.2.44
    username: administrator@vsphere.local
    password: vmware
    validate_certs: no
    folder: /testvms
    name: testvm_2
    state: poweredon
    template: template_el7
    disk:
    - size_gb: 10
      type: thin
      datastore: g73_datastore
    hardware:
      memory_mb: 512
      num_cpus: 6
      num_cpu_cores_per_socket: 3
      scsi: paravirtual
      memory_reservation: 512
      memory_reservation_lock: True
      mem_limit: 8096
      mem_reservation: 4096
      cpu_limit: 8096
      cpu_reservation: 4096
      max_connections: 5
      hotadd_cpu: True
      hotremove_cpu: True
      hotadd_memory: False
    cdrom:
      type: iso
      iso_path: "[datastore1] livecd.iso"
    networks:
    - name: VM Network
      mac: aa:bb:dd:aa:00:14
    wait_for_ip_address: yes
  delegate_to: localhost
  register: deploy

- name: Clone a VM from Template and customize
  vmware_guest:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    validate_certs: no
    datacenter: datacenter1
    cluster: cluster
    name: testvm-2
    template: template_windows
    networks:
    - name: VM Network
      ip: 192.168.1.100
      netmask: 255.255.255.0
      gateway: 192.168.1.1
      mac: aa:bb:dd:aa:00:14
      domain: my_domain
      dns_servers:
      - 192.168.1.1
      - 192.168.1.2
    - vlan: 1234
      type: dhcp
    customization:
      autologon: yes
      dns_servers:
      - 192.168.1.1
      - 192.168.1.2
      domain: my_domain
      password: new_vm_password
      runonce:
      - powershell.exe -ExecutionPolicy Unrestricted -File C:\Windows\Temp\ConfigureRemotingForAnsible.ps1 -ForceNewSSLCert -EnableCredSSP
  delegate_to: localhost

- name: Create a VM template
  vmware_guest:
    hostname: 192.0.2.88
    username: administrator@vsphere.local
    password: vmware
    validate_certs: no
    datacenter: datacenter1
    cluster: vmware_cluster_esx
    resource_pool: highperformance_pool
    folder: /testvms
    name: testvm_6
    is_template: yes
    guest_id: debian6_64Guest
    disk:
    - size_gb: 10
      type: thin
      datastore: g73_datastore
    hardware:
      memory_mb: 512
      num_cpus: 1
      scsi: lsilogic
  delegate_to: localhost
  register: deploy

- name: Rename a VM (requires the VM's uuid)
  vmware_guest:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    name: new_name
    state: present
  delegate_to: localhost

- name: Remove a VM by uuid
  vmware_guest:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: absent
  delegate_to: localhost

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

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

Ключ Возвращаемое Описание
экземпляр
словарь
всегда
метаданные о новой виртуальной машине

Пример:
None


Статус

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

Автор

  • James Tanner (@jctanner) <tanner.jc@gmail.com>
  • Loic Blot (@nerzhul) <loic.blot@unix-experience.fr>
  • Philippe Dellaert (@pdellaert) <philippe@dellaert.org>
  • Abhijeet Kasurde (@akasurde) <akasurde@redhat.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/vmware_guest_module.html

Spec-Zone.ru

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