Spec-Zone.ru › Ansible

Модуль vmware.vmware_rest.vcenter_vm_guest_customization — Применяет спецификацию настройки к виртуальной машине

Примечание

Этот модуль является частью коллекции vmware.vmware_rest (версия 3.2.0).

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

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

Для использования в плейбуке укажите: vmware.vmware_rest.vcenter_vm_guest_customization.

Новая функция в vmware.vmware_rest 0.1.0

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

Обзор

  • Применяет спецификацию настройки к виртуальной машине в {@param.name vm}. Фактическая настройка происходит внутри гостевой системы, когда виртуальная машина включена. Если для виртуальной машины есть ожидающая настройка, и новая настройка задается, то существующие настройки будут перезаписаны новыми.

Требования

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

  • vSphere 7.0.3 или более поздняя версия
  • python >= 3.6
  • aiohttp

Параметры

Параметр

Комментарии

configuration_spec

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

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

Допустимые атрибуты:

  • windows_config (словарь): Настройка гостевой ОС Windows

Если не задано, ConfigurationSpec.linux-config или ConfigurationSpec.cloud-config должны быть заданы. В противном случае будет выброшено соответствующее исключение. ([‘set’])

  • Допустимые ключи:
  • reboot (строка): Этот параметр определяет действие, которое должно быть выполнено с гостевой ОС после настройки.

Допустимые значения для этого поля:

  • NO_REBOOT
  • REBOOT
  • SHUTDOWN
  • sysprep (объект): Настройки настройки, такие как данные пользователя, данные администратора и т. д., для гостевой операционной системы Windows. Должен быть указан ровно один из WindowsConfiguration.sysprep или WindowsConfiguration.sysprep-xml.

Если не задано, настройки sysprep не будут применены к гостевой операционной системе Windows.

  • sysprep_xml (строка): Все настройки, указанные в формате XML. Это содержимое типичного файла answer.xml, используемого системными администраторами при настройке образа Windows. См. https://docs.microsoft.com/ru-ru/windows-hardware/manufacture/desktop/update-windows-settings-and-scripts-create-your-own-answer-file-sxs. Должен быть указан ровно один из WindowsConfiguration.sysprep или WindowsConfiguration.sysprep-xml.

Если не задано, настройки sysprep не будут применены к гостевой операционной системе Windows.

  • linux_config (словарь): Настройка гостевой ОС Linux

Если не задано, ConfigurationSpec.windows-config или ConfigurationSpec.cloud-config должны быть заданы. В противном случае будет выброшено соответствующее исключение. ([‘set’])

  • Допустимые ключи:
  • hostname (объект): Имя компьютера виртуальной машины (Windows). Имя компьютера может содержать буквы (A-Z), цифры (0-9) и дефисы (-), но не пробелы или точки (.). Имя не может состоять только из цифр. Имя компьютера ограничено 15 символами. Если имя компьютера длиннее 15 символов, оно будет усечено до 15 символов. См. HostnameGenerator для различных вариантов.
  • domain (строка): Полное доменное имя.
  • time_zone (строка): Поле времени зоны, например, Europe/Sofia. Действительные значения временных зон основаны на базе данных tz (временной зоны), используемой Linux. Значения являются строками (string) в формате «Area/Location», где Area — название континента или океана, а Location — название города, острова или другого регионального обозначения.

См. https://kb.vmware.com/kb/2145518 для списка поддерживаемых временных зон для различных версий Linux.

Если не задано, часовой пояс в гостевой ОС не изменяется.

  • script_text (строка): Скрипт, который выполняется до и после настройки гостевой ОС Linux.

Максимальный размер скрипта составляет 1500 байт. Если у скрипта (shell, perl, python…) есть правильный «#!» в заголовке, он поддерживается. При вызове скрипта не предполагаются переменные окружения.

Скрипт вызывается модулем настройки с использованием командной строки: 1) со значением «precustomization» перед настройкой, 2) со значением «postcustomization» после настройки. Скрипт должен разобрать это значение и реализовать код пред- и пост-настроек в соответствующих блоках.

Пример скрипта на языке оболочки Linux:

#!/bin/sh

if [ x$1 == x”precustomization” ]; then

echo “Выполняются преднастрочные задачи”

#код для преднастрочных действий…

elif [ x$1 == x”postcustomization” ]; then

echo “Выполняются постнастрочные задачи”

#код для постнастрочных действий…

fi

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

  • cloud_config (словарь): Настройка гостевой ОС с настройкой облака.

Если не задано, ConfigurationSpec.windows-config или ConfigurationSpec.linux-config должны быть заданы. В противном случае будет выброшено соответствующее исключение. ([‘set’])

  • Допустимые ключи:
  • type (строка): Этот параметр определяет различные типы настройки облака.

Допустимые значения для этого поля:

  • CLOUDINIT
  • cloudinit (объект): настройка cloud-init

Это поле необязательно и актуально только при значении CloudConfiguration.type равном CLOUDINIT.

global_DNS_settings

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

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

Допустимые атрибуты:

  • dns_suffix_list (список): Список суффиксов имен разрешения для адаптера виртуальной сети. Этот список применяется к настройке гостевой ОС как Windows, так и Linux. Для Linux это глобальная настройка, в то время как для Windows эта настройка указывается для каждого адаптера.

Если не задано, суффиксы DNS не устанавливаются. ([‘set’])

  • dns_servers (список): Список DNS-серверов для адаптера виртуальной сети со статическим IP-адресом. Если этот список пуст, предполагается, что гостевая операционная система будет использовать DHCP-сервер для получения настроек DNS-сервера. Эти настройки настраивают виртуальную машину для использования указанных DNS-серверов. Настройки DNS-серверов перечислены в порядке приоритета.

Если не задано, DNS-серверы не устанавливаются. ([‘set’])

interfaces

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

Настройки IP, которые специфичны для конкретного адаптера виртуальной сети. Структура AdapterMapping сопоставляет MAC-адрес адаптера с его IPSettings. Может быть пустым, если нет адаптеров, в противном случае должно соответствовать количеству адаптеров, настроенных для ВМ. Этот параметр обязателен.

Допустимые атрибуты:

  • mac_address (строка): MAC-адрес адаптера сети, который настраивается.

Если не задано, процесс настройки сопоставляет настройки из списка i_p_settings в CustomizationSpec.interfaces с адаптерами виртуальной машины в порядке PCI-слотов. Первому адаптеру виртуальной сети на шине PCI назначается interfaces[0].IPSettings, второму адаптеру — interfaces[1].IPSettings и так далее. ([‘set’])

  • adapter (словарь): Настройки IP для соответствующего адаптера виртуальной сети. ([‘set’])

Этот ключ требуется с [‘set’].

  • Допустимые ключи:
  • ipv4 (объект): Настройка для конфигурации IPv4-адреса, маски подсети и шлюза для этого адаптера виртуальной сети.

Если не задано, IPv4-адреса не устанавливаются.

  • ipv6 (объект): Настройка для конфигурации IPv6-адреса, маски подсети и шлюза для этого адаптера виртуальной сети.

Если не задано, IPv6-адреса не устанавливаются.

  • windows (объект): Настройки Windows, которые должны быть настроены для этого конкретного адаптера виртуальной сети. Это допустимо только для гостевых операционных систем Windows.

Если не задано, специфические настройки Windows не устанавливаются.

session_timeout

вещественное число

добавлено в vmware.vmware_rest 2.1.0

Настройки таймаута для сеанса клиента.

Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа.

Значение по умолчанию — 300 секунд.

state

строка

Варианты:

  • "set" ← (значение по умолчанию)

vcenter_hostname

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

Имя хоста или IP-адрес vCenter vSphere

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

vcenter_password

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

Пароль vCenter vSphere

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

vcenter_rest_log_file

строка

Вы можете использовать этот необязательный параметр для указания расположения файла журнала.

Этот файл будет использоваться для записи взаимодействия HTTP REST.

Файл будет сохранен на хосте, на котором выполняется модуль.

Если значение не указано в задаче, вместо него будет использовано значение

переменной среды VMWARE_REST_LOG_FILE.

vcenter_username

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

Имя пользователя vCenter vSphere

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

vcenter_validate_certs

булево

Разрешает подключение, когда сертификаты SSL недействительны. Установите значение false, когда сертификаты ненадёжны.

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

Варианты:

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

vm

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

Уникальный идентификатор виртуальной машины, которую нужно настроить.

Параметр должен быть идентификатором ресурса, возвращенного модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр является обязательным.

Примечания

Примечание

  • Тестировалось на vSphere 7.0.3

Примеры

- name: Customize the VM
  vmware.vmware_rest.vcenter_vm_guest_customization:
    vm: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/test_vm1') }}"
    configuration_spec:
      linux_config:
        domain: mydomain
        hostname:
          fixed_name: foobar
          type: FIXED
    interfaces:
    - adapter:
        ipv4:
          type: STATIC
          gateways:
          - 192.168.123.1
          ip_address: 192.168.123.50
          prefix: 24
    global_DNS_settings:
      dns_suffix_list: []
      dns_servers:
      - 1.1.1.1

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

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

Ключ

Описание

value

словарь

Настройка виртуальной машины

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

Пример: {}

Авторы

  • Команда Ansible Cloud (@ansible-collections)

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

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

© 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/vmware/vmware_rest/vcenter_vm_guest_customization_module.html

Spec-Zone.ru

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