Spec-Zone.ru › Ansible

Модуль vmware.vmware_rest.vcenter_vm_hardware – Обновляет параметры виртуального оборудования виртуальной машины.

Примечание

Этот модуль является частью коллекции vmware.vmware_rest (версия 3.2.0).

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

Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.

Для использования в playbook, укажите: vmware.vmware_rest.vcenter_vm_hardware.

Новое в vmware.vmware_rest 0.1.0

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

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

  • Обновляет параметры виртуального оборудования виртуальной машины.

Требования

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

  • vSphere 7.0.3 или выше
  • python >= 3.6
  • aiohttp

Параметры

Параметр

Комментарии

session_timeout

float

добавлено в vmware.vmware_rest 2.1.0

Параметры времени ожидания для сеанса клиента.

Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа.

Значение по умолчанию – 300 с.

state

string

Варианты:

  • "present" ← (по умолчанию)
  • "upgrade"

upgrade_policy

string

Перечисляемый тип upgrade_policy определяет допустимые политики обновления виртуального оборудования для виртуальной машины.

Варианты:

  • "AFTER_CLEAN_SHUTDOWN"
  • "ALWAYS"
  • "NEVER"

upgrade_version

string

Перечисляемый тип version определяет допустимые версии виртуального оборудования для виртуальной машины. См. https://kb.vmware.com/s/article/1003746 (Версии оборудования виртуальных машин (1003746)).

Варианты:

  • "VMX_03"
  • "VMX_04"
  • "VMX_06"
  • "VMX_07"
  • "VMX_08"
  • "VMX_09"
  • "VMX_10"
  • "VMX_11"
  • "VMX_12"
  • "VMX_13"
  • "VMX_14"
  • "VMX_15"
  • "VMX_16"
  • "VMX_17"
  • "VMX_18"
  • "VMX_19"

vcenter_hostname

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

Имя хоста или IP-адрес vSphere vCenter

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

vcenter_password

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

Пароль vSphere vCenter

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

vcenter_rest_log_file

string

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

Этот файл будет использоваться для записи взаимодействия HTTP REST.

Файл будет храниться на хосте, на котором запущен модуль.

Если значение не указано в задаче, вместо него будет использовано значение

переменной среды VMWARE_REST_LOG_FILE.

vcenter_username

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

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

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

vcenter_validate_certs

boolean

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

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

Варианты:

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

version

string

Перечисляемый тип version определяет допустимые версии виртуального оборудования для виртуальной машины. См. https://kb.vmware.com/s/article/1003746 (Версии оборудования виртуальных машин (1003746)).

Варианты:

  • "VMX_03"
  • "VMX_04"
  • "VMX_06"
  • "VMX_07"
  • "VMX_08"
  • "VMX_09"
  • "VMX_10"
  • "VMX_11"
  • "VMX_12"
  • "VMX_13"
  • "VMX_14"
  • "VMX_15"
  • "VMX_16"
  • "VMX_17"
  • "VMX_18"
  • "VMX_19"

vm

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

Идентификатор виртуальной машины.

Параметром должен быть идентификатор ресурса, возвращаемый vmware.vmware_rest.vcenter_vm_info. Этот параметр обязателен.

Примечания

Примечание

  • Тестировалось на vSphere 7.0.3

Примеры

- name: Upgrade the VM hardware version
  vmware.vmware_rest.vcenter_vm_hardware:
    upgrade_policy: AFTER_CLEAN_SHUTDOWN
    upgrade_version: VMX_11
    vm: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/test_vm1') }}"
  register: _result

Значения возврата

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

Ключ

Описание

id

словарь

moid ресурса

Возвращается: При успехе

значение

словарь

Обновление версии аппаратного обеспечения ВМ

Возвращается: При успехе

Пример: {}

Авторы

  • Команда Ansible Cloud (@ansible-collections)

Ссылки на сборку

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

© 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/vmware/vmware_rest/vcenter_vm_hardware_module.html

Spec-Zone.ru

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