Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts — получает информацию о томах систем VSP One SDS Block и Cloud.

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).

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

Для установки используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts.

Добавлено в hitachivantara.vspone_block 3.0.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые факты

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

Этот модуль получает информацию о томах хранения.
Он предоставляет сведения о томе хранения, например его имя, тип и другие данные.
Примеры см. по URL-адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/volume_facts.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info словарь / обязательный	Информация, необходимая для подключения к системе хранения.
address строка / обязательный	IP-адрес или имя хоста системы хранения.
connection_type строка	Тип подключения к системе хранения. Варианты: `"direct"` ← (по умолчанию)
password строка / обязательный	Пароль для аутентификации. Это обязательное поле.
username строка / обязательный	Имя пользователя для аутентификации. Это обязательное поле.
spec словарь	Параметры получения информации о томах.
capacity_saving строка	Параметры функции сокращения объёма данных для томов. Необязательный параметр для задачи получения томов с использованием других фильтров. Варианты: `"Disabled"` `"Compression"`
count целое число	Максимальное количество получаемых элементов информации о томах. Значение по умолчанию — 500. Обязательный параметр для задачи получения томов по количеству. Необязательный параметр для задачи получения томов с использованием других фильтров. По умолчанию: `500`
names список / элементы типа string	Имена томов. Обязательный параметр для задачи получения томов по именам.
nicknames список / элементы типа string	Псевдонимы томов. Обязательный параметр для задачи получения томов по псевдонимам.
vps_id строка	Идентификатор VPS.
vps_name строка	Имя VPS.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Определяет, должен ли модуль выполняться в режиме проверки.

Примеры

- name: Get volumes by default count
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Get volumes by count
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      count: 200

- name: Get volumes by names
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      names: ['test-volume1', 'test-volume2']

- name: Get volumes by other filters
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      count: 200
      capacity_saving: 'Disabled'

Возвращаемые факты

Факты, возвращаемые этим модулем, добавляются или обновляются в фактах узла hostvars и доступны по имени, как и любые другие факты узла. Для их использования не требуется их регистрировать.

Ключ	Описание
volumes list / elements=dictionary	Список томов хранилища с их атрибутами. Возвращается: при успехе
capacity_saving string	Состояние экономии емкости. Возвращается: при успехе Пример: `"Disabled"`
compute_nodes_info list / elements=dictionary	Информация об узлах вычислений, подключенных к тому. Возвращается: при успехе
id string	Уникальный идентификатор узла вычислений. Возвращается: при успехе Пример: `"4f9041aa-ab2f-4789-af2e-df4a0178a4d3"`
name string	Имя узла вычислений. Возвращается: при успехе Пример: `"hitachitest"`
data_reduction_effects dictionary	Результаты сокращения объема данных для тома. Возвращается: при успехе
post_capacity_data_reduction integer	Емкость после сокращения объема данных. Возвращается: при успехе Пример: `0`
pre_capacity_data_reduction_without_system_data integer	Емкость до сокращения объема данных без учета системных данных. Возвращается: при успехе Пример: `0`
system_data_capacity integer	Емкость системных данных. Возвращается: при успехе Пример: `0`
data_reduction_progress_rate string	Степень выполнения сокращения объема данных. Возвращается: при успехе Пример: `""`
data_reduction_status string	Состояние сокращения объема данных. Возвращается: при успехе Пример: `"Disabled"`
full_allocated boolean	Полностью ли выделена емкость тома. Возвращается: при успехе Пример: `false`
id string	Уникальный идентификатор тома. Возвращается: при успехе Пример: `"ef69d5c6-ed7c-4302-959f-b8b8a7382f3b"`
naa_id string	Идентификатор NAA тома. Возвращается: при успехе Пример: `"60060e810a85a000600a85a000000017"`
name string	Имя тома. Возвращается: при успехе Пример: `"vol010"`
nickname string	Псевдоним тома. Возвращается: при успехе Пример: `"vol010"`
number_of_connecting_servers integer	Количество серверов, подключенных к тому. Возвращается: при успехе Пример: `1`
number_of_snapshots integer	Количество снимков тома. Возвращается: при успехе Пример: `0`
pool_id string	Идентификатор пула, к которому относится том. Возвращается: при успехе Пример: `"cb9f7ecf-ceba-4d8e-808b-9c7bc3e59c03"`
pool_name string	Имя пула, к которому относится том. Возвращается: при успехе Пример: `"SP01"`
protection_domain_id string	Идентификатор домена защиты. Возвращается: при успехе Пример: `"645c36b6-da9e-44bb-b711-430e06c7ad2b"`
qos_param dictionary	Параметры качества обслуживания для тома. Возвращается: при успехе
upper_alert_allowable_time_in_sec integer	Допустимое время для верхнего порогового оповещения в секундах. Возвращается: при успехе Пример: `100`
upper_alert_time boolean	Флаг времени верхнего порогового оповещения. Возвращается: при успехе Пример: `false`
upper_limit_for_iops integer	Верхний предел IOPS. Возвращается: при успехе Пример: `100`
upper_limit_for_transfer_rate_mb_per_sec integer	Верхний предел скорости передачи в МБ/с. Возвращается: при успехе Пример: `100`
saving_mode string	Настройка режима экономии. Возвращается: при успехе Пример: `""`
snapshot_attribute string	Атрибут снимка. Возвращается: при успехе Пример: `"-"`
snapshot_status string	Состояние снимка. Возвращается: при успехе Пример: `""`
status string	Состояние тома. Возвращается: при успехе Пример: `"Normal"`
status_summary string	Сводка о состоянии тома. Возвращается: при успехе Пример: `"Normal"`
storage_controller_id string	Идентификатор контроллера хранения данных. Возвращается: при успехе Пример: `"fc22f6d3-2bd3-4df5-b5db-8a728e301af9"`
total_capacity_mb integer	Общая емкость тома в МБ. Возвращается: при успехе Пример: `120`
used_capacity_mb integer	Используемая емкость тома в МБ. Возвращается: при успехе Пример: `0`
volume_number integer	Номер тома. Возвращается: при успехе Пример: `23`
volume_type string	Тип тома. Возвращается: при успехе Пример: `"Normal"`
vps_id string	Идентификатор VPS. Возвращается: при успехе Пример: `"(system)"`
vps_name string	Имя VPS. Возвращается: при успехе Пример: `"(system)"`

Авторы

Hitachi Vantara LTD (@hitachi-vantara)

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

© 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/hitachivantara/vspone_block/sds_block.hv_sds_block_volume_facts_module.html