Spec-Zone.ru › Ansible

Модуль community.vmware.vmware_guest_controller — управление дисковыми контроллерами и контроллерами USB виртуальной машины в указанной инфраструктуре vCenter

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

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

Для установки используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать коллекцию в плейбуке, укажите: community.vmware.vmware_guest_controller.

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет добавлять и удалять дисковые контроллеры и контроллеры USB виртуальной машины.

Параметры

Параметр

Комментарии

controllers

list / elements=dictionary

Список дисковых контроллеров или контроллеров USB для добавления или удаления.

Для каждой виртуальной машины допускается не более 4 дисковых контроллеров одного типа.

Для каждой виртуальной машины допускается не более 2 контроллеров USB: 1 USB 2.0 и 1 USB 3.0 или 3.1.

Информацию о типах контроллеров, поддерживаемых конкретной гостевой ОС, см. в VMware Compatibility Guide.

bus_sharing

string

Тип совместного использования шины для контроллера SCSI.

Варианты:

  • "noSharing" ← (по умолчанию)
  • "physicalSharing"
  • "virtualSharing"

controller_number

integer

Номер шины дискового контроллера. Если задано controllers[].state=absent, этот параметр обязателен.

Если задано controllers[].type=usb2 или controllers[].type=usb3, этот параметр необязателен.

Варианты:

  • 0
  • 1
  • 2
  • 3

state

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

Добавить новый контроллер или удалить указанный существующий контроллер.

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

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

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

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

Варианты:

  • "present"
  • "absent"

type

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

Тип дискового контроллера или контроллера USB.

Начиная с vSphere 6.5 для виртуальных машин с аппаратной версией 13 поддерживаются контроллеры nvme.

Варианты:

  • "buslogic"
  • "lsilogic"
  • "lsilogicsas"
  • "paravirtual"
  • "sata"
  • "nvme"
  • "usb2"
  • "usb3"

datacenter

string

Имя центра обработки данных, которому принадлежит виртуальная машина.

По умолчанию: "ha-datacenter"

folder

string

Папка назначения: абсолютный или относительный путь для поиска существующей гостевой системы.

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

Путь к папке должен включать центр обработки данных. Центр обработки данных 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

gather_disk_controller_facts

boolean

Только собрать сведения о существующих дисковых контроллерах и контроллерах USB.

Если для этого параметра задано значение true, параметр controllers будет проигнорирован.

Варианты:

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

hostname

string

Имя узла или IP-адрес сервера vSphere vCenter.

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

moid

string

Идентификатор управляемого объекта экземпляра, которым нужно управлять, если он известен. Это уникальный идентификатор в пределах одного экземпляра vCenter.

Этот параметр обязателен, если не указаны name или uuid.

name

string

Имя виртуальной машины.

Этот параметр обязателен, если не указаны uuid или moid.

password

псевдонимы: pass, pwd

string

Пароль сервера vSphere vCenter.

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

port

integer

Номер порта сервера vSphere vCenter.

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

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

proxy_host

string

Адрес прокси-сервера, который принимает все HTTPS-запросы и перенаправляет их.

Укажите имя узла или IP-адрес.

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

proxy_port

integer

Порт HTTP-прокси-сервера, который принимает все HTTPS-запросы и перенаправляет их.

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

sleep_time

integer

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

Этот параметр необязателен. Максимальное значение — 600.

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

use_instance_uuid

boolean

Использовать UUID экземпляра VMware вместо UUID BIOS.

Варианты:

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

username

псевдонимы: admin, user

string

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

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

uuid

string

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

Этот параметр обязателен, если не указаны name или moid.

validate_certs

boolean

Разрешает подключение при недействительных SSL-сертификатах. Установите значение false, если сертификаты не являются доверенными.

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

Варианты:

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

Примечания

Примечание

  • Всем модулям необходим доступ к API для записи, поэтому они не поддерживаются при бесплатной лицензии ESXi.
  • Имена всех переменных и объектов VMware чувствительны к регистру.
  • Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не использует системное хранилище сертификатов. Указать хранилище сертификатов можно с помощью переменной окружения REQUESTS_CA_BUNDLE. Учтите, что в некоторых случаях наличие этой переменной может привести к игнорированию значения ‘false’ параметра ‘validate_certs’. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- name: Add disk and USB 3.0 controllers for virtual machine located by name
  community.vmware.vmware_guest_controller:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: test_VM
    controllers:
      - state: present
        type: sata
      - state: present
        type: nvme
      - state: present
        type: usb3
  delegate_to: localhost
  register: disk_controller_facts

- name: Remove disk controllers and USB 2.0 from virtual machine located by moid
  community.vmware.vmware_guest_controller:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    moid: vm-33
    controllers:
      - state: absent
        controller_number: 1
        type: sata
      - state: absent
        controller_number: 0
        type: nvme
      - state: absent
        type: usb2
  delegate_to: localhost
  register: disk_controller_facts

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

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

Ключ

Описание

disk_controller_status

dictionary

метаданные о существующих дисковых контроллерах виртуальной машины, а также данные после добавления или удаления контроллера

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

Пример: {"nvme": {"0": {"controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 31000, "controller_disks_devicekey": [], "controller_label": "NVME controller 0", "controller_summary": "NVME controller 0", "controller_unitnumber": 30}}, "sata": {"0": {"controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 15000, "controller_disks_devicekey": [16000, 16001], "controller_label": "SATA controller 0", "controller_summary": "AHCI", "controller_unitnumber": 24}}, "scsi": {"0": {"controller_bus_sharing": "noSharing", "controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 1000, "controller_disks_devicekey": [2000], "controller_label": "SCSI controller 0", "controller_summary": "LSI Logic SAS", "controller_unitnumber": 3}, "1": {"controller_bus_sharing": "physicalSharing", "controller_busnumber": 1, "controller_controllerkey": 100, "controller_devicekey": 1001, "controller_disks_devicekey": [], "controller_label": "SCSI controller 1", "controller_summary": "VMware paravirtual SCSI", "controller_unitnumber": 4}}, "usb2": {"0": {"controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 7000, "controller_disks_devicekey": [], "controller_label": "USB Controller", "controller_summary": "Auto connect Disabled", "controller_unitnumber": 22}}}

Авторы

  • Diane Wang (@Tomorrow9)

Ссылки на коллекцию

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_guest_controller_module.html

Spec-Zone.ru

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