Модуль hitachivantara.vspone_block.vsp.hv_vsp_one_volume — управление томами в системах хранения VSP E series, VSP One Block 20 series и VSP One Block 80 series.

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: hitachivantara.vspone_block.vsp.hv_vsp_one_volume.

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

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

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

Этот модуль позволяет создавать, изменять и удалять тома, а также подключать их к серверам и отключать от них.
Поддерживаются различные операции с томами в зависимости от указанного параметра state.
Для управления томами в моделях VSP One B20 series, VSP One B80 series и VSP E series используется Hitachi Virtual Storage Platform One Simple API.
Примеры использования см. на странице https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vsp_one_volume.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Данные, необходимые для подключения к системе хранения.
address string / обязательный	IP-адрес или имя узла системы хранения.
api_token string	Токен для работы с заблокированными ресурсами.
password string	Пароль для аутентификации. Это обязательное поле.
username string	Имя пользователя для аутентификации. Это обязательное поле.
spec dictionary / обязательный	Параметры конфигурации для операции с томом.
capacity string	Задание размера тома. Обязателен для задач «Создать том с заданными ёмкостью и идентификатором пула», «Создать том с включённым совместным использованием сокращения данных», «Создать один том с настройками пороговых значений QoS» (threshold) и «Увеличить размер существующего тома».
capacity_saving псевдонимы: saving_setting string	Настройка функции сокращения данных. Обязателен для задач «Создать том с включённым совместным использованием сокращения данных» и «Обновить параметры экономии места и compression_acceleration существующего тома». Варианты: `"compression"` `"deduplication_and_compression"` `"disable"`
compression_acceleration boolean	Управляет функцией ускорения сжатия. Обязателен для задачи «Обновить параметры экономии места и compression_acceleration существующего тома». Варианты: `false` `true`
is_data_reduction_share_enabled boolean	Включает функцию совместного использования сокращения данных. Обязателен для задачи «Создать том с включённым совместным использованием сокращения данных». Варианты: `false` ← (по умолчанию) `true`
number_of_volumes integer	Количество создаваемых томов. Обязателен для задачи «Создать несколько томов с последовательностью пользовательских псевдонимов». По умолчанию: `1`
pool_id integer	Идентификатор пула хранения. Обязателен для задач «Создать том с заданными ёмкостью и идентификатором пула», «Создать несколько томов с последовательностью пользовательских псевдонимов», «Создать том с включённым совместным использованием сокращения данных» и «Создать один том с настройками пороговых значений QoS» (threshold).
qos_settings dictionary	Настройки качества обслуживания тома. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold), «Изменить настройки пороговых значений QoS существующего тома» и «Изменить настройки оповещений QoS существующего тома».
alert_setting dictionary	Настройка оповещений QoS. Обязателен для задачи «Изменить настройки оповещений QoS существующего тома».
is_lower_alert_enabled boolean	Включает оповещения при достижении нижнего порогового значения. Обязателен для задачи «Изменить настройки оповещений QoS существующего тома». Варианты: `false` `true`
is_response_alert_enabled boolean	Включает оповещения о времени отклика. Обязателен для задачи «Изменить настройки оповещений QoS существующего тома». Варианты: `false` `true`
is_upper_alert_enabled boolean	Включает оповещения при достижении верхнего порогового значения. Обязателен для задачи «Изменить настройки оповещений QoS существующего тома». Варианты: `false` `true`
lower_alert_allowable_time integer	Допустимая длительность оповещений о нижнем пороговом значении. Обязателен для задачи «Изменить настройки оповещений QoS существующего тома».
response_alert_allowable_time integer	Допустимая длительность оповещений о времени отклика. Обязателен для задачи «Изменить настройки оповещений QoS существующего тома».
upper_alert_allowable_time integer	Допустимая длительность оповещений о верхнем пороговом значении. Обязателен для задачи «Изменить настройки оповещений QoS существующего тома».
threshold dictionary	Настройка пороговых значений QoS. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома».
is_lower_iops_enabled boolean	Включает ограничение минимального значения IOPS. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома». Варианты: `false` `true`
is_lower_transfer_rate_enabled boolean	Включает ограничение минимальной скорости передачи данных. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома». Варианты: `false` `true`
is_response_priority_enabled boolean	Включает настройку приоритета отклика. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома». Варианты: `false` `true`
is_upper_iops_enabled boolean	Включает ограничение максимального значения IOPS. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома». Варианты: `false` `true`
is_upper_transfer_rate_enabled boolean	Включает ограничение максимальной скорости передачи данных. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома». Варианты: `false` `true`
lower_iops integer	Минимальное пороговое значение IOPS. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома».
lower_transfer_rate integer	Минимальное пороговое значение скорости передачи данных. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома».
response_priority integer	Уровень приоритета отклика. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома».
upper_iops integer	Максимальное пороговое значение IOPS. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома».
upper_transfer_rate integer	Максимальное пороговое значение скорости передачи данных. Обязателен для задач «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить настройки пороговых значений QoS существующего тома».
server_ids list / элементы=integer	Список идентификаторов серверов для подключения тома. Обязателен для задач «Подключить том к серверам», «Отключить том от серверов» и «Подключить несколько томов к нескольким серверам за одну операцию».
volume_id string	Идентификатор тома. Обязателен для задач «Подключить том к серверам», «Отключить том от серверов», «Изменить настройки пороговых значений QoS существующего тома», «Изменить настройки оповещений QoS существующего тома», «Увеличить размер существующего тома», «Изменить параметры псевдонима тома», «Обновить параметры экономии места и compression_acceleration существующего тома» и «Удалить том по идентификатору».
volume_ids list / элементы=string	Список идентификаторов томов для пакетных операций подключения серверов. Обязателен для задачи «Подключить несколько томов к нескольким серверам за одну операцию».
volume_name dictionary	Настройки именования тома. Обязателен для задач «Создать том с заданными ёмкостью и идентификатором пула», «Создать несколько томов с последовательностью пользовательских псевдонимов», «Создать том с включённым совместным использованием сокращения данных», «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить параметры псевдонима тома».
base_name string / обязательный	Базовое имя для именования тома. Обязателен для задач «Создать том с заданными ёмкостью и идентификатором пула», «Создать несколько томов с последовательностью пользовательских псевдонимов», «Создать том с включённым совместным использованием сокращения данных», «Создать один том с настройками пороговых значений QoS» (threshold) и «Изменить параметры псевдонима тома».
number_of_digits integer	Количество цифр в числовой части имён томов. Обязателен для задачи «Создать несколько томов с последовательностью пользовательских псевдонимов».
start_number integer	Начальный номер в последовательности имён томов. Обязателен для задачи «Создать несколько томов с последовательностью пользовательских псевдонимов».
state string	Определяет тип операции с томом. Доступные варианты: `present`, `absent`, `attach_server` и `detach_server`. Варианты: `"present"` ← (по умолчанию) `"absent"` `"attach_server"` `"detach_server"` `"change_qos_settings"` `"server_present"`

Атрибуты

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

Примеры

- name: Create a volume with capacity and pool_id
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      capacity: 1GB
      pool_id: 1

- name: Create multiple volumes with custom nickname sequence
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      number: 3
      volume_name:
        base_name: "DataVol"
        start_number: 10
        number_of_digits: 3
      pool_id: 2

- name: Create volume with data reduction sharing enabled
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      capacity: 200MB
      is_data_reduction_share_enabled: true
      pool_id: 3

- name: Update volume with QoS threshold settings
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      volume_id: 12
      qos_settings:
        threshold:
          is_upper_iops_enabled: true
          upper_iops: 5000
          is_lower_iops_enabled: true
          lower_iops: 1000
          is_upper_transfer_rate_enabled: true
          upper_transfer_rate: 200
          is_lower_transfer_rate_enabled: false
          is_response_priority_enabled: true
          response_priority: 2

- name: Attach volume to servers
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume:
    state: attach_server
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      volume_id: 1234
      server_ids:
        - "server-01"
        - "server-02"

- name: Detach volume from servers
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume:
    state: detach_server
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      volume_id: 1234
      server_ids:
        - "server-01"

- name: Create volume with data reduction setting
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      capacity: 120GB
      pool_id: 5
      capacity_saving: "deduplication_and_compression"

- name: Delete volume by volume_id
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume:
    state: absent
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      volume_id: 1234

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

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

Ключ	Описание
volume list / elements=dictionary	Информация об объекте тома. Возвращается: всегда
capacity_saving string	Настройка экономии емкости (например, DISABLE). Возвращается: при успешном выполнении
capacity_saving_status string	Состояние экономии емкости. Возвращается: при успешном выполнении
compression_acceleration boolean	Указывает, включено ли ускорение сжатия. Возвращается: при успешном выполнении
compression_acceleration_status string	Состояние ускорения сжатия. Возвращается: при успешном выполнении
free_capacity integer	Свободная емкость тома. Возвращается: при успешном выполнении
free_capacity_in_mb integer	Свободная емкость в МБ. Возвращается: при успешном выполнении
id integer	Идентификатор тома. Возвращается: при успешном выполнении
id_hex string	Идентификатор тома в шестнадцатеричном формате. Возвращается: при успешном выполнении
is_data_reduction_share_enabled boolean	Указывает, включен ли общий доступ к сокращению объема данных. Возвращается: при успешном выполнении
luns list / elements=dictionary	Список LUN, связанных с томом. Возвращается: при успешном выполнении
nickname string	Псевдоним тома. Возвращается: при успешном выполнении
number_of_connecting_servers integer	Количество серверов, подключенных к тому. Возвращается: при успешном выполнении
number_of_snapshots integer	Количество снимков тома. Возвращается: при успешном выполнении
pool_id integer	Идентификатор пула. Возвращается: при успешном выполнении
pool_name string	Имя пула. Возвращается: при успешном выполнении
qos_settings dictionary	Настройки QoS для тома. Возвращается: при успешном выполнении
reserved_capacity integer	Зарезервированная емкость тома. Возвращается: при успешном выполнении
total_capacity integer	Общая емкость тома. Возвращается: при успешном выполнении
total_capacity_in_mb integer	Общая емкость в МБ. Возвращается: при успешном выполнении
used_capacity integer	Используемая емкость тома. Возвращается: при успешном выполнении
used_capacity_in_mb integer	Используемая емкость в МБ. Возвращается: при успешном выполнении
volume_types list / elements=string	Список типов томов. Возвращается: при успешном выполнении

Авторы

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/vsp.hv_vsp_one_volume_module.html