Skip to main content

We've Moved!

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

Monitoring storage systems

You can monitor the status of storage systems by getting alerts (SIMs) generated on each storage system, as well as information about the hardware installed in each storage system.

Getting a list of alert information

The following request gets a list of alerts related to the error information (SIM) of a storage system.
Note

This API request can be used when the storage system is VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

Execution permission

Support Personnel or User Maintenance

Request line

GET base-URL/v1/objects/alerts
Request message
  • Object ID

    None.

  • Query parameters

    Attribute

    Type

    Filter Condition

    type

    string

    (Required) Specify the type of the alert information you want to obtain.

    Specifiable values are as follows:

    • DKC: DKC

    • CTL1: controller 1

    • CTL2: controller 2

    start

    int

    (Optional) Specify the number of the alert from which you want to start obtaining information.

    Alerts are sorted by date and time in descending order.

    If you specified DKC for the type parameter, specify a value in the range from 1 to 10240.

    If you specified CTL1 or CTL2 for the type parameter, specify a value in the range from 1 to 256.

    If this parameter is omitted, alert information will be obtained starting from the first alert.

    count

    int

    (Optional) Specify the number of alerts to be obtained.

    If you specified DKC for the type parameter, specify a value in the range from 1 to 10240.

    If you specified CTL1 or CTL2 for the type parameter, specify a value in the range from 1 to 256.

    If this parameter is omitted, 10 alerts will be obtained.

  • Body

    None.

Response message
  • Body

    {
        "data" : [
            {
                "alertIndex" : "133ed620e449-0f0c9-7d0700",
                "alertId" : 61641,
                "occurenceTime" : "2018-03-22T16:14:01",
                "referenceCode" : 8193792,
                "errorLevel" : "Moderate",
                "errorSection" : "GUM detection error",
                "errorDetail" : "GUM security error detected",
                "location" : "CTL1",
                "actionCodes" : [
                    {
                        "actionCode" : 1492123648,
                        "possibleFailureParts" : "TSC CALL",
                        "accLocation" : "-"
                    }
                ]
            },
            {
                "alertIndex" : "133ed620a156-0f0c6-7d0700",
                "alertId" : 61638,
                "occurenceTime" : "2018-03-22T11:28:22",
                "referenceCode" : 8193792,
                "errorLevel" : "Moderate",
                "errorSection" : "GUM detection error",
                "errorDetail" : "GUM security error detected",
                "location" : "CTL1",
                "actionCodes" : [
                    {
                        "actionCode" : 1492123648,
                        "possibleFailureParts" : "TSC CALL",
                        "accLocation" : "-"
                    }
                ]
            },
            {
                "alertIndex" : "133ed6011907-0f0c3-7d0700",
                "alertId" : 61635,
                "occurenceTime" : "2018-03-20T19:59:03",
                "referenceCode" : 8193792,
                "errorLevel" : "Moderate",
                "errorSection" : "GUM detection error",
                "errorDetail" : "GUM security error detected",
                "location" : "CTL1",
                "actionCodes" : [
                    {
                        "actionCode" : 1492123648,
                        "possibleFailureParts" : "TSC CALL",
                        "accLocation" : "-"
                    }
                ]
            },
            {
                "alertIndex" : "133ed601164f-0f0bd-7d0700",
                "alertId" : 61629,
                "occurenceTime" : "2018-03-20T19:47:27",
                "referenceCode" : 8193792,
                "errorLevel" : "Moderate",
                "errorSection" : "GUM detection error",
                "errorDetail" : "GUM security error detected",
                "location" : "CTL1",
                "actionCodes" : [
                    {
                        "actionCode" : 1492123648,
                        "possibleFailureParts" : "TSC CALL",
                        "accLocation" : "-"
                    }
                ]
            }
        ]
    }

    Attribute

    Type

    Description

    alertIndex

    string

    Character string that uniquely identifies an alert

    alertID

    int

    Alert ID

    The log number of the SIM is displayed.

    occurenceTime

    string

    Date and time when the alert occurred

    The local time of the storage system is displayed in YYYY-MM-DDThh:mm:ss format.

    referenceCode

    int

    SIM reference code

    errorLevel

    string

    One of the following values is displayed as the error level:

    • Service: Service

    • Moderate: Warning (Moderate)

    • Serious: Error (Serious)

    • Acute: Acute

    errorSection

    string

    Information about where the alert occurred

    errorDetail

    string

    Details of the alert

    location

    string

    The location of the component or part for which the error occurred

    actionCodes

    object[]

    The following information related to the action code of the alert is displayed:

    • actionCode (long)

      Action code

    • possibleFailureParts (string)

      The part that might have been the cause of the error

      The name of the part that is assumed to be the cause of the error is displayed.

    • accLocation (string)

      Location

      The location of the component in which the error occurred is displayed.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session f76884c29fff4dfaa664aa6981087b71" -X GET "https://192.0.2.100/ConfigurationManager/v1/objects/alerts?type=CTL1&start=2&count=4"

Getting information about the hardware installed in a storage system

The following request gets information about the hardware installed in a storage system, including information about the controller's temperature and the battery status.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/components/instance
Request message
  • Object ID

    Specify instance. If an object has only one instance, the value for instance is the fixed value that specifies the object ID.

  • Query parameters

    Parameter

    Type

    Description

    componentOption

    string

    (Optional) Type of detailed information to be obtained

    • class

      You can get information about hardware installed on a storage system from the storage system's cache.

      You can specify this item for VSP 5000 series.

      To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

      If you specify class for componentOption in a query parameter, only detailed information is obtained.

  • Body

    None.

Response message
  • Body

    {
        "system": {
            "powerConsumption": 283
        },
        "ctls": [
            {
                "location": "CTL1",
                "status": "Normal",
                "temperature": 29,
                "temperatureStatus": "Normal",
                "charge": 100,
                "type": "Controller Board"
            },
            {
                "location": "CTL2",
                "status": "Normal",
                "temperature": 29,
                "temperatureStatus": "Normal",
                "charge": 100,
                "type": "Controller Board"
            }
        ],
        "cacheMemories": [
            {
                "location": "CTL1 CMG0",
                "status": "Normal",
                "cacheSize": 16
            },
            {
                "location": "CTL2 CMG0",
                "status": "Normal",
                "cacheSize": 16
            }
        ],
        "chbs": [
            {
                "location": "CHB-1A",
                "status": "Normal",
                "type": "10G 2Port iSCSI (Optic)"
            },
            {
                "location": "CHB-2A",
                "status": "Normal",
                "type": "10G 2Port iSCSI (Optic)"
            }
        ],
        "cacheFlashMemories": [
            {
                "location": "CFM-1",
                "status": "Normal",
                "type": "BM05"
            },
            {
                "location": "CFM-2",
                "status": "Normal",
                "type": "BM05"
            }
        ],
        "dkbs": [],
        "lanbs": [],...
    }

    For attributes indicated by a hash mark (#), if there is no hardware and information cannot be obtained, the attributes under the object are not output.

    Attribute

    Type

    Description

    system

    object

    The following attribute related to the storage system information is output:

    • powerConsumption (int)

      Power consumption of the storage system (Watt)

      A value is output indicating the average amount of power consumed by the controller and the drive box per minute.

      If a valid value cannot be obtained, -1 is output.

    ctls

    object[]

    The following attributes related to the controller information are output:

    • location (string)

      Location of the controller

    • status (string)

      Status of the controller

      • Normal
      • Warning
      • Blocked
      • Failed
    • temperature (int)

      Temperature of the controller (°C)

      A value in the range from -55 to 125 is output.

      If a value outside of this range is obtained, -274 is output.

      If the value of the status attribute is Blocked, the value that was obtained immediately before the controller was blocked is output.

      A similar value might also be output if the value of the status attribute is Failed.

    • temperatureStatus (string)

      Status indicating the temperature of the controller

      • Normal
      • Warning
      • Failed

      This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • charge (int)

      Charge status of the battery (%)

      A value in the range from 0 to 100 is output.

      If a value outside of this range is obtained, -1 is output.

      This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • type (string)

      Type of the controller

      • Encryption Controller Board: Encryption is enabled.
      • Controller Board: Encryption is disabled.

      If a valid value cannot be obtained, - is output.

      This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    cacheMemories#

    object[]

    The following attributes related to the cache memory are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the cache memory

    • status (string)

      Status of the cache memory

      • Normal
      • Warning
    • cacheSize (int)

      Size (GB) of the cache memory

      If a valid value cannot be obtained, -1 is output.

    chbs#

    object[]

    The following attributes related to the channel board are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the channel board

    • status (string)

      Status of the channel board

      • Normal

      • Warning

      • Blocked

      • Failed

    • type (string)

      Type of the channel board

      • 16G 2Port FC
      • 32G Ready 4Port FC
      • 10G 2Port iSCSI (Optic)
      • 10G 2Port iSCSI (Copper)

    cacheFlashMemories#

    object[]

    The following attributes related to the cache flash memory are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the cache flash memory

    • status (string)

      Status of the cache flash memory

      • Normal

      • Warning

      • Blocked

      • Failed

    • type (string)

      Type of the cache flash memory

      Example : BM30

    dkbs#

    object[]

    The following attributes related to the disk board are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the disk board

    • status (string)

      Status of the disk board

      • Normal
      • Warning
      • Blocked
      • Failed
    • type (string)

      Type of the disk board

      Example : Disk Board

    lanbs#

    object[]

    The following attributes related to the LAN board are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the LAN board

    • status (string)

      Status of the LAN board

      • Normal
      • Warning

    sfps#

    object[]

    The following attributes related to the SFP (Small Form Factor Pluggable) information are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • portId (string)

      Port number of the SFP

    • status (string)

      Status of the SFP

      • Not fix
      • Normal
      • Warning
    • type (string)

      Type of the SFP

      • Short Wave
      • Long Wave
      • Copper Cable

      If no port is used, an empty character string is output.

    • speed (string)

      SFP Speed

      • 16Gbps
      • 32Gbps

      If no speed is set, an empty character string is output.

    • portCondition (string)

      Condition of the SFP port

      • Not Available
      • Available (Connected)
      • Available (Not Connected)

      If the value of the attribute is anything other than the above, a hyphen (-) is output.

    bkmfs#

    object[]

    The following attributes related to the backup module are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the backup module

    • status (string)

      Status of the backup module

      • Normal
      • Warning
      • Blocked
      • Failed
    • batteries (object[])

      The following attributes related to the battery are output:

      • location(string)

        Location of the battery

      • status (string)

        Status of the battery

        Normal

        Warning

        Blocked

        Failed

      • life (int)

        Life expectancy of the battery

        A value in the range from 0 to 100 is output.

        If a value outside of this range is obtained, -1 is output.

    dkcpss#

    object[]

    The following attributes related to the DKCPS information are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the DKCPS

    • status (string)

      Status of the DKCPS

      • Normal
      • Warning
      • Failed

    driveBoxes#

    object[]

    The following attributes related to the drive box are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the drive box

    • type (string)

      Type of the drive box

      • DBS
      • DBL
      • DB60
      • DBF
    • led (string)

      Status of the LED

      • ON
      • OFF
    • drives (object[])

      The following attributes related to drives are output:

      • location (string)

        Location of the drives

      • modelCode (string)

        Drive type code

      • status (string)

        Status of the drives

        Normal

        Warning

        Warning (Port 0 failed)

        Warning (Port 1 failed)

        Failed

        Copying n % (xxx to xxx)

        Copying n % (xxx from xxx)

        Pending (xxx to xxx)

        Pending (xxx from xxx)

        Copy incomplete

        Reserved

        If multiple copy statuses exist, all of them are output.

      • usage (string)

        Drive usage

        DATA

        Spare

        Free

      • recomendReplacement (int)

        Whether the replacement of the drive is recommended

        0: PDEV replacement is not recommended.

        1: PDEV replacement is recommended.

    • encs (object[])

      The following attributes related to the ENC information are output:

      • location (string)

        Location of the ENC

      • status (string)

        Status of the ENC

        Normal

        Warning

        Blocked

        Failed

    • dbps (object[])

      The following attributes related to the power supply for drive boxes are output:

      • location (string)

        Location of the power supply for drive boxes

      • status (string)

        Status of the power supply for drive boxes

        Normal

        Warning

        Failed

    fans#

    object[]

    The following attributes related to fans are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the fans

    • status (string)

      Status of the fans

      • Normal
      • Warning
      • Failed

    upsMode

    string

    UPS mode

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • UPS Interlock Mode 1
    • UPS Interlock Mode 2
    • UPS Interlock Mode 3
    • Standard Mode

    pecbs#

    object[]

    The following attributes related to the PCle channel board are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the PCle channel board

    • status (string)

      Status of the PCle channel board

      • Normal
      • Warning
      • Blocked
    • connectionMode (string)

      Connection mode of the PCle channel board

      • Channel Board Box
      • Server Chassis

      If the value of the attribute is anything other than the above, a hyphen (-) is output.

    chbb#

    object

    The following attributes related to the channel board box are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the channel board box

    • expansionMode (string)

      Expansion mode of the channel board box

      • 1-vSW
      • 2-vSW

      If the value of the attribute is anything other than the above, a hyphen (-) is output.

    pcps#

    object[]

    The following attributes related to the PCle channel package are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the PCle channel package

    • status (string)

      Status of the PCle channel package

      • Normal
      • Warning
      • Blocked

    swpks#

    object[]

    The following attributes related to the switch package are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the switch package

    • status (string)

      Status of the switch package

      • Normal
      • Warning
      • Blocked

    chbbfans#

    object[]

    The following attributes related to the fan for the channel board box are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the fan for the channel board box

    • status (string)

      Status of the fan for the channel board box

      • Normal
      • Warning

    chbbps#

    object[]

    The following attributes related to the power supply for the channel board box are output:

    This attribute is output for VSP E, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

    • location (string)

      Location of the power supply for the channel board box

    • status (string)

      Status of the power supply for the channel board box

      • Normal
      • Warning

    If you run this request with class specified for the componentOption query parameter, only information from the storage system's cache will be obtained.

    Attribute

    Type

    Description

    cacheMemorySummary

    object

    The attribute related to summary information about the cache memory

    • status (string)

      Status of the cache memory

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown

    sharedMemorySummary

    object

    The attribute related to summary information about the shared memory

    • status (string)

      Status of the shared memory

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown

    lanbSummary

    object

    • status (string)

      This attribute is currently not in use.

    bkmfSummary

    object

    The attribute related to summary information about the backup module

    • fanStatus (string)

      Status of the fan

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown

    dkcpsSummary

    object

    The attribute related to summary information about the DKCPS

    • status (string)

      Status of the DKCPS

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown

    driveBoxSummary

    object

    Attributes related to summary information about the drive box

    • powerSupplyStatus (string)

      Status of the drive box power supply

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown
    • fanStatus (string)

      This attribute is currently not in use.

    • environmentStatus (string)

      Status of the drive box environment

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown
    • driveStatus (string)

      Status of the drive

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown

    processorSummary

    object

    The attribute related to summary information about the processor

    • status (string)

      Status of the processor

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown

    batterySummary

    object

    The attribute related to summary information about the battery

    • status (string)

      Status of the battery

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown

    xPathSummary

    object

    The attribute related to summary information about the X-path

    Information about the X-path and the interconnection switch is output as the value of the xPathSummary attribute.

    • status (string)

      Status of the X-path

      • Normal
      • Service
      • Moderate
      • Serious
      • Acute
      • Unknown
Status codes

For details on the status codes of the request for this operation, see the section explaining HTTP status codes.

Coding example
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/components/instance

Getting information about channel boards

This request gets information about all channel boards.
Note
  • You can use this API function for VSP 5000 series.

  • To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/channel-boards
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "data" : [ {
        "channelBoardId" : 3,
        "location" : "CHB-01F",
        "clusterNumber" : 1,
        "channelBoardNumber" : 3,
        "channelBoardType" : "FIBRE",
        "numOfPorts" : "4Port",
        "maxPortSpeed" : "32G",
        "cableMaterial" : "-"
      }, {
        "channelBoardId" : 7,
        "location" : "CHB-02F",
        "clusterNumber" : 2,
        "channelBoardNumber" : 3,
        "channelBoardType" : "FIBRE",
        "numOfPorts" : "4Port",
        "maxPortSpeed" : "32G",
        "cableMaterial" : "-"
      } ]
    }
    

    Attribute

    Type

    Description

    channelBoardId

    int

    ID of the channel board

    location

    string

    Location of the channel board

    clusterNumber

    int

    Cluster number of the channel board

    channelBoardNumber

    int

    Number of the channel board

    Each channel board in a cluster is assigned a unique number.

    channelBoardType

    string

    Type of ports that are installed on the channel board

    • FICON
    • FIBRE
    • ISCSI

    numOfPorts

    string

    Number of ports that are installed on the channel board

    • 2Port
    • 4Port
    • -

    If this information cannot be obtained, a hyphen (-) is output.

    maxPortSpeed

    string

    Data transmission speed of the ports installed on the channel board

    • 10G
    • 16G
    • 32G
    • -

    If this information cannot be obtained, a hyphen (-) is output.

    cableMaterial

    string

    Type of cable materials that can be used with the ports that are installed on the channel board

    • Optical
    • -

    If no information about the type of cable materials exists, a hyphen (-) is output.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/channel-boards