Getting started

Last updated
Save as PDF

Registering a license (CLI or REST API)

To request and register a license, contact your sales account representative to purchase a license key. To purchase a license key, you must provide the storage cluster ID and type of license you require. Depending on the type of the license, you also must notify the licensed capacity and period.

Tip

You can obtain the ID of the storage cluster by running the command described in Obtaining information about storage clusters or clicking the Cluster information icon in the GUI.

Caution

After reconfiguring a storage cluster, the license key issued before reconfiguring a storage cluster cannot be used for a new storage cluster. In this case, contact your sales account representative to re-issue a license key that corresponds to the new storage cluster ID, and then register the new license.

Before you begin

Required role: Storage

Procedure

Contact your sales account representative to purchase a license key.

To purchase a license key, you must provide the storage cluster ID and type of license you require. Depending on the type of the license, you also must notify the licensed capacity and period.

You can obtain the ID of the storage cluster by running the command described in Obtaining information about storage clusters or clicking the Storage Cluster Information icon in the GUI.
Register a license.

Run one of the following commands with the license key specified.

REST API: POST /v1/objects/licenses

CLI: license_install

Verify the job ID which is displayed after the command is run.
Verify the state of the job by specifying the job ID.

REST API: GET /v1/objects/jobs/<jobId>

CLI: job_show

If the job state is "Succeeded", the job is completed.
Back up the configuration information.

Perform this step by referring to Backing up the configuration information.

If you continue operations with other procedures, you must back up the configuration information after you have completed all operations.

Allocating volumes to compute nodes

Perform the following procedures to connect compute nodes to the Virtual Storage Software block storage system:

Verify the requirements for compute nodes to be installed.
Register information about all compute nodes that handle the storage system.
Register initiator information of compute nodes.
Register path information of compute nodes.

In addition, to use the storage system from a compute node, in the storage pool, create a volume for storing user data.

To enable the compute node to handle the created volume, set up a path between the volume and the compute node.

Category	See:	Is there a GUI operation?
Allocate volumes to compute nodes	1. Installing a compute node
	2. Registering information about compute nodes (CLI or REST API)	Yes
	3. Registering information about the initiators for compute nodes (CLI or REST API)
	4. Registering path information about compute nodes (CLI or REST API)
	5. Creating volumes (CLI or REST API)	Yes
	6. Allocating volumes to compute nodes (CLI or REST API)	Yes

Expanding storage pools (CLI or REST API)

When you finish setting up Virtual Storage Software block, the storage pool is created with the name specified in the VSSB configuration file (SystemConfigurationFile.csv). The storage pool is empty. Therefore, you must add drives to the storage pool.

To perform this operation, you need the Storage role. If setup is completed, a user is created in ServiceAdministrators. Because the Service and Storage roles are set for ServiceAdministrators, you can expand storage pools by using the user created in ServiceAdministrators. By using this user and user ID as credentials when running commands, perform the following procedures.

Caution

If there is an operation that was performed before this procedure, confirm that the process is completed or terminated due to an error before performing this procedure. If the operation that was performed before this procedure is terminated due to an error, and the event log indicates the action that needs to be taken before this procedure, take that action, and then perform this procedure.

Before you begin

Required role: Storage

Procedure

Before you expand a storage pool, verify the logical capacity, free capacity, ID, rebuild capacity policy, and tolerable number of drive failures of the intended storage pool.

If you use the CLI to specify a storage pool by name, check the name of the storage pool.

REST API: GET /v1/objects/pools

CLI: pool_list
Change the rebuild capacity policy as necessary to suit your operation.

For details, see Editing storage pool settings.

Caution
If you change the rebuild capacity policy after expanding storage pools, sufficient rebuild capacity might not be secured. Therefore, if you want to change the rebuild capacity policy, do so before expanding storage pools.
Verify the status of the storage node containing the drive you want to add.

REST API: GET /v1/objects/storage-nodes

CLI: storage_node_list

If the status of the storage node is "Ready" or "RemovalFailed", go to step 3.
Verify drive IDs.

REST API: GET /v1/objects/drives

CLI: drive_list
Add drives to the storage pool.

Run either of the following commands with the ID of the intended storage pool and the IDs of the drives to be added specified.

If you use the CLI, you can specify a name instead of the ID of the storage pool.

REST API: POST /v1/objects/pools/<id>/actions/expand/invoke

CLI: pool_expand

Verify the job ID which is displayed after the command is run.

Caution
To perform other operations, make sure that the storage pool has been expanded as described in step 7 before doing so.
Verify the state of the job by specifying the job ID.

REST API: GET /v1/objects/jobs/<jobId>

CLI: job_show

After running the command, if you receive a response indicating "Succeeded" as the state, the job is completed. Subsequently, capacity allocation to the storage controller, which is internal processing, is performed. Upon completion of these processes, the added capacity will be available for use.

The processing time (approximate) for capacity allocation to storage controller can be calculated by the following formula.

The processing is executed in each storage controller in parallel. Therefore, the total processing time is almost the same as the processing time for a single storage controller.
- For HPEC 4D+1P:
  
  30 [sec] × (total physical capacity of drives per storage node / 121 [GiB])
- For HPEC 4D+2P:
  
  30 [sec] × (total physical capacity of drives per storage node / 145 [GiB])
- For Mirroring Duplication:
  
  30 [sec] × (total physical capacity of drives per storage node / 194 [GiB])
Caution
If physical capacity of a storage node exceeds the capacity that can be allocated to a storage controller, the calculated approximate processing time might be longer. For details about the maximum capacity that can be allocated to a storage controller, contact customer support
Obtain event logs to make sure that the drives specified in step 5 can now be used as storage pool capacity.

Wait for the event log KARS16020-I to output as many storage nodes as possible. Until then, you may not be able to perform other operations.

If you get as many KARS16020-I event logs as the number of storage nodes, the storage pool has been expanded as specified.

When you expand a storage pool, if the KARS16046-I message is output to the event log, the logical capacity has not been configured. To configure the logical capacity, add necessary drives to the storage pool. For details, see Capacity design (for HPEC 4D+1P), Capacity design (for HPEC 4D+2P), or Capacity design (for Mirroring).
Obtain information about the storage pool that has the newly-added drives.

REST API: GET /v1/objects/pools

CLI: pool_list

Verify that the logical capacity and free capacity of the storage pool has increased as a result of adding the drives.
Back up the configuration information.

Perform this step by referring to Backing up the configuration information.

If you continue operations with other procedures, you must back up the configuration information after you have completed all operations.

Tip
A drive whose status is "Offline" is not incorporated into the storage pool. You can verify the drive status from drive information.

About Virtual Storage Software block GUI

Virtual Storage Software block GUI is a software product that allows for easy verification of the status and total configuration of a storage system and information about individual resources managed by Virtual Storage Software block with easy navigation and fast response. You can also perform various operations related to volumes, drives, storage nodes, and compute nodes, and operations for dump log files.

For user permissions, see the required role in Before you begin for each operation.

Requirements for web browsers to use the GUI

The following table lists the requirements for web browsers for using the GUI.

Web browser	OS
Microsoft Edge (Latest version of stable channel)	Windows platform supported by the web browser.
Google Chrome (Latest version of stable channel)	Windows or Linux platform supported by the web browser.

Note

Do not use "Refresh" of the web browser. Using it might cause an unexpected window to be displayed. If an unexpected window is displayed, close the web browser, and then retry login.
After you have updated the storage software, re-open the GUI
Some screen magnification settings might cause screen display abnormality. For example, buttons might become unclickable. In such a case, use the zoom function of the web browser to adjust the magnification.
If GUI screens are displayed in multiple windows or if tabs that contain GUI screens are inactive, the refresh interval for charts and other screens pertaining to performance information might become longer. You might be able to mitigate the issue by performing the following operations:
- Reduce the number of tabs and windows as much as possible.
- Make sure that charts and other screens pertaining to performance information are displayed in the active tab of each window as much as possible.
If "Waiting for available socket..." is displayed in the web browser, and the operation slows down, you may be able to resolve the issue by restarting the web browser.
If "Loading…" is displayed and stays in the top left of the window, the network might not be operating normally. Verify whether the network is operating normally, close the tab once, and then open the tab again to use the GUI.
If an icon is not displayed or displayed abnormally (for example, when □ is displayed instead of the icon), the network might not be operating normally. Verify whether the network is operating normally, close the tab once, and then open the tab again to use the GUI.
If the operation icon button is not displayed, verify that the user is assigned appropriate permissions. When the user has appropriate permissions, the network might not be operating normally. Verify whether the network is operating normally, close the tab once, and then open the tab again to use the GUI.
When the number of resources to be displayed in the volumes window or other windows becomes large, it might take longer for the windows to be displayed.

How to set the browser to use the GUI

To use the GUI, set the browser as follows.

Browser to be used	Required setting	Setting Description
Microsoft Edge	Enabling JavaScript	For details about how to set the web browser, see Help of your web browser.
	Enabling Cookies
	Enabling automatic download of multiple files
	Disabling sleep status of inactive tabs
Google Chrome	Enabling JavaScript
	Enabling Cookies
	Enabling automatic download of multiple files

Logging in to and logging out of the GUI

This section describes how to log in to and log out from the GUI.

When you log in to the GUI, a new session is generated. When you log out of the GUI, the session ends.

Before you begin

Required role: Security, Storage, Monitor, or Service

Procedure

In the web browser, enter the following URL:

https://<<IP-address-or-corresponding-FQDN>>[:443]/hsds/
- <<IP-address-or-corresponding-FQDN>>: Specify one of the following IP addresses set in the VSSB configuration file (SystemConfigurationFile.csv) or the corresponding FQDN :
  - Representative IP address (ClusterIpv4Address) of the storage cluster or the corresponding FQDN if representative IP address (ClusterIpv4Address) of the storage cluster is set
  - Any IP address (ControlNWIPv4) for the storage node control network or the corresponding FQDN if no representative IP address (ClusterIpv4Address) of the storage cluster is set
  Tip
  For details about server certificate verification, see Client requirements for SSL/TLS communication. When you specify the FQDN, the DNS that enables the IP address for the control network to be resolved by forward lookup from the FQDN of the storage node must be registered in the system from which the web browser is started.
- "443" is a port number. ":443" can be omitted.
When the Login window opens, enter your user ID and password to log in.

Logging in shows the dashboard window. The dashboard window displays total information about the Virtual Storage Software block storage system.
- Your account will be locked if your login is unsuccessful multiple consecutive times. Wait until your account is unlocked, and then retry the login.
To log out, click the user icon in the navigation bar and then select Logout.

Dashboard window

The dashboard window displays the following information about the Virtual Storage Software block storage system.

Health status for each resource type
Logical capacity and used capacity of the storage pool
Used capacity reduction effect
Data reduction effect
System performance information
Number of resources

Note

Performance information is displayed only for users who have the Storage, Monitor, or Resource role.
If volume migration is running, a value including the number of I/Os issued by the volume migration is displayed in the performance information.
When a storage node has a high load, the chart of performance information might not be fully displayed, but it will be fully displayed after a while.
Total Efficiency indicates the used capacity reduction effect achieved by the volume creation function and snapshot function.

This is an average ratio, where the ratio of usedCapacity (used capacity of the storage pool) to totalVolumeCapacity (total capacity of created volumes)^* is calculated for each storage controller, and then weighted according to the total capacity of the created volumes for each storage controller. The larger the total capacity of created volumes of a storage controller is, the more the capacity reduction effect of that storage controller are reflected to the Total Efficiency value.

* You can get the value of used capacity of the storage pool (usedCapacity) and the value of total capacity of created volumes (totalVolumeCapacity) by obtaining information about the storage pool. You can verify the used capacity of the storage pool (usedCapacity) in USED of USED/TOTAL in Summary on the Storage Pool window, and the total capacity of created volumes (totalVolumeCapacity) in TOTAL CAPACITY of VOLUME CAPACITY INFORMATION on the Storage Pool window.

When the ratio is larger than 99999.99:1, it is displayed as ">99999.99:1".
When snapshot volumes are used, the used storage pool capacity can be reduced by storing only the differential data between P-VOL and S-VOL. Therefore, the value of totalEfficiency is larger than that when snapshot volumes are not included, even if the total capacity of created volumes is the same.
When storage pool expansion processing is being performed and KARS16017-I, KARS16020-I, KARS16022-I, or KARS16081-I is output, the value of totalEfficiency might become larger even when snapshot operations are not being performed. Note that snapshot operations refer to preparation (for obtaining snapshots) and obtaining, deleting, and restoring snapshots.
Volumes whose type is “ExternalMigrationOrigin” are not included in the number of volumes.

Health status

The health status indicates the status ("Normal" or "Alerting") of each resource. For example, "Normal" displayed for resource type "Storage Nodes" in the health status display area indicates that the STATUS SUMMARY of all storage nodes is "Normal". If "Alerting" is displayed for resource type "Nodes", there is at least one storage node whose STATUS SUMMARY is "Warning" or "Error".

If the health status could not be obtained, the following is displayed in the health status display area.

Also, a health status summary is displayed in the navigation bar. Each status description is as follows:

"Normal": The health status of all resource types is "Normal".
"Alerting": There is at least one resource type whose status is "Alerting".
"Unknown": The health status could not be obtained.

Clicking the health status summary opens the dashboard window.

Caution

The health status of the storage cluster and the health status summary displayed in the navigation bar do not indicate the boot status of the storage cluster.

For details about how to start a storage cluster, contact customer support

Navigation bar

You can perform the following operations from the navigation bar at the top of the GUI window.

Caution

The ID displayed when clicking "Register Storage Cluster Service ID" from the gear icon is the one set by service personnel or maintenance personnel. This function is unavailable for users.

Note

Clicking the gear icon displays the following menu items:
- Jobs: Displayed only to users with the Storage, Service, or Security role.
- Dump Log Files: Displayed only to users with the Service role.
- Import System Requirements File: Displayed only to users with the Service role.
- Licenses: Displayed only to users with the Storage, Monitor, or Resource role.
- Register Storage Cluster Service ID: Displayed only to users with the Storage or Service role.
You can verify the model name of Virtual Storage Software block by clicking the Storage Cluster Information icon.
- MODEL NAME = "VSSB": Virtual machine model
- MODEL NAME = "VSSBB1": Bare metal model

Clicking each item displays the following information.

EVENT: Displays the event logs.
MONITOR: Displays performance information in a chart. "MONITOR" is displayed only for users who have the Storage, Monitor, or Resource role.
PROTECTION DOMAIN: Displays information about the protection domain and fault domain.
STORAGE NODES: Displays information about the storage nodes.
DRIVES: Displays information about the drives.
COMPUTE NODES: Displays information about the compute nodes.
VOLUMES: Displays information about the volumes.
STORAGE POOLS: Displays information about the pools.
PORTS: Displays information about the compute ports, internode ports, and control ports.

Note

Do not use "Back", "Forward", or "Refresh" of the web browser. Using any of these functions might cause an unexpected window to be displayed. If an unexpected window is displayed, close the web browser, and then retry login.

Displaying performance information about storage systems

The performance information for each resource collected by Virtual Storage Software block can be displayed on the System Monitor window. Performance information can be displayed by specifying a range for the last 2 hours.

Before you begin

Required role: Storage, Monitor, or Resource role

Procedure

Click MONITOR on the navigation bar.

The System Monitor window opens.
Select Report Type.
Select Metric Type.
In Target, specify resource IDs or names (up to 32, delimited by commas). You can specify a combination of IDs and names.

If you selected Storage Node for Report Type, clicking the check box to the left of [Select All resources] selects all the resources.
Click Apply.

The performance information is displayed.

If multiple resource IDs are specified in step 4, a chart for the specified multiple resources will be displayed with a legend.
Note
- If a processing that involves I/O operations, such as volume migration and drive data relocation, is running, values including performance information for the I/Os are displayed in the performance information.
- Click CSV EXPORT to save the displayed performance information as a CSV file.
- When a storage node has a high load, the chart of performance information might not be fully displayed, but it will be fully displayed after a while.

Monitor link

The monitor link icon is displayed in the list window or the detailed information window of nodes, drives, volumes, or ports. It is also displayed in the list of compute ports, internode ports, or control ports, which is related information about the node detailed information window.

However, the Monitor link icon is displayed only for users who have the Storage, Monitor, or Resource role.

Clicking the activated monitor link icon selects the resource ID having this icon and displays the System Monitor window with the report type and resource ID set.

You can select a maximum of 32 resources. To select multiple resources, click the checkbox in each resource. The Monitor link icon to the right of the [Select All] will be activated.

Clicking on the Monitor link icon opens the System Monitor window with a chart of the specified multiple resources displayed with a legend.

To select all resources, click the checkbox to the left of [Select All]. If 33 or more resources are selected, the Monitor link to the right of [Select All] is not activated because up to 32 resources can be selected. Clear the selection by clicking the checkbox in each resource and set the number of selections to 32 or less.

Be careful when clicking the checkbox to the left of [Select All]. Resources will be selected over multiple pages.

Performing maintenance

The Storage Node list window, Storage Node detailed information window, Drive list window, and Drive detailed information window have a Maintenance link icon.

The Maintenance link icon is displayed only to users that can perform maintenance. For details about user's privilege, see "Required role" as a prerequisite for each procedure.

The following table shows the menus that are displayed when you click an active Maintenance icon and their respective transition-destination windows (displayed when you click a menu).

Window	Menu to be displayed	Transition-destination window
Drives list window Drive detailed information window	Remove Drives	Drive removal dialog. This dialog is displayed with SERIAL NO of the drive to be removed set.
	Add Drives	Drive addition dialog. This dialog is displayed with SERIAL NO of the drive to be added set.
	Turn On/Off Locator LEDs	Locator LED on/off dialog. This dialog is displayed with SERIAL NO of the drive (whose Locator LED is to be turned on/off) set.
Storage Node list window Storage Node detailed information window	Maintenance Recovery	Storage node maintenance recovery dialog. This dialog is displayed with the name of the storage node subject to maintenance recovery set.
	Maintenance Blockade	Storage node maintenance blocking dialog. This dialog is displayed with the name of the storage node subject to maintenance blocking set.

How many resources can be selected varies depending on the displayed menu. To select multiple resources, click the check box in each resource. Doing this activates the Maintenance icon to the right of the Monitor link icon.

Clicking an activated Maintenance icon shows menus from which you can open transition-destination windows that display the specified number of resources.

Check the maximum number of selectable items for each menu to be displayed by operating each menu.

To select all resources, click the check box to the left of [Select All]. If you select more resources than are allowed, the Maintenance icon to the right of the Monitor link icon is deactivated. Clear the selection by clicking the check box in each resource, and then set the number of resource selections to the maximum or less.

Viewing the List window

Selecting an item in the list view opens a window showing detailed information.

You can perform keyword search, filtering, and sort in the list window.

Depending on the resource, the following icons are shown so that you can perform editing and other operations.

A set of icons shown to the right of [Select All] are used for operations on the selected resources. A set of icons shown for each resource are for operations on that resource.

Clicking the switching icon toggles between Inventory view and List view.

■List view

■Inventory view

Viewing the detailed information window

Clicking an item in the list window opens the detailed information window related to that item. (An overview is displayed at the top, and related information is displayed at the bottom.)

The related information area allows you to perform keyword search and filtering. Selecting an item in the displayed list opens its corresponding detailed information window. In some windows, clicking the tab toggles between the lists of related information.

Depending on the resource, the following icons are shown so that you can perform editing and other operations.

Refresh display

In the window with the refresh icon, clicking the refresh icon refreshes the displayed information.

Help display

In the window with the help icon, clicking the help icon shows the help information.

■Help display example

Pop-up message display

You can check the operation result on the pop-up message displayed at the right bottom of the window.

Clicking the x icon closes the pop-up message.

If the operation fails, you can check the details by clicking Details on the pop-up message.

■Example display of pop-up messages when operations succeed

■Example display of a pop-up message when an operation fails

We've Moved!

Product Documentation has moved to docs.hitachivantara.com

Registering a license (CLI or REST API)

Allocating volumes to compute nodes

Expanding storage pools (CLI or REST API)