Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_volume — управление томами систем 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.

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

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

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

Этот модуль позволяет создавать, обновлять и удалять тома, а также добавлять и удалять вычислительный код.
Поддерживаются различные операции с томами в зависимости от указанного состояния.
Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/volume.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Сведения, необходимые для установления соединения с системой хранения данных.
address string / обязательный	IP-адрес или имя хоста системы хранения данных.
connection_type string	Тип соединения с системой хранения данных. Варианты: `"direct"` ← (по умолчанию)
password string / обязательный	Пароль для аутентификации. Это обязательное поле.
username string / обязательный	Имя пользователя для аутентификации. Это обязательное поле.
spec dictionary / обязательный	Параметры задачи с томом.
capacity string	Емкость тома. Обязательный параметр для задач создания тома /создания тома с параметрами QoS /расширения тома по имени /расширения тома по ID.
capacity_saving string	Настройки функции сокращения объема данных. `Disabled` или `Compression`. Необязательный параметр для задач создания /обновления тома.
compute_nodes list / элементы=string	Массив имен вычислительных узлов, к которым подключен том. Необязательный параметр для задач создания тома /создания тома с параметрами QoS. Обязательный параметр для задач добавления тома к вычислительным узлам /удаления тома из вычислительных узлов.
id string	Идентификатор тома. Необязательный параметр для задачи обновления тома. Обязательный параметр для задач расширения тома по ID /удаления тома по ID.
name string	Имя тома. Необязательный параметр для задач создания тома /создания тома с параметрами QoS /обновления тома. Обязательный параметр для задач обновления параметров QoS тома /расширения тома по имени /добавления тома к вычислительным узлам /удаления тома из вычислительных узлов /удаления тома по имени.
nickname string	Псевдоним тома.
pool_name string	Имя пула хранения, в котором будет создан том. Обязательный параметр для задач создания тома /создания тома с параметрами QoS.
qos_param dictionary	Параметры качества обслуживания тома. Необязательный параметр для задачи создания тома с параметрами QoS.
upper_alert_allowable_time_in_sec integer	Допустимое время верхнего порогового оповещения (в секундах). Необязательный параметр для задач создания тома с параметрами QoS /обновления параметров QoS тома.
upper_limit_for_iops integer	Верхний предел IOPS. Необязательный параметр для задач создания тома с параметрами QoS /обновления параметров QoS тома.
upper_limit_for_transfer_rate_mb_per_sec integer	Верхний предел скорости передачи данных (МБ/с). Необязательный параметр для задач создания тома с параметрами QoS /обновления параметров QoS тома.
state string	Состояние задачи с томом. Обязательный параметр для задач добавления тома к вычислительным узлам /удаления тома из вычислительных узлов. Варианты: `"add_compute_node"` `"remove_compute_node"`
vps_id string	Идентификатор VPS, в котором будет создан или удален том. Параметры vps_id и pool_name являются взаимоисключающими.
vps_name string	Имя VPS, в котором будет создан или удален том. Параметры vps_name и pool_name являются взаимоисключающими.
state string	Уровень задачи с томом. Возможные значения: `present` и `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

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

Примеры

- name: Create volume
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      pool_name: "SP01"
      name: "RD-volume-4"
      capacity: 99
      compute_nodes: ["CAPI123678", "ComputeNode-1"]

- name: Create volume with QoS parameters
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      pool_name: "SP01"
      name: "RD-volume-4"
      capacity: 99
      qos_param:
        upper_limit_for_iops: 100
        upper_limit_for_transfer_rate_mb_per_sec: 100
        upper_alert_allowable_time_in_sec: 100
      compute_nodes: ["CAPI123678", "ComputeNode-1"]

- name: Delete volume by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: absent
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "df63a5d9-32ea-4ae1-879a-7c23fbc574db"

- name: Delete volume by name
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: absent
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "RD-volume-4"

- name: Expand volume
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "RD-volume-4"
      capacity: 202

- name: Update volume nickname
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "RD-volume-4"
      nickname: "RD-volume-0004"

- name: Update volume QoS parameters
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "RD-volume-4"
      qos_param:
        upper_limit_for_iops: 100
        upper_limit_for_transfer_rate_mb_per_sec: 100
        upper_alert_allowable_time_in_sec: 100

- name: Update volume name
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "aba5c900-b04c-4beb-8ca4-ed53537afb09"
      name: "RD-volume-0004"
      nickname: "RD-volume-0004"

- name: Remove compute node
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      state: "remove_compute_node"
      id: "aba5c900-b04c-4beb-8ca4-ed53537afb09"
      compute_nodes: ["ComputeNode-1"]

- name: Add compute node
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      state: "add_compute_node"
      id: "aba5c900-b04c-4beb-8ca4-ed53537afb09"
      compute_nodes: ["ComputeNode-1"]

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

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

Ключ	Описание
volumes dictionary	Сведения о томе. Возвращается: всегда
capacity_saving string	Состояние экономии емкости. Возвращается: при успешном выполнении Пример: `"Disabled"`
compute_nodes_info list / elements=dictionary	Список вычислительных узлов, к которым подключен том. Возвращается: при успешном выполнении Пример: `[]`
data_reduction_effects dictionary	Результаты сокращения объема данных на томе. Возвращается: при успешном выполнении Пример: `{}`
data_reduction_progress_rate string	Скорость выполнения сокращения объема данных. Возвращается: при успешном выполнении Пример: `""`
data_reduction_status string	Состояние сокращения объема данных. Возвращается: при успешном выполнении Пример: `"Disabled"`
full_allocated boolean	Полностью ли выделена емкость для тома. Возвращается: при успешном выполнении Пример: `false`
id string	Уникальный идентификатор тома. Возвращается: при успешном выполнении Пример: `"355a9259-96e7-479d-8586-29b2aa74e106"`
naa_id string	Идентификатор NAA тома. Возвращается: при успешном выполнении Пример: `"60060e810274f000600274f00000271c"`
name string	Имя тома. Возвращается: при успешном выполнении Пример: `"SDSBolume12"`
nickname string	Псевдоним тома. Возвращается: при успешном выполнении Пример: `"SDSBolume12"`
number_of_connecting_servers integer	Количество серверов, подключенных к тому. Возвращается: при успешном выполнении Пример: `0`
number_of_snapshots integer	Количество снимков тома. Возвращается: при успешном выполнении Пример: `0`
pool_id string	Идентификатор пула, в котором создан том. Возвращается: при успешном выполнении Пример: `"80d306ea-d224-4fb1-a746-5ed41994e708"`
pool_name string	Имя пула хранения. Возвращается: при успешном выполнении Пример: `"SP01"`
protection_domain_id string	Идентификатор домена защиты. Возвращается: при успешном выполнении Пример: `"66449f50-caa4-4070-ade1-e81f29614741"`
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	Идентификатор контроллера хранения. Возвращается: при успешном выполнении Пример: `"970e253e-b023-4ce5-b538-c9f8b9ebfa56"`
total_capacity_mb integer	Общая емкость тома в МБ. Возвращается: при успешном выполнении Пример: `100`
used_capacity integer	Используемая емкость тома. Возвращается: при успешном выполнении Пример: `-1`
volume_number integer	Номер тома. Возвращается: при успешном выполнении Пример: `10012`
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_module.html