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

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_guest_snapshot_info.

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

Обзор

Этот модуль предназначен для сбора информации о снимках виртуальных машин.

Параметры

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

Примечания

Примечание

Всем модулям необходим доступ на запись через API, поэтому они не поддерживаются бесплатной лицензией ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не использует системное хранилище сертификатов. Вы можете указать хранилище сертификатов, задав переменную окружения REQUESTS_CA_BUNDLE. Обратите внимание: в некоторых случаях наличие этой переменной может привести к тому, что значение ‘false’ параметра ‘validate_certs’ будет проигнорировано. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- 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 dictionary	метаданные об информации о снимке Возвращается: всегда Пример: `{"current_snapshot": {"creation_time": "2018-02-10T14:48:31.999459+00:00", "description": "", "id": 28, "name": "snap_0003", "quiesced": false, "state": "poweredOff"}, "snapshots": [{"creation_time": "2018-02-10T14:48:31.999459+00:00", "description": "", "id": 28, "name": "snap_0003", "quiesced": false, "state": "poweredOff"}]}`

Ключ

Описание

guest_snapshots

dictionary

метаданные об информации о снимке

Возвращается: всегда

Пример: {"current_snapshot": {"creation_time": "2018-02-10T14:48:31.999459+00:00", "description": "", "id": 28, "name": "snap_0003", "quiesced": false, "state": "poweredOff"}, "snapshots": [{"creation_time": "2018-02-10T14:48:31.999459+00:00", "description": "", "id": 28, "name": "snap_0003", "quiesced": false, "state": "poweredOff"}]}

Авторы

Abhijeet Kasurde (@Akasurde)

Ссылки на коллекцию

© 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/community/vmware/vmware_guest_snapshot_info_module.html