модуль community.vmware.vmware_all_snapshots_info — собирает сведения обо всех снимках виртуальных машин в указанном центре обработки данных VMware

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
datacenter string / обязательный	Имя центра обработки данных, сведения о снимках которого нужно собрать. Его можно найти в интерфейсе VMware.
filters dictionary	Необязательные фильтры для собранных данных о снимках; можно применить один или несколько фильтров. Фильтры применяются в соответствии со значением переменной match_type. Если match_type равен exact, фильтры требуют точного совпадения. Если же match_type равен includes, будут выбраны значения, содержащие указанное значение. Доступные параметры фильтрации: creation_time, description, folder, id, name, quiesced, state, vm_name. Можно применить несколько фильтров; чтобы снимок был включён в результаты, он должен соответствовать всем критериям фильтрации. По умолчанию: `{}`
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
match_type string	Указывает, должно ли совпадение с фильтром быть точным или включать заданное значение. Например, чтобы получить все снимки, в имени которых содержится слово test, задайте фильтр name со значением test и параметр match_type со значением includes. Например, чтобы получить все снимки в состоянии poweredOn, не указывайте match_type (по умолчанию используется exact) или задайте match_type exact. Варианты: `"exact"` ← (по умолчанию) `"includes"`
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`.
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
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 information about all snapshots in VMware vCenter
  vmware_all_snapshots_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    datacenter: '{{ datacenter_name }}'
  delegate_to: localhost
- name: Gather information of a snapshot with filters applied and match_type in exacts.
  vmware_all_snapshots_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: yes
    datacenter: '{{ datacenter_name }}'
    filters:
      state: "poweredOn"
      vm_name: "you_marchine_name"
  delegate_to: localhost
- name: Gather information of snapshots that in their name contain the "test" in their name.
  vmware_all_snapshots_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: yes
    datacenter: '{{ datacenter_name }}'
    match_type: "includes"
    filters:
      name: "test"
  delegate_to: localhost

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

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

Ключ	Описание
vmware_all_snapshots_info list / элементы=dictionary	Список сведений обо всех снимках всех виртуальных машин в указанном центре обработки данных Возвращается: всегда
creation_time string	Время создания снимка Возвращается: всегда
description string	Описание снимка. Возвращается: если существует, поскольку зависит от его наличия
folder string	Путь к папке виртуальной машины в центре обработки данных; обычно это vm Возвращается: всегда
id integer	Уникальный идентификатор снимка Возвращается: всегда
name string	Имя снимка Возвращается: всегда
quiesced boolean	Показывает, была ли файловая система виртуальной машины переведена в состояние покоя при создании снимка Возвращается: всегда
state string	Состояние виртуальной машины на момент создания снимка (включена/выключена) Возвращается: всегда
vm_name string	Имя виртуальной машины, отображаемое в пользовательском интерфейсе. Возвращается: всегда

Авторы

Fernando Mendieta (@valkiriaaquatica)

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

© 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_all_snapshots_info_module.html