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

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
datacenter string / required	Имя центра обработки данных, из которого необходимо собрать информацию о моментальных снимках. Вы можете получить его в интерфейсе 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 или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
match_type string	Указывает, должно ли соответствие фильтра быть точным или включающим. Например, если вы хотите получить все моментальные снимки, которые содержат в своем имени слово «test», вы помещаете фильтр name test и match_type includes. Например, если вы хотите получить все моментальные снимки, которые находятся в состоянии poweredOn, вы пропускаете match_type (по умолчанию exact) или пишете match_type exact. Варианты: `"exact"` ← (по умолчанию) `"includes"`
password aliases: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать все HTTPS-запросы и передавать их. Формат – имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать все HTTPS-запросы и передавать их. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false`, когда сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Все модули требуют доступа для записи API и поэтому не поддерживаются на бесплатной лицензии ESXi.
Все имена переменных и объектов VMware чувствительны к регистру.

Примеры

- name: Gather information about all snapshots in VMware vCenter
  vmware_snapshot_info_all:
    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_snapshot_info_all:
    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_snapshot_info_all:
    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 список / элементы=словарь	Список всей информации о снимках всех виртуальных машин в указанном дата-центре Возвращается: всегда
creation_time строка	Время создания снимка Возвращается: всегда
description строка	Описание снимка. Возвращается: если оно существует, так как зависит от наличия или отсутствия
folder строка	Путь к папке виртуальной машины в дата-центре, обычно vm Возвращается: всегда
id целое число	Уникальный идентификатор снимка Возвращается: всегда
name строка	Имя снимка Возвращается: всегда
quiesced логическое	Указывает, был ли снимок создан с замороженной файловой системой виртуальной машины Возвращается: всегда
state строка	Состояние виртуальной машины при создании снимка (включена/выключена) Возвращается: всегда
vm_name строка	Имя виртуальной машины, которое отображается в интерфейсе пользователя. Возвращается: всегда

Авторы

Fernando Mendieta (@valkiriaaquatica)

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

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