Getting information about a storage system

Storage Advisor Embedded User Guide
Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

The following request obtains information about a storage system.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/storage

Request message

Object ID
None.
Query parameters
None.
Body
None.

Response message

Body
{
    "modelName": "VSP E1090",
    "serial": "700001",
    "nickname": "VSP_E1090_700001",
    "numberOfTotalVolumes": 100,
    "numberOfFreeDrives": 12,
    "numberOfTotalServers": 240,
    "totalPhysicalCapacity": 95334400,
    "totalPoolCapacity": 40960,
    "usedPoolCapacity": 0,
    "freePoolCapacity": 40960,
    "totalPoolCapacityWithTiPool": 40960,
    "usedPoolCapacityWithTiPool": 0,
    "freePoolCapacityWithTiPool": 40960,
    "savingEffects": {
        "efficiencyDataReduction": 220,
        "preCapacityDataReduction": 0,
        "postCapacityDataReduction": 0,
        "efficiencyFmdSaving": 120,
        "preCapacityFmdSaving": 1234,
        "postCapacityFmdSaving": 1028,
        "isTotalEfficiencySupport": true,
        "totalEfficiencyStatus": "Valid",
        "dataReductionWithoutSystemDataStatus": "Valid",
        "softwareSavingWithoutSystemDataStatus": "Valid",
        "totalEfficiency": 12345,
        "dataReductionWithoutSystemData": 102,
        "preCapacityDataReductionWithoutSystemData": 0,
        "postCapacityDataReductionWithoutSystemData": 0,
        "softwareSavingWithoutSystemData": 103,
        "calculationStartTime": "2022-02-24T01:12:54Z",
        "calculationEndTime": "2022-02-24T01:22:54Z"
    },
    "gumVersion": "93-06-01/00",
    "dkcMicroVersion": "93-06-01-80/00",
    "warningLedStatus": "OFF",
    "ipAddressIpv4Ctl1": "1.2.3.4",
    "ipAddressIpv4Ctl2": "1.2.3.4",
    "ipAddressIpv6Ctl1": "::",
    "ipAddressIpv6Ctl2": "::"
}

Attribute

Type

Description

modelName

string

Model name of the storage system

serial

string

Serial number of the storage system

nickname

string

Nickname of the storage system

numberOfTotalVolumes

int

Number of created volumes

numberOfFreeDrives

int

Number of free drives

numberOfTotalServers

int

Number of servers managed by Storage Advisor Embedded

totalPhysicalCapacity

long

Capacity of data that can be stored in the data drives of the storage system (MiB)

totalPoolCapacity

long

Total capacity of the pools managed by Storage Advisor Embedded (MiB)

usedPoolCapacity

long

Total used capacity of the pools managed by Storage Advisor Embedded (MiB)

freePoolCapacity

long

Total free capacity of the pools managed by Storage Advisor Embedded (MiB)

totalPoolCapacityWithTiPool

long

Total capacity of the pools in the storage system (MiB)

usedPoolCapacityWithTiPool

long

Total used capacity of the pools in the storage system (MiB)

freePoolCapacityWithTiPool

long

Total free capacity of the pools in the storage system (MiB)

savingEffects

object

Information about the capacity (amount and percentage) saved throughout the storage system by the capacity saving and accelerated compression:

  • efficiencyDataReduction (int)1

    Percentage of all the data managed by Storage Advisor Embedded saved by using the capacity saving (deduplication and compression)

    The value before reduction appears. This value is calculated under the assumption that the value after reduction is 100.

    Example: If the value before reduction is 105 and the value after reduction is 100, "efficiencyDataReduction": 105 appears.

    You can convert it a ratio by dividing it by 100. Example: 105 / 100 = 1.05:1.

    If -1 appears, this value is invalid. Invalid value -1 is returned in case of that there is no data subject to reduction.

  • preCapacityDataReduction (long)1

    Capacity of all the data managed by Storage Advisor Embedded before reduction by using the capacity saving (deduplication and compression) (MiB)

  • postCapacityDataReduction (long)1

    Capacity of all the data managed by Storage Advisor Embedded after reduction by using the capacity saving (deduplication and compression) (MiB)

  • efficiencyFmdSaving (int)

    Percentage of the entire storage system capacity saved by using the accelerated compression

    The value before reduction appears. This value is calculated under the assumption that the value after reduction is 100.

    Example: If the value before reduction is 105 and the value after reduction is 100, "efficiencyFmdSaving": 105 appears.

    You can convert it a ratio by dividing it by 100. Example: 105 / 100 = 1.05:1.

    If -1 appears, this value is invalid. Invalid value -1 is returned in case of that there is no data subject to reduction.

    For VSP E series storage systems, -1 appears, indicating an invalid value.

  • preCapacityFmdSaving (long)

    Entire storage system capacity before reduction by using the accelerated compression (MiB)

    If the invalid value -1 appears for the attribute efficiencyFmdSaving, 0 appears for this attribute.

  • postCapacityFmdSaving (long)

    Entire storage system capacity after reduction by using the accelerated compression (MiB)

    If the invalid value -1 appears for the attribute efficiencyFmdSaving, 0 appears for this attribute.

  • isTotalEfficiencySupport (boolean)

    Whether the saving efficiency for consumption of capacity (referred hereafter to as total efficiency) by using the function for improving the usage efficiency of the storage system (the capacity saving (deduplication and compression), the accelerated compression, snapshots, and Dynamic Provisioning) is supported

    • true: Supported
    • false: Not supported

    For VSP E series storage systems, the saving efficiency achieved by using the accelerated compression function is not included.

  • totalEfficiencyStatus (string)

    Status of the total efficiency for the entire storage system

    • Valid: Valid
    • NotSupported: Not supported
    • CalculationInProgress: Being calculated
    • NoTargetData: No data to calculate
    • Unknown: Unknown
  • dataReductionWithoutSystemDataStatus (string)

    Status of the entire storage system capacity saved by using the capacity saving (deduplication and compression) and the accelerated compression

    • Valid: Valid
    • NotSupported: Not supported
    • CalculationInProgress: Not calculated yet
    • NoTargetData: No data to calculate
    • Unknown: Unknown

    For VSP E series storage systems, the saving efficiency achieved by using the accelerated compression function is not included.

  • softwareSavingWithoutSystemDataStatus (string)

    Status of the effect of reduction, due to the capacity saving (deduplication and compression), in the entire storage system for volumes for which the capacity saving is enabled.

    • Valid: Valid
    • NotSupported: Not supported
    • CalculationInProgress: Not calculated yet
    • NoTargetData: No data to calculate
    • Unknown: Unknown

    This information appears only for VSP E series storage systems.

  • totalEfficiency (long)2

    Percentage of the total efficiency for the entire storage system

    The value before reduction appears. This value is calculated under the assumption that the value after reduction is 100.

    Example: If the value before reduction is 529652 and the value after reduction is 100, "totalEfficiency": 529652 appears.

    After a volume is created from a pool and before data is written to the volume, the maximum value (9223372036854775807) appears.

    By checking the attribute calculationStartTime or calculationEndTime, you can check the date and time when calculation processing started or finished.

    In the following cases, -1 appears, to indicate an invalid value.

    • The value of the attribute isTotalEfficiencySupport is false.
    • The value of the attribute totalEfficiencyStatus is NotSupported, CalculationInProgress, or NoTargetData.
  • dataReductionWithoutSystemData (long)2

    Percentage of the entire storage system capacity saved by using the capacity saving (deduplication and compression) and the accelerated compression

    The value before reduction appears. This value is calculated under the assumption that the value after reduction is 100.

    Example: If the value before reduction is 138 and the value after reduction is 100, "dataReductionWithoutSystemData" : 138 appears.

    For VSP E series storage systems, the saving efficiency achieved by using the accelerated compression function is not included.

    By checking the attribute calculationStartTime or calculationEndTime, you can check the date and time when calculation processing started or finished.

    In the following cases, -1 appears, to indicate an invalid value.

    • The value of the attribute isTotalEfficiencySupport is false.
    • The value of the attribute dataReductionWithoutSystemDataStatus is NotSupported, CalculationInProgress, or NoTargetData.
  • softwareSavingWithoutSystemData (long)2

    Percentage of the effect of reduction, due to the capacity saving (deduplication and compression), in the entire storage system for volumes for which the capacity saving is enabled.

    The value before reduction appears. This value is calculated under the assumption that the value after reduction is 100.

    Example: If the value before reduction is 138 and the value after reduction is 100, "softwareSavingWithoutSystemData" : 138 appears.

    This information appears only for VSP E series storage systems.

    In the following cases, -1 appears, to indicate an invalid value.

    • The value of the attribute isTotalEfficiencySupport is false.
    • The value of the attribute softwareSavingWithoutSystemDataStatus is NotSupported, CalculationInProgress, or NoTargetData.
  • preCapacityDataReductionWithoutSystemData (long)2

    Entire storage system capacity before reduction by using the capacity saving (deduplication and compression) (MiB)

    If the value of the attribute isTotalEfficiencySupport is false, -1 appears, to indicate an invalid value.

  • postCapacityDataReductionWithoutSystemData (long)2

    Entire storage system capacity after reduction by using the capacity saving (deduplication and compression) (MiB)

    If the value of the attribute isTotalEfficiencySupport is false, -1 appears, to indicate an invalid value.

  • calculationStartTime (ISO8601string)

    The date and time (UTC) when calculation processing started appears in the following format: YYYY-MM-DDThh:mm:ssZ.

  • calculationEndTime (ISO8601string)

    The date and time (UTC) when calculation processing finished appears in the following format: YYYY-MM-DDThh:mm:ssZ.

gumVersion

string

GUM version

dkcMicroVersion

string

Microcode version of the storage system

warningLedStatus

string

Status of failures in the storage system:

  • OFF: The status is normal.
  • ON: A failure has occurred.
  • BLINK: An unidentified SIM exists.
  • Unknown: Unknown

ipAddressIpv4Ctl1

string

IP address for IPv4 on controller 1 (CTL1)

ipAddressIpv4Ctl2

string

IP address for IPv4 on controller 2 (CTL2)

ipAddressIpv6Ctl1

string

IP address for IPv6 on controller 1 (CTL1)

ipAddressIpv6Ctl2

string

IP address for IPv6 on controller 2 (CTL2)

1 The capacity after reduction is calculated based on a value that includes metadata and garbage data generated by the storage system, in addition to user data. For this reason, the value after reduction is sometimes greater than the value before reduction.

2 The capacity after reduction does not include metadata and garbage data generated by the storage system.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/storage