community.vmware.vmware_guest_controller – Управление контроллерами дисков или USB, относящимися к виртуальной машине в заданной инфраструктуре vCenter
Примечание
Этот плагин входит в коллекцию community.vmware (версия 1.7.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Для использования в плейбуке укажите: community.vmware.vmware_guest_controller.
Обзор
- Этот модуль можно использовать для добавления или удаления контроллеров дисков или USB, принадлежащих данной виртуальной машине.
- Все параметры и имена объектов VMware чувствительны к регистру.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| controllers список / элементы=словарь | Список контроллеров дисков или USB для добавления или удаления. Для одной виртуальной машины разрешено всего 4 контроллера дисков одного типа. Для одной виртуальной машины разрешено всего 2 контроллера USB, 1 USB 2.0 и 1 USB 3.0 или 3.1. Для конкретных гостевых ОС, поддерживаемых типов контроллеров, пожалуйста, обратитесь к Руководству по совместимости VMware. | ||
| controller_number целое число |
| Номер шины контроллера диска. Когда state установлено в absent, этот параметр требуется.Когда type установлено в usb2 или usb3, этот параметр не требуется. | |
| state строка / обязательно |
| Добавить новый контроллер или удалить существующий. Если state установлено в absent, указанный контроллер будет удален из виртуальной машины, если к нему не подключены диски или устройства.Если указанный контроллер удален или не существует, никаких действий не будет предпринято, будет только сообщение об ошибке. Если state установлено в present, будет добавлен новый контроллер указанного типа.Если количество контроллеров с указанным типом достигает максимального значения, никаких действий не будет предпринято, будет только сообщение об ошибке. | |
| type строка / обязательно |
| Тип контроллера диска или USB. Начиная с vSphere 6.5 и виртуальной машины с версией аппаратного обеспечения 13, контроллер nvme стал поддерживаться. | |
| datacenter строка | Значение по умолчанию: "ha-datacenter" | Имя дата-центра, к которому принадлежит виртуальная машина. | |
| 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 | ||
| gather_disk_controller_facts булево |
| Выполнять сбор фактов существующих контроллеров дисков и USB. Когда этот параметр установлен в True, параметр controllers будет проигнорирован. | |
| hostname строка | Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | ||
| moid строка | Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только в рамках одного экземпляра vCenter. Требуется, если name или uuid не указаны. | ||
| name строка | Имя виртуальной машины. Обязательно, если параметр uuid или moid не указан. | ||
| password строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. Псевдонимы: pass, pwd | ||
| port целое число | Значение по умолчанию: 443 | Порт сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. | |
| proxy_host строка | Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12 | ||
| proxy_port целое число | Порт HTTP-прокси, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_PORT. | ||
| sleep_time целое число | Значение по умолчанию: 10 | Время ожидания в секундах после завершения задачи переконфигурации VM, используется, когда не получены обновленные факты контроллера VM после переконфигурации VM. Этот параметр не обязателен. Максимальное значение — 600. | |
| use_instance_uuid булево |
| Использовать UUID экземпляра VMware вместо UUID BIOS. | |
| username строка | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. Псевдонимы: admin, user | ||
| uuid строка | UUID экземпляра для сбора фактов, если известен. Это уникальный идентификатор VMware. Обязательно, если параметр name или moid не указан. | ||
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите в false, когда сертификаты не доверяются.Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено в true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. | |
Примечания
Примечание
- Проверено на vSphere 6.0, 6.5 и 6.7
Примеры
- 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 словарь | всегда | метаданные о существующих контроллерах дисков виртуальной машины или после добавления или удаления операции Пример: {'nvme': {'0': {'controller_busnumber': 0, 'controller_controllerkey': 100, 'controller_devicekey': 31000, 'controller_disks_devicekey': [], 'controller_label': 'NVME контроллер 0', 'controller_summary': 'NVME контроллер 0', 'controller_unitnumber': 30}}, 'sata': {'0': {'controller_busnumber': 0, 'controller_controllerkey': 100, 'controller_devicekey': 15000, 'controller_disks_devicekey': [16000, 16001], 'controller_label': 'SATA контроллер 0', 'controller_summary': 'AHCI', 'controller_unitnumber': 24}}, 'scsi': {'0': {'controller_busnumber': 0, 'controller_controllerkey': 100, 'controller_devicekey': 1000, 'controller_disks_devicekey': [2000], 'controller_label': 'SCSI контроллер 0', 'controller_summary': 'LSI Logic SAS', 'controller_unitnumber': 3}, '1': {'controller_busnumber': 1, 'controller_controllerkey': 100, 'controller_devicekey': 1001, 'controller_disks_devicekey': [], 'controller_label': 'SCSI контроллер 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_summary': 'Автоматическое подключение отключено', 'controller_unitnumber': 22}}} |
Авторы
- Diane Wang (@Tomorrow9) <dianew@vmware.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_guest_controller_module.html
