Модуль hitachivantara.vspone_block.vsp.hv_resource_group — управление группами ресурсов в системах блочного хранения VSP.
Примечание
Этот модуль входит в коллекцию 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_resource_group.
Добавлено в hitachivantara.vspone_block 3.2.0
Краткое описание
- Этот модуль позволяет создавать и удалять группы ресурсов в системах блочного хранения VSP.
- Он также позволяет добавлять различные типы ресурсов в группу ресурсов и удалять их из неё.
- Примеры см. по ссылке https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/resource_group.yml
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
connection_info dictionary / обязательный | Информация, необходимая для установления соединения с системой хранения. |
|
address string / обязательный |
IP-адрес или имя узла системы хранения. |
|
api_token string |
Токен для выполнения операций с заблокированными ресурсами. |
|
connection_type string |
Тип соединения с системой хранения. Варианты:
|
|
password string |
Пароль для аутентификации. Это обязательное поле. |
|
username string |
Имя пользователя для аутентификации. Это обязательное поле. |
spec dictionary / обязательный | Спецификация группы ресурсов. |
|
add_resource_time_out_in_sec integer |
Время ожидания операции добавления ресурса. Значение по умолчанию — 300 секунд. |
|
begin_ldev_id псевдонимы: start_ldev string |
Номер первого LDEV. Если указан этот атрибут, необходимо также указать end_ldev_id. Если указано ldevs, этот атрибут указывать нельзя. Обязателен для добавления/удаления LDEV с использованием диапазона идентификаторов LDEV. |
|
end_ldev_id псевдонимы: end_ldev string |
Номер последнего LDEV. Если указан этот атрибут, необходимо также указать start_ldev_id. Если указано ldevs, этот атрибут указывать нельзя. Обязателен для добавления/удаления LDEV с использованием диапазона идентификаторов LDEV. |
|
external_parity_groups list / elements=string |
Список внешних групп паритета для добавления в группу ресурсов или удаления из неё. |
|
force boolean |
Для операций удаления указывает, следует ли выполнить операцию принудительно. Необязателен для принудительного удаления группы ресурсов по идентификатору. Варианты:
|
|
host_groups list / elements=dictionary |
Список групп хостов для добавления в группу ресурсов или удаления из неё. Обязателен для операций создания, добавления или удаления, связанных с группами хостов. |
|
begin_id integer |
Идентификатор первой группы хостов. Если указан этот атрибут, необходимо также указать end_id. Для операций создания, добавления или удаления, связанных с группами хостов, необходимо указать одно из значений: ‘name’, ‘ids’ или ‘begin_id/end_id’. |
|
end_id integer |
Идентификатор последней группы хостов. Если указан этот атрибут, необходимо также указать begin_id. Для операций создания, добавления или удаления, связанных с группами хостов, необходимо указать одно из значений: ‘name’, ‘ids’ или ‘begin_id/end_id’. |
|
ids list / elements=integer |
Список идентификаторов групп хостов. Для операций создания, добавления или удаления, связанных с группами хостов, необходимо указать одно из значений: ‘name’, ‘ids’ или ‘begin_id/end_id’. |
|
name string |
Имя группы хостов. Для операций создания, добавления или удаления, связанных с группами хостов, необходимо указать одно из значений: ‘name’, ‘ids’ или ‘begin_id/end_id’. |
|
port_id псевдонимы: port string / обязательный |
Идентификатор порта, связанного с группой хостов. Обязателен для операций создания, добавления или удаления, связанных с группами хостов. |
|
id integer |
Идентификатор группы ресурсов. Необязателен для следующих задач: - Добавление перечисленных ресурсов в существующую группу ресурсов по идентификатору: LDEV, порты, группы хостов, идентификаторы подсистем NVM - Удаление перечисленных ресурсов из существующей группы ресурсов по идентификатору: LDEV, порты, группы хостов, идентификаторы подсистем NVM - Удаление группы ресурсов по идентификатору - Принудительное удаление группы ресурсов по идентификатору Обязателен для следующих задач: - Добавление LDEV в существующую группу ресурсов по идентификатору с использованием диапазона LDEV - Удаление LDEV из существующей группы ресурсов по идентификатору с использованием диапазона LDEV |
|
iscsi_targets list / elements=dictionary |
Список целей iSCSI для добавления в группу ресурсов или удаления из неё. Необязателен для операций добавления/удаления по имени. |
|
begin_id integer |
Идентификатор первой цели iSCSI. Если указан этот атрибут, необходимо также указать end_id. Для операций создания, добавления или удаления, связанных с целями iSCSI, необходимо указать одно из значений: ‘name’, ‘ids’ или ‘begin_id/end_id’. |
|
end_id integer |
Идентификатор последней цели iSCSI. Если указан этот атрибут, необходимо также указать begin_id. Для операций создания, добавления или удаления, связанных с целями iSCSI, необходимо указать одно из значений: ‘name’, ‘ids’ или ‘begin_id/end_id’. |
|
ids list / elements=integer |
Список идентификаторов целей iSCSI. Для операций создания, добавления или удаления, связанных с целями iSCSI, необходимо указать одно из значений: ‘name’, ‘ids’ или ‘begin_id/end_id’. |
|
name string |
Имя цели iSCSI. Для операций добавления/удаления необходимо указать одно из значений: ‘name’, ‘ids’ или ‘begin_id/end_id’. |
|
port_id псевдонимы: port string / обязательный |
Идентификатор порта, связанного с целью iSCSI. Обязателен для операций добавления/удаления по имени. |
|
ldevs list / elements=string |
Список LDEV для добавления в группу ресурсов или удаления из неё. Необязателен при создании группы ресурсов с LDEV или со следующими ресурсами: LDEV, группы паритета, порты, группы хостов, идентификаторы подсистем NVM. Также используется для операций добавления/удаления по идентификатору или имени. |
|
name string |
Имя группы ресурсов. Обязательно для следующих задач: - Создание группы ресурсов без ресурсов - Создание группы ресурсов с виртуальным серийным номером хранилища VSM - Создание группы ресурсов с LDEV - Создание группы ресурсов со следующими ресурсами: LDEV, группы паритета, порты, группы хостов, идентификаторы подсистем NVM - Создание группы ресурсов с идентификаторами пулов хранения и группами паритета - Добавление перечисленных ресурсов в существующую группу ресурсов по имени: LDEV, порты, группы хостов, цели iSCSI - Удаление перечисленных ресурсов из существующей группы ресурсов по имени: LDEV, порты, группы хостов, цели iSCSI - Удаление группы ресурсов по имени |
|
nvm_subsystem_ids list / elements=integer |
Список идентификаторов подсистем NVM для добавления в группу ресурсов или удаления из неё. Необязателен для операций создания или добавления/удаления по идентификатору. |
|
parity_group_ids псевдонимы: parity_groups list / elements=string |
Список групп паритета для добавления в группу ресурсов или удаления из неё. Необязателен при создании группы ресурсов с LDEV, группами паритета, портами, группами хостов и идентификаторами подсистем NVM либо с идентификаторами пулов хранения. |
|
port_ids псевдонимы: ports list / elements=string |
Список портов для добавления в группу ресурсов или удаления из неё. Необязателен для операций создания или добавления/удаления по идентификатору или имени. |
|
state string |
- Операция, выполняемая с ресурсами группы ресурсов. - add_resource — добавление ресурсов в группу ресурсов. - remove_resource — удаление ресурсов из группы ресурсов. Варианты:
|
|
storage_pool_ids list / elements=integer |
Тома пула для добавления в группу ресурсов или удаления из неё. Необязателен при создании группы ресурсов с идентификаторами пулов хранения и группами паритета. |
|
virtual_storage_model string |
Имя модели виртуального хранилища, связанной с группой ресурсов. Обязательно для задачи создания группы ресурсов с виртуальным серийным номером хранилища VSM. Варианты:
|
|
virtual_storage_serial string |
Виртуальный серийный номер хранилища, связанного с группой ресурсов. Обязателен для задачи создания группы ресурсов с виртуальным серийным номером хранилища VSM. |
state string | Требуемое состояние задачи группы ресурсов. Варианты:
|
storage_system_info dictionary | Информация о системе хранения. Это поле необязательно. |
|
serial string |
Серийный номер системы хранения. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: отсутствует | Определяет, следует ли запускать модуль в режиме проверки. |
Примечания
Примечание
- Если какой-либо ресурс в целевой системе хранения заблокирован, операции с группами ресурсов выполнить нельзя. В таких случаях перед выполнением операций с группами ресурсов разблокируйте ресурсы.
- Некоторые параметры будут объявлены устаревшими в будущих выпусках. Подробности и исходные имена см. в документации; используйте их вместо псевдонимов.
- Тип соединения
gatewayудалён начиная с версии 3.4.0. Если вам необходим этот тип соединения, используйте более раннюю версию.
Примеры
- name: Create a Resource Group with virtual storage serial number of VSM
hitachivantara.vspone_block.vsp.hv_resource_group:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
spec:
name: "my_resource_group_1"
virtual_storage_serial: "69200"
virtual_storage_model: "VSP G370"
- name: Get Resource Group by name
hitachivantara.vspone_block.vsp.hv_resource_group:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
spec:
name: "my_resource_group"
- name: Create a Resource Group with LDEVs, parity groups, port_ids, and host groups
hitachivantara.vspone_block.vsp.hv_resource_group:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
spec:
ldevs: [1, 2, 3]
parity_groups: ["PG1", "PG2"]
port_ids: ["CL1-A", "CL1-C"]
host_groups:
- port_id: "CL1-A"
name: "my_host_group_1"
- port_id: "CL1-A"
name: "my_host_group_2"
- name: Add resources to an existing Resource Group by ID
hitachivantara.vspone_block.vsp.hv_resource_group:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
spec:
state: add_resource
id: 4
ldevs: [3, 4]
host_groups:
- port: "CL1-A"
name: "my_host_group_3"
iscsi_targets:
- port: "CL1-C"
name: "my_iscsi_target_2"
- name: Remove resources from an existing Resource Group by ID
hitachivantara.vspone_block.vsp.hv_resource_group:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
spec:
id: 4
state: remove_resource
ldevs: [3, 4]
host_groups:
- port: "CL1-A"
name: "my_host_group_3"
iscsi_targets:
- port: "CL1-C"
name: "my_iscsi_target_2"
- name: Delete a Resource Group by ID forcefully
hitachivantara.vspone_block.vsp.hv_resource_group:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
state: absent
spec:
id: 4
force: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resource_groups list / elements=dictionary | Сведения о группе ресурсов. Возвращается: всегда |
|
host_groups list / elements=dictionary |
Список групп хостов в группе ресурсов. Возвращается: при успехе |
|
id integer |
Идентификатор группы хостов. Возвращается: при успехе Пример: |
|
name string |
Имя группы хостов. Возвращается: при успехе Пример: |
|
port string |
Устарело. Используйте вместо этого port_id. Возвращается: при успехе Пример: |
|
port_id string |
Идентификатор порта, связанного с группой хостов. Возвращается: при успехе Пример: |
|
id integer |
Идентификатор группы ресурсов. Возвращается: при успехе Пример: |
|
iscsi_targets list / elements=dictionary |
Список целей iSCSI в группе ресурсов. Возвращается: при успехе |
|
id integer |
Идентификатор цели iSCSI. Возвращается: при успехе Пример: |
|
name string |
Имя цели iSCSI. Возвращается: при успехе Пример: |
|
port string |
Имя порта, связанного с целью iSCSI. Возвращается: при успехе Пример: |
|
ldevs list / elements=integer |
Список LDEV в группе ресурсов. Возвращается: при успехе Пример: |
|
ldevs_hex list / elements=string |
Список LDEV в шестнадцатеричном формате в группе ресурсов. Возвращается: при успехе Пример: |
|
lock_status string |
Состояние блокировки группы ресурсов. Возвращается: при успехе Пример: |
|
name string |
Имя группы ресурсов. Возвращается: при успехе Пример: |
|
parity_groups list / elements=string |
Список групп четности в группе ресурсов. Возвращается: при успехе Пример: |
|
port_ids list / elements=string |
Список идентификаторов портов в группе ресурсов. Возвращается: при успехе Пример: |
|
ports list / elements=string |
Устарело. Используйте вместо этого port_ids. Возвращается: при успехе Пример: |
|
virtual_storage_id integer |
Идентификатор виртуального хранилища, связанного с группой ресурсов. Возвращается: при успехе Пример: |
|
virtual_storage_serial string |
Серийный номер виртуального хранилища, связанного с группой ресурсов. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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_resource_group_module.html