Spec-Zone.ru › Ansible

Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_vps — управление настройкой ADR томов виртуальных частных хранилищ (VPS) в системах 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_vps.

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

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

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

  • Этот модуль позволяет обновить настройку ADR томов виртуальных частных хранилищ.
  • Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/update_vps_volume_adr_setting.yml

Требования

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

  • python >= 3.9

Параметры

Параметр

Комментарии

connection_info

dictionary / обязательный

Информация, необходимая для установления соединения с системой хранения данных.

address

string / обязательный

IP-адрес или имя хоста системы хранения данных.

connection_type

string

Тип соединения с системой хранения данных.

Варианты:

  • "direct" ← (по умолчанию)

password

string / обязательный

Пароль для аутентификации. Это обязательное поле.

username

string / обязательный

Имя пользователя для аутентификации. Это обязательное поле.

spec

dictionary / обязательный

Спецификация сведений о VPS.

capacity_saving

string

Экономия емкости для томов VPS. Необязательный параметр для задачи обновления настройки ADR тома VPS по идентификатору. Обязательный параметр для задачи обновления настройки ADR тома VPS по имени.

Варианты:

  • "Disabled" ← (по умолчанию)
  • "Compression"

id

string

Идентификатор VPS, сведения о котором необходимо получить. Необязательный параметр для задачи обновления настройки ADR тома VPS по идентификатору.

name

string

Имя VPS, сведения о котором необходимо получить. Обязательный параметр для создания VPS. Обязательный параметр для задачи обновления настройки ADR тома VPS по имени.

upper_alert_allowable_time_of_volume

integer

Пороговое значение оповещения (в секундах) для верхнего предела производительности томов VPS. Это поле используется при обновлении настроек VPS. Оно задает значение по умолчанию для порога оповещения о превышении верхнего предела производительности томов, созданных на VPS. Чтобы задать порог оповещения, укажите значение от 1 до 600. Чтобы отключить порог оповещения, укажите -1. Если указать 0, задания завершатся неудачно. В журнал событий выводится сообщение, если ограничение верхнего предела производительности, заданное параметром upper_limit_for_iops_of_volume или upper_limit_for_transfer_rate_of_volume_mbps, сохраняется в течение указанного времени. Это свойство можно задать, если указан параметр upper_limit_for_iops_of_volume, upper_limit_for_transfer_rate_of_volume_mbps или оба параметра. Если это свойство не указано, предполагается значение -1.

upper_limit_for_capacity_of_single_volume_mb

integer

Верхний предел емкости (в МиБ) одного тома VPS. Допустимые значения: от 0 до 6871947674. Это поле используется при обновлении настроек VPS. Чтобы не ограничивать емкость одного тома, укажите -1. Сведения о допустимых значениях параметра upper_limit_for_capacity_of_single_volume_mb можно получить в службе поддержки клиентов.

upper_limit_for_capacity_of_volumes_mb

integer

Верхний предел общей емкости томов VPS (в МиБ). Значения от 0 до 9223372036854775807. Это поле действительно при обновлении настроек VPS. За подробной информацией о значениях, которые следует указать для upper_limit_for_capacity_of_volumes_mb, обратитесь в службу поддержки.

upper_limit_for_iops_of_volume

integer

Верхний предел производительности томов VPS (в IOPS). Это поле действительно при обновлении настроек VPS. Это значение используется по умолчанию в качестве верхнего предела производительности (в IOPS) томов, созданных в VPS. Чтобы задать верхний предел производительности томов (в IOPS), укажите значение в диапазоне от 100 до 2147483647. Чтобы не задавать верхний предел, укажите -1. Если указать значения от 0 до 99, задания завершатся неудачно. Администратор VPS, создающий тома, может задать для каждого тома верхний предел производительности (в IOPS), не превышающий это значение. Если отключить настройки и upper_limit_for_iops_of_volume, и upper_limit_for_transfer_rate_of_volume_mbps, настройка upper_alert_allowable_time_of_volume также будет отключена. Если это свойство не указано, предполагается, что задано значение -1.

upper_limit_for_number_of_servers

integer

Максимально допустимое количество вычислительных узлов в VPS. Значения от 0 до 1024. Обязательный параметр при создании VPS.

upper_limit_for_number_of_sessions

integer

Максимальное количество сеансов, которое можно установить для VPS. Значения от 0 до 436. Если это свойство не указано, предполагается, что задано значение 436.

upper_limit_for_number_of_user_groups

integer

Максимальное количество групп пользователей, которые могут входить в VPS. Значения от 0 до 256. Если это свойство не указано, предполагается, что задано значение 256.

upper_limit_for_number_of_users

integer

Максимальное количество пользователей, которые могут входить в VPS. Значения от 0 до 256. Если это свойство не указано, предполагается, что задано значение 256.

upper_limit_for_number_of_volumes

integer

Верхний предел количества томов в VPS. Действительно при обновлении настроек VPS. За подробной информацией о значениях, которые следует указать для upper_limit_for_number_of_volumes, обратитесь в службу поддержки.

upper_limit_for_transfer_rate_of_volume_mbps

integer

Верхний предел производительности томов VPS (в МиБ/с). Это поле действительно при обновлении настроек VPS. Это значение используется по умолчанию в качестве верхнего предела производительности (в МиБ/с) томов, созданных в VPS. Чтобы задать верхний предел производительности томов (в МиБ/с), укажите значение в диапазоне от 1 до 2097151. Чтобы не задавать верхний предел, укажите -1. Если указать 0, задания завершатся неудачно. Администратор VPS, создающий тома, может задать для каждого тома верхний предел производительности (в МиБ/с), не превышающий это значение. Если отключить настройки и upper_limit_for_iops_of_volume, и upper_limit_for_transfer_rate_of_volume_mbps, настройка upperAlertAllowableTimeOfVolume также будет отключена. Если это свойство не указано, предполагается, что задано значение -1.

volume_settings

list / elements=dictionary

Список объектов volume_setting. Это поле действительно и обязательно при создании VPS.

capacity_saving

string

Экономия емкости для томов VPS.

Варианты:

  • "Disabled" ← (по умолчанию)
  • "Compression"

pool_id

string / обязательный

Идентификатор пула хранения, который будет использоваться в виртуальном частном хранилище (VPS). Обязательный параметр для создания VPS.

upper_alert_allowable_time_of_volume

integer

Пороговое значение оповещения (в секундах) для верхнего предела производительности тома в VPS. Оно используется как значение по умолчанию для порога оповещения о верхнем пределе производительности томов, созданных в VPS. Чтобы задать порог оповещения, укажите значение от 1 до 600. Чтобы не задавать порог оповещения, укажите -1. Если указать 0, задания завершатся неудачно. В журнал событий выводится сообщение, если ограничение верхнего предела производительности, заданного параметром upper_limit_for_iops_of_volume или upper_limit_for_transfer_rate_of_volume_mbps, сохраняется в течение указанного времени. Это свойство можно задать, если указан параметр upper_limit_for_iops_of_volume или upper_limit_for_transfer_rate_of_volume_mbps либо оба параметра. Если это свойство не указано, предполагается, что задано значение -1.

upper_limit_for_capacity_of_single_volume_mb

integer

Верхний предел емкости (в МиБ) одного тома VPS. Значения от 0 до 6871947674. Чтобы не ограничивать емкость отдельного тома, укажите -1. За сведениями о значениях, которые следует указать для upper_limit_for_capacity_of_single_volume_mb, обратитесь в службу поддержки.

upper_limit_for_capacity_of_volumes_mb

integer / обязательный

Верхний предел общей емкости томов (в МиБ) VPS. Значения от 0 до 9223372036854775807. Обязательный параметр для создания VPS. За сведениями о значениях, которые следует указать для upper_limit_for_capacity_of_volumes_mb, обратитесь в службу поддержки.

upper_limit_for_iops_of_volume

integer

Верхний предел производительности тома (в IOPS) в VPS. Он используется как значение по умолчанию для верхнего предела производительности (в IOPS) томов, созданных в VPS. Чтобы задать верхний предел производительности тома (в IOPS), укажите значение от 100 до 2147483647. Чтобы не задавать верхний предел, укажите -1. Если указать значение от 0 до 99, задания завершатся неудачно. Администратор VPS, создающий тома, может задать для каждого тома верхний предел производительности (в IOPS), не превышающий это значение. Если отключить оба параметра upper_limit_for_iops_of_volume и upper_limit_for_transfer_rate_of_volume_mbps, параметр upper_alert_allowable_time_of_volume также будет отключен. Если это свойство не указано, предполагается, что задано значение -1.

upper_limit_for_number_of_volumes

integer / обязательный

Верхний предел количества томов в VPS. Обязательный параметр для создания VPS. За сведениями о значениях, которые следует указать для upper_limit_for_number_of_volumes, обратитесь в службу поддержки.

upper_limit_for_transfer_rate_of_volume_mbps

integer

Верхний предел производительности тома (в МиБ/с) в VPS. Он используется как значение по умолчанию для верхнего предела производительности (в МиБ/с) томов, созданных в VPS. Чтобы задать верхний предел производительности тома (в МиБ/с), укажите значение от 1 до 2097151. Чтобы не задавать верхний предел, укажите -1. Если указать 0, задания завершатся неудачно. Администратор VPS, создающий тома, может задать для каждого тома верхний предел производительности (в МиБ/с), не превышающий это значение. Если отключить оба параметра upper_limit_for_iops_of_volume и upper_limit_for_transfer_rate_of_volume_mbps, параметр upperAlertAllowableTimeOfVolume также будет отключен. Если это свойство не указано, предполагается, что задано значение -1.

state

string

Состояние настройки ADR тома VPS.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: отсутствует

Определяет, должен ли модуль работать в режиме проверки.

Примеры

- name: Create a VPS
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "RKD_VPS_02"
      upper_limit_for_number_of_user_groups: 10
      upper_limit_for_number_of_users: 5
      upper_limit_for_number_of_sessions: 20
      upper_limit_for_number_of_servers: 200
      volume_settings:
        - pool_id: "b78fe7d7-22f3-4d43-a9cf-81af3b4d7bf6"
          upper_limit_for_number_of_volumes: 20
          upper_limit_for_capacity_of_volumes_mb: 300000
          upper_limit_for_capacity_of_single_volume_mb: -1
          upper_limit_for_iops_of_volume: -1
          upper_limit_for_transfer_rate_of_volume_mbps: -1
          upper_alert_allowable_time_of_volume: -1
          capacity_saving: "Disabled"

- name: Update settings of a VPS
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "ae0f247c-dc56-491c-9cb9-4b2b6d33b345"
      name: "RKD_VPS_03"
      upper_limit_for_number_of_user_groups: 15
      upper_limit_for_number_of_users: 10
      upper_limit_for_number_of_servers: 300
      upper_limit_for_number_of_sessions: 25
      upper_limit_for_number_of_volumes: 22
      upper_limit_for_capacity_of_volumes_mb: 330000
      upper_limit_for_capacity_of_single_volume_mb: 30000
      capacity_saving: "Disabled"
      upper_limit_for_iops_of_volume: 21474836
      upper_limit_for_transfer_rate_of_volume_mbps: 50
      upper_alert_allowable_time_of_volume: 40

- name: Delete a VPS by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
      spec:
        id: "ae0f247c-dc56-491c-9cb9-4b2b6d33b345"

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

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

Ключ

Описание

vps

dictionary

Атрибуты VPS.

Возвращается: всегда

id

string

Идентификатор VPS.

Возвращается: при успехе

Пример: "969963dd-6f5c-418d-abd0-2341e767d898"

name

string

Имя VPS.

Возвращается: при успехе

Пример: "testvps"

number_of_hbas_created

integer

Количество созданных HBA.

Возвращается: при успехе

Пример: 0

number_of_servers_created

integer

Количество созданных серверов.

Возвращается: при успехе

Пример: 0

number_of_sessions_created

integer

Количество созданных сеансов.

Возвращается: при успехе

Пример: 0

number_of_user_groups_created

integer

Количество созданных групп пользователей.

Возвращается: при успехе

Пример: 0

number_of_users_created

integer

Количество созданных пользователей.

Возвращается: при успехе

Пример: 0

number_of_volume_server_connections_created

integer

Количество созданных подключений к серверу томов.

Возвращается: при успехе

Пример: 0

upper_limit_for_number_of_hbas

integer

Верхний предел количества HBA.

Возвращается: при успехе

Пример: 800

upper_limit_for_number_of_servers

integer

Верхний предел количества серверов.

Возвращается: при успехе

Пример: 200

upper_limit_for_number_of_sessions

integer

Верхний предел количества сеансов.

Возвращается: при успехе

Пример: 20

upper_limit_for_number_of_user_groups

integer

Верхний предел количества групп пользователей.

Возвращается: при успехе

Пример: 10

upper_limit_for_number_of_users

integer

Верхний предел количества пользователей.

Возвращается: при успехе

Пример: 5

upper_limit_for_number_of_volume_server_connections

integer

Верхний предел количества подключений серверов томов.

Возвращается: при успехе

Пример: 40

volume_settings

dictionary

Параметры томов.

Возвращается: при успехе

capacity_of_volumes_created

integer

Емкость созданных томов (МиБ).

Возвращается: при успехе

Пример: 0

capacity_saving_of_volume

string

Режим экономии емкости тома.

Возвращается: при успехе

Пример: "Disabled"

number_of_volumes_created

integer

Количество созданных томов.

Возвращается: при успехе

Пример: 0

pool_id

string

Идентификатор пула, связанного с томом.

Возвращается: при успехе

Пример: "80d306ea-d224-4fb1-a746-5ed41994e708"

qos_param

dictionary

Параметры качества обслуживания тома.

Возвращается: при успехе

upper_alert_allowable_time_of_volume

integer

Допустимое время срабатывания верхнего предупреждения для тома.

Возвращается: при успехе

Пример: -1

upper_limit_for_iops_of_volume

integer

Верхний предел IOPS тома.

Возвращается: при успехе

Пример: -1

upper_limit_for_transfer_rate_of_volume

integer

Верхний предел скорости передачи данных для тома.

Возвращается: при успехе

Пример: -1

saving_mode_of_volume

boolean

Режим экономии места для тома (логический флаг).

Возвращается: при успехе

Пример: false

upper_limit_for_capacity_of_single_volume

integer

Верхний предел ёмкости одного тома (МиБ).

Возвращается: при успехе

Пример: -1

upper_limit_for_capacity_of_volumes

integer

Верхний предел ёмкости томов (МиБ).

Возвращается: при успехе

Пример: 300000

upper_limit_for_number_of_volumes

integer

Верхний предел количества томов.

Возвращается: при успехе

Пример: 20

Авторы

  • 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_vps_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API