vmware_guest_disk – Управление дисками виртуальной машины в заданной инфраструктуре vCenter
Описание
- Этот модуль может использоваться для добавления, удаления и обновления дисков, принадлежащих заданной виртуальной машине.
- Все параметры и имена объектов VMware чувствительны к регистру.
- Этот модуль разрушительного характера, пожалуйста, внимательно прочитайте документацию перед продолжением.
- Будьте внимательны при удалении диска, так как это может привести к потере данных.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| datacenter строка / обязательно | Имя центра обработки данных, к которому принадлежит виртуальная машина. | |
| disk список | Значение по умолчанию: [] | Список дисков для добавления. Информация о виртуальном диске предоставляется с помощью этого списка. Все значения и параметры чувствительны к регистру. Допустимые атрибуты: - size[_tb,_gb,_mb,_kb] (целое число): Размер хранилища диска в указанной единице.Если size указано, то должна быть указана единица измерения. Пробел между числом размера и единицей измерения недопустим.Будет учтено только первое вхождение в элемент диска, даже если доступны несколько параметров size*. - type (строка): Допустимые значения:- thin тонкий диск- eagerzeroedthick диск eagerzeroedthick- thick толстый дискЗначение по умолчанию: thick толстый диск, без eagerzero.- datastore (строка): Имя хранилища данных или кластера хранилищ данных для использования для диска.- autoselect_datastore (булево): Выбрать наименее используемое хранилище. Указать только если datastore не указано.- scsi_controller (целое число): Номер контроллера SCSI. Диапазон допустимых значений от 0 до 3.Допускается только 4 контроллера SCSI на одну ВМ. Следует соблюдать осторожность при указании scsi_controller равно 0 и unit_number равно 0, так как этот диск может содержать ОС.- unit_number (целое число): Номер устройства диска. Диапазон допустимых значений от 0 до 15. Допускается только 15 дисков на один контроллер SCSI.- scsi_type (строка): Тип контроллера SCSI. Это значение требуется только для первого появления контроллера SCSI.Это значение игнорируется, если контроллер SCSI уже присутствует или state равно absent.Допустимые значения buslogic, lsilogic, lsilogicsas и paravirtual.paravirtual является значением по умолчанию для этого параметра.- state (строка): Состояние диска. Это либо "отсутствует", либо "присутствует".Если state установлено в absent, диск будет постоянно удален из конфигурации виртуальной машины и из хранилища VMware.Если state установлено в present, диск будет добавлен, если он отсутствует на заданном контроллере SCSI и номере устройства.Если state установлено в present и диск существует с другим размером, размер диска увеличивается.Уменьшение размера диска не допускается. |
| 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 | |
| hostname строка | Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_HOST.Поддержка переменных окружения добавлена в Ansible 2.6. | |
| moid строка добавлено в 2.9 | Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только внутри одного экземпляра vCenter. Это обязательно, если name или uuid не указаны. | |
| name строка | Имя виртуальной машины. Это обязательный параметр, если параметр uuid или moid не указан. | |
| password строка | Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PASSWORD. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | Значение по умолчанию: 443 | Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PORT.Поддержка переменных окружения добавлена в Ansible 2.6. |
| proxy_host строка добавлено в 2.9 | Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PROXY_HOST.Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12 | |
| proxy_port целое число добавлено в 2.9 | Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PROXY_PORT. | |
| use_instance_uuid логическое добавлено в 2.8 |
| Использовать UUID экземпляра VMware вместо BIOS UUID. |
| username строка | Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_USER.Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user | |
| uuid строка | UUID экземпляра для сбора фактов, если известен. Это уникальный идентификатор VMware. Этот параметр является обязательным, если параметр name или moid не указан. | |
| validate_certs логическое |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите в false когда сертификаты не доверяются.Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_VALIDATE_CERTS.Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено в yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примечания
Примечание
- Проверено на vSphere 6.0 и 6.5
Примеры
- name: Add disks to virtual machine using UUID
vmware_guest_disk:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
validate_certs: no
uuid: 421e4592-c069-924d-ce20-7e7533fab926
disk:
- size_mb: 10
type: thin
datastore: datacluster0
state: present
scsi_controller: 1
unit_number: 1
scsi_type: 'paravirtual'
- size_gb: 10
type: eagerzeroedthick
state: present
autoselect_datastore: True
scsi_controller: 2
scsi_type: 'buslogic'
unit_number: 12
- size: 10Gb
type: eagerzeroedthick
state: present
autoselect_datastore: True
scsi_controller: 2
scsi_type: 'buslogic'
unit_number: 1
delegate_to: localhost
register: disk_facts
- name: Remove disks from virtual machine using name
vmware_guest_disk:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
validate_certs: no
name: VM_225
disk:
- state: absent
scsi_controller: 1
unit_number: 1
delegate_to: localhost
register: disk_facts
- name: Remove disks from virtual machine using moid
vmware_guest_disk:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
validate_certs: no
moid: vm-42
disk:
- state: absent
scsi_controller: 1
unit_number: 1
delegate_to: localhost
register: disk_facts
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| disk_status словарь | всегда | метаданные о виртуальных дисках виртуальной машины после их управления Пример: {'0': {'backing_datastore': 'datastore2', 'backing_disk_mode': 'persistent', 'backing_eagerlyscrub': False, 'backing_filename': '[datastore2] VM_225/VM_225.vmdk', 'backing_thinprovisioned': False, 'backing_writethrough': False, 'capacity_in_bytes': 10485760, 'capacity_in_kb': 10240, 'controller_key': 1000, 'key': 2000, 'label': 'Жесткий диск 1', 'summary': '10 240 КБ', 'unit_number': 0}} |
Состояние
- В данном модуле нет гарантии обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/vmware_guest_disk_module.html