Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Notes and restrictions

You can check the imformation of restrictions applied when using the REST API.

Notes and restrictions

Notes on the VSP N series

In this manual, the phrase "VSP Gx00 models, VSP Fx00 models" should be interpreted to also include the following storage system models: VSP N400, VSP N600, VSP N800.

Executing an asynchronous processing API function to the REST API server

When a user executes an asynchronous processing API function job that takes two hours or more to process, the KART30031-E error occurs and the job fails.

This problem occurs if the user executes an API function command to perform one of the following tasks and the job takes two hours or more to complete.

  • Deleting a journal volume from a journal

  • Formatting a volume

  • Shredding a volume

  • Formatting a parity group

  • Deleting a parity group

  • Initializing the capacity-saving function for a pool

  • Shrinking a pool

  • Restoring a pool

  • Relocating a pool

Even though the KART30031-E error occurs, the request might have succeeded. Confirm the status of the resources.

Display of the pair concordance rate and the processing progress rate in the Thin Image pair information

If all of the following conditions are met, the progressRate attribute, which indicates the progress of processing, is displayed:

  • The isClone attribute of the pair is set to false.

  • The canCascade attribute of the pair is set to false.

  • The pair status is COPY, RCPY, SMPP, or PSUP.

In the above case, the value displayed for the progressRate attribute is actually the value of the concordanceRate attribute.

Problems related to the synchronization of the date and time between the NTP server and the storage system in REST API

A difference of several hours between the storage system's date and time and the NTP server's date and time occurs if all of the following conditions are met:

  • A time zone for which daylight saving time is supported is set.

  • Automatic adjustment of daylight saving time is enabled.

  • You synchronize the storage system with the NTP server during the transition period from standard time to daylight saving time or the transition period from daylight saving time to standard time.

To recover from this problem, synchronize with the NTP server again after the transition period from standard time to daylight saving time or the transition period from daylight saving time to standard time.

Problems related to automatic adjustments for daylight saving time in the date and time of the storage system in REST API

The symptoms of this problem occur if all of the following conditions are met:

  • A time zone for which daylight saving time is supported is set.

  • Automatic adjustment of daylight saving time is enabled.

Symptom 1:

  • An NTP server synchronization time that was set during standard time incorrectly changes to one hour earlier than the actual time when daylight saving time begins.

  • An NTP server synchronization time that was set during daylight saving time incorrectly changes to one hour later than the actual time when daylight saving time ends.

To resolve this problem, reset the NTP server synchronization time by re-executing the API function to change the date and time of the storage system after daylight saving time begins or ends.

Symptom 2:

  • When the date and time of the REST server is in daylight saving time and the date and time of the storage system is in standard time, a time one hour earlier than the time you request as the time of synchronization with the NTP server is set as the synchronization time for the storage system.

  • When the date and time of the REST server is in standard time and the date and time of the storage system is in daylight saving time, a time one hour later than the time you request as the time of synchronization with the NTP server is set as the synchronization time for the storage system.

To resolve this problem, set the same date and time for the REST server and the NTP server, and then re-set the NTP server synchronization time by re-executing the API function to change the date and time of the storage system.

Error on the API which multiple operations are performed internally

If the error occurred by using the following API, a part of the resource might be created.

  • HDT pool creation

When the error occurred, check the status of the resource, delete the resource created partially, and perform the API again.

Creating Thin Image pairs

If the following conditions are met, attempts to create Thin Image pairs fail, and the KART00000-E message is output.

  1. The specified snapshot group name is already being used for another snapshot group.

  2. The API command to create a Thin Image pair is executed when the API command to delete a Thin Image pair is executed at the same time, and both APIs are using the same pvolLdevId attribute without svolLdevId attribute.

If this problem occurs, re-execute the API command to create a Thin Image pair.

Restriction that applies when the maximum number of storage system resources is exceeded as a result of resource creation

If the maximum number of resources already exist on the storage system and you use one of the following API commands to create a new resource, the job might fail and the KART30013-E message might be output:

  • Creating a host group (without specifying hostGroupNumber)
  • Creating an LU path (without specifying lun)
If an error occurs and the KART30013-E message is output, obtain a list of the target resources and then check whether the number of the existing resources has reached the maximum number of resources allowed on the storage system. For details about the maximum number of resources that can be created on a storage system, see the Provisioning Guide.
Creating Thin Image pair

Creating Thin Image pair API may fail with KART40188-E or KART4009-E when clonesAutomation=true or autoSplit=true is specified.

Execute cloning Thin Image pair API or storing snapshot data API after confirming if pair status of Thin Image is "PAIR".

Getting a list of external path groups

When getting a list of external path groups in an environment where number of external path is 10000 or more, all of the information may not be obtained.

Perform the follow actions after checking the nextPageHeadPathGroupId in the external path group:

  • When the value of nextPageHeadPathGroupId is other than -1, execute the getting list of external path group API with specifying the value of nextPageHeadPathGroupId by the value of the previous headPathGroupId, and obtain the list of the external path groups in the range that could not be acquired.
  • When the value of nextPageHeadPathGroupId is -1, no additional action is required.
affectedResources when a job is executed by using the REST API

When any of the following operations is executed, affectedResources displays an incorrect URL.

  • Unmapping an external volume

    DELETE base-URL/v1/objects/external-parity-groups/object-ID
  • Removing an external path from an external path group

    POST base-URL/v1/objects/external-path-groups/object-ID/actions/remove-path/invoke
  • Disconnecting from an external volume

    POST base-URL/v1/objects/external-parity-groups/object-ID/actions/disconnect/invoke
  • Performing migration

    POST base-URL/v1/objects/local-clone-copypairs/object-ID/actions/migrate/invoke
  • Performing migration for an entire copy group

    POST base-URL/v1/objects/local-clone-copygroups/object-ID/actions/migrate/invoke

To check whether the above operations were successful, execute the following APIs.

  • Unmapping an external volume

    GET base-URL/v1/objects/external-path-groups
  • Removing an external path from an external path group

    GET base-URL/v1/objects/external-path-groups/object-ID
  • Disconnecting from an external volume

    GET base-URL/v1/objects/external-path-groups
  • Performing migration #

    GET base-URL/v1/objects/local-clone-copypairs/object-ID
  • Performing migration for an entire copy group #

    GET base-URL/v1/objects/local-clone-copygroups/object-ID
  • #: The possible pair statuses are as follows.

    If the pair status is PSUS: Migration succeeded.

    If the pair status is PSUE: Migration failed.

Device group name

Do not specify "dummydevgroup" as a device group name.

If "dummydevgroup" is specified as a device group name, API response takes much time, or error might occur with KART20022-E message.

Recovery procedure when REST API doesn't respond for a long period (VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900)

When REST API doesn't respond for a long period, reboot the GUM that the CTL has a problem by using maintenance utility. If REST API still doesn't respond after GUM is rebooted, detailed investigation is required. Collect the normal dump and contact the support center.

Copy group names and device group names for copy groups, and snapshot group IDs for snapshot groups

If any attribute of the following object IDs contains a comma ("," or "%2c"), the KART40014-E error occurs when an API for managing copy groups or snapshot groups is executed:

  • pvolDeviceGroupName
  • svolDeviceGroupName
  • localDeviceGroupName
  • remoteDeviceGroupName
  • copyGroupName
  • copyPairName
  • snapshotGroupId

Note that, when an object ID includes commas for combining attribute values, such commas do not cause the KART40014-E error.

About the operation of the pair

Do not register a pair with the same device group, when operating a pair over 2,048.

Divide the different device group, when create a pair over 2,048.

API operating a storage system becomes slow or fails to error in KART20022-E, when create a pair over 2,048 in the same device group.

Get list of remote copy groups limitations on running the API with the query "detailInfoType = Pair"

In case that the remote Storage System is one of VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, some attributes are not displayed.

  • If the volume on the Remote Storage System is P-VOL, the following attributes are not displayed:
    • pvolStatus
    • pvolIOMode
    • copyPace
  • If the volume on the Remote Storage System is S-VOL, the following attributes are not displayed:
    • svolStatus
    • svolIOMode

In case that a remote Storage system is one of Virtual Storage Platform, HUS VM, do not displayed some attributes of the TrueCopy pair.

  • If the volume on the Remote Storage System is P-VOL, the following attributes are not displayed:
    • pvolStatus
    • copyPace
  • If the volume on the Remote Storage System is S-VOL, the following attributes are not displayed:
    • svolStatus
Note on the management of VSP 5000 series storage systems

If an API request is executed during controller maintenance or when a controller failure has occurred, the API request might fail, and one of the following error messages might be output: KART40047-E, KART30102-E, KART30011-E, KART00007-E or KART20022-E.

If an error occurs, wait until the maintenance work is complete, and then execute the API request again.

The problem persists with KART30043-E after you handled solutions.

If the problem persists after you handled solutions that is described in KART30043-E, confirm the storage system supports functions you are trying to retrieve or perform.

Notes when a resource is locked after a specific REST API fails.

If the resource is still locked after the following REST API fails to run, unlock the resource forcibly by using Storage Navigator.

  • PATCH base-URL/v1/objects/auditlog-syslog-servers/instance
  • POST base-URL/v1/objects/clprs
  • DELETE base-URL/v1/objects/clprs/object-ID
  • PATCH base-URL/v1/objects/clprs/object-ID
  • POST base-URL/v1/objects/actions/file-upload/invoke
  • PATCH base-URL/v1/objects/journals/object-ID
  • POST base-URL/v1/objects/resource-groups
  • DELETE base-URL/v1/objects/resource-groups/object-ID
  • POST base-URL/v1/objects/resource-groups/object-ID/actions/add-resource/invoke
  • POST base-URL/v1/objects/resource-groups/object-ID/actions/remove-resource/invoke
  • PATCH base-URL/v1/objects/snmp-settings/instance
  • POST base-URL/v1/objects/users
  • DELETE base-URL/v1/objects/users/object-ID
  • PATCH base-URL/v1/objects/users/object-ID
  • POST base-URL/v1/objects/users/object-ID/actions/add-user-group/invoke
  • POST base-URL/v1/objects/users/object-ID/actions/remove-user-group/invoke
  • POST base-URL/v1/objects/user-groups
  • DELETE base-URL/v1/objects/user-groups/object-ID
  • PATCH base-URL/v1/objects/user-groups/object-ID
  • POST base-URL/v1/objects/user-groups/object-ID/actions/add-resource-group/invoke
  • POST base-URL/v1/objects/user-groups/object-ID/actions/remove-resource-group/invoke
Adding resources to or removing resources from a resource group that is a virtual storage machine (VSP 5000 series, VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900)

When the resources that include a host group, an iSCSI target, or an LDEV to which an LU path is mapped are added to or removed from a resource group that is a virtual storage machine, the following API requests fail with the KART40206-E error.

Delete the LU path before executing these API requests.

Applicable API requests:

  • Adding a resource to a resource group

    POST base-URL/v1/objects/resource-groups/object-ID/actions/add-resource/invoke

  • Removing a resource from a resource group

    POST base-URL/v1/objects/resource-groups/object-ID/actions/remove-resource/invoke

Creating a resource group by specifying a virtual storage machine on VSP E series

To create a resource group by specifying a virtual storage machine on VSP E series, specify virtualStorageDeviceId instead of virtualStorageId.

Applicable API request:

  • Creating a resource group

    POST base-URL/v1/objects/resource-groups

The ipAddress attribute of the API for getting a list of sessions

The ipAddress attribute of the API for getting a list of sessions might not display a string (the content of the X-Forwarded-For header received by the REST API server) that is a concatenation of the IP addresses of the client and an intermediate server. Reference this attribute only when referencing the IP address of a client that communicated directly with the REST API server.

Setting TLS for storage system of VSP 5100, 5500, 5100H, 5500H

If TLS1.2 is disabled for VSP 5100, 5500, 5100H, 5500H, attempts to perform a remote copy operation on a combination of the VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 and the VSP 5100, 5500, 5100H, 5500H fail with KART40097-E or KART40098-E.

When you run those operations, set the TLS1.2.

To perform TLS settings on storage system of the VSP 5100, 5500, 5100H, 5500H, see Setting SSL/TLS communications using Device Manager - Storage Navigator in the System Administrator Guide for VSP 5000 series.

Applicable API request:

  • POST base-URL/v1/objects/remote-storages
  • DELETE base-URL/v1/objects/remote-storages/object-ID
  • GET base-URL/v1/objects/remote-mirror-copygroups
  • GET base-URL/v1/objects/remote-mirror-copygroups/object-ID
  • DELETE base-URL/v1/objects/remote-mirror-copygroups/object-ID
  • GET base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/split
  • POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/split/invoke
  • GET base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/resync
  • POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/resync/invoke
  • POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/takeover/invoke
  • GET base-URL/v1/objects/remote-mirror-copypairs/object-ID
  • POST base-URL/v1/objects/remote-mirror-copypairs
  • DELETE base-URL/v1/objects/remote-mirror-copypairs/object-ID
  • GET base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/split
  • POST base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/split/invoke
  • GET base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/resync
  • POST base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/resync/invoke
  • POST base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/takeover/invoke