Модуль vmware.vmware_rest.vcenter_vm_hardware_memory — обновляет настройки виртуальной машины, связанные с памятью.
Примечание
Этот модуль входит в коллекцию vmware.vmware_rest (версия 4.10.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля нужны дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: vmware.vmware_rest.vcenter_vm_hardware_memory.
Добавлено в vmware.vmware_rest 0.1.0
УСТАРЕЛО
- Удалено в:
-
версии 5.0.0
- Причина:
-
Этот модуль перенесен в новую коллекцию vmware.vmware
- Альтернатива:
-
Вместо него используйте vmware.vmware.vm.
Краткое описание
- Обновляет настройки виртуальной машины, связанные с памятью.
Требования
На узле, на котором выполняется этот модуль, необходимы следующие компоненты.
- vSphere 7.0.3 или новее
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
hot_add_enabled логическое значение | Флаг, указывающий, следует ли разрешить добавление памяти во время работы виртуальной машины. Некоторые гостевые операционные системы могут потреблять больше ресурсов или работать менее эффективно на оборудовании, поддерживающем добавление памяти во время работы машины. Это поле можно изменить, только если виртуальная машина выключена. Если значение не задано, оно не изменяется. Варианты:
|
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0 | Настройки времени ожидания для сеанса клиента. Максимальное число секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
size_MiB целое число | Новый размер памяти в мебибайтах. Допустимый диапазон размеров памяти ограничен настроенной гостевой операционной системой и версией виртуального оборудования виртуальной машины. Если виртуальная машина работает, это значение можно изменить, только если hot_add_enabled равно true, а новый размер памяти должен соответствовать ограничениям, заданным параметром hot_add_increment_size_mib и Если значение не задано, оно не изменяется. |
state строка | Варианты:
|
vcenter_hostname строка / обязательный | Имя узла или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
vcenter_password строка / обязательный | Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
vcenter_rest_log_file строка | С помощью этого необязательного параметра можно указать путь к файлу журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет храниться на узле, на котором выполняется модуль. Если значение не указано в задаче, значение переменной окружения |
vcenter_username строка / обязательный | Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
vcenter_validate_certs логическое значение | Разрешает подключение, если SSL-сертификаты недействительны. Если сертификаты не являются доверенными, установите значение Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
vm строка / обязательный | Идентификатор виртуальной машины. Параметр должен содержать идентификатор ресурса, возвращаемый модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр является обязательным. |
Примечания
Примечание
- Проверено на vSphere 7.0.3
Примеры
- name: Look up the VM called test_vm1 in the inventory
register: search_result
vmware.vmware_rest.vcenter_vm_info:
filter_names:
- test_vm1
- name: Collect information about a specific VM
vmware.vmware_rest.vcenter_vm_info:
vm: '{{ search_result.value[0].vm }}'
register: test_vm1_info
- name: Increase the memory of a VM
vmware.vmware_rest.vcenter_vm_hardware_memory:
vm: '{{ test_vm1_info.id }}'
size_MiB: 1080
register: _result
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
id словарь | moid ресурса Возвращается: при успехе |
value словарь | Увеличение объема памяти виртуальной машины Возвращается: при успехе Пример: |
Статус
- Этот модуль будет удален в версии 5.0.0. [устарело]
- Дополнительную информацию см. в разделе УСТАРЕЛО.
Авторы
- Команда Ansible Cloud (@ansible-collections)
Ссылки на коллекцию
© 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/vmware/vmware_rest/vcenter_vm_hardware_memory_module.html