Модуль community.vmware.vmware_guest_controller — Управление дисками или контроллерами USB, связанными с виртуальной машиной в заданной инфраструктуре vCenter
Примечание
Этот модуль является частью коллекции community.vmware (версия 4.7.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.vmware.
Чтобы использовать его в книге задач, укажите: community.vmware.vmware_guest_controller.
Обзор
- Этот модуль можно использовать для добавления или удаления контроллеров дисков или USB, относящихся к заданной виртуальной машине.
Параметры
Параметр | Комментарии |
|---|---|
controllers список / элементы=словарь | Список дисков или USB-контроллеров для добавления или удаления. Максимальное количество дисков одного типа на одну виртуальную машину — 4. Максимальное количество USB-контроллеров на одну виртуальную машину — 2, по 1 USB 2.0 и USB 3.0 или 3.1. Для конкретных гостевых ОС, поддерживаемых типов контроллеров, обратитесь к руководству по совместимости VMware. |
|
bus_sharing строка |
Тип совместного использования шины для SCSI-контроллера. Варианты:
|
|
controller_number целое число |
Номер шины контроллера диска. Если Если Варианты:
|
|
state строка / обязательно |
Добавить новый контроллер или удалить существующий. Если установлено значение Если указанный контроллер удален или не существует, никаких действий не будет выполнено, только предупреждающее сообщение. Если установлено значение Если количество контроллеров указанного типа достигнет максимального значения, никаких действий не будет выполнено, только предупреждающее сообщение. Варианты:
|
|
type строка / обязательно |
Тип контроллера диска или USB. Начиная с vSphere 6.5 и виртуальных машин с аппаратной версией 13, поддержка контроллера Варианты:
|
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-контроллерах. Если этот параметр установлен в Варианты:
|
hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды |
moid строка | |
name строка | |
password псевдонимы: pass, pwd строка | Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды |
port целое число | Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды По умолчанию: |
proxy_host строка | Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды |
proxy_port целое число | Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, будет использовано значение переменной среды |
sleep_time integer | Время ожидания в секундах после завершения задачи переконфигурации виртуальной машины, используется, когда после переконфигурации не получены обновлённые факты о контроллере виртуальной машины. Этот параметр не обязателен. Максимальное значение равно 600. По умолчанию: |
use_instance_uuid boolean | Использовать UUID экземпляра VMware вместо UUID BIOS. Варианты:
|
username aliases: admin, user string | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды |
uuid string | |
validate_certs boolean | Разрешает подключение, когда SSL-сертификаты недействительны. Устанавливается в Если значение не указано в задаче, используется значение переменной среды Варианты:
|
Примечания
Примечание
- Все модули требуют права на запись в API и поэтому не поддерживаются на бесплатной лицензии ESXi.
- Все имена переменных и объектов VMware чувствительны к регистру.
Примеры
- 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 | Метаданные о существующих контроллерах дисков виртуальной машины или после добавления или удаления операции Возвращается: всегда Пример: |
Авторы
- Diane Wang (@Tomorrow9)
Ссылки на коллекцию
© 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/community/vmware/vmware_guest_controller_module.html
