Модуль vmware.vmware_rest.vcenter_vm_tools_info — Получение свойств VMware Tools.

Примечание

Этот модуль входит в коллекцию 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_tools_info.

Новое в vmware.vmware_rest 0.1.0

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

Описание

Получение свойств VMware Tools.

Требования

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

vSphere 7.0.3 или более поздняя версия
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
session_timeout float добавлено в vmware.vmware_rest 2.1.0	Настройки таймаута для сессии клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 секунд.
vcenter_hostname string / обязательно	Имя хоста или IP-адрес vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`.
vcenter_password string / обязательно	Пароль vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`.
vcenter_rest_log_file string	Вы можете использовать этот необязательный параметр для задания расположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет сохранён на хосте, на котором запущен модуль. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_REST_LOG_FILE`.
vcenter_username string / обязательно	Имя пользователя vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_USER`.
vcenter_validate_certs boolean	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false`, если сертификаты ненадёжны. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vm string	Идентификатор виртуальной машины. Параметр должен быть идентификатором ресурса, возвращённым модулем vmware.vmware_rest.vcenter_vm_info. Требуется при state=[‘get’]

Примечания

Примечание

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

Примеры

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"
      datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}"
      folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}"
      resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      hot_add_enabled: true
      size_MiB: 1024
    disks:
    - type: SATA
      backing:
        type: VMDK_FILE
        vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk'
    - type: SATA
      new_vmdk:
        name: second_disk
        capacity: 32000000000
    cdroms:
    - type: SATA
      sata:
        bus: 0
        unit: 2
    nics:
    - backing:
        type: STANDARD_PORTGROUP
        network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: my_vm

- name: Wait until my VM is ready
  vmware.vmware_rest.vcenter_vm_tools_info:
    vm: '{{ my_vm.id }}'
  register: vm_tools_info
  until:
  - vm_tools_info is not failed
  - vm_tools_info.value.run_state == "RUNNING"
  retries: 10
  delay: 5

- name: Wait until my VM is ready
  vmware.vmware_rest.vcenter_vm_tools_info:
    vm: '{{ my_vm.id }}'
  register: vm_tools_info
  until:
  - vm_tools_info is not failed
  - vm_tools_info.value.run_state == "RUNNING"
  retries: 60
  delay: 5

- 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: Wait until my VM is ready
  vmware.vmware_rest.vcenter_vm_tools_info:
    vm: '{{ test_vm1_info.id }}'
  register: vm_tools_info
  until:
  - vm_tools_info is not failed
  - vm_tools_info.value.run_state == "RUNNING"
  retries: 60
  delay: 5

Возвращаемые значения

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

Ключ	Описание
value dictionary	Дождитесь готовности моей VM Возвращается: При успехе Пример: `{"auto_update_supported": 0, "install_attempt_count": 0, "install_type": "OPEN_VM_TOOLS", "run_state": "RUNNING", "upgrade_policy": "MANUAL", "version": "10346", "version_number": 10346, "version_status": "UNMANAGED"}`

Авторы

Команда 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_tools_info_module.html