community.vmware.vmware_guest_snapshot_info – Сбор информации о снимках виртуальной машины в vCenter

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.7.0).

Для его установки используйте: ansible-galaxy collection install community.vmware.

Для использования в плейбуке укажите: community.vmware.vmware_guest_snapshot_info.

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

Обзор

Этот модуль можно использовать для сбора информации о снимках виртуальной машины.
Этот модуль назывался vmware_guest_snapshot_facts до Ansible 2.9. Способ использования не изменился.

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
datacenter строка / обязательно		Имя датацентра.
folder строка		Папка назначения, абсолютный или относительный путь для поиска существующего гостевого виртуального сервера. Этот параметр требуется, если `name` предоставлен. Папка должна включать датацентр. Датацентр 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-адрес vCenter сервера или ESXi сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`. Поддержка переменных среды добавлена в Ansible 2.6.
moid строка		Идентификатор управляемого объекта экземпляра для управления, если он известен, это уникальный идентификатор только в рамках одного экземпляра vCenter. Требуется, если `name` или `uuid` не указаны.
name строка		Имя виртуальной машины для работы. Требуется, если `uuid` или `moid` не указаны.
password строка		Пароль vCenter сервера или ESXi сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в Ansible 2.6. алиасы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта vCenter сервера или ESXi сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PORT`. Поддержка переменных среды добавлена в Ansible 2.6.
proxy_host строка		Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат - имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12
proxy_port целое число		Порт HTTP прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
use_instance_uuid булево	Варианты: нет ← да	Использовать UUID экземпляра VMware вместо BIOS UUID.
username строка		Имя пользователя vCenter сервера или ESXi сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. алиасы: admin, user
uuid строка		UUID экземпляра для управления, если известен, по умолчанию - BIOS UUID VMware. Требуется, если параметр `name` или `moid` не указан. Параметр `folder` игнорируется, если предоставлен параметр `uuid`.
validate_certs булево	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false`, когда сертификаты не доверяются. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено значение `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

Проверено на vSphere 6.0 и 6.5

Примеры

- name: Gather snapshot information about the virtual machine in the given vCenter
  community.vmware.vmware_guest_snapshot_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    folder: "/{{ datacenter_name }}/vm/"
    name: "{{ guest_name }}"
  delegate_to: localhost
  register: snapshot_info

- name: Gather snapshot information about the virtual machine using MoID
  community.vmware.vmware_guest_snapshot_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    moid: vm-42
  delegate_to: localhost
  register: snapshot_info

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

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

Ключ	Возвращаемое значение	Описание
guest_snapshots словарь	всегда	метаданные о снимках Пример: {'current_snapshot': {'creation_time': '2018-02-10T14:48:31.999459+00:00', 'description': '', 'id': 28, 'name': 'snap_0003', 'state': 'poweredOff'}, 'snapshots': [{'creation_time': '2018-02-10T14:48:31.999459+00:00', 'description': '', 'id': 28, 'name': 'snap_0003', 'state': 'poweredOff'}]}

Авторы

Abhijeet Kasurde (@Akasurde)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_guest_snapshot_info_module.html