1. Overview

Documentation for the RESTful API provided for management and monitoring of E-Series storage-systems.

1.1. Version information

Version : 2.12

1.2. URI scheme

BasePath : /devmgr/v2

1.3. Tags

  • Administration

  • Authentication

  • Configuration

  • Copy-Services

  • Device-ASUP

  • Diagnostics

  • Drive-Firmware

  • File-Management

  • Firmware

  • Flash-Cache

  • Hardware

  • LDAP

  • Mapping

  • Mirroring

  • Monitoring

  • Security

  • Service-Catalog

  • Statistics

  • Storage-Systems

  • Upgrade

  • Volumes

  • Workloads

1.4. MetaData Descriptions

REST endpoint attribute descriptions

1.4.1. x-mode

The mode in which the SANtricity REST endpoint can be successfully initiated with. Proxy denotes the webserver is running on a server while embedded denotes the server running directly from an E-series controller such as the E2800, EF280, E5700, and EF570.

1.4.2. x-allowedRoles

Allowed roles denotes the user role type necessary to initiate the SANtricity REST endpoint. Users must authenticate with the correct user role type to authorize the REST endpoint’s usage

2. Security

2.1. basicAuth

Type : basic

3. Resources

3.1. Administration

3.1.1. Retrieve the login banner.

GET /devmgr/v2/storage-systems/{system-id}/login-banner
Description

Retrieves the login banner as either a file or plain text.

MetaData

x-mode = embedded
x-allowedRoles = [ALL_ACCESS]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

asFile
optional

Set to true to get the login banner as a file and set to false to get it as plain text.

boolean

"false"

Responses
HTTP Code Description Schema

200

The login banner was successfully returned

204

Access banner not configured

422

Unable to return the login banner

CallResponse

Consumes
  • application/json

Produces
  • application/octet-stream

  • text/plain

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/login-banner
Request query
{
  "asFile" : true
}
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.2. Upload a user defined login banner text file.

POST /devmgr/v2/storage-systems/{system-id}/login-banner
Description

The file should not be greater than 5KB in size and cannot be empty.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

FormData

file
optional

login banner file

file

Responses
HTTP Code Description Schema

204

The login banner was successfully saved

422

Unable to save the login banner

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/login-banner
Request formData
"file"
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.3. Deletes the login banner file.

DELETE /devmgr/v2/storage-systems/{system-id}/login-banner
Description

Deletes the login banner file.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

204

The login banner was successfully deleted

422

Unable to delete the login banner

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/login-banner
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.4. GET the SSL Configuration on the system

GET /devmgr/v2/certificates
MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

SSLCertConfiguration

422

User input error

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates
Example HTTP response
Response 200
{
  "dn" : "string",
  "rdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "subjectAlternateNames" : [ {
    "sanType" : "string",
    "sanValue" : "string"
  } ]
}

3.1.5. Set the SSL Configuration on the system. This will cause a regeneration of the SSL Certificate.

POST /devmgr/v2/certificates
MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Schema

Body

body
optional

SSLCertConfiguration

Responses
HTTP Code Description Schema

202

Request accepted, no data is returned. The changes will take affect on the next web server restart

422

User input error

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates
Request body
{
  "dn" : "string",
  "rdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "subjectAlternateNames" : [ {
    "sanType" : "string",
    "sanValue" : "string"
  } ]
}

3.1.6. Asynchronously reloads the SSL configuration

POST /devmgr/v2/certificates/reload
MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Query

reloadBoth
optional

This parameter is only applicable for embedded environments. True if wanting to restart the SSL certificate configuration on both controllers

boolean

"false"

Responses
HTTP Code Description Schema

202

Request accepted, no data is returned. The changes will take affect the next web server restart

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/reload
Request query
{
  "reloadBoth" : true
}

3.1.7. Upload a signed server certificate to the keystore on the system. Any required root/intermediate certificates must be uploaded into the keystore first via POST: /certificates/ca.

POST /devmgr/v2/certificates/import
MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

FormData

file
optional

The certificate file to upload

file

Responses
HTTP Code Description Schema

204

The certificate was successfully uploaded

422

An error occurred when attempting to upload the file

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/import
Request formData
"file"
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.8. Gets the list of known trusted certificate authorities on the storage array

GET /devmgr/v2/certificates/ca
MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Query

useTruststore
optional

True to see CA certificates in the truststore, false to see certificates in the keystore.

boolean

Responses
HTTP Code Description Schema

200

successful operation

< X509CertInfo > array

422

An error occurred when attempting to retrieve the list

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/ca
Request query
{
  "useTruststore" : true
}
Example HTTP response
Response 200
{
  "alias" : "string",
  "subjectDN" : "string",
  "issuerDN" : "string",
  "start" : "string",
  "expire" : "string",
  "truststore" : true,
  "isUserInstalled" : true,
  "isKeyEntry" : true
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.9. Upload the root/intermediate certificates from a certificate authority that signed the certificate used for this server

POST /devmgr/v2/certificates/ca
MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Query

useTruststore
optional

True if this CA certificate needs to be stored in the truststore, false otherwise.

boolean

Query

alias
optional

The user specified alias for this CA certificate

string

FormData

file
optional

certificate file

file

Responses
HTTP Code Description Schema

204

The certificate was successfully uploaded

422

An error occurred when uploading the certificate

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/ca
Request query
{
  "useTruststore" : true,
  "alias" : "string"
}
Request formData
"file"
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.10. Deletes the certificate authority certificate with the given alias

DELETE /devmgr/v2/certificates/ca/{alias}
MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

alias
required

string

Query

useTruststore
optional

True if this CA certificate needs to be deleted from the truststore, false otherwise.

boolean

Responses
HTTP Code Description Schema

204

The certificate was successfully deleted

404

An error occurred attempting to delete the CA certificate

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/ca/string
Request query
{
  "useTruststore" : true
}

3.1.11. Removes all previously uploaded certificates from the keystore and optionally reloads the SSL configuration back to a self-signed certificate asynchronously

POST /devmgr/v2/certificates/reset
MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Query

reloadSSL
optional

Set to false if you don’t want to reload the SSL Context immediately; default value is true.

boolean

"true"

Responses
HTTP Code Description Schema

202

Request accepted, no data is returned. The changes will take affect after the next web server restart

422

An error occurred when attempting to reset to a self-signed certificate

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/reset
Request query
{
  "reloadSSL" : true
}
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.12. Tests if the specified OCSP (On-line Certificate Status Protocol) URL is reachable. If ocspUrlString is not passed in and the OCSP URL is not set in the certificate revocation settings a 404 will be returned.

POST /devmgr/v2/certificates/settings/testOcspUrl
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Query

ocspUrlString
optional

The URL of the OCSP address to test

string

Responses
HTTP Code Description Schema

200

successful operation

boolean

204

The test completed successfully.

404

Not able to find the OCSP URL.

422

Unable to connect to the OCSP’s URL.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/settings/testOcspUrl
Request query
{
  "ocspUrlString" : "string"
}
Example HTTP response
Response 200
true
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.13. Retrieves the certificate revocation settings.

GET /devmgr/v2/certificates/settings
Description

Returns the certificate revocation settings; detailing if revocation checking is enabled and the preferred OCSP responder URL.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

CertRevocatSettings

422

Unable to get the certificate revocation settings.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/settings
Example HTTP response
Response 200
{
  "revocationChecking" : true,
  "ocspResponderAddress" : "string"
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.14. Configure certificate revocation settings.

POST /devmgr/v2/certificates/settings
Description

Used to configure certificate settings (revocation checking, specific OCSP responder URL, etc) When setting the OCSP URL it will be encoded to conform to RFC 2396.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Body

body
optional

CertRevocatSettings

Query

preventSslContextReload
optional

Set to true to prevent the webserver from reloading the SSL Configuration immediately. Changes made here will not take affect until the SSL Configuration has been reloaded.

boolean

"false"

Responses
HTTP Code Description Schema

200

The certificate revocation options were successfully saved

CertRevocatSettings

422

Unable to save the certificate revocation settings

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/settings
Request body
{
  "revocationChecking" : true,
  "ocspResponderAddress" : "string"
}
Request query
{
  "preventSslContextReload" : true
}
Example HTTP response
Response 200
{
  "revocationChecking" : true,
  "ocspResponderAddress" : "string"
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.15. Retrieves an x509 certificate signing request.

POST /devmgr/v2/certificates/export
Description

This will return the ID for the x509 certificate signing request file (for use with other endpoints)and a URL which can be used to directly access the file.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Query

filename
optional

The name for the x509 certificate file

string

Responses
HTTP Code Description Schema

200

successful operation

PrivateFileInfo

404

Error retrieving file.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/export
Request query
{
  "filename" : "string"
}
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileID" : "string",
  "fileURL" : "string"
}

3.1.16. Return a secure random token of 16 bytes

GET /devmgr/v2/client-token
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/client-token
Example HTTP response
Response 200
"string"

3.1.17. Shows if the admin password is set and the minimum password length value

GET /devmgr/v2/storage-systems/{system-id}/local-users/info
MetaData

x-mode = embedded
x-allowedRoles = [ALL_ACCESS, NO_XSRF_PROTECTION]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

LocalUserInfoResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/local-users/info
Example HTTP response
Response 200
{
  "adminPasswordSet" : true,
  "minimumPasswordLength" : 0
}

3.1.18. Retrieve the local users and if their password is set

GET /devmgr/v2/storage-systems/{system-id}/local-users
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< LocalUserResponse > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/local-users
Example HTTP response
Response 200
{
  "userName" : "string",
  "roles" : [ "string" ],
  "passwordSet" : true
} ]

3.1.19. Update/set the passwords for local users

POST /devmgr/v2/storage-systems/{system-id}/local-users
MetaData

x-mode = embedded
x-allowedRoles = [root.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

LocalUserRequest

Responses
HTTP Code Description Schema

204

Successfully set the password for local users.

404

An error occurred while attempting to set the password.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/local-users
Request body
{
  "currentAdminPassword" : "string",
  "updates" : [ {
    "userName" : "string",
    "newPassword" : "string"
  } ]
}

3.1.20. Set the minimum password length

POST /devmgr/v2/storage-systems/{system-id}/local-users/password-length
MetaData

x-mode = embedded
x-allowedRoles = [root.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

LocalUsersMinPasswordRequest

Responses
HTTP Code Description Schema

204

Successfully set the new minimum password length.

422

An invalid minimum password length was supplied.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/local-users/password-length
Request body
{
  "minimumPasswordLength" : 0
}

3.1.21. Retrieve session settings.

GET /devmgr/v2/storage-systems/{system-id}/settings/sessions
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

SessionSettingsResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/settings/sessions
Example HTTP response
Response 200
{
  "minimumSessionInactivePeriod" : 0,
  "sessionInactivePeriod" : 0
}

3.1.22. Update session settings.

POST /devmgr/v2/storage-systems/{system-id}/settings/sessions
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SessionSettings

Responses
HTTP Code Description Schema

200

successful operation

SessionSettingsResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/settings/sessions
Request body
{
  "sessionInactivePeriod" : 0
}
Example HTTP response
Response 200
{
  "minimumSessionInactivePeriod" : 0,
  "sessionInactivePeriod" : 0
}

3.1.23. Retrieve authentication settings.

GET /devmgr/v2/storage-systems/{system-id}/settings/authentication
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

AuthenticationSettings

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/settings/authentication
Example HTTP response
Response 200
{
  "disableBasicAuthentication" : true
}

3.1.24. Update authentication settings.

POST /devmgr/v2/storage-systems/{system-id}/settings/authentication
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

AuthenticationSettings

Responses
HTTP Code Description Schema

200

successful operation

SessionSettingsResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/settings/authentication
Request body
{
  "disableBasicAuthentication" : true
}
Example HTTP response
Response 200
{
  "minimumSessionInactivePeriod" : 0,
  "sessionInactivePeriod" : 0
}

3.1.25. Retrieve the local users and if their password is set

GET /devmgr/v2/local-users
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

< LocalUserResponse > array

404

An error occurred while attempting to retrieve the local user information

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/local-users
Example HTTP response
Response 200
{
  "userName" : "string",
  "roles" : [ "string" ],
  "passwordSet" : true
} ]

3.1.26. Set the password for local users

POST /devmgr/v2/local-users
MetaData

x-mode = proxy
x-allowedRoles = [root.admin]

Parameters
Type Name Schema

Body

body
optional

LocalUserRequest

Responses
HTTP Code Description Schema

204

The password was updated successfully

404

An error occurred while attempting to update the password

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/local-users
Request body
{
  "currentAdminPassword" : "string",
  "updates" : [ {
    "userName" : "string",
    "newPassword" : "string"
  } ]
}

3.1.27. Shows if the admin password is set and the minimum password length value

GET /devmgr/v2/local-users/info
MetaData

x-mode = proxy
x-allowedRoles = [ALL_ACCESS, NO_XSRF_PROTECTION]

Responses
HTTP Code Description Schema

200

successful operation

LocalUserInfoResponse

404

An error occurred when attempting to retrieve the local user information

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/local-users/info
Example HTTP response
Response 200
{
  "adminPasswordSet" : true,
  "minimumPasswordLength" : 0
}

3.1.28. Set the minimum password length

POST /devmgr/v2/local-users/password-length
MetaData

x-mode = proxy
x-allowedRoles = [root.admin]

Parameters
Type Name Schema

Body

body
optional

LocalUsersMinPasswordRequest

Responses
HTTP Code Description Schema

204

The minimum password length was updated successfully.

422

An error occurred while attempting to update the minimum password length

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/local-users/password-length
Request body
{
  "minimumPasswordLength" : 0
}

3.1.29. Retrieve session settings.

GET /devmgr/v2/settings/sessions
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

SessionSettingsResponse

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/settings/sessions
Example HTTP response
Response 200
{
  "minimumSessionInactivePeriod" : 0,
  "sessionInactivePeriod" : 0
}

3.1.30. Update session settings.

POST /devmgr/v2/settings/sessions
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Schema

Body

body
optional

SessionSettings

Responses
HTTP Code Description Schema

200

successful operation

SessionSettingsResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/settings/sessions
Request body
{
  "sessionInactivePeriod" : 0
}
Example HTTP response
Response 200
{
  "minimumSessionInactivePeriod" : 0,
  "sessionInactivePeriod" : 0
}

3.1.31. Retrieve authentication settings.

GET /devmgr/v2/settings/authentication
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

AuthenticationSettings

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/settings/authentication
Example HTTP response
Response 200
{
  "disableBasicAuthentication" : true
}

3.1.32. Update authentication settings.

POST /devmgr/v2/settings/authentication
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Schema

Body

body
optional

AuthenticationSettings

Responses
HTTP Code Description Schema

200

successful operation

SessionSettingsResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/settings/authentication
Request body
{
  "disableBasicAuthentication" : true
}
Example HTTP response
Response 200
{
  "minimumSessionInactivePeriod" : 0,
  "sessionInactivePeriod" : 0
}

3.1.33. GET the SSL Configuration

GET /devmgr/v2/sslconfig
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

SSLCertConfiguration

202

Request accepted, no data is returned. The changes will take affect the next web server restart

422

User input error

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig
Example HTTP response
Response 200
{
  "dn" : "string",
  "rdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "subjectAlternateNames" : [ {
    "sanType" : "string",
    "sanValue" : "string"
  } ]
}

3.1.34. Set the SSL Configuration causing a regeneration of the SSL Certificate.

POST /devmgr/v2/sslconfig
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Schema

Body

body
optional

SSLCertConfiguration

Responses
HTTP Code Description Schema

202

Request accepted, no data is returned. The changes will take affect the next web server restart

422

User input error

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig
Request body
{
  "dn" : "string",
  "rdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "subjectAlternateNames" : [ {
    "sanType" : "string",
    "sanValue" : "string"
  } ]
}

3.1.35. Asynchonously Reloads SSL Configuration. When this call returns, the reload has been requested

POST /devmgr/v2/sslconfig/reload
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Query

reloadBoth
optional

True if wanting to restart both controllers SSL Configuration; only applies to embedded systems.

boolean

Responses
HTTP Code Description Schema

202

Request accepted, no data is returned. The changes will take affect the next web server restart

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/reload
Request query
{
  "reloadBoth" : true
}

3.1.36. Upload a previously exported certificate signing request

POST /devmgr/v2/sslconfig/import
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

FormData

file
optional

certificate file

file

Responses
HTTP Code Description Schema

200

successful operation

< FileInfo > array

422

An unexpected error occurred

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/import
Request formData
"file"
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.37. Gets the list of known trusted certificate authorities

GET /devmgr/v2/sslconfig/ca
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Query

useTruststore
optional

True to see CA certificates in the truststore, false to see certificates in the keystore.

boolean

Responses
HTTP Code Description Schema

200

successful operation

< X509CertInfo > array

422

An unexpected error occurred

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/ca
Request query
{
  "useTruststore" : true
}
Example HTTP response
Response 200
{
  "alias" : "string",
  "subjectDN" : "string",
  "issuerDN" : "string",
  "start" : "string",
  "expire" : "string",
  "truststore" : true,
  "isUserInstalled" : true,
  "isKeyEntry" : true
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.38. Upload the root/intermediate certificates from a certificate authority that signed the certificate used for this server

POST /devmgr/v2/sslconfig/ca
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Query

useTruststore
optional

True if this CA certificate needs to be stored in the truststore, false otherwise.

boolean

Query

alias
optional

The user specified alias for this CA certificate

string

FormData

file
optional

certificate file

file

Responses
HTTP Code Description Schema

422

An unexpected error occurred

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/ca
Request query
{
  "useTruststore" : true,
  "alias" : "string"
}
Request formData
"file"
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.39. Retrieves an x509 certificate signing request

GET /devmgr/v2/sslconfig/export
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Query

filename
optional

fileName

string

Responses
HTTP Code Description Schema

200

successful operation

file

404

File not found.

Consumes
  • application/json

Produces
  • application/octet-stream

Example HTTP request
Request path
/devmgr/v2/sslconfig/export
Request query
{
  "filename" : "string"
}
Example HTTP response
Response 200
"file"

3.1.40. Deletes the CA with the given aliass

DELETE /devmgr/v2/sslconfig/ca/{alias}
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

alias
required

string

Query

useTruststore
optional

True if this CA certificate needs to be deleted from the truststore, false otherwise.

boolean

Responses
HTTP Code Description Schema

204

Delete was successful

404

Alias not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/ca/string
Request query
{
  "useTruststore" : true
}

3.1.41. Reset the webserer back to a self-signed certificate. Removes all previously uploaded certificates from the keystore and asynchronously reloads the SSL configuration."

POST /devmgr/v2/sslconfig/reset
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Query

reloadSSL
optional

Set to false if you don’t want to reload the SSL Context immediately; default value is true.

boolean

"true"

Responses
HTTP Code Description Schema

202

Request accepted, no data is returned. The changes will take affect the next web server restart

422

An unexpected error occurred

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/reset
Request query
{
  "reloadSSL" : true
}
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.42. Tests if the specified OCSP (On-line Certificate Status Protocol) URL is reachable. If ocspUrlString is not passed in and the OCSP URL is not set in the certificate revocation settings a 404 will be returned.

POST /devmgr/v2/sslconfig/settings/testOcspUrl
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Query

ocspUrlString
optional

The URL of the OCSP address to test

string

Responses
HTTP Code Description Schema

200

successful operation

boolean

204

The test completed.

404

Not able to find the OCSP URL.

422

Unable to connect to the OCSP’s URL.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/settings/testOcspUrl
Request query
{
  "ocspUrlString" : "string"
}
Example HTTP response
Response 200
true
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.43. Returns the certificate revocation settings, detailing if revocation checking is enabled and the preferred OCSP responder URL.

GET /devmgr/v2/sslconfig/settings
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

200

The certificate revocation options were successfully returned.

CertRevocatSettings

422

Unable to get the certificate revocation settings.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/settings
Example HTTP response
Response 200
{
  "revocationChecking" : true,
  "ocspResponderAddress" : "string"
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.44. Configure certificate revocation settings. Used to configure certificate settings such as if revocation checking should be enabled and if a specific OCSP responder URL should be used. When setting the OCSP URL it will be encoded to conform to RFC 2396.

POST /devmgr/v2/sslconfig/settings
Caution

operation.deprecated

Description

This endpoint has been deprecated.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Body

body
optional

CertRevocatSettings

Query

preventSslContextReload
optional

Set to true to prevent the webserver from reloading the SSL Configuration immediately; until the SSL Configuration is reloaded your changes will not take effect

boolean

"false"

Responses
HTTP Code Description Schema

200

The certificate revocation options were successfully saved

CertRevocatSettings

422

Unable to save the certificate revocation settings

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/settings
Request body
{
  "revocationChecking" : true,
  "ocspResponderAddress" : "string"
}
Request query
{
  "preventSslContextReload" : true
}
Example HTTP response
Response 200
{
  "revocationChecking" : true,
  "ocspResponderAddress" : "string"
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.45. Retrieve if the SYMbol port is enabled

GET /devmgr/v2/storage-systems/{system-id}/symbol-port
MetaData

x-mode = embedded
x-allowedRoles = [ALL_ACCESS, NO_XSRF_PROTECTION]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

SymbolPortResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/symbol-port
Example HTTP response
Response 200
{
  "symbolPortEnabled" : true
}

3.1.46. Set if the SYMbol port is enabled

POST /devmgr/v2/storage-systems/{system-id}/symbol-port
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SymbolPortRequest

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/symbol-port
Request body
{
  "enable" : true
}

3.2. Authentication

3.2.1. Retrieve a specific LDAP domain configuration

GET /devmgr/v2/storage-systems/{system-id}/ldap/{id}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

The id of the LDAP domain that configuration information should be retrieved for

string

Responses
HTTP Code Description Schema

200

successful operation

LdapDomain

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap/string
Example HTTP response
Response 200
{
  "id" : "string",
  "bindLookupUser" : {
    "password" : "string",
    "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
  },
  "groupAttributes" : "memberOf",
  "ldapUrl" : "ldaps://ldap.example.com:636",
  "names" : [ "string" ],
  "roleMapCollection" : [ {
    "groupRegex" : ".*cn=data-admin.*",
    "ignorecase" : false,
    "name" : "storage.monitor"
  } ],
  "searchBase" : "ou=users,dc=example,dc=com",
  "userAttribute" : "sAMAccountName"
}

3.2.2. Deletes the specified domain from the LDAP configuration

DELETE /devmgr/v2/storage-systems/{system-id}/ldap/{id}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

The id of the LDAP domain to be deleted from the configuration

string

Responses
HTTP Code Description Schema

204

The specified domain has been successfully deleted

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap/string

3.2.3. Retrieve the LDAP configuration

GET /devmgr/v2/storage-systems/{system-id}/ldap
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.2.4. Configure LDAP for a single or multiple domains

POST /devmgr/v2/storage-systems/{system-id}/ldap
Description

Warning: This will remove previous configurations

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

LdapConfiguration

Query

skipTest
optional

Indicates if connection and authentication testing should be skipped on the domains in the LDAP configuration provided. If any of the tests fail, the LDAP configuration provided will not be saved. The default value is false.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

StorageDevice not found

422

Testing of the LDAP configuration has failed

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap
Request body
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}
Request query
{
  "skipTest" : true
}
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.2.5. Remove the existing LDAP configuration

DELETE /devmgr/v2/storage-systems/{system-id}/ldap
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.2.6. Get the user’s current roles and list of role permissions.

GET /devmgr/v2/storage-systems/{system-id}/ldap/roles
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, security.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

allUsers
optional

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

RolesResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap/roles
Request query
{
  "allUsers" : true
}
Example HTTP response
Response 200
{
  "userRoles" : [ "string" ],
  "endpoints" : [ {
    "httpMethod" : "string",
    "endpoint" : "string",
    "roles" : [ "string" ]
  } ]
}

3.2.7. Adds an LDAP domain to the existing configuration

POST /devmgr/v2/storage-systems/{system-id}/ldap/addDomain
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

LdapDomain

Query

skipTest
optional

Indicates if connection and authentication testing should be skipped on the provided LDAP domain. If any of the tests fail, the LDAP domain provided will not be added. The default value is false.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

StorageDevice not found

422

Testing of the LDAP domain has failed

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap/addDomain
Request body
{
  "id" : "string",
  "bindLookupUser" : {
    "password" : "string",
    "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
  },
  "groupAttributes" : "memberOf",
  "ldapUrl" : "ldaps://ldap.example.com:636",
  "names" : [ "string" ],
  "roleMapCollection" : [ {
    "groupRegex" : ".*cn=data-admin.*",
    "ignorecase" : false,
    "name" : "storage.monitor"
  } ],
  "searchBase" : "ou=users,dc=example,dc=com",
  "userAttribute" : "sAMAccountName"
}
Request query
{
  "skipTest" : true
}
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.2.8. Updates LDAP configuration for a single domain

POST /devmgr/v2/storage-systems/{system-id}/ldap/{domain-id}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

domain-id
required

The id of the LDAP domain that needs to be updated

string

Body

body
optional

LdapDomain

Query

skipTest
optional

Indicates if connection and authentication testing should be skipped on the provided LDAP domain. If any of the tests fail, the LDAP configuration will not be updated. The default value is false.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

StorageDevice not found

422

Testing of the LDAP domain has failed

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap/string
Request body
{
  "id" : "string",
  "bindLookupUser" : {
    "password" : "string",
    "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
  },
  "groupAttributes" : "memberOf",
  "ldapUrl" : "ldaps://ldap.example.com:636",
  "names" : [ "string" ],
  "roleMapCollection" : [ {
    "groupRegex" : ".*cn=data-admin.*",
    "ignorecase" : false,
    "name" : "storage.monitor"
  } ],
  "searchBase" : "ou=users,dc=example,dc=com",
  "userAttribute" : "sAMAccountName"
}
Request query
{
  "skipTest" : true
}
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.2.9. Test the current LDAP configuration.

POST /devmgr/v2/storage-systems/{system-id}/ldap/test
Description

If no bind user is defined only a communication test will be performed

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< LdapDomainTestResponse > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap/test
Example HTTP response
Response 200
{
  "id" : "string",
  "result" : {
    "connectionTestResult" : "string",
    "authenticationTestResult" : "string",
    "searchTestResult" : "string"
  }
} ]

3.2.10. Retrieve the roles for a specific Identity Provider.

GET /devmgr/v2/saml/identity-provider/{id}/roles
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Responses
HTTP Code Description Schema

200

Successful operation

404

Configuration not found

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/identity-provider/string/roles

3.2.11. Configure the roles for a specific Identity Provider.

POST /devmgr/v2/saml/identity-provider/{id}/roles
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Body

body
required

Updated requests

SamlRolesRequest

Responses
HTTP Code Description Schema

200

Successful operation

404

Configuration not found

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/identity-provider/string/roles
Request body
{
  "roles" : [ {
    "attribute" : "string",
    "match" : "string",
    "roles" : [ "string" ]
  } ]
}

3.2.12. Retrieve SAML configuration data.

GET /devmgr/v2/saml
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

200

Successful operation

SamlConfiguration

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml
Example HTTP response
Response 200
{
  "samlEnabled" : true,
  "identityProviders" : [ {
    "id" : "string",
    "entityId" : "string",
    "singleSignOnEndpoint" : "string",
    "singleLogoutEndpoint" : "string",
    "namedIdFormats" : [ "string" ],
    "roles" : [ {
      "attribute" : "string",
      "match" : "string",
      "roles" : [ "string" ]
    } ],
    "signingCertificates" : [ "string" ]
  } ],
  "serviceProviders" : [ {
    "domainName" : "string",
    "controllerPosition" : 0
  } ]
}

3.2.13. Retrieve the status of a test for a specific Identity Provider.

GET /devmgr/v2/saml/identity-provider/{id}/test
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Path

id
required

Identity Provider ID

string

Query

alternate
optional

Run on alternate controller in embedded mode

boolean

"false"

Responses
HTTP Code Description Schema

200

Successful operation

enum (ok, failed, notRun, running, missingRequiredRoles)

404

IdP not found

enum (ok, failed, notRun, running, missingRequiredRoles)

501

SAML service not found

502

There was an issue sending command to alternate

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/identity-provider/string/test
Request query
{
  "alternate" : true
}
Example HTTP response
Response 200
"string"
Response 404
"string"

3.2.14. Initiate a test for a specific Identity Provider.

POST /devmgr/v2/saml/identity-provider/{id}/test
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Path

id
required

Identity Provider ID

string

Query

redirect
optional

If the endpoint should issue a redirect or not

boolean

"true"

Query

alternate
optional

Run on alternate controller in embedded mode

boolean

"false"

Responses
HTTP Code Description Schema

200

User is supplied with payload containing redirect URL

303

Redirect to the Identity Provider for authentication

404

Configuration not found

422

A test is already in progress

501

SAML service not found

502

There was an issue sending command to alternate

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/identity-provider/string/test
Request query
{
  "redirect" : true,
  "alternate" : true
}

3.2.15. Delete test results for an Identity Provider.

DELETE /devmgr/v2/saml/identity-provider/{id}/test
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Path

id
required

Identity Provider ID

string

Query

alternate
optional

Run on alternate controller in embedded mode

boolean

"false"

Responses
HTTP Code Description Schema

204

Successful operation

501

SAML service not found

502

There was an issue sending command to alternate

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/identity-provider/string/test
Request query
{
  "alternate" : true
}

3.2.16. Authenticate user against an Identity Provider.

POST /devmgr/v2/saml/login
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [ALL_ACCESS, NO_XSRF_PROTECTION]

Parameters
Type Name Description Schema Default

Body

body
optional

The login request

SamlLoginRequest

Query

redirect
optional

If the endpoint should issue a redirect or not

boolean

"true"

Responses
HTTP Code Description Schema

200

User is supplied with payload containing redirect URL

303

User redirected to the Identity Provider for authentication

422

SAML configuration error

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/login
Request body
{
  "redirectUrl" : "string"
}
Request query
{
  "redirect" : true
}

3.2.17. Enable SAML authentication.

POST /devmgr/v2/saml/enable
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

204

Successful operation

404

SAML configuration not found

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/enable

3.2.18. Retrieve the metadata for a specific Identity Provider.

GET /devmgr/v2/saml/identity-provider/{id}
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Responses
HTTP Code Description Schema

200

Successful operation

SamlIdentityProvider

404

Configuration not found

SamlIdentityProvider

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/identity-provider/string
Example HTTP response
Response 200
{
  "id" : "string",
  "entityId" : "string",
  "singleSignOnEndpoint" : "string",
  "singleLogoutEndpoint" : "string",
  "namedIdFormats" : [ "string" ],
  "roles" : [ {
    "attribute" : "string",
    "match" : "string",
    "roles" : [ "string" ]
  } ],
  "signingCertificates" : [ "string" ]
}
Response 404
{
  "id" : "string",
  "entityId" : "string",
  "singleSignOnEndpoint" : "string",
  "singleLogoutEndpoint" : "string",
  "namedIdFormats" : [ "string" ],
  "roles" : [ {
    "attribute" : "string",
    "match" : "string",
    "roles" : [ "string" ]
  } ],
  "signingCertificates" : [ "string" ]
}

3.2.19. Delete the metadata for a specific Identity Provider.

DELETE /devmgr/v2/saml/identity-provider/{id}
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Responses
HTTP Code Description Schema

204

Successful operation

404

Configuration not found

422

SAML configuration error

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/identity-provider/string

3.2.20. Export Service Provider metadata for consumption by an Identity Provider.

POST /devmgr/v2/saml/export
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Body

body
optional

SAML service provider information

SamlServiceProvider

Responses
HTTP Code Description Schema

200

Successful operation

PrivateFileInfo

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/export
Request body
{
  "domainName" : "string",
  "controllerPosition" : 0
}
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileID" : "string",
  "fileURL" : "string"
}

3.2.21. Import an Identity Provider metadata file.

POST /devmgr/v2/saml/identity-provider
Description

Mode: Embedded only

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

FormData

idpMetadata
optional

identity provider metadata file

file

Responses
HTTP Code Description Schema

200

Successful operation

SamlIdentityProvider

422

Unexpected error occurred while importing metadata

SamlIdentityProvider

501

SAML service not found

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/identity-provider
Request formData
"file"
Example HTTP response
Response 200
{
  "id" : "string",
  "entityId" : "string",
  "singleSignOnEndpoint" : "string",
  "singleLogoutEndpoint" : "string",
  "namedIdFormats" : [ "string" ],
  "roles" : [ {
    "attribute" : "string",
    "match" : "string",
    "roles" : [ "string" ]
  } ],
  "signingCertificates" : [ "string" ]
}
Response 422
{
  "id" : "string",
  "entityId" : "string",
  "singleSignOnEndpoint" : "string",
  "singleLogoutEndpoint" : "string",
  "namedIdFormats" : [ "string" ],
  "roles" : [ {
    "attribute" : "string",
    "match" : "string",
    "roles" : [ "string" ]
  } ],
  "signingCertificates" : [ "string" ]
}

3.3. Configuration

3.3.1. Retrieve ASUP configuration info

GET /devmgr/v2/asup
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, support.admin, storage.monitor]

Responses
HTTP Code Description Schema

200

successful operation

AsupResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/asup
Example HTTP response
Response 200
{
  "enabled" : true,
  "scheduleType" : 0,
  "weekdays" : [ 0 ],
  "months" : [ 0 ],
  "scheduledDays" : [ 0 ],
  "deliveryType" : 0,
  "destinationHttpAddr" : "string",
  "destinationSmtpAddr" : "string",
  "httpDeliveryType" : 0,
  "proxyHostAddr" : "string",
  "proxyHostPort" : "string",
  "authRequired" : true,
  "authUserName" : "string",
  "authPassword" : "string",
  "proxyScript" : "string",
  "mailServer" : "string",
  "mailSenderAddr" : "string",
  "mailReplyAddr" : "string",
  "log" : "string",
  "sequence" : "string",
  "default" : true
}

3.3.2. Update ASUP configuration info

POST /devmgr/v2/asup
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, support.admin]

Parameters
Type Name Schema

Body

body
optional

AsupUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

AsupResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/asup
Request body
{
  "enable" : true,
  "scheduleTypeReq" : 0,
  "weekDaysReq" : [ 0 ],
  "monthsReq" : [ 0 ],
  "scheduledDaysReq" : [ 0 ],
  "deliveryType" : 0,
  "httpDeliveryType" : 0,
  "proxyHostAddr" : "string",
  "proxyHostPort" : "string",
  "authRequired" : true,
  "authUserName" : "string",
  "authPassword" : "string",
  "proxyScript" : "string",
  "mailServer" : "string",
  "mailSenderAddr" : "string",
  "mailReplyAddr" : "string"
}
Example HTTP response
Response 200
{
  "enabled" : true,
  "scheduleType" : 0,
  "weekdays" : [ 0 ],
  "months" : [ 0 ],
  "scheduledDays" : [ 0 ],
  "deliveryType" : 0,
  "destinationHttpAddr" : "string",
  "destinationSmtpAddr" : "string",
  "httpDeliveryType" : 0,
  "proxyHostAddr" : "string",
  "proxyHostPort" : "string",
  "authRequired" : true,
  "authUserName" : "string",
  "authPassword" : "string",
  "proxyScript" : "string",
  "mailServer" : "string",
  "mailSenderAddr" : "string",
  "mailReplyAddr" : "string",
  "log" : "string",
  "sequence" : "string",
  "default" : true
}

3.3.3. Dispatch the ASUP bundle

POST /devmgr/v2/asup/dispatch
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, support.admin]

Parameters
Type Name Schema

Body

body
optional

AsupDispatchRequest

Responses
HTTP Code Description Schema

200

successful operation

AsupResponse

422

Unregistered asup bundle ID

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/asup/dispatch
Request body
{
  "id" : "string",
  "dispatchType" : 0
}
Example HTTP response
Response 200
{
  "enabled" : true,
  "scheduleType" : 0,
  "weekdays" : [ 0 ],
  "months" : [ 0 ],
  "scheduledDays" : [ 0 ],
  "deliveryType" : 0,
  "destinationHttpAddr" : "string",
  "destinationSmtpAddr" : "string",
  "httpDeliveryType" : 0,
  "proxyHostAddr" : "string",
  "proxyHostPort" : "string",
  "authRequired" : true,
  "authUserName" : "string",
  "authPassword" : "string",
  "proxyScript" : "string",
  "mailServer" : "string",
  "mailSenderAddr" : "string",
  "mailReplyAddr" : "string",
  "log" : "string",
  "sequence" : "string",
  "default" : true
}

3.3.4. Register the ASUP bundle

POST /devmgr/v2/asup/register
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, support.admin]

Parameters
Type Name Schema

Body

body
optional

AsupRegistrationRequest

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/asup/register
Request body
{
  "entries" : [ {
    "fileName" : "string",
    "filePath" : "string",
    "priority" : 0,
    "contentType" : "string",
    "description" : "string",
    "schedule" : [ 0 ]
  } ],
  "id" : "string",
  "modelName" : "string",
  "subjectName" : "string"
}
Example HTTP response
Response 200
"string"

3.3.5. Retrieve results of the last configuration operation

GET /devmgr/v2/configuration
Description

If no operation has been performed, an empty body is returned.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, support.admin]

Responses
HTTP Code Description Schema

200

Current result data for the last operation

ConfigurationResult

204

There is no current operation from which to return results

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/configuration
Example HTTP response
Response 200
{
  "startDate" : "string",
  "endDate" : "string",
  "currentResults" : [ {
    "systemKey" : "string",
    "success" : true,
    "response" : {
      "errorMessage" : "string",
      "localizedMessage" : "string",
      "retcode" : "string",
      "codeType" : "string",
      "invalidFieldsIfKnown" : [ "string" ]
    }
  } ],
  "totalSystems" : 0,
  "numberDone" : 0,
  "operationDone" : true
}

3.3.6. Initiates a new bulk configuration operation

POST /devmgr/v2/configuration
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Schema

Body

body
optional

FileBasedConfigurationRequest

Responses
HTTP Code Description Schema

200

The operation is already running

201

A new bulk configuration task has been started

ConfigurationResult

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/configuration
Request body
{
  "skipHeader" : true,
  "fileName" : "string",
  "configItems" : [ {
    "column" : 0,
    "type" : "string"
  } ]
}
Example HTTP response
Response 201
{
  "startDate" : "string",
  "endDate" : "string",
  "currentResults" : [ {
    "systemKey" : "string",
    "success" : true,
    "response" : {
      "errorMessage" : "string",
      "localizedMessage" : "string",
      "retcode" : "string",
      "codeType" : "string",
      "invalidFieldsIfKnown" : [ "string" ]
    }
  } ],
  "totalSystems" : 0,
  "numberDone" : 0,
  "operationDone" : true
}

3.3.7. Interrupts any current configuration process

DELETE /devmgr/v2/configuration
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Responses
HTTP Code Description Schema

default

successful operation

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/configuration

3.3.8. Returns a list of known configuration items that can be used by this server

GET /devmgr/v2/configuration/validate
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, support.admin]

Responses
HTTP Code Description Schema

200

successful operation

< enum (systemSerialNumber, controllerAPort1IP4, controllerAPort2IP4, controllerBPort1IP4, controllerBPort2IP4, controllerAPort1IP6, controllerAPort2IP6, controllerBPort1IP6, controllerBPort2IP6, controllerAPort1Netmask4, controllerAPort2Netmask4, controllerBPort1Netmask4, controllerBPort2Netmask4, controllerAPort1Netmask6, controllerAPort2Netmask6, controllerBPort1Netmask6, controllerBPort2Netmask6, controllerAIPv4GW, controllerAIPv6GW, controllerBIPv4GW, controllerBIPv6GW, systemLabel, saPassword, systemKey, metaData) > array

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/configuration/validate
Example HTTP response
Response 200
[ "string" ]

3.3.9. Used to validate an input CSV file previously uploaded

POST /devmgr/v2/configuration/validate
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Schema

Body

body
optional

FileBasedConfigurationRequest

Responses
HTTP Code Description Schema

200

successful operation

ValidateConfiurationFileResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/configuration/validate
Request body
{
  "skipHeader" : true,
  "fileName" : "string",
  "configItems" : [ {
    "column" : 0,
    "type" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "fileFound" : true,
  "items" : [ {
    "row" : 0,
    "type" : "string",
    "value" : "string"
  } ]
}

3.4. Copy-Services

3.4.1. Get consistency group

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

PITConsistencyGroup

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string
Example HTTP response
Response 200
{
  "cgRef" : "string",
  "label" : "string",
  "repFullPolicy" : "string",
  "fullWarnThreshold" : 0,
  "autoDeleteLimit" : 0,
  "rollbackPriority" : "string",
  "uniqueSequenceNumber" : [ "string" ],
  "creationPendingStatus" : "string",
  "name" : "string",
  "id" : "string"
}

3.4.2. Update consistency group

POST /devmgr/v2/storage-systems/{system-id}/consistency-groups/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

ConsistencyGroupUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

PITConsistencyGroup

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string
Request body
{
  "name" : "string",
  "fullWarnThresholdPercent" : 0,
  "autoDeleteThreshold" : 0,
  "repositoryFullPolicy" : "string",
  "rollbackPriority" : "string"
}
Example HTTP response
Response 200
{
  "cgRef" : "string",
  "label" : "string",
  "repFullPolicy" : "string",
  "fullWarnThreshold" : 0,
  "autoDeleteLimit" : 0,
  "rollbackPriority" : "string",
  "uniqueSequenceNumber" : [ "string" ],
  "creationPendingStatus" : "string",
  "name" : "string",
  "id" : "string"
}

3.4.3. Delete consistency group

DELETE /devmgr/v2/storage-systems/{system-id}/consistency-groups/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string

3.4.4. Get all consistency groups

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< PITConsistencyGroup > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups
Example HTTP response
Response 200
{
  "cgRef" : "string",
  "label" : "string",
  "repFullPolicy" : "string",
  "fullWarnThreshold" : 0,
  "autoDeleteLimit" : 0,
  "rollbackPriority" : "string",
  "uniqueSequenceNumber" : [ "string" ],
  "creationPendingStatus" : "string",
  "name" : "string",
  "id" : "string"
} ]

3.4.5. Create consistency group

POST /devmgr/v2/storage-systems/{system-id}/consistency-groups
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

ConsistencyGroupCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

PITConsistencyGroup

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups
Request body
{
  "name" : "string",
  "fullWarnThresholdPercent" : 0,
  "autoDeleteThreshold" : 0,
  "repositoryFullPolicy" : "string",
  "rollbackPriority" : "string"
}
Example HTTP response
Response 200
{
  "cgRef" : "string",
  "label" : "string",
  "repFullPolicy" : "string",
  "fullWarnThreshold" : 0,
  "autoDeleteLimit" : 0,
  "rollbackPriority" : "string",
  "uniqueSequenceNumber" : [ "string" ],
  "creationPendingStatus" : "string",
  "name" : "string",
  "id" : "string"
}

3.4.6. Get a list of all consistency group members

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/member-volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< PITCGMember > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/member-volumes
Example HTTP response
Response 200
{
  "consistencyGroupId" : "string",
  "volumeId" : "string",
  "volumeWwn" : "string",
  "baseVolumeName" : "string",
  "clusterSize" : 0,
  "totalRepositoryVolumes" : 0,
  "totalRepositoryCapacity" : "string",
  "usedRepositoryCapacity" : "string",
  "fullWarnThreshold" : 0,
  "totalSnapshotImages" : 0,
  "totalSnapshotVolumes" : 0,
  "autoDeleteSnapshots" : true,
  "autoDeleteLimit" : 0,
  "pitGroupId" : "string",
  "repositoryVolume" : "string"
} ]

3.4.7. Get a list of all consistency group snapshot views

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/views
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< PITConsistencyGroupView > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/views
Example HTTP response
Response 200
{
  "cgViewRef" : "string",
  "groupRef" : "string",
  "label" : "string",
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "name" : "string",
  "id" : "string"
} ]

3.4.8. Get ConsistencyGroup members

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/member-volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

< PITCGMember > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/member-volumes
Example HTTP response
Response 200
{
  "consistencyGroupId" : "string",
  "volumeId" : "string",
  "volumeWwn" : "string",
  "baseVolumeName" : "string",
  "clusterSize" : 0,
  "totalRepositoryVolumes" : 0,
  "totalRepositoryCapacity" : "string",
  "usedRepositoryCapacity" : "string",
  "fullWarnThreshold" : 0,
  "totalSnapshotImages" : 0,
  "totalSnapshotVolumes" : 0,
  "autoDeleteSnapshots" : true,
  "autoDeleteLimit" : 0,
  "pitGroupId" : "string",
  "repositoryVolume" : "string"
} ]

3.4.9. Add ConsistencyGroup member

POST /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/member-volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Body

body
optional

AddConsistencyGroupMemberRequest

Responses
HTTP Code Description Schema

200

successful operation

PITCGMember

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/member-volumes
Request body
{
  "volumeId" : "string",
  "repositoryPoolId" : "string",
  "scanMedia" : true,
  "validateParity" : true,
  "repositoryPercent" : 0.0,
  "repositoryCandidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  }
}
Example HTTP response
Response 200
{
  "consistencyGroupId" : "string",
  "volumeId" : "string",
  "volumeWwn" : "string",
  "baseVolumeName" : "string",
  "clusterSize" : 0,
  "totalRepositoryVolumes" : 0,
  "totalRepositoryCapacity" : "string",
  "usedRepositoryCapacity" : "string",
  "fullWarnThreshold" : 0,
  "totalSnapshotImages" : 0,
  "totalSnapshotVolumes" : 0,
  "autoDeleteSnapshots" : true,
  "autoDeleteLimit" : 0,
  "pitGroupId" : "string",
  "repositoryVolume" : "string"
}

3.4.10. Get ConsistencyGroup member

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/member-volumes/{volumeRef}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Path

volumeRef
required

string

Responses
HTTP Code Description Schema

200

successful operation

PITCGMember

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/member-volumes/string
Example HTTP response
Response 200
{
  "consistencyGroupId" : "string",
  "volumeId" : "string",
  "volumeWwn" : "string",
  "baseVolumeName" : "string",
  "clusterSize" : 0,
  "totalRepositoryVolumes" : 0,
  "totalRepositoryCapacity" : "string",
  "usedRepositoryCapacity" : "string",
  "fullWarnThreshold" : 0,
  "totalSnapshotImages" : 0,
  "totalSnapshotVolumes" : 0,
  "autoDeleteSnapshots" : true,
  "autoDeleteLimit" : 0,
  "pitGroupId" : "string",
  "repositoryVolume" : "string"
}

3.4.11. Remove ConsistencyGroup member

DELETE /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/member-volumes/{volumeRef}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Path

volumeRef
required

string

Query

retainRepositories
optional

boolean

"false"

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/member-volumes/string
Request query
{
  "retainRepositories" : true
}

3.4.12. Add multiple ConsistencyGroup members at once

POST /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/member-volumes/batch
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Body

body
optional

AddBatchCGMembersRequest

Responses
HTTP Code Description Schema

200

successful operation

< PITCGMember > array

404

StorageDevice not found

422

A volumeInitializing error will be returned if any volumes are being initialized when this call is made.

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/member-volumes/batch
Request body
{
  "volumeToCandidates" : {
    "string" : "<<_concatvolumecandidate>>"
  },
  "scanMedia" : true,
  "validateParity" : true
}
Example HTTP response
Response 200
{
  "consistencyGroupId" : "string",
  "volumeId" : "string",
  "volumeWwn" : "string",
  "baseVolumeName" : "string",
  "clusterSize" : 0,
  "totalRepositoryVolumes" : 0,
  "totalRepositoryCapacity" : "string",
  "usedRepositoryCapacity" : "string",
  "fullWarnThreshold" : 0,
  "totalSnapshotImages" : 0,
  "totalSnapshotVolumes" : 0,
  "autoDeleteSnapshots" : true,
  "autoDeleteLimit" : 0,
  "pitGroupId" : "string",
  "repositoryVolume" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.4.13. Rollback a ConsistencyGroup snapshot

POST /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/snapshots/{sequenceNumber}/rollback
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Path

sequenceNumber
required

integer (int64)

Responses
HTTP Code Description Schema

204

Rollback started

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/snapshots/0/rollback

3.4.14. Get a set of Snapshots by sequenceNumber

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/snapshots/{sequenceNumber}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Path

sequenceNumber
required

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

< Snapshot > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/snapshots/0
Example HTTP response
Response 200
{
  "pitRef" : "string",
  "pitGroupRef" : "string",
  "creationMethod" : "string",
  "pitTimestamp" : "string",
  "pitSequenceNumber" : "string",
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : "string",
  "repositoryCapacityUtilization" : "string",
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
} ]

3.4.15. Remove ConsistencyGroup snapshot

DELETE /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/snapshots/{sequenceNumber}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Path

sequenceNumber
required

integer (int64)

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/snapshots/0

3.4.16. Get Snapshots associated with the ConsistencyGroup

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/snapshots
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

< Snapshot > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/snapshots
Example HTTP response
Response 200
{
  "pitRef" : "string",
  "pitGroupRef" : "string",
  "creationMethod" : "string",
  "pitTimestamp" : "string",
  "pitSequenceNumber" : "string",
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : "string",
  "repositoryCapacityUtilization" : "string",
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
} ]

3.4.17. Create ConsistencyGroup snapshot

POST /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/snapshots
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Body

body
optional

CreateConsistencyGroupSnapshotRequest

Responses
HTTP Code Description Schema

200

successful operation

< Snapshot > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/snapshots
Request body
{ }
Example HTTP response
Response 200
{
  "pitRef" : "string",
  "pitGroupRef" : "string",
  "creationMethod" : "string",
  "pitTimestamp" : "string",
  "pitSequenceNumber" : "string",
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : "string",
  "repositoryCapacityUtilization" : "string",
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
} ]

3.4.18. Get Snapshot views associated with the ConsistencyGroup

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/views
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

< PITConsistencyGroupView > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/views
Example HTTP response
Response 200
{
  "cgViewRef" : "string",
  "groupRef" : "string",
  "label" : "string",
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "name" : "string",
  "id" : "string"
} ]

3.4.19. Create Snapshot Views from a ConsistencyGroup Snapshot

POST /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/views
Description

A pitId or a pitSequenceNumber can be provided to this endpoint in order to create a snapshotView. If a pitId is provided, only a single view will be created. If a pitSequenceNumber is provided, a snapshotView will be created for each Snapshot associated with the sequenceNumber.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Body

body
optional

CreateConsistencyGroupSnapshotViewRequest

Responses
HTTP Code Description Schema

200

successful operation

PITConsistencyGroupView

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/views
Request body
{
  "name" : "string",
  "repositoryPoolId" : "string",
  "pitId" : "string",
  "pitSequenceNumber" : "string",
  "accessMode" : "string",
  "repositoryPercent" : 0.0,
  "scanMedia" : true,
  "validateParity" : true
}
Example HTTP response
Response 200
{
  "cgViewRef" : "string",
  "groupRef" : "string",
  "label" : "string",
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "name" : "string",
  "id" : "string"
}

3.4.20. Get a Snapshot view associated with the ConsistencyGroup

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/views/{viewId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Path

viewId
required

string

Responses
HTTP Code Description Schema

200

successful operation

PITConsistencyGroupView

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/views/string
Example HTTP response
Response 200
{
  "cgViewRef" : "string",
  "groupRef" : "string",
  "label" : "string",
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "name" : "string",
  "id" : "string"
}

3.4.21. Delete an existing Snapshot View

DELETE /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/views/{viewId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Path

viewId
required

string

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/views/string

3.4.22. Retrieve the underlying SnapshotVolumes associated with the PITConsistencyGroupView

GET /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/views/{viewId}/views
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Path

viewId
required

string

Responses
HTTP Code Description Schema

200

successful operation

< PitViewEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/views/string/views
Example HTTP response
Response 200
{
  "viewRef" : "string",
  "worldWideName" : "string",
  "baseVol" : "string",
  "basePIT" : "string",
  "boundToPIT" : true,
  "accessMode" : "string",
  "label" : "string",
  "status" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "repositoryCapacity" : "string",
  "baseVolumeCapacity" : "string",
  "totalSizeInBytes" : "string",
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
} ]

3.4.23. Create Snapshot Views from a ConsistencyGroup Snapshot

POST /devmgr/v2/storage-systems/{system-id}/consistency-groups/{cg-id}/views/batch
Description

This endpoint provides more granularity and customization in creating a view than the non-batch endpoint. For each snapshot that you wish for a view to be created of, a CGSnapshotViewRequest must be provided that defines the parameters (including a repository candidate, if necessary [See repositories/concat]). Each Snapshot provided MUST be under the same pitSequenceNumber.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

cg-id
required

string

Body

body
optional

CreateCGSnapshotViewManualRequest

Responses
HTTP Code Description Schema

200

successful operation

PITConsistencyGroupView

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/views/batch
Request body
{
  "name" : "string",
  "pitSequenceNumber" : "string",
  "requests" : [ {
    "pitId" : "string",
    "candidate" : {
      "candType" : "string",
      "newVolCandidate" : {
        "memberVolumeLabel" : "string",
        "memberVolumeGroupLabel" : "string",
        "memberCandidate" : {
          "raidLevel" : "string",
          "trayLossProtection" : true,
          "rawSize" : "string",
          "usableSize" : "string",
          "driveCount" : 0,
          "freeExtentRef" : "string",
          "driveRefList" : {
            "driveRef" : [ "string" ]
          },
          "candidateSelectionType" : "string",
          "spindleSpeedMatch" : true,
          "spindleSpeed" : 0,
          "phyDriveType" : "string",
          "dssPreallocEnabled" : true,
          "securityType" : "string",
          "drawerLossProtection" : true,
          "driveMediaType" : "string",
          "protectionInformationCapable" : true,
          "protectionInformationCapabilities" : {
            "protectionInformationCapable" : true,
            "protectionType" : "string"
          },
          "volumeCandidateData" : {
            "type" : "string",
            "diskPoolVolumeCandidateData" : {
              "reconstructionReservedDriveCount" : 0,
              "reconstructionReservedAmt" : "string",
              "unusableCapacity" : "string"
            }
          },
          "driveBlockFormat" : "string",
          "allocateReservedSpace" : true,
          "securityLevel" : "string"
        },
        "memberCapacity" : "string"
      },
      "existVolCandidate" : {
        "refType" : "string",
        "memberVolumeRef" : [ "string" ],
        "memberLabel" : [ "string" ]
      },
      "expansionDescriptor" : {
        "additionalCapacity" : "string"
      }
    },
    "accessMode" : "string",
    "scanMedia" : true,
    "validateParity" : true
  } ]
}
Example HTTP response
Response 200
{
  "cgViewRef" : "string",
  "groupRef" : "string",
  "label" : "string",
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "name" : "string",
  "id" : "string"
}

3.4.24. Retrieve the repository usage statistics for all Legacy Snapshots.

GET /devmgr/v2/storage-systems/{system-id}/legacy-snapshots/repository-utilization
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< RepositoryUtilization > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots/repository-utilization
Example HTTP response
Response 200
{
  "repositoryUsage" : "string",
  "snapRef" : "string"
} ]

3.4.25. Retrieve the repository usage statistics for a single Legacy Snapshot.

GET /devmgr/v2/storage-systems/{system-id}/legacy-snapshots/{id}/repository-utilization
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

RepositoryUtilization

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots/string/repository-utilization
Example HTTP response
Response 200
{
  "repositoryUsage" : "string",
  "snapRef" : "string"
}

3.4.26. Get Legacy Snapshots

GET /devmgr/v2/storage-systems/{system-id}/legacy-snapshots
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< LegacySnapshotEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "snapshotRef" : "string",
  "label" : "string",
  "status" : "string",
  "action" : "string",
  "currentManager" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "overWarnThreshold" : true,
  "repositoryFull" : true,
  "repFullPolicy" : "string",
  "rollbackPriority" : 0,
  "extentStart" : "string",
  "extentSize" : "string",
  "snapshotTime" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : "string",
  "totalSizeInBytes" : "string",
  "preferredControllerId" : "string",
  "repositoryCapacity" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
} ]

3.4.27. Create Legacy Snapshot

POST /devmgr/v2/storage-systems/{system-id}/legacy-snapshots
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

LegacySnapshotCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

LegacySnapshotEx

201

Snapshot Created

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots
Request body
{
  "baseVolumeId" : "string",
  "name" : "string",
  "repositoryPercentage" : 0.0,
  "warningThreshold" : 0,
  "fullPolicy" : "string",
  "storagePoolId" : "string"
}
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "snapshotRef" : "string",
  "label" : "string",
  "status" : "string",
  "action" : "string",
  "currentManager" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "overWarnThreshold" : true,
  "repositoryFull" : true,
  "repFullPolicy" : "string",
  "rollbackPriority" : 0,
  "extentStart" : "string",
  "extentSize" : "string",
  "snapshotTime" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : "string",
  "totalSizeInBytes" : "string",
  "preferredControllerId" : "string",
  "repositoryCapacity" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.4.28. Get Legacy Snapshot

GET /devmgr/v2/storage-systems/{system-id}/legacy-snapshots/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

LegacySnapshotEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots/string
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "snapshotRef" : "string",
  "label" : "string",
  "status" : "string",
  "action" : "string",
  "currentManager" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "overWarnThreshold" : true,
  "repositoryFull" : true,
  "repFullPolicy" : "string",
  "rollbackPriority" : 0,
  "extentStart" : "string",
  "extentSize" : "string",
  "snapshotTime" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : "string",
  "totalSizeInBytes" : "string",
  "preferredControllerId" : "string",
  "repositoryCapacity" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.4.29. Update a Legacy Snapshot

POST /devmgr/v2/storage-systems/{system-id}/legacy-snapshots/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

LegacySnapshotUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

LegacySnapshotEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots/string
Request body
{
  "warningThreshold" : 0,
  "fullPolicy" : "string",
  "newName" : "string",
  "recreateSnapshot" : true
}
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "snapshotRef" : "string",
  "label" : "string",
  "status" : "string",
  "action" : "string",
  "currentManager" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "overWarnThreshold" : true,
  "repositoryFull" : true,
  "repFullPolicy" : "string",
  "rollbackPriority" : 0,
  "extentStart" : "string",
  "extentSize" : "string",
  "snapshotTime" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : "string",
  "totalSizeInBytes" : "string",
  "preferredControllerId" : "string",
  "repositoryCapacity" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.4.30. Delete a Legacy Snapshot

DELETE /devmgr/v2/storage-systems/{system-id}/legacy-snapshots/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Delete successful

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots/string

3.4.31. Request a list of ConcatVolumeCandidates for a single base volume.

POST /devmgr/v2/storage-systems/{system-id}/repositories/concat/single
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

CVCandidateSelectionRequest

Responses
HTTP Code Description Schema

200

successful operation

< CVCandidateResponse > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/repositories/concat/single
Request body
{
  "useFreeRepositoryVolumes" : true,
  "candidateRequest" : {
    "baseVolumeRef" : "string",
    "percentCapacity" : 0.0,
    "concatVolumeType" : "string"
  },
  "exclusions" : [ {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  } ]
}
Example HTTP response
Response 200
{
  "raidLevelMatch" : true,
  "samePool" : true,
  "candidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  },
  "volumeGroupId" : "string",
  "capacityMatch" : true,
  "qosMatch" : true,
  "diskPool" : true,
  "capacity" : "string",
  "baseMappableObjectId" : "string",
  "candidateType" : "string",
  "securityMatch" : true,
  "daMatch" : true,
  "driveTypeMatch" : true,
  "existingCandidate" : true
} ]

3.4.32. Get a specific Concat Repository Volume.

GET /devmgr/v2/storage-systems/{system-id}/repositories/concat/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

ConcatRepositoryVolume

404

Concat Repository Volume not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/repositories/concat/string
Example HTTP response
Response 200
{
  "concatVolRef" : "string",
  "status" : "string",
  "memberCount" : 0,
  "aggregateCapacity" : "string",
  "mediaScanParams" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "volumeHandle" : 0,
  "allowedOperations" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "memberRefs" : [ "string" ],
  "baseObjectType" : "string",
  "baseObjectId" : "string",
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.4.33. Request the best ConcatVolumeCandidate for multiple base volumes.

POST /devmgr/v2/storage-systems/{system-id}/repositories/concat/multiple
Description

If no candidate can be found for a particular base volume, a response with null Candidate will be returned in the list.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

CVCandidateMultipleSelectionRequest

Responses
HTTP Code Description Schema

200

successful operation

< CVCandidateResponse > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/repositories/concat/multiple
Request body
{
  "candidateRequests" : [ {
    "baseVolumeRef" : "string",
    "percentCapacity" : 0.0,
    "concatVolumeType" : "string"
  } ],
  "exclusions" : [ {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  } ],
  "useFreeRepositoryVolumes" : true
}
Example HTTP response
Response 200
{
  "raidLevelMatch" : true,
  "samePool" : true,
  "candidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  },
  "volumeGroupId" : "string",
  "capacityMatch" : true,
  "qosMatch" : true,
  "diskPool" : true,
  "capacity" : "string",
  "baseMappableObjectId" : "string",
  "candidateType" : "string",
  "securityMatch" : true,
  "daMatch" : true,
  "driveTypeMatch" : true,
  "existingCandidate" : true
} ]

3.4.34. Retrieve the list of Concat Repository Volumes.

GET /devmgr/v2/storage-systems/{system-id}/repositories/concat
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< ConcatRepositoryVolume > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/repositories/concat
Example HTTP response
Response 200
{
  "concatVolRef" : "string",
  "status" : "string",
  "memberCount" : 0,
  "aggregateCapacity" : "string",
  "mediaScanParams" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "volumeHandle" : 0,
  "allowedOperations" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "memberRefs" : [ "string" ],
  "baseObjectType" : "string",
  "baseObjectId" : "string",
  "id" : "string"
} ]

3.4.35. Expand a Concat Repository Volume by providing an expansion candidate.

POST /devmgr/v2/storage-systems/{system-id}/repositories/concat/{id}/expand
Description

An expansion candidate of type "expansion" is only valid for ThinVolume repositories. ThinVolume repositories are likewise also limited to a single repository member, which prevents use of the "existingVol" and "newVol" expansion types.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

ConcatVolumeExpansionRequest

Responses
HTTP Code Description Schema

200

successful operation

ConcatRepositoryVolume

404

Concat Repository Volume not found

CallResponse

422

The expansion operation failed.

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/repositories/concat/string/expand
Request body
{
  "repositoryRef" : "string",
  "expansionCandidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  }
}
Example HTTP response
Response 200
{
  "concatVolRef" : "string",
  "status" : "string",
  "memberCount" : 0,
  "aggregateCapacity" : "string",
  "mediaScanParams" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "volumeHandle" : 0,
  "allowedOperations" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "memberRefs" : [ "string" ],
  "baseObjectType" : "string",
  "baseObjectId" : "string",
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.4.36. Get all Snapshot Groups

GET /devmgr/v2/storage-systems/{system-id}/snapshot-groups
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< SnapshotGroup > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-groups
Example HTTP response
Response 200
{
  "pitGroupRef" : "string",
  "label" : "string",
  "status" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "maxBaseCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "repFullPolicy" : "string",
  "fullWarnThreshold" : 0,
  "autoDeleteLimit" : 0,
  "action" : "string",
  "rollbackStatus" : "string",
  "rollbackPriority" : "string",
  "consistencyGroup" : true,
  "consistencyGroupRef" : "string",
  "creationPendingStatus" : "string",
  "volumeHandle" : 0,
  "volcopyId" : "string",
  "snapshotCount" : 0,
  "repositoryCapacity" : "string",
  "id" : "string",
  "name" : "string"
} ]

3.4.37. Create a Snapshot Group

POST /devmgr/v2/storage-systems/{system-id}/snapshot-groups
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SnapshotGroupCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

SnapshotGroup

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-groups
Request body
{
  "baseMappableObjectId" : "string",
  "name" : "string",
  "repositoryPercentage" : 0.0,
  "warningThreshold" : 0,
  "autoDeleteLimit" : 0,
  "fullPolicy" : "string",
  "storagePoolId" : "string",
  "repositoryCandidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  },
  "schedule" : {
    "action" : "string",
    "targetObject" : "string",
    "scheduleMethod" : "string",
    "dailySchedule" : {
      "timeOfDay" : 0,
      "everyNMinutes" : 0,
      "timesPerDay" : 0
    },
    "daysOfWeek" : [ "string" ],
    "monthsOfYear" : [ "string" ],
    "daysOfMonth" : [ "string" ],
    "startDate" : "string",
    "endDate" : "string",
    "timezone" : {
      "tzLabel" : "string",
      "tzOffset" : 0,
      "dstStart" : {
        "time" : 0,
        "clockMode" : "string",
        "month" : 0,
        "dayOfMonth" : 0,
        "dayOfWeek" : 0
      },
      "dstEnd" : {
        "time" : 0,
        "clockMode" : "string",
        "month" : 0,
        "dayOfMonth" : 0,
        "dayOfWeek" : 0
      },
      "dstAdjust" : 0
    }
  }
}
Example HTTP response
Response 200
{
  "pitGroupRef" : "string",
  "label" : "string",
  "status" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "maxBaseCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "repFullPolicy" : "string",
  "fullWarnThreshold" : 0,
  "autoDeleteLimit" : 0,
  "action" : "string",
  "rollbackStatus" : "string",
  "rollbackPriority" : "string",
  "consistencyGroup" : true,
  "consistencyGroupRef" : "string",
  "creationPendingStatus" : "string",
  "volumeHandle" : 0,
  "volcopyId" : "string",
  "snapshotCount" : 0,
  "repositoryCapacity" : "string",
  "id" : "string",
  "name" : "string"
}

3.4.38. Retrieve the repository usage statistics for all SnapshotGroups.

GET /devmgr/v2/storage-systems/{system-id}/snapshot-groups/repository-utilization
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< PITGroupRepositoryUtilization > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-groups/repository-utilization
Example HTTP response
Response 200
{
  "pitGroupBytesUsed" : "string",
  "pitGroupBytesAvailable" : "string",
  "groupRef" : "string",
  "pitUtilization" : [ {
    "pitRef" : "string",
    "bytesUsed" : "string"
  } ]
} ]

3.4.39. Retrieve the repository usage statistics for a single SnapshotGroup.

GET /devmgr/v2/storage-systems/{system-id}/snapshot-groups/{id}/repository-utilization
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

PITGroupRepositoryUtilization

204

No utilization data available for this snapshot group

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-groups/string/repository-utilization
Example HTTP response
Response 200
{
  "pitGroupBytesUsed" : "string",
  "pitGroupBytesAvailable" : "string",
  "groupRef" : "string",
  "pitUtilization" : [ {
    "pitRef" : "string",
    "bytesUsed" : "string"
  } ]
}

3.4.40. Get a Snapshot Group

GET /devmgr/v2/storage-systems/{system-id}/snapshot-groups/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

SnapshotGroup

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-groups/string
Example HTTP response
Response 200
{
  "pitGroupRef" : "string",
  "label" : "string",
  "status" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "maxBaseCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "repFullPolicy" : "string",
  "fullWarnThreshold" : 0,
  "autoDeleteLimit" : 0,
  "action" : "string",
  "rollbackStatus" : "string",
  "rollbackPriority" : "string",
  "consistencyGroup" : true,
  "consistencyGroupRef" : "string",
  "creationPendingStatus" : "string",
  "volumeHandle" : 0,
  "volcopyId" : "string",
  "snapshotCount" : 0,
  "repositoryCapacity" : "string",
  "id" : "string",
  "name" : "string"
}

3.4.41. Update a Snapshot Group

POST /devmgr/v2/storage-systems/{system-id}/snapshot-groups/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

SnapshotGroupUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

SnapshotGroup

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-groups/string
Request body
{
  "name" : "string",
  "warningThreshold" : 0,
  "autoDeleteLimit" : 0,
  "fullPolicy" : "string",
  "rollbackPriority" : "string"
}
Example HTTP response
Response 200
{
  "pitGroupRef" : "string",
  "label" : "string",
  "status" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "maxBaseCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "repFullPolicy" : "string",
  "fullWarnThreshold" : 0,
  "autoDeleteLimit" : 0,
  "action" : "string",
  "rollbackStatus" : "string",
  "rollbackPriority" : "string",
  "consistencyGroup" : true,
  "consistencyGroupRef" : "string",
  "creationPendingStatus" : "string",
  "volumeHandle" : 0,
  "volcopyId" : "string",
  "snapshotCount" : 0,
  "repositoryCapacity" : "string",
  "id" : "string",
  "name" : "string"
}

3.4.42. Delete a Snapshot Group

DELETE /devmgr/v2/storage-systems/{system-id}/snapshot-groups/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Delete was successful

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-groups/string

3.4.43. Get all Snapshots

GET /devmgr/v2/storage-systems/{system-id}/snapshot-images
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< Snapshot > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-images
Example HTTP response
Response 200
{
  "pitRef" : "string",
  "pitGroupRef" : "string",
  "creationMethod" : "string",
  "pitTimestamp" : "string",
  "pitSequenceNumber" : "string",
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : "string",
  "repositoryCapacityUtilization" : "string",
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
} ]

3.4.44. Create a Snapshot

POST /devmgr/v2/storage-systems/{system-id}/snapshot-images
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SnapshotCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

Snapshot

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-images
Request body
{
  "groupId" : "string"
}
Example HTTP response
Response 200
{
  "pitRef" : "string",
  "pitGroupRef" : "string",
  "creationMethod" : "string",
  "pitTimestamp" : "string",
  "pitSequenceNumber" : "string",
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : "string",
  "repositoryCapacityUtilization" : "string",
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
}

3.4.45. Get a Snapshot Volume

GET /devmgr/v2/storage-systems/{system-id}/snapshot-images/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

Snapshot

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-images/string
Example HTTP response
Response 200
{
  "pitRef" : "string",
  "pitGroupRef" : "string",
  "creationMethod" : "string",
  "pitTimestamp" : "string",
  "pitSequenceNumber" : "string",
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : "string",
  "repositoryCapacityUtilization" : "string",
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
}

3.4.46. Delete a Snapshot Volume

DELETE /devmgr/v2/storage-systems/{system-id}/snapshot-images/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Delete was successful

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-images/string

3.4.47. Get all Snapshot Schedules

GET /devmgr/v2/storage-systems/{system-id}/snapshot-schedules
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< ScheduleInstance > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-schedules
Example HTTP response
Response 200
{
  "schedRef" : "string",
  "scheduleStatus" : "string",
  "action" : "string",
  "targetObject" : "string",
  "schedule" : {
    "calendar" : {
      "scheduleMethod" : "string",
      "daily" : {
        "dailySchedule" : {
          "timeOfDay" : 0,
          "everyNMinutes" : 0,
          "timesPerDay" : 0
        }
      },
      "weekly" : {
        "daysOfWeek" : [ "string" ],
        "dailySchedule" : {
          "timeOfDay" : 0,
          "everyNMinutes" : 0,
          "timesPerDay" : 0
        }
      },
      "monthlyByDate" : {
        "daysOfMonth" : [ "string" ],
        "monthsOfYear" : [ "string" ],
        "dailySchedule" : {
          "timeOfDay" : 0,
          "everyNMinutes" : 0,
          "timesPerDay" : 0
        }
      },
      "monthlyByDay" : {
        "dayOfWeek" : "string",
        "dailySchedule" : {
          "timeOfDay" : 0,
          "everyNMinutes" : 0,
          "timesPerDay" : 0
        },
        "weekNumber" : 0,
        "monthsOfYear" : [ "string" ]
      }
    },
    "startDate" : "string",
    "recurrence" : {
      "recurrenceType" : "string",
      "recurrenceCount" : 0,
      "recurrenceEndDate" : "string"
    },
    "timezone" : {
      "tzLabel" : "string",
      "tzOffset" : 0,
      "dstStart" : {
        "time" : 0,
        "clockMode" : "string",
        "month" : 0,
        "dayOfMonth" : 0,
        "dayOfWeek" : 0
      },
      "dstEnd" : {
        "time" : 0,
        "clockMode" : "string",
        "month" : 0,
        "dayOfMonth" : 0,
        "dayOfWeek" : 0
      },
      "dstAdjust" : 0
    }
  },
  "creationTime" : "string",
  "lastRunTime" : "string",
  "nextRunTime" : "string",
  "stopTime" : "string",
  "id" : "string"
} ]

3.4.48. Get a Snapshot Schedule

GET /devmgr/v2/storage-systems/{system-id}/snapshot-schedules/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

ScheduleInstance

404

Snapshot Schedule not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-schedules/string
Example HTTP response
Response 200
{
  "schedRef" : "string",
  "scheduleStatus" : "string",
  "action" : "string",
  "targetObject" : "string",
  "schedule" : {
    "calendar" : {
      "scheduleMethod" : "string",
      "daily" : {
        "dailySchedule" : {
          "timeOfDay" : 0,
          "everyNMinutes" : 0,
          "timesPerDay" : 0
        }
      },
      "weekly" : {
        "daysOfWeek" : [ "string" ],
        "dailySchedule" : {
          "timeOfDay" : 0,
          "everyNMinutes" : 0,
          "timesPerDay" : 0
        }
      },
      "monthlyByDate" : {
        "daysOfMonth" : [ "string" ],
        "monthsOfYear" : [ "string" ],
        "dailySchedule" : {
          "timeOfDay" : 0,
          "everyNMinutes" : 0,
          "timesPerDay" : 0
        }
      },
      "monthlyByDay" : {
        "dayOfWeek" : "string",
        "dailySchedule" : {
          "timeOfDay" : 0,
          "everyNMinutes" : 0,
          "timesPerDay" : 0
        },
        "weekNumber" : 0,
        "monthsOfYear" : [ "string" ]
      }
    },
    "startDate" : "string",
    "recurrence" : {
      "recurrenceType" : "string",
      "recurrenceCount" : 0,
      "recurrenceEndDate" : "string"
    },
    "timezone" : {
      "tzLabel" : "string",
      "tzOffset" : 0,
      "dstStart" : {
        "time" : 0,
        "clockMode" : "string",
        "month" : 0,
        "dayOfMonth" : 0,
        "dayOfWeek" : 0
      },
      "dstEnd" : {
        "time" : 0,
        "clockMode" : "string",
        "month" : 0,
        "dayOfMonth" : 0,
        "dayOfWeek" : 0
      },
      "dstAdjust" : 0
    }
  },
  "creationTime" : "string",
  "lastRunTime" : "string",
  "nextRunTime" : "string",
  "stopTime" : "string",
  "id" : "string"
}

3.4.49. Retrieve the repository usage statistics for a single SnapshotVolume.

GET /devmgr/v2/storage-systems/{system-id}/snapshot-volumes/{id}/repository-utilization
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

PITViewRepositoryUtilization

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-volumes/string/repository-utilization
Example HTTP response
Response 200
{
  "viewBytesUsed" : "string",
  "viewBytesAvailable" : "string",
  "viewRef" : "string"
}

3.4.50. Retrieve the repository usage statistics for all SnapshotVolumes.

GET /devmgr/v2/storage-systems/{system-id}/snapshot-volumes/repository-utilization
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< PITViewRepositoryUtilization > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-volumes/repository-utilization
Example HTTP response
Response 200
{
  "viewBytesUsed" : "string",
  "viewBytesAvailable" : "string",
  "viewRef" : "string"
} ]

3.4.51. Convert a ReadOnly Snapshot Volume to ReadWrite mode

POST /devmgr/v2/storage-systems/{system-id}/snapshot-volumes/{viewId}/convertReadOnly
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

viewId
required

string

Body

body
optional

SnapshotVolumeModeConversionRequest

Responses
HTTP Code Description Schema

200

successful operation

PitViewEx

404

Snapshot Volume not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-volumes/string/convertReadOnly
Request body
{
  "repositoryPercentage" : 0.0,
  "repositoryCandidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  },
  "fullThreshold" : 0
}
Example HTTP response
Response 200
{
  "viewRef" : "string",
  "worldWideName" : "string",
  "baseVol" : "string",
  "basePIT" : "string",
  "boundToPIT" : true,
  "accessMode" : "string",
  "label" : "string",
  "status" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "repositoryCapacity" : "string",
  "baseVolumeCapacity" : "string",
  "totalSizeInBytes" : "string",
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.4.52. Get all Snapshot Volumes

GET /devmgr/v2/storage-systems/{system-id}/snapshot-volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< PitViewEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-volumes
Example HTTP response
Response 200
{
  "viewRef" : "string",
  "worldWideName" : "string",
  "baseVol" : "string",
  "basePIT" : "string",
  "boundToPIT" : true,
  "accessMode" : "string",
  "label" : "string",
  "status" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "repositoryCapacity" : "string",
  "baseVolumeCapacity" : "string",
  "totalSizeInBytes" : "string",
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
} ]

3.4.53. Create a Snapshot Volume

POST /devmgr/v2/storage-systems/{system-id}/snapshot-volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SnapshotViewCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

PitViewEx

404

StorageDevice not found

422

Created object not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-volumes
Request body
{
  "snapshotImageId" : "string",
  "fullThreshold" : 0,
  "name" : "string",
  "viewMode" : "string",
  "repositoryPercentage" : 0.0,
  "repositoryPoolId" : "string",
  "repositoryCandidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  }
}
Example HTTP response
Response 200
{
  "viewRef" : "string",
  "worldWideName" : "string",
  "baseVol" : "string",
  "basePIT" : "string",
  "boundToPIT" : true,
  "accessMode" : "string",
  "label" : "string",
  "status" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "repositoryCapacity" : "string",
  "baseVolumeCapacity" : "string",
  "totalSizeInBytes" : "string",
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.4.54. Get a Snapshot Volume

GET /devmgr/v2/storage-systems/{system-id}/snapshot-volumes/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

PitViewEx

404

Snapshot Volume not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-volumes/string
Example HTTP response
Response 200
{
  "viewRef" : "string",
  "worldWideName" : "string",
  "baseVol" : "string",
  "basePIT" : "string",
  "boundToPIT" : true,
  "accessMode" : "string",
  "label" : "string",
  "status" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "repositoryCapacity" : "string",
  "baseVolumeCapacity" : "string",
  "totalSizeInBytes" : "string",
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.4.55. Update a Snapshot Volume

POST /devmgr/v2/storage-systems/{system-id}/snapshot-volumes/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

SnapshotViewUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

PitViewEx

404

Snapshot Volume not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-volumes/string
Request body
{
  "name" : "string",
  "fullThreshold" : 0
}
Example HTTP response
Response 200
{
  "viewRef" : "string",
  "worldWideName" : "string",
  "baseVol" : "string",
  "basePIT" : "string",
  "boundToPIT" : true,
  "accessMode" : "string",
  "label" : "string",
  "status" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "viewTime" : "string",
  "viewSequenceNumber" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : "string",
  "unusableRepositoryCapacity" : "string",
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "repositoryCapacity" : "string",
  "baseVolumeCapacity" : "string",
  "totalSizeInBytes" : "string",
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.4.56. Delete a Snapshot Volume

DELETE /devmgr/v2/storage-systems/{system-id}/snapshot-volumes/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Delete was successful

404

Snapshot Volume not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-volumes/string

3.4.57. Start/Stop a copy pair operation

POST /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs-control/{ids}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

ids
required

A comma separated list of id’s

string

Query

control
required

control

enum (start, stop)

Responses
HTTP Code Description Schema

200

successful operation

< VolumeCopyProgress > array

404

No valid IDs found

424

StorageDevice offline

Consumes
  • /

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs-control/string
Request query
{
  "control" : "string"
}
Example HTTP response
Response 200
{
  "percentComplete" : 0,
  "timeToCompletion" : 0,
  "volumeCopyId" : "string"
} ]

3.4.58. Get progress of a copy pair

GET /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs-control/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

VolumeCopyProgress

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs-control/string
Example HTTP response
Response 200
{
  "percentComplete" : 0,
  "timeToCompletion" : 0,
  "volumeCopyId" : "string"
}

3.4.59. Get progress of all copy pairs

GET /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs-control
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< VolumeCopyProgress > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs-control
Example HTTP response
Response 200
{
  "percentComplete" : 0,
  "timeToCompletion" : 0,
  "volumeCopyId" : "string"
} ]

3.4.60. Get the list of volume copy pairs

GET /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< VolumeCopyPair > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "volcopyHandle" : 0,
  "volcopyRef" : "string",
  "status" : "string",
  "sourceVolume" : "string",
  "targetVolume" : "string",
  "currentManager" : "string",
  "idleTargetWriteProt" : true,
  "copyCompleteTime" : "string",
  "copyStartTime" : "string",
  "copyPriority" : "string",
  "reserved1" : "string",
  "cloneCopy" : true,
  "pgRef" : "string",
  "baseSourceVolumeId" : "string",
  "id" : "string",
  "onlineCopy" : true
} ]

3.4.61. Create a new volume copy pair

POST /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs
Description

Establish a new volume copy pair by providing a source and a target volume. The target volume must be of greater or equal size to the source.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

VolumeCopyCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeCopyPair

404

StorageDevice not found

422

Created pair not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs
Request body
{
  "sourceId" : "string",
  "targetId" : "string",
  "copyPriority" : "string",
  "targetWriteProtected" : true,
  "onlineCopy" : true,
  "repositoryCandidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  }
}
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "volcopyHandle" : 0,
  "volcopyRef" : "string",
  "status" : "string",
  "sourceVolume" : "string",
  "targetVolume" : "string",
  "currentManager" : "string",
  "idleTargetWriteProt" : true,
  "copyCompleteTime" : "string",
  "copyStartTime" : "string",
  "copyPriority" : "string",
  "reserved1" : "string",
  "cloneCopy" : true,
  "pgRef" : "string",
  "baseSourceVolumeId" : "string",
  "id" : "string",
  "onlineCopy" : true
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.4.62. Get a volume copy pair

GET /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs/{vcId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

vcId
required

string

Responses
HTTP Code Description Schema

200

successful operation

VolumeCopyPair

404

VolumeCopy not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs/string
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "volcopyHandle" : 0,
  "volcopyRef" : "string",
  "status" : "string",
  "sourceVolume" : "string",
  "targetVolume" : "string",
  "currentManager" : "string",
  "idleTargetWriteProt" : true,
  "copyCompleteTime" : "string",
  "copyStartTime" : "string",
  "copyPriority" : "string",
  "reserved1" : "string",
  "cloneCopy" : true,
  "pgRef" : "string",
  "baseSourceVolumeId" : "string",
  "id" : "string",
  "onlineCopy" : true
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.4.63. Update parameters of a volume copy pair

POST /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs/{vcId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

vcId
required

string

Body

body
optional

VolumeCopyUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeCopyPair

404

VolumeCopy not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs/string
Request body
{
  "copyPriority" : "string",
  "targetWriteProtected" : true
}
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "volcopyHandle" : 0,
  "volcopyRef" : "string",
  "status" : "string",
  "sourceVolume" : "string",
  "targetVolume" : "string",
  "currentManager" : "string",
  "idleTargetWriteProt" : true,
  "copyCompleteTime" : "string",
  "copyStartTime" : "string",
  "copyPriority" : "string",
  "reserved1" : "string",
  "cloneCopy" : true,
  "pgRef" : "string",
  "baseSourceVolumeId" : "string",
  "id" : "string",
  "onlineCopy" : true
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.4.64. Remove a volume copy pair

DELETE /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs/{vcId}
Description

Online volume copies, or copies based on snapshots, require multiple operations to delete all repository volumes (if enabled). If there is a service interruption, it is possible that all repository volumes will not be deleted.These repository volumes can be retrieved using the volumes resource, and will be marked with a volumeUse of 'freeRepositoryVolume'.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

vcId
required

string

Query

retainRepositories
optional

boolean

"false"

Responses
HTTP Code Description Schema

204

Removal was successful

404

VolumeCopy not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs/string
Request query
{
  "retainRepositories" : true
}

3.5. Device-ASUP

3.5.1. Retrieve the device ASUP configuration

GET /devmgr/v2/device-asup
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Responses
HTTP Code Description Schema

200

successful operation

DeviceAsupResponse

501

Device ASUP service not available.

503

Device ASUP service is initializing.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/device-asup
Example HTTP response
Response 200
{
  "asupCapable" : true,
  "onDemandCapable" : true,
  "asupEnabled" : true,
  "onDemandEnabled" : true,
  "remoteDiagsEnabled" : true,
  "delivery" : {
    "method" : "string",
    "routingType" : "string",
    "proxyHost" : "string",
    "proxyPort" : 0,
    "proxyUserName" : "string",
    "proxyPassword" : "string",
    "proxyScript" : "string",
    "mailRelayServer" : "string",
    "mailSenderAddress" : "string"
  },
  "destinationAddress" : "string",
  "schedule" : {
    "dailyMinTime" : 0,
    "dailyMaxTime" : 0,
    "weeklyMinTime" : 0,
    "weeklyMaxTime" : 0,
    "daysOfWeek" : [ "string" ]
  }
}

3.5.2. Update the device ASUP configuration

POST /devmgr/v2/device-asup
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Body

body
optional

DeviceAsupUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

DeviceAsupResponse

501

Device ASUP service not available.

503

Device ASUP service is initializing.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/device-asup
Request body
{
  "asupEnabled" : true,
  "onDemandEnabled" : true,
  "remoteDiagsEnabled" : true,
  "delivery" : {
    "method" : "string",
    "routingType" : "string",
    "proxyHost" : "string",
    "proxyPort" : 0,
    "proxyUserName" : "string",
    "proxyPassword" : "string",
    "proxyScript" : "string",
    "mailRelayServer" : "string",
    "mailSenderAddress" : "string"
  },
  "schedule" : {
    "dailyMinTime" : 0,
    "dailyMaxTime" : 0,
    "weeklyMinTime" : 0,
    "weeklyMaxTime" : 0,
    "daysOfWeek" : [ "string" ]
  }
}
Example HTTP response
Response 200
{
  "asupCapable" : true,
  "onDemandCapable" : true,
  "asupEnabled" : true,
  "onDemandEnabled" : true,
  "remoteDiagsEnabled" : true,
  "delivery" : {
    "method" : "string",
    "routingType" : "string",
    "proxyHost" : "string",
    "proxyPort" : 0,
    "proxyUserName" : "string",
    "proxyPassword" : "string",
    "proxyScript" : "string",
    "mailRelayServer" : "string",
    "mailSenderAddress" : "string"
  },
  "destinationAddress" : "string",
  "schedule" : {
    "dailyMinTime" : 0,
    "dailyMaxTime" : 0,
    "weeklyMinTime" : 0,
    "weeklyMaxTime" : 0,
    "daysOfWeek" : [ "string" ]
  }
}

3.5.3. Retrieve ASUP information for all storage devices

GET /devmgr/v2/device-asup/devices
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Responses
HTTP Code Description Schema

200

successful operation

< DeviceAsupDevice > array

501

Device ASUP service not available.

503

Device ASUP service is initializing.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/device-asup/devices
Example HTTP response
Response 200
{
  "wwn" : "string",
  "name" : "string",
  "asupCapable" : true,
  "asupEnabled" : true,
  "onDemandCapable" : true,
  "scheduled" : true,
  "dailyScheduleTime" : 0,
  "weeklyScheduleTime" : 0,
  "weeklyDayOfWeek" : "string"
} ]

3.5.4. Retrieve a list of ASUP transimission log files

GET /devmgr/v2/device-asup/logs
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Responses
HTTP Code Description Schema

200

successful operation

< FileInfo > array

501

Device ASUP service not available.

503

Device ASUP service is initializing.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/device-asup/logs
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileName" : "string"
} ]

3.5.5. Verify a device ASUP configuration

POST /devmgr/v2/device-asup/verify-config
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Body

body
optional

DeviceAsupVerifyRequest

Responses
HTTP Code Description Schema

200

successful operation

DeviceAsupVerifyResponse

422

Invalid parameter.

501

Device ASUP service not available.

503

Device ASUP service is initializing.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/device-asup/verify-config
Request body
{
  "delivery" : {
    "method" : "string",
    "routingType" : "string",
    "proxyHost" : "string",
    "proxyPort" : 0,
    "proxyUserName" : "string",
    "proxyPassword" : "string",
    "proxyScript" : "string",
    "mailRelayServer" : "string",
    "mailSenderAddress" : "string"
  },
  "mailReplyAddress" : "string"
}
Example HTTP response
Response 200
{
  "successful" : true,
  "errorMessage" : "string",
  "aodAttempted" : true,
  "aodSuccessful" : true,
  "aodErrorMessage" : "string"
}

3.5.6. Gets an ASUP transmission log file

GET /devmgr/v2/device-asup/logs/{filename}
Description

The response type of this method is a file stream.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Schema

Path

filename
required

string

Responses
HTTP Code Description Schema

200

successful operation

file

404

File not found.

501

Device ASUP service not available.

503

Device ASUP service is initializing.

Consumes
  • application/json

Produces
  • application/octet-stream

Example HTTP request
Request path
/devmgr/v2/device-asup/logs/string
Example HTTP response
Response 200
"file"

3.5.7. Set the storage system ASUP maintenance window configuration

POST /devmgr/v2/device-asup/maintenance-window
Description

Sets the ASUP maintenance window configuration

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Body

body
optional

AsupMaintenanceWindowRequest

Responses
HTTP Code Description Schema

200

ASUP maintenance window configuration set successfully.

422

ASUP maintenance window configuration error.

501

Device ASUP service not available.

503

Device ASUP service is initializing.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/device-asup/maintenance-window
Request body
{
  "emailAddresses" : [ "string" ],
  "duration" : 0,
  "maintenanceWindowEnabled" : true
}

3.6. Diagnostics

3.6.1. Initiate sending test syslog messages using the syslog settings

POST /devmgr/v2/storage-systems/{system-id}/device-alerts/alert-syslog-test
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

AlertSyslogResponse

501

Device Alert service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts/alert-syslog-test
Example HTTP response
Response 200
{
  "response" : "string"
}

3.6.2. Retrieve the syslog configuration

GET /devmgr/v2/storage-systems/{system-id}/device-alerts/alert-syslog
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

AlertSyslogConfiguration

501

Syslog service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts/alert-syslog
Example HTTP response
Response 200
{
  "syslogReceivers" : [ {
    "serverName" : "string",
    "portNumber" : 0
  } ],
  "defaultFacility" : 0,
  "defaultTag" : "string"
}

3.6.3. Update the syslog configuration

POST /devmgr/v2/storage-systems/{system-id}/device-alerts/alert-syslog
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

AlertSyslogConfiguration

Responses
HTTP Code Description Schema

200

successful operation

AlertSyslogConfiguration

501

Syslog service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts/alert-syslog
Request body
{
  "syslogReceivers" : [ {
    "serverName" : "string",
    "portNumber" : 0
  } ],
  "defaultFacility" : 0,
  "defaultTag" : "string"
}
Example HTTP response
Response 200
{
  "syslogReceivers" : [ {
    "serverName" : "string",
    "portNumber" : 0
  } ],
  "defaultFacility" : 0,
  "defaultTag" : "string"
}

3.6.4. Get the core dump information

GET /devmgr/v2/storage-systems/{system-id}/core-dump-info
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

DPLCoreDumpData

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/core-dump-info
Example HTTP response
Response 200
{
  "dplCoreDumpTag" : 0,
  "dplCoreDumpNeedsRetrieved" : true,
  "dplCoreDumpEnabled" : true,
  "timeStamp" : "string"
}

3.6.5. Retrieve the device Alerts configuration

GET /devmgr/v2/storage-systems/{system-id}/device-alerts
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

DeviceAlertConfiguration

501

Device Alert service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts
Example HTTP response
Response 200
{
  "alertingEnabled" : true,
  "emailServerAddress" : "string",
  "emailSenderAddress" : "string",
  "sendAdditionalContactInformation" : true,
  "additionalContactInformation" : "string",
  "recipientEmailAddresses" : [ "string" ]
}

3.6.6. Update the device Alerts configuration

POST /devmgr/v2/storage-systems/{system-id}/device-alerts
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

updateRequest
required

Alert configuration request

DeviceAlertConfiguration

Responses
HTTP Code Description Schema

200

successful operation

DeviceAlertConfiguration

501

Device Alert service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts
Request body
{
  "alertingEnabled" : true,
  "emailServerAddress" : "string",
  "emailSenderAddress" : "string",
  "sendAdditionalContactInformation" : true,
  "additionalContactInformation" : "string",
  "recipientEmailAddresses" : [ "string" ]
}
Example HTTP response
Response 200
{
  "alertingEnabled" : true,
  "emailServerAddress" : "string",
  "emailSenderAddress" : "string",
  "sendAdditionalContactInformation" : true,
  "additionalContactInformation" : "string",
  "recipientEmailAddresses" : [ "string" ]
}

3.6.7. Initiate a test email using the array alert settings

POST /devmgr/v2/storage-systems/{system-id}/device-alerts/alert-email-test
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

DeviceAlertTestResponse

501

Device Alert service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts/alert-email-test
Example HTTP response
Response 200
{
  "response" : "string",
  "emailSendErrorString" : "string"
}

3.6.8. Retrieve diagnostic data about the managed device

POST /devmgr/v2/storage-systems/{system-id}/diagnostic-data
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

dataRequest
required

Diagnostic data request

DiagnosticDataRequest

Responses
HTTP Code Description Schema

200

successful operation

DeviceDataResponse

404

StorageDevice not found

501

Service not available

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/diagnostic-data
Request body
{
  "requestType" : "string"
}
Example HTTP response
Response 200
{
  "responseData" : "string"
}

3.6.9. Get list of failures

GET /devmgr/v2/storage-systems/{system-id}/failures
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

details
optional

Whether or not to fetch object data and extra data

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

< FailureData > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/failures
Request query
{
  "details" : true
}
Example HTTP response
Response 200
{
  "failureType" : "string",
  "objectRef" : "string",
  "objectType" : "string",
  "objectData" : { },
  "extraData" : { }
} ]

3.6.10. Initiate a support data retrieval request

POST /devmgr/v2/storage-systems/{system-id}/support-data
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SupportDataRequest

Responses
HTTP Code Description Schema

200

successful operation

InitialAsyncResponse

202

Request accepted

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/support-data
Request body
{
  "type" : "string",
  "filename" : "string",
  "traceSpec" : {
    "controllerA" : true,
    "controllerB" : true
  },
  "driveSpec" : {
    "driveRef" : [ "string" ]
  },
  "saveConfigSpec" : {
    "storageArraySettings" : true,
    "volumeConfiguration" : true,
    "hostConfiguration" : true,
    "volumeMappings" : true
  }
}
Example HTTP response
Response 200
{
  "requestId" : "string"
}

3.6.11. Retrieve the status of a pending data retrieval request

GET /devmgr/v2/storage-systems/{system-id}/support-data/{requestId}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

requestId
required

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

SupportDataResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/support-data/0
Example HTTP response
Response 200
{
  "requestId" : "string",
  "progress" : {
    "complete" : true,
    "percentage" : 0
  },
  "sizeInBytes" : "string",
  "type" : "string",
  "filename" : "string"
}

3.6.12. Retrieve all syslog server configurations.

GET /devmgr/v2/storage-systems/{system-id}/syslog
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

SyslogServer

404

StorageDevice not found

422

Failure loading syslog configurations

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog
Example HTTP response
Response 200
{
  "id" : "string",
  "serverAddress" : "string",
  "port" : 0,
  "protocol" : "string",
  "components" : [ {
    "type" : "string"
  } ]
}

3.6.13. Add a new syslog server configuration.

POST /devmgr/v2/storage-systems/{system-id}/syslog
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

data
required

SyslogServerRequest

Responses
HTTP Code Description Schema

200

successful operation

SyslogServer

404

StorageDevice not found

422

Error with input data

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog
Request body
{
  "serverAddress" : "string",
  "port" : 0,
  "protocol" : "string",
  "components" : [ {
    "type" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "id" : "string",
  "serverAddress" : "string",
  "port" : 0,
  "protocol" : "string",
  "components" : [ {
    "type" : "string"
  } ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.6.14. Retrieves a particular syslog server configuration.

GET /devmgr/v2/storage-systems/{system-id}/syslog/{id}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

< SyslogServer > array

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog/string
Example HTTP response
Response 200
{
  "id" : "string",
  "serverAddress" : "string",
  "port" : 0,
  "protocol" : "string",
  "components" : [ {
    "type" : "string"
  } ]
} ]

3.6.15. Update an existing syslog server configuration.

POST /devmgr/v2/storage-systems/{system-id}/syslog/{id}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

data
required

SyslogServerRequest

Responses
HTTP Code Description Schema

200

successful operation

SyslogServer

404

Object not found

422

Error with input data

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog/string
Request body
{
  "serverAddress" : "string",
  "port" : 0,
  "protocol" : "string",
  "components" : [ {
    "type" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "id" : "string",
  "serverAddress" : "string",
  "port" : 0,
  "protocol" : "string",
  "components" : [ {
    "type" : "string"
  } ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.6.16. Delete a syslog server configuration.

DELETE /devmgr/v2/storage-systems/{system-id}/syslog/{id}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog/string

3.6.17. Initiate sending a test syslog message to the current syslog server.

POST /devmgr/v2/storage-systems/{system-id}/syslog/{id}/test
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog/string/test

3.7. Drive-Firmware

3.7.1. Performs a mini health check and fetchs firmware to drive associations

GET /devmgr/v2/storage-systems/{system-id}/firmware/drives
Description

This is used to determine which drives are compatible with with firmware files that have been previously uploaded.The information returned about the drives also indicates if it can be updated online.This action also performs a mini health check to help determine if there are any storage system conditions that would prevent a firmware update to proceed.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

DriveFirmwareCompatibilityResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/firmware/drives
Example HTTP response
Response 200
{
  "contollerOffline" : true,
  "controllerMissing" : true,
  "controllerServiceMode" : true,
  "simplexMode" : true,
  "compatibilities" : [ {
    "filename" : "string",
    "firmwareVersion" : "string",
    "supportedFirmwareVersions" : [ "string" ],
    "compatibleDrives" : [ {
      "driveRef" : "string",
      "onlineUpgradeCapable" : true
    } ]
  } ]
}

3.7.2. Cancel the on going update operations.

DELETE /devmgr/v2/storage-systems/{system-id}/firmware/drives
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

204

Cancelling on going update operation success

422

An unexpected error occurred cancelling the operation.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/firmware/drives

3.7.3. Retrieve list of files in the drive firmware directory

GET /devmgr/v2/files/drive
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Responses
HTTP Code Description Schema

200

successful operation

< FileInfo > array

422

An unexpected error retrieving the list of drive firmware files.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/files/drive
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.7.4. Upload a drive firmware file

POST /devmgr/v2/files/drive
Description

Firmware file is uploaded to staging area and referenced in other drive firmware operations. If your multipart form has non-file data, it will be ignored and only the files handled.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

FormData

file
optional

drive firmware file

file

Responses
HTTP Code Description Schema

200

successful operation

< FileInfo > array

422

An unexpected error occurred saving the drive firmware file.

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/files/drive
Request formData
"file"
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.7.5. Gets a file from the drive firmware directory

GET /devmgr/v2/files/drive/{filename}
Description

The response type of this method is a file stream.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

filename
required

The name of the file

string

Query

auto-delete
optional

Automatically remove the file after the retrieval completes

boolean

Responses
HTTP Code Description Schema

200

successful operation

file

404

File not found.

Consumes
  • application/json

Produces
  • application/octet-stream

Example HTTP request
Request path
/devmgr/v2/files/drive/string
Request query
{
  "auto-delete" : true
}
Example HTTP response
Response 200
"file"

3.7.6. Deletes a drive firmware file

DELETE /devmgr/v2/files/drive/{filename}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

filename
required

The name of the file to delete

string

Responses
HTTP Code Description Schema

422

An unexpected error occurred removing the firmware file.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/files/drive/string
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.7.7. Get the status of the on going update operations.

GET /devmgr/v2/storage-systems/{system-id}/firmware/drives/state
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

DriveFirmwareStatus

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/firmware/drives/state
Example HTTP response
Response 200
{
  "overallStatus" : "string",
  "driveStatus" : [ {
    "driveRef" : "string",
    "status" : "string",
    "percentComplete" : 0
  } ]
}

3.7.8. Initiate a drive firmware update

POST /devmgr/v2/storage-systems/{system-id}/firmware/drives/initiate-upgrade
Description

The firmware files to be used for the update should be uploaded previously.When the update has been successfully initiated, the firmware files that were uploaded and used in the update will be automatically removedIf there are files uploaded but not used by the update, they not be immediately removed but may be culled later if they remain unused.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
required

Data for which drives to update.

< DriveFirmwareUpdateEntry > array

Query

onlineUpdate
required

Perform the update with the drives online.

boolean

Responses
HTTP Code Description Schema

200

successful operation

string

422

Error processing drive firmware file.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/firmware/drives/initiate-upgrade
Request body
{
  "filename" : "string",
  "driveRefList" : [ "string" ]
} ]
Request query
{
  "onlineUpdate" : true
}
Example HTTP response
Response 200
"string"
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.8. File-Management

3.8.1. Upload a private file for later reference in an API call.

POST /devmgr/v2/files/private
Description

If the provided multipart form has non-file data, that data will be ignored and only the files will be handled.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema

FormData

file
optional

file

file

Responses
HTTP Code Description Schema

200

successful operation

PrivateFileInfo

422

An unexpected error occurred while attempting to save the file.

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/files/private
Request formData
"file"
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileID" : "string",
  "fileURL" : "string"
}

3.8.2. Gets a file from the private file directory

GET /devmgr/v2/files/private/{id}
Description

The response type of this method is a file stream.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema Default

Path

id
required

The ID of the file to be retrieved

string

Query

auto-delete
optional

Automatically remove the file after the retrieval completes. The default value is false.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

file

422

An unexpected error occurred while attempting to retrieve the file.

Consumes
  • application/json

Produces
  • application/json

  • application/octet-stream

Example HTTP request
Request path
/devmgr/v2/files/private/string
Request query
{
  "auto-delete" : true
}
Example HTTP response
Response 200
"file"

3.8.3. Deletes a file from the private file directory

DELETE /devmgr/v2/files/private/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema

Path

id
required

The ID of the file to be deleted

string

Responses
HTTP Code Description Schema

422

An unexpected error occurred when attempting to delete the file.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/files/private/string

3.8.4. Retrieve a file from the scratch directory

GET /devmgr/v2/files
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Responses
HTTP Code Description Schema

200

successful operation

< FileInfo > array

422

An unexpected error occurred saving the firmware file.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/files
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.8.5. Upload a generic file for later reference in an API call.

POST /devmgr/v2/files
Description

If your multipart form has non-file data, it will be ignored and only the files handled.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

FormData

file
optional

file

file

Responses
HTTP Code Description Schema

200

successful operation

< FileInfo > array

422

An unexpected error occurred saving the firmware file.

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/files
Request formData
"file"
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.8.6. Gets a file from the scratch directory

GET /devmgr/v2/files/{filename}
Description

The response type of this method is a file stream.
This API will accept a filename (only), as a parameter to retrieve. Paths of any kind will be ignored.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

filename
required

string

Query

auto-delete
optional

Automatically remove the file after the retrieval completes

boolean

Responses
HTTP Code Description Schema

200

successful operation

file

404

File not found.

Consumes
  • application/json

Produces
  • application/octet-stream

Example HTTP request
Request path
/devmgr/v2/files/string
Request query
{
  "auto-delete" : true
}
Example HTTP response
Response 200
"file"

3.8.7. Deletes a generic file

DELETE /devmgr/v2/files/{filename}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

filename
required

Name of file to delete

string

Responses
HTTP Code Description Schema

422

An unexpected error occurred removing the firmware file.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/files/string
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.8.8. Retrieve the list of support artifacts by type

GET /devmgr/v2/support-data/files
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

< SupportArtifacts > array

501

Support artifacts service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/support-data/files
Example HTTP response
Response 200
{
  "type" : "string",
  "artifacts" : [ {
    "fileName" : "string",
    "lastModifiedTime" : "string",
    "size" : "string"
  } ]
} ]

3.8.9. Retrieve a specific support artifact.

GET /devmgr/v2/support-data/files/{identifier}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]

Parameters
Type Name Schema

Path

identifier
required

string

Responses
HTTP Code Description Schema

200

successful operation

file

403

Support artifact not accessible with current roles.

404

Support artifact not found.

501

Support artifacts service not available.

Consumes
  • application/json

Produces
  • application/octet-stream

Example HTTP request
Request path
/devmgr/v2/support-data/files/string
Example HTTP response
Response 200
"file"

3.8.10. Deletes a specific support artifact.

DELETE /devmgr/v2/support-data/files/{identifier}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]

Parameters
Type Name Schema

Path

identifier
required

string

Responses
HTTP Code Description Schema

403

Support artifact not accessible with current roles.

404

Support artifact not found.

501

Support artifacts service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/support-data/files/string

3.9. Firmware

3.9.1. Get the list of firmware files

GET /devmgr/v2/firmware/cfw-files
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Responses
HTTP Code Description Schema

200

successful operation

< CFWPackageMetadata > array

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/cfw-files
Example HTTP response
Response 200
{
  "filename" : "string",
  "version" : "string"
} ]

3.9.2. Get a specific firmware file

GET /devmgr/v2/firmware/cfw-files/{filename}
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Schema

Path

filename
required

string

Responses
HTTP Code Description Schema

200

successful operation

CFWPackageMetadata

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/cfw-files/string
Example HTTP response
Response 200
{
  "filename" : "string",
  "version" : "string"
}

3.9.3. Retrieve status of a Controller Firmware upgrade operation

GET /devmgr/v2/storage-systems/{system-id}/cfw-upgrade
Description

Retrieve the status of a running controller firmware or nvsram upgrade operation.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

CfwUpgradeResponse

404

StorageDevice not found

422

Health check failure

HealthCheckFailureResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade
Example HTTP response
Response 200
{
  "requestId" : "string",
  "healthCheck" : {
    "storageDeviceId" : "string",
    "storageDeviceName" : "string",
    "storageDeviceWWN" : "string",
    "processingTimeMS" : "string",
    "rerun" : true,
    "recommendedRecovery" : "string",
    "successful" : true,
    "storageDeviceAccessible" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "spmDatabaseVerification" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "failureMessages" : [ "string" ],
      "successful" : true
    },
    "configurationDatabaseCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "status" : "string",
      "successful" : true
    },
    "objectGraphSyncCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "cfwMatch" : true,
      "nvsramMatch" : true,
      "successful" : true
    },
    "volumeGroupsComplete" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "controllerStatusOptimal" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "hotSparesInUse" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "missingVolumes" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "driveCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "exclusiveOperations" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "volumeRefToAction" : {
        "string" : "string"
      },
      "successful" : true
    },
    "failedDrivesPresent" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "validPasswordSet" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "melCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "warningMessages" : [ "string" ],
      "successful" : true
    },
    "integratedHealthCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "healthCheckTests" : [ {
        "testPassed" : true,
        "testName" : "string",
        "resultsData" : "string"
      } ],
      "successful" : true
    }
  },
  "startTime" : "string",
  "uploadStartTime" : "string",
  "activationStartTime" : "string",
  "uploadCompletionTime" : "string",
  "uploadCompletionPercentage" : 0,
  "activationCompletionTime" : "string",
  "running" : true
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ],
  "requestId" : "string",
  "result" : {
    "requestId" : "string",
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : "string",
      "rerun" : true,
      "recommendedRecovery" : "string",
      "successful" : true,
      "storageDeviceAccessible" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "spmDatabaseVerification" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "failureMessages" : [ "string" ],
        "successful" : true
      },
      "configurationDatabaseCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "status" : "string",
        "successful" : true
      },
      "objectGraphSyncCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "cfwMatch" : true,
        "nvsramMatch" : true,
        "successful" : true
      },
      "volumeGroupsComplete" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "controllerStatusOptimal" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "hotSparesInUse" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "missingVolumes" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "driveCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "exclusiveOperations" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "volumeRefToAction" : {
          "string" : "string"
        },
        "successful" : true
      },
      "failedDrivesPresent" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "validPasswordSet" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "melCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "warningMessages" : [ "string" ],
        "successful" : true
      },
      "integratedHealthCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "healthCheckTests" : [ {
          "testPassed" : true,
          "testName" : "string",
          "resultsData" : "string"
        } ],
        "successful" : true
      }
    },
    "startTime" : "string",
    "uploadStartTime" : "string",
    "activationStartTime" : "string",
    "uploadCompletionTime" : "string",
    "uploadCompletionPercentage" : 0,
    "activationCompletionTime" : "string",
    "running" : true
  }
}

3.9.4. Initiate a Controller Firmware upgrade operation

POST /devmgr/v2/storage-systems/{system-id}/cfw-upgrade
Description

Start a controller firmware or nvsram upgrade operation.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

CfwUpgradeRequest

Responses
HTTP Code Description Schema

202

Request accepted

InitialAsyncResponse

404

StorageDevice not found

422

Health check failure

HealthCheckFailureResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade
Request body
{
  "cfwFile" : "string",
  "nvsramFile" : "string",
  "stageFirmware" : true,
  "skipMelCheck" : true
}
Example HTTP response
Response 202
{
  "requestId" : "string"
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ],
  "requestId" : "string",
  "result" : {
    "requestId" : "string",
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : "string",
      "rerun" : true,
      "recommendedRecovery" : "string",
      "successful" : true,
      "storageDeviceAccessible" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "spmDatabaseVerification" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "failureMessages" : [ "string" ],
        "successful" : true
      },
      "configurationDatabaseCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "status" : "string",
        "successful" : true
      },
      "objectGraphSyncCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "cfwMatch" : true,
        "nvsramMatch" : true,
        "successful" : true
      },
      "volumeGroupsComplete" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "controllerStatusOptimal" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "hotSparesInUse" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "missingVolumes" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "driveCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "exclusiveOperations" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "volumeRefToAction" : {
          "string" : "string"
        },
        "successful" : true
      },
      "failedDrivesPresent" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "validPasswordSet" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "melCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "warningMessages" : [ "string" ],
        "successful" : true
      },
      "integratedHealthCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "healthCheckTests" : [ {
          "testPassed" : true,
          "testName" : "string",
          "resultsData" : "string"
        } ],
        "successful" : true
      }
    },
    "startTime" : "string",
    "uploadStartTime" : "string",
    "activationStartTime" : "string",
    "uploadCompletionTime" : "string",
    "uploadCompletionPercentage" : 0,
    "activationCompletionTime" : "string",
    "running" : true
  }
}

3.9.5. Activate staged controller firmware

POST /devmgr/v2/storage-systems/{system-id}/cfw-upgrade/activate
Description

Activate Controller Firmware that was previous staged for a later upgrade operation. This operation will begin activation of the uploaded package.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

CfwActivationRequest

Responses
HTTP Code Description Schema

200

successful operation

CfwUpgradeResponse

404

StorageDevice not found

422

Health check failure

HealthCheckFailureResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade/activate
Request body
{
  "skipMelCheck" : true
}
Example HTTP response
Response 200
{
  "requestId" : "string",
  "healthCheck" : {
    "storageDeviceId" : "string",
    "storageDeviceName" : "string",
    "storageDeviceWWN" : "string",
    "processingTimeMS" : "string",
    "rerun" : true,
    "recommendedRecovery" : "string",
    "successful" : true,
    "storageDeviceAccessible" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "spmDatabaseVerification" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "failureMessages" : [ "string" ],
      "successful" : true
    },
    "configurationDatabaseCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "status" : "string",
      "successful" : true
    },
    "objectGraphSyncCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "cfwMatch" : true,
      "nvsramMatch" : true,
      "successful" : true
    },
    "volumeGroupsComplete" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "controllerStatusOptimal" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "hotSparesInUse" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "missingVolumes" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "driveCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "exclusiveOperations" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "volumeRefToAction" : {
        "string" : "string"
      },
      "successful" : true
    },
    "failedDrivesPresent" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "validPasswordSet" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "melCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "warningMessages" : [ "string" ],
      "successful" : true
    },
    "integratedHealthCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "healthCheckTests" : [ {
        "testPassed" : true,
        "testName" : "string",
        "resultsData" : "string"
      } ],
      "successful" : true
    }
  },
  "startTime" : "string",
  "uploadStartTime" : "string",
  "activationStartTime" : "string",
  "uploadCompletionTime" : "string",
  "uploadCompletionPercentage" : 0,
  "activationCompletionTime" : "string",
  "running" : true
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ],
  "requestId" : "string",
  "result" : {
    "requestId" : "string",
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : "string",
      "rerun" : true,
      "recommendedRecovery" : "string",
      "successful" : true,
      "storageDeviceAccessible" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "spmDatabaseVerification" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "failureMessages" : [ "string" ],
        "successful" : true
      },
      "configurationDatabaseCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "status" : "string",
        "successful" : true
      },
      "objectGraphSyncCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "cfwMatch" : true,
        "nvsramMatch" : true,
        "successful" : true
      },
      "volumeGroupsComplete" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "controllerStatusOptimal" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "hotSparesInUse" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "missingVolumes" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "driveCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "exclusiveOperations" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "volumeRefToAction" : {
          "string" : "string"
        },
        "successful" : true
      },
      "failedDrivesPresent" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "validPasswordSet" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "melCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "warningMessages" : [ "string" ],
        "successful" : true
      },
      "integratedHealthCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "healthCheckTests" : [ {
          "testPassed" : true,
          "testName" : "string",
          "resultsData" : "string"
        } ],
        "successful" : true
      }
    },
    "startTime" : "string",
    "uploadStartTime" : "string",
    "activationStartTime" : "string",
    "uploadCompletionTime" : "string",
    "uploadCompletionPercentage" : 0,
    "activationCompletionTime" : "string",
    "running" : true
  }
}

3.9.6. Retrieve details on the staged firmware

GET /devmgr/v2/storage-systems/{system-id}/cfw-upgrade/staged
Description

Retrieve the list of code modules and versions of the firmware staged on the storage array.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

StagedFirmwareResponse

404

StorageDevice not found

422

Health check failure

HealthCheckFailureResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade/staged
Example HTTP response
Response 200
{
  "timeStamp" : "string",
  "codeVersions" : [ {
    "codeModule" : "string",
    "versionString" : "string"
  } ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ],
  "requestId" : "string",
  "result" : {
    "requestId" : "string",
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : "string",
      "rerun" : true,
      "recommendedRecovery" : "string",
      "successful" : true,
      "storageDeviceAccessible" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "spmDatabaseVerification" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "failureMessages" : [ "string" ],
        "successful" : true
      },
      "configurationDatabaseCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "status" : "string",
        "successful" : true
      },
      "objectGraphSyncCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "cfwMatch" : true,
        "nvsramMatch" : true,
        "successful" : true
      },
      "volumeGroupsComplete" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "controllerStatusOptimal" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "hotSparesInUse" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "missingVolumes" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "driveCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "exclusiveOperations" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "volumeRefToAction" : {
          "string" : "string"
        },
        "successful" : true
      },
      "failedDrivesPresent" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "validPasswordSet" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "melCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "warningMessages" : [ "string" ],
        "successful" : true
      },
      "integratedHealthCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "healthCheckTests" : [ {
          "testPassed" : true,
          "testName" : "string",
          "resultsData" : "string"
        } ],
        "successful" : true
      }
    },
    "startTime" : "string",
    "uploadStartTime" : "string",
    "activationStartTime" : "string",
    "uploadCompletionTime" : "string",
    "uploadCompletionPercentage" : 0,
    "activationCompletionTime" : "string",
    "running" : true
  }
}

3.9.7. Clear staged firmware details on the array

DELETE /devmgr/v2/storage-systems/{system-id}/cfw-upgrade/staged
Description

Clear staged firmware details on the storage array

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

204

Staged Firmware details were successfully cleared

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade/staged

3.9.8. Get last successful firmware upgrade timestamps and firmware upgrade logs

GET /devmgr/v2/firmware/embedded-firmware
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Query

cfwUpgrade
optional

Controller Firmware Upgrade

boolean

Query

iomUpgrade
optional

IOM Firmware Upgrade

boolean

Query

driveUpgrade
optional

Drive Firmware Upgrade

boolean

Query

nvsramUpgrade
optional

NVSRAM Upgrade

boolean

Query

includeLogs
optional

Include firmware log

boolean

Responses
HTTP Code Description Schema

200

successful operation

EmbeddedFirmwareResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware
Request query
{
  "cfwUpgrade" : true,
  "iomUpgrade" : true,
  "driveUpgrade" : true,
  "nvsramUpgrade" : true,
  "includeLogs" : true
}
Example HTTP response
Response 200
{
  "cfwUpgradeTS" : "string",
  "iomUpgradeTS" : "string",
  "driveUpgradeTS" : "string",
  "nvsramUpgradeTS" : "string",
  "cfwLog" : [ {
    "level" : {
      "name" : "string",
      "resourceBundleName" : "string",
      "localizedName" : "string"
    },
    "sequenceNumber" : "string",
    "sourceClassName" : "string",
    "sourceMethodName" : "string",
    "message" : "string",
    "threadID" : 0,
    "millis" : "string",
    "thrown" : {
      "cause" : {
        "cause" : "...",
        "stackTrace" : [ {
          "methodName" : "string",
          "fileName" : "string",
          "lineNumber" : 0,
          "className" : "string",
          "nativeMethod" : true
        } ],
        "localizedMessage" : "string",
        "message" : "string",
        "suppressed" : [ "..." ]
      },
      "stackTrace" : [ {
        "methodName" : "string",
        "fileName" : "string",
        "lineNumber" : 0,
        "className" : "string",
        "nativeMethod" : true
      } ],
      "localizedMessage" : "string",
      "message" : "string",
      "suppressed" : [ "..." ]
    },
    "loggerName" : "string",
    "resourceBundleName" : "string",
    "parameters" : [ "object" ],
    "resourceBundle" : {
      "locale" : {
        "language" : "string",
        "country" : "string",
        "displayCountry" : "string",
        "displayLanguage" : "string",
        "displayName" : "string",
        "displayScript" : "string",
        "displayVariant" : "string",
        "extensionKeys" : [ "string" ],
        "iso3Country" : "string",
        "iso3Language" : "string",
        "script" : "string",
        "unicodeLocaleAttributes" : [ "string" ],
        "unicodeLocaleKeys" : [ "string" ],
        "variant" : "string"
      },
      "keys" : { },
      "baseBundleName" : "string"
    }
  } ],
  "iomLog" : [ {
    "level" : {
      "name" : "string",
      "resourceBundleName" : "string",
      "localizedName" : "string"
    },
    "sequenceNumber" : "string",
    "sourceClassName" : "string",
    "sourceMethodName" : "string",
    "message" : "string",
    "threadID" : 0,
    "millis" : "string",
    "thrown" : "...",
    "loggerName" : "string",
    "resourceBundleName" : "string",
    "parameters" : [ "object" ],
    "resourceBundle" : {
      "locale" : {
        "language" : "string",
        "country" : "string",
        "displayCountry" : "string",
        "displayLanguage" : "string",
        "displayName" : "string",
        "displayScript" : "string",
        "displayVariant" : "string",
        "extensionKeys" : [ "string" ],
        "iso3Country" : "string",
        "iso3Language" : "string",
        "script" : "string",
        "unicodeLocaleAttributes" : [ "string" ],
        "unicodeLocaleKeys" : [ "string" ],
        "variant" : "string"
      },
      "keys" : { },
      "baseBundleName" : "string"
    }
  } ],
  "driveLog" : [ {
    "level" : {
      "name" : "string",
      "resourceBundleName" : "string",
      "localizedName" : "string"
    },
    "sequenceNumber" : "string",
    "sourceClassName" : "string",
    "sourceMethodName" : "string",
    "message" : "string",
    "threadID" : 0,
    "millis" : "string",
    "thrown" : "...",
    "loggerName" : "string",
    "resourceBundleName" : "string",
    "parameters" : [ "object" ],
    "resourceBundle" : {
      "locale" : {
        "language" : "string",
        "country" : "string",
        "displayCountry" : "string",
        "displayLanguage" : "string",
        "displayName" : "string",
        "displayScript" : "string",
        "displayVariant" : "string",
        "extensionKeys" : [ "string" ],
        "iso3Country" : "string",
        "iso3Language" : "string",
        "script" : "string",
        "unicodeLocaleAttributes" : [ "string" ],
        "unicodeLocaleKeys" : [ "string" ],
        "variant" : "string"
      },
      "keys" : { },
      "baseBundleName" : "string"
    }
  } ],
  "nvsramLog" : [ {
    "level" : {
      "name" : "string",
      "resourceBundleName" : "string",
      "localizedName" : "string"
    },
    "sequenceNumber" : "string",
    "sourceClassName" : "string",
    "sourceMethodName" : "string",
    "message" : "string",
    "threadID" : 0,
    "millis" : "string",
    "thrown" : "...",
    "loggerName" : "string",
    "resourceBundleName" : "string",
    "parameters" : [ "object" ],
    "resourceBundle" : {
      "locale" : {
        "language" : "string",
        "country" : "string",
        "displayCountry" : "string",
        "displayLanguage" : "string",
        "displayName" : "string",
        "displayScript" : "string",
        "displayVariant" : "string",
        "extensionKeys" : [ "string" ],
        "iso3Country" : "string",
        "iso3Language" : "string",
        "script" : "string",
        "unicodeLocaleAttributes" : [ "string" ],
        "unicodeLocaleKeys" : [ "string" ],
        "variant" : "string"
      },
      "keys" : { },
      "baseBundleName" : "string"
    }
  } ]
}

3.9.9. Upload and activate firmware files

POST /devmgr/v2/firmware/embedded-firmware
Description

Directly loads firmware files to the controller and optionally activate the files. File can be named 'veosimage' or 'nvsramimage.'

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Query

staged
optional

Set to upload the files to the controller without activation.

boolean

Query

nvsram
optional

Set to true if the nvsram file is included in the request.

boolean

FormData

nvsramfile
optional

An image file for the non-volatile random-access memory on the controller. If included, this file must be the first file in the request. If not, an error will be generated.

file

FormData

dlpfile
optional

An image file for the controller firmware.

file

Responses
HTTP Code Description Schema

204

Controller firmware successfully uploaded.

422

An unexpected error occurred saving the firmware file.

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware
Request query
{
  "staged" : true,
  "nvsram" : true
}
Request formData
"file"
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.9.10. Upload a nvsram file.

POST /devmgr/v2/firmware/embedded-firmware/{system-id}/nvsram
Description

Upload endpoint for nvsram to download to the controller. Controllers will reboot when operation completes

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Path

system-id
required

string

FormData

nvsramimage
optional

file

Responses
HTTP Code Description Schema

422

An unexpected error occurred saving the nvsram file.

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/nvsram
Request formData
"file"
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.9.11. Activates previously staged firmware.

POST /devmgr/v2/firmware/embedded-firmware/activate
Description

A successful activation will shut the web server down which may result in the request to timeout, be canceled, or return with a 503 Service Unavailable before the success response could be returned.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Responses
HTTP Code Description Schema

204

Activation successful.

422

An unexpected error occurred activating the firmware file.

CallResponse

503

Activation was successful but the web server was shut down before the success response could be returned.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/activate
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.9.12. Get IOM service information

GET /devmgr/v2/firmware/embedded-firmware/iom/service
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Responses
HTTP Code Description Schema

200

successful operation

IomServiceInfoResponse

501

IOM service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/iom/service
Example HTTP response
Response 200
{
  "iomServiceEnabled" : true,
  "disruptiveIomFirmwareUpdate" : true
}

3.9.13. Updates the IOM service configuration

POST /devmgr/v2/firmware/embedded-firmware/iom/service
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Body

body
optional

IomServiceUpdateRequest

Responses
HTTP Code Description Schema

501

IOM service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/iom/service
Request body
{
  "enabled" : true
}

3.9.14. Retrieve details on the staged firmware

GET /devmgr/v2/firmware/embedded-firmware/{system-id}/staged
Description

Retrieve the list of code modules and versions of the firmware staged on the storage array.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Schema

Path

system-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

StagedFirmwareResponse

404

StorageDevice not found

422

Health check failure

HealthCheckFailureResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/staged
Example HTTP response
Response 200
{
  "timeStamp" : "string",
  "codeVersions" : [ {
    "codeModule" : "string",
    "versionString" : "string"
  } ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ],
  "requestId" : "string",
  "result" : {
    "requestId" : "string",
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : "string",
      "rerun" : true,
      "recommendedRecovery" : "string",
      "successful" : true,
      "storageDeviceAccessible" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "spmDatabaseVerification" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "failureMessages" : [ "string" ],
        "successful" : true
      },
      "configurationDatabaseCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "status" : "string",
        "successful" : true
      },
      "objectGraphSyncCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "cfwMatch" : true,
        "nvsramMatch" : true,
        "successful" : true
      },
      "volumeGroupsComplete" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "controllerStatusOptimal" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "hotSparesInUse" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "missingVolumes" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "driveCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "exclusiveOperations" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "volumeRefToAction" : {
          "string" : "string"
        },
        "successful" : true
      },
      "failedDrivesPresent" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "validPasswordSet" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "successful" : true
      },
      "melCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "warningMessages" : [ "string" ],
        "successful" : true
      },
      "integratedHealthCheck" : {
        "result" : "string",
        "type" : "string",
        "severityLevel" : "string",
        "resultsData" : "string",
        "healthCheckTests" : [ {
          "testPassed" : true,
          "testName" : "string",
          "resultsData" : "string"
        } ],
        "successful" : true
      }
    },
    "startTime" : "string",
    "uploadStartTime" : "string",
    "activationStartTime" : "string",
    "uploadCompletionTime" : "string",
    "uploadCompletionPercentage" : 0,
    "activationCompletionTime" : "string",
    "running" : true
  }
}

3.9.15. Clear staged firmware details on the array

DELETE /devmgr/v2/firmware/embedded-firmware/{system-id}/staged
Description

Clear staged firmware details on the storage array

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Path

system-id
required

string

Responses
HTTP Code Description Schema

204

Staged Firmware details were successfully cleared

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/staged

3.9.16. Performs compatibility and signature checks on an NVSRAM file.

POST /devmgr/v2/firmware/embedded-firmware/{system-id}/nvsram-compatibility-check
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Path

system-id
required

string

FormData

file
optional

file

Responses
HTTP Code Description Schema

200

Compatibility check completed successfully

EmbeddedCompatibilityCheckResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/nvsram-compatibility-check
Request formData
"file"
Example HTTP response
Response 200
{
  "signatureTestingPassed" : true,
  "fileCompatible" : true,
  "versionContents" : [ {
    "module" : "string",
    "bundledVersion" : "string",
    "onboardVersion" : "string"
  } ]
}

3.9.17. Performs compatibility and signature checks on a controller firmware bundle.

POST /devmgr/v2/firmware/embedded-firmware/{system-id}/bundle-compatibility-check
Description

Speed up the process by sending only first 8KB of a file.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Path

system-id
required

string

FormData

file
optional

file

Responses
HTTP Code Description Schema

200

Compatibility check completed successfully

EmbeddedCompatibilityCheckResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/bundle-compatibility-check
Request formData
"file"
Example HTTP response
Response 200
{
  "signatureTestingPassed" : true,
  "fileCompatible" : true,
  "versionContents" : [ {
    "module" : "string",
    "bundledVersion" : "string",
    "onboardVersion" : "string"
  } ]
}

3.9.18. Retrieve details on the current firmware

GET /devmgr/v2/firmware/embedded-firmware/{system-id}/versions
Description

Retrieve the list of code modules and versions of the firmware on the storage array.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Schema

Path

system-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

CurrentFirmwareResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/versions
Example HTTP response
Response 200
{
  "codeVersions" : [ {
    "codeModule" : "string",
    "versionString" : "string"
  } ]
}

3.9.19. Request status of a firmware compatibility check operation

GET /devmgr/v2/firmware/compatibility-check
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Query

requestId
optional

Retrieve result of a previously submitted request.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

FirmwareCompatibilityResponse

404

A requested request result no longer exists.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/compatibility-check
Request query
{
  "requestId" : 0
}
Example HTTP response
Response 200
{
  "checkRunning" : true,
  "cancelled" : true,
  "lastStart" : "string",
  "inaccessibleStorageDevices" : [ "string" ],
  "results" : [ {
    "storageDeviceId" : "string",
    "storageDeviceWwn" : "string",
    "cfwFiles" : [ {
      "filename" : "string",
      "version" : "string"
    } ],
    "nvsramFiles" : [ {
      "version" : "string",
      "filename" : "string"
    } ]
  } ],
  "requestId" : "string",
  "failedStorageDevices" : [ "string" ]
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.9.20. Begin a firmware compatibility check operation

POST /devmgr/v2/firmware/compatibility-check
Description

This endpoint allows a user to request all firmware and nvsram files that are compatible with a StorageSystem, or list of StorageSystems.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Body

body
optional

FirmwareCompatibilityRequest

Responses
HTTP Code Description Schema

200

successful operation

FirmwareCompatibilityResponse

422

A compatibility check is already running.

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/compatibility-check
Request body
{
  "storageDeviceIds" : [ "string" ],
  "releasedBuildsOnly" : true
}
Example HTTP response
Response 200
{
  "checkRunning" : true,
  "cancelled" : true,
  "lastStart" : "string",
  "inaccessibleStorageDevices" : [ "string" ],
  "results" : [ {
    "storageDeviceId" : "string",
    "storageDeviceWwn" : "string",
    "cfwFiles" : [ {
      "filename" : "string",
      "version" : "string"
    } ],
    "nvsramFiles" : [ {
      "version" : "string",
      "filename" : "string"
    } ]
  } ],
  "requestId" : "string",
  "failedStorageDevices" : [ "string" ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.9.21. Cancel a firmware compatibility check operation

DELETE /devmgr/v2/firmware/compatibility-check
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Responses
HTTP Code Description Schema

default

successful operation

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/compatibility-check

3.9.22. Initiate a health check operation on the storage-system

POST /devmgr/v2/storage-systems/{system-id}/health-check
Description

The health checks are designed to test whether or not a storage-system’s state is healthy enough to safely allow a firmware upgrade operation to proceed.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

FirmwareUpgradeHealthCheckResult

404

StorageDevice not found

408

Request timed out

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/health-check
Example HTTP response
Response 200
{
  "storageDeviceId" : "string",
  "storageDeviceName" : "string",
  "storageDeviceWWN" : "string",
  "processingTimeMS" : "string",
  "rerun" : true,
  "recommendedRecovery" : "string",
  "successful" : true,
  "storageDeviceAccessible" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "successful" : true
  },
  "spmDatabaseVerification" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "failureMessages" : [ "string" ],
    "successful" : true
  },
  "configurationDatabaseCheck" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "status" : "string",
    "successful" : true
  },
  "objectGraphSyncCheck" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "cfwMatch" : true,
    "nvsramMatch" : true,
    "successful" : true
  },
  "volumeGroupsComplete" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "successful" : true
  },
  "controllerStatusOptimal" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "successful" : true
  },
  "hotSparesInUse" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "successful" : true
  },
  "missingVolumes" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "successful" : true
  },
  "driveCheck" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "successful" : true
  },
  "exclusiveOperations" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "volumeRefToAction" : {
      "string" : "string"
    },
    "successful" : true
  },
  "failedDrivesPresent" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "successful" : true
  },
  "validPasswordSet" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "successful" : true
  },
  "melCheck" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "warningMessages" : [ "string" ],
    "successful" : true
  },
  "integratedHealthCheck" : {
    "result" : "string",
    "type" : "string",
    "severityLevel" : "string",
    "resultsData" : "string",
    "healthCheckTests" : [ {
      "testPassed" : true,
      "testName" : "string",
      "resultsData" : "string"
    } ],
    "successful" : true
  }
}

3.9.23. Upload a firmware file.

POST /devmgr/v2/firmware/upload
Description

The firmware file will be uploaded to the server and will be available for firmware upgrade operations. It is recommended to keep the file names the same as they were named by the company. Some file types require this and will fail of renamed

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Query

validate
optional

Validate firmware file

boolean

"true"

FormData

firmwareFile
required

The firmware file

file

Responses
HTTP Code Description Schema

200

successful operation

FileInfo

422

An unexpected error occurred saving the firmware file.

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/upload
Request query
{
  "validate" : true
}
Request formData
"file"
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileName" : "string"
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.9.24. Delete an uploaded firmware file

DELETE /devmgr/v2/firmware/upload/{filename}
Description

Delete an uploaded firmware file by providing the filename. If the file is locked the file will be scheduled for deletion on service shutdown.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Path

filename
required

string

Responses
HTTP Code Description Schema

204

File deletion was successful.

423

The file is locked and could not be deleted, but an attempt will be made to delete it upon shutdown.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/firmware/upload/string

3.9.25. Get health check status

GET /devmgr/v2/health-check
Description

This endpoint should be utilized to retrieve the results of the health check. There are multiple parts to the health check process. If a critical portion fails, the entire check will be set to failed. If an invalid password is detected or a controller cannot be contacted, the check will return without completing additional unnecessary steps.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Query

requestId
optional

Retrieve result of a previously submitted request.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

HealthCheckResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/health-check
Request query
{
  "requestId" : 0
}
Example HTTP response
Response 200
{
  "requestId" : "string",
  "healthCheckRunning" : true,
  "cancelled" : true,
  "remaining" : 0,
  "results" : [ {
    "storageDeviceId" : "string",
    "storageDeviceName" : "string",
    "storageDeviceWWN" : "string",
    "processingTimeMS" : "string",
    "rerun" : true,
    "recommendedRecovery" : "string",
    "successful" : true,
    "storageDeviceAccessible" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "spmDatabaseVerification" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "failureMessages" : [ "string" ],
      "successful" : true
    },
    "configurationDatabaseCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "status" : "string",
      "successful" : true
    },
    "objectGraphSyncCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "cfwMatch" : true,
      "nvsramMatch" : true,
      "successful" : true
    },
    "volumeGroupsComplete" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "controllerStatusOptimal" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "hotSparesInUse" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "missingVolumes" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "driveCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "exclusiveOperations" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "volumeRefToAction" : {
        "string" : "string"
      },
      "successful" : true
    },
    "failedDrivesPresent" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "validPasswordSet" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "successful" : true
    },
    "melCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "warningMessages" : [ "string" ],
      "successful" : true
    },
    "integratedHealthCheck" : {
      "result" : "string",
      "type" : "string",
      "severityLevel" : "string",
      "resultsData" : "string",
      "healthCheckTests" : [ {
        "testPassed" : true,
        "testName" : "string",
        "resultsData" : "string"
      } ],
      "successful" : true
    }
  } ],
  "start" : "string"
}

3.9.26. Begin a health check

POST /devmgr/v2/health-check
Description

The health checks are designed to test whether or not a StorageSystem is stable enough to safely allow a firmware upgrade operation to proceed. They can also be used in a generic fashion to probe a large number of StorageSystems for issues requiring attention.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Schema

Body

body
optional

HealthCheckRequest

Responses
HTTP Code Description Schema

200

successful operation

InitialAsyncResponse

202

Request accepted

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/health-check
Request body
{
  "onlineOnly" : true,
  "storageDeviceIds" : [ "string" ]
}
Example HTTP response
Response 200
{
  "requestId" : "string"
}

3.9.27. Cancel a running health check

DELETE /devmgr/v2/health-check
Description

This operation may take some time to cancel, as pending operations must be completed first.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Responses
HTTP Code Description Schema

204

Cancelled

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/health-check

3.10. Flash-Cache

3.10.1. Retrieve the FlashCache, if it exists.

GET /devmgr/v2/storage-systems/{system-id}/flash-cache
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

FlashCacheEx

404

No FlashCache has been defined

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache
Example HTTP response
Response 200
{
  "wwn" : "string",
  "flashCacheRef" : "string",
  "flashCacheBase" : {
    "label" : "string",
    "status" : "string",
    "configType" : "string",
    "analyticsStatus" : "string",
    "analyticsCause" : "string",
    "statusCause" : "string"
  },
  "fcDriveInfo" : {
    "flashCacheType" : "string",
    "fcWithDrives" : {
      "securityType" : "string",
      "protectionInformationCapabilities" : {
        "protectionInformationCapable" : true,
        "protectionType" : "string"
      },
      "usedCapacity" : "string",
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.10.2. Define a new FlashCache

POST /devmgr/v2/storage-systems/{system-id}/flash-cache
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

FlashCacheCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

FlashCacheEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache
Request body
{
  "driveRefs" : [ "string" ],
  "name" : "string",
  "enableExistingVolumes" : true
}
Example HTTP response
Response 200
{
  "wwn" : "string",
  "flashCacheRef" : "string",
  "flashCacheBase" : {
    "label" : "string",
    "status" : "string",
    "configType" : "string",
    "analyticsStatus" : "string",
    "analyticsCause" : "string",
    "statusCause" : "string"
  },
  "fcDriveInfo" : {
    "flashCacheType" : "string",
    "fcWithDrives" : {
      "securityType" : "string",
      "protectionInformationCapabilities" : {
        "protectionInformationCapable" : true,
        "protectionType" : "string"
      },
      "usedCapacity" : "string",
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}

3.10.3. Delete the defined FlashCache

DELETE /devmgr/v2/storage-systems/{system-id}/flash-cache
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

204

Delete FlashCache successful

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache

3.10.4. Modify FlashCache parameters

POST /devmgr/v2/storage-systems/{system-id}/flash-cache/configure
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

FlashCacheUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

FlashCacheEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache/configure
Request body
{
  "name" : "string",
  "configType" : "string"
}
Example HTTP response
Response 200
{
  "wwn" : "string",
  "flashCacheRef" : "string",
  "flashCacheBase" : {
    "label" : "string",
    "status" : "string",
    "configType" : "string",
    "analyticsStatus" : "string",
    "analyticsCause" : "string",
    "statusCause" : "string"
  },
  "fcDriveInfo" : {
    "flashCacheType" : "string",
    "fcWithDrives" : {
      "securityType" : "string",
      "protectionInformationCapabilities" : {
        "protectionInformationCapable" : true,
        "protectionType" : "string"
      },
      "usedCapacity" : "string",
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}

3.10.5. Resume a suspended FlashCache

POST /devmgr/v2/storage-systems/{system-id}/flash-cache/resume
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

FlashCacheEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache/resume
Example HTTP response
Response 200
{
  "wwn" : "string",
  "flashCacheRef" : "string",
  "flashCacheBase" : {
    "label" : "string",
    "status" : "string",
    "configType" : "string",
    "analyticsStatus" : "string",
    "analyticsCause" : "string",
    "statusCause" : "string"
  },
  "fcDriveInfo" : {
    "flashCacheType" : "string",
    "fcWithDrives" : {
      "securityType" : "string",
      "protectionInformationCapabilities" : {
        "protectionInformationCapable" : true,
        "protectionType" : "string"
      },
      "usedCapacity" : "string",
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}

3.10.6. Retrieve a list of volumes that are compatible with the defined flashCache

GET /devmgr/v2/storage-systems/{system-id}/flash-cache/compatibleVolumes
Description

Volumes must be compatible with the security and DataAssurance settings of the FlashCache to be added.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< string > array

404

No FlashCache has been defined

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache/compatibleVolumes
Example HTTP response
Response 200
[ "string" ]
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.10.7. Remove drives currently being used by the FlashCache

POST /devmgr/v2/storage-systems/{system-id}/flash-cache/removeDrives
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

DriveRefList

Responses
HTTP Code Description Schema

200

successful operation

FlashCacheEx

404

No FlashCache has been defined

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache/removeDrives
Request body
{
  "driveRef" : [ "string" ]
}
Example HTTP response
Response 200
{
  "wwn" : "string",
  "flashCacheRef" : "string",
  "flashCacheBase" : {
    "label" : "string",
    "status" : "string",
    "configType" : "string",
    "analyticsStatus" : "string",
    "analyticsCause" : "string",
    "statusCause" : "string"
  },
  "fcDriveInfo" : {
    "flashCacheType" : "string",
    "fcWithDrives" : {
      "securityType" : "string",
      "protectionInformationCapabilities" : {
        "protectionInformationCapable" : true,
        "protectionType" : "string"
      },
      "usedCapacity" : "string",
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.10.8. Add drives to an existing FlashCache

POST /devmgr/v2/storage-systems/{system-id}/flash-cache/addDrives
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

DriveRefList

Responses
HTTP Code Description Schema

200

successful operation

FlashCacheEx

404

No FlashCache has been defined

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache/addDrives
Request body
{
  "driveRef" : [ "string" ]
}
Example HTTP response
Response 200
{
  "wwn" : "string",
  "flashCacheRef" : "string",
  "flashCacheBase" : {
    "label" : "string",
    "status" : "string",
    "configType" : "string",
    "analyticsStatus" : "string",
    "analyticsCause" : "string",
    "statusCause" : "string"
  },
  "fcDriveInfo" : {
    "flashCacheType" : "string",
    "fcWithDrives" : {
      "securityType" : "string",
      "protectionInformationCapabilities" : {
        "protectionInformationCapable" : true,
        "protectionType" : "string"
      },
      "usedCapacity" : "string",
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.10.9. Suspend the FlashCache

POST /devmgr/v2/storage-systems/{system-id}/flash-cache/suspend
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

FlashCacheEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache/suspend
Example HTTP response
Response 200
{
  "wwn" : "string",
  "flashCacheRef" : "string",
  "flashCacheBase" : {
    "label" : "string",
    "status" : "string",
    "configType" : "string",
    "analyticsStatus" : "string",
    "analyticsCause" : "string",
    "statusCause" : "string"
  },
  "fcDriveInfo" : {
    "flashCacheType" : "string",
    "fcWithDrives" : {
      "securityType" : "string",
      "protectionInformationCapabilities" : {
        "protectionInformationCapable" : true,
        "protectionType" : "string"
      },
      "usedCapacity" : "string",
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}

3.11. Hardware

3.11.1. Get a controller

GET /devmgr/v2/storage-systems/{system-id}/controllers/{controllerId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

controllerId
required

string

Responses
HTTP Code Description Schema

200

successful operation

Controller

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/controllers/string
Example HTTP response
Response 200
{
  "active" : true,
  "quiesced" : true,
  "status" : "string",
  "controllerRef" : "string",
  "physicalLocation" : {
    "trayRef" : "string",
    "slot" : 0,
    "locationParent" : {
      "refType" : "string",
      "controllerRef" : "string",
      "symbolRef" : "string",
      "typedReference" : {
        "componentType" : "string",
        "symbolRef" : "string"
      }
    },
    "locationPosition" : 0,
    "label" : "string"
  },
  "manufacturer" : "string",
  "manufacturerDate" : "string",
  "appVersion" : "string",
  "bootVersion" : "string",
  "productID" : "string",
  "productRevLevel" : "string",
  "serialNumber" : "string",
  "boardID" : "string",
  "cacheMemorySize" : 0,
  "processorMemorySize" : 0,
  "hostInterfaces" : [ {
    "interfaceType" : "string",
    "fibre" : {
      "channel" : 0,
      "loopID" : 0,
      "speed" : 0,
      "hardAddress" : 0,
      "nodeName" : "string",
      "portName" : "string",
      "portId" : "string",
      "topology" : "string",
      "part" : "string",
      "revision" : 0,
      "chanMiswire" : true,
      "esmMiswire" : true,
      "linkStatus" : "string",
      "isDegraded" : true,
      "speedControl" : "string",
      "maxSpeed" : 0,
      "speedNegError" : true,
      "reserved1" : "string",
      "reserved2" : "string",
      "ddsChannelState" : 0,
      "ddsStateReason" : 0,
      "ddsStateWho" : 0,
      "isLocal" : true,
      "channelPorts" : [ {
        "speedDetError" : true,
        "manuallyBypassed" : true,
        "portNumber" : "string"
      } ],
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkCapable" : true,
      "trunkMiswire" : true,
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "ib" : {
      "interfaceRef" : "string",
      "channel" : 0,
      "channelPortRef" : "string",
      "localIdentifier" : 0,
      "globalIdentifier" : "string",
      "linkState" : "string",
      "portState" : "string",
      "maximumTransmissionUnit" : 0,
      "currentSpeed" : "string",
      "supportedSpeed" : [ "string" ],
      "currentLinkWidth" : "string",
      "supportedLinkWidth" : [ "string" ],
      "currentDataVirtualLanes" : 0,
      "maximumDataVirtualLanes" : 0,
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isSRPSupported" : true,
      "isISERSupported" : true,
      "physPortState" : "string",
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "isNVMeSupported" : true,
      "id" : "string"
    },
    "iscsi" : {
      "channel" : 0,
      "channelPortRef" : "string",
      "tcpListenPort" : 0,
      "ipv4Enabled" : true,
      "ipv4Data" : {
        "ipv4Address" : "string",
        "ipv4AddressConfigMethod" : "string",
        "ipv4OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4AddressData" : {
          "configState" : "string",
          "ipv4Address" : "string",
          "ipv4SubnetMask" : "string",
          "ipv4GatewayAddress" : "string"
        }
      },
      "interfaceData" : {
        "type" : "string",
        "ethernetData" : {
          "partData" : {
            "vendorName" : "string",
            "partNumber" : "string",
            "revisionNumber" : "string",
            "serialNumber" : "string"
          },
          "macAddress" : "string",
          "fullDuplex" : true,
          "maximumFramePayloadSize" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "linkStatus" : "string",
          "supportedInterfaceSpeeds" : [ "string" ],
          "autoconfigSupport" : true,
          "copperCableDiagnosticsSupport" : true
        },
        "infinibandData" : {
          "isIser" : true
        }
      },
      "interfaceRef" : "string",
      "ipv6Enabled" : true,
      "ipv6Data" : {
        "ipv6LocalAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6RoutableAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6PortRouterAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6AddressConfigMethod" : "string",
        "ipv6OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6HopLimit" : 0,
        "ipv6NdReachableTime" : 0,
        "ipv6NdRetransmitTime" : 0,
        "ipv6NdStaleTimeout" : 0,
        "ipv6DuplicateAddressDetectionAttempts" : 0
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isIPv6Capable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sas" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "part" : "string",
      "revision" : 0,
      "isDegraded" : true,
      "iocPort" : {
        "parent" : {
          "type" : "string",
          "controller" : "string",
          "drive" : "string",
          "expander" : "string",
          "hostBoardRef" : "string"
        },
        "attachedDevice" : {
          "channel" : 0,
          "channelType" : "string",
          "sasAttachedDeviceData" : {
            "type" : "string",
            "alternateController" : "string",
            "drive" : "string",
            "expander" : "string",
            "remoteHostPortAddress" : "string",
            "localController" : "string",
            "physicalLocation" : {
              "trayRef" : "string",
              "slot" : 0,
              "locationParent" : {
                "refType" : "string",
                "controllerRef" : "string",
                "symbolRef" : "string",
                "typedReference" : {
                  "componentType" : "string",
                  "symbolRef" : "string"
                }
              },
              "locationPosition" : 0,
              "label" : "string"
            }
          }
        },
        "state" : "string",
        "miswireType" : "string",
        "channelPortRef" : "string",
        "sasPhys" : [ {
          "phyIdentifier" : 0,
          "isOperational" : true
        } ],
        "portTypeData" : {
          "portType" : "string",
          "portIdentifier" : "string",
          "routingType" : "string"
        },
        "portMode" : "string",
        "domainNumber" : 0,
        "attachedChannelPortRef" : "string",
        "discoveryStatus" : 0
      },
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sata" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "speedControl" : "string",
      "part" : "string",
      "revision" : 0,
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "id" : "string"
    },
    "scsi" : {
      "channel" : 0,
      "scsiID" : 0,
      "speed" : 0,
      "scsiType" : "string",
      "width" : 0,
      "part" : "string",
      "revision" : 0,
      "reserved1" : "string",
      "reserved2" : "string"
    }
  } ],
  "driveInterfaces" : [ {
    "interfaceType" : "string",
    "fibre" : {
      "channel" : 0,
      "loopID" : 0,
      "speed" : 0,
      "hardAddress" : 0,
      "nodeName" : "string",
      "portName" : "string",
      "portId" : "string",
      "topology" : "string",
      "part" : "string",
      "revision" : 0,
      "chanMiswire" : true,
      "esmMiswire" : true,
      "linkStatus" : "string",
      "isDegraded" : true,
      "speedControl" : "string",
      "maxSpeed" : 0,
      "speedNegError" : true,
      "reserved1" : "string",
      "reserved2" : "string",
      "ddsChannelState" : 0,
      "ddsStateReason" : 0,
      "ddsStateWho" : 0,
      "isLocal" : true,
      "channelPorts" : [ {
        "speedDetError" : true,
        "manuallyBypassed" : true,
        "portNumber" : "string"
      } ],
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkCapable" : true,
      "trunkMiswire" : true,
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "ib" : {
      "interfaceRef" : "string",
      "channel" : 0,
      "channelPortRef" : "string",
      "localIdentifier" : 0,
      "globalIdentifier" : "string",
      "linkState" : "string",
      "portState" : "string",
      "maximumTransmissionUnit" : 0,
      "currentSpeed" : "string",
      "supportedSpeed" : [ "string" ],
      "currentLinkWidth" : "string",
      "supportedLinkWidth" : [ "string" ],
      "currentDataVirtualLanes" : 0,
      "maximumDataVirtualLanes" : 0,
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isSRPSupported" : true,
      "isISERSupported" : true,
      "physPortState" : "string",
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "isNVMeSupported" : true,
      "id" : "string"
    },
    "iscsi" : {
      "channel" : 0,
      "channelPortRef" : "string",
      "tcpListenPort" : 0,
      "ipv4Enabled" : true,
      "ipv4Data" : {
        "ipv4Address" : "string",
        "ipv4AddressConfigMethod" : "string",
        "ipv4OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4AddressData" : {
          "configState" : "string",
          "ipv4Address" : "string",
          "ipv4SubnetMask" : "string",
          "ipv4GatewayAddress" : "string"
        }
      },
      "interfaceData" : {
        "type" : "string",
        "ethernetData" : {
          "partData" : {
            "vendorName" : "string",
            "partNumber" : "string",
            "revisionNumber" : "string",
            "serialNumber" : "string"
          },
          "macAddress" : "string",
          "fullDuplex" : true,
          "maximumFramePayloadSize" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "linkStatus" : "string",
          "supportedInterfaceSpeeds" : [ "string" ],
          "autoconfigSupport" : true,
          "copperCableDiagnosticsSupport" : true
        },
        "infinibandData" : {
          "isIser" : true
        }
      },
      "interfaceRef" : "string",
      "ipv6Enabled" : true,
      "ipv6Data" : {
        "ipv6LocalAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6RoutableAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6PortRouterAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6AddressConfigMethod" : "string",
        "ipv6OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6HopLimit" : 0,
        "ipv6NdReachableTime" : 0,
        "ipv6NdRetransmitTime" : 0,
        "ipv6NdStaleTimeout" : 0,
        "ipv6DuplicateAddressDetectionAttempts" : 0
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isIPv6Capable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sas" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "part" : "string",
      "revision" : 0,
      "isDegraded" : true,
      "iocPort" : {
        "parent" : {
          "type" : "string",
          "controller" : "string",
          "drive" : "string",
          "expander" : "string",
          "hostBoardRef" : "string"
        },
        "attachedDevice" : {
          "channel" : 0,
          "channelType" : "string",
          "sasAttachedDeviceData" : {
            "type" : "string",
            "alternateController" : "string",
            "drive" : "string",
            "expander" : "string",
            "remoteHostPortAddress" : "string",
            "localController" : "string",
            "physicalLocation" : {
              "trayRef" : "string",
              "slot" : 0,
              "locationParent" : {
                "refType" : "string",
                "controllerRef" : "string",
                "symbolRef" : "string",
                "typedReference" : {
                  "componentType" : "string",
                  "symbolRef" : "string"
                }
              },
              "locationPosition" : 0,
              "label" : "string"
            }
          }
        },
        "state" : "string",
        "miswireType" : "string",
        "channelPortRef" : "string",
        "sasPhys" : [ {
          "phyIdentifier" : 0,
          "isOperational" : true
        } ],
        "portTypeData" : {
          "portType" : "string",
          "portIdentifier" : "string",
          "routingType" : "string"
        },
        "portMode" : "string",
        "domainNumber" : 0,
        "attachedChannelPortRef" : "string",
        "discoveryStatus" : 0
      },
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sata" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "speedControl" : "string",
      "part" : "string",
      "revision" : 0,
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "id" : "string"
    },
    "scsi" : {
      "channel" : 0,
      "scsiID" : 0,
      "speed" : 0,
      "scsiType" : "string",
      "width" : 0,
      "part" : "string",
      "revision" : 0,
      "reserved1" : "string",
      "reserved2" : "string"
    }
  } ],
  "netInterfaces" : [ {
    "interfaceType" : "string",
    "ethernet" : {
      "interfaceName" : "string",
      "channel" : 0,
      "speed" : 0,
      "ip" : 0,
      "alias" : "string",
      "macAddr" : "string",
      "gatewayIp" : 0,
      "subnetMask" : 0,
      "bootpUsed" : true,
      "rloginEnabled" : true,
      "reserved1" : "string",
      "setupError" : true,
      "reserved2" : "string",
      "interfaceRef" : "string",
      "linkStatus" : "string",
      "ipv4Enabled" : true,
      "ipv4Address" : "string",
      "ipv4SubnetMask" : "string",
      "ipv4AddressConfigMethod" : "string",
      "ipv6Enabled" : true,
      "ipv6LocalAddress" : {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      },
      "ipv6PortStaticRoutableAddress" : {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      },
      "ipv6PortRoutableAddresses" : [ {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      } ],
      "ipv6AddressConfigMethod" : "string",
      "fullDuplex" : true,
      "supportedSpeedSettings" : [ "string" ],
      "configuredSpeedSetting" : "string",
      "currentSpeed" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      }
    }
  } ],
  "inventory" : [ {
    "itemName" : "string",
    "itemVersion" : "string"
  } ],
  "reserved1" : "string",
  "reserved2" : "string",
  "hostBoardID" : "string",
  "physicalCacheMemorySize" : 0,
  "readyToRemove" : true,
  "boardSubmodelID" : "string",
  "submodelSupported" : true,
  "oemPartNumber" : "string",
  "partNumber" : "string",
  "rtrAttributes" : {
    "cruType" : "string",
    "parentCru" : {
      "type" : "string",
      "parentController" : "string",
      "parentEsm" : "string",
      "parentFan" : "string",
      "parentInterconnectCru" : "string",
      "parentSupportCru" : "string",
      "parentDrawer" : "string"
    },
    "rtrAttributeData" : {
      "hasReadyToRemoveIndicator" : true,
      "readyToRemove" : true
    }
  },
  "bootTime" : "string",
  "modelName" : "string",
  "networkSettings" : {
    "ipv4DefaultRouterAddress" : "string",
    "ipv6DefaultRouterAddress" : {
      "address" : "string",
      "addressState" : {
        "addressType" : "string",
        "interfaceAddressState" : "string",
        "routerAddressState" : "string"
      }
    },
    "ipv6CandidateDefaultRouterAddresses" : [ {
      "address" : "string",
      "addressState" : {
        "addressType" : "string",
        "interfaceAddressState" : "string",
        "routerAddressState" : "string"
      }
    } ],
    "remoteAccessEnabled" : true,
    "dnsProperties" : {
      "acquisitionProperties" : {
        "dnsAcquisitionType" : "string",
        "dnsServers" : [ {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        } ]
      },
      "dhcpAcquiredDnsServers" : [ {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      } ]
    },
    "ntpProperties" : {
      "acquisitionProperties" : {
        "ntpAcquisitionType" : "string",
        "ntpServers" : [ {
          "addrType" : "string",
          "domainName" : "string",
          "ipvxAddress" : {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          }
        } ]
      },
      "dhcpAcquiredNtpServers" : [ {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      } ]
    }
  },
  "repairPolicy" : {
    "removalData" : {
      "removalMethod" : "string",
      "rtrAttributes" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "replacementMethod" : "string"
  },
  "flashCacheMemorySize" : 0,
  "ctrlIocDumpData" : {
    "iocDumpNeedsRetrieved" : true,
    "iocDumpTag" : 0,
    "timeStamp" : "string"
  },
  "locateInProgress" : true,
  "hasTrayIdentityIndicator" : true,
  "controllerErrorMode" : "string",
  "codeVersions" : [ {
    "codeModule" : "string",
    "versionString" : "string"
  } ],
  "id" : "string"
}

3.11.2. Get the list of controllers

GET /devmgr/v2/storage-systems/{system-id}/controllers
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< Controller > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/controllers
Example HTTP response
Response 200
{
  "active" : true,
  "quiesced" : true,
  "status" : "string",
  "controllerRef" : "string",
  "physicalLocation" : {
    "trayRef" : "string",
    "slot" : 0,
    "locationParent" : {
      "refType" : "string",
      "controllerRef" : "string",
      "symbolRef" : "string",
      "typedReference" : {
        "componentType" : "string",
        "symbolRef" : "string"
      }
    },
    "locationPosition" : 0,
    "label" : "string"
  },
  "manufacturer" : "string",
  "manufacturerDate" : "string",
  "appVersion" : "string",
  "bootVersion" : "string",
  "productID" : "string",
  "productRevLevel" : "string",
  "serialNumber" : "string",
  "boardID" : "string",
  "cacheMemorySize" : 0,
  "processorMemorySize" : 0,
  "hostInterfaces" : [ {
    "interfaceType" : "string",
    "fibre" : {
      "channel" : 0,
      "loopID" : 0,
      "speed" : 0,
      "hardAddress" : 0,
      "nodeName" : "string",
      "portName" : "string",
      "portId" : "string",
      "topology" : "string",
      "part" : "string",
      "revision" : 0,
      "chanMiswire" : true,
      "esmMiswire" : true,
      "linkStatus" : "string",
      "isDegraded" : true,
      "speedControl" : "string",
      "maxSpeed" : 0,
      "speedNegError" : true,
      "reserved1" : "string",
      "reserved2" : "string",
      "ddsChannelState" : 0,
      "ddsStateReason" : 0,
      "ddsStateWho" : 0,
      "isLocal" : true,
      "channelPorts" : [ {
        "speedDetError" : true,
        "manuallyBypassed" : true,
        "portNumber" : "string"
      } ],
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkCapable" : true,
      "trunkMiswire" : true,
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "ib" : {
      "interfaceRef" : "string",
      "channel" : 0,
      "channelPortRef" : "string",
      "localIdentifier" : 0,
      "globalIdentifier" : "string",
      "linkState" : "string",
      "portState" : "string",
      "maximumTransmissionUnit" : 0,
      "currentSpeed" : "string",
      "supportedSpeed" : [ "string" ],
      "currentLinkWidth" : "string",
      "supportedLinkWidth" : [ "string" ],
      "currentDataVirtualLanes" : 0,
      "maximumDataVirtualLanes" : 0,
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isSRPSupported" : true,
      "isISERSupported" : true,
      "physPortState" : "string",
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "isNVMeSupported" : true,
      "id" : "string"
    },
    "iscsi" : {
      "channel" : 0,
      "channelPortRef" : "string",
      "tcpListenPort" : 0,
      "ipv4Enabled" : true,
      "ipv4Data" : {
        "ipv4Address" : "string",
        "ipv4AddressConfigMethod" : "string",
        "ipv4OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4AddressData" : {
          "configState" : "string",
          "ipv4Address" : "string",
          "ipv4SubnetMask" : "string",
          "ipv4GatewayAddress" : "string"
        }
      },
      "interfaceData" : {
        "type" : "string",
        "ethernetData" : {
          "partData" : {
            "vendorName" : "string",
            "partNumber" : "string",
            "revisionNumber" : "string",
            "serialNumber" : "string"
          },
          "macAddress" : "string",
          "fullDuplex" : true,
          "maximumFramePayloadSize" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "linkStatus" : "string",
          "supportedInterfaceSpeeds" : [ "string" ],
          "autoconfigSupport" : true,
          "copperCableDiagnosticsSupport" : true
        },
        "infinibandData" : {
          "isIser" : true
        }
      },
      "interfaceRef" : "string",
      "ipv6Enabled" : true,
      "ipv6Data" : {
        "ipv6LocalAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6RoutableAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6PortRouterAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6AddressConfigMethod" : "string",
        "ipv6OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6HopLimit" : 0,
        "ipv6NdReachableTime" : 0,
        "ipv6NdRetransmitTime" : 0,
        "ipv6NdStaleTimeout" : 0,
        "ipv6DuplicateAddressDetectionAttempts" : 0
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isIPv6Capable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sas" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "part" : "string",
      "revision" : 0,
      "isDegraded" : true,
      "iocPort" : {
        "parent" : {
          "type" : "string",
          "controller" : "string",
          "drive" : "string",
          "expander" : "string",
          "hostBoardRef" : "string"
        },
        "attachedDevice" : {
          "channel" : 0,
          "channelType" : "string",
          "sasAttachedDeviceData" : {
            "type" : "string",
            "alternateController" : "string",
            "drive" : "string",
            "expander" : "string",
            "remoteHostPortAddress" : "string",
            "localController" : "string",
            "physicalLocation" : {
              "trayRef" : "string",
              "slot" : 0,
              "locationParent" : {
                "refType" : "string",
                "controllerRef" : "string",
                "symbolRef" : "string",
                "typedReference" : {
                  "componentType" : "string",
                  "symbolRef" : "string"
                }
              },
              "locationPosition" : 0,
              "label" : "string"
            }
          }
        },
        "state" : "string",
        "miswireType" : "string",
        "channelPortRef" : "string",
        "sasPhys" : [ {
          "phyIdentifier" : 0,
          "isOperational" : true
        } ],
        "portTypeData" : {
          "portType" : "string",
          "portIdentifier" : "string",
          "routingType" : "string"
        },
        "portMode" : "string",
        "domainNumber" : 0,
        "attachedChannelPortRef" : "string",
        "discoveryStatus" : 0
      },
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sata" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "speedControl" : "string",
      "part" : "string",
      "revision" : 0,
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "id" : "string"
    },
    "scsi" : {
      "channel" : 0,
      "scsiID" : 0,
      "speed" : 0,
      "scsiType" : "string",
      "width" : 0,
      "part" : "string",
      "revision" : 0,
      "reserved1" : "string",
      "reserved2" : "string"
    }
  } ],
  "driveInterfaces" : [ {
    "interfaceType" : "string",
    "fibre" : {
      "channel" : 0,
      "loopID" : 0,
      "speed" : 0,
      "hardAddress" : 0,
      "nodeName" : "string",
      "portName" : "string",
      "portId" : "string",
      "topology" : "string",
      "part" : "string",
      "revision" : 0,
      "chanMiswire" : true,
      "esmMiswire" : true,
      "linkStatus" : "string",
      "isDegraded" : true,
      "speedControl" : "string",
      "maxSpeed" : 0,
      "speedNegError" : true,
      "reserved1" : "string",
      "reserved2" : "string",
      "ddsChannelState" : 0,
      "ddsStateReason" : 0,
      "ddsStateWho" : 0,
      "isLocal" : true,
      "channelPorts" : [ {
        "speedDetError" : true,
        "manuallyBypassed" : true,
        "portNumber" : "string"
      } ],
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkCapable" : true,
      "trunkMiswire" : true,
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "ib" : {
      "interfaceRef" : "string",
      "channel" : 0,
      "channelPortRef" : "string",
      "localIdentifier" : 0,
      "globalIdentifier" : "string",
      "linkState" : "string",
      "portState" : "string",
      "maximumTransmissionUnit" : 0,
      "currentSpeed" : "string",
      "supportedSpeed" : [ "string" ],
      "currentLinkWidth" : "string",
      "supportedLinkWidth" : [ "string" ],
      "currentDataVirtualLanes" : 0,
      "maximumDataVirtualLanes" : 0,
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isSRPSupported" : true,
      "isISERSupported" : true,
      "physPortState" : "string",
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "isNVMeSupported" : true,
      "id" : "string"
    },
    "iscsi" : {
      "channel" : 0,
      "channelPortRef" : "string",
      "tcpListenPort" : 0,
      "ipv4Enabled" : true,
      "ipv4Data" : {
        "ipv4Address" : "string",
        "ipv4AddressConfigMethod" : "string",
        "ipv4OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4AddressData" : {
          "configState" : "string",
          "ipv4Address" : "string",
          "ipv4SubnetMask" : "string",
          "ipv4GatewayAddress" : "string"
        }
      },
      "interfaceData" : {
        "type" : "string",
        "ethernetData" : {
          "partData" : {
            "vendorName" : "string",
            "partNumber" : "string",
            "revisionNumber" : "string",
            "serialNumber" : "string"
          },
          "macAddress" : "string",
          "fullDuplex" : true,
          "maximumFramePayloadSize" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "linkStatus" : "string",
          "supportedInterfaceSpeeds" : [ "string" ],
          "autoconfigSupport" : true,
          "copperCableDiagnosticsSupport" : true
        },
        "infinibandData" : {
          "isIser" : true
        }
      },
      "interfaceRef" : "string",
      "ipv6Enabled" : true,
      "ipv6Data" : {
        "ipv6LocalAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6RoutableAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6PortRouterAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6AddressConfigMethod" : "string",
        "ipv6OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6HopLimit" : 0,
        "ipv6NdReachableTime" : 0,
        "ipv6NdRetransmitTime" : 0,
        "ipv6NdStaleTimeout" : 0,
        "ipv6DuplicateAddressDetectionAttempts" : 0
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isIPv6Capable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sas" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "part" : "string",
      "revision" : 0,
      "isDegraded" : true,
      "iocPort" : {
        "parent" : {
          "type" : "string",
          "controller" : "string",
          "drive" : "string",
          "expander" : "string",
          "hostBoardRef" : "string"
        },
        "attachedDevice" : {
          "channel" : 0,
          "channelType" : "string",
          "sasAttachedDeviceData" : {
            "type" : "string",
            "alternateController" : "string",
            "drive" : "string",
            "expander" : "string",
            "remoteHostPortAddress" : "string",
            "localController" : "string",
            "physicalLocation" : {
              "trayRef" : "string",
              "slot" : 0,
              "locationParent" : {
                "refType" : "string",
                "controllerRef" : "string",
                "symbolRef" : "string",
                "typedReference" : {
                  "componentType" : "string",
                  "symbolRef" : "string"
                }
              },
              "locationPosition" : 0,
              "label" : "string"
            }
          }
        },
        "state" : "string",
        "miswireType" : "string",
        "channelPortRef" : "string",
        "sasPhys" : [ {
          "phyIdentifier" : 0,
          "isOperational" : true
        } ],
        "portTypeData" : {
          "portType" : "string",
          "portIdentifier" : "string",
          "routingType" : "string"
        },
        "portMode" : "string",
        "domainNumber" : 0,
        "attachedChannelPortRef" : "string",
        "discoveryStatus" : 0
      },
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sata" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "speedControl" : "string",
      "part" : "string",
      "revision" : 0,
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "id" : "string"
    },
    "scsi" : {
      "channel" : 0,
      "scsiID" : 0,
      "speed" : 0,
      "scsiType" : "string",
      "width" : 0,
      "part" : "string",
      "revision" : 0,
      "reserved1" : "string",
      "reserved2" : "string"
    }
  } ],
  "netInterfaces" : [ {
    "interfaceType" : "string",
    "ethernet" : {
      "interfaceName" : "string",
      "channel" : 0,
      "speed" : 0,
      "ip" : 0,
      "alias" : "string",
      "macAddr" : "string",
      "gatewayIp" : 0,
      "subnetMask" : 0,
      "bootpUsed" : true,
      "rloginEnabled" : true,
      "reserved1" : "string",
      "setupError" : true,
      "reserved2" : "string",
      "interfaceRef" : "string",
      "linkStatus" : "string",
      "ipv4Enabled" : true,
      "ipv4Address" : "string",
      "ipv4SubnetMask" : "string",
      "ipv4AddressConfigMethod" : "string",
      "ipv6Enabled" : true,
      "ipv6LocalAddress" : {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      },
      "ipv6PortStaticRoutableAddress" : {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      },
      "ipv6PortRoutableAddresses" : [ {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      } ],
      "ipv6AddressConfigMethod" : "string",
      "fullDuplex" : true,
      "supportedSpeedSettings" : [ "string" ],
      "configuredSpeedSetting" : "string",
      "currentSpeed" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      }
    }
  } ],
  "inventory" : [ {
    "itemName" : "string",
    "itemVersion" : "string"
  } ],
  "reserved1" : "string",
  "reserved2" : "string",
  "hostBoardID" : "string",
  "physicalCacheMemorySize" : 0,
  "readyToRemove" : true,
  "boardSubmodelID" : "string",
  "submodelSupported" : true,
  "oemPartNumber" : "string",
  "partNumber" : "string",
  "rtrAttributes" : {
    "cruType" : "string",
    "parentCru" : {
      "type" : "string",
      "parentController" : "string",
      "parentEsm" : "string",
      "parentFan" : "string",
      "parentInterconnectCru" : "string",
      "parentSupportCru" : "string",
      "parentDrawer" : "string"
    },
    "rtrAttributeData" : {
      "hasReadyToRemoveIndicator" : true,
      "readyToRemove" : true
    }
  },
  "bootTime" : "string",
  "modelName" : "string",
  "networkSettings" : {
    "ipv4DefaultRouterAddress" : "string",
    "ipv6DefaultRouterAddress" : {
      "address" : "string",
      "addressState" : {
        "addressType" : "string",
        "interfaceAddressState" : "string",
        "routerAddressState" : "string"
      }
    },
    "ipv6CandidateDefaultRouterAddresses" : [ {
      "address" : "string",
      "addressState" : {
        "addressType" : "string",
        "interfaceAddressState" : "string",
        "routerAddressState" : "string"
      }
    } ],
    "remoteAccessEnabled" : true,
    "dnsProperties" : {
      "acquisitionProperties" : {
        "dnsAcquisitionType" : "string",
        "dnsServers" : [ {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        } ]
      },
      "dhcpAcquiredDnsServers" : [ {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      } ]
    },
    "ntpProperties" : {
      "acquisitionProperties" : {
        "ntpAcquisitionType" : "string",
        "ntpServers" : [ {
          "addrType" : "string",
          "domainName" : "string",
          "ipvxAddress" : {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          }
        } ]
      },
      "dhcpAcquiredNtpServers" : [ {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      } ]
    }
  },
  "repairPolicy" : {
    "removalData" : {
      "removalMethod" : "string",
      "rtrAttributes" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "replacementMethod" : "string"
  },
  "flashCacheMemorySize" : 0,
  "ctrlIocDumpData" : {
    "iocDumpNeedsRetrieved" : true,
    "iocDumpTag" : 0,
    "timeStamp" : "string"
  },
  "locateInProgress" : true,
  "hasTrayIdentityIndicator" : true,
  "controllerErrorMode" : "string",
  "codeVersions" : [ {
    "codeModule" : "string",
    "versionString" : "string"
  } ],
  "id" : "string"
} ]

3.11.3. Get a drive

GET /devmgr/v2/storage-systems/{system-id}/drives/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

DriveEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drives/string
Example HTTP response
Response 200
{
  "offline" : true,
  "hotSpare" : true,
  "invalidDriveData" : true,
  "available" : true,
  "pfa" : true,
  "driveRef" : "string",
  "status" : "string",
  "cause" : "string",
  "interfaceType" : {
    "driveType" : "string",
    "fibre" : [ {
      "channel" : 0,
      "loopID" : 0
    } ],
    "sas" : {
      "deviceName" : "string",
      "drivePortAddresses" : [ {
        "channel" : 0,
        "portIdentifier" : "string"
      } ]
    },
    "scsi" : {
      "channel" : 0,
      "id" : 0
    }
  },
  "physicalLocation" : {
    "trayRef" : "string",
    "slot" : 0,
    "locationParent" : {
      "refType" : "string",
      "controllerRef" : "string",
      "symbolRef" : "string",
      "typedReference" : {
        "componentType" : "string",
        "symbolRef" : "string"
      }
    },
    "locationPosition" : 0,
    "label" : "string"
  },
  "manufacturer" : "string",
  "manufacturerDate" : "string",
  "productID" : "string",
  "serialNumber" : "string",
  "softwareVersion" : "string",
  "blkSize" : 0,
  "usableCapacity" : "string",
  "rawCapacity" : "string",
  "worldWideName" : "string",
  "currentVolumeGroupRef" : "string",
  "sparedForDriveRef" : "string",
  "mirrorDrive" : "string",
  "nonRedundantAccess" : true,
  "workingChannel" : 0,
  "volumeGroupIndex" : 0,
  "currentSpeed" : "string",
  "maxSpeed" : "string",
  "uncertified" : true,
  "hasDegradedChannel" : true,
  "degradedChannels" : [ 0 ],
  "phyDriveType" : "string",
  "spindleSpeed" : 0,
  "rtrAttributes" : {
    "cruType" : "string",
    "parentCru" : {
      "type" : "string",
      "parentController" : "string",
      "parentEsm" : "string",
      "parentFan" : "string",
      "parentInterconnectCru" : "string",
      "parentSupportCru" : "string",
      "parentDrawer" : "string"
    },
    "rtrAttributeData" : {
      "hasReadyToRemoveIndicator" : true,
      "readyToRemove" : true
    }
  },
  "reserved" : "string",
  "phyDriveTypeData" : {
    "phyDriveType" : "string",
    "sataDriveAttributes" : {
      "translatorData" : {
        "vendorId" : "string",
        "productId" : "string",
        "productRevLevel" : "string",
        "satType" : "string"
      },
      "ataDiskModelNumber" : "string",
      "ataDiskFwRevision" : "string"
    }
  },
  "pfaReason" : "string",
  "bypassSource" : [ {
    "refType" : "string",
    "controllerRef" : "string",
    "symbolRef" : "string",
    "typedReference" : {
      "componentType" : "string",
      "symbolRef" : "string"
    }
  } ],
  "repairPolicy" : {
    "removalData" : {
      "removalMethod" : "string",
      "rtrAttributes" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "replacementMethod" : "string"
  },
  "fdeCapable" : true,
  "fdeEnabled" : true,
  "fdeLocked" : true,
  "lockKeyID" : "string",
  "ssdWearLife" : {
    "averageEraseCountPercent" : 0,
    "spareBlocksRemainingPercent" : 0,
    "isWearLifeMonitoringSupported" : true,
    "percentEnduranceUsed" : 0
  },
  "driveMediaType" : "string",
  "fpgaVersion" : "string",
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "protectionInformationCapable" : true,
  "protectionType" : "string",
  "interposerPresent" : true,
  "interposerRef" : "string",
  "currentCommandAgingTimeout" : 0,
  "defaultCommandAgingTimeout" : 0,
  "driveTemperature" : {
    "currentTemp" : 0,
    "refTemp" : 0
  },
  "blkSizePhysical" : 0,
  "lowestAlignedLBA" : "string",
  "removed" : true,
  "locateInProgress" : true,
  "fipsCapable" : true,
  "firmwareVersion" : "string",
  "lockKeyIDValue" : "string",
  "id" : "string"
}

3.11.4. Get the list of drives

GET /devmgr/v2/storage-systems/{system-id}/drives
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< DriveEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drives
Example HTTP response
Response 200
{
  "offline" : true,
  "hotSpare" : true,
  "invalidDriveData" : true,
  "available" : true,
  "pfa" : true,
  "driveRef" : "string",
  "status" : "string",
  "cause" : "string",
  "interfaceType" : {
    "driveType" : "string",
    "fibre" : [ {
      "channel" : 0,
      "loopID" : 0
    } ],
    "sas" : {
      "deviceName" : "string",
      "drivePortAddresses" : [ {
        "channel" : 0,
        "portIdentifier" : "string"
      } ]
    },
    "scsi" : {
      "channel" : 0,
      "id" : 0
    }
  },
  "physicalLocation" : {
    "trayRef" : "string",
    "slot" : 0,
    "locationParent" : {
      "refType" : "string",
      "controllerRef" : "string",
      "symbolRef" : "string",
      "typedReference" : {
        "componentType" : "string",
        "symbolRef" : "string"
      }
    },
    "locationPosition" : 0,
    "label" : "string"
  },
  "manufacturer" : "string",
  "manufacturerDate" : "string",
  "productID" : "string",
  "serialNumber" : "string",
  "softwareVersion" : "string",
  "blkSize" : 0,
  "usableCapacity" : "string",
  "rawCapacity" : "string",
  "worldWideName" : "string",
  "currentVolumeGroupRef" : "string",
  "sparedForDriveRef" : "string",
  "mirrorDrive" : "string",
  "nonRedundantAccess" : true,
  "workingChannel" : 0,
  "volumeGroupIndex" : 0,
  "currentSpeed" : "string",
  "maxSpeed" : "string",
  "uncertified" : true,
  "hasDegradedChannel" : true,
  "degradedChannels" : [ 0 ],
  "phyDriveType" : "string",
  "spindleSpeed" : 0,
  "rtrAttributes" : {
    "cruType" : "string",
    "parentCru" : {
      "type" : "string",
      "parentController" : "string",
      "parentEsm" : "string",
      "parentFan" : "string",
      "parentInterconnectCru" : "string",
      "parentSupportCru" : "string",
      "parentDrawer" : "string"
    },
    "rtrAttributeData" : {
      "hasReadyToRemoveIndicator" : true,
      "readyToRemove" : true
    }
  },
  "reserved" : "string",
  "phyDriveTypeData" : {
    "phyDriveType" : "string",
    "sataDriveAttributes" : {
      "translatorData" : {
        "vendorId" : "string",
        "productId" : "string",
        "productRevLevel" : "string",
        "satType" : "string"
      },
      "ataDiskModelNumber" : "string",
      "ataDiskFwRevision" : "string"
    }
  },
  "pfaReason" : "string",
  "bypassSource" : [ {
    "refType" : "string",
    "controllerRef" : "string",
    "symbolRef" : "string",
    "typedReference" : {
      "componentType" : "string",
      "symbolRef" : "string"
    }
  } ],
  "repairPolicy" : {
    "removalData" : {
      "removalMethod" : "string",
      "rtrAttributes" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "replacementMethod" : "string"
  },
  "fdeCapable" : true,
  "fdeEnabled" : true,
  "fdeLocked" : true,
  "lockKeyID" : "string",
  "ssdWearLife" : {
    "averageEraseCountPercent" : 0,
    "spareBlocksRemainingPercent" : 0,
    "isWearLifeMonitoringSupported" : true,
    "percentEnduranceUsed" : 0
  },
  "driveMediaType" : "string",
  "fpgaVersion" : "string",
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "protectionInformationCapable" : true,
  "protectionType" : "string",
  "interposerPresent" : true,
  "interposerRef" : "string",
  "currentCommandAgingTimeout" : 0,
  "defaultCommandAgingTimeout" : 0,
  "driveTemperature" : {
    "currentTemp" : 0,
    "refTemp" : 0
  },
  "blkSizePhysical" : 0,
  "lowestAlignedLBA" : "string",
  "removed" : true,
  "locateInProgress" : true,
  "fipsCapable" : true,
  "firmwareVersion" : "string",
  "lockKeyIDValue" : "string",
  "id" : "string"
} ]

3.11.5. Select drives for storage-pool creation

POST /devmgr/v2/storage-systems/{system-id}/drives
Description

Retrieve a list of drives based on provided selection criteria. If the number of drives you have selected is not available based on the request parameters, then a 204 is returned.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

DriveSelectionRequest

Responses
HTTP Code Description Schema

200

A valid list of drives was found

< DriveEx > array

204

Couldn’t find a set of drives that satisfies request parameters

404

StorageDevice not found

CallResponse

422

Invalid Parameter

CallResponse

424

StorageDevice offline

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drives
Request body
{
  "driveCount" : 0,
  "selectedSpindleSpeeds" : [ 0 ],
  "fdeCapableOnly" : true,
  "driveCapacityMin" : "string",
  "driveType" : "string",
  "interfaceType" : "string",
  "protectionInformationCapable" : true,
  "sizeUnit" : "string",
  "raidLevel" : "string",
  "targetUsableCapacity" : 0
}
Example HTTP response
Response 200
{
  "offline" : true,
  "hotSpare" : true,
  "invalidDriveData" : true,
  "available" : true,
  "pfa" : true,
  "driveRef" : "string",
  "status" : "string",
  "cause" : "string",
  "interfaceType" : {
    "driveType" : "string",
    "fibre" : [ {
      "channel" : 0,
      "loopID" : 0
    } ],
    "sas" : {
      "deviceName" : "string",
      "drivePortAddresses" : [ {
        "channel" : 0,
        "portIdentifier" : "string"
      } ]
    },
    "scsi" : {
      "channel" : 0,
      "id" : 0
    }
  },
  "physicalLocation" : {
    "trayRef" : "string",
    "slot" : 0,
    "locationParent" : {
      "refType" : "string",
      "controllerRef" : "string",
      "symbolRef" : "string",
      "typedReference" : {
        "componentType" : "string",
        "symbolRef" : "string"
      }
    },
    "locationPosition" : 0,
    "label" : "string"
  },
  "manufacturer" : "string",
  "manufacturerDate" : "string",
  "productID" : "string",
  "serialNumber" : "string",
  "softwareVersion" : "string",
  "blkSize" : 0,
  "usableCapacity" : "string",
  "rawCapacity" : "string",
  "worldWideName" : "string",
  "currentVolumeGroupRef" : "string",
  "sparedForDriveRef" : "string",
  "mirrorDrive" : "string",
  "nonRedundantAccess" : true,
  "workingChannel" : 0,
  "volumeGroupIndex" : 0,
  "currentSpeed" : "string",
  "maxSpeed" : "string",
  "uncertified" : true,
  "hasDegradedChannel" : true,
  "degradedChannels" : [ 0 ],
  "phyDriveType" : "string",
  "spindleSpeed" : 0,
  "rtrAttributes" : {
    "cruType" : "string",
    "parentCru" : {
      "type" : "string",
      "parentController" : "string",
      "parentEsm" : "string",
      "parentFan" : "string",
      "parentInterconnectCru" : "string",
      "parentSupportCru" : "string",
      "parentDrawer" : "string"
    },
    "rtrAttributeData" : {
      "hasReadyToRemoveIndicator" : true,
      "readyToRemove" : true
    }
  },
  "reserved" : "string",
  "phyDriveTypeData" : {
    "phyDriveType" : "string",
    "sataDriveAttributes" : {
      "translatorData" : {
        "vendorId" : "string",
        "productId" : "string",
        "productRevLevel" : "string",
        "satType" : "string"
      },
      "ataDiskModelNumber" : "string",
      "ataDiskFwRevision" : "string"
    }
  },
  "pfaReason" : "string",
  "bypassSource" : [ {
    "refType" : "string",
    "controllerRef" : "string",
    "symbolRef" : "string",
    "typedReference" : {
      "componentType" : "string",
      "symbolRef" : "string"
    }
  } ],
  "repairPolicy" : {
    "removalData" : {
      "removalMethod" : "string",
      "rtrAttributes" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "replacementMethod" : "string"
  },
  "fdeCapable" : true,
  "fdeEnabled" : true,
  "fdeLocked" : true,
  "lockKeyID" : "string",
  "ssdWearLife" : {
    "averageEraseCountPercent" : 0,
    "spareBlocksRemainingPercent" : 0,
    "isWearLifeMonitoringSupported" : true,
    "percentEnduranceUsed" : 0
  },
  "driveMediaType" : "string",
  "fpgaVersion" : "string",
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "protectionInformationCapable" : true,
  "protectionType" : "string",
  "interposerPresent" : true,
  "interposerRef" : "string",
  "currentCommandAgingTimeout" : 0,
  "defaultCommandAgingTimeout" : 0,
  "driveTemperature" : {
    "currentTemp" : 0,
    "refTemp" : 0
  },
  "blkSizePhysical" : 0,
  "lowestAlignedLBA" : "string",
  "removed" : true,
  "locateInProgress" : true,
  "fipsCapable" : true,
  "firmwareVersion" : "string",
  "lockKeyIDValue" : "string",
  "id" : "string"
} ]
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}
Response 424
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.11.6. Get the list of unreadable sectors

GET /devmgr/v2/storage-systems/{system-id}/drives/unreadable-sectors
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

UnreadableSectorResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drives/unreadable-sectors
Example HTTP response
Response 200
{
  "maxLimit" : 0,
  "database" : [ {
    "driveRef" : "string",
    "timeStamp" : "string",
    "volumeRef" : "string",
    "recordType" : "string",
    "volumeLBA" : "string",
    "trayNo" : 0,
    "slotNo" : 0,
    "driveLBA" : "string"
  } ]
}

3.11.7. Get hardware information

GET /devmgr/v2/storage-systems/{system-id}/hardware-inventory
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

HardwareInventoryResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hardware-inventory
Example HTTP response
Response 200
{
  "drives" : [ {
    "offline" : true,
    "hotSpare" : true,
    "invalidDriveData" : true,
    "available" : true,
    "pfa" : true,
    "driveRef" : "string",
    "status" : "string",
    "cause" : "string",
    "interfaceType" : {
      "driveType" : "string",
      "fibre" : [ {
        "channel" : 0,
        "loopID" : 0
      } ],
      "sas" : {
        "deviceName" : "string",
        "drivePortAddresses" : [ {
          "channel" : 0,
          "portIdentifier" : "string"
        } ]
      },
      "scsi" : {
        "channel" : 0,
        "id" : 0
      }
    },
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "manufacturer" : "string",
    "manufacturerDate" : "string",
    "productID" : "string",
    "serialNumber" : "string",
    "softwareVersion" : "string",
    "blkSize" : 0,
    "usableCapacity" : "string",
    "rawCapacity" : "string",
    "worldWideName" : "string",
    "currentVolumeGroupRef" : "string",
    "sparedForDriveRef" : "string",
    "mirrorDrive" : "string",
    "nonRedundantAccess" : true,
    "workingChannel" : 0,
    "volumeGroupIndex" : 0,
    "currentSpeed" : "string",
    "maxSpeed" : "string",
    "uncertified" : true,
    "hasDegradedChannel" : true,
    "degradedChannels" : [ 0 ],
    "phyDriveType" : "string",
    "spindleSpeed" : 0,
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "reserved" : "string",
    "phyDriveTypeData" : {
      "phyDriveType" : "string",
      "sataDriveAttributes" : {
        "translatorData" : {
          "vendorId" : "string",
          "productId" : "string",
          "productRevLevel" : "string",
          "satType" : "string"
        },
        "ataDiskModelNumber" : "string",
        "ataDiskFwRevision" : "string"
      }
    },
    "pfaReason" : "string",
    "bypassSource" : [ {
      "refType" : "string",
      "controllerRef" : "string",
      "symbolRef" : "string",
      "typedReference" : {
        "componentType" : "string",
        "symbolRef" : "string"
      }
    } ],
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "fdeCapable" : true,
    "fdeEnabled" : true,
    "fdeLocked" : true,
    "lockKeyID" : "string",
    "ssdWearLife" : {
      "averageEraseCountPercent" : 0,
      "spareBlocksRemainingPercent" : 0,
      "isWearLifeMonitoringSupported" : true,
      "percentEnduranceUsed" : 0
    },
    "driveMediaType" : "string",
    "fpgaVersion" : "string",
    "protectionInformationCapabilities" : {
      "protectionInformationCapable" : true,
      "protectionType" : "string"
    },
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "interposerPresent" : true,
    "interposerRef" : "string",
    "currentCommandAgingTimeout" : 0,
    "defaultCommandAgingTimeout" : 0,
    "driveTemperature" : {
      "currentTemp" : 0,
      "refTemp" : 0
    },
    "blkSizePhysical" : 0,
    "lowestAlignedLBA" : "string",
    "removed" : true,
    "locateInProgress" : true,
    "fipsCapable" : true,
    "firmwareVersion" : "string",
    "lockKeyIDValue" : "string",
    "id" : "string"
  } ],
  "ibPorts" : [ {
    "interfaceRef" : "string",
    "channel" : 0,
    "channelPortRef" : "string",
    "localIdentifier" : 0,
    "globalIdentifier" : "string",
    "linkState" : "string",
    "portState" : "string",
    "maximumTransmissionUnit" : 0,
    "currentSpeed" : "string",
    "supportedSpeed" : [ "string" ],
    "currentLinkWidth" : "string",
    "supportedLinkWidth" : [ "string" ],
    "currentDataVirtualLanes" : 0,
    "maximumDataVirtualLanes" : 0,
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "protectionInformationCapable" : true,
    "isSRPSupported" : true,
    "isISERSupported" : true,
    "physPortState" : "string",
    "oneWayMaxRate" : "string",
    "bidirectionalMaxRate" : "string",
    "isNVMeSupported" : true,
    "controllerId" : "string",
    "commandProtocolProperties" : [ {
      "commandProtocol" : "string",
      "nvmeProperties" : {
        "commandSet" : "string",
        "nvmeofProperties" : {
          "provider" : "string",
          "ibProperties" : {
            "ipAddressData" : {
              "addressType" : "string",
              "ipv4Data" : {
                "configState" : "string",
                "ipv4Address" : "string",
                "ipv4SubnetMask" : "string",
                "ipv4GatewayAddress" : "string"
              },
              "ipv6Data" : {
                "address" : "string",
                "addressState" : {
                  "addressType" : "string",
                  "interfaceAddressState" : "string",
                  "routerAddressState" : "string"
                }
              }
            },
            "listeningPort" : 0
          }
        }
      }
    } ],
    "interfaceId" : "string",
    "addressId" : "string",
    "niceAddressId" : "string",
    "id" : "string"
  } ],
  "iscsiPorts" : [ {
    "channel" : 0,
    "channelPortRef" : "string",
    "tcpListenPort" : 0,
    "ipv4Enabled" : true,
    "ipv4Data" : {
      "ipv4Address" : "string",
      "ipv4AddressConfigMethod" : "string",
      "ipv4OutboundPacketPriority" : {
        "isEnabled" : true,
        "value" : 0
      },
      "ipv4VlanId" : {
        "isEnabled" : true,
        "value" : 0
      },
      "ipv4AddressData" : {
        "configState" : "string",
        "ipv4Address" : "string",
        "ipv4SubnetMask" : "string",
        "ipv4GatewayAddress" : "string"
      }
    },
    "interfaceData" : {
      "type" : "string",
      "ethernetData" : {
        "partData" : {
          "vendorName" : "string",
          "partNumber" : "string",
          "revisionNumber" : "string",
          "serialNumber" : "string"
        },
        "macAddress" : "string",
        "fullDuplex" : true,
        "maximumFramePayloadSize" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "linkStatus" : "string",
        "supportedInterfaceSpeeds" : [ "string" ],
        "autoconfigSupport" : true,
        "copperCableDiagnosticsSupport" : true
      },
      "infinibandData" : {
        "isIser" : true
      }
    },
    "interfaceRef" : "string",
    "ipv6Enabled" : true,
    "ipv6Data" : {
      "ipv6LocalAddresses" : [ {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      } ],
      "ipv6RoutableAddresses" : [ {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      } ],
      "ipv6PortRouterAddress" : {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      },
      "ipv6AddressConfigMethod" : "string",
      "ipv6OutboundPacketPriority" : {
        "isEnabled" : true,
        "value" : 0
      },
      "ipv6VlanId" : {
        "isEnabled" : true,
        "value" : 0
      },
      "ipv6HopLimit" : 0,
      "ipv6NdReachableTime" : 0,
      "ipv6NdRetransmitTime" : 0,
      "ipv6NdStaleTimeout" : 0,
      "ipv6DuplicateAddressDetectionAttempts" : 0
    },
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "protectionInformationCapable" : true,
    "isIPv6Capable" : true,
    "oneWayMaxRate" : "string",
    "bidirectionalMaxRate" : "string",
    "iqn" : "string",
    "controllerId" : "string",
    "interfaceId" : "string",
    "addressId" : "string",
    "niceAddressId" : "string",
    "id" : "string"
  } ],
  "fibrePorts" : [ {
    "channel" : 0,
    "loopID" : 0,
    "speed" : 0,
    "hardAddress" : 0,
    "nodeName" : "string",
    "portName" : "string",
    "portId" : "string",
    "topology" : "string",
    "part" : "string",
    "revision" : 0,
    "chanMiswire" : true,
    "esmMiswire" : true,
    "linkStatus" : "string",
    "isDegraded" : true,
    "speedControl" : "string",
    "maxSpeed" : 0,
    "speedNegError" : true,
    "reserved1" : "string",
    "reserved2" : "string",
    "ddsChannelState" : 0,
    "ddsStateReason" : 0,
    "ddsStateWho" : 0,
    "isLocal" : true,
    "channelPorts" : [ {
      "speedDetError" : true,
      "manuallyBypassed" : true,
      "portNumber" : "string"
    } ],
    "currentInterfaceSpeed" : "string",
    "maximumInterfaceSpeed" : "string",
    "interfaceRef" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "isTrunkCapable" : true,
    "trunkMiswire" : true,
    "protectionInformationCapable" : true,
    "oneWayMaxRate" : "string",
    "bidirectionalMaxRate" : "string",
    "controllerId" : "string",
    "interfaceId" : "string",
    "addressId" : "string",
    "niceAddressId" : "string",
    "id" : "string"
  } ],
  "sasPorts" : [ {
    "channel" : 0,
    "currentInterfaceSpeed" : "string",
    "maximumInterfaceSpeed" : "string",
    "part" : "string",
    "revision" : 0,
    "isDegraded" : true,
    "iocPort" : {
      "parent" : {
        "type" : "string",
        "controller" : "string",
        "drive" : "string",
        "expander" : "string",
        "hostBoardRef" : "string"
      },
      "attachedDevice" : {
        "channel" : 0,
        "channelType" : "string",
        "sasAttachedDeviceData" : {
          "type" : "string",
          "alternateController" : "string",
          "drive" : "string",
          "expander" : "string",
          "remoteHostPortAddress" : "string",
          "localController" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          }
        }
      },
      "state" : "string",
      "miswireType" : "string",
      "channelPortRef" : "string",
      "sasPhys" : [ {
        "phyIdentifier" : 0,
        "isOperational" : true
      } ],
      "portTypeData" : {
        "portType" : "string",
        "portIdentifier" : "string",
        "routingType" : "string"
      },
      "portMode" : "string",
      "domainNumber" : 0,
      "attachedChannelPortRef" : "string",
      "discoveryStatus" : 0
    },
    "interfaceRef" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "protectionInformationCapable" : true,
    "oneWayMaxRate" : "string",
    "bidirectionalMaxRate" : "string",
    "controllerId" : "string",
    "interfaceId" : "string",
    "addressId" : "string",
    "niceAddressId" : "string",
    "basePortAddress" : "string",
    "id" : "string"
  } ],
  "sasExpanders" : [ {
    "expanderRef" : "string",
    "parent" : {
      "expanderParentType" : "string",
      "parentController" : "string",
      "parentEsm" : "string",
      "parentDrawer" : "string"
    },
    "channel" : 0,
    "deviceName" : "string",
    "vendorId" : "string",
    "productId" : "string",
    "fwVersion" : "string",
    "expanderPorts" : [ {
      "parent" : {
        "type" : "string",
        "controller" : "string",
        "drive" : "string",
        "expander" : "string",
        "hostBoardRef" : "string"
      },
      "attachedDevice" : {
        "channel" : 0,
        "channelType" : "string",
        "sasAttachedDeviceData" : {
          "type" : "string",
          "alternateController" : "string",
          "drive" : "string",
          "expander" : "string",
          "remoteHostPortAddress" : "string",
          "localController" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          }
        }
      },
      "state" : "string",
      "miswireType" : "string",
      "channelPortRef" : "string",
      "sasPhys" : [ {
        "phyIdentifier" : 0,
        "isOperational" : true
      } ],
      "portTypeData" : {
        "portType" : "string",
        "portIdentifier" : "string",
        "routingType" : "string"
      },
      "portMode" : "string",
      "domainNumber" : 0,
      "attachedChannelPortRef" : "string",
      "discoveryStatus" : 0
    } ],
    "domainNumber" : 0,
    "id" : "string"
  } ],
  "channelPorts" : [ {
    "portRef" : "string",
    "portParent" : {
      "type" : "string",
      "controllerRef" : "string",
      "esmRef" : "string",
      "minihubRef" : "string",
      "hicRef" : "string"
    },
    "portNumber" : 0,
    "channel" : 0,
    "channelType" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "isTrunkActive" : true,
    "id" : "string"
  } ],
  "trays" : [ {
    "type" : "string",
    "orientation" : "string",
    "numControllerSlots" : 0,
    "numDriveSlots" : 0,
    "trayId" : 0,
    "trayRef" : "string",
    "nonRedundantAccess" : true,
    "partNumber" : "string",
    "serialNumber" : "string",
    "vendorName" : "string",
    "manufacturerDate" : "string",
    "fruType" : "string",
    "trayIDMismatch" : true,
    "trayIDConflict" : true,
    "esmVersionMismatch" : true,
    "esmMiswire" : true,
    "drvMHSpeedMismatch" : true,
    "unsupportedTray" : true,
    "workingChannel" : 0,
    "maxSpeed" : "string",
    "trayTechnologyType" : "string",
    "esmGroupError" : true,
    "uncertifiedTray" : true,
    "locateTray" : true,
    "esmHardwareMismatch" : true,
    "hasConfigurableTrayId" : true,
    "frontEndInterfaceTechnology" : "string",
    "driveTechnologies" : [ "string" ],
    "numDriveCompartments" : 0,
    "numDriveSlotsPerCompartment" : 0,
    "trayAttributes" : [ {
      "attributeId" : "string",
      "attributeValue" : "string"
    } ],
    "isMisconfigured" : true,
    "esmFactoryDefaultsMismatch" : true,
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "numDrawers" : 0,
    "driveLayout" : {
      "driveOrientation" : "string",
      "numRows" : 0,
      "numColumns" : 0,
      "primaryTraversal" : "string",
      "secondaryTraversal" : "string"
    },
    "factoryDefaultsData" : {
      "factoryDefaultsVersion" : "string",
      "isSupported" : true
    },
    "locateInProgress" : true,
    "hasTrayIdentityIndicator" : true,
    "trayPositionIndex" : 0,
    "id" : "string"
  } ],
  "drawers" : [ {
    "drawerRef" : "string",
    "isOpen" : true,
    "status" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "softwareVersion" : "string",
    "partNumber" : "string",
    "serialNumber" : "string",
    "vendorName" : "string",
    "manufactureDate" : "string",
    "fruType" : "string",
    "drawerType" : "string",
    "id" : "string"
  } ],
  "controllers" : [ {
    "active" : true,
    "quiesced" : true,
    "status" : "string",
    "controllerRef" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "manufacturer" : "string",
    "manufacturerDate" : "string",
    "appVersion" : "string",
    "bootVersion" : "string",
    "productID" : "string",
    "productRevLevel" : "string",
    "serialNumber" : "string",
    "boardID" : "string",
    "cacheMemorySize" : 0,
    "processorMemorySize" : 0,
    "hostInterfaces" : [ {
      "interfaceType" : "string",
      "fibre" : {
        "channel" : 0,
        "loopID" : 0,
        "speed" : 0,
        "hardAddress" : 0,
        "nodeName" : "string",
        "portName" : "string",
        "portId" : "string",
        "topology" : "string",
        "part" : "string",
        "revision" : 0,
        "chanMiswire" : true,
        "esmMiswire" : true,
        "linkStatus" : "string",
        "isDegraded" : true,
        "speedControl" : "string",
        "maxSpeed" : 0,
        "speedNegError" : true,
        "reserved1" : "string",
        "reserved2" : "string",
        "ddsChannelState" : 0,
        "ddsStateReason" : 0,
        "ddsStateWho" : 0,
        "isLocal" : true,
        "channelPorts" : [ {
          "speedDetError" : true,
          "manuallyBypassed" : true,
          "portNumber" : "string"
        } ],
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "isTrunkCapable" : true,
        "trunkMiswire" : true,
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "ib" : {
        "interfaceRef" : "string",
        "channel" : 0,
        "channelPortRef" : "string",
        "localIdentifier" : 0,
        "globalIdentifier" : "string",
        "linkState" : "string",
        "portState" : "string",
        "maximumTransmissionUnit" : 0,
        "currentSpeed" : "string",
        "supportedSpeed" : [ "string" ],
        "currentLinkWidth" : "string",
        "supportedLinkWidth" : [ "string" ],
        "currentDataVirtualLanes" : 0,
        "maximumDataVirtualLanes" : 0,
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isSRPSupported" : true,
        "isISERSupported" : true,
        "physPortState" : "string",
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "isNVMeSupported" : true,
        "id" : "string"
      },
      "iscsi" : {
        "channel" : 0,
        "channelPortRef" : "string",
        "tcpListenPort" : 0,
        "ipv4Enabled" : true,
        "ipv4Data" : {
          "ipv4Address" : "string",
          "ipv4AddressConfigMethod" : "string",
          "ipv4OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4AddressData" : {
            "configState" : "string",
            "ipv4Address" : "string",
            "ipv4SubnetMask" : "string",
            "ipv4GatewayAddress" : "string"
          }
        },
        "interfaceData" : {
          "type" : "string",
          "ethernetData" : {
            "partData" : {
              "vendorName" : "string",
              "partNumber" : "string",
              "revisionNumber" : "string",
              "serialNumber" : "string"
            },
            "macAddress" : "string",
            "fullDuplex" : true,
            "maximumFramePayloadSize" : 0,
            "currentInterfaceSpeed" : "string",
            "maximumInterfaceSpeed" : "string",
            "linkStatus" : "string",
            "supportedInterfaceSpeeds" : [ "string" ],
            "autoconfigSupport" : true,
            "copperCableDiagnosticsSupport" : true
          },
          "infinibandData" : {
            "isIser" : true
          }
        },
        "interfaceRef" : "string",
        "ipv6Enabled" : true,
        "ipv6Data" : {
          "ipv6LocalAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6RoutableAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6PortRouterAddress" : {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          },
          "ipv6AddressConfigMethod" : "string",
          "ipv6OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6HopLimit" : 0,
          "ipv6NdReachableTime" : 0,
          "ipv6NdRetransmitTime" : 0,
          "ipv6NdStaleTimeout" : 0,
          "ipv6DuplicateAddressDetectionAttempts" : 0
        },
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isIPv6Capable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sas" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "part" : "string",
        "revision" : 0,
        "isDegraded" : true,
        "iocPort" : {
          "parent" : {
            "type" : "string",
            "controller" : "string",
            "drive" : "string",
            "expander" : "string",
            "hostBoardRef" : "string"
          },
          "attachedDevice" : {
            "channel" : 0,
            "channelType" : "string",
            "sasAttachedDeviceData" : {
              "type" : "string",
              "alternateController" : "string",
              "drive" : "string",
              "expander" : "string",
              "remoteHostPortAddress" : "string",
              "localController" : "string",
              "physicalLocation" : {
                "trayRef" : "string",
                "slot" : 0,
                "locationParent" : {
                  "refType" : "string",
                  "controllerRef" : "string",
                  "symbolRef" : "string",
                  "typedReference" : {
                    "componentType" : "string",
                    "symbolRef" : "string"
                  }
                },
                "locationPosition" : 0,
                "label" : "string"
              }
            }
          },
          "state" : "string",
          "miswireType" : "string",
          "channelPortRef" : "string",
          "sasPhys" : [ {
            "phyIdentifier" : 0,
            "isOperational" : true
          } ],
          "portTypeData" : {
            "portType" : "string",
            "portIdentifier" : "string",
            "routingType" : "string"
          },
          "portMode" : "string",
          "domainNumber" : 0,
          "attachedChannelPortRef" : "string",
          "discoveryStatus" : 0
        },
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sata" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "speedControl" : "string",
        "part" : "string",
        "revision" : 0,
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "id" : "string"
      },
      "scsi" : {
        "channel" : 0,
        "scsiID" : 0,
        "speed" : 0,
        "scsiType" : "string",
        "width" : 0,
        "part" : "string",
        "revision" : 0,
        "reserved1" : "string",
        "reserved2" : "string"
      }
    } ],
    "driveInterfaces" : [ {
      "interfaceType" : "string",
      "fibre" : {
        "channel" : 0,
        "loopID" : 0,
        "speed" : 0,
        "hardAddress" : 0,
        "nodeName" : "string",
        "portName" : "string",
        "portId" : "string",
        "topology" : "string",
        "part" : "string",
        "revision" : 0,
        "chanMiswire" : true,
        "esmMiswire" : true,
        "linkStatus" : "string",
        "isDegraded" : true,
        "speedControl" : "string",
        "maxSpeed" : 0,
        "speedNegError" : true,
        "reserved1" : "string",
        "reserved2" : "string",
        "ddsChannelState" : 0,
        "ddsStateReason" : 0,
        "ddsStateWho" : 0,
        "isLocal" : true,
        "channelPorts" : [ {
          "speedDetError" : true,
          "manuallyBypassed" : true,
          "portNumber" : "string"
        } ],
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "isTrunkCapable" : true,
        "trunkMiswire" : true,
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "ib" : {
        "interfaceRef" : "string",
        "channel" : 0,
        "channelPortRef" : "string",
        "localIdentifier" : 0,
        "globalIdentifier" : "string",
        "linkState" : "string",
        "portState" : "string",
        "maximumTransmissionUnit" : 0,
        "currentSpeed" : "string",
        "supportedSpeed" : [ "string" ],
        "currentLinkWidth" : "string",
        "supportedLinkWidth" : [ "string" ],
        "currentDataVirtualLanes" : 0,
        "maximumDataVirtualLanes" : 0,
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isSRPSupported" : true,
        "isISERSupported" : true,
        "physPortState" : "string",
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "isNVMeSupported" : true,
        "id" : "string"
      },
      "iscsi" : {
        "channel" : 0,
        "channelPortRef" : "string",
        "tcpListenPort" : 0,
        "ipv4Enabled" : true,
        "ipv4Data" : {
          "ipv4Address" : "string",
          "ipv4AddressConfigMethod" : "string",
          "ipv4OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4AddressData" : {
            "configState" : "string",
            "ipv4Address" : "string",
            "ipv4SubnetMask" : "string",
            "ipv4GatewayAddress" : "string"
          }
        },
        "interfaceData" : {
          "type" : "string",
          "ethernetData" : {
            "partData" : {
              "vendorName" : "string",
              "partNumber" : "string",
              "revisionNumber" : "string",
              "serialNumber" : "string"
            },
            "macAddress" : "string",
            "fullDuplex" : true,
            "maximumFramePayloadSize" : 0,
            "currentInterfaceSpeed" : "string",
            "maximumInterfaceSpeed" : "string",
            "linkStatus" : "string",
            "supportedInterfaceSpeeds" : [ "string" ],
            "autoconfigSupport" : true,
            "copperCableDiagnosticsSupport" : true
          },
          "infinibandData" : {
            "isIser" : true
          }
        },
        "interfaceRef" : "string",
        "ipv6Enabled" : true,
        "ipv6Data" : {
          "ipv6LocalAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6RoutableAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6PortRouterAddress" : {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          },
          "ipv6AddressConfigMethod" : "string",
          "ipv6OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6HopLimit" : 0,
          "ipv6NdReachableTime" : 0,
          "ipv6NdRetransmitTime" : 0,
          "ipv6NdStaleTimeout" : 0,
          "ipv6DuplicateAddressDetectionAttempts" : 0
        },
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isIPv6Capable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sas" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "part" : "string",
        "revision" : 0,
        "isDegraded" : true,
        "iocPort" : {
          "parent" : {
            "type" : "string",
            "controller" : "string",
            "drive" : "string",
            "expander" : "string",
            "hostBoardRef" : "string"
          },
          "attachedDevice" : {
            "channel" : 0,
            "channelType" : "string",
            "sasAttachedDeviceData" : {
              "type" : "string",
              "alternateController" : "string",
              "drive" : "string",
              "expander" : "string",
              "remoteHostPortAddress" : "string",
              "localController" : "string",
              "physicalLocation" : {
                "trayRef" : "string",
                "slot" : 0,
                "locationParent" : {
                  "refType" : "string",
                  "controllerRef" : "string",
                  "symbolRef" : "string",
                  "typedReference" : {
                    "componentType" : "string",
                    "symbolRef" : "string"
                  }
                },
                "locationPosition" : 0,
                "label" : "string"
              }
            }
          },
          "state" : "string",
          "miswireType" : "string",
          "channelPortRef" : "string",
          "sasPhys" : [ {
            "phyIdentifier" : 0,
            "isOperational" : true
          } ],
          "portTypeData" : {
            "portType" : "string",
            "portIdentifier" : "string",
            "routingType" : "string"
          },
          "portMode" : "string",
          "domainNumber" : 0,
          "attachedChannelPortRef" : "string",
          "discoveryStatus" : 0
        },
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sata" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "speedControl" : "string",
        "part" : "string",
        "revision" : 0,
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "id" : "string"
      },
      "scsi" : {
        "channel" : 0,
        "scsiID" : 0,
        "speed" : 0,
        "scsiType" : "string",
        "width" : 0,
        "part" : "string",
        "revision" : 0,
        "reserved1" : "string",
        "reserved2" : "string"
      }
    } ],
    "netInterfaces" : [ {
      "interfaceType" : "string",
      "ethernet" : {
        "interfaceName" : "string",
        "channel" : 0,
        "speed" : 0,
        "ip" : 0,
        "alias" : "string",
        "macAddr" : "string",
        "gatewayIp" : 0,
        "subnetMask" : 0,
        "bootpUsed" : true,
        "rloginEnabled" : true,
        "reserved1" : "string",
        "setupError" : true,
        "reserved2" : "string",
        "interfaceRef" : "string",
        "linkStatus" : "string",
        "ipv4Enabled" : true,
        "ipv4Address" : "string",
        "ipv4SubnetMask" : "string",
        "ipv4AddressConfigMethod" : "string",
        "ipv6Enabled" : true,
        "ipv6LocalAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6PortStaticRoutableAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6PortRoutableAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6AddressConfigMethod" : "string",
        "fullDuplex" : true,
        "supportedSpeedSettings" : [ "string" ],
        "configuredSpeedSetting" : "string",
        "currentSpeed" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        }
      }
    } ],
    "inventory" : [ {
      "itemName" : "string",
      "itemVersion" : "string"
    } ],
    "reserved1" : "string",
    "reserved2" : "string",
    "hostBoardID" : "string",
    "physicalCacheMemorySize" : 0,
    "readyToRemove" : true,
    "boardSubmodelID" : "string",
    "submodelSupported" : true,
    "oemPartNumber" : "string",
    "partNumber" : "string",
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "bootTime" : "string",
    "modelName" : "string",
    "networkSettings" : {
      "ipv4DefaultRouterAddress" : "string",
      "ipv6DefaultRouterAddress" : {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      },
      "ipv6CandidateDefaultRouterAddresses" : [ {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      } ],
      "remoteAccessEnabled" : true,
      "dnsProperties" : {
        "acquisitionProperties" : {
          "dnsAcquisitionType" : "string",
          "dnsServers" : [ {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          } ]
        },
        "dhcpAcquiredDnsServers" : [ {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        } ]
      },
      "ntpProperties" : {
        "acquisitionProperties" : {
          "ntpAcquisitionType" : "string",
          "ntpServers" : [ {
            "addrType" : "string",
            "domainName" : "string",
            "ipvxAddress" : {
              "addressType" : "string",
              "ipv4Address" : "string",
              "ipv6Address" : "string"
            }
          } ]
        },
        "dhcpAcquiredNtpServers" : [ {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        } ]
      }
    },
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "flashCacheMemorySize" : 0,
    "ctrlIocDumpData" : {
      "iocDumpNeedsRetrieved" : true,
      "iocDumpTag" : 0,
      "timeStamp" : "string"
    },
    "locateInProgress" : true,
    "hasTrayIdentityIndicator" : true,
    "controllerErrorMode" : "string",
    "codeVersions" : [ {
      "codeModule" : "string",
      "versionString" : "string"
    } ],
    "id" : "string"
  } ],
  "batteries" : [ {
    "batteryRef" : "string",
    "status" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "batteryAge" : 0,
    "batteryLifeRemaining" : 0,
    "batteryTypeData" : {
      "batteryType" : "string",
      "cruParentController" : "string",
      "parentController" : "string"
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "manufacturerDate" : "string",
    "vendorName" : "string",
    "vendorPN" : "string",
    "vendorSN" : "string",
    "fruType" : "string",
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "batteryCanExpire" : true,
    "automaticAgeReset" : true,
    "learnCycleData" : {
      "lastBatteryLearnCycle" : "string",
      "nextBatteryLearnCycle" : "string",
      "batteryLearnCycleInterval" : 0
    },
    "smartBatteryData" : {
      "lastBatteryLearnCycle" : "string",
      "nextBatteryLearnCycle" : "string",
      "batteryLearnCycleInterval" : 0
    },
    "id" : "string"
  } ],
  "fans" : [ {
    "fanRef" : "string",
    "status" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "id" : "string"
  } ],
  "hostBoards" : [ {
    "parentController" : "string",
    "partNumber" : "string",
    "serialNumber" : "string",
    "vendorName" : "string",
    "manufacturerDate" : "string",
    "fruType" : "string",
    "hostBoardId" : "string",
    "status" : "string",
    "type" : "string",
    "hostBoardRef" : "string",
    "numberOfPorts" : 0,
    "hbTypeData" : {
      "type" : "string",
      "dualPortIbTypeData" : {
        "tcaGuid" : "string",
        "queuePairsSupported" : 0,
        "completionQueuesSupported" : 0,
        "sharedReceiveQueuesSupported" : 0
      },
      "dualPortDenaliIbTypeData" : {
        "tcaGuid" : "string",
        "queuePairsSupported" : 0,
        "completionQueuesSupported" : 0,
        "sharedReceiveQueuesSupported" : 0
      }
    },
    "oemPartNumber" : "string",
    "hostBoardControllerSlot" : 0,
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "id" : "string"
  } ],
  "powerSupplies" : [ {
    "powerSupplyRef" : "string",
    "status" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "partNumber" : "string",
    "serialNumber" : "string",
    "vendorName" : "string",
    "manufacturerDate" : "string",
    "fruType" : "string",
    "reserved1" : "string",
    "reserved2" : "string",
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "firmwareRevision" : "string",
    "manufacturingDeviceCode" : 0,
    "id" : "string"
  } ],
  "nvsramVersion" : "string",
  "cacheMemoryDimms" : [ {
    "cacheMemoryDimmRef" : "string",
    "status" : "string",
    "capacityInMegabytes" : 0,
    "serialNumber" : "string",
    "partNumber" : "string",
    "oemPartNumber" : "string",
    "manufacturerPartNumber" : "string",
    "manufacturer" : "string",
    "manufactureDate" : "string",
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "shared" : true,
    "revisionCode" : "string"
  } ],
  "cacheBackupDevices" : [ {
    "backupDeviceRef" : "string",
    "backupDeviceControllerSlot" : 0,
    "parentController" : "string",
    "backupDeviceType" : "string",
    "backupDeviceStatus" : "string",
    "backupDeviceVpd" : {
      "manufacturer" : "string",
      "manufactureDate" : "string",
      "productId" : "string",
      "productRevLevel" : "string",
      "partNumber" : "string",
      "serialNumber" : "string"
    },
    "backupDeviceCapacity" : 0,
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "id" : "string"
  } ],
  "supportCRUs" : [ {
    "supportCRURef" : "string",
    "status" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "manufacturerDate" : "string",
    "vendorName" : "string",
    "vendorPN" : "string",
    "vendorSN" : "string",
    "fruType" : "string",
    "readyToRemove" : true,
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "configuredComponents" : [ "string" ],
    "type" : "string",
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "id" : "string"
  } ],
  "esms" : [ {
    "esmRef" : "string",
    "status" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "nonRedundantAccess" : true,
    "partNumber" : "string",
    "serialNumber" : "string",
    "manufacturerDate" : "string",
    "manufacturer" : "string",
    "fruType" : "string",
    "softwareVersion" : "string",
    "esmInterfaceData" : {
      "ioInterfaceType" : "string",
      "portList" : {
        "ports" : [ {
          "portStatus" : "string",
          "portType" : "string",
          "reserved1" : "string",
          "reserved2" : "string"
        } ]
      }
    },
    "productID" : "string",
    "workingChannel" : 0,
    "currentSpeed" : "string",
    "maxSpeed" : "string",
    "reserved1" : "string",
    "reserved2" : "string",
    "fibreEsm" : {
      "esmPortRef" : "string",
      "loopID" : 0,
      "portRef" : "string"
    },
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "esmInterfaceAttributes" : {
      "ioInterfaceType" : "string",
      "fibreEsmAttributes" : {
        "isSwitched" : true,
        "fibreEsmAddress" : {
          "esmPortRef" : "string",
          "loopID" : 0,
          "portRef" : "string"
        }
      },
      "sasEsmAttributes" : {
        "sasExpander" : [ "string" ]
      }
    },
    "boardId" : "string",
    "factoryDefaultsData" : {
      "isSupported" : true,
      "factoryDefaultsVersion" : "string"
    },
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "isTrunkCapable" : true,
    "trunkMiswire" : true,
    "locateInProgress" : true,
    "hasTrayIdentityIndicator" : true,
    "esmType" : "string",
    "id" : "string"
  } ],
  "sfps" : [ {
    "sfpRef" : "string",
    "status" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "sfpType" : {
      "sfpIdentType" : "string",
      "sfpConnectType" : "string",
      "sfpLinkLType" : "string",
      "sfpTransmitterType" : "string",
      "sfpSpeed" : [ "string" ],
      "sfpTransmissionMedia" : [ "string" ],
      "manufacturerDate" : "string",
      "vendorName" : "string",
      "vendorPN" : "string",
      "vendorRev" : "string",
      "vendorSN" : "string",
      "vendorOUI" : "string",
      "reserved1" : "string",
      "reserved2" : "string"
    },
    "sfpPort" : "string",
    "parentData" : {
      "sfpParentType" : "string",
      "controllerSFP" : {
        "controllerSFPType" : "string",
        "parentController" : "string",
        "channel" : 0,
        "reserved1" : "string",
        "reserved2" : "string"
      },
      "parentEsm" : "string",
      "parentMinihub" : "string"
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "sfpPortRef" : "string",
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "id" : "string"
  } ],
  "thermalSensors" : [ {
    "thermalSensorRef" : "string",
    "status" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "id" : "string"
  } ]
}

3.11.8. Get connectivity information for drive trays

GET /devmgr/v2/storage-systems/{system-id}/hardware-inventory/connections
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

EsmPortConnectionResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hardware-inventory/connections
Example HTTP response
Response 200
{
  "sasConnections" : [ {
    "tray" : {
      "type" : "string",
      "orientation" : "string",
      "numControllerSlots" : 0,
      "numDriveSlots" : 0,
      "trayId" : 0,
      "trayRef" : "string",
      "nonRedundantAccess" : true,
      "partNumber" : "string",
      "serialNumber" : "string",
      "vendorName" : "string",
      "manufacturerDate" : "string",
      "fruType" : "string",
      "trayIDMismatch" : true,
      "trayIDConflict" : true,
      "esmVersionMismatch" : true,
      "esmMiswire" : true,
      "drvMHSpeedMismatch" : true,
      "unsupportedTray" : true,
      "workingChannel" : 0,
      "maxSpeed" : "string",
      "trayTechnologyType" : "string",
      "esmGroupError" : true,
      "uncertifiedTray" : true,
      "locateTray" : true,
      "esmHardwareMismatch" : true,
      "hasConfigurableTrayId" : true,
      "frontEndInterfaceTechnology" : "string",
      "driveTechnologies" : [ "string" ],
      "numDriveCompartments" : 0,
      "numDriveSlotsPerCompartment" : 0,
      "trayAttributes" : [ {
        "attributeId" : "string",
        "attributeValue" : "string"
      } ],
      "isMisconfigured" : true,
      "esmFactoryDefaultsMismatch" : true,
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "numDrawers" : 0,
      "driveLayout" : {
        "driveOrientation" : "string",
        "numRows" : 0,
        "numColumns" : 0,
        "primaryTraversal" : "string",
        "secondaryTraversal" : "string"
      },
      "factoryDefaultsData" : {
        "factoryDefaultsVersion" : "string",
        "isSupported" : true
      },
      "locateInProgress" : true,
      "hasTrayIdentityIndicator" : true,
      "id" : "string"
    },
    "esm" : {
      "esmRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "nonRedundantAccess" : true,
      "partNumber" : "string",
      "serialNumber" : "string",
      "manufacturerDate" : "string",
      "manufacturer" : "string",
      "fruType" : "string",
      "softwareVersion" : "string",
      "esmInterfaceData" : {
        "ioInterfaceType" : "string",
        "portList" : {
          "ports" : [ {
            "portStatus" : "string",
            "portType" : "string",
            "reserved1" : "string",
            "reserved2" : "string"
          } ]
        }
      },
      "productID" : "string",
      "workingChannel" : 0,
      "currentSpeed" : "string",
      "maxSpeed" : "string",
      "reserved1" : "string",
      "reserved2" : "string",
      "fibreEsm" : {
        "esmPortRef" : "string",
        "loopID" : 0,
        "portRef" : "string"
      },
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "esmInterfaceAttributes" : {
        "ioInterfaceType" : "string",
        "fibreEsmAttributes" : {
          "isSwitched" : true,
          "fibreEsmAddress" : {
            "esmPortRef" : "string",
            "loopID" : 0,
            "portRef" : "string"
          }
        },
        "sasEsmAttributes" : {
          "sasExpander" : [ "string" ]
        }
      },
      "boardId" : "string",
      "factoryDefaultsData" : {
        "isSupported" : true,
        "factoryDefaultsVersion" : "string"
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "isTrunkCapable" : true,
      "trunkMiswire" : true,
      "locateInProgress" : true,
      "hasTrayIdentityIndicator" : true,
      "esmType" : "string",
      "id" : "string"
    },
    "sasExpander" : {
      "expanderRef" : "string",
      "parent" : {
        "expanderParentType" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentDrawer" : "string"
      },
      "channel" : 0,
      "deviceName" : "string",
      "vendorId" : "string",
      "productId" : "string",
      "fwVersion" : "string",
      "expanderPorts" : [ {
        "parent" : {
          "type" : "string",
          "controller" : "string",
          "drive" : "string",
          "expander" : "string",
          "hostBoardRef" : "string"
        },
        "attachedDevice" : {
          "channel" : 0,
          "channelType" : "string",
          "sasAttachedDeviceData" : {
            "type" : "string",
            "alternateController" : "string",
            "drive" : "string",
            "expander" : "string",
            "remoteHostPortAddress" : "string",
            "localController" : "string",
            "physicalLocation" : {
              "trayRef" : "string",
              "slot" : 0,
              "locationParent" : {
                "refType" : "string",
                "controllerRef" : "string",
                "symbolRef" : "string",
                "typedReference" : {
                  "componentType" : "string",
                  "symbolRef" : "string"
                }
              },
              "locationPosition" : 0,
              "label" : "string"
            }
          }
        },
        "state" : "string",
        "miswireType" : "string",
        "channelPortRef" : "string",
        "sasPhys" : [ {
          "phyIdentifier" : 0,
          "isOperational" : true
        } ],
        "portTypeData" : {
          "portType" : "string",
          "portIdentifier" : "string",
          "routingType" : "string"
        },
        "portMode" : "string",
        "domainNumber" : 0,
        "attachedChannelPortRef" : "string",
        "discoveryStatus" : 0
      } ],
      "domainNumber" : 0,
      "id" : "string"
    },
    "sasPort" : {
      "parent" : {
        "type" : "string",
        "controller" : "string",
        "drive" : "string",
        "expander" : "string",
        "hostBoardRef" : "string"
      },
      "attachedDevice" : {
        "channel" : 0,
        "channelType" : "string",
        "sasAttachedDeviceData" : {
          "type" : "string",
          "alternateController" : "string",
          "drive" : "string",
          "expander" : "string",
          "remoteHostPortAddress" : "string",
          "localController" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          }
        }
      },
      "state" : "string",
      "miswireType" : "string",
      "channelPortRef" : "string",
      "sasPhys" : [ {
        "phyIdentifier" : 0,
        "isOperational" : true
      } ],
      "portTypeData" : {
        "portType" : "string",
        "portIdentifier" : "string",
        "routingType" : "string"
      },
      "portMode" : "string",
      "domainNumber" : 0,
      "attachedChannelPortRef" : "string",
      "discoveryStatus" : 0
    },
    "channelPort" : {
      "portRef" : "string",
      "portParent" : {
        "type" : "string",
        "controllerRef" : "string",
        "esmRef" : "string",
        "minihubRef" : "string",
        "hicRef" : "string"
      },
      "portNumber" : 0,
      "channel" : 0,
      "channelType" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkActive" : true,
      "id" : "string"
    },
    "attachedSasExpander" : {
      "expanderRef" : "string",
      "parent" : {
        "expanderParentType" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentDrawer" : "string"
      },
      "channel" : 0,
      "deviceName" : "string",
      "vendorId" : "string",
      "productId" : "string",
      "fwVersion" : "string",
      "expanderPorts" : [ {
        "parent" : {
          "type" : "string",
          "controller" : "string",
          "drive" : "string",
          "expander" : "string",
          "hostBoardRef" : "string"
        },
        "attachedDevice" : {
          "channel" : 0,
          "channelType" : "string",
          "sasAttachedDeviceData" : {
            "type" : "string",
            "alternateController" : "string",
            "drive" : "string",
            "expander" : "string",
            "remoteHostPortAddress" : "string",
            "localController" : "string",
            "physicalLocation" : {
              "trayRef" : "string",
              "slot" : 0,
              "locationParent" : {
                "refType" : "string",
                "controllerRef" : "string",
                "symbolRef" : "string",
                "typedReference" : {
                  "componentType" : "string",
                  "symbolRef" : "string"
                }
              },
              "locationPosition" : 0,
              "label" : "string"
            }
          }
        },
        "state" : "string",
        "miswireType" : "string",
        "channelPortRef" : "string",
        "sasPhys" : [ {
          "phyIdentifier" : 0,
          "isOperational" : true
        } ],
        "portTypeData" : {
          "portType" : "string",
          "portIdentifier" : "string",
          "routingType" : "string"
        },
        "portMode" : "string",
        "domainNumber" : 0,
        "attachedChannelPortRef" : "string",
        "discoveryStatus" : 0
      } ],
      "domainNumber" : 0,
      "id" : "string"
    },
    "attachedChannelPort" : {
      "portRef" : "string",
      "portParent" : {
        "type" : "string",
        "controllerRef" : "string",
        "esmRef" : "string",
        "minihubRef" : "string",
        "hicRef" : "string"
      },
      "portNumber" : 0,
      "channel" : 0,
      "channelType" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkActive" : true,
      "id" : "string"
    },
    "attachedController" : {
      "active" : true,
      "quiesced" : true,
      "status" : "string",
      "controllerRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "manufacturer" : "string",
      "manufacturerDate" : "string",
      "appVersion" : "string",
      "bootVersion" : "string",
      "productID" : "string",
      "productRevLevel" : "string",
      "serialNumber" : "string",
      "boardID" : "string",
      "cacheMemorySize" : 0,
      "processorMemorySize" : 0,
      "hostInterfaces" : [ {
        "interfaceType" : "string",
        "fibre" : {
          "channel" : 0,
          "loopID" : 0,
          "speed" : 0,
          "hardAddress" : 0,
          "nodeName" : "string",
          "portName" : "string",
          "portId" : "string",
          "topology" : "string",
          "part" : "string",
          "revision" : 0,
          "chanMiswire" : true,
          "esmMiswire" : true,
          "linkStatus" : "string",
          "isDegraded" : true,
          "speedControl" : "string",
          "maxSpeed" : 0,
          "speedNegError" : true,
          "reserved1" : "string",
          "reserved2" : "string",
          "ddsChannelState" : 0,
          "ddsStateReason" : 0,
          "ddsStateWho" : 0,
          "isLocal" : true,
          "channelPorts" : [ {
            "speedDetError" : true,
            "manuallyBypassed" : true,
            "portNumber" : "string"
          } ],
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "isTrunkCapable" : true,
          "trunkMiswire" : true,
          "protectionInformationCapable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "ib" : {
          "interfaceRef" : "string",
          "channel" : 0,
          "channelPortRef" : "string",
          "localIdentifier" : 0,
          "globalIdentifier" : "string",
          "linkState" : "string",
          "portState" : "string",
          "maximumTransmissionUnit" : 0,
          "currentSpeed" : "string",
          "supportedSpeed" : [ "string" ],
          "currentLinkWidth" : "string",
          "supportedLinkWidth" : [ "string" ],
          "currentDataVirtualLanes" : 0,
          "maximumDataVirtualLanes" : 0,
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "isSRPSupported" : true,
          "isISERSupported" : true,
          "physPortState" : "string",
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "isNVMeSupported" : true,
          "id" : "string"
        },
        "iscsi" : {
          "channel" : 0,
          "channelPortRef" : "string",
          "tcpListenPort" : 0,
          "ipv4Enabled" : true,
          "ipv4Data" : {
            "ipv4Address" : "string",
            "ipv4AddressConfigMethod" : "string",
            "ipv4OutboundPacketPriority" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv4VlanId" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv4AddressData" : {
              "configState" : "string",
              "ipv4Address" : "string",
              "ipv4SubnetMask" : "string",
              "ipv4GatewayAddress" : "string"
            }
          },
          "interfaceData" : {
            "type" : "string",
            "ethernetData" : {
              "partData" : {
                "vendorName" : "string",
                "partNumber" : "string",
                "revisionNumber" : "string",
                "serialNumber" : "string"
              },
              "macAddress" : "string",
              "fullDuplex" : true,
              "maximumFramePayloadSize" : 0,
              "currentInterfaceSpeed" : "string",
              "maximumInterfaceSpeed" : "string",
              "linkStatus" : "string",
              "supportedInterfaceSpeeds" : [ "string" ],
              "autoconfigSupport" : true,
              "copperCableDiagnosticsSupport" : true
            },
            "infinibandData" : {
              "isIser" : true
            }
          },
          "interfaceRef" : "string",
          "ipv6Enabled" : true,
          "ipv6Data" : {
            "ipv6LocalAddresses" : [ {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            } ],
            "ipv6RoutableAddresses" : [ {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            } ],
            "ipv6PortRouterAddress" : {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            },
            "ipv6AddressConfigMethod" : "string",
            "ipv6OutboundPacketPriority" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv6VlanId" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv6HopLimit" : 0,
            "ipv6NdReachableTime" : 0,
            "ipv6NdRetransmitTime" : 0,
            "ipv6NdStaleTimeout" : 0,
            "ipv6DuplicateAddressDetectionAttempts" : 0
          },
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "isIPv6Capable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "sas" : {
          "channel" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "part" : "string",
          "revision" : 0,
          "isDegraded" : true,
          "iocPort" : {
            "parent" : {
              "type" : "string",
              "controller" : "string",
              "drive" : "string",
              "expander" : "string",
              "hostBoardRef" : "string"
            },
            "attachedDevice" : {
              "channel" : 0,
              "channelType" : "string",
              "sasAttachedDeviceData" : {
                "type" : "string",
                "alternateController" : "string",
                "drive" : "string",
                "expander" : "string",
                "remoteHostPortAddress" : "string",
                "localController" : "string",
                "physicalLocation" : {
                  "trayRef" : "string",
                  "slot" : 0,
                  "locationParent" : {
                    "refType" : "string",
                    "controllerRef" : "string",
                    "symbolRef" : "string",
                    "typedReference" : {
                      "componentType" : "string",
                      "symbolRef" : "string"
                    }
                  },
                  "locationPosition" : 0,
                  "label" : "string"
                }
              }
            },
            "state" : "string",
            "miswireType" : "string",
            "channelPortRef" : "string",
            "sasPhys" : [ {
              "phyIdentifier" : 0,
              "isOperational" : true
            } ],
            "portTypeData" : {
              "portType" : "string",
              "portIdentifier" : "string",
              "routingType" : "string"
            },
            "portMode" : "string",
            "domainNumber" : 0,
            "attachedChannelPortRef" : "string",
            "discoveryStatus" : 0
          },
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "sata" : {
          "channel" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "speedControl" : "string",
          "part" : "string",
          "revision" : 0,
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "id" : "string"
        },
        "scsi" : {
          "channel" : 0,
          "scsiID" : 0,
          "speed" : 0,
          "scsiType" : "string",
          "width" : 0,
          "part" : "string",
          "revision" : 0,
          "reserved1" : "string",
          "reserved2" : "string"
        }
      } ],
      "driveInterfaces" : [ {
        "interfaceType" : "string",
        "fibre" : {
          "channel" : 0,
          "loopID" : 0,
          "speed" : 0,
          "hardAddress" : 0,
          "nodeName" : "string",
          "portName" : "string",
          "portId" : "string",
          "topology" : "string",
          "part" : "string",
          "revision" : 0,
          "chanMiswire" : true,
          "esmMiswire" : true,
          "linkStatus" : "string",
          "isDegraded" : true,
          "speedControl" : "string",
          "maxSpeed" : 0,
          "speedNegError" : true,
          "reserved1" : "string",
          "reserved2" : "string",
          "ddsChannelState" : 0,
          "ddsStateReason" : 0,
          "ddsStateWho" : 0,
          "isLocal" : true,
          "channelPorts" : [ {
            "speedDetError" : true,
            "manuallyBypassed" : true,
            "portNumber" : "string"
          } ],
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "isTrunkCapable" : true,
          "trunkMiswire" : true,
          "protectionInformationCapable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "ib" : {
          "interfaceRef" : "string",
          "channel" : 0,
          "channelPortRef" : "string",
          "localIdentifier" : 0,
          "globalIdentifier" : "string",
          "linkState" : "string",
          "portState" : "string",
          "maximumTransmissionUnit" : 0,
          "currentSpeed" : "string",
          "supportedSpeed" : [ "string" ],
          "currentLinkWidth" : "string",
          "supportedLinkWidth" : [ "string" ],
          "currentDataVirtualLanes" : 0,
          "maximumDataVirtualLanes" : 0,
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "isSRPSupported" : true,
          "isISERSupported" : true,
          "physPortState" : "string",
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "isNVMeSupported" : true,
          "id" : "string"
        },
        "iscsi" : {
          "channel" : 0,
          "channelPortRef" : "string",
          "tcpListenPort" : 0,
          "ipv4Enabled" : true,
          "ipv4Data" : {
            "ipv4Address" : "string",
            "ipv4AddressConfigMethod" : "string",
            "ipv4OutboundPacketPriority" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv4VlanId" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv4AddressData" : {
              "configState" : "string",
              "ipv4Address" : "string",
              "ipv4SubnetMask" : "string",
              "ipv4GatewayAddress" : "string"
            }
          },
          "interfaceData" : {
            "type" : "string",
            "ethernetData" : {
              "partData" : {
                "vendorName" : "string",
                "partNumber" : "string",
                "revisionNumber" : "string",
                "serialNumber" : "string"
              },
              "macAddress" : "string",
              "fullDuplex" : true,
              "maximumFramePayloadSize" : 0,
              "currentInterfaceSpeed" : "string",
              "maximumInterfaceSpeed" : "string",
              "linkStatus" : "string",
              "supportedInterfaceSpeeds" : [ "string" ],
              "autoconfigSupport" : true,
              "copperCableDiagnosticsSupport" : true
            },
            "infinibandData" : {
              "isIser" : true
            }
          },
          "interfaceRef" : "string",
          "ipv6Enabled" : true,
          "ipv6Data" : {
            "ipv6LocalAddresses" : [ {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            } ],
            "ipv6RoutableAddresses" : [ {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            } ],
            "ipv6PortRouterAddress" : {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            },
            "ipv6AddressConfigMethod" : "string",
            "ipv6OutboundPacketPriority" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv6VlanId" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv6HopLimit" : 0,
            "ipv6NdReachableTime" : 0,
            "ipv6NdRetransmitTime" : 0,
            "ipv6NdStaleTimeout" : 0,
            "ipv6DuplicateAddressDetectionAttempts" : 0
          },
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "isIPv6Capable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "sas" : {
          "channel" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "part" : "string",
          "revision" : 0,
          "isDegraded" : true,
          "iocPort" : {
            "parent" : {
              "type" : "string",
              "controller" : "string",
              "drive" : "string",
              "expander" : "string",
              "hostBoardRef" : "string"
            },
            "attachedDevice" : {
              "channel" : 0,
              "channelType" : "string",
              "sasAttachedDeviceData" : {
                "type" : "string",
                "alternateController" : "string",
                "drive" : "string",
                "expander" : "string",
                "remoteHostPortAddress" : "string",
                "localController" : "string",
                "physicalLocation" : {
                  "trayRef" : "string",
                  "slot" : 0,
                  "locationParent" : {
                    "refType" : "string",
                    "controllerRef" : "string",
                    "symbolRef" : "string",
                    "typedReference" : {
                      "componentType" : "string",
                      "symbolRef" : "string"
                    }
                  },
                  "locationPosition" : 0,
                  "label" : "string"
                }
              }
            },
            "state" : "string",
            "miswireType" : "string",
            "channelPortRef" : "string",
            "sasPhys" : [ {
              "phyIdentifier" : 0,
              "isOperational" : true
            } ],
            "portTypeData" : {
              "portType" : "string",
              "portIdentifier" : "string",
              "routingType" : "string"
            },
            "portMode" : "string",
            "domainNumber" : 0,
            "attachedChannelPortRef" : "string",
            "discoveryStatus" : 0
          },
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "sata" : {
          "channel" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "speedControl" : "string",
          "part" : "string",
          "revision" : 0,
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "id" : "string"
        },
        "scsi" : {
          "channel" : 0,
          "scsiID" : 0,
          "speed" : 0,
          "scsiType" : "string",
          "width" : 0,
          "part" : "string",
          "revision" : 0,
          "reserved1" : "string",
          "reserved2" : "string"
        }
      } ],
      "netInterfaces" : [ {
        "interfaceType" : "string",
        "ethernet" : {
          "interfaceName" : "string",
          "channel" : 0,
          "speed" : 0,
          "ip" : 0,
          "alias" : "string",
          "macAddr" : "string",
          "gatewayIp" : 0,
          "subnetMask" : 0,
          "bootpUsed" : true,
          "rloginEnabled" : true,
          "reserved1" : "string",
          "setupError" : true,
          "reserved2" : "string",
          "interfaceRef" : "string",
          "linkStatus" : "string",
          "ipv4Enabled" : true,
          "ipv4Address" : "string",
          "ipv4SubnetMask" : "string",
          "ipv4AddressConfigMethod" : "string",
          "ipv6Enabled" : true,
          "ipv6LocalAddress" : {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          },
          "ipv6PortStaticRoutableAddress" : {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          },
          "ipv6PortRoutableAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6AddressConfigMethod" : "string",
          "fullDuplex" : true,
          "supportedSpeedSettings" : [ "string" ],
          "configuredSpeedSetting" : "string",
          "currentSpeed" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          }
        }
      } ],
      "inventory" : [ {
        "itemName" : "string",
        "itemVersion" : "string"
      } ],
      "reserved1" : "string",
      "reserved2" : "string",
      "hostBoardID" : "string",
      "physicalCacheMemorySize" : 0,
      "readyToRemove" : true,
      "boardSubmodelID" : "string",
      "submodelSupported" : true,
      "oemPartNumber" : "string",
      "partNumber" : "string",
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "bootTime" : "string",
      "modelName" : "string",
      "networkSettings" : {
        "ipv4DefaultRouterAddress" : "string",
        "ipv6DefaultRouterAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6CandidateDefaultRouterAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "remoteAccessEnabled" : true,
        "dnsProperties" : {
          "acquisitionProperties" : {
            "dnsAcquisitionType" : "string",
            "dnsServers" : [ {
              "addressType" : "string",
              "ipv4Address" : "string",
              "ipv6Address" : "string"
            } ]
          },
          "dhcpAcquiredDnsServers" : [ {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          } ]
        },
        "ntpProperties" : {
          "acquisitionProperties" : {
            "ntpAcquisitionType" : "string",
            "ntpServers" : [ {
              "addrType" : "string",
              "domainName" : "string",
              "ipvxAddress" : {
                "addressType" : "string",
                "ipv4Address" : "string",
                "ipv6Address" : "string"
              }
            } ]
          },
          "dhcpAcquiredNtpServers" : [ {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          } ]
        }
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "flashCacheMemorySize" : 0,
      "ctrlIocDumpData" : {
        "iocDumpNeedsRetrieved" : true,
        "iocDumpTag" : 0,
        "timeStamp" : "string"
      },
      "locateInProgress" : true,
      "hasTrayIdentityIndicator" : true,
      "controllerErrorMode" : "string",
      "codeVersions" : [ {
        "codeModule" : "string",
        "versionString" : "string"
      } ],
      "id" : "string"
    },
    "type" : "string"
  } ],
  "fibreConnections" : [ {
    "tray" : {
      "type" : "string",
      "orientation" : "string",
      "numControllerSlots" : 0,
      "numDriveSlots" : 0,
      "trayId" : 0,
      "trayRef" : "string",
      "nonRedundantAccess" : true,
      "partNumber" : "string",
      "serialNumber" : "string",
      "vendorName" : "string",
      "manufacturerDate" : "string",
      "fruType" : "string",
      "trayIDMismatch" : true,
      "trayIDConflict" : true,
      "esmVersionMismatch" : true,
      "esmMiswire" : true,
      "drvMHSpeedMismatch" : true,
      "unsupportedTray" : true,
      "workingChannel" : 0,
      "maxSpeed" : "string",
      "trayTechnologyType" : "string",
      "esmGroupError" : true,
      "uncertifiedTray" : true,
      "locateTray" : true,
      "esmHardwareMismatch" : true,
      "hasConfigurableTrayId" : true,
      "frontEndInterfaceTechnology" : "string",
      "driveTechnologies" : [ "string" ],
      "numDriveCompartments" : 0,
      "numDriveSlotsPerCompartment" : 0,
      "trayAttributes" : [ {
        "attributeId" : "string",
        "attributeValue" : "string"
      } ],
      "isMisconfigured" : true,
      "esmFactoryDefaultsMismatch" : true,
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "numDrawers" : 0,
      "driveLayout" : {
        "driveOrientation" : "string",
        "numRows" : 0,
        "numColumns" : 0,
        "primaryTraversal" : "string",
        "secondaryTraversal" : "string"
      },
      "factoryDefaultsData" : {
        "factoryDefaultsVersion" : "string",
        "isSupported" : true
      },
      "locateInProgress" : true,
      "hasTrayIdentityIndicator" : true,
      "id" : "string"
    },
    "esm" : {
      "esmRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "nonRedundantAccess" : true,
      "partNumber" : "string",
      "serialNumber" : "string",
      "manufacturerDate" : "string",
      "manufacturer" : "string",
      "fruType" : "string",
      "softwareVersion" : "string",
      "esmInterfaceData" : {
        "ioInterfaceType" : "string",
        "portList" : {
          "ports" : [ {
            "portStatus" : "string",
            "portType" : "string",
            "reserved1" : "string",
            "reserved2" : "string"
          } ]
        }
      },
      "productID" : "string",
      "workingChannel" : 0,
      "currentSpeed" : "string",
      "maxSpeed" : "string",
      "reserved1" : "string",
      "reserved2" : "string",
      "fibreEsm" : {
        "esmPortRef" : "string",
        "loopID" : 0,
        "portRef" : "string"
      },
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "esmInterfaceAttributes" : {
        "ioInterfaceType" : "string",
        "fibreEsmAttributes" : {
          "isSwitched" : true,
          "fibreEsmAddress" : {
            "esmPortRef" : "string",
            "loopID" : 0,
            "portRef" : "string"
          }
        },
        "sasEsmAttributes" : {
          "sasExpander" : [ "string" ]
        }
      },
      "boardId" : "string",
      "factoryDefaultsData" : {
        "isSupported" : true,
        "factoryDefaultsVersion" : "string"
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "isTrunkCapable" : true,
      "trunkMiswire" : true,
      "locateInProgress" : true,
      "hasTrayIdentityIndicator" : true,
      "esmType" : "string",
      "id" : "string"
    },
    "channelPort" : {
      "portRef" : "string",
      "portParent" : {
        "type" : "string",
        "controllerRef" : "string",
        "esmRef" : "string",
        "minihubRef" : "string",
        "hicRef" : "string"
      },
      "portNumber" : 0,
      "channel" : 0,
      "channelType" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkActive" : true,
      "id" : "string"
    },
    "attachedController" : {
      "active" : true,
      "quiesced" : true,
      "status" : "string",
      "controllerRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "manufacturer" : "string",
      "manufacturerDate" : "string",
      "appVersion" : "string",
      "bootVersion" : "string",
      "productID" : "string",
      "productRevLevel" : "string",
      "serialNumber" : "string",
      "boardID" : "string",
      "cacheMemorySize" : 0,
      "processorMemorySize" : 0,
      "hostInterfaces" : [ {
        "interfaceType" : "string",
        "fibre" : {
          "channel" : 0,
          "loopID" : 0,
          "speed" : 0,
          "hardAddress" : 0,
          "nodeName" : "string",
          "portName" : "string",
          "portId" : "string",
          "topology" : "string",
          "part" : "string",
          "revision" : 0,
          "chanMiswire" : true,
          "esmMiswire" : true,
          "linkStatus" : "string",
          "isDegraded" : true,
          "speedControl" : "string",
          "maxSpeed" : 0,
          "speedNegError" : true,
          "reserved1" : "string",
          "reserved2" : "string",
          "ddsChannelState" : 0,
          "ddsStateReason" : 0,
          "ddsStateWho" : 0,
          "isLocal" : true,
          "channelPorts" : [ {
            "speedDetError" : true,
            "manuallyBypassed" : true,
            "portNumber" : "string"
          } ],
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "isTrunkCapable" : true,
          "trunkMiswire" : true,
          "protectionInformationCapable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "ib" : {
          "interfaceRef" : "string",
          "channel" : 0,
          "channelPortRef" : "string",
          "localIdentifier" : 0,
          "globalIdentifier" : "string",
          "linkState" : "string",
          "portState" : "string",
          "maximumTransmissionUnit" : 0,
          "currentSpeed" : "string",
          "supportedSpeed" : [ "string" ],
          "currentLinkWidth" : "string",
          "supportedLinkWidth" : [ "string" ],
          "currentDataVirtualLanes" : 0,
          "maximumDataVirtualLanes" : 0,
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "isSRPSupported" : true,
          "isISERSupported" : true,
          "physPortState" : "string",
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "isNVMeSupported" : true,
          "id" : "string"
        },
        "iscsi" : {
          "channel" : 0,
          "channelPortRef" : "string",
          "tcpListenPort" : 0,
          "ipv4Enabled" : true,
          "ipv4Data" : {
            "ipv4Address" : "string",
            "ipv4AddressConfigMethod" : "string",
            "ipv4OutboundPacketPriority" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv4VlanId" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv4AddressData" : {
              "configState" : "string",
              "ipv4Address" : "string",
              "ipv4SubnetMask" : "string",
              "ipv4GatewayAddress" : "string"
            }
          },
          "interfaceData" : {
            "type" : "string",
            "ethernetData" : {
              "partData" : {
                "vendorName" : "string",
                "partNumber" : "string",
                "revisionNumber" : "string",
                "serialNumber" : "string"
              },
              "macAddress" : "string",
              "fullDuplex" : true,
              "maximumFramePayloadSize" : 0,
              "currentInterfaceSpeed" : "string",
              "maximumInterfaceSpeed" : "string",
              "linkStatus" : "string",
              "supportedInterfaceSpeeds" : [ "string" ],
              "autoconfigSupport" : true,
              "copperCableDiagnosticsSupport" : true
            },
            "infinibandData" : {
              "isIser" : true
            }
          },
          "interfaceRef" : "string",
          "ipv6Enabled" : true,
          "ipv6Data" : {
            "ipv6LocalAddresses" : [ {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            } ],
            "ipv6RoutableAddresses" : [ {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            } ],
            "ipv6PortRouterAddress" : {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            },
            "ipv6AddressConfigMethod" : "string",
            "ipv6OutboundPacketPriority" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv6VlanId" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv6HopLimit" : 0,
            "ipv6NdReachableTime" : 0,
            "ipv6NdRetransmitTime" : 0,
            "ipv6NdStaleTimeout" : 0,
            "ipv6DuplicateAddressDetectionAttempts" : 0
          },
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "isIPv6Capable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "sas" : {
          "channel" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "part" : "string",
          "revision" : 0,
          "isDegraded" : true,
          "iocPort" : {
            "parent" : {
              "type" : "string",
              "controller" : "string",
              "drive" : "string",
              "expander" : "string",
              "hostBoardRef" : "string"
            },
            "attachedDevice" : {
              "channel" : 0,
              "channelType" : "string",
              "sasAttachedDeviceData" : {
                "type" : "string",
                "alternateController" : "string",
                "drive" : "string",
                "expander" : "string",
                "remoteHostPortAddress" : "string",
                "localController" : "string",
                "physicalLocation" : {
                  "trayRef" : "string",
                  "slot" : 0,
                  "locationParent" : {
                    "refType" : "string",
                    "controllerRef" : "string",
                    "symbolRef" : "string",
                    "typedReference" : {
                      "componentType" : "string",
                      "symbolRef" : "string"
                    }
                  },
                  "locationPosition" : 0,
                  "label" : "string"
                }
              }
            },
            "state" : "string",
            "miswireType" : "string",
            "channelPortRef" : "string",
            "sasPhys" : [ {
              "phyIdentifier" : 0,
              "isOperational" : true
            } ],
            "portTypeData" : {
              "portType" : "string",
              "portIdentifier" : "string",
              "routingType" : "string"
            },
            "portMode" : "string",
            "domainNumber" : 0,
            "attachedChannelPortRef" : "string",
            "discoveryStatus" : 0
          },
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "sata" : {
          "channel" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "speedControl" : "string",
          "part" : "string",
          "revision" : 0,
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "id" : "string"
        },
        "scsi" : {
          "channel" : 0,
          "scsiID" : 0,
          "speed" : 0,
          "scsiType" : "string",
          "width" : 0,
          "part" : "string",
          "revision" : 0,
          "reserved1" : "string",
          "reserved2" : "string"
        }
      } ],
      "driveInterfaces" : [ {
        "interfaceType" : "string",
        "fibre" : {
          "channel" : 0,
          "loopID" : 0,
          "speed" : 0,
          "hardAddress" : 0,
          "nodeName" : "string",
          "portName" : "string",
          "portId" : "string",
          "topology" : "string",
          "part" : "string",
          "revision" : 0,
          "chanMiswire" : true,
          "esmMiswire" : true,
          "linkStatus" : "string",
          "isDegraded" : true,
          "speedControl" : "string",
          "maxSpeed" : 0,
          "speedNegError" : true,
          "reserved1" : "string",
          "reserved2" : "string",
          "ddsChannelState" : 0,
          "ddsStateReason" : 0,
          "ddsStateWho" : 0,
          "isLocal" : true,
          "channelPorts" : [ {
            "speedDetError" : true,
            "manuallyBypassed" : true,
            "portNumber" : "string"
          } ],
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "isTrunkCapable" : true,
          "trunkMiswire" : true,
          "protectionInformationCapable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "ib" : {
          "interfaceRef" : "string",
          "channel" : 0,
          "channelPortRef" : "string",
          "localIdentifier" : 0,
          "globalIdentifier" : "string",
          "linkState" : "string",
          "portState" : "string",
          "maximumTransmissionUnit" : 0,
          "currentSpeed" : "string",
          "supportedSpeed" : [ "string" ],
          "currentLinkWidth" : "string",
          "supportedLinkWidth" : [ "string" ],
          "currentDataVirtualLanes" : 0,
          "maximumDataVirtualLanes" : 0,
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "isSRPSupported" : true,
          "isISERSupported" : true,
          "physPortState" : "string",
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "isNVMeSupported" : true,
          "id" : "string"
        },
        "iscsi" : {
          "channel" : 0,
          "channelPortRef" : "string",
          "tcpListenPort" : 0,
          "ipv4Enabled" : true,
          "ipv4Data" : {
            "ipv4Address" : "string",
            "ipv4AddressConfigMethod" : "string",
            "ipv4OutboundPacketPriority" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv4VlanId" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv4AddressData" : {
              "configState" : "string",
              "ipv4Address" : "string",
              "ipv4SubnetMask" : "string",
              "ipv4GatewayAddress" : "string"
            }
          },
          "interfaceData" : {
            "type" : "string",
            "ethernetData" : {
              "partData" : {
                "vendorName" : "string",
                "partNumber" : "string",
                "revisionNumber" : "string",
                "serialNumber" : "string"
              },
              "macAddress" : "string",
              "fullDuplex" : true,
              "maximumFramePayloadSize" : 0,
              "currentInterfaceSpeed" : "string",
              "maximumInterfaceSpeed" : "string",
              "linkStatus" : "string",
              "supportedInterfaceSpeeds" : [ "string" ],
              "autoconfigSupport" : true,
              "copperCableDiagnosticsSupport" : true
            },
            "infinibandData" : {
              "isIser" : true
            }
          },
          "interfaceRef" : "string",
          "ipv6Enabled" : true,
          "ipv6Data" : {
            "ipv6LocalAddresses" : [ {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            } ],
            "ipv6RoutableAddresses" : [ {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            } ],
            "ipv6PortRouterAddress" : {
              "address" : "string",
              "addressState" : {
                "addressType" : "string",
                "interfaceAddressState" : "string",
                "routerAddressState" : "string"
              }
            },
            "ipv6AddressConfigMethod" : "string",
            "ipv6OutboundPacketPriority" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv6VlanId" : {
              "isEnabled" : true,
              "value" : 0
            },
            "ipv6HopLimit" : 0,
            "ipv6NdReachableTime" : 0,
            "ipv6NdRetransmitTime" : 0,
            "ipv6NdStaleTimeout" : 0,
            "ipv6DuplicateAddressDetectionAttempts" : 0
          },
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "isIPv6Capable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "sas" : {
          "channel" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "part" : "string",
          "revision" : 0,
          "isDegraded" : true,
          "iocPort" : {
            "parent" : {
              "type" : "string",
              "controller" : "string",
              "drive" : "string",
              "expander" : "string",
              "hostBoardRef" : "string"
            },
            "attachedDevice" : {
              "channel" : 0,
              "channelType" : "string",
              "sasAttachedDeviceData" : {
                "type" : "string",
                "alternateController" : "string",
                "drive" : "string",
                "expander" : "string",
                "remoteHostPortAddress" : "string",
                "localController" : "string",
                "physicalLocation" : {
                  "trayRef" : "string",
                  "slot" : 0,
                  "locationParent" : {
                    "refType" : "string",
                    "controllerRef" : "string",
                    "symbolRef" : "string",
                    "typedReference" : {
                      "componentType" : "string",
                      "symbolRef" : "string"
                    }
                  },
                  "locationPosition" : 0,
                  "label" : "string"
                }
              }
            },
            "state" : "string",
            "miswireType" : "string",
            "channelPortRef" : "string",
            "sasPhys" : [ {
              "phyIdentifier" : 0,
              "isOperational" : true
            } ],
            "portTypeData" : {
              "portType" : "string",
              "portIdentifier" : "string",
              "routingType" : "string"
            },
            "portMode" : "string",
            "domainNumber" : 0,
            "attachedChannelPortRef" : "string",
            "discoveryStatus" : 0
          },
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "oneWayMaxRate" : "string",
          "bidirectionalMaxRate" : "string",
          "id" : "string"
        },
        "sata" : {
          "channel" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "speedControl" : "string",
          "part" : "string",
          "revision" : 0,
          "interfaceRef" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          },
          "protectionInformationCapable" : true,
          "id" : "string"
        },
        "scsi" : {
          "channel" : 0,
          "scsiID" : 0,
          "speed" : 0,
          "scsiType" : "string",
          "width" : 0,
          "part" : "string",
          "revision" : 0,
          "reserved1" : "string",
          "reserved2" : "string"
        }
      } ],
      "netInterfaces" : [ {
        "interfaceType" : "string",
        "ethernet" : {
          "interfaceName" : "string",
          "channel" : 0,
          "speed" : 0,
          "ip" : 0,
          "alias" : "string",
          "macAddr" : "string",
          "gatewayIp" : 0,
          "subnetMask" : 0,
          "bootpUsed" : true,
          "rloginEnabled" : true,
          "reserved1" : "string",
          "setupError" : true,
          "reserved2" : "string",
          "interfaceRef" : "string",
          "linkStatus" : "string",
          "ipv4Enabled" : true,
          "ipv4Address" : "string",
          "ipv4SubnetMask" : "string",
          "ipv4AddressConfigMethod" : "string",
          "ipv6Enabled" : true,
          "ipv6LocalAddress" : {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          },
          "ipv6PortStaticRoutableAddress" : {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          },
          "ipv6PortRoutableAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6AddressConfigMethod" : "string",
          "fullDuplex" : true,
          "supportedSpeedSettings" : [ "string" ],
          "configuredSpeedSetting" : "string",
          "currentSpeed" : "string",
          "physicalLocation" : {
            "trayRef" : "string",
            "slot" : 0,
            "locationParent" : {
              "refType" : "string",
              "controllerRef" : "string",
              "symbolRef" : "string",
              "typedReference" : {
                "componentType" : "string",
                "symbolRef" : "string"
              }
            },
            "locationPosition" : 0,
            "label" : "string"
          }
        }
      } ],
      "inventory" : [ {
        "itemName" : "string",
        "itemVersion" : "string"
      } ],
      "reserved1" : "string",
      "reserved2" : "string",
      "hostBoardID" : "string",
      "physicalCacheMemorySize" : 0,
      "readyToRemove" : true,
      "boardSubmodelID" : "string",
      "submodelSupported" : true,
      "oemPartNumber" : "string",
      "partNumber" : "string",
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "bootTime" : "string",
      "modelName" : "string",
      "networkSettings" : {
        "ipv4DefaultRouterAddress" : "string",
        "ipv6DefaultRouterAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6CandidateDefaultRouterAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "remoteAccessEnabled" : true,
        "dnsProperties" : {
          "acquisitionProperties" : {
            "dnsAcquisitionType" : "string",
            "dnsServers" : [ {
              "addressType" : "string",
              "ipv4Address" : "string",
              "ipv6Address" : "string"
            } ]
          },
          "dhcpAcquiredDnsServers" : [ {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          } ]
        },
        "ntpProperties" : {
          "acquisitionProperties" : {
            "ntpAcquisitionType" : "string",
            "ntpServers" : [ {
              "addrType" : "string",
              "domainName" : "string",
              "ipvxAddress" : {
                "addressType" : "string",
                "ipv4Address" : "string",
                "ipv6Address" : "string"
              }
            } ]
          },
          "dhcpAcquiredNtpServers" : [ {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          } ]
        }
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "flashCacheMemorySize" : 0,
      "ctrlIocDumpData" : {
        "iocDumpNeedsRetrieved" : true,
        "iocDumpTag" : 0,
        "timeStamp" : "string"
      },
      "locateInProgress" : true,
      "hasTrayIdentityIndicator" : true,
      "controllerErrorMode" : "string",
      "codeVersions" : [ {
        "codeModule" : "string",
        "versionString" : "string"
      } ],
      "id" : "string"
    },
    "type" : "string"
  } ]
}

3.11.9. Start hardware identification

POST /devmgr/v2/storage-systems/{system-id}/identify
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

IdentificationRequest

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/identify
Request body
{
  "channels" : [ 0 ],
  "trays" : [ "string" ],
  "drives" : [ "string" ],
  "pools" : [ "string" ],
  "volumes" : [ "string" ],
  "storageSystem" : true
}

3.11.10. Cancel any active hardware identification

DELETE /devmgr/v2/storage-systems/{system-id}/identify
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

204

Cancel successful

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/identify

3.11.11. Get the iSCSI Target

GET /devmgr/v2/storage-systems/{system-id}/iscsi/target-settings
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

Target

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/iscsi/target-settings
Example HTTP response
Response 200
{
  "targetRef" : "string",
  "nodeName" : {
    "ioInterfaceType" : "string",
    "iscsiNodeName" : "string",
    "remoteNodeWWN" : "string",
    "nvmeNodeName" : "string"
  },
  "alias" : {
    "ioInterfaceType" : "string",
    "iscsiAlias" : "string"
  },
  "configuredAuthMethods" : {
    "authMethodData" : [ {
      "authMethod" : "string",
      "chapSecret" : [ {
        "type" : "string",
        "pkcs5Data" : {
          "iterations" : 0,
          "salt" : "string",
          "cipherText" : "string"
        },
        "pkcs5AesData" : {
          "iterations" : 0,
          "salt" : "string",
          "cipherText" : "string"
        }
      } ]
    } ]
  },
  "portals" : [ {
    "groupTag" : 0,
    "ipAddress" : {
      "addressType" : "string",
      "ipv4Address" : "string",
      "ipv6Address" : "string"
    },
    "tcpListenPort" : 0
  } ]
}

3.11.12. Update the iSCSI Target

POST /devmgr/v2/storage-systems/{system-id}/iscsi/target-settings
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

IscsiTargetUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

IscsiTargetResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/iscsi/target-settings
Request body
{
  "alias" : "string",
  "enableChapAuthentication" : true,
  "chapSecret" : "string"
}
Example HTTP response
Response 200
{
  "authMethod" : "string",
  "chapSecret" : "string",
  "iqn" : "string",
  "alias" : "string"
}

3.11.13. Get the iSCSI Entity data

GET /devmgr/v2/storage-systems/{system-id}/iscsi/entity
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

IscsiEntityResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/iscsi/entity
Example HTTP response
Response 200
{
  "icmpPingResponseEnabled" : true,
  "unnamedDiscoverySessionsEnabled" : true,
  "isnsServerTcpListenPort" : 0,
  "ipv4IsnsServerAddress" : "string",
  "ipv6IsnsServerAddress" : "string",
  "isnsServerRegistrationEnabled" : true,
  "hostPortsConfiguredDHCP" : true,
  "ipv4IsnsServerAddressConfigMethod" : "string",
  "ipv6IsnsServerAddressConfigMethod" : "string",
  "isnsRegistrationState" : "string"
}

3.11.14. Update iSCSI Entity data

POST /devmgr/v2/storage-systems/{system-id}/iscsi/entity
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

IscsiEntityUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

IscsiEntityResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/iscsi/entity
Request body
{
  "icmpPingResponseEnabled" : true,
  "unnamedDiscoverySessionsEnabled" : true,
  "isnsServerTcpListenPort" : 0,
  "ipv4IsnsServerAddressConfigMethod" : "string",
  "ipv4IsnsServerAddress" : "string",
  "ipv6IsnsServerAddress" : "string",
  "isnsServerRegistrationEnabled" : true
}
Example HTTP response
Response 200
{
  "icmpPingResponseEnabled" : true,
  "unnamedDiscoverySessionsEnabled" : true,
  "isnsServerTcpListenPort" : 0,
  "ipv4IsnsServerAddress" : "string",
  "ipv6IsnsServerAddress" : "string",
  "isnsServerRegistrationEnabled" : true,
  "hostPortsConfiguredDHCP" : true,
  "ipv4IsnsServerAddressConfigMethod" : "string",
  "ipv6IsnsServerAddressConfigMethod" : "string",
  "isnsRegistrationState" : "string"
}

3.11.15. Get NVMeoF entity

GET /devmgr/v2/storage-systems/{system-id}/nvmeof/entity
Description

Mode: Both Embedded and Proxy.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< IoInterface > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/nvmeof/entity
Example HTTP response
Response 200
{
  "interfaceRef" : "string",
  "channelType" : "string",
  "ioInterfaceTypeData" : {
    "interfaceType" : "string",
    "fibre" : {
      "channel" : 0,
      "loopID" : 0,
      "speed" : 0,
      "hardAddress" : 0,
      "nodeName" : "string",
      "portName" : "string",
      "portId" : "string",
      "topology" : "string",
      "part" : "string",
      "revision" : 0,
      "chanMiswire" : true,
      "esmMiswire" : true,
      "linkStatus" : "string",
      "isDegraded" : true,
      "speedControl" : "string",
      "maxSpeed" : 0,
      "speedNegError" : true,
      "reserved1" : "string",
      "reserved2" : "string",
      "ddsChannelState" : 0,
      "ddsStateReason" : 0,
      "ddsStateWho" : 0,
      "isLocal" : true,
      "channelPorts" : [ {
        "speedDetError" : true,
        "manuallyBypassed" : true,
        "portNumber" : "string"
      } ],
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkCapable" : true,
      "trunkMiswire" : true,
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "ib" : {
      "interfaceRef" : "string",
      "channel" : 0,
      "channelPortRef" : "string",
      "localIdentifier" : 0,
      "globalIdentifier" : "string",
      "linkState" : "string",
      "portState" : "string",
      "maximumTransmissionUnit" : 0,
      "currentSpeed" : "string",
      "supportedSpeed" : [ "string" ],
      "currentLinkWidth" : "string",
      "supportedLinkWidth" : [ "string" ],
      "currentDataVirtualLanes" : 0,
      "maximumDataVirtualLanes" : 0,
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isSRPSupported" : true,
      "isISERSupported" : true,
      "physPortState" : "string",
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "isNVMeSupported" : true,
      "id" : "string"
    },
    "iscsi" : {
      "channel" : 0,
      "channelPortRef" : "string",
      "tcpListenPort" : 0,
      "ipv4Enabled" : true,
      "ipv4Data" : {
        "ipv4Address" : "string",
        "ipv4AddressConfigMethod" : "string",
        "ipv4OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4AddressData" : {
          "configState" : "string",
          "ipv4Address" : "string",
          "ipv4SubnetMask" : "string",
          "ipv4GatewayAddress" : "string"
        }
      },
      "interfaceData" : {
        "type" : "string",
        "ethernetData" : {
          "partData" : {
            "vendorName" : "string",
            "partNumber" : "string",
            "revisionNumber" : "string",
            "serialNumber" : "string"
          },
          "macAddress" : "string",
          "fullDuplex" : true,
          "maximumFramePayloadSize" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "linkStatus" : "string",
          "supportedInterfaceSpeeds" : [ "string" ],
          "autoconfigSupport" : true,
          "copperCableDiagnosticsSupport" : true
        },
        "infinibandData" : {
          "isIser" : true
        }
      },
      "interfaceRef" : "string",
      "ipv6Enabled" : true,
      "ipv6Data" : {
        "ipv6LocalAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6RoutableAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6PortRouterAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6AddressConfigMethod" : "string",
        "ipv6OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6HopLimit" : 0,
        "ipv6NdReachableTime" : 0,
        "ipv6NdRetransmitTime" : 0,
        "ipv6NdStaleTimeout" : 0,
        "ipv6DuplicateAddressDetectionAttempts" : 0
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isIPv6Capable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sas" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "part" : "string",
      "revision" : 0,
      "isDegraded" : true,
      "iocPort" : {
        "parent" : {
          "type" : "string",
          "controller" : "string",
          "drive" : "string",
          "expander" : "string",
          "hostBoardRef" : "string"
        },
        "attachedDevice" : {
          "channel" : 0,
          "channelType" : "string",
          "sasAttachedDeviceData" : {
            "type" : "string",
            "alternateController" : "string",
            "drive" : "string",
            "expander" : "string",
            "remoteHostPortAddress" : "string",
            "localController" : "string",
            "physicalLocation" : {
              "trayRef" : "string",
              "slot" : 0,
              "locationParent" : {
                "refType" : "string",
                "controllerRef" : "string",
                "symbolRef" : "string",
                "typedReference" : {
                  "componentType" : "string",
                  "symbolRef" : "string"
                }
              },
              "locationPosition" : 0,
              "label" : "string"
            }
          }
        },
        "state" : "string",
        "miswireType" : "string",
        "channelPortRef" : "string",
        "sasPhys" : [ {
          "phyIdentifier" : 0,
          "isOperational" : true
        } ],
        "portTypeData" : {
          "portType" : "string",
          "portIdentifier" : "string",
          "routingType" : "string"
        },
        "portMode" : "string",
        "domainNumber" : 0,
        "attachedChannelPortRef" : "string",
        "discoveryStatus" : 0
      },
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sata" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "speedControl" : "string",
      "part" : "string",
      "revision" : 0,
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "id" : "string"
    },
    "scsi" : {
      "channel" : 0,
      "scsiID" : 0,
      "speed" : 0,
      "scsiType" : "string",
      "width" : 0,
      "part" : "string",
      "revision" : 0,
      "reserved1" : "string",
      "reserved2" : "string"
    }
  },
  "controllerRef" : "string",
  "commandProtocolPropertiesList" : {
    "commandProtocolProperties" : [ {
      "commandProtocol" : "string",
      "nvmeProperties" : {
        "commandSet" : "string",
        "nvmeofProperties" : {
          "provider" : "string",
          "ibProperties" : {
            "ipAddressData" : {
              "addressType" : "string",
              "ipv4Data" : {
                "configState" : "string",
                "ipv4Address" : "string",
                "ipv4SubnetMask" : "string",
                "ipv4GatewayAddress" : "string"
              },
              "ipv6Data" : {
                "address" : "string",
                "addressState" : {
                  "addressType" : "string",
                  "interfaceAddressState" : "string",
                  "routerAddressState" : "string"
                }
              }
            },
            "listeningPort" : 0
          }
        }
      }
    } ]
  }
} ]

3.11.16. Update NVMeoF entity

POST /devmgr/v2/storage-systems/{system-id}/nvmeof/entity
Description

Mode: Both Embedded and Proxy.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

NVMeoFEntityUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

< IoInterface > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/nvmeof/entity
Request body
{
  "nvmeInterface" : "string",
  "ipv4Address" : [ "string" ]
}
Example HTTP response
Response 200
{
  "interfaceRef" : "string",
  "channelType" : "string",
  "ioInterfaceTypeData" : {
    "interfaceType" : "string",
    "fibre" : {
      "channel" : 0,
      "loopID" : 0,
      "speed" : 0,
      "hardAddress" : 0,
      "nodeName" : "string",
      "portName" : "string",
      "portId" : "string",
      "topology" : "string",
      "part" : "string",
      "revision" : 0,
      "chanMiswire" : true,
      "esmMiswire" : true,
      "linkStatus" : "string",
      "isDegraded" : true,
      "speedControl" : "string",
      "maxSpeed" : 0,
      "speedNegError" : true,
      "reserved1" : "string",
      "reserved2" : "string",
      "ddsChannelState" : 0,
      "ddsStateReason" : 0,
      "ddsStateWho" : 0,
      "isLocal" : true,
      "channelPorts" : [ {
        "speedDetError" : true,
        "manuallyBypassed" : true,
        "portNumber" : "string"
      } ],
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkCapable" : true,
      "trunkMiswire" : true,
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "ib" : {
      "interfaceRef" : "string",
      "channel" : 0,
      "channelPortRef" : "string",
      "localIdentifier" : 0,
      "globalIdentifier" : "string",
      "linkState" : "string",
      "portState" : "string",
      "maximumTransmissionUnit" : 0,
      "currentSpeed" : "string",
      "supportedSpeed" : [ "string" ],
      "currentLinkWidth" : "string",
      "supportedLinkWidth" : [ "string" ],
      "currentDataVirtualLanes" : 0,
      "maximumDataVirtualLanes" : 0,
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isSRPSupported" : true,
      "isISERSupported" : true,
      "physPortState" : "string",
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "isNVMeSupported" : true,
      "id" : "string"
    },
    "iscsi" : {
      "channel" : 0,
      "channelPortRef" : "string",
      "tcpListenPort" : 0,
      "ipv4Enabled" : true,
      "ipv4Data" : {
        "ipv4Address" : "string",
        "ipv4AddressConfigMethod" : "string",
        "ipv4OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv4AddressData" : {
          "configState" : "string",
          "ipv4Address" : "string",
          "ipv4SubnetMask" : "string",
          "ipv4GatewayAddress" : "string"
        }
      },
      "interfaceData" : {
        "type" : "string",
        "ethernetData" : {
          "partData" : {
            "vendorName" : "string",
            "partNumber" : "string",
            "revisionNumber" : "string",
            "serialNumber" : "string"
          },
          "macAddress" : "string",
          "fullDuplex" : true,
          "maximumFramePayloadSize" : 0,
          "currentInterfaceSpeed" : "string",
          "maximumInterfaceSpeed" : "string",
          "linkStatus" : "string",
          "supportedInterfaceSpeeds" : [ "string" ],
          "autoconfigSupport" : true,
          "copperCableDiagnosticsSupport" : true
        },
        "infinibandData" : {
          "isIser" : true
        }
      },
      "interfaceRef" : "string",
      "ipv6Enabled" : true,
      "ipv6Data" : {
        "ipv6LocalAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6RoutableAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6PortRouterAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6AddressConfigMethod" : "string",
        "ipv6OutboundPacketPriority" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6VlanId" : {
          "isEnabled" : true,
          "value" : 0
        },
        "ipv6HopLimit" : 0,
        "ipv6NdReachableTime" : 0,
        "ipv6NdRetransmitTime" : 0,
        "ipv6NdStaleTimeout" : 0,
        "ipv6DuplicateAddressDetectionAttempts" : 0
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "isIPv6Capable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sas" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "part" : "string",
      "revision" : 0,
      "isDegraded" : true,
      "iocPort" : {
        "parent" : {
          "type" : "string",
          "controller" : "string",
          "drive" : "string",
          "expander" : "string",
          "hostBoardRef" : "string"
        },
        "attachedDevice" : {
          "channel" : 0,
          "channelType" : "string",
          "sasAttachedDeviceData" : {
            "type" : "string",
            "alternateController" : "string",
            "drive" : "string",
            "expander" : "string",
            "remoteHostPortAddress" : "string",
            "localController" : "string",
            "physicalLocation" : {
              "trayRef" : "string",
              "slot" : 0,
              "locationParent" : {
                "refType" : "string",
                "controllerRef" : "string",
                "symbolRef" : "string",
                "typedReference" : {
                  "componentType" : "string",
                  "symbolRef" : "string"
                }
              },
              "locationPosition" : 0,
              "label" : "string"
            }
          }
        },
        "state" : "string",
        "miswireType" : "string",
        "channelPortRef" : "string",
        "sasPhys" : [ {
          "phyIdentifier" : 0,
          "isOperational" : true
        } ],
        "portTypeData" : {
          "portType" : "string",
          "portIdentifier" : "string",
          "routingType" : "string"
        },
        "portMode" : "string",
        "domainNumber" : 0,
        "attachedChannelPortRef" : "string",
        "discoveryStatus" : 0
      },
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "oneWayMaxRate" : "string",
      "bidirectionalMaxRate" : "string",
      "id" : "string"
    },
    "sata" : {
      "channel" : 0,
      "currentInterfaceSpeed" : "string",
      "maximumInterfaceSpeed" : "string",
      "speedControl" : "string",
      "part" : "string",
      "revision" : 0,
      "interfaceRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "protectionInformationCapable" : true,
      "id" : "string"
    },
    "scsi" : {
      "channel" : 0,
      "scsiID" : 0,
      "speed" : 0,
      "scsiType" : "string",
      "width" : 0,
      "part" : "string",
      "revision" : 0,
      "reserved1" : "string",
      "reserved2" : "string"
    }
  },
  "controllerRef" : "string",
  "commandProtocolPropertiesList" : {
    "commandProtocolProperties" : [ {
      "commandProtocol" : "string",
      "nvmeProperties" : {
        "commandSet" : "string",
        "nvmeofProperties" : {
          "provider" : "string",
          "ibProperties" : {
            "ipAddressData" : {
              "addressType" : "string",
              "ipv4Data" : {
                "configState" : "string",
                "ipv4Address" : "string",
                "ipv4SubnetMask" : "string",
                "ipv4GatewayAddress" : "string"
              },
              "ipv6Data" : {
                "address" : "string",
                "addressState" : {
                  "addressType" : "string",
                  "interfaceAddressState" : "string",
                  "routerAddressState" : "string"
                }
              }
            },
            "listeningPort" : 0
          }
        }
      }
    } ]
  }
} ]

3.11.17. Get NVMeoF initiator settings

GET /devmgr/v2/storage-systems/{system-id}/nvmeof/initiator-settings
Description

Mode: Both Embedded and Proxy.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

Target

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/nvmeof/initiator-settings
Example HTTP response
Response 200
{
  "targetRef" : "string",
  "nodeName" : {
    "ioInterfaceType" : "string",
    "iscsiNodeName" : "string",
    "remoteNodeWWN" : "string",
    "nvmeNodeName" : "string"
  },
  "alias" : {
    "ioInterfaceType" : "string",
    "iscsiAlias" : "string"
  },
  "configuredAuthMethods" : {
    "authMethodData" : [ {
      "authMethod" : "string",
      "chapSecret" : [ {
        "type" : "string",
        "pkcs5Data" : {
          "iterations" : 0,
          "salt" : "string",
          "cipherText" : "string"
        },
        "pkcs5AesData" : {
          "iterations" : 0,
          "salt" : "string",
          "cipherText" : "string"
        }
      } ]
    } ]
  },
  "portals" : [ {
    "groupTag" : 0,
    "ipAddress" : {
      "addressType" : "string",
      "ipv4Address" : "string",
      "ipv6Address" : "string"
    },
    "tcpListenPort" : 0
  } ]
}

3.12. LDAP

3.12.1. Retrieve the LDAP configuration on the proxy server

GET /devmgr/v2/ldap
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

Unable to load proxy LDAP configuration

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/ldap
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.12.2. Configure LDAP on the proxy server for a single or multiple domains

POST /devmgr/v2/ldap
Description

Warning: This will remove previous configurations

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Body

body
optional

LdapConfiguration

Query

skipTest
optional

Indicates if connection and authentication testing should be skipped on the domains in the LDAP configuration provided. If any of the tests fail, the LDAP configuration provided will not be saved. The default value is false.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

Unable to configure LDAP

422

Testing of the LDAP configuration has failed

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/ldap
Request body
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}
Request query
{
  "skipTest" : true
}
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.12.3. Remove the existing LDAP configuration

DELETE /devmgr/v2/ldap
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/ldap
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.12.4. Retrieve a specific LDAP domain configuration on the proxy server

GET /devmgr/v2/ldap/{id}
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

id
required

The id of the LDAP domain that configuration information should be retrieved for

string

Responses
HTTP Code Description Schema

200

successful operation

LdapDomain

404

Unable to retrieve the specified domain

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/ldap/string
Example HTTP response
Response 200
{
  "id" : "string",
  "bindLookupUser" : {
    "password" : "string",
    "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
  },
  "groupAttributes" : "memberOf",
  "ldapUrl" : "ldaps://ldap.example.com:636",
  "names" : [ "string" ],
  "roleMapCollection" : [ {
    "groupRegex" : ".*cn=data-admin.*",
    "ignorecase" : false,
    "name" : "storage.monitor"
  } ],
  "searchBase" : "ou=users,dc=example,dc=com",
  "userAttribute" : "sAMAccountName"
}

3.12.5. Deletes the specified domain from the LDAP configuration on the proxy server

DELETE /devmgr/v2/ldap/{id}
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

id
required

The id of the LDAP domain to be deleted from the configuration

string

Responses
HTTP Code Description Schema

204

The specified domain has been successfully deleted

404

Unable to delete specified domain

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/ldap/string

3.12.6. Adds an LDAP domain to the existing configuration on the proxy server

POST /devmgr/v2/ldap/addDomain
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Body

body
optional

LdapDomain

Query

skipTest
optional

Indicates if connection and authentication testing should be skipped on the provided LDAP domain. If any of the tests fail, the LDAP domain provided will not be added. The default value is false.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

Unable to add domain

422

Testing of the LDAP domain has failed

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/ldap/addDomain
Request body
{
  "id" : "string",
  "bindLookupUser" : {
    "password" : "string",
    "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
  },
  "groupAttributes" : "memberOf",
  "ldapUrl" : "ldaps://ldap.example.com:636",
  "names" : [ "string" ],
  "roleMapCollection" : [ {
    "groupRegex" : ".*cn=data-admin.*",
    "ignorecase" : false,
    "name" : "storage.monitor"
  } ],
  "searchBase" : "ou=users,dc=example,dc=com",
  "userAttribute" : "sAMAccountName"
}
Request query
{
  "skipTest" : true
}
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.12.7. Updates LDAP configuration for a single domain on the proxy server

POST /devmgr/v2/ldap/{domain-id}
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Path

domain-id
required

The id of the LDAP domain that needs to be updated

string

Body

body
optional

LdapDomain

Query

skipTest
optional

Indicates if connection and authentication testing should be skipped on the provided LDAP domain. If any of the tests fail, the LDAP configuration will not be updated. The default value is false.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

LdapConfiguration

404

Unable to update configuration

422

Testing of the LDAP domain has failed

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/ldap/string
Request body
{
  "id" : "string",
  "bindLookupUser" : {
    "password" : "string",
    "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
  },
  "groupAttributes" : "memberOf",
  "ldapUrl" : "ldaps://ldap.example.com:636",
  "names" : [ "string" ],
  "roleMapCollection" : [ {
    "groupRegex" : ".*cn=data-admin.*",
    "ignorecase" : false,
    "name" : "storage.monitor"
  } ],
  "searchBase" : "ou=users,dc=example,dc=com",
  "userAttribute" : "sAMAccountName"
}
Request query
{
  "skipTest" : true
}
Example HTTP response
Response 200
{
  "ldapDomains" : [ {
    "id" : "string",
    "bindLookupUser" : {
      "password" : "string",
      "user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
    },
    "groupAttributes" : "memberOf",
    "ldapUrl" : "ldaps://ldap.example.com:636",
    "names" : [ "string" ],
    "roleMapCollection" : [ {
      "groupRegex" : ".*cn=data-admin.*",
      "ignorecase" : false,
      "name" : "storage.monitor"
    } ],
    "searchBase" : "ou=users,dc=example,dc=com",
    "userAttribute" : "sAMAccountName"
  } ]
}

3.12.8. Test the current LDAP configuration on the proxy server.

POST /devmgr/v2/ldap/test
Description

If no bind user is defined only a communication test will be performed

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, security.admin]

Responses
HTTP Code Description Schema

200

successful operation

< LdapDomainTestResponse > array

404

Unable to test the LDAP configuration

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/ldap/test
Example HTTP response
Response 200
{
  "id" : "string",
  "result" : {
    "connectionTestResult" : "string",
    "authenticationTestResult" : "string",
    "searchTestResult" : "string"
  }
} ]

3.12.9. Get the user’s current roles and list of role permissions.

GET /devmgr/v2/ldap/roles
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, security.admin, storage.admin, support.admin]

Parameters
Type Name Schema Default

Query

allUsers
optional

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

RolesResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/ldap/roles
Request query
{
  "allUsers" : true
}
Example HTTP response
Response 200
{
  "userRoles" : [ "string" ],
  "endpoints" : [ {
    "httpMethod" : "string",
    "endpoint" : "string",
    "roles" : [ "string" ]
  } ]
}

3.13. Mapping

3.13.1. Get a HostGroup

GET /devmgr/v2/storage-systems/{system-id}/host-groups/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

The id of the hostgroup

string

Responses
HTTP Code Description Schema

200

successful operation

HostGroup

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-groups/string
Example HTTP response
Response 200
{
  "clusterRef" : "string",
  "label" : "string",
  "isSAControlled" : true,
  "confirmLUNMappingCreation" : true,
  "protectionInformationCapableAccessMethod" : true,
  "isLun0Restricted" : true,
  "id" : "string",
  "name" : "string"
}

3.13.2. Update a HostGroup

POST /devmgr/v2/storage-systems/{system-id}/host-groups/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

The id of the hostgroup

string

Body

body
optional

HostGroupUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

HostGroup

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-groups/string
Request body
{
  "name" : "string",
  "hosts" : [ "string" ]
}
Example HTTP response
Response 200
{
  "clusterRef" : "string",
  "label" : "string",
  "isSAControlled" : true,
  "confirmLUNMappingCreation" : true,
  "protectionInformationCapableAccessMethod" : true,
  "isLun0Restricted" : true,
  "id" : "string",
  "name" : "string"
}

3.13.3. Delete a HostGroup

DELETE /devmgr/v2/storage-systems/{system-id}/host-groups/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

The id of the hostgroup

string

Responses
HTTP Code Description Schema

204

Delete HostGroup successful

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-groups/string

3.13.4. Get all HostGroups

GET /devmgr/v2/storage-systems/{system-id}/host-groups
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< HostGroup > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-groups
Example HTTP response
Response 200
{
  "clusterRef" : "string",
  "label" : "string",
  "isSAControlled" : true,
  "confirmLUNMappingCreation" : true,
  "protectionInformationCapableAccessMethod" : true,
  "isLun0Restricted" : true,
  "id" : "string",
  "name" : "string"
} ]

3.13.5. Create a HostGroup

POST /devmgr/v2/storage-systems/{system-id}/host-groups
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

HostGroupCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

HostGroup

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-groups
Request body
{
  "name" : "string",
  "hosts" : [ "string" ]
}
Example HTTP response
Response 200
{
  "clusterRef" : "string",
  "label" : "string",
  "isSAControlled" : true,
  "confirmLUNMappingCreation" : true,
  "protectionInformationCapableAccessMethod" : true,
  "isLun0Restricted" : true,
  "id" : "string",
  "name" : "string"
}

3.13.6. Get a Host

GET /devmgr/v2/storage-systems/{system-id}/hosts/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

The id of the host

string

Responses
HTTP Code Description Schema

200

successful operation

HostEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hosts/string
Example HTTP response
Response 200
{
  "hostRef" : "string",
  "clusterRef" : "string",
  "label" : "string",
  "isSAControlled" : true,
  "confirmLUNMappingCreation" : true,
  "hostTypeIndex" : 0,
  "protectionInformationCapableAccessMethod" : true,
  "isLargeBlockFormatHost" : true,
  "isLun0Restricted" : true,
  "ports" : [ {
    "hostPortRef" : "string",
    "hostPortName" : "string",
    "label" : "string",
    "hostRef" : "string",
    "hostPortTypeIndex" : 0,
    "isSAControlled" : true,
    "confirmLUNMappingCreation" : true,
    "portId" : {
      "ioInterfaceType" : "string",
      "portName" : "string",
      "ibPortName" : "string",
      "iscsiPortName" : {
        "initiatorNodeName" : "string",
        "initiatorSessionId" : "string"
      },
      "sasPortName" : "string",
      "nvmeInitiatorPortId" : {
        "name" : "string",
        "hostIdentifier" : "string",
        "portIdentifier" : {
          "ioInterfaceType" : "string",
          "fcPortName" : "string",
          "ibPortName" : "string",
          "sasPortName" : "string"
        }
      }
    },
    "portInactive" : true,
    "id" : "string"
  } ],
  "initiators" : [ {
    "initiatorRef" : "string",
    "nodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "alias" : {
      "ioInterfaceType" : "string",
      "iscsiAlias" : "string"
    },
    "label" : "string",
    "configuredAuthMethods" : {
      "authMethodData" : [ {
        "authMethod" : "string",
        "chapSecret" : [ {
          "type" : "string",
          "pkcs5Data" : {
            "iterations" : 0,
            "salt" : "string",
            "cipherText" : "string"
          },
          "pkcs5AesData" : {
            "iterations" : 0,
            "salt" : "string",
            "cipherText" : "string"
          }
        } ]
      } ]
    },
    "hostRef" : "string",
    "initiatorInactive" : true,
    "id" : "string"
  } ],
  "hostSidePorts" : [ {
    "type" : "string",
    "address" : "string",
    "label" : "string"
  } ],
  "id" : "string",
  "name" : "string"
}

3.13.7. Update the parameters of a Host

POST /devmgr/v2/storage-systems/{system-id}/hosts/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

The id of the host

string

Body

body
optional

HostUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

HostEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hosts/string
Request body
{
  "name" : "string",
  "groupId" : "string",
  "ports" : [ {
    "type" : "string",
    "port" : "string",
    "label" : "string",
    "iscsiChapSecret" : "string"
  } ],
  "portsToUpdate" : [ {
    "portRef" : "string",
    "hostRef" : "string",
    "port" : "string",
    "label" : "string",
    "iscsiChapSecret" : "string"
  } ],
  "portsToRemove" : [ "string" ],
  "hostType" : {
    "name" : "string",
    "index" : 0,
    "code" : "string",
    "used" : true,
    "default" : true
  }
}
Example HTTP response
Response 200
{
  "hostRef" : "string",
  "clusterRef" : "string",
  "label" : "string",
  "isSAControlled" : true,
  "confirmLUNMappingCreation" : true,
  "hostTypeIndex" : 0,
  "protectionInformationCapableAccessMethod" : true,
  "isLargeBlockFormatHost" : true,
  "isLun0Restricted" : true,
  "ports" : [ {
    "hostPortRef" : "string",
    "hostPortName" : "string",
    "label" : "string",
    "hostRef" : "string",
    "hostPortTypeIndex" : 0,
    "isSAControlled" : true,
    "confirmLUNMappingCreation" : true,
    "portId" : {
      "ioInterfaceType" : "string",
      "portName" : "string",
      "ibPortName" : "string",
      "iscsiPortName" : {
        "initiatorNodeName" : "string",
        "initiatorSessionId" : "string"
      },
      "sasPortName" : "string",
      "nvmeInitiatorPortId" : {
        "name" : "string",
        "hostIdentifier" : "string",
        "portIdentifier" : {
          "ioInterfaceType" : "string",
          "fcPortName" : "string",
          "ibPortName" : "string",
          "sasPortName" : "string"
        }
      }
    },
    "portInactive" : true,
    "id" : "string"
  } ],
  "initiators" : [ {
    "initiatorRef" : "string",
    "nodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "alias" : {
      "ioInterfaceType" : "string",
      "iscsiAlias" : "string"
    },
    "label" : "string",
    "configuredAuthMethods" : {
      "authMethodData" : [ {
        "authMethod" : "string",
        "chapSecret" : [ {
          "type" : "string",
          "pkcs5Data" : {
            "iterations" : 0,
            "salt" : "string",
            "cipherText" : "string"
          },
          "pkcs5AesData" : {
            "iterations" : 0,
            "salt" : "string",
            "cipherText" : "string"
          }
        } ]
      } ]
    },
    "hostRef" : "string",
    "initiatorInactive" : true,
    "id" : "string"
  } ],
  "hostSidePorts" : [ {
    "type" : "string",
    "address" : "string",
    "label" : "string"
  } ],
  "id" : "string",
  "name" : "string"
}

3.13.8. Delete a Host

DELETE /devmgr/v2/storage-systems/{system-id}/hosts/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

The id of the host

string

Responses
HTTP Code Description Schema

204

Delete host successful

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hosts/string

3.13.9. Move a Host under a different HostGroup

POST /devmgr/v2/storage-systems/{system-id}/hosts/{hostId}/move
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

hostId
required

The id of an existing host entry configured on the specified array

string

Body

body
optional

HostMoveRequest

Responses
HTTP Code Description Schema

200

successful operation

HostEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hosts/string/move
Request body
{
  "groupId" : "string"
}
Example HTTP response
Response 200
{
  "hostRef" : "string",
  "clusterRef" : "string",
  "label" : "string",
  "isSAControlled" : true,
  "confirmLUNMappingCreation" : true,
  "hostTypeIndex" : 0,
  "protectionInformationCapableAccessMethod" : true,
  "isLargeBlockFormatHost" : true,
  "isLun0Restricted" : true,
  "ports" : [ {
    "hostPortRef" : "string",
    "hostPortName" : "string",
    "label" : "string",
    "hostRef" : "string",
    "hostPortTypeIndex" : 0,
    "isSAControlled" : true,
    "confirmLUNMappingCreation" : true,
    "portId" : {
      "ioInterfaceType" : "string",
      "portName" : "string",
      "ibPortName" : "string",
      "iscsiPortName" : {
        "initiatorNodeName" : "string",
        "initiatorSessionId" : "string"
      },
      "sasPortName" : "string",
      "nvmeInitiatorPortId" : {
        "name" : "string",
        "hostIdentifier" : "string",
        "portIdentifier" : {
          "ioInterfaceType" : "string",
          "fcPortName" : "string",
          "ibPortName" : "string",
          "sasPortName" : "string"
        }
      }
    },
    "portInactive" : true,
    "id" : "string"
  } ],
  "initiators" : [ {
    "initiatorRef" : "string",
    "nodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "alias" : {
      "ioInterfaceType" : "string",
      "iscsiAlias" : "string"
    },
    "label" : "string",
    "configuredAuthMethods" : {
      "authMethodData" : [ {
        "authMethod" : "string",
        "chapSecret" : [ {
          "type" : "string",
          "pkcs5Data" : {
            "iterations" : 0,
            "salt" : "string",
            "cipherText" : "string"
          },
          "pkcs5AesData" : {
            "iterations" : 0,
            "salt" : "string",
            "cipherText" : "string"
          }
        } ]
      } ]
    },
    "hostRef" : "string",
    "initiatorInactive" : true,
    "id" : "string"
  } ],
  "hostSidePorts" : [ {
    "type" : "string",
    "address" : "string",
    "label" : "string"
  } ],
  "id" : "string",
  "name" : "string"
}

3.13.10. Get all Hosts

GET /devmgr/v2/storage-systems/{system-id}/hosts
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< HostEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hosts
Example HTTP response
Response 200
{
  "hostRef" : "string",
  "clusterRef" : "string",
  "label" : "string",
  "isSAControlled" : true,
  "confirmLUNMappingCreation" : true,
  "hostTypeIndex" : 0,
  "protectionInformationCapableAccessMethod" : true,
  "isLargeBlockFormatHost" : true,
  "isLun0Restricted" : true,
  "ports" : [ {
    "hostPortRef" : "string",
    "hostPortName" : "string",
    "label" : "string",
    "hostRef" : "string",
    "hostPortTypeIndex" : 0,
    "isSAControlled" : true,
    "confirmLUNMappingCreation" : true,
    "portId" : {
      "ioInterfaceType" : "string",
      "portName" : "string",
      "ibPortName" : "string",
      "iscsiPortName" : {
        "initiatorNodeName" : "string",
        "initiatorSessionId" : "string"
      },
      "sasPortName" : "string",
      "nvmeInitiatorPortId" : {
        "name" : "string",
        "hostIdentifier" : "string",
        "portIdentifier" : {
          "ioInterfaceType" : "string",
          "fcPortName" : "string",
          "ibPortName" : "string",
          "sasPortName" : "string"
        }
      }
    },
    "portInactive" : true,
    "id" : "string"
  } ],
  "initiators" : [ {
    "initiatorRef" : "string",
    "nodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "alias" : {
      "ioInterfaceType" : "string",
      "iscsiAlias" : "string"
    },
    "label" : "string",
    "configuredAuthMethods" : {
      "authMethodData" : [ {
        "authMethod" : "string",
        "chapSecret" : [ {
          "type" : "string",
          "pkcs5Data" : {
            "iterations" : 0,
            "salt" : "string",
            "cipherText" : "string"
          },
          "pkcs5AesData" : {
            "iterations" : 0,
            "salt" : "string",
            "cipherText" : "string"
          }
        } ]
      } ]
    },
    "hostRef" : "string",
    "initiatorInactive" : true,
    "id" : "string"
  } ],
  "hostSidePorts" : [ {
    "type" : "string",
    "address" : "string",
    "label" : "string"
  } ],
  "id" : "string",
  "name" : "string"
} ]

3.13.11. Create a new Host

POST /devmgr/v2/storage-systems/{system-id}/hosts
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

HostCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

Host

404

StorageDevice not found

422

Invalid HostGroup reference

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hosts
Request body
{
  "name" : "string",
  "hostType" : {
    "name" : "string",
    "index" : 0,
    "code" : "string",
    "used" : true,
    "default" : true
  },
  "groupId" : "string",
  "ports" : [ {
    "type" : "string",
    "port" : "string",
    "label" : "string",
    "iscsiChapSecret" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "hostRef" : "string",
  "clusterRef" : "string",
  "label" : "string",
  "isSAControlled" : true,
  "confirmLUNMappingCreation" : true,
  "hostTypeIndex" : 0,
  "protectionInformationCapableAccessMethod" : true,
  "isLargeBlockFormatHost" : true,
  "isLun0Restricted" : true,
  "name" : "string",
  "id" : "string"
}

3.13.12. Get all HostTypes

GET /devmgr/v2/storage-systems/{system-id}/host-types
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< HostType > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-types
Example HTTP response
Response 200
{
  "name" : "string",
  "index" : 0,
  "code" : "string",
  "used" : true,
  "default" : true
} ]

3.13.13. Set default HostType

POST /devmgr/v2/storage-systems/{system-id}/host-types
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SingleNumberValue

Responses
HTTP Code Description Schema

200

successful operation

HostType

404

StorageDevice not found

422

Invalid HostType

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-types
Request body
{
  "value" : 0
}
Example HTTP response
Response 200
{
  "name" : "string",
  "index" : 0,
  "code" : "string",
  "used" : true,
  "default" : true
}

3.13.14. Get a HostType

GET /devmgr/v2/storage-systems/{system-id}/host-types/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

The id of the HostType

string

Responses
HTTP Code Description Schema

200

successful operation

HostType

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-types/string
Example HTTP response
Response 200
{
  "name" : "string",
  "index" : 0,
  "code" : "string",
  "used" : true,
  "default" : true
}

3.13.15. Get the list of HostTypes

GET /devmgr/v2/storage-systems/{system-id}/host-type-values
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< HostTypeValues > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-type-values
Example HTTP response
Response 200
{
  "waitForDownload" : true,
  "notReadySenseForQuiescenceInProgress" : true,
  "notReadySenseForQuiescenceInProgress2" : true,
  "checkConditionForVendorUniqueUAConditions" : true,
  "reportDeferredErrors" : true,
  "ignoreForceUnitAccess" : true,
  "ignoreWriteCacheDisable" : true,
  "allowReservationOnUnownedLUNs" : true,
  "worldWideNameInStandardInquiry" : true,
  "propagateHostBusResets" : true,
  "reportSCCDeviceEnable" : true,
  "conditionalFCLogout" : true,
  "forceSCSI2" : true,
  "reportUnconfiguredLUNs" : true,
  "ignoreSyncCache" : true,
  "ignoreUTMLunOwnership" : true,
  "reportLUNPreferredPathInStandardInquiry" : true,
  "autoLUNTransfer" : true,
  "inquiryUnconfiguredDeviceType" : "string",
  "inquiryUnownedDeviceType" : "string",
  "unownedBlock0Read" : "string",
  "retainLogins" : true,
  "hostPortType" : "string",
  "maxRestrictedLUNs" : 0,
  "reserved1" : "string",
  "avtExclusionExtentsEnabled" : true,
  "suppressVolOffPreferredPathAlert" : true,
  "hostType" : "string",
  "tpgsSupported" : true,
  "volumeFormatOptions" : true,
  "restrictedLun0" : true,
  "usePage2CQuiescenceTimeout" : true,
  "asymmetricLUAccess" : true,
  "ignoreISCSISessionIDInITN" : true,
  "enableLUCheckConditionParallelResponses" : true,
  "disableExplicitTPGS" : true,
  "unownedCheckConditionDuringFWActivation" : true,
  "allowPreferredOwnerReportingSuppression" : true,
  "enableTargetFailback" : true,
  "enableAutoLoadBalance" : true,
  "quiescenceInProgressSenseKey" : 0,
  "quiescenceInProgressASC" : 0,
  "quiescenceInProgressASCQ" : 0,
  "persistentID" : 0,
  "nvmeVUFailoverSupported" : true,
  "nvmeStandardFailoverSupported" : true,
  "index" : 0,
  "default" : true
} ]

3.13.16. Get the list of HostTypes

GET /devmgr/v2/storage-systems/{system-id}/host-type-values/{index}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

index
required

"The value of the index for the desired host type value. This value corresponds to the index attribute of the HostTypeValues model"

integer (int32)

Responses
HTTP Code Description Schema

200

successful operation

HostTypeValues

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-type-values/0
Example HTTP response
Response 200
{
  "waitForDownload" : true,
  "notReadySenseForQuiescenceInProgress" : true,
  "notReadySenseForQuiescenceInProgress2" : true,
  "checkConditionForVendorUniqueUAConditions" : true,
  "reportDeferredErrors" : true,
  "ignoreForceUnitAccess" : true,
  "ignoreWriteCacheDisable" : true,
  "allowReservationOnUnownedLUNs" : true,
  "worldWideNameInStandardInquiry" : true,
  "propagateHostBusResets" : true,
  "reportSCCDeviceEnable" : true,
  "conditionalFCLogout" : true,
  "forceSCSI2" : true,
  "reportUnconfiguredLUNs" : true,
  "ignoreSyncCache" : true,
  "ignoreUTMLunOwnership" : true,
  "reportLUNPreferredPathInStandardInquiry" : true,
  "autoLUNTransfer" : true,
  "inquiryUnconfiguredDeviceType" : "string",
  "inquiryUnownedDeviceType" : "string",
  "unownedBlock0Read" : "string",
  "retainLogins" : true,
  "hostPortType" : "string",
  "maxRestrictedLUNs" : 0,
  "reserved1" : "string",
  "avtExclusionExtentsEnabled" : true,
  "suppressVolOffPreferredPathAlert" : true,
  "hostType" : "string",
  "tpgsSupported" : true,
  "volumeFormatOptions" : true,
  "restrictedLun0" : true,
  "usePage2CQuiescenceTimeout" : true,
  "asymmetricLUAccess" : true,
  "ignoreISCSISessionIDInITN" : true,
  "enableLUCheckConditionParallelResponses" : true,
  "disableExplicitTPGS" : true,
  "unownedCheckConditionDuringFWActivation" : true,
  "allowPreferredOwnerReportingSuppression" : true,
  "enableTargetFailback" : true,
  "enableAutoLoadBalance" : true,
  "quiescenceInProgressSenseKey" : 0,
  "quiescenceInProgressASC" : 0,
  "quiescenceInProgressASCQ" : 0,
  "persistentID" : 0,
  "nvmeVUFailoverSupported" : true,
  "nvmeStandardFailoverSupported" : true,
  "index" : 0,
  "default" : true
}

3.13.17. Get the list of unassociated HostPorts

GET /devmgr/v2/storage-systems/{system-id}/unassociated-host-ports
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< UnassociatedHostPort > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/unassociated-host-ports
Example HTTP response
Response 200
{
  "type" : "string",
  "id" : "string",
  "address" : "string"
} ]

3.14. Mirroring

3.14.1. Get a list of storage-systems that support Asynchronous Mirroring

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/arvm-arrays
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

compatibleOnly
optional

Only return storage-systems supporting async mirroring that compatible with the target storage-system.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

< RemoteCandidate > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/arvm-arrays
Request query
{
  "compatibleOnly" : true
}
Example HTTP response
Response 200
{
  "wwn" : "string",
  "id" : "string",
  "name" : "string",
  "type" : "string",
  "fcMirroringState" : "string"
} ]

3.14.2. Resume synchronization of an Async Mirror Group

POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/resume
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Query

deleteRecoveryPointIfNecessary
optional

boolean

"true"

Responses
HTTP Code Description Schema

204

AMG synchronization resumed.

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/resume
Request query
{
  "deleteRecoveryPointIfNecessary" : true
}

3.14.3. Suspend synchronization of an Async Mirror Group

POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/suspend
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

AMG synchronization suspended.

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/suspend

3.14.4. Test connectivity of an Async Mirror Group

POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/test
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

AsyncMirrorGroupConnectivityTestRequest

Responses
HTTP Code Description Schema

200

successful operation

< AsyncCommunicationData > array

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/test
Request body
{
  "requestedTestType" : "string",
  "testIterations" : 0,
  "timeout" : 0
}
Example HTTP response
Response 200
{
  "timeout" : 0,
  "returnStatus" : "string",
  "successful" : true,
  "controllerRef" : "string",
  "amgRef" : "string",
  "testType" : "string",
  "bwTestResult" : {
    "latencyMeasures" : {
      "minLatencyInMicroseconds" : 0,
      "maxLatencyInMicroseconds" : 0,
      "avgLatencyInMicroseconds" : 0
    },
    "minBandwidthBitsPerSecond" : "string",
    "maxBandwidthBitsPerSecond" : "string",
    "avgBandwidthBitsPerSecond" : "string",
    "negotiatedLinkSpeedBitsPerSecond" : "string"
  },
  "latTestResult" : {
    "minLatencyInMicroseconds" : 0,
    "maxLatencyInMicroseconds" : 0,
    "avgLatencyInMicroseconds" : 0
  }
} ]

3.14.5. Begin synchronization of an Async Mirror Group

POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/sync
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

AsyncMirrorGroupSyncRequest

Responses
HTTP Code Description Schema

204

AMG synchronization started.

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/sync
Request body
{
  "deleteRecoveryPointIfNecessary" : true
}

3.14.6. Retrieve the sync progress of all Async Mirror Groups at once

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/progress
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< AsyncMirrorGroupSyncProgress > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/progress
Example HTTP response
Response 200
{
  "groupPercentComplete" : 0,
  "groupTimeToCompletion" : 0,
  "groupSyncBytes" : "string",
  "groupRef" : "string",
  "memberProgress" : [ {
    "percentComplete" : 0,
    "timeToCompletion" : 0,
    "syncBytes" : "string",
    "mirrorRef" : "string",
    "trackingBytes" : "string"
  } ],
  "groupTrackingBytes" : "string"
} ]

3.14.7. Retrieve sync progress of an Async Mirror Group

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirrorGroupId}/progress
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

mirrorGroupId
required

string

Responses
HTTP Code Description Schema

200

successful operation

AsyncMirrorGroupSyncProgress

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/progress
Example HTTP response
Response 200
{
  "groupPercentComplete" : 0,
  "groupTimeToCompletion" : 0,
  "groupSyncBytes" : "string",
  "groupRef" : "string",
  "memberProgress" : [ {
    "percentComplete" : 0,
    "timeToCompletion" : 0,
    "syncBytes" : "string",
    "mirrorRef" : "string",
    "trackingBytes" : "string"
  } ],
  "groupTrackingBytes" : "string"
}

3.14.8. Get Async Mirror Groups

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< Amg > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors
Example HTTP response
Response 200
{
  "groupRef" : "string",
  "worldWideName" : "string",
  "label" : "string",
  "groupState" : "string",
  "localRole" : "string",
  "remoteRole" : "string",
  "roleChangeProgress" : "string",
  "syncIntervalMinutes" : 0,
  "syncCompletionTimeAlertThresholdMinutes" : 0,
  "recoveryPointAgeAlertThresholdMinutes" : 0,
  "repositoryUtilizationWarnThreshold" : 0,
  "mirrorChannelRemoteTarget" : "string",
  "syncActivity" : "string",
  "orphanGroup" : true,
  "connectionType" : "string",
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "remoteTarget" : {
    "remoteRef" : "string",
    "nodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "scsiinitiatorTargetBaseProperties" : {
      "ioInterfaceType" : "string",
      "iscsiinitiatorTargetBaseParameters" : {
        "portals" : [ {
          "groupTag" : 0,
          "ipAddress" : {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          },
          "tcpListenPort" : 0
        } ]
      }
    }
  },
  "id" : "string"
} ]

3.14.9. Create an Async Mirror Group

POST /devmgr/v2/storage-systems/{system-id}/async-mirrors
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

AsyncMirrorGroupCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

Amg

404

StorageDevice not found

422

Created AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors
Request body
{
  "name" : "string",
  "secondaryArrayId" : "string",
  "syncIntervalMinutes" : 0,
  "manualSync" : true,
  "recoveryWarnThresholdMinutes" : 0,
  "repoUtilizationWarnThreshold" : 0,
  "interfaceType" : "string",
  "syncWarnThresholdMinutes" : 0
}
Example HTTP response
Response 200
{
  "groupRef" : "string",
  "worldWideName" : "string",
  "label" : "string",
  "groupState" : "string",
  "localRole" : "string",
  "remoteRole" : "string",
  "roleChangeProgress" : "string",
  "syncIntervalMinutes" : 0,
  "syncCompletionTimeAlertThresholdMinutes" : 0,
  "recoveryPointAgeAlertThresholdMinutes" : 0,
  "repositoryUtilizationWarnThreshold" : 0,
  "mirrorChannelRemoteTarget" : "string",
  "syncActivity" : "string",
  "orphanGroup" : true,
  "connectionType" : "string",
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "remoteTarget" : {
    "remoteRef" : "string",
    "nodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "scsiinitiatorTargetBaseProperties" : {
      "ioInterfaceType" : "string",
      "iscsiinitiatorTargetBaseParameters" : {
        "portals" : [ {
          "groupTag" : 0,
          "ipAddress" : {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          },
          "tcpListenPort" : 0
        } ]
      }
    }
  },
  "id" : "string"
}

3.14.10. Retrieve the current remote StorageDevice mirroring connections for an Amg

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirrorGroupId}/connections
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

mirrorGroupId
required

string

Responses
HTTP Code Description Schema

200

successful operation

AsyncMirrorConnectionsResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/connections
Example HTTP response
Response 200
{
  "amgRef" : "string",
  "connections" : [ {
    "localPortName" : "string",
    "remotePortName" : "string",
    "remotePortId" : "string",
    "localPortId" : "string",
    "localPortNumber" : 0,
    "remotePortNumber" : 0,
    "controller" : "string",
    "ioInterfaceType" : "string",
    "localPortRef" : "string",
    "iscsiConnectionDetail" : {
      "connectedRemoteTargetPortals" : [ {
        "groupTag" : 0,
        "ipAddress" : {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        },
        "tcpListenPort" : 0
      } ]
    },
    "fibreConnectionDetail" : {
      "remoteNodeWWN" : "string",
      "associatedSwitchPorts" : [ "string" ],
      "connectedRemoteTargetPorts" : [ {
        "switchPortId" : "string",
        "targetPortName" : "string"
      } ]
    },
    "remoteTargetConnections" : {
      "ioInterfaceType" : "string",
      "iscsiConnectionDetail" : {
        "connectedRemoteTargetPortals" : [ {
          "groupTag" : 0,
          "ipAddress" : {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          },
          "tcpListenPort" : 0
        } ]
      },
      "fibreConnectionDetail" : {
        "remoteNodeWWN" : "string",
        "associatedSwitchPorts" : [ "string" ],
        "connectedRemoteTargetPorts" : [ {
          "switchPortId" : "string",
          "targetPortName" : "string"
        } ]
      }
    }
  } ]
}

3.14.11. Retrieve the current remote StorageDevice mirroring connections

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/connections
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< AsyncMirrorConnectionsResponse > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/connections
Example HTTP response
Response 200
{
  "amgRef" : "string",
  "connections" : [ {
    "localPortName" : "string",
    "remotePortName" : "string",
    "remotePortId" : "string",
    "localPortId" : "string",
    "localPortNumber" : 0,
    "remotePortNumber" : 0,
    "controller" : "string",
    "ioInterfaceType" : "string",
    "localPortRef" : "string",
    "iscsiConnectionDetail" : {
      "connectedRemoteTargetPortals" : [ {
        "groupTag" : 0,
        "ipAddress" : {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        },
        "tcpListenPort" : 0
      } ]
    },
    "fibreConnectionDetail" : {
      "remoteNodeWWN" : "string",
      "associatedSwitchPorts" : [ "string" ],
      "connectedRemoteTargetPorts" : [ {
        "switchPortId" : "string",
        "targetPortName" : "string"
      } ]
    },
    "remoteTargetConnections" : {
      "ioInterfaceType" : "string",
      "iscsiConnectionDetail" : {
        "connectedRemoteTargetPortals" : [ {
          "groupTag" : 0,
          "ipAddress" : {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          },
          "tcpListenPort" : 0
        } ]
      },
      "fibreConnectionDetail" : {
        "remoteNodeWWN" : "string",
        "associatedSwitchPorts" : [ "string" ],
        "connectedRemoteTargetPorts" : [ {
          "switchPortId" : "string",
          "targetPortName" : "string"
        } ]
      }
    }
  } ]
} ]

3.14.12. Retrieve the repository usage statistics for all AmgMembers.

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/pairs/repository-utilization
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< AsyncMirrorRepositoryUtilization > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/pairs/repository-utilization
Example HTTP response
Response 200
{
  "pitDataBytes" : "string",
  "deltaLogBytes" : "string",
  "bytesAvailable" : "string",
  "mirrorRef" : "string",
  "id" : "string"
} ]

3.14.13. Retrieve the repository usage statistics for a single AmgMember.

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/pairs/{id}/repository-utilization
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

AsyncMirrorRepositoryUtilization

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/pairs/string/repository-utilization
Example HTTP response
Response 200
{
  "pitDataBytes" : "string",
  "deltaLogBytes" : "string",
  "bytesAvailable" : "string",
  "mirrorRef" : "string",
  "id" : "string"
}

3.14.14. Get an Async Mirror Group

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

Amg

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string
Example HTTP response
Response 200
{
  "groupRef" : "string",
  "worldWideName" : "string",
  "label" : "string",
  "groupState" : "string",
  "localRole" : "string",
  "remoteRole" : "string",
  "roleChangeProgress" : "string",
  "syncIntervalMinutes" : 0,
  "syncCompletionTimeAlertThresholdMinutes" : 0,
  "recoveryPointAgeAlertThresholdMinutes" : 0,
  "repositoryUtilizationWarnThreshold" : 0,
  "mirrorChannelRemoteTarget" : "string",
  "syncActivity" : "string",
  "orphanGroup" : true,
  "connectionType" : "string",
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "remoteTarget" : {
    "remoteRef" : "string",
    "nodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "scsiinitiatorTargetBaseProperties" : {
      "ioInterfaceType" : "string",
      "iscsiinitiatorTargetBaseParameters" : {
        "portals" : [ {
          "groupTag" : 0,
          "ipAddress" : {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          },
          "tcpListenPort" : 0
        } ]
      }
    }
  },
  "id" : "string"
}

3.14.15. Update an Async Mirror Group

POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

AsyncMirrorGroupUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

Amg

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string
Request body
{
  "name" : "string",
  "syncIntervalMinutes" : 0,
  "recoveryWarnThresholdMinutes" : 0,
  "repoUtilizationWarnThreshold" : 0,
  "syncWarnThresholdMinutes" : 0
}
Example HTTP response
Response 200
{
  "groupRef" : "string",
  "worldWideName" : "string",
  "label" : "string",
  "groupState" : "string",
  "localRole" : "string",
  "remoteRole" : "string",
  "roleChangeProgress" : "string",
  "syncIntervalMinutes" : 0,
  "syncCompletionTimeAlertThresholdMinutes" : 0,
  "recoveryPointAgeAlertThresholdMinutes" : 0,
  "repositoryUtilizationWarnThreshold" : 0,
  "mirrorChannelRemoteTarget" : "string",
  "syncActivity" : "string",
  "orphanGroup" : true,
  "connectionType" : "string",
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "remoteTarget" : {
    "remoteRef" : "string",
    "nodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "scsiinitiatorTargetBaseProperties" : {
      "ioInterfaceType" : "string",
      "iscsiinitiatorTargetBaseParameters" : {
        "portals" : [ {
          "groupTag" : 0,
          "ipAddress" : {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          },
          "tcpListenPort" : 0
        } ]
      }
    }
  },
  "id" : "string"
}

3.14.16. Delete an Async Mirror Group

DELETE /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string

3.14.17. Update the mirror role of an Async Mirror Group.

POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/role
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

AsyncMirrorGroupRoleUpdateRequest

Responses
HTTP Code Description Schema

204

StorageDevice role for AMG updated.

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/role
Request body
{
  "role" : "string",
  "noSync" : true,
  "force" : true
}

3.14.18. Get all Async Mirror Group Members

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/pairs
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< AmgMember > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/pairs
Example HTTP response
Response 200
{
  "memberRef" : "string",
  "mirrorGroup" : "string",
  "localVolume" : "string",
  "remoteVolume" : "string",
  "memberState" : "string",
  "lastRecoveryPointTime" : "string",
  "overUtilizationWarnThreshold" : true,
  "mirroredLocalCapacity" : "string",
  "repositoryVolume" : "string",
  "worldWideName" : "string",
  "volumeHandle" : 0,
  "repositoryFull" : true,
  "localVolumeName" : "string",
  "remoteVolumeName" : "string",
  "remoteVolumeInfo" : {
    "worldWideName" : "string",
    "remoteVolRef" : "string",
    "manager" : "string",
    "remoteArrayId" : {
      "worldWideName" : "string"
    },
    "remoteNodeWWN" : "string",
    "remoteVolWWN" : "string",
    "remoteVolUserLabel" : "string",
    "remoteVolState" : "string",
    "remoteVolCapacity" : "string",
    "volumeHandle" : 0,
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "remoteNodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "remoteVolSecurityType" : "string"
  },
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "totalSizeInBytes" : "string",
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "id" : "string"
} ]

3.14.19. Get a specific Async Mirror Group Member

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/pairs/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

AmgMember

404

AMG member was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/pairs/string
Example HTTP response
Response 200
{
  "memberRef" : "string",
  "mirrorGroup" : "string",
  "localVolume" : "string",
  "remoteVolume" : "string",
  "memberState" : "string",
  "lastRecoveryPointTime" : "string",
  "overUtilizationWarnThreshold" : true,
  "mirroredLocalCapacity" : "string",
  "repositoryVolume" : "string",
  "worldWideName" : "string",
  "volumeHandle" : 0,
  "repositoryFull" : true,
  "localVolumeName" : "string",
  "remoteVolumeName" : "string",
  "remoteVolumeInfo" : {
    "worldWideName" : "string",
    "remoteVolRef" : "string",
    "manager" : "string",
    "remoteArrayId" : {
      "worldWideName" : "string"
    },
    "remoteNodeWWN" : "string",
    "remoteVolWWN" : "string",
    "remoteVolUserLabel" : "string",
    "remoteVolState" : "string",
    "remoteVolCapacity" : "string",
    "volumeHandle" : 0,
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "remoteNodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "remoteVolSecurityType" : "string"
  },
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "totalSizeInBytes" : "string",
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "id" : "string"
}

3.14.20. Complete an incomplete Async Mirror relationship

POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/incomplete-pairs/{incompleteMirrorId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

incompleteMirrorId
required

string

Body

body
optional

AsyncMirrorGroupMemberCompletionRequest

Responses
HTTP Code Description Schema

200

successful operation

AmgMember

404

StorageDevice not found

422

Created AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/incomplete-pairs/string
Request body
{
  "secondaryPoolId" : "string",
  "secondaryVolumeRef" : "string",
  "scanMedia" : true,
  "validateRepositoryParity" : true,
  "secondaryPercentCapacity" : 0.0,
  "secondaryRepositoryCandidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  }
}
Example HTTP response
Response 200
{
  "memberRef" : "string",
  "mirrorGroup" : "string",
  "localVolume" : "string",
  "remoteVolume" : "string",
  "memberState" : "string",
  "lastRecoveryPointTime" : "string",
  "overUtilizationWarnThreshold" : true,
  "mirroredLocalCapacity" : "string",
  "repositoryVolume" : "string",
  "worldWideName" : "string",
  "volumeHandle" : 0,
  "repositoryFull" : true,
  "localVolumeName" : "string",
  "remoteVolumeName" : "string",
  "remoteVolumeInfo" : {
    "worldWideName" : "string",
    "remoteVolRef" : "string",
    "manager" : "string",
    "remoteArrayId" : {
      "worldWideName" : "string"
    },
    "remoteNodeWWN" : "string",
    "remoteVolWWN" : "string",
    "remoteVolUserLabel" : "string",
    "remoteVolState" : "string",
    "remoteVolCapacity" : "string",
    "volumeHandle" : 0,
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "remoteNodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "remoteVolSecurityType" : "string"
  },
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "totalSizeInBytes" : "string",
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "id" : "string"
}

3.14.21. Remove an Async Mirror relationship that has not been completed

DELETE /devmgr/v2/storage-systems/{system-id}/async-mirrors/incomplete-pairs/{incompleteMirrorId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

incompleteMirrorId
required

string

Responses
HTTP Code Description Schema

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/incomplete-pairs/string

3.14.22. Get Async Mirror Group relationships that have not yet been completed

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/incomplete-pairs/{mirror-id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

mirrorId
required

string

Responses
HTTP Code Description Schema

200

successful operation

< AmgIncompleteMember > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/incomplete-pairs/{mirror-id}
Example HTTP response
Response 200
{
  "memberRef" : "string",
  "groupRef" : "string",
  "primaryVolWWN" : "string",
  "primaryVolCapacity" : "string",
  "primaryVolRAIDLevel" : "string",
  "primaryVolProtectionType" : "string",
  "primaryVolSecurityType" : "string",
  "primaryVolUserLabel" : "string",
  "orphanIncompleteMember" : true,
  "primaryVolumeParameters" : {
    "volumeType" : "string",
    "capacityProvisioningDetails" : {
      "capacityQuota" : "string",
      "growthAlertThreshold" : 0,
      "repositoryExpansionPolicy" : "string"
    }
  },
  "primaryVolSecurityLevel" : "string",
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "id" : "string"
} ]

3.14.23. Get Async Mirror Group relationships that have not yet been completed

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/incomplete-pairs
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< AmgIncompleteMember > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/incomplete-pairs
Example HTTP response
Response 200
{
  "memberRef" : "string",
  "groupRef" : "string",
  "primaryVolWWN" : "string",
  "primaryVolCapacity" : "string",
  "primaryVolRAIDLevel" : "string",
  "primaryVolProtectionType" : "string",
  "primaryVolSecurityType" : "string",
  "primaryVolUserLabel" : "string",
  "orphanIncompleteMember" : true,
  "primaryVolumeParameters" : {
    "volumeType" : "string",
    "capacityProvisioningDetails" : {
      "capacityQuota" : "string",
      "growthAlertThreshold" : 0,
      "repositoryExpansionPolicy" : "string"
    }
  },
  "primaryVolSecurityLevel" : "string",
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "id" : "string"
} ]

3.14.24. Retrieve a member volume associated with an AMG

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirror-id}/pairs/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

mirror-id
required

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

AmgMember

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/pairs/string
Example HTTP response
Response 200
{
  "memberRef" : "string",
  "mirrorGroup" : "string",
  "localVolume" : "string",
  "remoteVolume" : "string",
  "memberState" : "string",
  "lastRecoveryPointTime" : "string",
  "overUtilizationWarnThreshold" : true,
  "mirroredLocalCapacity" : "string",
  "repositoryVolume" : "string",
  "worldWideName" : "string",
  "volumeHandle" : 0,
  "repositoryFull" : true,
  "localVolumeName" : "string",
  "remoteVolumeName" : "string",
  "remoteVolumeInfo" : {
    "worldWideName" : "string",
    "remoteVolRef" : "string",
    "manager" : "string",
    "remoteArrayId" : {
      "worldWideName" : "string"
    },
    "remoteNodeWWN" : "string",
    "remoteVolWWN" : "string",
    "remoteVolUserLabel" : "string",
    "remoteVolState" : "string",
    "remoteVolCapacity" : "string",
    "volumeHandle" : 0,
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "remoteNodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "remoteVolSecurityType" : "string"
  },
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "totalSizeInBytes" : "string",
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "id" : "string"
}

3.14.25. Remove a member from an Async Mirror Group

DELETE /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirror-id}/pairs/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

mirror-id
required

string

Path

id
required

string

Responses
HTTP Code Description Schema

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/pairs/string

3.14.26. Retrieve the member volumes associated with an AMG

GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirror-id}/pairs
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

mirror-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

< AmgMember > array

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/pairs
Example HTTP response
Response 200
{
  "memberRef" : "string",
  "mirrorGroup" : "string",
  "localVolume" : "string",
  "remoteVolume" : "string",
  "memberState" : "string",
  "lastRecoveryPointTime" : "string",
  "overUtilizationWarnThreshold" : true,
  "mirroredLocalCapacity" : "string",
  "repositoryVolume" : "string",
  "worldWideName" : "string",
  "volumeHandle" : 0,
  "repositoryFull" : true,
  "localVolumeName" : "string",
  "remoteVolumeName" : "string",
  "remoteVolumeInfo" : {
    "worldWideName" : "string",
    "remoteVolRef" : "string",
    "manager" : "string",
    "remoteArrayId" : {
      "worldWideName" : "string"
    },
    "remoteNodeWWN" : "string",
    "remoteVolWWN" : "string",
    "remoteVolUserLabel" : "string",
    "remoteVolState" : "string",
    "remoteVolCapacity" : "string",
    "volumeHandle" : 0,
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "remoteNodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "remoteVolSecurityType" : "string"
  },
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "totalSizeInBytes" : "string",
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "id" : "string"
} ]

3.14.27. Add a new member to an Async Mirror Group

POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirror-id}/pairs
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

mirror-id
required

string

Body

body
optional

AsyncMirrorGroupMemberCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

AmgMember

404

AMG was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/pairs
Request body
{
  "primaryPoolId" : "string",
  "secondaryPoolId" : "string",
  "primaryVolumeRef" : "string",
  "secondaryVolumeRef" : "string",
  "primaryRepositoryCandidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  },
  "secondaryRepositoryCandidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : "string",
        "usableSize" : "string",
        "driveCount" : 0,
        "freeExtentRef" : "string",
        "driveRefList" : {
          "driveRef" : [ "string" ]
        },
        "candidateSelectionType" : "string",
        "spindleSpeedMatch" : true,
        "spindleSpeed" : 0,
        "phyDriveType" : "string",
        "dssPreallocEnabled" : true,
        "securityType" : "string",
        "drawerLossProtection" : true,
        "driveMediaType" : "string",
        "protectionInformationCapable" : true,
        "protectionInformationCapabilities" : {
          "protectionInformationCapable" : true,
          "protectionType" : "string"
        },
        "volumeCandidateData" : {
          "type" : "string",
          "diskPoolVolumeCandidateData" : {
            "reconstructionReservedDriveCount" : 0,
            "reconstructionReservedAmt" : "string",
            "unusableCapacity" : "string"
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : "string"
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : "string"
    }
  },
  "scanMedia" : true,
  "validateRepositoryParity" : true,
  "percentCapacity" : 0.0,
  "secondaryPercentCapacity" : 0.0
}
Example HTTP response
Response 200
{
  "memberRef" : "string",
  "mirrorGroup" : "string",
  "localVolume" : "string",
  "remoteVolume" : "string",
  "memberState" : "string",
  "lastRecoveryPointTime" : "string",
  "overUtilizationWarnThreshold" : true,
  "mirroredLocalCapacity" : "string",
  "repositoryVolume" : "string",
  "worldWideName" : "string",
  "volumeHandle" : 0,
  "repositoryFull" : true,
  "localVolumeName" : "string",
  "remoteVolumeName" : "string",
  "remoteVolumeInfo" : {
    "worldWideName" : "string",
    "remoteVolRef" : "string",
    "manager" : "string",
    "remoteArrayId" : {
      "worldWideName" : "string"
    },
    "remoteNodeWWN" : "string",
    "remoteVolWWN" : "string",
    "remoteVolUserLabel" : "string",
    "remoteVolState" : "string",
    "remoteVolCapacity" : "string",
    "volumeHandle" : 0,
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "reserved1" : "string",
    "reserved2" : "string",
    "remoteNodeName" : {
      "ioInterfaceType" : "string",
      "iscsiNodeName" : "string",
      "remoteNodeWWN" : "string",
      "nvmeNodeName" : "string"
    },
    "remoteVolSecurityType" : "string"
  },
  "remoteTargetWwn" : "string",
  "remoteTargetName" : "string",
  "remoteTargetId" : "string",
  "totalSizeInBytes" : "string",
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "id" : "string"
}

3.14.28. Get Remote Volume Mirrors

GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< RemoteMirrorPair > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs
Example HTTP response
Response 200
{
  "base" : {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  },
  "target" : {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  },
  "baseArray" : "string",
  "targetArray" : "string",
  "id" : "string",
  "lastStartTime" : "string",
  "lastCompleteTime" : "string",
  "state" : 0,
  "priority" : 0,
  "writeMode" : 0,
  "autoResync" : true,
  "featureActive" : true,
  "status" : "string",
  "baseStatus" : "string",
  "targetStatus" : "string"
} ]

3.14.29. Create Remote Volume Mirror

POST /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

RemoteVolumeMirrorCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

RemoteMirrorPair

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs
Request body
{
  "srcVolID" : "string",
  "tgtVolWWN" : "string",
  "remoteArrayId" : "string",
  "copyType" : 0,
  "priority" : 0,
  "autoResync" : true
}
Example HTTP response
Response 200
{
  "base" : {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  },
  "target" : {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  },
  "baseArray" : "string",
  "targetArray" : "string",
  "id" : "string",
  "lastStartTime" : "string",
  "lastCompleteTime" : "string",
  "state" : 0,
  "priority" : 0,
  "writeMode" : 0,
  "autoResync" : true,
  "featureActive" : true,
  "status" : "string",
  "baseStatus" : "string",
  "targetStatus" : "string"
}

3.14.30. Get Remote Volume Mirror

GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

RemoteMirrorPair

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/string
Example HTTP response
Response 200
{
  "base" : {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  },
  "target" : {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  },
  "baseArray" : "string",
  "targetArray" : "string",
  "id" : "string",
  "lastStartTime" : "string",
  "lastCompleteTime" : "string",
  "state" : 0,
  "priority" : 0,
  "writeMode" : 0,
  "autoResync" : true,
  "featureActive" : true,
  "status" : "string",
  "baseStatus" : "string",
  "targetStatus" : "string"
}

3.14.31. Update a Remote Volume Mirror

POST /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

RemoteVolumeMirrorUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

RemoteMirrorPair

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/string
Request body
{
  "baseVolumeId" : "string",
  "remoteVolumeId" : "string",
  "role" : 0,
  "updateType" : "string",
  "priority" : 0,
  "writeMode" : 0,
  "autoResync" : true
}
Example HTTP response
Response 200
{
  "base" : {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  },
  "target" : {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  },
  "baseArray" : "string",
  "targetArray" : "string",
  "id" : "string",
  "lastStartTime" : "string",
  "lastCompleteTime" : "string",
  "state" : 0,
  "priority" : 0,
  "writeMode" : 0,
  "autoResync" : true,
  "featureActive" : true,
  "status" : "string",
  "baseStatus" : "string",
  "targetStatus" : "string"
}

3.14.32. Remove a Remote Volume Mirror

DELETE /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Removal was successful

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/string

3.14.33. Test Remote Mirror Communication

GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/test-remote-mirror-communication/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

RemoteCommunicationData

404

Remote mirror not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/test-remote-mirror-communication/string
Example HTTP response
Response 200
{
  "samples" : [ 0 ],
  "timeout" : 0,
  "status" : 0
}

3.14.34. Get Remote Mirror synchronization status

GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/mirror-sync-progress/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

JobProgress

404

Remote mirror not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/mirror-sync-progress/string
Example HTTP response
Response 200
{
  "objectId" : "string",
  "percentComplete" : 0
}

3.14.35. Retrieve potential mirror candidates for a volume

GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/remote-mirror-target-candidates/{volumeId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

volumeId
required

string

Responses
HTTP Code Description Schema

200

successful operation

< RemoteMirrorCandidate > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/remote-mirror-target-candidates/string
Example HTTP response
Response 200
{
  "sourceVolume" : {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  },
  "targetVolumes" : [ {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "volumeUse" : "string",
    "volumeFull" : true,
    "volumeCopyTarget" : true,
    "volumeCopySource" : true,
    "pitBaseVolume" : true,
    "asyncMirrorTarget" : true,
    "asyncMirrorSource" : true,
    "remoteMirrorSource" : true,
    "remoteMirrorTarget" : true,
    "diskPool" : true,
    "flashCached" : true,
    "increasingBy" : "string",
    "metadata" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "dataAssurance" : true,
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "cacheSettings" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "onlineVolumeCopy" : true,
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string",
    "thinProvisioned" : true
  } ],
  "targetArrayName" : "string",
  "targetArrayId" : "string"
} ]

3.15. Monitoring

3.15.1. Get a list of audit log messages.

GET /devmgr/v2/storage-systems/{system-id}/audit-log
Description

Mode: Both Embedded only.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

startRecordOrdinal
optional

Starting record ordinal

integer (int32)

Query

endingRecordOrdinal
optional

Ending record ordinal

integer (int32)

Query

beginDate
optional

Beginning date

integer (int64)

Query

endDate
optional

Ending date

integer (int64)

Query

file
optional

Return CSV file

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

AuditLogGetResponse

404

StorageDevice not found

422

Invalid Parameter

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/octet-stream

  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/audit-log
Request query
{
  "startRecordOrdinal" : 0,
  "endingRecordOrdinal" : 0,
  "beginDate" : 0,
  "endDate" : 0,
  "file" : true
}
Example HTTP response
Response 200
{
  "totalLogRecords" : 0,
  "logRecords" : [ {
    "method" : "string",
    "accessedUrl" : "string",
    "clientIp" : "string",
    "userId" : "string",
    "httpStatus" : 0,
    "httpReasonPhrase" : "string",
    "isFederated" : true,
    "loggingAgent" : "string",
    "cliCommandExecuted" : "string",
    "cliReturnStatus" : "string",
    "symbolProcedure" : "string",
    "sshEventType" : "string",
    "sshSessionPid" : 0,
    "sshSessionDuration" : 0,
    "timestamp" : "string",
    "recordOrdinal" : 0,
    "optionalText" : "string"
  } ],
  "firstRecordOrdinal" : 0,
  "lastRecordOrdinal" : 0
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.15.2. Delete specified subset or all audit log messages.

DELETE /devmgr/v2/storage-systems/{system-id}/audit-log
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

retentionCount
optional

Number of records to preserve within the log

integer (int32)

Query

endDate
optional

Ending record date to delete

integer (int64)

Query

clearAll
optional

Clear all records

boolean

Responses
HTTP Code Description Schema

200

successful operation

AuditLogDeleteResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/audit-log
Request query
{
  "retentionCount" : 0,
  "endDate" : 0,
  "clearAll" : true
}
Example HTTP response
Response 200
{
  "totalDeletedRecords" : 0
}

3.15.3. Get audit log metadata.

GET /devmgr/v2/storage-systems/{system-id}/audit-log/info
Description

Mode: Both Embedded only.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

AuditLogInfoResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/audit-log/info
Example HTTP response
Response 200
{
  "totalLogRecords" : 0,
  "firstRecordTimestamp" : "string",
  "lastRecordTimestamp" : "string"
}

3.15.4. Get the current audit log configuration.

GET /devmgr/v2/storage-systems/{system-id}/audit-log/config
Description

Mode: Both Embedded only.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

AuditLogConfiguration

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/audit-log/config
Example HTTP response
Response 200
{
  "auditLogMaxRecords" : 0,
  "auditLogLevel" : "string",
  "auditLogFullPolicy" : "string",
  "auditLogWarningThresholdPct" : 0
}

3.15.5. Updates the audit long configuration.

POST /devmgr/v2/storage-systems/{system-id}/audit-log/config
Description

Mode: Both Embedded only.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

AuditLogConfiguration

Responses
HTTP Code Description Schema

200

successful operation

AuditLogConfiguration

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/audit-log/config
Request body
{
  "auditLogMaxRecords" : 0,
  "auditLogLevel" : "string",
  "auditLogFullPolicy" : "string",
  "auditLogWarningThresholdPct" : 0
}
Example HTTP response
Response 200
{
  "auditLogMaxRecords" : 0,
  "auditLogLevel" : "string",
  "auditLogFullPolicy" : "string",
  "auditLogWarningThresholdPct" : 0
}

3.15.6. Get the list of status Events for the StorageDevice

GET /devmgr/v2/storage-systems/{system-id}/events
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

lastKnown
optional

integer (int64)

-1

Query

wait
optional

Amount of time to wait for a new event

integer (int32)

30

Responses
HTTP Code Description Schema

200

successful operation

< Event > array

404

StorageDevice not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/events
Request query
{
  "lastKnown" : 0,
  "wait" : 0
}
Example HTTP response
Response 200
{
  "timestamp" : "string",
  "eventNumber" : "string",
  "eventType" : "string"
} ]

3.15.7. Get all global status events

GET /devmgr/v2/events
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Query

lastKnown
optional

The sequence number of the last event you have received

integer (int64)

-1

Query

wait
optional

seconds to wait for a new event

integer (int32)

30

Responses
HTTP Code Description Schema

200

successful operation

< Event > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/events
Request query
{
  "lastKnown" : 0,
  "wait" : 0
}
Example HTTP response
Response 200
{
  "timestamp" : "string",
  "eventNumber" : "string",
  "eventType" : "string"
} ]

3.15.8. Get a list of log messages for a component.

GET /devmgr/v2/storage-systems/{system-id}/service-logs
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

loggerType
optional

LoggerType to retrieve records for

enum (cfwUpgradeLogger, driveUpgradeLogger, iomServiceLogger, nvsramUpgradeLogger, cfwUpgradeTimestamp, driveUpgradeTimestamp, iomServiceTimestamp, nvsramUpgradeTimestamp)

"cfwUpgradeLogger"

Query

startRecord
optional

Starting record number

integer (int32)

0

Query

endingRecord
optional

Ending record number

integer (int32)

50

Responses
HTTP Code Description Schema

200

successful operation

LoggerRecordResponse

404

StorageDevice not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/service-logs
Request query
{
  "loggerType" : "string",
  "startRecord" : 0,
  "endingRecord" : 0
}
Example HTTP response
Response 200
{
  "recordType" : "string",
  "logRecords" : [ {
    "loggerType" : "string",
    "timestamp" : "string",
    "messageText" : "string",
    "context" : "string",
    "recordId" : "string"
  } ],
  "timeStamps" : {
    "string" : "string"
  }
}

3.15.9. Retrieve MelEvents

GET /devmgr/v2/storage-systems/{system-id}/mel-events
Description

This operation may take a substantial amount of time to return large numbers of events. In this case, the client may timeout. To avoid this, either the number of events to be retrieved should be reduced and multiple requests made, or the client-side timeout should be increased.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

startSequenceNumber
optional

The starting sequence number for the MEL events to be retrieved. If this value is set to a negative value then the events will be retrieved starting with the most recent event that was logged and then working backwards based on what the count value is set to.

integer (int32)

-1

Query

count
optional

Maximum number of events to retrieve

integer (int32)

100

Query

critical
optional

Only retrieve events classified as critical

boolean

"false"

Query

includeDebug
optional

Whether or not to retrieve debug entries

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

< MelEntryEx > array

404

StorageDevice not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mel-events
Request query
{
  "startSequenceNumber" : 0,
  "count" : 0,
  "critical" : true,
  "includeDebug" : true
}
Example HTTP response
Response 200
{
  "sequenceNumber" : "string",
  "eventType" : 0,
  "timeStamp" : "string",
  "category" : "string",
  "componentType" : "string",
  "componentLocation" : {
    "eventComponentType" : "string",
    "alarmLocation" : {
      "tray" : 0,
      "slot" : 0
    },
    "batteryTray" : 0,
    "cacheBackupDeviceLocation" : {
      "controllerTray" : 0,
      "controllerSlot" : 0,
      "cacheBackupDeviceSlot" : 0
    },
    "cacheMemoryDimmLocation" : {
      "controllerTray" : 0,
      "controllerSlot" : 0,
      "cacheMemoryDimmControllerSlot" : 0
    },
    "channelLoc" : {
      "channelType" : "string",
      "index" : 0,
      "controllerSlot" : 0
    },
    "channelPort" : 0,
    "chipLoc" : {
      "tray" : 0,
      "slot" : 0
    },
    "controllerLoc" : {
      "tray" : 0,
      "slot" : 0
    },
    "ctlrSfpLocation" : {
      "channelType" : "string",
      "channel" : 0,
      "sfpPort" : 0,
      "controllerSlot" : 0
    },
    "socLocation" : {
      "channelType" : "string",
      "channel" : 0,
      "soc" : 0,
      "port" : 0,
      "controllerSlot" : 0
    },
    "driveLoc" : {
      "tray" : 0,
      "slot" : 0
    },
    "enclosureTray" : 0,
    "esmTray" : 0,
    "fanTray" : 0,
    "hostIoCardLocation" : {
      "controllerTray" : 0,
      "controllerSlot" : 0,
      "hostIoCardControllerSlot" : 0
    },
    "initiatorLocation" : {
      "initiatorName" : "string"
    },
    "interconnectCruLocation" : {
      "tray" : 0,
      "slot" : 0
    },
    "isnsServerLocation" : {
      "ipAddress" : {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      },
      "tcpListenPort" : 0
    },
    "minihubLoc" : {
      "minihubType" : "string",
      "channel" : 0,
      "controllerSlot" : 0,
      "tray" : 0
    },
    "portCruTray" : 0,
    "powerSupplyTray" : 0,
    "sfpLocation" : {
      "tray" : 0,
      "slot" : 0
    },
    "supportCruLocation" : {
      "tray" : 0,
      "slot" : 0
    },
    "targetLocation" : {
      "targetName" : "string"
    },
    "tempSensorTray" : 0,
    "label" : "string",
    "groupNumber" : 0,
    "hostLocation" : "string",
    "hostPortLocation" : {
      "ioInterfaceType" : "string",
      "fcPortName" : "string",
      "ibPortName" : "string",
      "sasPortName" : "string"
    },
    "drawerLocation" : {
      "tray" : 0,
      "slot" : 0
    },
    "componentRelativeLocation" : {
      "componentType" : "string",
      "trayId" : 0,
      "relativePosition" : 0,
      "parentSize" : 0,
      "parent" : [ {
        "componentType" : "string",
        "relativePosition" : 0
      } ],
      "componentLabel" : "string"
    },
    "schedule" : "string",
    "diskPool" : 0,
    "asyncMirrorGroup" : "string",
    "pitLabel" : "string",
    "cgLabel" : "string",
    "cgPitLabel" : "string",
    "cgViewLabel" : "string",
    "flashCacheLabel" : "string",
    "communityNameString" : "string",
    "destinationIpAddress" : "string",
    "fcTargetLocation" : {
      "targetName" : "string"
    },
    "fanCruLocation" : {
      "tray" : 0,
      "slot" : 0
    },
    "powerSupplyCruLocation" : {
      "tray" : 0,
      "slot" : 0
    },
    "nvmeInitiatorLocation" : {
      "initiatorName" : "string"
    }
  },
  "locationValid" : true,
  "priority" : "string",
  "eventSourceController" : 0,
  "senseKey" : 0,
  "rawData" : "string",
  "extComponentLocation" : {
    "extLocType" : "string",
    "compChannelLoc" : {
      "channelType" : "string",
      "index" : 0,
      "controllerSlot" : 0
    },
    "compMinihubLoc" : {
      "minihubType" : "string",
      "channel" : 0,
      "controllerSlot" : 0,
      "tray" : 0
    },
    "compTray" : 0,
    "compTraySlot" : {
      "tray" : 0,
      "slot" : 0
    },
    "compLabel" : "string",
    "pitSequence" : "string",
    "compReference" : "string",
    "controllerReference" : "string",
    "locationLabel" : "string",
    "volumeGroupLabel" : "string",
    "diskPoolLabel" : "string"
  },
  "controlParams" : {
    "oemPriority" : "string",
    "defaultNeedsAttention" : true,
    "defaultSendAlert" : true,
    "defaultVisibility" : true,
    "oemNeedsAttention" : "string",
    "oemSendAlert" : "string",
    "oemVisibility" : "string",
    "collectSupportBundle" : true,
    "priorityCaseCreationTrigger" : true
  },
  "description" : "string",
  "location" : "string",
  "id" : "string",
  "critical" : true,
  "asc" : 0,
  "ascq" : 0
} ]

3.15.10. Clear all MEL events

DELETE /devmgr/v2/storage-systems/{system-id}/mel-events
Description

Gives the user the ability to clear the event cache and the event log directly on the StorageDevice.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

clearCache
optional

boolean

"false"

Query

resetMel
optional

Reset the EventLog on the StorageDevice

boolean

"true"

Responses
HTTP Code Description Schema

204

Successfully cleared

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mel-events
Request query
{
  "clearCache" : true,
  "resetMel" : true
}

3.15.11. Check the oldest and newest available events

GET /devmgr/v2/storage-systems/{system-id}/mel-events/available
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

cacheOnly
optional

Only retrieve events currently in the cache

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

MelExtent

404

StorageDevice not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mel-events/available
Request query
{
  "cacheOnly" : true
}
Example HTTP response
Response 200
{
  "startingSeqNum" : "string",
  "endingSeqNum" : "string"
}

3.16. Security

3.16.1. Retrieves the specified certificate file

GET /devmgr/v2/storage-systems/{system-id}/external-key-server/certificate
Description

This API is designed to return a file. It will only return a content-type of application/json in cases where the file retrieval did not succeed.
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

certificateType
required

Type of certificate being retrieved

enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED)

Responses
HTTP Code Description Schema

200

successful operation

file

404

Storage device not found

422

Cannot retrieve certificate file

CallResponse

Consumes
  • application/json

Produces
  • application/octet-stream

  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/certificate
Request query
{
  "certificateType" : "string"
}
Example HTTP response
Response 200
"file"
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.16.2. Install a KMS Certificate or a certificate in a chain

POST /devmgr/v2/storage-systems/{system-id}/external-key-server/certificate
Description

This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

certificateType
required

Type of certificate being installed

enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED)

FormData

file
optional

certificate file

file

Responses
HTTP Code Description Schema

204

The certificate file was installed successfully

404

Storage Device not found

422

Unable to install certificate

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/certificate
Request query
{
  "certificateType" : "string"
}
Request formData
"file"
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.16.3. Removes the specified certificate type

DELETE /devmgr/v2/storage-systems/{system-id}/external-key-server/certificate
Description

This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

certificateType
required

Type of certificate being removed

enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED)

Responses
HTTP Code Description Schema

204

The specified certificate type was removed

404

Storage device not found

422

Unable to remove the specified certificate type

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/certificate
Request query
{
  "certificateType" : "string"
}
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.16.4. Verify the storage system is able to communicate with the KMS server

POST /devmgr/v2/storage-systems/{system-id}/external-key-server/test
Description

This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

EKMSCommunicationResponse

404

StorageDevice not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/test
Example HTTP response
Response 200
{
  "successful" : true,
  "returnCode" : "string"
}

3.16.5. Retrieves the details for the certificate files on the system as well as the associated Key Management Server IP and port.

GET /devmgr/v2/storage-systems/{system-id}/external-key-server
Description

This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

X509ExternalCertInfo

404

Storage device not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server
Example HTTP response
Response 200
{
  "kmsAddress" : {
    "addrType" : "string",
    "domainName" : "string",
    "ipvxAddress" : {
      "addressType" : "string",
      "ipv4Address" : "string",
      "ipv6Address" : "string"
    }
  },
  "kmsPort" : 0,
  "clientKmsType" : "string",
  "clientSubjectDN" : "string",
  "clientIssuerDN" : "string",
  "clientStart" : "string",
  "clientExpire" : "string",
  "serverKmsType" : "string",
  "serverSubjectDN" : "string",
  "serverIssuerDN" : "string",
  "serverStart" : "string",
  "serverExpire" : "string"
}

3.16.6. Sets (enables/updates) the key server information

POST /devmgr/v2/storage-systems/{system-id}/external-key-server
Description

This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

EnableExternalKeyServerRequest

Responses
HTTP Code Description Schema

204

The key server information was updated successfully

404

Storage device not found

422

Unable to update the key server information

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server
Request body
{
  "keyServerAddress" : {
    "addrType" : "string",
    "domainName" : "string",
    "ipvxAddress" : {
      "addressType" : "string",
      "ipv4Address" : "string",
      "ipv6Address" : "string"
    }
  },
  "port" : 0
}
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.16.7. Enables, disables or changes the external security key on the storage system

POST /devmgr/v2/storage-systems/{system-id}/external-key-server/security-key
Description

If the ekmsOption field is set to enable, the storage array will communicate with the KMS server to obtain a security key and install it on the storage system. In order for this to be successful, the following things must first occur:

  1. The KMS server IP and port must be set

  2. A CSR must be generated and uploaded to the KMS server to retrieve the client certificate

  3. Both the client and server certificates need to be installed on the storage system

If the ekmsOption field is set to disable and external key management is currently enabled, the storage array will switch to internal key management and a new security key will be generated on the storage system.

If the ekmsOption is set to changeKey and external key management is currently enabled, a new security key will be generated on the storage system to replace the existing key.

This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

EnableDisableEkmsRequest

Responses
HTTP Code Description Schema

200

successful operation

SecureVolumeExternalKeyResponse

404

Storage device not found

422

Cannot complete the requested action.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/security-key
Request body
{
  "passPhrase" : "string",
  "ekmsOption" : "string"
}
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileID" : "string",
  "fileURL" : "string",
  "lockKeyId" : "string"
}

3.16.8. Request a certificate signing request for a client side certificate used to validate with the external key server

POST /devmgr/v2/storage-systems/{system-id}/external-key-server/certificate/csr
Description

This will return the ID for the file (for use with other endpoints) and a URL (can be used directly).
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

ExternalKeyManagerCSR

Responses
HTTP Code Description Schema

200

successful operation

PrivateFileInfo

404

StorageDevice not found

422

The certificate signing request could not be generated

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/certificate/csr
Request body
{
  "commonName" : "string",
  "organizationName" : "string",
  "organizationalUnitName" : "string",
  "localityName" : "string",
  "stateProvinceName" : "string",
  "countryName" : "string"
}
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileID" : "string",
  "fileURL" : "string"
}

3.16.9. Export a full disk encryption key

GET /devmgr/v2/storage-systems/{system-id}/security-key/export
Caution

operation.deprecated

Description

The response type of this method is a file stream. This endpoint has been deprecated. The following endpoint should instead be used: POST:/storage-systems/{system-id}/security-key/export

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

passPhrase
optional

Pass phrase

string

Query

fileName
optional

File name

string

Responses
HTTP Code Description Schema

200

successful operation

file

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/octet-stream

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/security-key/export
Request query
{
  "passPhrase" : "string",
  "fileName" : "string"
}
Example HTTP response
Response 200
"file"

3.16.10. Request a full disk encryption key file

POST /devmgr/v2/storage-systems/{system-id}/security-key/export
Description

This will return the ID for the security key file (for use with other endpoints) and a URL which can be used to directly access the file.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SecurityKeyFileRequest

Responses
HTTP Code Description Schema

200

successful operation

PrivateFileInfo

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/security-key/export
Request body
{
  "fileName" : "string",
  "passPhrase" : "string"
}
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileID" : "string",
  "fileURL" : "string"
}

3.16.11. Import a full disk encryption key

POST /devmgr/v2/storage-systems/{system-id}/security-key/import
Description

Use secure pass phrase for additional security instead of pass phrase.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

passPhrase
optional

Pass phrase

string

FormData

keyfile
optional

file

file

FormData

securePassPhrase
optional

Secure pass phrase

string

Responses
HTTP Code Description Schema

200

The key was successfully imported

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/security-key/import
Request query
{
  "passPhrase" : "string"
}
Request formData
"string"

3.16.12. Create or change a full disk encryption key

POST /devmgr/v2/storage-systems/{system-id}/security-key
Description

The result of this method is the creation of a new key file. Retrieve with the /file/{filename} endpoint.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SecureVolumeKeyRequest

Responses
HTTP Code Description Schema

200

successful operation

SecureVolumeKeyResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/security-key
Request body
{
  "lockKeyId" : "string",
  "passPhrase" : "string",
  "setLockKey" : true
}
Example HTTP response
Response 200
{
  "fileSize" : "string",
  "fileName" : "string",
  "lockKeyId" : "string"
}

3.16.13. Validate a full disk encryption key

POST /devmgr/v2/storage-systems/{system-id}/security-key/validate
Description

Use secure pass phrase for additional security instead of pass phrase.

MetaData

x-mode = both
x-allowedRoles = [root.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

passPhrase
optional

Pass phrase

string

FormData

keyfile
required

file

file

FormData

securePassPhrase
optional

Secure pass phrase

string

Responses
HTTP Code Description Schema

200

The key is valid

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/security-key/validate
Request query
{
  "passPhrase" : "string"
}
Request formData
"string"

3.17. Service-Catalog

3.17.1. Retrieve the list of volumes

GET /devmgr/v2/storage-systems/{system-id}/ssc/volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< UserVolume > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/volumes
Example HTTP response
Response 200
{
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "flashCached" : true,
  "dataAssurance" : true,
  "protectionType" : "string",
  "thinProvisioned" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
} ]

3.17.2. Define a new volume and configure its QOS parameters

POST /devmgr/v2/storage-systems/{system-id}/ssc/volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

SscVolumeCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

UserVolume

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/volumes
Request body
{
  "poolId" : "string",
  "name" : "string",
  "sizeUnit" : "gb",
  "size" : "string",
  "readCacheEnable" : true,
  "writeCacheEnable" : true,
  "flashCacheEnable" : false,
  "dataAssuranceEnable" : false,
  "thinProvision" : false,
  "metaTags" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "flashCached" : true,
  "dataAssurance" : true,
  "protectionType" : "string",
  "thinProvisioned" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.17.3. Retrieve a volume by id or label

GET /devmgr/v2/storage-systems/{system-id}/ssc/volumes/{volumeId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

volumeId
required

string

Responses
HTTP Code Description Schema

200

successful operation

UserVolume

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/volumes/string
Example HTTP response
Response 200
{
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "flashCached" : true,
  "dataAssurance" : true,
  "protectionType" : "string",
  "thinProvisioned" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.17.4. Update an existing volume

POST /devmgr/v2/storage-systems/{system-id}/ssc/volumes/{volumeId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

volumeId
required

string

Body

body
optional

SscVolumeUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

UserVolume

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/volumes/string
Request body
{
  "name" : "string",
  "newSize" : "string",
  "sizeUnit" : "gb",
  "flashCache" : true,
  "owningControllerId" : "string",
  "readCacheEnable" : true,
  "writeCacheEnable" : true,
  "scanSettings" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "metaTags" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "flashCached" : true,
  "dataAssurance" : true,
  "protectionType" : "string",
  "thinProvisioned" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.17.5. Delete a volume by id or label

DELETE /devmgr/v2/storage-systems/{system-id}/ssc/volumes/{volumeId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

volumeId
required

string

Responses
HTTP Code Description Schema

204

Delete was successful

404

StorageDevice not found

CallResponse

424

StorageDevice offline

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/volumes/string
Example HTTP response
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}
Response 424
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.17.6. Retrieve the list of pools

GET /devmgr/v2/storage-systems/{system-id}/ssc/pools
Description

Retrieve the list of pools and their service quality features. The list is sorted in descending order by the largest block of freeSpace that each has available.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< PoolQosResponse > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/pools
Example HTTP response
Response 200
{
  "poolId" : "string",
  "name" : "string",
  "pool" : {
    "sequenceNum" : 0,
    "offline" : true,
    "raidLevel" : "string",
    "worldWideName" : "string",
    "volumeGroupRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string",
    "trayLossProtection" : true,
    "label" : "string",
    "state" : "string",
    "spindleSpeedMatch" : true,
    "spindleSpeed" : 0,
    "isInaccessible" : true,
    "securityType" : "string",
    "drawerLossProtection" : true,
    "protectionInformationCapable" : true,
    "protectionInformationCapabilities" : {
      "protectionInformationCapable" : true,
      "protectionType" : "string"
    },
    "volumeGroupData" : {
      "type" : "string",
      "diskPoolData" : {
        "reconstructionReservedDriveCount" : 0,
        "reconstructionReservedAmt" : "string",
        "reconstructionReservedDriveCountCurrent" : 0,
        "poolUtilizationWarningThreshold" : 0,
        "poolUtilizationCriticalThreshold" : 0,
        "poolUtilizationState" : "string",
        "unusableCapacity" : "string",
        "degradedReconstructPriority" : "string",
        "criticalReconstructPriority" : "string",
        "backgroundOperationPriority" : "string",
        "allocGranularity" : "string",
        "minimumDriveCount" : 0
      }
    },
    "usage" : "string",
    "driveBlockFormat" : "string",
    "reservedSpaceAllocated" : true,
    "securityLevel" : "string",
    "usedSpace" : "string",
    "totalRaidedSpace" : "string",
    "extents" : [ {
      "sectorOffset" : "string",
      "rawCapacity" : "string",
      "raidLevel" : "string",
      "volumeGroupRef" : "string",
      "freeExtentRef" : "string",
      "reserved1" : "string",
      "reserved2" : "string"
    } ],
    "largestFreeExtentSize" : "string",
    "raidStatus" : "string",
    "freeSpace" : "string",
    "drivePhysicalType" : "string",
    "driveMediaType" : "string",
    "normalizedSpindleSpeed" : "string",
    "id" : "string",
    "diskPool" : true,
    "name" : "string"
  },
  "flashCacheCapable" : true,
  "dataAssuranceCapable" : true,
  "encrypted" : true,
  "thinProvisioningCapable" : true,
  "spindleSpeed" : "string",
  "raidLevel" : "string",
  "availableFreeExtentCapacities" : [ "string" ]
} ]

3.17.7. Retrieve a pool by name or ID

GET /devmgr/v2/storage-systems/{system-id}/ssc/pools/{poolId}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

poolId
required

string

Responses
HTTP Code Description Schema

200

successful operation

PoolQosResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/pools/string
Example HTTP response
Response 200
{
  "poolId" : "string",
  "name" : "string",
  "pool" : {
    "sequenceNum" : 0,
    "offline" : true,
    "raidLevel" : "string",
    "worldWideName" : "string",
    "volumeGroupRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string",
    "trayLossProtection" : true,
    "label" : "string",
    "state" : "string",
    "spindleSpeedMatch" : true,
    "spindleSpeed" : 0,
    "isInaccessible" : true,
    "securityType" : "string",
    "drawerLossProtection" : true,
    "protectionInformationCapable" : true,
    "protectionInformationCapabilities" : {
      "protectionInformationCapable" : true,
      "protectionType" : "string"
    },
    "volumeGroupData" : {
      "type" : "string",
      "diskPoolData" : {
        "reconstructionReservedDriveCount" : 0,
        "reconstructionReservedAmt" : "string",
        "reconstructionReservedDriveCountCurrent" : 0,
        "poolUtilizationWarningThreshold" : 0,
        "poolUtilizationCriticalThreshold" : 0,
        "poolUtilizationState" : "string",
        "unusableCapacity" : "string",
        "degradedReconstructPriority" : "string",
        "criticalReconstructPriority" : "string",
        "backgroundOperationPriority" : "string",
        "allocGranularity" : "string",
        "minimumDriveCount" : 0
      }
    },
    "usage" : "string",
    "driveBlockFormat" : "string",
    "reservedSpaceAllocated" : true,
    "securityLevel" : "string",
    "usedSpace" : "string",
    "totalRaidedSpace" : "string",
    "extents" : [ {
      "sectorOffset" : "string",
      "rawCapacity" : "string",
      "raidLevel" : "string",
      "volumeGroupRef" : "string",
      "freeExtentRef" : "string",
      "reserved1" : "string",
      "reserved2" : "string"
    } ],
    "largestFreeExtentSize" : "string",
    "raidStatus" : "string",
    "freeSpace" : "string",
    "drivePhysicalType" : "string",
    "driveMediaType" : "string",
    "normalizedSpindleSpeed" : "string",
    "id" : "string",
    "diskPool" : true,
    "name" : "string"
  },
  "flashCacheCapable" : true,
  "dataAssuranceCapable" : true,
  "encrypted" : true,
  "thinProvisioningCapable" : true,
  "spindleSpeed" : "string",
  "raidLevel" : "string",
  "availableFreeExtentCapacities" : [ "string" ]
}

3.18. Statistics

3.18.1. Get all analysed disk statistics

GET /devmgr/v2/storage-systems/{system-id}/analysed-drive-statistics
Description

This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< AnalysedDiskStatistics > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-drive-statistics
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "readIOps" : 0.0,
  "writeIOps" : 0.0,
  "otherIOps" : 0.0,
  "combinedIOps" : 0.0,
  "readThroughput" : 0.0,
  "writeThroughput" : 0.0,
  "combinedThroughput" : 0.0,
  "readResponseTime" : 0.0,
  "readResponseTimeStdDev" : 0.0,
  "writeResponseTime" : 0.0,
  "writeResponseTimeStdDev" : 0.0,
  "combinedResponseTime" : 0.0,
  "combinedResponseTimeStdDev" : 0.0,
  "averageReadOpSize" : 0.0,
  "averageWriteOpSize" : 0.0,
  "readOps" : 0.0,
  "writeOps" : 0.0,
  "diskId" : "string",
  "readPhysicalIOps" : 0.0,
  "writePhysicalIOps" : 0.0,
  "readTimeMax" : 0.0,
  "writeTimeMax" : 0.0,
  "queueDepthMax" : 0.0,
  "averageQueueDepth" : 0.0,
  "randomIosPercent" : 0.0,
  "randomBytesPercent" : 0.0
} ]

3.18.2. Get a subset of analysed disk statistics

GET /devmgr/v2/storage-systems/{system-id}/analysed-drive-statistics/{idlist}
Description

This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of disk ids

< string > array(csv)

Responses
HTTP Code Description Schema

200

successful operation

< AnalysedDiskStatistics > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-drive-statistics/string
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "readIOps" : 0.0,
  "writeIOps" : 0.0,
  "otherIOps" : 0.0,
  "combinedIOps" : 0.0,
  "readThroughput" : 0.0,
  "writeThroughput" : 0.0,
  "combinedThroughput" : 0.0,
  "readResponseTime" : 0.0,
  "readResponseTimeStdDev" : 0.0,
  "writeResponseTime" : 0.0,
  "writeResponseTimeStdDev" : 0.0,
  "combinedResponseTime" : 0.0,
  "combinedResponseTimeStdDev" : 0.0,
  "averageReadOpSize" : 0.0,
  "averageWriteOpSize" : 0.0,
  "readOps" : 0.0,
  "writeOps" : 0.0,
  "diskId" : "string",
  "readPhysicalIOps" : 0.0,
  "writePhysicalIOps" : 0.0,
  "readTimeMax" : 0.0,
  "writeTimeMax" : 0.0,
  "queueDepthMax" : 0.0,
  "averageQueueDepth" : 0.0,
  "randomIosPercent" : 0.0,
  "randomBytesPercent" : 0.0
} ]

3.18.3. Get a subset of analysed volume statistics

GET /devmgr/v2/storage-systems/{system-id}/analysed-volume-statistics/{idlist}
Description

This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of volume ids

string

Responses
HTTP Code Description Schema

200

successful operation

< AnalysedVolumeStatistics > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-volume-statistics/string
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "readIOps" : 0.0,
  "writeIOps" : 0.0,
  "otherIOps" : 0.0,
  "combinedIOps" : 0.0,
  "readThroughput" : 0.0,
  "writeThroughput" : 0.0,
  "combinedThroughput" : 0.0,
  "readResponseTime" : 0.0,
  "readResponseTimeStdDev" : 0.0,
  "writeResponseTime" : 0.0,
  "writeResponseTimeStdDev" : 0.0,
  "combinedResponseTime" : 0.0,
  "combinedResponseTimeStdDev" : 0.0,
  "averageReadOpSize" : 0.0,
  "averageWriteOpSize" : 0.0,
  "readOps" : 0.0,
  "writeOps" : 0.0,
  "volumeId" : "string",
  "volumeName" : "string",
  "poolId" : "string",
  "controllerId" : "string",
  "workLoadId" : "string",
  "mapped" : true,
  "readHitOps" : 0.0,
  "readHitResponseTime" : 0.0,
  "readHitResponseTimeStdDev" : 0.0,
  "readHitBytes" : 0.0,
  "writeHitBytes" : 0.0,
  "writeHitOps" : 0.0,
  "writeHitResponseTime" : 0.0,
  "writeHitResponseTimeStdDev" : 0.0,
  "combinedHitResponseTime" : 0.0,
  "combinedHitResponseTimeStdDev" : 0.0,
  "readCacheUtilization" : 0.0,
  "writeCacheUtilization" : 0.0,
  "flashCacheReadHitOps" : 0.0,
  "flashCacheReadHitBytes" : 0.0,
  "readPhysicalIOps" : 0.0,
  "writePhysicalIOps" : 0.0,
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "readTimeMax" : 0.0,
  "writeTimeMax" : 0.0,
  "averageQueueDepth" : 0.0,
  "randomIosPercent" : 0.0,
  "randomBytesPercent" : 0.0,
  "cacheWriteWaitOpsPercent" : 0.0,
  "cacheWriteWaitBytesPercent" : 0.0,
  "prefetchHitPercent" : 0.0,
  "fullStripeWritesBytesPercent" : 0.0,
  "flashCacheReadThroughput" : 0.0,
  "flashCacheReadResponseTime" : 0.0,
  "flashCacheHitPct" : 0.0
} ]

3.18.4. Get all analysed volume statistics

GET /devmgr/v2/storage-systems/{system-id}/analysed-volume-statistics
Description

This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< AnalysedVolumeStatistics > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-volume-statistics
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "readIOps" : 0.0,
  "writeIOps" : 0.0,
  "otherIOps" : 0.0,
  "combinedIOps" : 0.0,
  "readThroughput" : 0.0,
  "writeThroughput" : 0.0,
  "combinedThroughput" : 0.0,
  "readResponseTime" : 0.0,
  "readResponseTimeStdDev" : 0.0,
  "writeResponseTime" : 0.0,
  "writeResponseTimeStdDev" : 0.0,
  "combinedResponseTime" : 0.0,
  "combinedResponseTimeStdDev" : 0.0,
  "averageReadOpSize" : 0.0,
  "averageWriteOpSize" : 0.0,
  "readOps" : 0.0,
  "writeOps" : 0.0,
  "volumeId" : "string",
  "volumeName" : "string",
  "poolId" : "string",
  "controllerId" : "string",
  "workLoadId" : "string",
  "mapped" : true,
  "readHitOps" : 0.0,
  "readHitResponseTime" : 0.0,
  "readHitResponseTimeStdDev" : 0.0,
  "readHitBytes" : 0.0,
  "writeHitBytes" : 0.0,
  "writeHitOps" : 0.0,
  "writeHitResponseTime" : 0.0,
  "writeHitResponseTimeStdDev" : 0.0,
  "combinedHitResponseTime" : 0.0,
  "combinedHitResponseTimeStdDev" : 0.0,
  "readCacheUtilization" : 0.0,
  "writeCacheUtilization" : 0.0,
  "flashCacheReadHitOps" : 0.0,
  "flashCacheReadHitBytes" : 0.0,
  "readPhysicalIOps" : 0.0,
  "writePhysicalIOps" : 0.0,
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "readTimeMax" : 0.0,
  "writeTimeMax" : 0.0,
  "averageQueueDepth" : 0.0,
  "randomIosPercent" : 0.0,
  "randomBytesPercent" : 0.0,
  "cacheWriteWaitOpsPercent" : 0.0,
  "cacheWriteWaitBytesPercent" : 0.0,
  "prefetchHitPercent" : 0.0,
  "fullStripeWritesBytesPercent" : 0.0,
  "flashCacheReadThroughput" : 0.0,
  "flashCacheReadResponseTime" : 0.0,
  "flashCacheHitPct" : 0.0
} ]

3.18.5. Get all analysed controller statistics

GET /devmgr/v2/storage-systems/{system-id}/analysed-controller-statistics
Description

This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.

This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< AnalysedControllerStatistics > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-controller-statistics
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "readIOps" : 0.0,
  "writeIOps" : 0.0,
  "otherIOps" : 0.0,
  "combinedIOps" : 0.0,
  "readThroughput" : 0.0,
  "writeThroughput" : 0.0,
  "combinedThroughput" : 0.0,
  "readResponseTime" : 0.0,
  "readResponseTimeStdDev" : 0.0,
  "writeResponseTime" : 0.0,
  "writeResponseTimeStdDev" : 0.0,
  "combinedResponseTime" : 0.0,
  "combinedResponseTimeStdDev" : 0.0,
  "averageReadOpSize" : 0.0,
  "averageWriteOpSize" : 0.0,
  "readOps" : 0.0,
  "writeOps" : 0.0,
  "readPhysicalIOps" : 0.0,
  "writePhysicalIOps" : 0.0,
  "controllerId" : "string",
  "cacheHitBytesPercent" : 0.0,
  "randomIosPercent" : 0.0,
  "mirrorBytesPercent" : 0.0,
  "fullStripeWritesBytesPercent" : 0.0,
  "maxCpuUtilization" : 0.0,
  "maxCpuUtilizationPerCore" : [ 0.0 ],
  "cpuAvgUtilization" : 0.0,
  "cpuAvgUtilizationPerCore" : [ 0.0 ],
  "cpuAvgUtilizationPerCoreStdDev" : [ 0.0 ],
  "raid0BytesPercent" : 0.0,
  "raid1BytesPercent" : 0.0,
  "raid5BytesPercent" : 0.0,
  "raid6BytesPercent" : 0.0,
  "ddpBytesPercent" : 0.0,
  "readHitResponseTime" : 0.0,
  "readHitResponseTimeStdDev" : 0.0,
  "writeHitResponseTime" : 0.0,
  "writeHitResponseTimeStdDev" : 0.0,
  "combinedHitResponseTime" : 0.0,
  "combinedHitResponseTimeStdDev" : 0.0
} ]

3.18.6. Get a subset of analysed controller statistics

GET /devmgr/v2/storage-systems/{system-id}/analysed-controller-statistics/{idlist}
Caution

operation.deprecated

Description

This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.

This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of controller id’s

< string > array(csv)

Responses
HTTP Code Description Schema

200

successful operation

< AnalysedControllerStatistics > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-controller-statistics/string
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "readIOps" : 0.0,
  "writeIOps" : 0.0,
  "otherIOps" : 0.0,
  "combinedIOps" : 0.0,
  "readThroughput" : 0.0,
  "writeThroughput" : 0.0,
  "combinedThroughput" : 0.0,
  "readResponseTime" : 0.0,
  "readResponseTimeStdDev" : 0.0,
  "writeResponseTime" : 0.0,
  "writeResponseTimeStdDev" : 0.0,
  "combinedResponseTime" : 0.0,
  "combinedResponseTimeStdDev" : 0.0,
  "averageReadOpSize" : 0.0,
  "averageWriteOpSize" : 0.0,
  "readOps" : 0.0,
  "writeOps" : 0.0,
  "readPhysicalIOps" : 0.0,
  "writePhysicalIOps" : 0.0,
  "controllerId" : "string",
  "cacheHitBytesPercent" : 0.0,
  "randomIosPercent" : 0.0,
  "mirrorBytesPercent" : 0.0,
  "fullStripeWritesBytesPercent" : 0.0,
  "maxCpuUtilization" : 0.0,
  "maxCpuUtilizationPerCore" : [ 0.0 ],
  "cpuAvgUtilization" : 0.0,
  "cpuAvgUtilizationPerCore" : [ 0.0 ],
  "cpuAvgUtilizationPerCoreStdDev" : [ 0.0 ],
  "raid0BytesPercent" : 0.0,
  "raid1BytesPercent" : 0.0,
  "raid5BytesPercent" : 0.0,
  "raid6BytesPercent" : 0.0,
  "ddpBytesPercent" : 0.0,
  "readHitResponseTime" : 0.0,
  "readHitResponseTimeStdDev" : 0.0,
  "writeHitResponseTime" : 0.0,
  "writeHitResponseTimeStdDev" : 0.0,
  "combinedHitResponseTime" : 0.0,
  "combinedHitResponseTimeStdDev" : 0.0
} ]

3.18.7. Get all analysed interface statistics

GET /devmgr/v2/storage-systems/{system-id}/analysed-interface-statistics
Description

This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.

This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< AnalyzedInterfaceStatistics > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-interface-statistics
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "readIOps" : 0.0,
  "writeIOps" : 0.0,
  "otherIOps" : 0.0,
  "combinedIOps" : 0.0,
  "readThroughput" : 0.0,
  "writeThroughput" : 0.0,
  "combinedThroughput" : 0.0,
  "readResponseTime" : 0.0,
  "readResponseTimeStdDev" : 0.0,
  "writeResponseTime" : 0.0,
  "writeResponseTimeStdDev" : 0.0,
  "combinedResponseTime" : 0.0,
  "combinedResponseTimeStdDev" : 0.0,
  "averageReadOpSize" : 0.0,
  "averageWriteOpSize" : 0.0,
  "readOps" : 0.0,
  "writeOps" : 0.0,
  "interfaceId" : "string",
  "channelType" : "string",
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "channelNumber" : 0,
  "channelErrorCounts" : 0.0
} ]

3.18.8. Get a subset of analysed interface statistics

GET /devmgr/v2/storage-systems/{system-id}/analysed-interface-statistics/{idlist}
Description

This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.

This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of interface id’s

< string > array(csv)

Responses
HTTP Code Description Schema

200

successful operation

< AnalyzedInterfaceStatistics > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-interface-statistics/string
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "readIOps" : 0.0,
  "writeIOps" : 0.0,
  "otherIOps" : 0.0,
  "combinedIOps" : 0.0,
  "readThroughput" : 0.0,
  "writeThroughput" : 0.0,
  "combinedThroughput" : 0.0,
  "readResponseTime" : 0.0,
  "readResponseTimeStdDev" : 0.0,
  "writeResponseTime" : 0.0,
  "writeResponseTimeStdDev" : 0.0,
  "combinedResponseTime" : 0.0,
  "combinedResponseTimeStdDev" : 0.0,
  "averageReadOpSize" : 0.0,
  "averageWriteOpSize" : 0.0,
  "readOps" : 0.0,
  "writeOps" : 0.0,
  "interfaceId" : "string",
  "channelType" : "string",
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "channelNumber" : 0,
  "channelErrorCounts" : 0.0
} ]

3.18.9. Get a subset of raw controller statistics

GET /devmgr/v2/storage-systems/{system-id}/controller-statistics/{idlist}
Caution

operation.deprecated

Description

This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.

This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.

MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of controller id’s

< string > array(csv)

Query

usecache
optional

When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data.

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

< ControllerStats > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/controller-statistics/string
Request query
{
  "usecache" : true
}
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "lastResetTime" : "string",
  "lastResetTimeInMS" : "string",
  "controllerId" : "string",
  "arrayId" : "string",
  "arrayWwn" : "string",
  "cpuUtilizationStats" : [ {
    "maxCpuUtilization" : 0,
    "sumCpuUtilization" : 0,
    "ssqCpuUtilization" : 0
  } ],
  "totalIopsServiced" : 0.0,
  "totalBytesServiced" : 0.0,
  "cacheHitsIopsTotal" : 0.0,
  "cacheHitsBytesTotal" : 0.0,
  "randomIosTotal" : 0.0,
  "randomBytesTotal" : 0.0,
  "readIopsTotal" : 0.0,
  "readBytesTotal" : 0.0,
  "writeIopsTotal" : 0.0,
  "writeBytesTotal" : 0.0,
  "mirrorIopsTotal" : 0.0,
  "mirrorBytesTotal" : 0.0,
  "fullStripeWritesBytes" : 0.0,
  "raid0BytesTransferred" : 0.0,
  "raid1BytesTransferred" : 0.0,
  "raid5BytesTransferred" : 0.0,
  "raid6BytesTransferred" : 0.0,
  "ddpBytesTransferred" : 0.0,
  "maxPossibleBpsUnderCurrentLoad" : 0.0,
  "maxPossibleIopsUnderCurrentLoad" : 0.0
} ]

3.18.10. Get all raw controller statistics

GET /devmgr/v2/storage-systems/{system-id}/controller-statistics
Description

This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.

This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

usecache
optional

When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data.

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

< ControllerStats > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/controller-statistics
Request query
{
  "usecache" : true
}
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "lastResetTime" : "string",
  "lastResetTimeInMS" : "string",
  "controllerId" : "string",
  "arrayId" : "string",
  "arrayWwn" : "string",
  "cpuUtilizationStats" : [ {
    "maxCpuUtilization" : 0,
    "sumCpuUtilization" : 0,
    "ssqCpuUtilization" : 0
  } ],
  "totalIopsServiced" : 0.0,
  "totalBytesServiced" : 0.0,
  "cacheHitsIopsTotal" : 0.0,
  "cacheHitsBytesTotal" : 0.0,
  "randomIosTotal" : 0.0,
  "randomBytesTotal" : 0.0,
  "readIopsTotal" : 0.0,
  "readBytesTotal" : 0.0,
  "writeIopsTotal" : 0.0,
  "writeBytesTotal" : 0.0,
  "mirrorIopsTotal" : 0.0,
  "mirrorBytesTotal" : 0.0,
  "fullStripeWritesBytes" : 0.0,
  "raid0BytesTransferred" : 0.0,
  "raid1BytesTransferred" : 0.0,
  "raid5BytesTransferred" : 0.0,
  "raid6BytesTransferred" : 0.0,
  "ddpBytesTransferred" : 0.0,
  "maxPossibleBpsUnderCurrentLoad" : 0.0,
  "maxPossibleIopsUnderCurrentLoad" : 0.0
} ]

3.18.11. Get a subset of the raw disk statistics

GET /devmgr/v2/storage-systems/{system-id}/drive-statistics/{idlist}
Description

This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of disk ids

< string > array(csv)

Query

usecache
optional

When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data.

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

< DiskIOStats > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drive-statistics/string
Request query
{
  "usecache" : true
}
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "lastResetTime" : "string",
  "lastResetTimeInMS" : "string",
  "diskId" : "string",
  "serialNumber" : "string",
  "arrayId" : "string",
  "arrayWWN" : "string",
  "driveWWN" : "string",
  "volGroupId" : "string",
  "volGroupName" : "string",
  "volGroupWWN" : "string",
  "trayId" : "string",
  "slot" : 0,
  "diskManufacture" : "string",
  "diskSoftwareVersion" : "string",
  "idleTime" : 0.0,
  "otherOps" : 0.0,
  "otherTimeMax" : 0.0,
  "otherTimeTotal" : 0.0,
  "otherTimeTotalSq" : 0.0,
  "readBytes" : 0.0,
  "readOps" : 0.0,
  "readTimeMax" : 0.0,
  "readTimeTotal" : 0.0,
  "readTimeTotalSq" : 0.0,
  "recoveredErrors" : 0.0,
  "retriedIos" : 0.0,
  "timeouts" : 0.0,
  "unrecoveredErrors" : 0.0,
  "writeBytes" : 0.0,
  "writeOps" : 0.0,
  "writeTimeMax" : 0.0,
  "writeTimeTotal" : 0.0,
  "writeTimeTotalSq" : 0.0,
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "randomIosTotal" : 0.0,
  "randomBytesTotal" : 0.0,
  "cumulativeLBA" : 0.0,
  "cumulativeDeltaLBA" : 0.0
} ]

3.18.12. Get raw disk statistics

GET /devmgr/v2/storage-systems/{system-id}/drive-statistics
Description

This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

usecache
optional

When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data.

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

< DiskIOStats > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drive-statistics
Request query
{
  "usecache" : true
}
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "lastResetTime" : "string",
  "lastResetTimeInMS" : "string",
  "diskId" : "string",
  "serialNumber" : "string",
  "arrayId" : "string",
  "arrayWWN" : "string",
  "driveWWN" : "string",
  "volGroupId" : "string",
  "volGroupName" : "string",
  "volGroupWWN" : "string",
  "trayId" : "string",
  "slot" : 0,
  "diskManufacture" : "string",
  "diskSoftwareVersion" : "string",
  "idleTime" : 0.0,
  "otherOps" : 0.0,
  "otherTimeMax" : 0.0,
  "otherTimeTotal" : 0.0,
  "otherTimeTotalSq" : 0.0,
  "readBytes" : 0.0,
  "readOps" : 0.0,
  "readTimeMax" : 0.0,
  "readTimeTotal" : 0.0,
  "readTimeTotalSq" : 0.0,
  "recoveredErrors" : 0.0,
  "retriedIos" : 0.0,
  "timeouts" : 0.0,
  "unrecoveredErrors" : 0.0,
  "writeBytes" : 0.0,
  "writeOps" : 0.0,
  "writeTimeMax" : 0.0,
  "writeTimeTotal" : 0.0,
  "writeTimeTotalSq" : 0.0,
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "randomIosTotal" : 0.0,
  "randomBytesTotal" : 0.0,
  "cumulativeLBA" : 0.0,
  "cumulativeDeltaLBA" : 0.0
} ]

3.18.13. Get the list supported statistics types

GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/supported-types
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< enum (volume, controller, storageSystem, drive, ioInterface, storagePool, application, workload) > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/supported-types
Example HTTP response
Response 200
[ "string" ]

3.18.14. Get the list supported raw statistics types

GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/supported-types/raw
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< enum (volume, controller, storageSystem, drive, ioInterface, storagePool, application, workload) > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/supported-types/raw
Example HTTP response
Response 200
[ "string" ]

3.18.15. Get the list supported average analyzed statistics types

GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/supported-types/average
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< enum (volume, controller, storageSystem, drive, ioInterface, storagePool, application, workload) > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/supported-types/average
Example HTTP response
Response 200
[ "string" ]

3.18.16. Get historical performance statistics

GET /devmgr/v2/storage-systems/{system-id}/historical-statistics
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

type
optional

Statistics type

string

Query

start
optional

start time in milliseconds since the epoch

integer (int64)

Query

end
optional

end time in milliseconds since the epoch

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

HistoricalStatsResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics
Request query
{
  "type" : "string",
  "start" : 0,
  "end" : 0
}
Example HTTP response
Response 200
{
  "volumeStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "volumeId" : "string",
    "volumeName" : "string",
    "poolId" : "string",
    "controllerId" : "string",
    "workLoadId" : "string",
    "mapped" : true,
    "readHitOps" : 0.0,
    "readHitResponseTime" : 0.0,
    "readHitResponseTimeStdDev" : 0.0,
    "readHitBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitResponseTime" : 0.0,
    "writeHitResponseTimeStdDev" : 0.0,
    "combinedHitResponseTime" : 0.0,
    "combinedHitResponseTimeStdDev" : 0.0,
    "readCacheUtilization" : 0.0,
    "writeCacheUtilization" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "averageQueueDepth" : 0.0,
    "randomIosPercent" : 0.0,
    "randomBytesPercent" : 0.0,
    "cacheWriteWaitOpsPercent" : 0.0,
    "cacheWriteWaitBytesPercent" : 0.0,
    "prefetchHitPercent" : 0.0,
    "fullStripeWritesBytesPercent" : 0.0,
    "flashCacheReadThroughput" : 0.0,
    "flashCacheReadResponseTime" : 0.0,
    "flashCacheHitPct" : 0.0
  } ],
  "controllerStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "controllerId" : "string",
    "cacheHitBytesPercent" : 0.0,
    "randomIosPercent" : 0.0,
    "mirrorBytesPercent" : 0.0,
    "fullStripeWritesBytesPercent" : 0.0,
    "maxCpuUtilization" : 0.0,
    "maxCpuUtilizationPerCore" : [ 0.0 ],
    "cpuAvgUtilization" : 0.0,
    "cpuAvgUtilizationPerCore" : [ 0.0 ],
    "cpuAvgUtilizationPerCoreStdDev" : [ 0.0 ],
    "raid0BytesPercent" : 0.0,
    "raid1BytesPercent" : 0.0,
    "raid5BytesPercent" : 0.0,
    "raid6BytesPercent" : 0.0,
    "ddpBytesPercent" : 0.0,
    "readHitResponseTime" : 0.0,
    "readHitResponseTimeStdDev" : 0.0,
    "writeHitResponseTime" : 0.0,
    "writeHitResponseTimeStdDev" : 0.0,
    "combinedHitResponseTime" : 0.0,
    "combinedHitResponseTimeStdDev" : 0.0
  } ],
  "systemStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "storageSystemId" : "string",
    "storageSystemWWN" : "string",
    "storageSystemName" : "string"
  } ],
  "interfaceStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "interfaceId" : "string",
    "channelType" : "string",
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "channelNumber" : 0,
    "channelErrorCounts" : 0.0
  } ],
  "diskStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "diskId" : "string",
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "readTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthMax" : 0.0,
    "averageQueueDepth" : 0.0,
    "randomIosPercent" : 0.0,
    "randomBytesPercent" : 0.0
  } ],
  "poolStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "poolId" : "string"
  } ],
  "workloadStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "workloadId" : "string"
  } ],
  "applicationStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "applicationId" : "string"
  } ],
  "volumes" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "volumeId" : "string",
    "volumeName" : "string",
    "poolId" : "string",
    "controllerId" : "string",
    "workLoadId" : "string",
    "mapped" : true,
    "readHitOps" : 0.0,
    "readHitResponseTime" : 0.0,
    "readHitResponseTimeStdDev" : 0.0,
    "readHitBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitResponseTime" : 0.0,
    "writeHitResponseTimeStdDev" : 0.0,
    "combinedHitResponseTime" : 0.0,
    "combinedHitResponseTimeStdDev" : 0.0,
    "readCacheUtilization" : 0.0,
    "writeCacheUtilization" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "averageQueueDepth" : 0.0,
    "randomIosPercent" : 0.0,
    "randomBytesPercent" : 0.0,
    "cacheWriteWaitOpsPercent" : 0.0,
    "cacheWriteWaitBytesPercent" : 0.0,
    "prefetchHitPercent" : 0.0,
    "fullStripeWritesBytesPercent" : 0.0,
    "flashCacheReadThroughput" : 0.0,
    "flashCacheReadResponseTime" : 0.0,
    "flashCacheHitPct" : 0.0
  } ]
}

3.18.17. Get selected historical performance statistics

GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/{idlist}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of object ids

< string > array(csv)

Query

type
optional

Statistics type

string

Query

start
optional

start time in milliseconds since the epoch

integer (int64)

Query

end
optional

end time in milliseconds since the epoch

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

HistoricalStatsResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/string
Request query
{
  "type" : "string",
  "start" : 0,
  "end" : 0
}
Example HTTP response
Response 200
{
  "volumeStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "volumeId" : "string",
    "volumeName" : "string",
    "poolId" : "string",
    "controllerId" : "string",
    "workLoadId" : "string",
    "mapped" : true,
    "readHitOps" : 0.0,
    "readHitResponseTime" : 0.0,
    "readHitResponseTimeStdDev" : 0.0,
    "readHitBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitResponseTime" : 0.0,
    "writeHitResponseTimeStdDev" : 0.0,
    "combinedHitResponseTime" : 0.0,
    "combinedHitResponseTimeStdDev" : 0.0,
    "readCacheUtilization" : 0.0,
    "writeCacheUtilization" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "averageQueueDepth" : 0.0,
    "randomIosPercent" : 0.0,
    "randomBytesPercent" : 0.0,
    "cacheWriteWaitOpsPercent" : 0.0,
    "cacheWriteWaitBytesPercent" : 0.0,
    "prefetchHitPercent" : 0.0,
    "fullStripeWritesBytesPercent" : 0.0,
    "flashCacheReadThroughput" : 0.0,
    "flashCacheReadResponseTime" : 0.0,
    "flashCacheHitPct" : 0.0
  } ],
  "controllerStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "controllerId" : "string",
    "cacheHitBytesPercent" : 0.0,
    "randomIosPercent" : 0.0,
    "mirrorBytesPercent" : 0.0,
    "fullStripeWritesBytesPercent" : 0.0,
    "maxCpuUtilization" : 0.0,
    "maxCpuUtilizationPerCore" : [ 0.0 ],
    "cpuAvgUtilization" : 0.0,
    "cpuAvgUtilizationPerCore" : [ 0.0 ],
    "cpuAvgUtilizationPerCoreStdDev" : [ 0.0 ],
    "raid0BytesPercent" : 0.0,
    "raid1BytesPercent" : 0.0,
    "raid5BytesPercent" : 0.0,
    "raid6BytesPercent" : 0.0,
    "ddpBytesPercent" : 0.0,
    "readHitResponseTime" : 0.0,
    "readHitResponseTimeStdDev" : 0.0,
    "writeHitResponseTime" : 0.0,
    "writeHitResponseTimeStdDev" : 0.0,
    "combinedHitResponseTime" : 0.0,
    "combinedHitResponseTimeStdDev" : 0.0
  } ],
  "systemStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "storageSystemId" : "string",
    "storageSystemWWN" : "string",
    "storageSystemName" : "string"
  } ],
  "interfaceStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "interfaceId" : "string",
    "channelType" : "string",
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "channelNumber" : 0,
    "channelErrorCounts" : 0.0
  } ],
  "diskStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "diskId" : "string",
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "readTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthMax" : 0.0,
    "averageQueueDepth" : 0.0,
    "randomIosPercent" : 0.0,
    "randomBytesPercent" : 0.0
  } ],
  "poolStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "poolId" : "string"
  } ],
  "workloadStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "workloadId" : "string"
  } ],
  "applicationStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "applicationId" : "string"
  } ],
  "volumes" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "volumeId" : "string",
    "volumeName" : "string",
    "poolId" : "string",
    "controllerId" : "string",
    "workLoadId" : "string",
    "mapped" : true,
    "readHitOps" : 0.0,
    "readHitResponseTime" : 0.0,
    "readHitResponseTimeStdDev" : 0.0,
    "readHitBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitResponseTime" : 0.0,
    "writeHitResponseTimeStdDev" : 0.0,
    "combinedHitResponseTime" : 0.0,
    "combinedHitResponseTimeStdDev" : 0.0,
    "readCacheUtilization" : 0.0,
    "writeCacheUtilization" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "averageQueueDepth" : 0.0,
    "randomIosPercent" : 0.0,
    "randomBytesPercent" : 0.0,
    "cacheWriteWaitOpsPercent" : 0.0,
    "cacheWriteWaitBytesPercent" : 0.0,
    "prefetchHitPercent" : 0.0,
    "fullStripeWritesBytesPercent" : 0.0,
    "flashCacheReadThroughput" : 0.0,
    "flashCacheReadResponseTime" : 0.0,
    "flashCacheHitPct" : 0.0
  } ]
}

3.18.18. Get historical performance raw statistics

GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/raw
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

type
optional

Statistics type

string

Query

start
optional

start time in milliseconds since the epoch

integer (int64)

Query

end
optional

end time in milliseconds since the epoch

integer (int64)

Query

length
optional

Length of time in ms.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

RawStatsResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/raw
Request query
{
  "type" : "string",
  "start" : 0,
  "end" : 0,
  "length" : 0
}
Example HTTP response
Response 200
{
  "volumeStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "volumeGroupId" : "string",
    "controllerId" : "string",
    "volumeId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "volumeGroupWwn" : "string",
    "volumeName" : "string",
    "volumeWwn" : "string",
    "workloadId" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeCacheHitOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readHitTimeTotalSq" : 0.0,
    "readTimeMax" : 0.0,
    "readTimeTotalSq" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeHitTimeTotalSq" : 0.0,
    "writeTimeMax" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "cacheWriteWaitHitIops" : 0.0,
    "cacheWriteWaitHitBytes" : 0.0,
    "fullStripeWriteBytes" : 0.0,
    "totalIosShipped" : 0.0,
    "totalBlksEvicted" : 0.0,
    "cacheBlksInUse" : 0.0,
    "prefetchHitBytes" : 0.0,
    "prefetchMissBytes" : "string",
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "flashCacheReadHitTimeTotalSq" : 0.0
  } ],
  "controllerStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "controllerId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "cpuUtilizationStats" : [ {
      "maxCpuUtilization" : 0,
      "sumCpuUtilization" : 0,
      "ssqCpuUtilization" : 0
    } ],
    "totalIopsServiced" : 0.0,
    "totalBytesServiced" : 0.0,
    "cacheHitsIopsTotal" : 0.0,
    "cacheHitsBytesTotal" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "readIopsTotal" : 0.0,
    "readBytesTotal" : 0.0,
    "writeIopsTotal" : 0.0,
    "writeBytesTotal" : 0.0,
    "mirrorIopsTotal" : 0.0,
    "mirrorBytesTotal" : 0.0,
    "fullStripeWritesBytes" : 0.0,
    "raid0BytesTransferred" : 0.0,
    "raid1BytesTransferred" : 0.0,
    "raid5BytesTransferred" : 0.0,
    "raid6BytesTransferred" : 0.0,
    "ddpBytesTransferred" : 0.0,
    "maxPossibleBpsUnderCurrentLoad" : 0.0,
    "maxPossibleIopsUnderCurrentLoad" : 0.0
  } ],
  "systemStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "controllerStats" : [ {
      "controllerId" : "string",
      "cpuUtilizationStats" : [ {
        "maxCpuUtilization" : 0,
        "sumCpuUtilization" : 0,
        "ssqCpuUtilization" : 0
      } ]
    } ],
    "totalIopsServiced" : 0.0,
    "totalBytesServiced" : 0.0,
    "cacheHitsIopsTotal" : 0.0,
    "cacheHitsBytesTotal" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "readIopsTotal" : 0.0,
    "readBytesTotal" : 0.0,
    "writeIopsTotal" : 0.0,
    "writeBytesTotal" : 0.0,
    "mirrorIopsTotal" : 0.0,
    "mirrorBytesTotal" : 0.0,
    "fullStripeWritesBytes" : 0.0,
    "raid0BytesTransferred" : 0.0,
    "raid1BytesTransferred" : 0.0,
    "raid5BytesTransferred" : 0.0,
    "raid6BytesTransferred" : 0.0,
    "ddpBytesTransferred" : 0.0,
    "maxPossibleBpsUnderCurrentLoad" : 0.0,
    "maxPossibleIopsUnderCurrentLoad" : 0.0
  } ],
  "interfaceStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "interfaceId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "channelType" : "string",
    "channelNumber" : 0,
    "readOps" : 0.0,
    "readBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readTimeMax" : 0.0,
    "writeOps" : 0.0,
    "writeBytes" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeTimeMax" : 0.0,
    "otherOps" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeMax" : 0.0,
    "readTimeTotalSq" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "channelErrorCount" : 0.0
  } ],
  "diskStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "diskId" : "string",
    "serialNumber" : "string",
    "arrayId" : "string",
    "arrayWWN" : "string",
    "driveWWN" : "string",
    "volGroupId" : "string",
    "volGroupName" : "string",
    "volGroupWWN" : "string",
    "trayId" : "string",
    "slot" : 0,
    "diskManufacture" : "string",
    "diskSoftwareVersion" : "string",
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "readBytes" : 0.0,
    "readOps" : 0.0,
    "readTimeMax" : 0.0,
    "readTimeTotal" : 0.0,
    "readTimeTotalSq" : 0.0,
    "recoveredErrors" : 0.0,
    "retriedIos" : 0.0,
    "timeouts" : 0.0,
    "unrecoveredErrors" : 0.0,
    "writeBytes" : 0.0,
    "writeOps" : 0.0,
    "writeTimeMax" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "cumulativeLBA" : 0.0,
    "cumulativeDeltaLBA" : 0.0
  } ],
  "poolStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "poolId" : "string"
  } ],
  "applicationStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "applicationId" : "string"
  } ],
  "workloadStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "workloadId" : "string"
  } ]
}

3.18.19. Get selected historical performance raw statistics

GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/raw/{idlist}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of object ids

< string > array(csv)

Query

type
optional

Statistics type

string

Query

start
optional

start time in milliseconds since the epoch

integer (int64)

Query

end
optional

end time in milliseconds since the epoch

integer (int64)

Query

length
optional

Length of time in ms.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

RawStatsResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/raw/string
Request query
{
  "type" : "string",
  "start" : 0,
  "end" : 0,
  "length" : 0
}
Example HTTP response
Response 200
{
  "volumeStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "volumeGroupId" : "string",
    "controllerId" : "string",
    "volumeId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "volumeGroupWwn" : "string",
    "volumeName" : "string",
    "volumeWwn" : "string",
    "workloadId" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeCacheHitOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readHitTimeTotalSq" : 0.0,
    "readTimeMax" : 0.0,
    "readTimeTotalSq" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeHitTimeTotalSq" : 0.0,
    "writeTimeMax" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "cacheWriteWaitHitIops" : 0.0,
    "cacheWriteWaitHitBytes" : 0.0,
    "fullStripeWriteBytes" : 0.0,
    "totalIosShipped" : 0.0,
    "totalBlksEvicted" : 0.0,
    "cacheBlksInUse" : 0.0,
    "prefetchHitBytes" : 0.0,
    "prefetchMissBytes" : "string",
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "flashCacheReadHitTimeTotalSq" : 0.0
  } ],
  "controllerStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "controllerId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "cpuUtilizationStats" : [ {
      "maxCpuUtilization" : 0,
      "sumCpuUtilization" : 0,
      "ssqCpuUtilization" : 0
    } ],
    "totalIopsServiced" : 0.0,
    "totalBytesServiced" : 0.0,
    "cacheHitsIopsTotal" : 0.0,
    "cacheHitsBytesTotal" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "readIopsTotal" : 0.0,
    "readBytesTotal" : 0.0,
    "writeIopsTotal" : 0.0,
    "writeBytesTotal" : 0.0,
    "mirrorIopsTotal" : 0.0,
    "mirrorBytesTotal" : 0.0,
    "fullStripeWritesBytes" : 0.0,
    "raid0BytesTransferred" : 0.0,
    "raid1BytesTransferred" : 0.0,
    "raid5BytesTransferred" : 0.0,
    "raid6BytesTransferred" : 0.0,
    "ddpBytesTransferred" : 0.0,
    "maxPossibleBpsUnderCurrentLoad" : 0.0,
    "maxPossibleIopsUnderCurrentLoad" : 0.0
  } ],
  "systemStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "controllerStats" : [ {
      "controllerId" : "string",
      "cpuUtilizationStats" : [ {
        "maxCpuUtilization" : 0,
        "sumCpuUtilization" : 0,
        "ssqCpuUtilization" : 0
      } ]
    } ],
    "totalIopsServiced" : 0.0,
    "totalBytesServiced" : 0.0,
    "cacheHitsIopsTotal" : 0.0,
    "cacheHitsBytesTotal" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "readIopsTotal" : 0.0,
    "readBytesTotal" : 0.0,
    "writeIopsTotal" : 0.0,
    "writeBytesTotal" : 0.0,
    "mirrorIopsTotal" : 0.0,
    "mirrorBytesTotal" : 0.0,
    "fullStripeWritesBytes" : 0.0,
    "raid0BytesTransferred" : 0.0,
    "raid1BytesTransferred" : 0.0,
    "raid5BytesTransferred" : 0.0,
    "raid6BytesTransferred" : 0.0,
    "ddpBytesTransferred" : 0.0,
    "maxPossibleBpsUnderCurrentLoad" : 0.0,
    "maxPossibleIopsUnderCurrentLoad" : 0.0
  } ],
  "interfaceStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "interfaceId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "channelType" : "string",
    "channelNumber" : 0,
    "readOps" : 0.0,
    "readBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readTimeMax" : 0.0,
    "writeOps" : 0.0,
    "writeBytes" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeTimeMax" : 0.0,
    "otherOps" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeMax" : 0.0,
    "readTimeTotalSq" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "channelErrorCount" : 0.0
  } ],
  "diskStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "diskId" : "string",
    "serialNumber" : "string",
    "arrayId" : "string",
    "arrayWWN" : "string",
    "driveWWN" : "string",
    "volGroupId" : "string",
    "volGroupName" : "string",
    "volGroupWWN" : "string",
    "trayId" : "string",
    "slot" : 0,
    "diskManufacture" : "string",
    "diskSoftwareVersion" : "string",
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "readBytes" : 0.0,
    "readOps" : 0.0,
    "readTimeMax" : 0.0,
    "readTimeTotal" : 0.0,
    "readTimeTotalSq" : 0.0,
    "recoveredErrors" : 0.0,
    "retriedIos" : 0.0,
    "timeouts" : 0.0,
    "unrecoveredErrors" : 0.0,
    "writeBytes" : 0.0,
    "writeOps" : 0.0,
    "writeTimeMax" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "cumulativeLBA" : 0.0,
    "cumulativeDeltaLBA" : 0.0
  } ],
  "poolStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "poolId" : "string"
  } ],
  "applicationStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "applicationId" : "string"
  } ],
  "workloadStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "workloadId" : "string"
  } ]
}

3.18.20. Get historical performance statistics averaged over a time range.

GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/average
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

type
optional

Statistics type

string

Query

length
optional

Length of time in ms.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

AverageAnalysedStatsResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/average
Request query
{
  "type" : "string",
  "length" : 0
}
Example HTTP response
Response 200
{
  "volumeStats" : [ {
    "id" : "string",
    "latencyRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "latencyWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "primaryCacheReadHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "primaryCacheWriteHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "ssdCacheReadHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    }
  } ],
  "diskStats" : [ {
    "id" : "string",
    "latencyRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "latencyWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    }
  } ],
  "controllerStats" : [ {
    "id" : "string",
    "iopsRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "cpuUtilization" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "headroomPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    }
  } ],
  "interfaceStats" : [ {
    "id" : "string",
    "latencyRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "latencyWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "headroomPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    }
  } ],
  "systemStats" : [ {
    "id" : "string",
    "iopsRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "controllerStats" : [ {
      "controllerId" : "string",
      "cpuUtilization" : {
        "min" : 0.0,
        "max" : 0.0,
        "value" : 0.0,
        "std" : 0.0
      }
    } ]
  } ],
  "poolStats" : [ {
    "id" : "string",
    "latencyRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "latencyWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "primaryCacheReadHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "primaryCacheWriteHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "ssdCacheReadHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    }
  } ],
  "workloadStats" : [ {
    "id" : "string",
    "latencyRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "latencyWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "primaryCacheReadHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "primaryCacheWriteHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "ssdCacheReadHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    }
  } ],
  "applicationStats" : [ {
    "id" : "string",
    "latencyRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "latencyWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "iopsWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputRead" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "throughputWrite" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "primaryCacheReadHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "primaryCacheWriteHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    },
    "ssdCacheReadHitPct" : {
      "min" : 0.0,
      "max" : 0.0,
      "value" : 0.0,
      "std" : 0.0
    }
  } ]
}

3.18.21. Get a subset of raw interface statistics

GET /devmgr/v2/storage-systems/{system-id}/interface-statistics/{idlist}
Description

This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.

This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of interface id’s

< string > array(csv)

Query

usecache
optional

When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data.

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

< InterfaceStats > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/interface-statistics/string
Request query
{
  "usecache" : true
}
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "lastResetTime" : "string",
  "lastResetTimeInMS" : "string",
  "interfaceId" : "string",
  "arrayId" : "string",
  "arrayWwn" : "string",
  "channelType" : "string",
  "channelNumber" : 0,
  "readOps" : 0.0,
  "readBytes" : 0.0,
  "readTimeTotal" : 0.0,
  "readTimeMax" : 0.0,
  "writeOps" : 0.0,
  "writeBytes" : 0.0,
  "writeTimeTotal" : 0.0,
  "writeTimeMax" : 0.0,
  "otherOps" : 0.0,
  "otherTimeTotal" : 0.0,
  "otherTimeMax" : 0.0,
  "readTimeTotalSq" : 0.0,
  "writeTimeTotalSq" : 0.0,
  "otherTimeTotalSq" : 0.0,
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "channelErrorCount" : 0.0
} ]

3.18.22. Get all raw interface statistics

GET /devmgr/v2/storage-systems/{system-id}/interface-statistics
Description

This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.

This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

usecache
optional

When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data.

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

< InterfaceStats > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/interface-statistics
Request query
{
  "usecache" : true
}
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "lastResetTime" : "string",
  "lastResetTimeInMS" : "string",
  "interfaceId" : "string",
  "arrayId" : "string",
  "arrayWwn" : "string",
  "channelType" : "string",
  "channelNumber" : 0,
  "readOps" : 0.0,
  "readBytes" : 0.0,
  "readTimeTotal" : 0.0,
  "readTimeMax" : 0.0,
  "writeOps" : 0.0,
  "writeBytes" : 0.0,
  "writeTimeTotal" : 0.0,
  "writeTimeMax" : 0.0,
  "otherOps" : 0.0,
  "otherTimeTotal" : 0.0,
  "otherTimeMax" : 0.0,
  "readTimeTotalSq" : 0.0,
  "writeTimeTotalSq" : 0.0,
  "otherTimeTotalSq" : 0.0,
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "channelErrorCount" : 0.0
} ]

3.18.23. Get selected Live performance statistics

GET /devmgr/v2/storage-systems/{system-id}/live-statistics/{idlist}
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of object ids

< string > array(csv)

Query

type
optional

Statistics type

string

Responses
HTTP Code Description Schema

200

successful operation

RawStatsResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/live-statistics/string
Request query
{
  "type" : "string"
}
Example HTTP response
Response 200
{
  "volumeStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "volumeGroupId" : "string",
    "controllerId" : "string",
    "volumeId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "volumeGroupWwn" : "string",
    "volumeName" : "string",
    "volumeWwn" : "string",
    "workloadId" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeCacheHitOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readHitTimeTotalSq" : 0.0,
    "readTimeMax" : 0.0,
    "readTimeTotalSq" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeHitTimeTotalSq" : 0.0,
    "writeTimeMax" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "cacheWriteWaitHitIops" : 0.0,
    "cacheWriteWaitHitBytes" : 0.0,
    "fullStripeWriteBytes" : 0.0,
    "totalIosShipped" : 0.0,
    "totalBlksEvicted" : 0.0,
    "cacheBlksInUse" : 0.0,
    "prefetchHitBytes" : 0.0,
    "prefetchMissBytes" : "string",
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "flashCacheReadHitTimeTotalSq" : 0.0
  } ],
  "controllerStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "controllerId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "cpuUtilizationStats" : [ {
      "maxCpuUtilization" : 0,
      "sumCpuUtilization" : 0,
      "ssqCpuUtilization" : 0
    } ],
    "totalIopsServiced" : 0.0,
    "totalBytesServiced" : 0.0,
    "cacheHitsIopsTotal" : 0.0,
    "cacheHitsBytesTotal" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "readIopsTotal" : 0.0,
    "readBytesTotal" : 0.0,
    "writeIopsTotal" : 0.0,
    "writeBytesTotal" : 0.0,
    "mirrorIopsTotal" : 0.0,
    "mirrorBytesTotal" : 0.0,
    "fullStripeWritesBytes" : 0.0,
    "raid0BytesTransferred" : 0.0,
    "raid1BytesTransferred" : 0.0,
    "raid5BytesTransferred" : 0.0,
    "raid6BytesTransferred" : 0.0,
    "ddpBytesTransferred" : 0.0,
    "maxPossibleBpsUnderCurrentLoad" : 0.0,
    "maxPossibleIopsUnderCurrentLoad" : 0.0
  } ],
  "systemStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "controllerStats" : [ {
      "controllerId" : "string",
      "cpuUtilizationStats" : [ {
        "maxCpuUtilization" : 0,
        "sumCpuUtilization" : 0,
        "ssqCpuUtilization" : 0
      } ]
    } ],
    "totalIopsServiced" : 0.0,
    "totalBytesServiced" : 0.0,
    "cacheHitsIopsTotal" : 0.0,
    "cacheHitsBytesTotal" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "readIopsTotal" : 0.0,
    "readBytesTotal" : 0.0,
    "writeIopsTotal" : 0.0,
    "writeBytesTotal" : 0.0,
    "mirrorIopsTotal" : 0.0,
    "mirrorBytesTotal" : 0.0,
    "fullStripeWritesBytes" : 0.0,
    "raid0BytesTransferred" : 0.0,
    "raid1BytesTransferred" : 0.0,
    "raid5BytesTransferred" : 0.0,
    "raid6BytesTransferred" : 0.0,
    "ddpBytesTransferred" : 0.0,
    "maxPossibleBpsUnderCurrentLoad" : 0.0,
    "maxPossibleIopsUnderCurrentLoad" : 0.0
  } ],
  "interfaceStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "interfaceId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "channelType" : "string",
    "channelNumber" : 0,
    "readOps" : 0.0,
    "readBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readTimeMax" : 0.0,
    "writeOps" : 0.0,
    "writeBytes" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeTimeMax" : 0.0,
    "otherOps" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeMax" : 0.0,
    "readTimeTotalSq" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "channelErrorCount" : 0.0
  } ],
  "diskStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "diskId" : "string",
    "serialNumber" : "string",
    "arrayId" : "string",
    "arrayWWN" : "string",
    "driveWWN" : "string",
    "volGroupId" : "string",
    "volGroupName" : "string",
    "volGroupWWN" : "string",
    "trayId" : "string",
    "slot" : 0,
    "diskManufacture" : "string",
    "diskSoftwareVersion" : "string",
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "readBytes" : 0.0,
    "readOps" : 0.0,
    "readTimeMax" : 0.0,
    "readTimeTotal" : 0.0,
    "readTimeTotalSq" : 0.0,
    "recoveredErrors" : 0.0,
    "retriedIos" : 0.0,
    "timeouts" : 0.0,
    "unrecoveredErrors" : 0.0,
    "writeBytes" : 0.0,
    "writeOps" : 0.0,
    "writeTimeMax" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "cumulativeLBA" : 0.0,
    "cumulativeDeltaLBA" : 0.0
  } ],
  "poolStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "poolId" : "string"
  } ],
  "applicationStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "applicationId" : "string"
  } ],
  "workloadStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "workloadId" : "string"
  } ]
}

3.18.24. Get Live performance statistics

GET /devmgr/v2/storage-systems/{system-id}/live-statistics
MetaData

x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

type
optional

Statistics type

string

Responses
HTTP Code Description Schema

200

successful operation

RawStatsResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/live-statistics
Request query
{
  "type" : "string"
}
Example HTTP response
Response 200
{
  "volumeStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "volumeGroupId" : "string",
    "controllerId" : "string",
    "volumeId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "volumeGroupWwn" : "string",
    "volumeName" : "string",
    "volumeWwn" : "string",
    "workloadId" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeCacheHitOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readHitTimeTotalSq" : 0.0,
    "readTimeMax" : 0.0,
    "readTimeTotalSq" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeHitTimeTotalSq" : 0.0,
    "writeTimeMax" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "cacheWriteWaitHitIops" : 0.0,
    "cacheWriteWaitHitBytes" : 0.0,
    "fullStripeWriteBytes" : 0.0,
    "totalIosShipped" : 0.0,
    "totalBlksEvicted" : 0.0,
    "cacheBlksInUse" : 0.0,
    "prefetchHitBytes" : 0.0,
    "prefetchMissBytes" : "string",
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "flashCacheReadHitTimeTotalSq" : 0.0
  } ],
  "controllerStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "controllerId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "cpuUtilizationStats" : [ {
      "maxCpuUtilization" : 0,
      "sumCpuUtilization" : 0,
      "ssqCpuUtilization" : 0
    } ],
    "totalIopsServiced" : 0.0,
    "totalBytesServiced" : 0.0,
    "cacheHitsIopsTotal" : 0.0,
    "cacheHitsBytesTotal" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "readIopsTotal" : 0.0,
    "readBytesTotal" : 0.0,
    "writeIopsTotal" : 0.0,
    "writeBytesTotal" : 0.0,
    "mirrorIopsTotal" : 0.0,
    "mirrorBytesTotal" : 0.0,
    "fullStripeWritesBytes" : 0.0,
    "raid0BytesTransferred" : 0.0,
    "raid1BytesTransferred" : 0.0,
    "raid5BytesTransferred" : 0.0,
    "raid6BytesTransferred" : 0.0,
    "ddpBytesTransferred" : 0.0,
    "maxPossibleBpsUnderCurrentLoad" : 0.0,
    "maxPossibleIopsUnderCurrentLoad" : 0.0
  } ],
  "systemStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "controllerStats" : [ {
      "controllerId" : "string",
      "cpuUtilizationStats" : [ {
        "maxCpuUtilization" : 0,
        "sumCpuUtilization" : 0,
        "ssqCpuUtilization" : 0
      } ]
    } ],
    "totalIopsServiced" : 0.0,
    "totalBytesServiced" : 0.0,
    "cacheHitsIopsTotal" : 0.0,
    "cacheHitsBytesTotal" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "readIopsTotal" : 0.0,
    "readBytesTotal" : 0.0,
    "writeIopsTotal" : 0.0,
    "writeBytesTotal" : 0.0,
    "mirrorIopsTotal" : 0.0,
    "mirrorBytesTotal" : 0.0,
    "fullStripeWritesBytes" : 0.0,
    "raid0BytesTransferred" : 0.0,
    "raid1BytesTransferred" : 0.0,
    "raid5BytesTransferred" : 0.0,
    "raid6BytesTransferred" : 0.0,
    "ddpBytesTransferred" : 0.0,
    "maxPossibleBpsUnderCurrentLoad" : 0.0,
    "maxPossibleIopsUnderCurrentLoad" : 0.0
  } ],
  "interfaceStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "interfaceId" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "channelType" : "string",
    "channelNumber" : 0,
    "readOps" : 0.0,
    "readBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readTimeMax" : 0.0,
    "writeOps" : 0.0,
    "writeBytes" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeTimeMax" : 0.0,
    "otherOps" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeMax" : 0.0,
    "readTimeTotalSq" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "channelErrorCount" : 0.0
  } ],
  "diskStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "diskId" : "string",
    "serialNumber" : "string",
    "arrayId" : "string",
    "arrayWWN" : "string",
    "driveWWN" : "string",
    "volGroupId" : "string",
    "volGroupName" : "string",
    "volGroupWWN" : "string",
    "trayId" : "string",
    "slot" : 0,
    "diskManufacture" : "string",
    "diskSoftwareVersion" : "string",
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "otherTimeTotalSq" : 0.0,
    "readBytes" : 0.0,
    "readOps" : 0.0,
    "readTimeMax" : 0.0,
    "readTimeTotal" : 0.0,
    "readTimeTotalSq" : 0.0,
    "recoveredErrors" : 0.0,
    "retriedIos" : 0.0,
    "timeouts" : 0.0,
    "unrecoveredErrors" : 0.0,
    "writeBytes" : 0.0,
    "writeOps" : 0.0,
    "writeTimeMax" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeTimeTotalSq" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "randomIosTotal" : 0.0,
    "randomBytesTotal" : 0.0,
    "cumulativeLBA" : 0.0,
    "cumulativeDeltaLBA" : 0.0
  } ],
  "poolStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "poolId" : "string"
  } ],
  "applicationStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "applicationId" : "string"
  } ],
  "workloadStats" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "lastResetTime" : "string",
    "lastResetTimeInMS" : "string",
    "arrayId" : "string",
    "arrayWwn" : "string",
    "memberIdsHash" : "string",
    "readOps" : 0.0,
    "readHitOps" : 0.0,
    "readHitBytes" : 0.0,
    "readTimeTotal" : 0.0,
    "readHitTimeTotal" : 0.0,
    "writeOps" : 0.0,
    "writeTimeTotal" : 0.0,
    "writeHitTimeTotal" : 0.0,
    "errRedundancyChkIndeterminateReads" : 0.0,
    "errRedundancyChkRecoveredReads" : 0.0,
    "errRedundancyChkUnrecoveredReads" : 0.0,
    "idleTime" : 0.0,
    "otherOps" : 0.0,
    "otherTimeMax" : 0.0,
    "otherTimeTotal" : 0.0,
    "readBytes" : 0.0,
    "readHitTimeMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "flashCacheReadHitTimeTotal" : 0.0,
    "flashCacheReadHitTimeMax" : 0.0,
    "workloadId" : "string"
  } ]
}

3.18.25. Get a subset of raw volume statistics

GET /devmgr/v2/storage-systems/{system-id}/volume-statistics/{idlist}
Description

This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

idlist
required

A comma separated list of volume ids

< string > array(csv)

Query

usecache
optional

When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data.

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

< VolumeIOStats > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-statistics/string
Request query
{
  "usecache" : true
}
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "lastResetTime" : "string",
  "lastResetTimeInMS" : "string",
  "volumeGroupId" : "string",
  "controllerId" : "string",
  "volumeId" : "string",
  "arrayId" : "string",
  "arrayWwn" : "string",
  "volumeGroupWwn" : "string",
  "volumeName" : "string",
  "volumeWwn" : "string",
  "workloadId" : "string",
  "readOps" : 0.0,
  "readHitOps" : 0.0,
  "readHitBytes" : 0.0,
  "readTimeTotal" : 0.0,
  "readHitTimeTotal" : 0.0,
  "writeOps" : 0.0,
  "writeCacheHitOps" : 0.0,
  "writeTimeTotal" : 0.0,
  "writeHitTimeTotal" : 0.0,
  "errRedundancyChkIndeterminateReads" : 0.0,
  "errRedundancyChkRecoveredReads" : 0.0,
  "errRedundancyChkUnrecoveredReads" : 0.0,
  "idleTime" : 0.0,
  "otherOps" : 0.0,
  "otherTimeMax" : 0.0,
  "otherTimeTotal" : 0.0,
  "otherTimeTotalSq" : 0.0,
  "readBytes" : 0.0,
  "readHitTimeMax" : 0.0,
  "readHitTimeTotalSq" : 0.0,
  "readTimeMax" : 0.0,
  "readTimeTotalSq" : 0.0,
  "writeBytes" : 0.0,
  "writeHitBytes" : 0.0,
  "writeHitOps" : 0.0,
  "writeHitTimeMax" : 0.0,
  "writeHitTimeTotalSq" : 0.0,
  "writeTimeMax" : 0.0,
  "writeTimeTotalSq" : 0.0,
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "randomIosTotal" : 0.0,
  "randomBytesTotal" : 0.0,
  "cacheWriteWaitHitIops" : 0.0,
  "cacheWriteWaitHitBytes" : 0.0,
  "fullStripeWriteBytes" : 0.0,
  "totalIosShipped" : 0.0,
  "totalBlksEvicted" : 0.0,
  "cacheBlksInUse" : 0.0,
  "prefetchHitBytes" : 0.0,
  "prefetchMissBytes" : "string",
  "flashCacheReadHitOps" : 0.0,
  "flashCacheReadHitBytes" : 0.0,
  "flashCacheReadHitTimeTotal" : 0.0,
  "flashCacheReadHitTimeMax" : 0.0,
  "flashCacheReadHitTimeTotalSq" : 0.0
} ]

3.18.26. Get all raw volume statistics

GET /devmgr/v2/storage-systems/{system-id}/volume-statistics
Description

This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

usecache
optional

When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data.

boolean

"true"

Responses
HTTP Code Description Schema

200

successful operation

< VolumeIOStats > array

404

StorageDevice not found

422

Failure retrieving the requested statistics

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-statistics
Request query
{
  "usecache" : true
}
Example HTTP response
Response 200
{
  "observedTime" : "string",
  "observedTimeInMS" : "string",
  "lastResetTime" : "string",
  "lastResetTimeInMS" : "string",
  "volumeGroupId" : "string",
  "controllerId" : "string",
  "volumeId" : "string",
  "arrayId" : "string",
  "arrayWwn" : "string",
  "volumeGroupWwn" : "string",
  "volumeName" : "string",
  "volumeWwn" : "string",
  "workloadId" : "string",
  "readOps" : 0.0,
  "readHitOps" : 0.0,
  "readHitBytes" : 0.0,
  "readTimeTotal" : 0.0,
  "readHitTimeTotal" : 0.0,
  "writeOps" : 0.0,
  "writeCacheHitOps" : 0.0,
  "writeTimeTotal" : 0.0,
  "writeHitTimeTotal" : 0.0,
  "errRedundancyChkIndeterminateReads" : 0.0,
  "errRedundancyChkRecoveredReads" : 0.0,
  "errRedundancyChkUnrecoveredReads" : 0.0,
  "idleTime" : 0.0,
  "otherOps" : 0.0,
  "otherTimeMax" : 0.0,
  "otherTimeTotal" : 0.0,
  "otherTimeTotalSq" : 0.0,
  "readBytes" : 0.0,
  "readHitTimeMax" : 0.0,
  "readHitTimeTotalSq" : 0.0,
  "readTimeMax" : 0.0,
  "readTimeTotalSq" : 0.0,
  "writeBytes" : 0.0,
  "writeHitBytes" : 0.0,
  "writeHitOps" : 0.0,
  "writeHitTimeMax" : 0.0,
  "writeHitTimeTotalSq" : 0.0,
  "writeTimeMax" : 0.0,
  "writeTimeTotalSq" : 0.0,
  "queueDepthTotal" : 0.0,
  "queueDepthMax" : 0.0,
  "randomIosTotal" : 0.0,
  "randomBytesTotal" : 0.0,
  "cacheWriteWaitHitIops" : 0.0,
  "cacheWriteWaitHitBytes" : 0.0,
  "fullStripeWriteBytes" : 0.0,
  "totalIosShipped" : 0.0,
  "totalBlksEvicted" : 0.0,
  "cacheBlksInUse" : 0.0,
  "prefetchHitBytes" : 0.0,
  "prefetchMissBytes" : "string",
  "flashCacheReadHitOps" : 0.0,
  "flashCacheReadHitBytes" : 0.0,
  "flashCacheReadHitTimeTotal" : 0.0,
  "flashCacheReadHitTimeMax" : 0.0,
  "flashCacheReadHitTimeTotalSq" : 0.0
} ]

3.19. Storage-Systems

3.19.1. Get discovery results

GET /devmgr/v2/discovery
Description

Retrieve the results of a discovery operation on a range of IP addresses. Recent previous results can be retrieved using their requestId.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Schema

Query

requestId
optional

integer (int64)

Query

excludeManagedSystems
optional

boolean

Responses
HTTP Code Description Schema

200

successful operation

DiscoverResponse

404

Response not available

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/discovery
Request query
{
  "requestId" : 0,
  "excludeManagedSystems" : true
}
Example HTTP response
Response 200
{
  "requestId" : "string",
  "currentCount" : 0,
  "total" : 0,
  "lastStart" : "string",
  "discoverProcessRunning" : true,
  "storageSystems" : [ {
    "serialNumber" : "string",
    "wwn" : "string",
    "label" : "string",
    "firmware" : "string",
    "nvsram" : "string",
    "ipAddresses" : [ "string" ],
    "needsAttention" : true,
    "controllers" : [ {
      "ipAddresses" : [ "string" ],
      "certificateStatus" : "string"
    } ],
    "enabledManagementPorts" : [ "string" ]
  } ]
}

3.19.2. Discover StorageDevices on the network

POST /devmgr/v2/discovery
Description

Initiate a discovery operation on a range of IP addresses. Retrieve the results using a GET.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Schema

Body

body
optional

DiscoveryStartRequest

Responses
HTTP Code Description Schema

202

Discovery request accepted

DiscoverResponse

422

Invalid parameter

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/discovery
Request body
{
  "startIP" : "string",
  "endIP" : "string",
  "useAgents" : true,
  "connectionTimeout" : 0,
  "maxPortsToUse" : 0
}
Example HTTP response
Response 202
{
  "requestId" : "string",
  "currentCount" : 0,
  "total" : 0,
  "lastStart" : "string",
  "discoverProcessRunning" : true,
  "storageSystems" : [ {
    "serialNumber" : "string",
    "wwn" : "string",
    "label" : "string",
    "firmware" : "string",
    "nvsram" : "string",
    "ipAddresses" : [ "string" ],
    "needsAttention" : true,
    "controllers" : [ {
      "ipAddresses" : [ "string" ],
      "certificateStatus" : "string"
    } ],
    "enabledManagementPorts" : [ "string" ]
  } ]
}

3.19.3. Cancel discovery operation

DELETE /devmgr/v2/discovery
Description

Proxy Only. Cancel a running discovery operation.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Responses
HTTP Code Description Schema

204

Operation cancelled

422

Error cancelling operation

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/discovery
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.19.4. Get all Folders

GET /devmgr/v2/folders
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Responses
HTTP Code Description Schema

200

successful operation

< Folder > array

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/folders
Example HTTP response
Response 200
{
  "folderId" : "string",
  "parentFolderId" : "string",
  "name" : "string",
  "reserved" : true,
  "rules" : [ {
    "ruleType" : "string",
    "key" : "string",
    "value" : "string"
  } ],
  "storageSystemIds" : [ "string" ]
} ]

3.19.5. Create a Folder

POST /devmgr/v2/folders
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Schema

Body

body
optional

FolderCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

Folder

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/folders
Request body
{
  "parentId" : "string",
  "name" : "string",
  "rules" : [ {
    "ruleType" : "string",
    "key" : "string",
    "value" : "string"
  } ],
  "storageSystemIds" : [ "string" ]
}
Example HTTP response
Response 200
{
  "folderId" : "string",
  "parentFolderId" : "string",
  "name" : "string",
  "reserved" : true,
  "rules" : [ {
    "ruleType" : "string",
    "key" : "string",
    "value" : "string"
  } ],
  "storageSystemIds" : [ "string" ]
}

3.19.6. Get a Folder

GET /devmgr/v2/folders/{folder-id}
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Schema

Path

folder-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

Folder

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/folders/string
Example HTTP response
Response 200
{
  "folderId" : "string",
  "parentFolderId" : "string",
  "name" : "string",
  "reserved" : true,
  "rules" : [ {
    "ruleType" : "string",
    "key" : "string",
    "value" : "string"
  } ],
  "storageSystemIds" : [ "string" ]
}

3.19.7. Update a Folder

POST /devmgr/v2/folders/{folder-id}
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Schema

Path

folder-id
required

string

Body

body
optional

FolderUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

Folder

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/folders/string
Request body
{
  "parentId" : "string",
  "name" : "string",
  "rules" : [ {
    "ruleType" : "string",
    "key" : "string",
    "value" : "string"
  } ],
  "storageSystemIds" : [ "string" ]
}
Example HTTP response
Response 200
{
  "folderId" : "string",
  "parentFolderId" : "string",
  "name" : "string",
  "reserved" : true,
  "rules" : [ {
    "ruleType" : "string",
    "key" : "string",
    "value" : "string"
  } ],
  "storageSystemIds" : [ "string" ]
}

3.19.8. Delete a Folder

DELETE /devmgr/v2/folders/{folder-id}
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Schema

Path

folder-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/folders/string
Example HTTP response
Response 200
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.19.9. Get StorageDevices associated with a Folder

GET /devmgr/v2/folders/{folder-id}/storage-devices
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Schema

Path

folder-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

< string > array

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/folders/string/storage-devices
Example HTTP response
Response 200
[ "string" ]

3.19.10. Retrieve information about the storage system lockdown status.

GET /devmgr/v2/storage-systems/{system-id}/lockdownstatus
MetaData

x-mode = both
x-allowedRoles = [ALL_ACCESS, NO_XSRF_PROTECTION]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

"1"

Responses
HTTP Code Description Schema

200

successful operation

LockdownStatusResponse

404

Storage device not found

422

System-id invalid, unable to process

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/lockdownstatus
Example HTTP response
Response 200
{
  "isLockdown" : true,
  "storageSystemLabel" : "string",
  "lockdownType" : "string"
}

3.19.11. Retrieve the ObjectGraph, which contains all configuration details for the storage-system.

GET /devmgr/v2/storage-systems/{system-id}/graph
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

ObjectBundle

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/graph
Example HTTP response
Response 200
{
  "configGeneration" : "string",
  "sa" : {
    "saData" : {
      "needsAttention" : true,
      "fixing" : true,
      "saId" : {
        "worldWideName" : "string"
      },
      "managementClassName" : "string",
      "storageArrayLabel" : "string",
      "bootTime" : "string",
      "fwVersion" : "string",
      "appVersion" : "string",
      "bootVersion" : "string",
      "nvsramVersion" : "string",
      "fwPrefix" : "string",
      "chassisSerialNumber" : "string",
      "eventConfigurationDataVersion" : "string",
      "arrayAttributes" : [ 0 ],
      "res4" : [ 0 ],
      "res5" : [ 0 ],
      "res6" : [ 0 ],
      "res7" : "string",
      "extendedSAData" : {
        "reserved1" : "string",
        "codeVersions" : [ {
          "codeModule" : "string",
          "versionString" : "string"
        } ]
      }
    },
    "safeId" : {
      "worldWideName" : "string"
    },
    "cache" : {
      "cacheBlkSize" : 0,
      "demandFlushAmount" : 0,
      "demandFlushThreshold" : 0,
      "reserved1" : "string",
      "reserved2" : "string",
      "cacheMirroringProtectionInformation" : true
    },
    "accessVolume" : {
      "enabled" : true,
      "volumeHandle" : 0,
      "capacity" : "string",
      "accessVolumeRef" : "string",
      "reserved1" : "string"
    },
    "featureParameters" : {
      "maxHotSpares" : 0,
      "cacheBlockSizes" : [ 0 ],
      "maxDCEDrives" : 0,
      "maxReadAheadMultiplier" : 0,
      "minMediaScanPeriod" : 0,
      "maxMediaScanPeriod" : 0,
      "supportedSegSizes" : [ 0 ],
      "numStandardSegSizes" : 0,
      "segTransitions" : [ "string" ],
      "mappableLUNCount" : 0,
      "maxPartitionCount" : 0,
      "maxMappingsPerVolume" : 0,
      "maxVolumes" : 0,
      "maxSnapshots" : 0,
      "maxSnapshotsPerBase" : 0,
      "minRepositorySize" : 0,
      "maxMirrors" : 0,
      "maxVolCopys" : 0,
      "maxConcurrentBackgroundCopys" : 0,
      "maxUtmLunValue" : 0,
      "reserved1" : "string",
      "reserved2" : "string",
      "battery_not_in_configuration" : true,
      "supportedDriveTypes" : [ "string" ],
      "currentMaxMirrors" : 0,
      "maxVolumesPerGroup" : 0,
      "maxDriveDownloadFiles" : 0,
      "maxMgmtClientRecords" : 0,
      "maxMgmtClientRecordSize" : 0,
      "redundancyMode" : "string",
      "maxExpansionDriveTrays" : 0,
      "supportedAuthMethods" : [ "string" ],
      "maxIscsiIpv6LocalAddressesPerPort" : 0,
      "maxIscsiIpv6RoutableAddressesPerPort" : 0,
      "absoluteMaxDssSegmentSize" : 0,
      "smartBatteryTechnology" : true,
      "writeCachingEnabledDuringLearnCycle" : true,
      "maxSSDsSupported" : 0,
      "ssdInterfaceTypeMixingSupported" : true,
      "maxDriveSlots" : 0,
      "supportedProtectionTypes" : [ "string" ],
      "supportedEventPriorities" : [ "string" ],
      "maxFlashCacheSize" : "string",
      "defaultMediaScanPeriod" : 0
    },
    "mediaScanPeriod" : 0,
    "capabilities" : [ "string" ],
    "premiumFeatures" : [ {
      "capability" : "string",
      "isEnabled" : true,
      "isCompliant" : true,
      "isWithinLimits" : true,
      "featureId" : "string"
    } ],
    "trayPositionList" : {
      "trayPosition" : [ {
        "trayId" : 0,
        "rackId" : 0
      } ]
    },
    "hostPortType" : [ "string" ],
    "hostSpecificVals" : [ {
      "waitForDownload" : true,
      "notReadySenseForQuiescenceInProgress" : true,
      "notReadySenseForQuiescenceInProgress2" : true,
      "checkConditionForVendorUniqueUAConditions" : true,
      "reportDeferredErrors" : true,
      "ignoreForceUnitAccess" : true,
      "ignoreWriteCacheDisable" : true,
      "allowReservationOnUnownedLUNs" : true,
      "worldWideNameInStandardInquiry" : true,
      "propagateHostBusResets" : true,
      "reportSCCDeviceEnable" : true,
      "conditionalFCLogout" : true,
      "forceSCSI2" : true,
      "reportUnconfiguredLUNs" : true,
      "ignoreSyncCache" : true,
      "ignoreUTMLunOwnership" : true,
      "reportLUNPreferredPathInStandardInquiry" : true,
      "autoLUNTransfer" : true,
      "inquiryUnconfiguredDeviceType" : "string",
      "inquiryUnownedDeviceType" : "string",
      "unownedBlock0Read" : "string",
      "retainLogins" : true,
      "hostPortType" : "string",
      "maxRestrictedLUNs" : 0,
      "reserved1" : "string",
      "avtExclusionExtentsEnabled" : true,
      "suppressVolOffPreferredPathAlert" : true,
      "hostType" : "string",
      "tpgsSupported" : true,
      "volumeFormatOptions" : true,
      "restrictedLun0" : true,
      "usePage2CQuiescenceTimeout" : true,
      "asymmetricLUAccess" : true,
      "ignoreISCSISessionIDInITN" : true,
      "enableLUCheckConditionParallelResponses" : true,
      "disableExplicitTPGS" : true,
      "unownedCheckConditionDuringFWActivation" : true,
      "allowPreferredOwnerReportingSuppression" : true,
      "enableTargetFailback" : true,
      "enableAutoLoadBalance" : true,
      "quiescenceInProgressSenseKey" : 0,
      "quiescenceInProgressASC" : 0,
      "quiescenceInProgressASCQ" : 0,
      "persistentID" : 0,
      "nvmeVUFailoverSupported" : true,
      "nvmeStandardFailoverSupported" : true
    } ],
    "compatibility" : [ {
      "fwVersion" : "string",
      "compatible" : true
    } ],
    "usageHints" : [ {
      "usageHint" : "string",
      "segmentSize" : 0,
      "readAhead" : 0
    } ],
    "definedPartitionCount" : 0,
    "defaultHostPortTypeIndex" : 0,
    "remoteAccessID" : "string",
    "remoteMirroringActive" : true,
    "volXferAlertDelayPeriod" : 0,
    "reserved1" : "string",
    "reserved2" : "string",
    "stagedFirmware" : {
      "stagedFwValid" : true,
      "fwVersion" : "string",
      "appVersion" : "string",
      "bootVersion" : "string",
      "nvsramVersion" : "string",
      "timeStamp" : "string",
      "nvsramVersionString" : "string",
      "codeVersions" : [ {
        "codeModule" : "string",
        "versionString" : "string"
      } ]
    },
    "unreadableSectors" : {
      "count" : 0,
      "maxLimit" : 0
    },
    "driveChannels" : [ {
      "channel" : 0,
      "state" : "string",
      "reason" : "string",
      "degradingController" : "string",
      "statsControllerA" : {
        "startTimeStamp" : "string",
        "endTimeStamp" : "string",
        "totalIoCount" : 0,
        "totalIoErrorCount" : 0,
        "linkStatus" : "string",
        "errorCounts" : {
          "nonChannelErrors" : 0,
          "timeoutErrors" : 0,
          "controllerDetectedErrors" : 0,
          "driveDetectedErrors" : 0,
          "linkDownErrors" : 0
        }
      },
      "statsControllerB" : {
        "startTimeStamp" : "string",
        "endTimeStamp" : "string",
        "totalIoCount" : 0,
        "totalIoErrorCount" : 0,
        "linkStatus" : "string",
        "errorCounts" : {
          "nonChannelErrors" : 0,
          "timeoutErrors" : 0,
          "controllerDetectedErrors" : 0,
          "driveDetectedErrors" : 0,
          "linkDownErrors" : 0
        }
      }
    } ],
    "portLocations" : [ {
      "portRef" : "string",
      "channel" : 0,
      "portType" : "string",
      "parentType" : {
        "driveChannelParent" : "string",
        "controllerRef" : "string",
        "minihubRef" : "string"
      }
    } ],
    "ddcTag" : 0,
    "featureBundle" : {
      "name" : "string",
      "bundledFeatures" : [ {
        "featureId" : "string",
        "featureAttribute" : [ {
          "featureAttrId" : "string",
          "keyEnabled" : true,
          "keyLimit" : 0,
          "shippedEnabled" : true,
          "shippedLimit" : 0,
          "subjectToGoldKey" : true,
          "supportedValues" : [ "string" ],
          "evaluationDuration" : 0
        } ]
      } ],
      "bundleSubmodelId" : "string"
    },
    "featureState" : [ {
      "capability" : "string",
      "isEnabled" : true,
      "isCompliant" : true,
      "isWithinLimits" : true,
      "featureId" : "string",
      "featureRef" : "string",
      "limit" : 0,
      "duration" : 0,
      "enabledTime" : "string",
      "supportedFeatureBundleId" : 0,
      "permanentLicenseApplied" : true
    } ],
    "channelPortLocations" : [ {
      "portRef" : "string",
      "portParent" : {
        "type" : "string",
        "controllerRef" : "string",
        "esmRef" : "string",
        "minihubRef" : "string",
        "hicRef" : "string"
      },
      "portNumber" : 0,
      "channel" : 0,
      "channelType" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "isTrunkActive" : true,
      "id" : "string"
    } ],
    "iscsiEntityData" : {
      "icmpPingResponseEnabled" : true,
      "unnamedDiscoverySessionsEnabled" : true,
      "isnsServerTcpListenPort" : 0,
      "ipv4IsnsServerAddressConfigMethod" : "string",
      "ipv4IsnsServerAddress" : "string",
      "ipv6IsnsServerAddressConfigMethod" : "string",
      "ipv6IsnsServerAddress" : "string",
      "isnsRegistrationState" : "string",
      "isnsServerRegistrationEnabled" : true,
      "hostPortsConfiguredDHCP" : true
    },
    "hostType" : [ "string" ],
    "defaultHostTypeIndex" : 0,
    "rvmControllerHostChannel" : 0,
    "smartBatteryData" : {
      "lastBatteryLearnCycle" : "string",
      "nextBatteryLearnCycle" : "string",
      "batteryLearnCycleInterval" : 0
    },
    "invalidSystemConfig" : true,
    "securityLockKey" : true,
    "lockKeyIDRef" : "string",
    "syslogConfiguration" : {
      "syslogEnabled" : true,
      "syslogServerPortNumber" : 0,
      "syslogServerIpAddress" : {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      }
    },
    "securityExternalKmsEnable" : true,
    "newKeySequence" : 0,
    "securityExternalKmsKeyStatus" : "string",
    "lockKeyNeededList" : [ "string" ],
    "dplCoreDumpData" : {
      "dplCoreDumpTag" : 0,
      "dplCoreDumpNeedsRetrieved" : true,
      "dplCoreDumpEnabled" : true,
      "timeStamp" : "string"
    },
    "fcRVMState" : "string",
    "asupEnabled" : true,
    "asupOnDemandEnabled" : true,
    "asupRemoteDiagsEnabled" : true,
    "iocDumpData" : {
      "iocDumpEnabled" : true,
      "iocDumpNeedsRetrieved" : true,
      "iocDumpTag" : 0,
      "timeStamp" : "string"
    },
    "driveChannelPortDisabled" : true,
    "directExpansionPortInUse" : true,
    "highResolutionStatisticsEnabled" : true,
    "autoLoadBalancingEnabled" : true,
    "reserved3" : "string",
    "embeddedExternalKMSInformation" : {
      "installedKMSCertificateFile" : [ "string" ],
      "kmsEndpoint" : {
        "kmsAddress" : {
          "addrType" : "string",
          "domainName" : "string",
          "ipvxAddress" : {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          }
        },
        "kmsPort" : 0
      }
    },
    "isLun0RestrictedForDefaultPartition" : true,
    "securitySettings" : {
      "certificateRevocationSettings" : {
        "certificateRevocationCheckEnabled" : true,
        "ocspResponderAddress" : "string",
        "isOCSPResponderAddressSet" : true
      }
    },
    "parityCheckOnMediaType" : {
      "enabledOnHDD" : true,
      "enabledOnSSD" : true
    },
    "hostConnectivityReportingEnabled" : true,
    "vaaienabled" : true,
    "odxenabled" : true
  },
  "tray" : [ {
    "type" : "string",
    "orientation" : "string",
    "numControllerSlots" : 0,
    "numDriveSlots" : 0,
    "trayId" : 0,
    "trayRef" : "string",
    "nonRedundantAccess" : true,
    "partNumber" : "string",
    "serialNumber" : "string",
    "vendorName" : "string",
    "manufacturerDate" : "string",
    "fruType" : "string",
    "trayIDMismatch" : true,
    "trayIDConflict" : true,
    "esmVersionMismatch" : true,
    "esmMiswire" : true,
    "drvMHSpeedMismatch" : true,
    "unsupportedTray" : true,
    "workingChannel" : 0,
    "maxSpeed" : "string",
    "trayTechnologyType" : "string",
    "esmGroupError" : true,
    "uncertifiedTray" : true,
    "locateTray" : true,
    "esmHardwareMismatch" : true,
    "hasConfigurableTrayId" : true,
    "frontEndInterfaceTechnology" : "string",
    "driveTechnologies" : [ "string" ],
    "numDriveCompartments" : 0,
    "numDriveSlotsPerCompartment" : 0,
    "trayAttributes" : [ {
      "attributeId" : "string",
      "attributeValue" : "string"
    } ],
    "isMisconfigured" : true,
    "esmFactoryDefaultsMismatch" : true,
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "numDrawers" : 0,
    "driveLayout" : {
      "driveOrientation" : "string",
      "numRows" : 0,
      "numColumns" : 0,
      "primaryTraversal" : "string",
      "secondaryTraversal" : "string"
    },
    "factoryDefaultsData" : {
      "factoryDefaultsVersion" : "string",
      "isSupported" : true
    },
    "locateInProgress" : true,
    "hasTrayIdentityIndicator" : true,
    "id" : "string"
  } ],
  "componentBundle" : {
    "fan" : [ {
      "fanRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "reserved1" : "string",
      "reserved2" : "string",
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "id" : "string"
    } ],
    "battery" : [ {
      "batteryRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "batteryAge" : 0,
      "batteryLifeRemaining" : 0,
      "batteryTypeData" : {
        "batteryType" : "string",
        "cruParentController" : "string",
        "parentController" : "string"
      },
      "reserved1" : "string",
      "reserved2" : "string",
      "manufacturerDate" : "string",
      "vendorName" : "string",
      "vendorPN" : "string",
      "vendorSN" : "string",
      "fruType" : "string",
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "batteryCanExpire" : true,
      "automaticAgeReset" : true,
      "learnCycleData" : {
        "lastBatteryLearnCycle" : "string",
        "nextBatteryLearnCycle" : "string",
        "batteryLearnCycleInterval" : 0
      },
      "id" : "string"
    } ],
    "powerSupply" : [ {
      "powerSupplyRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "partNumber" : "string",
      "serialNumber" : "string",
      "vendorName" : "string",
      "manufacturerDate" : "string",
      "fruType" : "string",
      "reserved1" : "string",
      "reserved2" : "string",
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "firmwareRevision" : "string",
      "manufacturingDeviceCode" : 0,
      "id" : "string"
    } ],
    "thermalSensor" : [ {
      "thermalSensorRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "reserved1" : "string",
      "reserved2" : "string",
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "id" : "string"
    } ],
    "esm" : [ {
      "esmRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "nonRedundantAccess" : true,
      "partNumber" : "string",
      "serialNumber" : "string",
      "manufacturerDate" : "string",
      "manufacturer" : "string",
      "fruType" : "string",
      "softwareVersion" : "string",
      "esmInterfaceData" : {
        "ioInterfaceType" : "string",
        "portList" : {
          "ports" : [ {
            "portStatus" : "string",
            "portType" : "string",
            "reserved1" : "string",
            "reserved2" : "string"
          } ]
        }
      },
      "productID" : "string",
      "workingChannel" : 0,
      "currentSpeed" : "string",
      "maxSpeed" : "string",
      "reserved1" : "string",
      "reserved2" : "string",
      "fibreEsm" : {
        "esmPortRef" : "string",
        "loopID" : 0,
        "portRef" : "string"
      },
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "esmInterfaceAttributes" : {
        "ioInterfaceType" : "string",
        "fibreEsmAttributes" : {
          "isSwitched" : true,
          "fibreEsmAddress" : {
            "esmPortRef" : "string",
            "loopID" : 0,
            "portRef" : "string"
          }
        },
        "sasEsmAttributes" : {
          "sasExpander" : [ "string" ]
        }
      },
      "boardId" : "string",
      "factoryDefaultsData" : {
        "isSupported" : true,
        "factoryDefaultsVersion" : "string"
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "isTrunkCapable" : true,
      "trunkMiswire" : true,
      "locateInProgress" : true,
      "hasTrayIdentityIndicator" : true,
      "esmType" : "string",
      "id" : "string"
    } ],
    "ups" : [ {
      "upsRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "reserved1" : "string",
      "reserved2" : "string"
    } ],
    "minihub" : [ {
      "minihubRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "minihubData" : {
        "minihubType" : "string",
        "parentController" : "string"
      },
      "currentSpeed" : "string",
      "maxSpeed" : "string",
      "channel" : 0,
      "portList" : {
        "ports" : [ {
          "portStatus" : "string",
          "portType" : "string",
          "reserved1" : "string",
          "reserved2" : "string"
        } ]
      },
      "vendorName" : "string",
      "partNumber" : "string",
      "serialNumber" : "string",
      "fruType" : "string",
      "manufacturerDate" : "string",
      "reserved1" : "string",
      "reserved2" : "string",
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      }
    } ],
    "gbic" : [ {
      "gbicRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "gbicType" : "string",
      "gbicPort" : "string",
      "parentData" : {
        "gbicParentType" : "string",
        "controllerGBIC" : {
          "controllerGBICType" : "string",
          "parentController" : "string",
          "channel" : 0,
          "reserved1" : "string",
          "reserved2" : "string"
        },
        "parentEsm" : "string",
        "parentMinihub" : "string"
      },
      "reserved1" : "string",
      "reserved2" : "string"
    } ],
    "sfp" : [ {
      "sfpRef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "sfpType" : {
        "sfpIdentType" : "string",
        "sfpConnectType" : "string",
        "sfpLinkLType" : "string",
        "sfpTransmitterType" : "string",
        "sfpSpeed" : [ "string" ],
        "sfpTransmissionMedia" : [ "string" ],
        "manufacturerDate" : "string",
        "vendorName" : "string",
        "vendorPN" : "string",
        "vendorRev" : "string",
        "vendorSN" : "string",
        "vendorOUI" : "string",
        "reserved1" : "string",
        "reserved2" : "string"
      },
      "sfpPort" : "string",
      "parentData" : {
        "sfpParentType" : "string",
        "controllerSFP" : {
          "controllerSFPType" : "string",
          "parentController" : "string",
          "channel" : 0,
          "reserved1" : "string",
          "reserved2" : "string"
        },
        "parentEsm" : "string",
        "parentMinihub" : "string"
      },
      "reserved1" : "string",
      "reserved2" : "string",
      "sfpPortRef" : "string",
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "id" : "string"
    } ],
    "interconnectCRU" : [ {
      "interconnectCRURef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "manufacturerDate" : "string",
      "vendorName" : "string",
      "vendorPN" : "string",
      "vendorSN" : "string",
      "fruType" : "string",
      "readyToRemove" : true,
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      }
    } ],
    "supportCRU" : [ {
      "supportCRURef" : "string",
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "manufacturerDate" : "string",
      "vendorName" : "string",
      "vendorPN" : "string",
      "vendorSN" : "string",
      "fruType" : "string",
      "readyToRemove" : true,
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "configuredComponents" : [ "string" ],
      "type" : "string",
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "id" : "string"
    } ],
    "alarm" : [ {
      "alarmRef" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "status" : "string",
      "isManageable" : true,
      "rtrAttributes" : {
        "cruType" : "string",
        "parentCru" : {
          "type" : "string",
          "parentController" : "string",
          "parentEsm" : "string",
          "parentFan" : "string",
          "parentInterconnectCru" : "string",
          "parentSupportCru" : "string",
          "parentDrawer" : "string"
        },
        "rtrAttributeData" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      }
    } ],
    "hostBoard" : [ {
      "parentController" : "string",
      "partNumber" : "string",
      "serialNumber" : "string",
      "vendorName" : "string",
      "manufacturerDate" : "string",
      "fruType" : "string",
      "hostBoardId" : "string",
      "status" : "string",
      "type" : "string",
      "hostBoardRef" : "string",
      "numberOfPorts" : 0,
      "hbTypeData" : {
        "type" : "string",
        "dualPortIbTypeData" : {
          "tcaGuid" : "string",
          "queuePairsSupported" : 0,
          "completionQueuesSupported" : 0,
          "sharedReceiveQueuesSupported" : 0
        },
        "dualPortDenaliIbTypeData" : {
          "tcaGuid" : "string",
          "queuePairsSupported" : 0,
          "completionQueuesSupported" : 0,
          "sharedReceiveQueuesSupported" : 0
        }
      },
      "oemPartNumber" : "string",
      "hostBoardControllerSlot" : 0,
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "id" : "string"
    } ],
    "sasExpander" : [ {
      "expanderRef" : "string",
      "parent" : {
        "expanderParentType" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentDrawer" : "string"
      },
      "channel" : 0,
      "deviceName" : "string",
      "vendorId" : "string",
      "productId" : "string",
      "fwVersion" : "string",
      "expanderPorts" : [ {
        "parent" : {
          "type" : "string",
          "controller" : "string",
          "drive" : "string",
          "expander" : "string",
          "hostBoardRef" : "string"
        },
        "attachedDevice" : {
          "channel" : 0,
          "channelType" : "string",
          "sasAttachedDeviceData" : {
            "type" : "string",
            "alternateController" : "string",
            "drive" : "string",
            "expander" : "string",
            "remoteHostPortAddress" : "string",
            "localController" : "string",
            "physicalLocation" : {
              "trayRef" : "string",
              "slot" : 0,
              "locationParent" : {
                "refType" : "string",
                "controllerRef" : "string",
                "symbolRef" : "string",
                "typedReference" : {
                  "componentType" : "string",
                  "symbolRef" : "string"
                }
              },
              "locationPosition" : 0,
              "label" : "string"
            }
          }
        },
        "state" : "string",
        "miswireType" : "string",
        "channelPortRef" : "string",
        "sasPhys" : [ {
          "phyIdentifier" : 0,
          "isOperational" : true
        } ],
        "portTypeData" : {
          "portType" : "string",
          "portIdentifier" : "string",
          "routingType" : "string"
        },
        "portMode" : "string",
        "domainNumber" : 0,
        "attachedChannelPortRef" : "string",
        "discoveryStatus" : 0
      } ],
      "domainNumber" : 0,
      "id" : "string"
    } ],
    "cacheBackupDevice" : [ {
      "backupDeviceRef" : "string",
      "backupDeviceControllerSlot" : 0,
      "parentController" : "string",
      "backupDeviceType" : "string",
      "backupDeviceStatus" : "string",
      "backupDeviceVpd" : {
        "manufacturer" : "string",
        "manufactureDate" : "string",
        "productId" : "string",
        "productRevLevel" : "string",
        "partNumber" : "string",
        "serialNumber" : "string"
      },
      "backupDeviceCapacity" : 0,
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "id" : "string"
    } ],
    "cacheMemoryDimm" : [ {
      "cacheMemoryDimmRef" : "string",
      "status" : "string",
      "capacityInMegabytes" : 0,
      "serialNumber" : "string",
      "partNumber" : "string",
      "oemPartNumber" : "string",
      "manufacturerPartNumber" : "string",
      "manufacturer" : "string",
      "manufactureDate" : "string",
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "shared" : true,
      "revisionCode" : "string"
    } ],
    "processorMemoryDimm" : [ {
      "processorMemoryDimmRef" : "string",
      "parentController" : "string",
      "dimmControllerSlot" : 0,
      "status" : "string",
      "capacityInMegabytes" : 0,
      "serialNumber" : "string",
      "partNumber" : "string",
      "oemPartNumber" : "string",
      "manufacturerPartNumber" : "string",
      "manufacturer" : "string",
      "manufactureDate" : "string",
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "revisionCode" : "string"
    } ],
    "drawer" : [ {
      "drawerRef" : "string",
      "isOpen" : true,
      "status" : "string",
      "physicalLocation" : {
        "trayRef" : "string",
        "slot" : 0,
        "locationParent" : {
          "refType" : "string",
          "controllerRef" : "string",
          "symbolRef" : "string",
          "typedReference" : {
            "componentType" : "string",
            "symbolRef" : "string"
          }
        },
        "locationPosition" : 0,
        "label" : "string"
      },
      "repairPolicy" : {
        "removalData" : {
          "removalMethod" : "string",
          "rtrAttributes" : {
            "hasReadyToRemoveIndicator" : true,
            "readyToRemove" : true
          }
        },
        "replacementMethod" : "string"
      },
      "softwareVersion" : "string",
      "partNumber" : "string",
      "serialNumber" : "string",
      "vendorName" : "string",
      "manufactureDate" : "string",
      "fruType" : "string",
      "drawerType" : "string",
      "id" : "string"
    } ]
  },
  "controller" : [ {
    "active" : true,
    "quiesced" : true,
    "status" : "string",
    "controllerRef" : "string",
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "manufacturer" : "string",
    "manufacturerDate" : "string",
    "appVersion" : "string",
    "bootVersion" : "string",
    "productID" : "string",
    "productRevLevel" : "string",
    "serialNumber" : "string",
    "boardID" : "string",
    "cacheMemorySize" : 0,
    "processorMemorySize" : 0,
    "hostInterfaces" : [ {
      "interfaceType" : "string",
      "fibre" : {
        "channel" : 0,
        "loopID" : 0,
        "speed" : 0,
        "hardAddress" : 0,
        "nodeName" : "string",
        "portName" : "string",
        "portId" : "string",
        "topology" : "string",
        "part" : "string",
        "revision" : 0,
        "chanMiswire" : true,
        "esmMiswire" : true,
        "linkStatus" : "string",
        "isDegraded" : true,
        "speedControl" : "string",
        "maxSpeed" : 0,
        "speedNegError" : true,
        "reserved1" : "string",
        "reserved2" : "string",
        "ddsChannelState" : 0,
        "ddsStateReason" : 0,
        "ddsStateWho" : 0,
        "isLocal" : true,
        "channelPorts" : [ {
          "speedDetError" : true,
          "manuallyBypassed" : true,
          "portNumber" : "string"
        } ],
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "isTrunkCapable" : true,
        "trunkMiswire" : true,
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "ib" : {
        "interfaceRef" : "string",
        "channel" : 0,
        "channelPortRef" : "string",
        "localIdentifier" : 0,
        "globalIdentifier" : "string",
        "linkState" : "string",
        "portState" : "string",
        "maximumTransmissionUnit" : 0,
        "currentSpeed" : "string",
        "supportedSpeed" : [ "string" ],
        "currentLinkWidth" : "string",
        "supportedLinkWidth" : [ "string" ],
        "currentDataVirtualLanes" : 0,
        "maximumDataVirtualLanes" : 0,
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isSRPSupported" : true,
        "isISERSupported" : true,
        "physPortState" : "string",
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "isNVMeSupported" : true,
        "id" : "string"
      },
      "iscsi" : {
        "channel" : 0,
        "channelPortRef" : "string",
        "tcpListenPort" : 0,
        "ipv4Enabled" : true,
        "ipv4Data" : {
          "ipv4Address" : "string",
          "ipv4AddressConfigMethod" : "string",
          "ipv4OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4AddressData" : {
            "configState" : "string",
            "ipv4Address" : "string",
            "ipv4SubnetMask" : "string",
            "ipv4GatewayAddress" : "string"
          }
        },
        "interfaceData" : {
          "type" : "string",
          "ethernetData" : {
            "partData" : {
              "vendorName" : "string",
              "partNumber" : "string",
              "revisionNumber" : "string",
              "serialNumber" : "string"
            },
            "macAddress" : "string",
            "fullDuplex" : true,
            "maximumFramePayloadSize" : 0,
            "currentInterfaceSpeed" : "string",
            "maximumInterfaceSpeed" : "string",
            "linkStatus" : "string",
            "supportedInterfaceSpeeds" : [ "string" ],
            "autoconfigSupport" : true,
            "copperCableDiagnosticsSupport" : true
          },
          "infinibandData" : {
            "isIser" : true
          }
        },
        "interfaceRef" : "string",
        "ipv6Enabled" : true,
        "ipv6Data" : {
          "ipv6LocalAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6RoutableAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6PortRouterAddress" : {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          },
          "ipv6AddressConfigMethod" : "string",
          "ipv6OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6HopLimit" : 0,
          "ipv6NdReachableTime" : 0,
          "ipv6NdRetransmitTime" : 0,
          "ipv6NdStaleTimeout" : 0,
          "ipv6DuplicateAddressDetectionAttempts" : 0
        },
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isIPv6Capable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sas" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "part" : "string",
        "revision" : 0,
        "isDegraded" : true,
        "iocPort" : {
          "parent" : {
            "type" : "string",
            "controller" : "string",
            "drive" : "string",
            "expander" : "string",
            "hostBoardRef" : "string"
          },
          "attachedDevice" : {
            "channel" : 0,
            "channelType" : "string",
            "sasAttachedDeviceData" : {
              "type" : "string",
              "alternateController" : "string",
              "drive" : "string",
              "expander" : "string",
              "remoteHostPortAddress" : "string",
              "localController" : "string",
              "physicalLocation" : {
                "trayRef" : "string",
                "slot" : 0,
                "locationParent" : {
                  "refType" : "string",
                  "controllerRef" : "string",
                  "symbolRef" : "string",
                  "typedReference" : {
                    "componentType" : "string",
                    "symbolRef" : "string"
                  }
                },
                "locationPosition" : 0,
                "label" : "string"
              }
            }
          },
          "state" : "string",
          "miswireType" : "string",
          "channelPortRef" : "string",
          "sasPhys" : [ {
            "phyIdentifier" : 0,
            "isOperational" : true
          } ],
          "portTypeData" : {
            "portType" : "string",
            "portIdentifier" : "string",
            "routingType" : "string"
          },
          "portMode" : "string",
          "domainNumber" : 0,
          "attachedChannelPortRef" : "string",
          "discoveryStatus" : 0
        },
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sata" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "speedControl" : "string",
        "part" : "string",
        "revision" : 0,
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "id" : "string"
      },
      "scsi" : {
        "channel" : 0,
        "scsiID" : 0,
        "speed" : 0,
        "scsiType" : "string",
        "width" : 0,
        "part" : "string",
        "revision" : 0,
        "reserved1" : "string",
        "reserved2" : "string"
      }
    } ],
    "driveInterfaces" : [ {
      "interfaceType" : "string",
      "fibre" : {
        "channel" : 0,
        "loopID" : 0,
        "speed" : 0,
        "hardAddress" : 0,
        "nodeName" : "string",
        "portName" : "string",
        "portId" : "string",
        "topology" : "string",
        "part" : "string",
        "revision" : 0,
        "chanMiswire" : true,
        "esmMiswire" : true,
        "linkStatus" : "string",
        "isDegraded" : true,
        "speedControl" : "string",
        "maxSpeed" : 0,
        "speedNegError" : true,
        "reserved1" : "string",
        "reserved2" : "string",
        "ddsChannelState" : 0,
        "ddsStateReason" : 0,
        "ddsStateWho" : 0,
        "isLocal" : true,
        "channelPorts" : [ {
          "speedDetError" : true,
          "manuallyBypassed" : true,
          "portNumber" : "string"
        } ],
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "isTrunkCapable" : true,
        "trunkMiswire" : true,
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "ib" : {
        "interfaceRef" : "string",
        "channel" : 0,
        "channelPortRef" : "string",
        "localIdentifier" : 0,
        "globalIdentifier" : "string",
        "linkState" : "string",
        "portState" : "string",
        "maximumTransmissionUnit" : 0,
        "currentSpeed" : "string",
        "supportedSpeed" : [ "string" ],
        "currentLinkWidth" : "string",
        "supportedLinkWidth" : [ "string" ],
        "currentDataVirtualLanes" : 0,
        "maximumDataVirtualLanes" : 0,
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isSRPSupported" : true,
        "isISERSupported" : true,
        "physPortState" : "string",
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "isNVMeSupported" : true,
        "id" : "string"
      },
      "iscsi" : {
        "channel" : 0,
        "channelPortRef" : "string",
        "tcpListenPort" : 0,
        "ipv4Enabled" : true,
        "ipv4Data" : {
          "ipv4Address" : "string",
          "ipv4AddressConfigMethod" : "string",
          "ipv4OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4AddressData" : {
            "configState" : "string",
            "ipv4Address" : "string",
            "ipv4SubnetMask" : "string",
            "ipv4GatewayAddress" : "string"
          }
        },
        "interfaceData" : {
          "type" : "string",
          "ethernetData" : {
            "partData" : {
              "vendorName" : "string",
              "partNumber" : "string",
              "revisionNumber" : "string",
              "serialNumber" : "string"
            },
            "macAddress" : "string",
            "fullDuplex" : true,
            "maximumFramePayloadSize" : 0,
            "currentInterfaceSpeed" : "string",
            "maximumInterfaceSpeed" : "string",
            "linkStatus" : "string",
            "supportedInterfaceSpeeds" : [ "string" ],
            "autoconfigSupport" : true,
            "copperCableDiagnosticsSupport" : true
          },
          "infinibandData" : {
            "isIser" : true
          }
        },
        "interfaceRef" : "string",
        "ipv6Enabled" : true,
        "ipv6Data" : {
          "ipv6LocalAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6RoutableAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6PortRouterAddress" : {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          },
          "ipv6AddressConfigMethod" : "string",
          "ipv6OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6HopLimit" : 0,
          "ipv6NdReachableTime" : 0,
          "ipv6NdRetransmitTime" : 0,
          "ipv6NdStaleTimeout" : 0,
          "ipv6DuplicateAddressDetectionAttempts" : 0
        },
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isIPv6Capable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sas" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "part" : "string",
        "revision" : 0,
        "isDegraded" : true,
        "iocPort" : {
          "parent" : {
            "type" : "string",
            "controller" : "string",
            "drive" : "string",
            "expander" : "string",
            "hostBoardRef" : "string"
          },
          "attachedDevice" : {
            "channel" : 0,
            "channelType" : "string",
            "sasAttachedDeviceData" : {
              "type" : "string",
              "alternateController" : "string",
              "drive" : "string",
              "expander" : "string",
              "remoteHostPortAddress" : "string",
              "localController" : "string",
              "physicalLocation" : {
                "trayRef" : "string",
                "slot" : 0,
                "locationParent" : {
                  "refType" : "string",
                  "controllerRef" : "string",
                  "symbolRef" : "string",
                  "typedReference" : {
                    "componentType" : "string",
                    "symbolRef" : "string"
                  }
                },
                "locationPosition" : 0,
                "label" : "string"
              }
            }
          },
          "state" : "string",
          "miswireType" : "string",
          "channelPortRef" : "string",
          "sasPhys" : [ {
            "phyIdentifier" : 0,
            "isOperational" : true
          } ],
          "portTypeData" : {
            "portType" : "string",
            "portIdentifier" : "string",
            "routingType" : "string"
          },
          "portMode" : "string",
          "domainNumber" : 0,
          "attachedChannelPortRef" : "string",
          "discoveryStatus" : 0
        },
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sata" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "speedControl" : "string",
        "part" : "string",
        "revision" : 0,
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "id" : "string"
      },
      "scsi" : {
        "channel" : 0,
        "scsiID" : 0,
        "speed" : 0,
        "scsiType" : "string",
        "width" : 0,
        "part" : "string",
        "revision" : 0,
        "reserved1" : "string",
        "reserved2" : "string"
      }
    } ],
    "netInterfaces" : [ {
      "interfaceType" : "string",
      "ethernet" : {
        "interfaceName" : "string",
        "channel" : 0,
        "speed" : 0,
        "ip" : 0,
        "alias" : "string",
        "macAddr" : "string",
        "gatewayIp" : 0,
        "subnetMask" : 0,
        "bootpUsed" : true,
        "rloginEnabled" : true,
        "reserved1" : "string",
        "setupError" : true,
        "reserved2" : "string",
        "interfaceRef" : "string",
        "linkStatus" : "string",
        "ipv4Enabled" : true,
        "ipv4Address" : "string",
        "ipv4SubnetMask" : "string",
        "ipv4AddressConfigMethod" : "string",
        "ipv6Enabled" : true,
        "ipv6LocalAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6PortStaticRoutableAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6PortRoutableAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6AddressConfigMethod" : "string",
        "fullDuplex" : true,
        "supportedSpeedSettings" : [ "string" ],
        "configuredSpeedSetting" : "string",
        "currentSpeed" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        }
      }
    } ],
    "inventory" : [ {
      "itemName" : "string",
      "itemVersion" : "string"
    } ],
    "reserved1" : "string",
    "reserved2" : "string",
    "hostBoardID" : "string",
    "physicalCacheMemorySize" : 0,
    "readyToRemove" : true,
    "boardSubmodelID" : "string",
    "submodelSupported" : true,
    "oemPartNumber" : "string",
    "partNumber" : "string",
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "bootTime" : "string",
    "modelName" : "string",
    "networkSettings" : {
      "ipv4DefaultRouterAddress" : "string",
      "ipv6DefaultRouterAddress" : {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      },
      "ipv6CandidateDefaultRouterAddresses" : [ {
        "address" : "string",
        "addressState" : {
          "addressType" : "string",
          "interfaceAddressState" : "string",
          "routerAddressState" : "string"
        }
      } ],
      "remoteAccessEnabled" : true,
      "dnsProperties" : {
        "acquisitionProperties" : {
          "dnsAcquisitionType" : "string",
          "dnsServers" : [ {
            "addressType" : "string",
            "ipv4Address" : "string",
            "ipv6Address" : "string"
          } ]
        },
        "dhcpAcquiredDnsServers" : [ {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        } ]
      },
      "ntpProperties" : {
        "acquisitionProperties" : {
          "ntpAcquisitionType" : "string",
          "ntpServers" : [ {
            "addrType" : "string",
            "domainName" : "string",
            "ipvxAddress" : {
              "addressType" : "string",
              "ipv4Address" : "string",
              "ipv6Address" : "string"
            }
          } ]
        },
        "dhcpAcquiredNtpServers" : [ {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        } ]
      }
    },
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "flashCacheMemorySize" : 0,
    "ctrlIocDumpData" : {
      "iocDumpNeedsRetrieved" : true,
      "iocDumpTag" : 0,
      "timeStamp" : "string"
    },
    "locateInProgress" : true,
    "hasTrayIdentityIndicator" : true,
    "controllerErrorMode" : "string",
    "codeVersions" : [ {
      "codeModule" : "string",
      "versionString" : "string"
    } ],
    "id" : "string"
  } ],
  "drive" : [ {
    "offline" : true,
    "hotSpare" : true,
    "invalidDriveData" : true,
    "available" : true,
    "pfa" : true,
    "driveRef" : "string",
    "status" : "string",
    "cause" : "string",
    "interfaceType" : {
      "driveType" : "string",
      "fibre" : [ {
        "channel" : 0,
        "loopID" : 0
      } ],
      "sas" : {
        "deviceName" : "string",
        "drivePortAddresses" : [ {
          "channel" : 0,
          "portIdentifier" : "string"
        } ]
      },
      "scsi" : {
        "channel" : 0,
        "id" : 0
      }
    },
    "physicalLocation" : {
      "trayRef" : "string",
      "slot" : 0,
      "locationParent" : {
        "refType" : "string",
        "controllerRef" : "string",
        "symbolRef" : "string",
        "typedReference" : {
          "componentType" : "string",
          "symbolRef" : "string"
        }
      },
      "locationPosition" : 0,
      "label" : "string"
    },
    "manufacturer" : "string",
    "manufacturerDate" : "string",
    "productID" : "string",
    "serialNumber" : "string",
    "softwareVersion" : "string",
    "blkSize" : 0,
    "usableCapacity" : "string",
    "rawCapacity" : "string",
    "worldWideName" : "string",
    "currentVolumeGroupRef" : "string",
    "sparedForDriveRef" : "string",
    "mirrorDrive" : "string",
    "nonRedundantAccess" : true,
    "workingChannel" : 0,
    "volumeGroupIndex" : 0,
    "currentSpeed" : "string",
    "maxSpeed" : "string",
    "uncertified" : true,
    "hasDegradedChannel" : true,
    "degradedChannels" : [ 0 ],
    "phyDriveType" : "string",
    "spindleSpeed" : 0,
    "rtrAttributes" : {
      "cruType" : "string",
      "parentCru" : {
        "type" : "string",
        "parentController" : "string",
        "parentEsm" : "string",
        "parentFan" : "string",
        "parentInterconnectCru" : "string",
        "parentSupportCru" : "string",
        "parentDrawer" : "string"
      },
      "rtrAttributeData" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "reserved" : "string",
    "phyDriveTypeData" : {
      "phyDriveType" : "string",
      "sataDriveAttributes" : {
        "translatorData" : {
          "vendorId" : "string",
          "productId" : "string",
          "productRevLevel" : "string",
          "satType" : "string"
        },
        "ataDiskModelNumber" : "string",
        "ataDiskFwRevision" : "string"
      }
    },
    "pfaReason" : "string",
    "bypassSource" : [ {
      "refType" : "string",
      "controllerRef" : "string",
      "symbolRef" : "string",
      "typedReference" : {
        "componentType" : "string",
        "symbolRef" : "string"
      }
    } ],
    "repairPolicy" : {
      "removalData" : {
        "removalMethod" : "string",
        "rtrAttributes" : {
          "hasReadyToRemoveIndicator" : true,
          "readyToRemove" : true
        }
      },
      "replacementMethod" : "string"
    },
    "fdeCapable" : true,
    "fdeEnabled" : true,
    "fdeLocked" : true,
    "lockKeyID" : "string",
    "ssdWearLife" : {
      "averageEraseCountPercent" : 0,
      "spareBlocksRemainingPercent" : 0,
      "isWearLifeMonitoringSupported" : true,
      "percentEnduranceUsed" : 0
    },
    "driveMediaType" : "string",
    "fpgaVersion" : "string",
    "protectionInformationCapabilities" : {
      "protectionInformationCapable" : true,
      "protectionType" : "string"
    },
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "interposerPresent" : true,
    "interposerRef" : "string",
    "currentCommandAgingTimeout" : 0,
    "defaultCommandAgingTimeout" : 0,
    "driveTemperature" : {
      "currentTemp" : 0,
      "refTemp" : 0
    },
    "blkSizePhysical" : 0,
    "lowestAlignedLBA" : "string",
    "removed" : true,
    "locateInProgress" : true,
    "fipsCapable" : true,
    "id" : "string"
  } ],
  "volumeGroup" : [ {
    "sequenceNum" : 0,
    "offline" : true,
    "raidLevel" : "string",
    "worldWideName" : "string",
    "volumeGroupRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string",
    "trayLossProtection" : true,
    "label" : "string",
    "state" : "string",
    "spindleSpeedMatch" : true,
    "spindleSpeed" : 0,
    "isInaccessible" : true,
    "securityType" : "string",
    "drawerLossProtection" : true,
    "protectionInformationCapable" : true,
    "protectionInformationCapabilities" : {
      "protectionInformationCapable" : true,
      "protectionType" : "string"
    },
    "volumeGroupData" : {
      "type" : "string",
      "diskPoolData" : {
        "reconstructionReservedDriveCount" : 0,
        "reconstructionReservedAmt" : "string",
        "reconstructionReservedDriveCountCurrent" : 0,
        "poolUtilizationWarningThreshold" : 0,
        "poolUtilizationCriticalThreshold" : 0,
        "poolUtilizationState" : "string",
        "unusableCapacity" : "string",
        "degradedReconstructPriority" : "string",
        "criticalReconstructPriority" : "string",
        "backgroundOperationPriority" : "string",
        "allocGranularity" : "string",
        "minimumDriveCount" : 0
      }
    },
    "usage" : "string",
    "driveBlockFormat" : "string",
    "reservedSpaceAllocated" : true,
    "securityLevel" : "string",
    "name" : "string",
    "id" : "string"
  } ],
  "volume" : [ {
    "offline" : true,
    "extremeProtection" : true,
    "volumeHandle" : 0,
    "raidLevel" : "string",
    "sectorOffset" : "string",
    "worldWideName" : "string",
    "label" : "string",
    "blkSize" : 0,
    "capacity" : "string",
    "reconPriority" : 0,
    "segmentSize" : 0,
    "action" : "string",
    "cache" : {
      "cwob" : true,
      "enterpriseCacheDump" : true,
      "mirrorActive" : true,
      "mirrorEnable" : true,
      "readCacheActive" : true,
      "readCacheEnable" : true,
      "writeCacheActive" : true,
      "writeCacheEnable" : true,
      "cacheFlushModifier" : "string",
      "readAheadMultiplier" : 0
    },
    "mediaScan" : {
      "enable" : true,
      "parityValidationEnable" : true
    },
    "volumeRef" : "string",
    "status" : "string",
    "volumeGroupRef" : "string",
    "currentManager" : "string",
    "preferredManager" : "string",
    "perms" : {
      "mapToLUN" : true,
      "snapShot" : true,
      "format" : true,
      "reconfigure" : true,
      "mirrorPrimary" : true,
      "mirrorSecondary" : true,
      "copySource" : true,
      "copyTarget" : true,
      "readable" : true,
      "writable" : true,
      "rollback" : true,
      "mirrorSync" : true,
      "newImage" : true,
      "allowDVE" : true,
      "allowDSS" : true,
      "concatVolumeMember" : true,
      "flashReadCache" : true,
      "asyncMirrorPrimary" : true,
      "asyncMirrorSecondary" : true,
      "pitGroup" : true,
      "cacheParametersChangeable" : true,
      "allowThinManualExpansion" : true,
      "allowThinGrowthParametersChange" : true
    },
    "mgmtClientAttribute" : 0,
    "dssPreallocEnabled" : true,
    "dssMaxSegmentSize" : 0,
    "preReadRedundancyCheckEnabled" : true,
    "protectionInformationCapable" : true,
    "protectionType" : "string",
    "applicationTagOwned" : true,
    "repairedBlockCount" : 0,
    "extendedUniqueIdentifier" : "string",
    "cacheMirroringValidateProtectionInformation" : true,
    "expectedProtectionInformationAppTag" : 0,
    "name" : "string",
    "id" : "string"
  } ],
  "freeExtent" : [ {
    "sectorOffset" : "string",
    "rawCapacity" : "string",
    "raidLevel" : "string",
    "volumeGroupRef" : "string",
    "freeExtentRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string"
  } ],
  "dveVol" : [ {
    "volume" : "string",
    "amountOfIncrease" : "string"
  } ],
  "storagePoolBundle" : {
    "saPortGroup" : [ {
      "saPortGroupRef" : "string",
      "label" : "string"
    } ],
    "saPort" : [ {
      "saPortRef" : "string",
      "saPortGroupRef" : "string",
      "controllerRef" : "string",
      "portId" : 0
    } ],
    "cluster" : [ {
      "clusterRef" : "string",
      "label" : "string",
      "isSAControlled" : true,
      "confirmLUNMappingCreation" : true,
      "protectionInformationCapableAccessMethod" : true,
      "isLun0Restricted" : true,
      "name" : "string",
      "id" : "string"
    } ],
    "host" : [ {
      "hostRef" : "string",
      "clusterRef" : "string",
      "label" : "string",
      "isSAControlled" : true,
      "confirmLUNMappingCreation" : true,
      "hostTypeIndex" : 0,
      "protectionInformationCapableAccessMethod" : true,
      "isLargeBlockFormatHost" : true,
      "isLun0Restricted" : true,
      "name" : "string",
      "id" : "string"
    } ],
    "hostPort" : [ {
      "hostPortRef" : "string",
      "hostPortName" : "string",
      "label" : "string",
      "hostRef" : "string",
      "hostPortTypeIndex" : 0,
      "isSAControlled" : true,
      "confirmLUNMappingCreation" : true,
      "portId" : {
        "ioInterfaceType" : "string",
        "portName" : "string",
        "ibPortName" : "string",
        "iscsiPortName" : {
          "initiatorNodeName" : "string",
          "initiatorSessionId" : "string"
        },
        "sasPortName" : "string",
        "nvmeInitiatorPortId" : {
          "name" : "string",
          "hostIdentifier" : "string",
          "portIdentifier" : {
            "ioInterfaceType" : "string",
            "fcPortName" : "string",
            "ibPortName" : "string",
            "sasPortName" : "string"
          }
        }
      },
      "portInactive" : true,
      "id" : "string"
    } ],
    "lunMapping" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "initiator" : [ {
      "initiatorRef" : "string",
      "nodeName" : {
        "ioInterfaceType" : "string",
        "iscsiNodeName" : "string",
        "remoteNodeWWN" : "string",
        "nvmeNodeName" : "string"
      },
      "alias" : {
        "ioInterfaceType" : "string",
        "iscsiAlias" : "string"
      },
      "label" : "string",
      "configuredAuthMethods" : {
        "authMethodData" : [ {
          "authMethod" : "string",
          "chapSecret" : [ {
            "type" : "string",
            "pkcs5Data" : {
              "iterations" : 0,
              "salt" : "string",
              "cipherText" : "string"
            },
            "pkcs5AesData" : {
              "iterations" : 0,
              "salt" : "string",
              "cipherText" : "string"
            }
          } ]
        } ]
      },
      "hostRef" : "string",
      "initiatorInactive" : true,
      "id" : "string"
    } ],
    "target" : [ {
      "targetRef" : "string",
      "nodeName" : {
        "ioInterfaceType" : "string",
        "iscsiNodeName" : "string",
        "remoteNodeWWN" : "string",
        "nvmeNodeName" : "string"
      },
      "alias" : {
        "ioInterfaceType" : "string",
        "iscsiAlias" : "string"
      },
      "configuredAuthMethods" : {
        "authMethodData" : [ {
          "authMethod" : "string",
          "chapSecret" : [ {
            "type" : "string",
            "pkcs5Data" : {
              "iterations" : 0,
              "salt" : "string",
              "cipherText" : "string"
            },
            "pkcs5AesData" : {
              "iterations" : 0,
              "salt" : "string",
              "cipherText" : "string"
            }
          } ]
        } ]
      },
      "portals" : [ {
        "groupTag" : 0,
        "ipAddress" : {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        },
        "tcpListenPort" : 0
      } ]
    } ],
    "remoteTarget" : [ {
      "remoteRef" : "string",
      "nodeName" : {
        "ioInterfaceType" : "string",
        "iscsiNodeName" : "string",
        "remoteNodeWWN" : "string",
        "nvmeNodeName" : "string"
      },
      "scsiinitiatorTargetBaseProperties" : {
        "ioInterfaceType" : "string",
        "iscsiinitiatorTargetBaseParameters" : {
          "portals" : [ {
            "groupTag" : 0,
            "ipAddress" : {
              "addressType" : "string",
              "ipv4Address" : "string",
              "ipv6Address" : "string"
            },
            "tcpListenPort" : 0
          } ]
        }
      }
    } ]
  },
  "highLevelVolBundle" : {
    "snapshotVol" : [ {
      "worldWideName" : "string",
      "snapshotRef" : "string",
      "label" : "string",
      "status" : "string",
      "action" : "string",
      "currentManager" : "string",
      "baseVolume" : "string",
      "repositoryVolume" : "string",
      "fullWarnThreshold" : 0,
      "overWarnThreshold" : true,
      "repositoryFull" : true,
      "repFullPolicy" : "string",
      "rollbackPriority" : 0,
      "extentStart" : "string",
      "extentSize" : "string",
      "snapshotTime" : "string",
      "perms" : {
        "mapToLUN" : true,
        "snapShot" : true,
        "format" : true,
        "reconfigure" : true,
        "mirrorPrimary" : true,
        "mirrorSecondary" : true,
        "copySource" : true,
        "copyTarget" : true,
        "readable" : true,
        "writable" : true,
        "rollback" : true,
        "mirrorSync" : true,
        "newImage" : true,
        "allowDVE" : true,
        "allowDSS" : true,
        "concatVolumeMember" : true,
        "flashReadCache" : true,
        "asyncMirrorPrimary" : true,
        "asyncMirrorSecondary" : true,
        "pitGroup" : true,
        "cacheParametersChangeable" : true,
        "allowThinManualExpansion" : true,
        "allowThinGrowthParametersChange" : true
      },
      "childrenInactive" : true,
      "volumeHandle" : 0,
      "mgmtClientAttribute" : 0,
      "rollbackStatus" : "string",
      "id" : "string"
    } ],
    "mirrorVol" : [ {
      "worldWideName" : "string",
      "mirrorProxyRef" : "string",
      "volumeHandle" : 0,
      "localMirrorStatus" : "string",
      "remoteMirrorStatus" : "string",
      "localRole" : "string",
      "remoteRole" : "string",
      "localPriority" : "string",
      "peerPriority" : "string",
      "usableCapacity" : "string",
      "currentManager" : "string",
      "baseVolume" : "string",
      "remoteVolRef" : "string",
      "action" : "string",
      "reserved1" : "string",
      "reserved2" : "string",
      "localWriteMode" : "string",
      "autoResync" : true,
      "consistencyGroupRef" : "string"
    } ],
    "metadataVol" : [ {
      "metadataVolRef" : "string",
      "metadataVolType" : "string",
      "associatedVolume" : "string",
      "preferredManager" : "string",
      "perms" : {
        "mapToLUN" : true,
        "snapShot" : true,
        "format" : true,
        "reconfigure" : true,
        "mirrorPrimary" : true,
        "mirrorSecondary" : true,
        "copySource" : true,
        "copyTarget" : true,
        "readable" : true,
        "writable" : true,
        "rollback" : true,
        "mirrorSync" : true,
        "newImage" : true,
        "allowDVE" : true,
        "allowDSS" : true,
        "concatVolumeMember" : true,
        "flashReadCache" : true,
        "asyncMirrorPrimary" : true,
        "asyncMirrorSecondary" : true,
        "pitGroup" : true,
        "cacheParametersChangeable" : true,
        "allowThinManualExpansion" : true,
        "allowThinGrowthParametersChange" : true
      },
      "offline" : true,
      "reserved1" : "string"
    } ],
    "remoteVol" : [ {
      "worldWideName" : "string",
      "remoteVolRef" : "string",
      "manager" : "string",
      "remoteArrayId" : {
        "worldWideName" : "string"
      },
      "remoteNodeWWN" : "string",
      "remoteVolWWN" : "string",
      "remoteVolUserLabel" : "string",
      "remoteVolState" : "string",
      "remoteVolCapacity" : "string",
      "volumeHandle" : 0,
      "perms" : {
        "mapToLUN" : true,
        "snapShot" : true,
        "format" : true,
        "reconfigure" : true,
        "mirrorPrimary" : true,
        "mirrorSecondary" : true,
        "copySource" : true,
        "copyTarget" : true,
        "readable" : true,
        "writable" : true,
        "rollback" : true,
        "mirrorSync" : true,
        "newImage" : true,
        "allowDVE" : true,
        "allowDSS" : true,
        "concatVolumeMember" : true,
        "flashReadCache" : true,
        "asyncMirrorPrimary" : true,
        "asyncMirrorSecondary" : true,
        "pitGroup" : true,
        "cacheParametersChangeable" : true,
        "allowThinManualExpansion" : true,
        "allowThinGrowthParametersChange" : true
      },
      "reserved1" : "string",
      "reserved2" : "string",
      "remoteNodeName" : {
        "ioInterfaceType" : "string",
        "iscsiNodeName" : "string",
        "remoteNodeWWN" : "string",
        "nvmeNodeName" : "string"
      },
      "remoteVolSecurityType" : "string"
    } ],
    "volumeCopy" : [ {
      "worldWideName" : "string",
      "volcopyHandle" : 0,
      "volcopyRef" : "string",
      "status" : "string",
      "sourceVolume" : "string",
      "targetVolume" : "string",
      "currentManager" : "string",
      "idleTargetWriteProt" : true,
      "copyCompleteTime" : "string",
      "copyStartTime" : "string",
      "copyPriority" : "string",
      "reserved1" : "string",
      "cloneCopy" : true,
      "pgRef" : "string",
      "id" : "string"
    } ],
    "pitGroup" : [ {
      "pitGroupRef" : "string",
      "label" : "string",
      "status" : "string",
      "baseVolume" : "string",
      "repositoryVolume" : "string",
      "clusterSize" : 0,
      "maxRepositoryCapacity" : "string",
      "maxBaseCapacity" : "string",
      "unusableRepositoryCapacity" : "string",
      "repFullPolicy" : "string",
      "fullWarnThreshold" : 0,
      "autoDeleteLimit" : 0,
      "action" : "string",
      "rollbackStatus" : "string",
      "rollbackPriority" : "string",
      "consistencyGroup" : true,
      "consistencyGroupRef" : "string",
      "creationPendingStatus" : "string",
      "volumeHandle" : 0,
      "name" : "string",
      "id" : "string"
    } ],
    "pit" : [ {
      "pitRef" : "string",
      "pitGroupRef" : "string",
      "creationMethod" : "string",
      "pitTimestamp" : "string",
      "pitSequenceNumber" : "string",
      "status" : "string",
      "activeCOW" : true,
      "isRollbackSource" : true,
      "pitCapacity" : "string",
      "repositoryCapacityUtilization" : "string",
      "id" : "string"
    } ],
    "pitView" : [ {
      "viewRef" : "string",
      "worldWideName" : "string",
      "baseVol" : "string",
      "basePIT" : "string",
      "boundToPIT" : true,
      "accessMode" : "string",
      "label" : "string",
      "status" : "string",
      "currentManager" : "string",
      "preferredManager" : "string",
      "repositoryVolume" : "string",
      "fullWarnThreshold" : 0,
      "viewTime" : "string",
      "viewSequenceNumber" : "string",
      "perms" : {
        "mapToLUN" : true,
        "snapShot" : true,
        "format" : true,
        "reconfigure" : true,
        "mirrorPrimary" : true,
        "mirrorSecondary" : true,
        "copySource" : true,
        "copyTarget" : true,
        "readable" : true,
        "writable" : true,
        "rollback" : true,
        "mirrorSync" : true,
        "newImage" : true,
        "allowDVE" : true,
        "allowDSS" : true,
        "concatVolumeMember" : true,
        "flashReadCache" : true,
        "asyncMirrorPrimary" : true,
        "asyncMirrorSecondary" : true,
        "pitGroup" : true,
        "cacheParametersChangeable" : true,
        "allowThinManualExpansion" : true,
        "allowThinGrowthParametersChange" : true
      },
      "volumeHandle" : 0,
      "clusterSize" : 0,
      "maxRepositoryCapacity" : "string",
      "unusableRepositoryCapacity" : "string",
      "membership" : {
        "viewType" : "string",
        "cgViewRef" : "string"
      },
      "mgmtClientAttribute" : 0,
      "offline" : true,
      "extendedUniqueIdentifier" : "string",
      "name" : "string",
      "id" : "string"
    } ],
    "pitConsistencyGroup" : [ {
      "cgRef" : "string",
      "label" : "string",
      "repFullPolicy" : "string",
      "fullWarnThreshold" : 0,
      "autoDeleteLimit" : 0,
      "rollbackPriority" : "string",
      "uniqueSequenceNumber" : [ "string" ],
      "creationPendingStatus" : "string",
      "name" : "string",
      "id" : "string"
    } ],
    "concatVolume" : [ {
      "concatVolRef" : "string",
      "status" : "string",
      "memberCount" : 0,
      "aggregateCapacity" : "string",
      "mediaScanParams" : {
        "enable" : true,
        "parityValidationEnable" : true
      },
      "volumeHandle" : 0,
      "allowedOperations" : {
        "mapToLUN" : true,
        "snapShot" : true,
        "format" : true,
        "reconfigure" : true,
        "mirrorPrimary" : true,
        "mirrorSecondary" : true,
        "copySource" : true,
        "copyTarget" : true,
        "readable" : true,
        "writable" : true,
        "rollback" : true,
        "mirrorSync" : true,
        "newImage" : true,
        "allowDVE" : true,
        "allowDSS" : true,
        "concatVolumeMember" : true,
        "flashReadCache" : true,
        "asyncMirrorPrimary" : true,
        "asyncMirrorSecondary" : true,
        "pitGroup" : true,
        "cacheParametersChangeable" : true,
        "allowThinManualExpansion" : true,
        "allowThinGrowthParametersChange" : true
      },
      "id" : "string"
    } ],
    "concatVolMember" : [ {
      "memberRef" : "string",
      "concatVolRef" : "string",
      "storageVolumeRef" : "string",
      "parentIndex" : 0
    } ],
    "pitConsistencyGroupView" : [ {
      "cgViewRef" : "string",
      "groupRef" : "string",
      "label" : "string",
      "viewTime" : "string",
      "viewSequenceNumber" : "string",
      "name" : "string",
      "id" : "string"
    } ],
    "thinVolume" : [ {
      "volumeHandle" : 0,
      "worldWideName" : "string",
      "label" : "string",
      "allocationGranularity" : 0,
      "capacity" : "string",
      "reconPriority" : 0,
      "volumeRef" : "string",
      "status" : "string",
      "repositoryRef" : "string",
      "currentManager" : "string",
      "preferredManager" : "string",
      "perms" : {
        "mapToLUN" : true,
        "snapShot" : true,
        "format" : true,
        "reconfigure" : true,
        "mirrorPrimary" : true,
        "mirrorSecondary" : true,
        "copySource" : true,
        "copyTarget" : true,
        "readable" : true,
        "writable" : true,
        "rollback" : true,
        "mirrorSync" : true,
        "newImage" : true,
        "allowDVE" : true,
        "allowDSS" : true,
        "concatVolumeMember" : true,
        "flashReadCache" : true,
        "asyncMirrorPrimary" : true,
        "asyncMirrorSecondary" : true,
        "pitGroup" : true,
        "cacheParametersChangeable" : true,
        "allowThinManualExpansion" : true,
        "allowThinGrowthParametersChange" : true
      },
      "mgmtClientAttribute" : 0,
      "preReadRedundancyCheckEnabled" : true,
      "protectionType" : "string",
      "applicationTagOwned" : true,
      "maxVirtualCapacity" : "string",
      "initialProvisionedCapacity" : "string",
      "currentProvisionedCapacity" : "string",
      "provisionedCapacityQuota" : "string",
      "growthAlertThreshold" : 0,
      "expansionPolicy" : "string",
      "volumeCache" : {
        "cwob" : true,
        "enterpriseCacheDump" : true,
        "mirrorActive" : true,
        "mirrorEnable" : true,
        "readCacheActive" : true,
        "readCacheEnable" : true,
        "writeCacheActive" : true,
        "writeCacheEnable" : true,
        "cacheFlushModifier" : "string",
        "readAheadMultiplier" : 0
      },
      "offline" : true,
      "reportingPolicy" : "string",
      "extendedUniqueIdentifier" : "string",
      "id" : "string"
    } ],
    "asyncMirrorGroup" : [ {
      "groupRef" : "string",
      "worldWideName" : "string",
      "label" : "string",
      "groupState" : "string",
      "localRole" : "string",
      "remoteRole" : "string",
      "roleChangeProgress" : "string",
      "syncIntervalMinutes" : 0,
      "syncCompletionTimeAlertThresholdMinutes" : 0,
      "recoveryPointAgeAlertThresholdMinutes" : 0,
      "repositoryUtilizationWarnThreshold" : 0,
      "mirrorChannelRemoteTarget" : "string",
      "syncActivity" : "string",
      "orphanGroup" : true
    } ],
    "asyncMirrorGroupMember" : [ {
      "memberRef" : "string",
      "mirrorGroup" : "string",
      "localVolume" : "string",
      "remoteVolume" : "string",
      "memberState" : "string",
      "lastRecoveryPointTime" : "string",
      "overUtilizationWarnThreshold" : true,
      "mirroredLocalCapacity" : "string",
      "repositoryVolume" : "string",
      "worldWideName" : "string",
      "volumeHandle" : 0,
      "repositoryFull" : true,
      "id" : "string"
    } ],
    "asyncMirrorGroupIncompleteMember" : [ {
      "memberRef" : "string",
      "groupRef" : "string",
      "primaryVolWWN" : "string",
      "primaryVolCapacity" : "string",
      "primaryVolRAIDLevel" : "string",
      "primaryVolProtectionType" : "string",
      "primaryVolSecurityType" : "string",
      "primaryVolUserLabel" : "string",
      "orphanIncompleteMember" : true,
      "primaryVolumeParameters" : {
        "volumeType" : "string",
        "capacityProvisioningDetails" : {
          "capacityQuota" : "string",
          "growthAlertThreshold" : 0,
          "repositoryExpansionPolicy" : "string"
        }
      },
      "primaryVolSecurityLevel" : "string"
    } ]
  },
  "ghostVolBundle" : {
    "ghostVol" : [ {
      "worldWideName" : "string",
      "volumeRef" : "string",
      "reserved1" : "string",
      "reserved2" : "string"
    } ]
  },
  "consistencyGroupBundle" : {
    "consistencyGroup" : [ {
      "groupRef" : "string"
    } ]
  },
  "ioInterface" : [ {
    "interfaceRef" : "string",
    "channelType" : "string",
    "ioInterfaceTypeData" : {
      "interfaceType" : "string",
      "fibre" : {
        "channel" : 0,
        "loopID" : 0,
        "speed" : 0,
        "hardAddress" : 0,
        "nodeName" : "string",
        "portName" : "string",
        "portId" : "string",
        "topology" : "string",
        "part" : "string",
        "revision" : 0,
        "chanMiswire" : true,
        "esmMiswire" : true,
        "linkStatus" : "string",
        "isDegraded" : true,
        "speedControl" : "string",
        "maxSpeed" : 0,
        "speedNegError" : true,
        "reserved1" : "string",
        "reserved2" : "string",
        "ddsChannelState" : 0,
        "ddsStateReason" : 0,
        "ddsStateWho" : 0,
        "isLocal" : true,
        "channelPorts" : [ {
          "speedDetError" : true,
          "manuallyBypassed" : true,
          "portNumber" : "string"
        } ],
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "isTrunkCapable" : true,
        "trunkMiswire" : true,
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "ib" : {
        "interfaceRef" : "string",
        "channel" : 0,
        "channelPortRef" : "string",
        "localIdentifier" : 0,
        "globalIdentifier" : "string",
        "linkState" : "string",
        "portState" : "string",
        "maximumTransmissionUnit" : 0,
        "currentSpeed" : "string",
        "supportedSpeed" : [ "string" ],
        "currentLinkWidth" : "string",
        "supportedLinkWidth" : [ "string" ],
        "currentDataVirtualLanes" : 0,
        "maximumDataVirtualLanes" : 0,
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isSRPSupported" : true,
        "isISERSupported" : true,
        "physPortState" : "string",
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "isNVMeSupported" : true,
        "id" : "string"
      },
      "iscsi" : {
        "channel" : 0,
        "channelPortRef" : "string",
        "tcpListenPort" : 0,
        "ipv4Enabled" : true,
        "ipv4Data" : {
          "ipv4Address" : "string",
          "ipv4AddressConfigMethod" : "string",
          "ipv4OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv4AddressData" : {
            "configState" : "string",
            "ipv4Address" : "string",
            "ipv4SubnetMask" : "string",
            "ipv4GatewayAddress" : "string"
          }
        },
        "interfaceData" : {
          "type" : "string",
          "ethernetData" : {
            "partData" : {
              "vendorName" : "string",
              "partNumber" : "string",
              "revisionNumber" : "string",
              "serialNumber" : "string"
            },
            "macAddress" : "string",
            "fullDuplex" : true,
            "maximumFramePayloadSize" : 0,
            "currentInterfaceSpeed" : "string",
            "maximumInterfaceSpeed" : "string",
            "linkStatus" : "string",
            "supportedInterfaceSpeeds" : [ "string" ],
            "autoconfigSupport" : true,
            "copperCableDiagnosticsSupport" : true
          },
          "infinibandData" : {
            "isIser" : true
          }
        },
        "interfaceRef" : "string",
        "ipv6Enabled" : true,
        "ipv6Data" : {
          "ipv6LocalAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6RoutableAddresses" : [ {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          } ],
          "ipv6PortRouterAddress" : {
            "address" : "string",
            "addressState" : {
              "addressType" : "string",
              "interfaceAddressState" : "string",
              "routerAddressState" : "string"
            }
          },
          "ipv6AddressConfigMethod" : "string",
          "ipv6OutboundPacketPriority" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6VlanId" : {
            "isEnabled" : true,
            "value" : 0
          },
          "ipv6HopLimit" : 0,
          "ipv6NdReachableTime" : 0,
          "ipv6NdRetransmitTime" : 0,
          "ipv6NdStaleTimeout" : 0,
          "ipv6DuplicateAddressDetectionAttempts" : 0
        },
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "isIPv6Capable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sas" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "part" : "string",
        "revision" : 0,
        "isDegraded" : true,
        "iocPort" : {
          "parent" : {
            "type" : "string",
            "controller" : "string",
            "drive" : "string",
            "expander" : "string",
            "hostBoardRef" : "string"
          },
          "attachedDevice" : {
            "channel" : 0,
            "channelType" : "string",
            "sasAttachedDeviceData" : {
              "type" : "string",
              "alternateController" : "string",
              "drive" : "string",
              "expander" : "string",
              "remoteHostPortAddress" : "string",
              "localController" : "string",
              "physicalLocation" : {
                "trayRef" : "string",
                "slot" : 0,
                "locationParent" : {
                  "refType" : "string",
                  "controllerRef" : "string",
                  "symbolRef" : "string",
                  "typedReference" : {
                    "componentType" : "string",
                    "symbolRef" : "string"
                  }
                },
                "locationPosition" : 0,
                "label" : "string"
              }
            }
          },
          "state" : "string",
          "miswireType" : "string",
          "channelPortRef" : "string",
          "sasPhys" : [ {
            "phyIdentifier" : 0,
            "isOperational" : true
          } ],
          "portTypeData" : {
            "portType" : "string",
            "portIdentifier" : "string",
            "routingType" : "string"
          },
          "portMode" : "string",
          "domainNumber" : 0,
          "attachedChannelPortRef" : "string",
          "discoveryStatus" : 0
        },
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "oneWayMaxRate" : "string",
        "bidirectionalMaxRate" : "string",
        "id" : "string"
      },
      "sata" : {
        "channel" : 0,
        "currentInterfaceSpeed" : "string",
        "maximumInterfaceSpeed" : "string",
        "speedControl" : "string",
        "part" : "string",
        "revision" : 0,
        "interfaceRef" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        },
        "protectionInformationCapable" : true,
        "id" : "string"
      },
      "scsi" : {
        "channel" : 0,
        "scsiID" : 0,
        "speed" : 0,
        "scsiType" : "string",
        "width" : 0,
        "part" : "string",
        "revision" : 0,
        "reserved1" : "string",
        "reserved2" : "string"
      }
    },
    "controllerRef" : "string",
    "commandProtocolPropertiesList" : {
      "commandProtocolProperties" : [ {
        "commandProtocol" : "string",
        "nvmeProperties" : {
          "commandSet" : "string",
          "nvmeofProperties" : {
            "provider" : "string",
            "ibProperties" : {
              "ipAddressData" : {
                "addressType" : "string",
                "ipv4Data" : {
                  "configState" : "string",
                  "ipv4Address" : "string",
                  "ipv4SubnetMask" : "string",
                  "ipv4GatewayAddress" : "string"
                },
                "ipv6Data" : {
                  "address" : "string",
                  "addressState" : {
                    "addressType" : "string",
                    "interfaceAddressState" : "string",
                    "routerAddressState" : "string"
                  }
                }
              },
              "listeningPort" : 0
            }
          }
        }
      } ]
    }
  } ],
  "networkInterface" : [ {
    "interfaceRef" : "string",
    "channelType" : "string",
    "netInterfaceTypeData" : {
      "interfaceType" : "string",
      "ethernet" : {
        "interfaceName" : "string",
        "channel" : 0,
        "speed" : 0,
        "ip" : 0,
        "alias" : "string",
        "macAddr" : "string",
        "gatewayIp" : 0,
        "subnetMask" : 0,
        "bootpUsed" : true,
        "rloginEnabled" : true,
        "reserved1" : "string",
        "setupError" : true,
        "reserved2" : "string",
        "interfaceRef" : "string",
        "linkStatus" : "string",
        "ipv4Enabled" : true,
        "ipv4Address" : "string",
        "ipv4SubnetMask" : "string",
        "ipv4AddressConfigMethod" : "string",
        "ipv6Enabled" : true,
        "ipv6LocalAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6PortStaticRoutableAddress" : {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        },
        "ipv6PortRoutableAddresses" : [ {
          "address" : "string",
          "addressState" : {
            "addressType" : "string",
            "interfaceAddressState" : "string",
            "routerAddressState" : "string"
          }
        } ],
        "ipv6AddressConfigMethod" : "string",
        "fullDuplex" : true,
        "supportedSpeedSettings" : [ "string" ],
        "configuredSpeedSetting" : "string",
        "currentSpeed" : "string",
        "physicalLocation" : {
          "trayRef" : "string",
          "slot" : 0,
          "locationParent" : {
            "refType" : "string",
            "controllerRef" : "string",
            "symbolRef" : "string",
            "typedReference" : {
              "componentType" : "string",
              "symbolRef" : "string"
            }
          },
          "locationPosition" : 0,
          "label" : "string"
        }
      }
    }
  } ],
  "lockKeyIDs" : [ {
    "lockKeyIDRef" : "string",
    "lockKeyID" : "string"
  } ],
  "interposer" : [ {
    "interposerRef" : "string",
    "interposerTypeData" : {
      "interposerType" : "string",
      "fcSasInterposer" : {
        "vendorID" : "string",
        "productID" : "string",
        "revision" : "string",
        "deviceWWN" : "string",
        "serialNumber" : "string",
        "partNumber" : "string",
        "driveFwVersion" : "string"
      },
      "reserved" : "string"
    }
  } ],
  "ioInterfaceHicMap" : [ {
    "interfaceRef" : "string",
    "hostBoardRef" : "string"
  } ],
  "schedule" : [ {
    "schedRef" : "string",
    "scheduleStatus" : "string",
    "action" : "string",
    "targetObject" : "string",
    "schedule" : {
      "calendar" : {
        "scheduleMethod" : "string",
        "daily" : {
          "dailySchedule" : {
            "timeOfDay" : 0,
            "everyNMinutes" : 0,
            "timesPerDay" : 0
          }
        },
        "weekly" : {
          "daysOfWeek" : [ "string" ],
          "dailySchedule" : {
            "timeOfDay" : 0,
            "everyNMinutes" : 0,
            "timesPerDay" : 0
          }
        },
        "monthlyByDate" : {
          "daysOfMonth" : [ "string" ],
          "monthsOfYear" : [ "string" ],
          "dailySchedule" : {
            "timeOfDay" : 0,
            "everyNMinutes" : 0,
            "timesPerDay" : 0
          }
        },
        "monthlyByDay" : {
          "dayOfWeek" : "string",
          "dailySchedule" : {
            "timeOfDay" : 0,
            "everyNMinutes" : 0,
            "timesPerDay" : 0
          },
          "weekNumber" : 0,
          "monthsOfYear" : [ "string" ]
        }
      },
      "startDate" : "string",
      "recurrence" : {
        "recurrenceType" : "string",
        "recurrenceCount" : 0,
        "recurrenceEndDate" : "string"
      },
      "timezone" : {
        "tzLabel" : "string",
        "tzOffset" : 0,
        "dstStart" : {
          "time" : 0,
          "clockMode" : "string",
          "month" : 0,
          "dayOfMonth" : 0,
          "dayOfWeek" : 0
        },
        "dstEnd" : {
          "time" : 0,
          "clockMode" : "string",
          "month" : 0,
          "dayOfMonth" : 0,
          "dayOfWeek" : 0
        },
        "dstAdjust" : 0
      }
    },
    "creationTime" : "string",
    "lastRunTime" : "string",
    "nextRunTime" : "string",
    "stopTime" : "string",
    "id" : "string"
  } ],
  "remoteArray" : [ {
    "remoteArrayRef" : "string",
    "saId" : {
      "worldWideName" : "string"
    },
    "remoteTargets" : [ "string" ]
  } ],
  "flashCacheBundle" : {
    "flashCacheMap" : [ {
      "flashCache" : "string",
      "cachedVolume" : "string",
      "flashCacheMapRef" : "string",
      "id" : "string"
    } ],
    "flashCache" : [ {
      "wwn" : "string",
      "flashCacheRef" : "string",
      "flashCacheBase" : {
        "label" : "string",
        "status" : "string",
        "configType" : "string",
        "analyticsStatus" : "string",
        "analyticsCause" : "string",
        "statusCause" : "string"
      },
      "fcDriveInfo" : {
        "flashCacheType" : "string",
        "fcWithDrives" : {
          "securityType" : "string",
          "protectionInformationCapabilities" : {
            "protectionInformationCapable" : true,
            "protectionType" : "string"
          },
          "usedCapacity" : "string",
          "securityLevel" : "string"
        }
      },
      "id" : "string"
    } ]
  },
  "snmpBundle" : {
    "community" : [ {
      "communityRef" : "string",
      "communityName" : "string",
      "communityPermissions" : "string"
    } ],
    "trapDestination" : [ {
      "trapDestinationRef" : "string",
      "trapReceiverIpAddress" : {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      },
      "communityRef" : "string",
      "sendAuthenticationFailureTraps" : true
    } ],
    "systemVariables" : {
      "sysName" : "string",
      "sysContact" : "string",
      "sysLocation" : "string"
    }
  },
  "applicationAwarenessBundle" : {
    "keyValueTag" : [ {
      "keyValueTagRef" : "string",
      "key" : "string",
      "value" : "string"
    } ],
    "keyValueTagMapping" : [ {
      "keyValueTagRef" : "string",
      "associatedObject" : {
        "objectType" : "string",
        "volume" : "string",
        "workload" : "string"
      },
      "mappingRef" : "string"
    } ],
    "workload" : [ {
      "workloadRef" : "string",
      "description" : "string"
    } ],
    "workloadVolumeMapping" : [ {
      "mappingRef" : "string",
      "workloadRef" : "string",
      "volumeRef" : "string"
    } ]
  }
}

3.19.12. Retrieve one or more elements from the ObjectGraph using an XPath expression.

GET /devmgr/v2/storage-systems/{system-id}/graph/xpath-filter
Description

This method is used to query the ObjectGraph for one or more elements. <br/> <b>Examples:</b> <br/> <ul><li>Retrieve the list of drives: /drive </li> <li>Locate all instances of an attribute called "id": //id </li> <li>Find a thinVolume with an id of "1": /highLevelVolBundle/thinVolume[id="1"]</li><li>Find all thin volumes and volumes inefficiently: //volume | //thinVolume</li><li>Get the NSVRAM version from saData: /sa/saData/nvsramVersion</li></ul><b>References: </b> http://www.w3schools.com/xsl/xpath_intro.asp

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

query
optional

string

Responses
HTTP Code Description Schema

200

Successful

< object > array

203

StorageDevice could not be contacted, this is the most recent data we have.

< object > array

404

StorageDevice not found

424

StorageDevice is offline with no cached data

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/graph/xpath-filter
Request query
{
  "query" : "string"
}
Example HTTP response
Response 200
[ "object" ]
Response 203
[ "object" ]

3.19.13. Get the password status of the StorageDevice

GET /devmgr/v2/storage-systems/{system-id}/passwords
MetaData

x-mode = both
x-allowedRoles = [ALL_ACCESS, NO_XSRF_PROTECTION]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

PasswordStatusResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/passwords
Example HTTP response
Response 200
{
  "adminPasswordSet" : true,
  "readOnlyPasswordSet" : true
}

3.19.14. Set the password of the StorageDevice

POST /devmgr/v2/storage-systems/{system-id}/passwords
MetaData

x-mode = both
x-allowedRoles = [root.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

PasswordSetRequest

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/passwords
Request body
{
  "currentAdminPassword" : "string",
  "adminPassword" : true,
  "newPassword" : "string"
}

3.19.15. Enable a premium feature.

POST /devmgr/v2/storage-systems/{system-id}/premium-feature
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

FormData

keyFile
optional

The premium feature key file

file

Responses
HTTP Code Description Schema

422

An unexpected error occurred applying the premium feature key.

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/premium-feature
Request formData
"file"
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.19.16. Remove a premium feature.

DELETE /devmgr/v2/storage-systems/{system-id}/premium-feature
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Query

capability
required

Capability to remove.

enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, __UNDEFINED)

Responses
HTTP Code Description Schema

204

Removal was successful

422

An unexpected error occurred removing the feature key.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/premium-feature
Request query
{
  "capability" : "string"
}

3.19.17. Enable a feature pack.

POST /devmgr/v2/storage-systems/{system-id}/feature-pack
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

FormData

keyFile
required

The bundle key file

file

Responses
HTTP Code Description Schema

422

An unexpected error occurred applying the bundle key file.

CallResponse

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/feature-pack
Request formData
"file"
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.19.18. Remove all feature packs.

DELETE /devmgr/v2/storage-systems/{system-id}/feature-pack
Description
Warning
Removal of feature packs is an offline operation. Failure to quiesce IO prior to performing this operation may result in loss of access to data or loss of data.

When used in embedded mode a client may not receive a response from this operation.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

204

Removal was successful

422

An unexpected error occurred removing the bundle keys.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/feature-pack

3.19.19. Set the name of the StorageDevice

POST /devmgr/v2/storage-systems/{system-id}/configuration
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

StorageSystemConfigUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

StorageSystemConfigResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/configuration
Request body
{
  "name" : "string"
}
Example HTTP response
Response 200
{
  "name" : "string"
}

3.19.20. Get the list of ethernet interfaces

GET /devmgr/v2/storage-systems/{system-id}/configuration/ethernet-interfaces
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< ManagementInterface > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/configuration/ethernet-interfaces
Example HTTP response
Response 200
{
  "interfaceName" : "string",
  "channel" : 0,
  "speed" : 0,
  "ip" : 0,
  "alias" : "string",
  "macAddr" : "string",
  "gatewayIp" : 0,
  "subnetMask" : 0,
  "bootpUsed" : true,
  "rloginEnabled" : true,
  "reserved1" : "string",
  "setupError" : true,
  "reserved2" : "string",
  "interfaceRef" : "string",
  "linkStatus" : "string",
  "ipv4Enabled" : true,
  "ipv4Address" : "string",
  "ipv4SubnetMask" : "string",
  "ipv4AddressConfigMethod" : "string",
  "ipv6Enabled" : true,
  "ipv6LocalAddress" : {
    "address" : "string",
    "addressState" : {
      "addressType" : "string",
      "interfaceAddressState" : "string",
      "routerAddressState" : "string"
    }
  },
  "ipv6PortStaticRoutableAddress" : {
    "address" : "string",
    "addressState" : {
      "addressType" : "string",
      "interfaceAddressState" : "string",
      "routerAddressState" : "string"
    }
  },
  "ipv6PortRoutableAddresses" : [ {
    "address" : "string",
    "addressState" : {
      "addressType" : "string",
      "interfaceAddressState" : "string",
      "routerAddressState" : "string"
    }
  } ],
  "ipv6AddressConfigMethod" : "string",
  "fullDuplex" : true,
  "supportedSpeedSettings" : [ "string" ],
  "configuredSpeedSetting" : "string",
  "currentSpeed" : "string",
  "physicalLocation" : {
    "trayRef" : "string",
    "slot" : 0,
    "locationParent" : {
      "refType" : "string",
      "controllerRef" : "string",
      "symbolRef" : "string",
      "typedReference" : {
        "componentType" : "string",
        "symbolRef" : "string"
      }
    },
    "locationPosition" : 0,
    "label" : "string"
  },
  "ipv4GatewayAddress" : "string",
  "controllerRef" : "string",
  "controllerSlot" : 0,
  "dnsProperties" : {
    "acquisitionProperties" : {
      "dnsAcquisitionType" : "string",
      "dnsServers" : [ {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      } ]
    },
    "dhcpAcquiredDnsServers" : [ {
      "addressType" : "string",
      "ipv4Address" : "string",
      "ipv6Address" : "string"
    } ]
  },
  "ntpProperties" : {
    "acquisitionProperties" : {
      "ntpAcquisitionType" : "string",
      "ntpServers" : [ {
        "addrType" : "string",
        "domainName" : "string",
        "ipvxAddress" : {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        }
      } ]
    },
    "dhcpAcquiredNtpServers" : [ {
      "addressType" : "string",
      "ipv4Address" : "string",
      "ipv6Address" : "string"
    } ]
  },
  "id" : "string"
} ]

3.19.21. Configure the ethernet management connections on a controller

POST /devmgr/v2/storage-systems/{system-id}/configuration/ethernet-interfaces
Description

Update the ethernet management connection configuration.
This operation can lead to an inaccessible controller if performed incorrectly or if incorrect ip addresses, gateway addresses, etc, are provided. Configuration is performed by connecting to the alternate controller, so it must be accessible for the operation to succeed.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

ManagementConfigurationRequest

Responses
HTTP Code Description Schema

200

Request completed successfully

ManagementInterface

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/configuration/ethernet-interfaces
Request body
{
  "controllerRef" : "string",
  "enableRemoteAccess" : true,
  "ipv4GatewayAddress" : "string",
  "ipv6GatewayAddress" : "string",
  "ipv6StaticRoutableAddress" : "string",
  "interfaceRef" : "string",
  "interfaceName" : "string",
  "ipv4Enabled" : true,
  "ipv4Address" : "string",
  "ipv4SubnetMask" : "string",
  "ipv4AddressConfigMethod" : "string",
  "ipv6Enabled" : true,
  "ipv6LocalAddress" : "string",
  "ipv6AddressConfigMethod" : "string",
  "speedSetting" : "string",
  "dnsAcquisitionDescriptor" : {
    "dnsAcquisitionType" : "string",
    "dnsServers" : [ {
      "addressType" : "string",
      "ipv4Address" : "string",
      "ipv6Address" : "string"
    } ]
  },
  "ntpAcquisitionDescriptor" : {
    "ntpAcquisitionType" : "string",
    "ntpServers" : [ {
      "addrType" : "string",
      "domainName" : "string",
      "ipvxAddress" : {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      }
    } ]
  }
}
Example HTTP response
Response 200
{
  "interfaceName" : "string",
  "channel" : 0,
  "speed" : 0,
  "ip" : 0,
  "alias" : "string",
  "macAddr" : "string",
  "gatewayIp" : 0,
  "subnetMask" : 0,
  "bootpUsed" : true,
  "rloginEnabled" : true,
  "reserved1" : "string",
  "setupError" : true,
  "reserved2" : "string",
  "interfaceRef" : "string",
  "linkStatus" : "string",
  "ipv4Enabled" : true,
  "ipv4Address" : "string",
  "ipv4SubnetMask" : "string",
  "ipv4AddressConfigMethod" : "string",
  "ipv6Enabled" : true,
  "ipv6LocalAddress" : {
    "address" : "string",
    "addressState" : {
      "addressType" : "string",
      "interfaceAddressState" : "string",
      "routerAddressState" : "string"
    }
  },
  "ipv6PortStaticRoutableAddress" : {
    "address" : "string",
    "addressState" : {
      "addressType" : "string",
      "interfaceAddressState" : "string",
      "routerAddressState" : "string"
    }
  },
  "ipv6PortRoutableAddresses" : [ {
    "address" : "string",
    "addressState" : {
      "addressType" : "string",
      "interfaceAddressState" : "string",
      "routerAddressState" : "string"
    }
  } ],
  "ipv6AddressConfigMethod" : "string",
  "fullDuplex" : true,
  "supportedSpeedSettings" : [ "string" ],
  "configuredSpeedSetting" : "string",
  "currentSpeed" : "string",
  "physicalLocation" : {
    "trayRef" : "string",
    "slot" : 0,
    "locationParent" : {
      "refType" : "string",
      "controllerRef" : "string",
      "symbolRef" : "string",
      "typedReference" : {
        "componentType" : "string",
        "symbolRef" : "string"
      }
    },
    "locationPosition" : 0,
    "label" : "string"
  },
  "ipv4GatewayAddress" : "string",
  "controllerRef" : "string",
  "controllerSlot" : 0,
  "dnsProperties" : {
    "acquisitionProperties" : {
      "dnsAcquisitionType" : "string",
      "dnsServers" : [ {
        "addressType" : "string",
        "ipv4Address" : "string",
        "ipv6Address" : "string"
      } ]
    },
    "dhcpAcquiredDnsServers" : [ {
      "addressType" : "string",
      "ipv4Address" : "string",
      "ipv6Address" : "string"
    } ]
  },
  "ntpProperties" : {
    "acquisitionProperties" : {
      "ntpAcquisitionType" : "string",
      "ntpServers" : [ {
        "addrType" : "string",
        "domainName" : "string",
        "ipvxAddress" : {
          "addressType" : "string",
          "ipv4Address" : "string",
          "ipv6Address" : "string"
        }
      } ]
    },
    "dhcpAcquiredNtpServers" : [ {
      "addressType" : "string",
      "ipv4Address" : "string",
      "ipv6Address" : "string"
    } ]
  },
  "id" : "string"
}

3.19.22. Validate the stored password for a storage-system

POST /devmgr/v2/storage-systems/{system-id}/validatePassword
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

204

The password was successfully validated

422

The password validation failed because the password was invalid

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/validatePassword

3.19.23. Get a specific storage-system

GET /devmgr/v2/storage-systems/{system-id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

StorageSystemResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string
Example HTTP response
Response 200
{
  "id" : "string",
  "name" : "string",
  "wwn" : "string",
  "passwordStatus" : "string",
  "passwordSet" : true,
  "status" : "string",
  "ip1" : "string",
  "ip2" : "string",
  "managementPaths" : [ "string" ],
  "driveCount" : 0,
  "trayCount" : 0,
  "traceEnabled" : true,
  "types" : "string",
  "model" : "string",
  "metaTags" : [ {
    "key" : "string",
    "valueList" : [ "string" ]
  } ],
  "hotSpareSize" : "string",
  "usedPoolSpace" : "string",
  "freePoolSpace" : "string",
  "unconfiguredSpace" : "string",
  "driveTypes" : [ "string" ],
  "hostSpareCountInStandby" : 0,
  "hotSpareCount" : 0,
  "hostSparesUsed" : 0,
  "bootTime" : "string",
  "fwVersion" : "string",
  "appVersion" : "string",
  "bootVersion" : "string",
  "nvsramVersion" : "string",
  "chassisSerialNumber" : "string",
  "accessVolume" : {
    "enabled" : true,
    "volumeHandle" : 0,
    "capacity" : "string",
    "accessVolumeRef" : "string",
    "reserved1" : "string",
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string"
  },
  "unconfiguredSpaceByDriveType" : {
    "string" : "string"
  },
  "mediaScanPeriod" : 0,
  "driveChannelPortDisabled" : true,
  "recoveryModeEnabled" : true,
  "autoLoadBalancingEnabled" : true,
  "hostConnectivityReportingEnabled" : true,
  "remoteMirroringEnabled" : true,
  "fcRemoteMirroringState" : "string",
  "asupEnabled" : true,
  "securityKeyEnabled" : true,
  "externalKeyEnabled" : true,
  "lastContacted" : "string",
  "definedPartitionCount" : 0,
  "simplexModeEnabled" : true,
  "enabledManagementPorts" : [ "string" ],
  "freePoolSpaceAsString" : "string",
  "hotSpareSizeAsString" : "string",
  "unconfiguredSpaceAsStrings" : "string",
  "usedPoolSpaceAsString" : "string"
}

3.19.24. Update a storage-system

POST /devmgr/v2/storage-systems/{system-id}
MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

updateRequest
required

Update request

StorageSystemUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

StorageSystemResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string
Request body
{
  "storedPassword" : "string",
  "metaTags" : [ {
    "key" : "string",
    "valueList" : [ "string" ]
  } ],
  "removeAllTags" : true,
  "enableTrace" : true,
  "controllerAddresses" : [ "string" ]
}
Example HTTP response
Response 200
{
  "id" : "string",
  "name" : "string",
  "wwn" : "string",
  "passwordStatus" : "string",
  "passwordSet" : true,
  "status" : "string",
  "ip1" : "string",
  "ip2" : "string",
  "managementPaths" : [ "string" ],
  "driveCount" : 0,
  "trayCount" : 0,
  "traceEnabled" : true,
  "types" : "string",
  "model" : "string",
  "metaTags" : [ {
    "key" : "string",
    "valueList" : [ "string" ]
  } ],
  "hotSpareSize" : "string",
  "usedPoolSpace" : "string",
  "freePoolSpace" : "string",
  "unconfiguredSpace" : "string",
  "driveTypes" : [ "string" ],
  "hostSpareCountInStandby" : 0,
  "hotSpareCount" : 0,
  "hostSparesUsed" : 0,
  "bootTime" : "string",
  "fwVersion" : "string",
  "appVersion" : "string",
  "bootVersion" : "string",
  "nvsramVersion" : "string",
  "chassisSerialNumber" : "string",
  "accessVolume" : {
    "enabled" : true,
    "volumeHandle" : 0,
    "capacity" : "string",
    "accessVolumeRef" : "string",
    "reserved1" : "string",
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string"
  },
  "unconfiguredSpaceByDriveType" : {
    "string" : "string"
  },
  "mediaScanPeriod" : 0,
  "driveChannelPortDisabled" : true,
  "recoveryModeEnabled" : true,
  "autoLoadBalancingEnabled" : true,
  "hostConnectivityReportingEnabled" : true,
  "remoteMirroringEnabled" : true,
  "fcRemoteMirroringState" : "string",
  "asupEnabled" : true,
  "securityKeyEnabled" : true,
  "externalKeyEnabled" : true,
  "lastContacted" : "string",
  "definedPartitionCount" : 0,
  "simplexModeEnabled" : true,
  "enabledManagementPorts" : [ "string" ],
  "freePoolSpaceAsString" : "string",
  "hotSpareSizeAsString" : "string",
  "unconfiguredSpaceAsStrings" : "string",
  "usedPoolSpaceAsString" : "string"
}

3.19.25. Remove one or more storage-systems

DELETE /devmgr/v2/storage-systems/{system-id}
Description

The path is a comma-separated list of IDs. The identifiers of any storage-systems were failed to remove are provided in the response error response.

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

204

storage-system removed without error

422

1 or more storage-system removed failed with an error

CallResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string
Example HTTP response
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.19.26. Get list of storage-systems

GET /devmgr/v2/storage-systems
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Responses
HTTP Code Description Schema

200

successful operation

< StorageSystemResponse > array

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems
Example HTTP response
Response 200
{
  "id" : "string",
  "name" : "string",
  "wwn" : "string",
  "passwordStatus" : "string",
  "passwordSet" : true,
  "status" : "string",
  "ip1" : "string",
  "ip2" : "string",
  "managementPaths" : [ "string" ],
  "driveCount" : 0,
  "trayCount" : 0,
  "traceEnabled" : true,
  "types" : "string",
  "model" : "string",
  "metaTags" : [ {
    "key" : "string",
    "valueList" : [ "string" ]
  } ],
  "hotSpareSize" : "string",
  "usedPoolSpace" : "string",
  "freePoolSpace" : "string",
  "unconfiguredSpace" : "string",
  "driveTypes" : [ "string" ],
  "hostSpareCountInStandby" : 0,
  "hotSpareCount" : 0,
  "hostSparesUsed" : 0,
  "bootTime" : "string",
  "fwVersion" : "string",
  "appVersion" : "string",
  "bootVersion" : "string",
  "nvsramVersion" : "string",
  "chassisSerialNumber" : "string",
  "accessVolume" : {
    "enabled" : true,
    "volumeHandle" : 0,
    "capacity" : "string",
    "accessVolumeRef" : "string",
    "reserved1" : "string",
    "name" : "string",
    "id" : "string",
    "objectType" : "string",
    "wwn" : "string",
    "mapped" : true,
    "preferredControllerId" : "string",
    "totalSizeInBytes" : "string",
    "listOfMappings" : [ {
      "lunMappingRef" : "string",
      "lun" : 0,
      "ssid" : 0,
      "perms" : 0,
      "volumeRef" : "string",
      "type" : "string",
      "mapRef" : "string",
      "id" : "string"
    } ],
    "currentControllerId" : "string"
  },
  "unconfiguredSpaceByDriveType" : {
    "string" : "string"
  },
  "mediaScanPeriod" : 0,
  "driveChannelPortDisabled" : true,
  "recoveryModeEnabled" : true,
  "autoLoadBalancingEnabled" : true,
  "hostConnectivityReportingEnabled" : true,
  "remoteMirroringEnabled" : true,
  "fcRemoteMirroringState" : "string",
  "asupEnabled" : true,
  "securityKeyEnabled" : true,
  "externalKeyEnabled" : true,
  "lastContacted" : "string",
  "definedPartitionCount" : 0,
  "simplexModeEnabled" : true,
  "enabledManagementPorts" : [ "string" ],
  "freePoolSpaceAsString" : "string",
  "hotSpareSizeAsString" : "string",
  "unconfiguredSpaceAsStrings" : "string",
  "usedPoolSpaceAsString" : "string"
} ]

3.19.27. Add a storage-system

POST /devmgr/v2/storage-systems
Description

This endpoint allows you to add additional storage-systems under management using their IP address[es].

MetaData

x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Schema

Body

body
optional

StorageSystemCreateRequest

Responses
HTTP Code Description Schema

200

storage-system already exists

AddStorageSystemReturn

201

storage-system added successfully

AddStorageSystemReturn

422

Could not connect to storage system

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems
Request body
{
  "id" : "string",
  "controllerAddresses" : [ "string" ],
  "validate" : true,
  "password" : "string",
  "wwn" : "string",
  "enableTrace" : true,
  "metaTags" : [ {
    "key" : "string",
    "valueList" : [ "string" ]
  } ]
}
Example HTTP response
Response 200
{
  "id" : "string",
  "alreadyExists" : true
}
Response 201
{
  "id" : "string",
  "alreadyExists" : true
}

3.19.28. Get StorageDevice capabilities.

GET /devmgr/v2/storage-systems/{system-id}/capabilities
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

CapabilitiesResponse

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/capabilities
Example HTTP response
Response 200
{
  "featureBundle" : {
    "name" : "string",
    "bundledFeatures" : [ {
      "featureId" : "string",
      "featureAttribute" : [ {
        "featureAttrId" : "string",
        "keyEnabled" : true,
        "keyLimit" : 0,
        "shippedEnabled" : true,
        "shippedLimit" : 0,
        "subjectToGoldKey" : true,
        "supportedValues" : [ "string" ],
        "evaluationDuration" : 0
      } ]
    } ],
    "bundleSubmodelId" : "string"
  },
  "capabilities" : [ "string" ],
  "productCapabilities" : [ "string" ],
  "featureStates" : [ {
    "capability" : "string",
    "isEnabled" : true,
    "isCompliant" : true,
    "isWithinLimits" : true,
    "featureId" : "string",
    "featureRef" : "string",
    "limit" : 0,
    "duration" : 0,
    "enabledTime" : "string",
    "supportedFeatureBundleId" : 0,
    "permanentLicenseApplied" : true
  } ],
  "storageSystemAttributes" : {
    "isLun0RestrictedForDefaultPartition" : true
  },
  "featureParameters" : {
    "maxHotSpares" : 0,
    "cacheBlockSizes" : [ 0 ],
    "maxDCEDrives" : 0,
    "maxReadAheadMultiplier" : 0,
    "minMediaScanPeriod" : 0,
    "maxMediaScanPeriod" : 0,
    "supportedSegSizes" : [ 0 ],
    "numStandardSegSizes" : 0,
    "segTransitions" : [ "string" ],
    "mappableLUNCount" : 0,
    "maxPartitionCount" : 0,
    "maxMappingsPerVolume" : 0,
    "maxVolumes" : 0,
    "maxSnapshots" : 0,
    "maxSnapshotsPerBase" : 0,
    "minRepositorySize" : 0,
    "maxMirrors" : 0,
    "maxVolCopys" : 0,
    "maxConcurrentBackgroundCopys" : 0,
    "maxUtmLunValue" : 0,
    "reserved1" : "string",
    "reserved2" : "string",
    "battery_not_in_configuration" : true,
    "supportedDriveTypes" : [ "string" ],
    "currentMaxMirrors" : 0,
    "maxVolumesPerGroup" : 0,
    "maxDriveDownloadFiles" : 0,
    "maxMgmtClientRecords" : 0,
    "maxMgmtClientRecordSize" : 0,
    "redundancyMode" : "string",
    "maxExpansionDriveTrays" : 0,
    "supportedAuthMethods" : [ "string" ],
    "maxIscsiIpv6LocalAddressesPerPort" : 0,
    "maxIscsiIpv6RoutableAddressesPerPort" : 0,
    "absoluteMaxDssSegmentSize" : 0,
    "smartBatteryTechnology" : true,
    "writeCachingEnabledDuringLearnCycle" : true,
    "maxSSDsSupported" : 0,
    "ssdInterfaceTypeMixingSupported" : true,
    "maxDriveSlots" : 0,
    "supportedProtectionTypes" : [ "string" ],
    "supportedEventPriorities" : [ "string" ],
    "maxFlashCacheSize" : "string",
    "defaultMediaScanPeriod" : 0
  }
}

3.20. Upgrade

3.20.1. Initiates a reload of the software.

POST /devmgr/v2/upgrade/reload
Description

Loads any downloaded updates.
This is an asynchronous operation and is used in conjunction with /devmgr/v2/events.

MetaData

x-mode = both
x-allowedRoles = [root.admin, support.admin]

Responses
HTTP Code Description Schema

200

successful operation

UpgradeManagerResponse

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/upgrade/reload
Example HTTP response
Response 200
{
  "correlationId" : "string"
}

3.20.2. Retrieves current and staged version information for the RESTApi software

GET /devmgr/v2/upgrade
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, support.admin]

Responses
HTTP Code Description Schema

200

Successfully retrieved the current and staged version information.

SoftwareVersions

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/upgrade
Example HTTP response
Response 200
{
  "stagedVersions" : [ {
    "context" : "string",
    "version" : "string"
  } ],
  "currentVersions" : [ {
    "context" : "string",
    "version" : "string"
  } ]
}

3.20.3. Initiates a software update

POST /devmgr/v2/upgrade/download
Description

This is an asynchronous operation and used in conjunction with REST endpoint /devmgr/v2/events

MetaData

x-mode = both
x-allowedRoles = [root.admin, support.admin]

Parameters
Type Name Schema

Query

force
optional

string

Responses
HTTP Code Description Schema

200

successful operation

UpgradeManagerResponse

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/upgrade/download
Request query
{
  "force" : "string"
}
Example HTTP response
Response 200
{
  "correlationId" : "string"
}

3.21. Volumes

3.21.1. Get the access volume

GET /devmgr/v2/storage-systems/{system-id}/access-volume
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

AccessVolumeEx

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/access-volume
Example HTTP response
Response 200
{
  "enabled" : true,
  "volumeHandle" : 0,
  "capacity" : "string",
  "accessVolumeRef" : "string",
  "reserved1" : "string",
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}

3.21.2. Get a list of all mappable objects

GET /devmgr/v2/storage-systems/{system-id}/mappable-objects
Description

Provides a simplified way to discover the type of mappable object from an id/reference.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< MappableObject > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mappable-objects
Example HTTP response
Response 200
{
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
} ]

3.21.3. Get a specific mappable object

GET /devmgr/v2/storage-systems/{system-id}/mappable-objects/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

MappableObject

404

Mappable object not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mappable-objects/string
Example HTTP response
Response 200
{
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.4. Get the list of ThinVolumes

GET /devmgr/v2/storage-systems/{system-id}/thin-volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< ThinVolumeEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes
Example HTTP response
Response 200
{
  "volumeHandle" : 0,
  "worldWideName" : "string",
  "label" : "string",
  "allocationGranularity" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "volumeRef" : "string",
  "status" : "string",
  "repositoryRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "maxVirtualCapacity" : "string",
  "initialProvisionedCapacity" : "string",
  "currentProvisionedCapacity" : "string",
  "provisionedCapacityQuota" : "string",
  "growthAlertThreshold" : 0,
  "expansionPolicy" : "string",
  "volumeCache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "offline" : true,
  "reportingPolicy" : "string",
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "storageVolumeRef" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "flashCached" : true,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
} ]

3.21.5. Create a ThinVolume

POST /devmgr/v2/storage-systems/{system-id}/thin-volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

ThinVolumeCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

ThinVolumeEx

404

ThinVolume was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes
Request body
{
  "poolId" : "string",
  "name" : "string",
  "sizeUnit" : "string",
  "virtualSize" : "string",
  "repositorySize" : "string",
  "maximumRepositorySize" : "string",
  "owningControllerId" : "string",
  "growthAlertThreshold" : 0,
  "createDefaultMapping" : true,
  "expansionPolicy" : "string",
  "cacheReadAhead" : true,
  "dataAssuranceEnabled" : true,
  "metaTags" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "volumeHandle" : 0,
  "worldWideName" : "string",
  "label" : "string",
  "allocationGranularity" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "volumeRef" : "string",
  "status" : "string",
  "repositoryRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "maxVirtualCapacity" : "string",
  "initialProvisionedCapacity" : "string",
  "currentProvisionedCapacity" : "string",
  "provisionedCapacityQuota" : "string",
  "growthAlertThreshold" : 0,
  "expansionPolicy" : "string",
  "volumeCache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "offline" : true,
  "reportingPolicy" : "string",
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "storageVolumeRef" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "flashCached" : true,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
}

3.21.6. Get a ThinVolume

GET /devmgr/v2/storage-systems/{system-id}/thin-volumes/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

ThinVolumeEx

404

ThinVolume was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string
Example HTTP response
Response 200
{
  "volumeHandle" : 0,
  "worldWideName" : "string",
  "label" : "string",
  "allocationGranularity" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "volumeRef" : "string",
  "status" : "string",
  "repositoryRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "maxVirtualCapacity" : "string",
  "initialProvisionedCapacity" : "string",
  "currentProvisionedCapacity" : "string",
  "provisionedCapacityQuota" : "string",
  "growthAlertThreshold" : 0,
  "expansionPolicy" : "string",
  "volumeCache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "offline" : true,
  "reportingPolicy" : "string",
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "storageVolumeRef" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "flashCached" : true,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
}

3.21.7. Update a ThinVolume

POST /devmgr/v2/storage-systems/{system-id}/thin-volumes/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

ThinVolumeUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

ThinVolumeEx

404

ThinVolume was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string
Request body
{
  "name" : "string",
  "growthAlertThreshold" : 0,
  "flashCache" : true,
  "metaTags" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "expansionPolicy" : "string",
  "owningControllerId" : "string",
  "cacheSettings" : {
    "readCacheEnable" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string"
  },
  "scanSettings" : {
    "enable" : true,
    "parityValidationEnable" : true
  }
}
Example HTTP response
Response 200
{
  "volumeHandle" : 0,
  "worldWideName" : "string",
  "label" : "string",
  "allocationGranularity" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "volumeRef" : "string",
  "status" : "string",
  "repositoryRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "maxVirtualCapacity" : "string",
  "initialProvisionedCapacity" : "string",
  "currentProvisionedCapacity" : "string",
  "provisionedCapacityQuota" : "string",
  "growthAlertThreshold" : 0,
  "expansionPolicy" : "string",
  "volumeCache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "offline" : true,
  "reportingPolicy" : "string",
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "storageVolumeRef" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "flashCached" : true,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
}

3.21.8. Delete a ThinVolume

DELETE /devmgr/v2/storage-systems/{system-id}/thin-volumes/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Delete was successful

404

ThinVolume was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string

3.21.9. Initialize a ThinVolume

POST /devmgr/v2/storage-systems/{system-id}/thin-volumes/{thinVolumeId}/initialize
Description

Reinitialize the target thin volume, wiping out all existing data!

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

thinVolumeId
required

string

Responses
HTTP Code Description Schema

200

successful operation

ThinVolumeEx

404

ThinVolume was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string/initialize
Example HTTP response
Response 200
{
  "volumeHandle" : 0,
  "worldWideName" : "string",
  "label" : "string",
  "allocationGranularity" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "volumeRef" : "string",
  "status" : "string",
  "repositoryRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "maxVirtualCapacity" : "string",
  "initialProvisionedCapacity" : "string",
  "currentProvisionedCapacity" : "string",
  "provisionedCapacityQuota" : "string",
  "growthAlertThreshold" : 0,
  "expansionPolicy" : "string",
  "volumeCache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "offline" : true,
  "reportingPolicy" : "string",
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "storageVolumeRef" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "flashCached" : true,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
}

3.21.10. Expand a ThinVolume

POST /devmgr/v2/storage-systems/{system-id}/thin-volumes/{id}/expand
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

ThinVolumeExpansionRequest

Responses
HTTP Code Description Schema

200

successful operation

ThinVolumeEx

404

ThinVolume was not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string/expand
Request body
{
  "sizeUnit" : "string",
  "newVirtualSize" : "string",
  "newRepositorySize" : "string"
}
Example HTTP response
Response 200
{
  "volumeHandle" : 0,
  "worldWideName" : "string",
  "label" : "string",
  "allocationGranularity" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "volumeRef" : "string",
  "status" : "string",
  "repositoryRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "maxVirtualCapacity" : "string",
  "initialProvisionedCapacity" : "string",
  "currentProvisionedCapacity" : "string",
  "provisionedCapacityQuota" : "string",
  "growthAlertThreshold" : 0,
  "expansionPolicy" : "string",
  "volumeCache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "offline" : true,
  "reportingPolicy" : "string",
  "extendedUniqueIdentifier" : "string",
  "volumeFull" : true,
  "volumeGroupRef" : "string",
  "blkSize" : 0,
  "storageVolumeRef" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "flashCached" : true,
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "diskPool" : true,
  "segmentSize" : 0,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
}

3.21.11. Get list of storage pools

GET /devmgr/v2/storage-systems/{system-id}/storage-pools
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< VolumeGroupEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools
Example HTTP response
Response 200
{
  "sequenceNum" : 0,
  "offline" : true,
  "raidLevel" : "string",
  "worldWideName" : "string",
  "volumeGroupRef" : "string",
  "reserved1" : "string",
  "reserved2" : "string",
  "trayLossProtection" : true,
  "label" : "string",
  "state" : "string",
  "spindleSpeedMatch" : true,
  "spindleSpeed" : 0,
  "isInaccessible" : true,
  "securityType" : "string",
  "drawerLossProtection" : true,
  "protectionInformationCapable" : true,
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "volumeGroupData" : {
    "type" : "string",
    "diskPoolData" : {
      "reconstructionReservedDriveCount" : 0,
      "reconstructionReservedAmt" : "string",
      "reconstructionReservedDriveCountCurrent" : 0,
      "poolUtilizationWarningThreshold" : 0,
      "poolUtilizationCriticalThreshold" : 0,
      "poolUtilizationState" : "string",
      "unusableCapacity" : "string",
      "degradedReconstructPriority" : "string",
      "criticalReconstructPriority" : "string",
      "backgroundOperationPriority" : "string",
      "allocGranularity" : "string",
      "minimumDriveCount" : 0
    }
  },
  "usage" : "string",
  "driveBlockFormat" : "string",
  "reservedSpaceAllocated" : true,
  "securityLevel" : "string",
  "usedSpace" : "string",
  "totalRaidedSpace" : "string",
  "extents" : [ {
    "sectorOffset" : "string",
    "rawCapacity" : "string",
    "raidLevel" : "string",
    "volumeGroupRef" : "string",
    "freeExtentRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string"
  } ],
  "largestFreeExtentSize" : "string",
  "raidStatus" : "string",
  "freeSpace" : "string",
  "drivePhysicalType" : "string",
  "driveMediaType" : "string",
  "normalizedSpindleSpeed" : "string",
  "id" : "string",
  "diskPool" : true,
  "name" : "string"
} ]

3.21.12. Create a storage pool

POST /devmgr/v2/storage-systems/{system-id}/storage-pools
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

StoragePoolCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeGroupEx

404

StorageDevice not found

422

Created pool not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools
Request body
{
  "raidLevel" : "string",
  "diskDriveIds" : [ "string" ],
  "eraseSecuredDrives" : true,
  "name" : "string"
}
Example HTTP response
Response 200
{
  "sequenceNum" : 0,
  "offline" : true,
  "raidLevel" : "string",
  "worldWideName" : "string",
  "volumeGroupRef" : "string",
  "reserved1" : "string",
  "reserved2" : "string",
  "trayLossProtection" : true,
  "label" : "string",
  "state" : "string",
  "spindleSpeedMatch" : true,
  "spindleSpeed" : 0,
  "isInaccessible" : true,
  "securityType" : "string",
  "drawerLossProtection" : true,
  "protectionInformationCapable" : true,
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "volumeGroupData" : {
    "type" : "string",
    "diskPoolData" : {
      "reconstructionReservedDriveCount" : 0,
      "reconstructionReservedAmt" : "string",
      "reconstructionReservedDriveCountCurrent" : 0,
      "poolUtilizationWarningThreshold" : 0,
      "poolUtilizationCriticalThreshold" : 0,
      "poolUtilizationState" : "string",
      "unusableCapacity" : "string",
      "degradedReconstructPriority" : "string",
      "criticalReconstructPriority" : "string",
      "backgroundOperationPriority" : "string",
      "allocGranularity" : "string",
      "minimumDriveCount" : 0
    }
  },
  "usage" : "string",
  "driveBlockFormat" : "string",
  "reservedSpaceAllocated" : true,
  "securityLevel" : "string",
  "usedSpace" : "string",
  "totalRaidedSpace" : "string",
  "extents" : [ {
    "sectorOffset" : "string",
    "rawCapacity" : "string",
    "raidLevel" : "string",
    "volumeGroupRef" : "string",
    "freeExtentRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string"
  } ],
  "largestFreeExtentSize" : "string",
  "raidStatus" : "string",
  "freeSpace" : "string",
  "drivePhysicalType" : "string",
  "driveMediaType" : "string",
  "normalizedSpindleSpeed" : "string",
  "id" : "string",
  "diskPool" : true,
  "name" : "string"
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.13. Get a storage pool

GET /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

VolumeGroupEx

404

Pool not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string
Example HTTP response
Response 200
{
  "sequenceNum" : 0,
  "offline" : true,
  "raidLevel" : "string",
  "worldWideName" : "string",
  "volumeGroupRef" : "string",
  "reserved1" : "string",
  "reserved2" : "string",
  "trayLossProtection" : true,
  "label" : "string",
  "state" : "string",
  "spindleSpeedMatch" : true,
  "spindleSpeed" : 0,
  "isInaccessible" : true,
  "securityType" : "string",
  "drawerLossProtection" : true,
  "protectionInformationCapable" : true,
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "volumeGroupData" : {
    "type" : "string",
    "diskPoolData" : {
      "reconstructionReservedDriveCount" : 0,
      "reconstructionReservedAmt" : "string",
      "reconstructionReservedDriveCountCurrent" : 0,
      "poolUtilizationWarningThreshold" : 0,
      "poolUtilizationCriticalThreshold" : 0,
      "poolUtilizationState" : "string",
      "unusableCapacity" : "string",
      "degradedReconstructPriority" : "string",
      "criticalReconstructPriority" : "string",
      "backgroundOperationPriority" : "string",
      "allocGranularity" : "string",
      "minimumDriveCount" : 0
    }
  },
  "usage" : "string",
  "driveBlockFormat" : "string",
  "reservedSpaceAllocated" : true,
  "securityLevel" : "string",
  "usedSpace" : "string",
  "totalRaidedSpace" : "string",
  "extents" : [ {
    "sectorOffset" : "string",
    "rawCapacity" : "string",
    "raidLevel" : "string",
    "volumeGroupRef" : "string",
    "freeExtentRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string"
  } ],
  "largestFreeExtentSize" : "string",
  "raidStatus" : "string",
  "freeSpace" : "string",
  "drivePhysicalType" : "string",
  "driveMediaType" : "string",
  "normalizedSpindleSpeed" : "string",
  "id" : "string",
  "diskPool" : true,
  "name" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.14. Update a storage pool

POST /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

request
required

StoragePoolUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeGroupEx

404

Pool not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string
Request body
{
  "name" : "string",
  "securePool" : true,
  "reservedDriveCount" : 0,
  "poolPriority" : {
    "priority" : "string",
    "priorityType" : "string"
  },
  "poolThreshold" : {
    "thresholdType" : "string",
    "value" : 0
  }
}
Example HTTP response
Response 200
{
  "sequenceNum" : 0,
  "offline" : true,
  "raidLevel" : "string",
  "worldWideName" : "string",
  "volumeGroupRef" : "string",
  "reserved1" : "string",
  "reserved2" : "string",
  "trayLossProtection" : true,
  "label" : "string",
  "state" : "string",
  "spindleSpeedMatch" : true,
  "spindleSpeed" : 0,
  "isInaccessible" : true,
  "securityType" : "string",
  "drawerLossProtection" : true,
  "protectionInformationCapable" : true,
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "volumeGroupData" : {
    "type" : "string",
    "diskPoolData" : {
      "reconstructionReservedDriveCount" : 0,
      "reconstructionReservedAmt" : "string",
      "reconstructionReservedDriveCountCurrent" : 0,
      "poolUtilizationWarningThreshold" : 0,
      "poolUtilizationCriticalThreshold" : 0,
      "poolUtilizationState" : "string",
      "unusableCapacity" : "string",
      "degradedReconstructPriority" : "string",
      "criticalReconstructPriority" : "string",
      "backgroundOperationPriority" : "string",
      "allocGranularity" : "string",
      "minimumDriveCount" : 0
    }
  },
  "usage" : "string",
  "driveBlockFormat" : "string",
  "reservedSpaceAllocated" : true,
  "securityLevel" : "string",
  "usedSpace" : "string",
  "totalRaidedSpace" : "string",
  "extents" : [ {
    "sectorOffset" : "string",
    "rawCapacity" : "string",
    "raidLevel" : "string",
    "volumeGroupRef" : "string",
    "freeExtentRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string"
  } ],
  "largestFreeExtentSize" : "string",
  "raidStatus" : "string",
  "freeSpace" : "string",
  "drivePhysicalType" : "string",
  "driveMediaType" : "string",
  "normalizedSpindleSpeed" : "string",
  "id" : "string",
  "diskPool" : true,
  "name" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.15. Delete a storage pool

DELETE /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema Default

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Query

delete-volumes
optional

Automatically delete all owned volumes when a delete request is received.

boolean

"false"

Responses
HTTP Code Description Schema

204

Delete was successful

404

Pool not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string
Request query
{
  "delete-volumes" : true
}
Example HTTP response
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.16. Perform a RAID type migration on a storage pool

POST /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}/raid-type-migration
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

RaidMigrationRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeGroupEx

404

Pool not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/raid-type-migration
Request body
{
  "raidLevel" : "string"
}
Example HTTP response
Response 200
{
  "sequenceNum" : 0,
  "offline" : true,
  "raidLevel" : "string",
  "worldWideName" : "string",
  "volumeGroupRef" : "string",
  "reserved1" : "string",
  "reserved2" : "string",
  "trayLossProtection" : true,
  "label" : "string",
  "state" : "string",
  "spindleSpeedMatch" : true,
  "spindleSpeed" : 0,
  "isInaccessible" : true,
  "securityType" : "string",
  "drawerLossProtection" : true,
  "protectionInformationCapable" : true,
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "volumeGroupData" : {
    "type" : "string",
    "diskPoolData" : {
      "reconstructionReservedDriveCount" : 0,
      "reconstructionReservedAmt" : "string",
      "reconstructionReservedDriveCountCurrent" : 0,
      "poolUtilizationWarningThreshold" : 0,
      "poolUtilizationCriticalThreshold" : 0,
      "poolUtilizationState" : "string",
      "unusableCapacity" : "string",
      "degradedReconstructPriority" : "string",
      "criticalReconstructPriority" : "string",
      "backgroundOperationPriority" : "string",
      "allocGranularity" : "string",
      "minimumDriveCount" : 0
    }
  },
  "usage" : "string",
  "driveBlockFormat" : "string",
  "reservedSpaceAllocated" : true,
  "securityLevel" : "string",
  "usedSpace" : "string",
  "totalRaidedSpace" : "string",
  "extents" : [ {
    "sectorOffset" : "string",
    "rawCapacity" : "string",
    "raidLevel" : "string",
    "volumeGroupRef" : "string",
    "freeExtentRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string"
  } ],
  "largestFreeExtentSize" : "string",
  "raidStatus" : "string",
  "freeSpace" : "string",
  "drivePhysicalType" : "string",
  "driveMediaType" : "string",
  "normalizedSpindleSpeed" : "string",
  "id" : "string",
  "diskPool" : true,
  "name" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.17. Check the progress of a long-running action on a storage pool

GET /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}/action-progress
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

< OperationProgress > array

404

Pool not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/action-progress
Example HTTP response
Response 200
{
  "volumeRef" : "string",
  "currentAction" : "string",
  "progressPercentage" : 0,
  "estimatedTimeToCompletion" : 0
} ]
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.18. Retrieve a list of expansion candidates for a StoragePool

GET /devmgr/v2/storage-systems/{system-id}/storage-pools/{poolId}/expand
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

poolId
required

Storage pool id

string

Responses
HTTP Code Description Schema

200

successful operation

< VolumeGroupExpansionCandidate > array

404

Pool not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/expand
Example HTTP response
Response 200
{
  "drives" : [ "string" ],
  "trayLossProtection" : true,
  "wastedCapacity" : "string",
  "spindleSpeedMatch" : true,
  "drawerLossProtection" : true,
  "usableCapacity" : "string",
  "driveBlockFormat" : "string"
} ]
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.19. Expand the capacity of a StoragePool

POST /devmgr/v2/storage-systems/{system-id}/storage-pools/{poolId}/expand
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

poolId
required

Storage pool id

string

Body

body
optional

StoragePoolExpansionRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeGroupEx

404

Pool not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/expand
Request body
{
  "drives" : [ "string" ]
}
Example HTTP response
Response 200
{
  "sequenceNum" : 0,
  "offline" : true,
  "raidLevel" : "string",
  "worldWideName" : "string",
  "volumeGroupRef" : "string",
  "reserved1" : "string",
  "reserved2" : "string",
  "trayLossProtection" : true,
  "label" : "string",
  "state" : "string",
  "spindleSpeedMatch" : true,
  "spindleSpeed" : 0,
  "isInaccessible" : true,
  "securityType" : "string",
  "drawerLossProtection" : true,
  "protectionInformationCapable" : true,
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "volumeGroupData" : {
    "type" : "string",
    "diskPoolData" : {
      "reconstructionReservedDriveCount" : 0,
      "reconstructionReservedAmt" : "string",
      "reconstructionReservedDriveCountCurrent" : 0,
      "poolUtilizationWarningThreshold" : 0,
      "poolUtilizationCriticalThreshold" : 0,
      "poolUtilizationState" : "string",
      "unusableCapacity" : "string",
      "degradedReconstructPriority" : "string",
      "criticalReconstructPriority" : "string",
      "backgroundOperationPriority" : "string",
      "allocGranularity" : "string",
      "minimumDriveCount" : 0
    }
  },
  "usage" : "string",
  "driveBlockFormat" : "string",
  "reservedSpaceAllocated" : true,
  "securityLevel" : "string",
  "usedSpace" : "string",
  "totalRaidedSpace" : "string",
  "extents" : [ {
    "sectorOffset" : "string",
    "rawCapacity" : "string",
    "raidLevel" : "string",
    "volumeGroupRef" : "string",
    "freeExtentRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string"
  } ],
  "largestFreeExtentSize" : "string",
  "raidStatus" : "string",
  "freeSpace" : "string",
  "drivePhysicalType" : "string",
  "driveMediaType" : "string",
  "normalizedSpindleSpeed" : "string",
  "id" : "string",
  "diskPool" : true,
  "name" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.20. Get maximum number of drives that can be removed from a StoragePool

GET /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}/reduction
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

RemovableDriveResponse

404

Pool not found

CallResponse

422

This operation is only supported on pools of type raidDiskPool

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/reduction
Example HTTP response
Response 200
{
  "poolId" : "string",
  "removableDriveCount" : 0
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.21. Reduce the number of drives of a StoragePool

POST /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}/reduction
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

DiskPoolReductionRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeGroupEx

404

Pool not found

CallResponse

422

The maximum removable drive count (12), for a single operation has been exceeded

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/reduction
Request body
{
  "drives" : [ "string" ]
}
Example HTTP response
Response 200
{
  "sequenceNum" : 0,
  "offline" : true,
  "raidLevel" : "string",
  "worldWideName" : "string",
  "volumeGroupRef" : "string",
  "reserved1" : "string",
  "reserved2" : "string",
  "trayLossProtection" : true,
  "label" : "string",
  "state" : "string",
  "spindleSpeedMatch" : true,
  "spindleSpeed" : 0,
  "isInaccessible" : true,
  "securityType" : "string",
  "drawerLossProtection" : true,
  "protectionInformationCapable" : true,
  "protectionInformationCapabilities" : {
    "protectionInformationCapable" : true,
    "protectionType" : "string"
  },
  "volumeGroupData" : {
    "type" : "string",
    "diskPoolData" : {
      "reconstructionReservedDriveCount" : 0,
      "reconstructionReservedAmt" : "string",
      "reconstructionReservedDriveCountCurrent" : 0,
      "poolUtilizationWarningThreshold" : 0,
      "poolUtilizationCriticalThreshold" : 0,
      "poolUtilizationState" : "string",
      "unusableCapacity" : "string",
      "degradedReconstructPriority" : "string",
      "criticalReconstructPriority" : "string",
      "backgroundOperationPriority" : "string",
      "allocGranularity" : "string",
      "minimumDriveCount" : 0
    }
  },
  "usage" : "string",
  "driveBlockFormat" : "string",
  "reservedSpaceAllocated" : true,
  "securityLevel" : "string",
  "usedSpace" : "string",
  "totalRaidedSpace" : "string",
  "extents" : [ {
    "sectorOffset" : "string",
    "rawCapacity" : "string",
    "raidLevel" : "string",
    "volumeGroupRef" : "string",
    "freeExtentRef" : "string",
    "reserved1" : "string",
    "reserved2" : "string"
  } ],
  "largestFreeExtentSize" : "string",
  "raidStatus" : "string",
  "freeSpace" : "string",
  "drivePhysicalType" : "string",
  "driveMediaType" : "string",
  "normalizedSpindleSpeed" : "string",
  "id" : "string",
  "diskPool" : true,
  "name" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.22. Get the list of volumes

GET /devmgr/v2/storage-systems/{system-id}/volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< VolumeEx > array

404

Volume not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes
Example HTTP response
Response 200
{
  "offline" : true,
  "extremeProtection" : true,
  "volumeHandle" : 0,
  "raidLevel" : "string",
  "sectorOffset" : "string",
  "worldWideName" : "string",
  "label" : "string",
  "blkSize" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "segmentSize" : 0,
  "action" : "string",
  "cache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "volumeRef" : "string",
  "status" : "string",
  "volumeGroupRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "dssPreallocEnabled" : true,
  "dssMaxSegmentSize" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionInformationCapable" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "repairedBlockCount" : 0,
  "extendedUniqueIdentifier" : "string",
  "cacheMirroringValidateProtectionInformation" : true,
  "expectedProtectionInformationAppTag" : 0,
  "volumeUse" : "string",
  "volumeFull" : true,
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "diskPool" : true,
  "flashCached" : true,
  "increasingBy" : "string",
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
} ]
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.23. Create a new volume

POST /devmgr/v2/storage-systems/{system-id}/volumes
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

VolumeCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeEx

404

Created volume not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes
Request body
{
  "poolId" : "string",
  "name" : "string",
  "sizeUnit" : "gb",
  "size" : "string",
  "segSize" : 0,
  "dataAssuranceEnabled" : true,
  "owningControllerId" : "string",
  "metaTags" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "offline" : true,
  "extremeProtection" : true,
  "volumeHandle" : 0,
  "raidLevel" : "string",
  "sectorOffset" : "string",
  "worldWideName" : "string",
  "label" : "string",
  "blkSize" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "segmentSize" : 0,
  "action" : "string",
  "cache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "volumeRef" : "string",
  "status" : "string",
  "volumeGroupRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "dssPreallocEnabled" : true,
  "dssMaxSegmentSize" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionInformationCapable" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "repairedBlockCount" : 0,
  "extendedUniqueIdentifier" : "string",
  "cacheMirroringValidateProtectionInformation" : true,
  "expectedProtectionInformationAppTag" : 0,
  "volumeUse" : "string",
  "volumeFull" : true,
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "diskPool" : true,
  "flashCached" : true,
  "increasingBy" : "string",
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.24. Get the volume expansion progress

GET /devmgr/v2/storage-systems/{system-id}/volumes/{id}/expand
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

VolumeActionProgressResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string/expand
Example HTTP response
Response 200
{
  "percentComplete" : 0,
  "timeToCompletion" : 0,
  "action" : "string"
}

3.21.25. Start the volume expansion

POST /devmgr/v2/storage-systems/{system-id}/volumes/{id}/expand
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

VolumeExpansionRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeActionProgressResponse

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string/expand
Request body
{
  "sizeUnit" : "string",
  "expansionSize" : "string"
}
Example HTTP response
Response 200
{
  "percentComplete" : 0,
  "timeToCompletion" : 0,
  "action" : "string"
}

3.21.26. Get a specific volume

GET /devmgr/v2/storage-systems/{system-id}/volumes/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

VolumeEx

404

Volume not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string
Example HTTP response
Response 200
{
  "offline" : true,
  "extremeProtection" : true,
  "volumeHandle" : 0,
  "raidLevel" : "string",
  "sectorOffset" : "string",
  "worldWideName" : "string",
  "label" : "string",
  "blkSize" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "segmentSize" : 0,
  "action" : "string",
  "cache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "volumeRef" : "string",
  "status" : "string",
  "volumeGroupRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "dssPreallocEnabled" : true,
  "dssMaxSegmentSize" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionInformationCapable" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "repairedBlockCount" : 0,
  "extendedUniqueIdentifier" : "string",
  "cacheMirroringValidateProtectionInformation" : true,
  "expectedProtectionInformationAppTag" : 0,
  "volumeUse" : "string",
  "volumeFull" : true,
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "diskPool" : true,
  "flashCached" : true,
  "increasingBy" : "string",
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.27. Update volume parameters

POST /devmgr/v2/storage-systems/{system-id}/volumes/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Body

body
optional

VolumeUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

VolumeEx

404

Volume not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string
Request body
{
  "name" : "string",
  "owningControllerId" : "string",
  "cacheSettings" : {
    "readCacheEnable" : true,
    "writeCacheEnable" : true,
    "readAheadEnable" : true,
    "cacheFlushModifier" : "string",
    "mirrorEnable" : true,
    "cacheWithoutBatteries" : true
  },
  "flashCache" : true,
  "scanSettings" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "metaTags" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "offline" : true,
  "extremeProtection" : true,
  "volumeHandle" : 0,
  "raidLevel" : "string",
  "sectorOffset" : "string",
  "worldWideName" : "string",
  "label" : "string",
  "blkSize" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "segmentSize" : 0,
  "action" : "string",
  "cache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "volumeRef" : "string",
  "status" : "string",
  "volumeGroupRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "dssPreallocEnabled" : true,
  "dssMaxSegmentSize" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionInformationCapable" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "repairedBlockCount" : 0,
  "extendedUniqueIdentifier" : "string",
  "cacheMirroringValidateProtectionInformation" : true,
  "expectedProtectionInformationAppTag" : 0,
  "volumeUse" : "string",
  "volumeFull" : true,
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "diskPool" : true,
  "flashCached" : true,
  "increasingBy" : "string",
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.28. Delete a volume

DELETE /devmgr/v2/storage-systems/{system-id}/volumes/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

404

Volume not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string
Example HTTP response
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.29. Initialize a volume

POST /devmgr/v2/storage-systems/{system-id}/volumes/{volumeId}/initialize
Description

This procedure causes the specified volume to be re-initialized. All data that is currently present on the volume will be irretrievably lost as a result of this operation. Once a format operation starts, the volume’s action field will be changed to 'initializing'; the getVolumeActionProgress procedure can then be used to monitor the progress of the operation. Volume format operations are typically required only when reviving a volume that has been marked failed for some reason. Newly-created volumes need not be explicitly formatted using this procedure.

MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

volumeId
required

string

Responses
HTTP Code Description Schema

200

successful operation

VolumeEx

404

Volume not found

CallResponse

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string/initialize
Example HTTP response
Response 200
{
  "offline" : true,
  "extremeProtection" : true,
  "volumeHandle" : 0,
  "raidLevel" : "string",
  "sectorOffset" : "string",
  "worldWideName" : "string",
  "label" : "string",
  "blkSize" : 0,
  "capacity" : "string",
  "reconPriority" : 0,
  "segmentSize" : 0,
  "action" : "string",
  "cache" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "mediaScan" : {
    "enable" : true,
    "parityValidationEnable" : true
  },
  "volumeRef" : "string",
  "status" : "string",
  "volumeGroupRef" : "string",
  "currentManager" : "string",
  "preferredManager" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "mgmtClientAttribute" : 0,
  "dssPreallocEnabled" : true,
  "dssMaxSegmentSize" : 0,
  "preReadRedundancyCheckEnabled" : true,
  "protectionInformationCapable" : true,
  "protectionType" : "string",
  "applicationTagOwned" : true,
  "repairedBlockCount" : 0,
  "extendedUniqueIdentifier" : "string",
  "cacheMirroringValidateProtectionInformation" : true,
  "expectedProtectionInformationAppTag" : 0,
  "volumeUse" : "string",
  "volumeFull" : true,
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "diskPool" : true,
  "flashCached" : true,
  "increasingBy" : "string",
  "metadata" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "dataAssurance" : true,
  "name" : "string",
  "id" : "string",
  "objectType" : "string",
  "wwn" : "string",
  "mapped" : true,
  "cacheSettings" : {
    "cwob" : true,
    "enterpriseCacheDump" : true,
    "mirrorActive" : true,
    "mirrorEnable" : true,
    "readCacheActive" : true,
    "readCacheEnable" : true,
    "writeCacheActive" : true,
    "writeCacheEnable" : true,
    "cacheFlushModifier" : "string",
    "readAheadMultiplier" : 0
  },
  "preferredControllerId" : "string",
  "totalSizeInBytes" : "string",
  "onlineVolumeCopy" : true,
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "currentControllerId" : "string",
  "thinProvisioned" : true
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.21.30. Retrieve a LunMapping

GET /devmgr/v2/storage-systems/{system-id}/volume-mappings/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

LUNMapping

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-mappings/string
Example HTTP response
Response 200
{
  "lunMappingRef" : "string",
  "lun" : 0,
  "ssid" : 0,
  "perms" : 0,
  "volumeRef" : "string",
  "type" : "string",
  "mapRef" : "string",
  "id" : "string"
}

3.21.31. Remove a LunMapping

DELETE /devmgr/v2/storage-systems/{system-id}/volume-mappings/{id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Removal was successful

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-mappings/string

3.21.32. Retrieve the list of LunMappings

GET /devmgr/v2/storage-systems/{system-id}/volume-mappings
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< LUNMapping > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-mappings
Example HTTP response
Response 200
{
  "lunMappingRef" : "string",
  "lun" : 0,
  "ssid" : 0,
  "perms" : 0,
  "volumeRef" : "string",
  "type" : "string",
  "mapRef" : "string",
  "id" : "string"
} ]

3.21.33. Create a new LunMapping

POST /devmgr/v2/storage-systems/{system-id}/volume-mappings
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

body
optional

VolumeMappingCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

LUNMapping

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-mappings
Request body
{
  "mappableObjectId" : "string",
  "targetId" : "string",
  "lun" : 0
}
Example HTTP response
Response 200
{
  "lunMappingRef" : "string",
  "lun" : 0,
  "ssid" : 0,
  "perms" : 0,
  "volumeRef" : "string",
  "type" : "string",
  "mapRef" : "string",
  "id" : "string"
}

3.21.34. Move a LunMapping to a different host or host group

POST /devmgr/v2/storage-systems/{system-id}/volume-mappings/{mappingId}/move
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

mappingId
required

string

Body

body
optional

VolumeMappingMoveRequest

Responses
HTTP Code Description Schema

200

successful operation

LUNMapping

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-mappings/string/move
Request body
{
  "targetId" : "string",
  "lun" : 0
}
Example HTTP response
Response 200
{
  "lunMappingRef" : "string",
  "lun" : 0,
  "ssid" : 0,
  "perms" : 0,
  "volumeRef" : "string",
  "type" : "string",
  "mapRef" : "string",
  "id" : "string"
}

3.22. Workloads

3.22.1. Get all defined workloads

GET /devmgr/v2/storage-systems/{system-id}/workloads
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Responses
HTTP Code Description Schema

200

successful operation

< WorkloadModel > array

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads
Example HTTP response
Response 200
{
  "id" : "string",
  "name" : "string",
  "workloadAttributes" : [ {
    "key" : "string",
    "value" : "string"
  } ]
} ]

3.22.2. Create a workload

POST /devmgr/v2/storage-systems/{system-id}/workloads
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Body

data
required

WorkloadCreateRequest

Responses
HTTP Code Description Schema

200

successful operation

WorkloadModel

422

Error with input data

CallResponse

Consumes
  • Application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads
Request body
{
  "name" : "string",
  "workloadAttributes" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "id" : "string",
  "name" : "string",
  "workloadAttributes" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.22.3. Get a given defined workload

GET /devmgr/v2/storage-systems/{system-id}/workloads/{workload-id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

workload-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

WorkloadModel

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads/string
Example HTTP response
Response 200
{
  "id" : "string",
  "name" : "string",
  "workloadAttributes" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}

3.22.4. Modify an existing workload

POST /devmgr/v2/storage-systems/{system-id}/workloads/{workload-id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

workload-id
required

string

Body

data
required

WorkloadUpdateRequest

Responses
HTTP Code Description Schema

200

successful operation

WorkloadModel

Consumes
  • Application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads/string
Request body
{
  "workloadAttributes" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "id" : "string",
  "name" : "string",
  "workloadAttributes" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}

3.22.5. Delete a workload

DELETE /devmgr/v2/storage-systems/{system-id}/workloads/{workload-id}
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

workload-id
required

string

Responses
HTTP Code Description Schema

204

Delete was successful

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • Application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads/string

3.22.6. Create a copy of an existing workload

POST /devmgr/v2/storage-systems/{system-id}/workloads/{workload-id}/copy
MetaData

x-mode = both
x-allowedRoles = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

The unique identifier of the storage-system. This may be the id or the WWN.

string

Path

workload-id
required

string

Body

data
required

Name for the new workload

WorkloadCopyRequest

Responses
HTTP Code Description Schema

200

successful operation

WorkloadModel

404

Workload to copy or storage device not found

424

StorageDevice offline

Consumes
  • Application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads/string/copy
Request body
{
  "newWorkloadName" : "string",
  "changeVolumeTags" : true
}
Example HTTP response
Response 200
{
  "id" : "string",
  "name" : "string",
  "workloadAttributes" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}

4. Definitions

4.1. CallResponse

API response object that includes a Return Code that is dependent on the included API Error Code type. It also includes invalid fields if they can be determined.

Name Description Schema

errorMessage
required

Example : "string"

string

localizedMessage
required

Example : "string"

string

retcode
required

The value of retcode can vary by the code type. To be unique, it must be combined with code type. It is a string. Even if the returned value looks like a number, don’t assume its a number. It is a short label that will not change based on Internationalization.
Example : "string"

string

codeType
required

Example : "string"

enum (symbol, systemerror, devicemgrerror)

invalidFieldsIfKnown
required

Example : [ "string" ]

< string > array

4.2. AccessVolumeEx

Name Description Schema

enabled
required

True if the access volume feature (and thus the UTM command transfer capability) is enabled, or false if it is disabled.
Example : true

boolean

volumeHandle
required

An identifier value for the AccessVolume object. This will generally correspond to the logical unit number (LUN) that is used to access the volume for UTM protocol command transactions.
Example : 0

integer (int32)

capacity
required

The (simulated) capacity of the AccessVolume maintained by the controller. Since there is essentially no true data storage capacity present for an AccessVolume, this value is used to determine the block addressing limit of the unit, which is an important aspect of the UTM command transfer protocol.
Example : "string"

string (int64)

accessVolumeRef
required

The identifier value for this AccessVolume. Other objects may use this reference value to refer to the AccessVolume.
Example : "string"

string

reserved1
optional

Example : "string"

string

name
optional

Example : "string"

string

id
optional

Example : "string"

string

objectType
optional

Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

wwn
optional

Example : "string"

string

mapped
required

Example : true

boolean

preferredControllerId
optional

Example : "string"

string

totalSizeInBytes
optional

Example : "string"

string (int64)

listOfMappings
optional

Example : [ "LUNMapping" ]

< LUNMapping > array

currentControllerId
optional

Example : "string"

string

4.3. LUNMapping

Name Description Schema

lunMappingRef
required

The unique identification value for this object. Other objects may use this reference value to refer to the mapping definition.
Example : "string"

string

lun
required

The unique identification value for this object. Other objects may use this reference value to refer to the mapping definition.
Example : 0

integer (int32)

ssid
required

An internal volume identifier value that is not meaningful outside the firmware environment.
Example : 0

integer (int32)

perms
required

The permission values associated with this mapping definition. This field is not currently used, but is provided for future extensions.
Example : 0

integer (int32)

volumeRef
required

The unique identification value of the volume that is accessed via the LUN value associated with this mapping definition.
Example : "string"

string

type
required

The type of the LUN mapping.
Example : "string"

enum (none, hostport, host, cluster, saport, saportgroup, hostsaconnection, all, __UNDEFINED)

mapRef
required

The unique identifier of the entity for which the mapping applies. The type of the entity, and thus of the SYMbol reference, depends on the mapping type. For example, if the LUNMapping object represents a cluster-wide mapping, this field will contain the ClusterRef of the cluster for which the mapping applies. Similarly, if the object represents a host-specific mapping, this field will contain the HostRef of the host for which the mapping applies. Note that if the object represents a default mapping, this field will contain a NULL SYMbolRef.
Example : "string"

string

id
optional

Example : "string"

string

4.4. AlertSyslogResponse

Name Description Schema

response
required

Syslog test response
Example : "string"

enum (syslogSentOK, noSyslogReceiversConfigured, syslogSendFailed)

4.5. AlertSyslogConfiguration

API object that includes data related to syslog configuration.

Name Description Schema

syslogReceivers
required

The list of syslog receivers
Example : [ "AlertSyslogServer" ]

< AlertSyslogServer > array

defaultFacility
required

The syslog default facility
Example : 0

integer (int32)

defaultTag
required

The syslog default tag
Example : "string"

string

4.6. AlertSyslogServer

Configures Syslog server and port

Name Description Schema

serverName
required

Fully qualified name or IP address
Example : "string"

string

portNumber
required

Port number for syslog server
Example : 0

integer (int32)

4.7. AnalysedDiskStatistics

Disk statistics for storage system.

Name Description Schema

observedTime
required

A timestamp representing when the data was collected
Example : "string"

string (date-time)

observedTimeInMS
required

The time in which this data was polled and generated in milliseconds
Example : "string"

string (int64)

readIOps
required

Read operations per second.
Example : 0.0

number (double)

writeIOps
required

Write operations per second.
Example : 0.0

number (double)

otherIOps
required

SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready.
Example : 0.0

number (double)

combinedIOps
required

All operations per second.
Example : 0.0

number (double)

readThroughput
required

Read throughput in MB/s.
Example : 0.0

number (double)

writeThroughput
required

Write throughput in MB/s.
Example : 0.0

number (double)

combinedThroughput
required

Combined read/write throughput in MB/s.
Example : 0.0

number (double)

readResponseTime
required

Read response time average in milliseconds.
Example : 0.0

number (double)

readResponseTimeStdDev
required

The standard deviation of read response times.
Example : 0.0

number (double)

writeResponseTime
required

Write response time average in milliseconds.
Example : 0.0

number (double)

writeResponseTimeStdDev
required

The standard deviation of write response times.
Example : 0.0

number (double)

combinedResponseTime
required

Combined average response time in milliseconds.
Example : 0.0

number (double)

combinedResponseTimeStdDev
required

The standard deviation of combined response times.
Example : 0.0

number (double)

averageReadOpSize
required

Average read operation size in bytes.
Example : 0.0

number (double)

averageWriteOpSize
required

Average write operation size in bytes.
Example : 0.0

number (double)

readOps
required

The amount of read operations in this analysed interval.
Example : 0.0

number (double)

writeOps
required

The amount of write operations in this analysed interval.
Example : 0.0

number (double)

diskId
required

Id for the disk
Example : "string"

string

readPhysicalIOps
required

Physical read operations per second. For disk drives, the physical IOps will beequal to the total IOps.
Example : 0.0

number (double)

writePhysicalIOps
required

Physical write operations per second. For disk drives, the physical IOps will beequal to the total IOps.
Example : 0.0

number (double)

readTimeMax
required

The max time servicing read operations.
Example : 0.0

number (double)

writeTimeMax
required

The max time servicing write operations.
Example : 0.0

number (double)

queueDepthMax
required

Maximum queue depth.
Example : 0.0

number (double)

averageQueueDepth
required

Average queue depth over the observation time.
Example : 0.0

number (double)

randomIosPercent
required

The percentage of IOs that are classified as random.
Example : 0.0

number (double)

randomBytesPercent
required

The percentage of bytes that are classified as random.
Example : 0.0

number (double)

4.8. AnalysedVolumeStatistics

Volume statistics for storage system.

Name Description Schema

observedTime
required

A timestamp representing when the data was collected
Example : "string"

string (date-time)

observedTimeInMS
required

The time in which this data was polled and generated in milliseconds
Example : "string"

string (int64)

readIOps
required

Read operations per second.
Example : 0.0

number (double)

writeIOps
required

Write operations per second.
Example : 0.0

number (double)

otherIOps
required

SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready.
Example : 0.0

number (double)

combinedIOps
required

All operations per second.
Example : 0.0

number (double)

readThroughput
required

Read throughput in MB/s.
Example : 0.0

number (double)

writeThroughput
required

Write throughput in MB/s.
Example : 0.0

number (double)

combinedThroughput
required

Combined read/write throughput in MB/s.
Example : 0.0

number (double)

readResponseTime
required

Read response time average in milliseconds.
Example : 0.0

number (double)

readResponseTimeStdDev
required

The standard deviation of read response times.
Example : 0.0

number (double)

writeResponseTime
required

Write response time average in milliseconds.
Example : 0.0

number (double)

writeResponseTimeStdDev
required

The standard deviation of write response times.
Example : 0.0

number (double)

combinedResponseTime
required

Combined average response time in milliseconds.
Example : 0.0

number (double)

combinedResponseTimeStdDev
required

The standard deviation of combined response times.
Example : 0.0

number (double)

averageReadOpSize
required

Average read operation size in bytes.
Example : 0.0

number (double)

averageWriteOpSize
required

Average write operation size in bytes.
Example : 0.0

number (double)

readOps
required

The amount of read operations in this analysed interval.
Example : 0.0

number (double)

writeOps
required

The amount of write operations in this analysed interval.
Example : 0.0

number (double)

volumeId
required

Example : "string"

string

volumeName
required

Example : "string"

string

poolId
required

Example : "string"

string

controllerId
required

Example : "string"

string

workLoadId
optional

Example : "string"

string

mapped
required

True if the volume was mapped to a host at the point of data collection
Example : true

boolean

readHitOps
required

Number of read operations that hit cache
Example : 0.0

number (double)

readHitResponseTime
required

Average read cache hit response time in milliseconds.
Example : 0.0

number (double)

readHitResponseTimeStdDev
required

The standard deviation of read cache hit response times
Example : 0.0

number (double)

readHitBytes
required

Number of bytes read from cache
Example : 0.0

number (double)

writeHitBytes
required

Number of bytes written to cache
Example : 0.0

number (double)

writeHitOps
required

Number of write operations that hit cache
Example : 0.0

number (double)

writeHitResponseTime
required

Average write cache hit response time in milliseconds.
Example : 0.0

number (double)

writeHitResponseTimeStdDev
required

The standard deviation of write cache hit response times.
Example : 0.0

number (double)

combinedHitResponseTime
required

Combined average cache hit response time in milliseconds.
Example : 0.0

number (double)

combinedHitResponseTimeStdDev
required

The standard deviation of combined cache hit response times.
Example : 0.0

number (double)

readCacheUtilization
required

Percentage of bytes read from cache
Example : 0.0

number (double)

writeCacheUtilization
required

Percentage of bytes written to cache
Example : 0.0

number (double)

flashCacheReadHitOps
required

Number of read operations that hit flash(SSD) cache
Example : 0.0

number (double)

flashCacheReadHitBytes
required

Number of bytes read from flash(SSD) cache
Example : 0.0

number (double)

readPhysicalIOps
required

Physical read operations per second.
Example : 0.0

number (double)

writePhysicalIOps
required

Physical write operations per second.
Example : 0.0

number (double)

queueDepthTotal
required

Total channel queue depth.
Example : 0.0

number (double)

queueDepthMax
required

Maximum channel queue depth.
Example : 0.0

number (double)

readTimeMax
required

The max time servicing read operations.
Example : 0.0

number (double)

writeTimeMax
required

The max time servicing write operations.
Example : 0.0

number (double)

averageQueueDepth
required

Average queue depth over the observation time.
Example : 0.0

number (double)

randomIosPercent
required

The percentage of IOs that are classified as random.
Example : 0.0

number (double)

randomBytesPercent
required

The percentage of bytes that are classified as random.
Example : 0.0

number (double)

cacheWriteWaitOpsPercent
required

The percentage of write operations that are delayed, waiting for cache flush.
Example : 0.0

number (double)

cacheWriteWaitBytesPercent
required

The percentage of write bytes that are delayed, waiting for cache flush.
Example : 0.0

number (double)

prefetchHitPercent
required

The percentage of pre-fetched hits that are ultimately read by the host.
Example : 0.0

number (double)

fullStripeWritesBytesPercent
required

The percentage of bytes that are classified as random. This field is only correctly defined in storage-systems running firmware version greater than or equal to 08.40.+ / 11.40.+
Example : 0.0

number (double)

flashCacheReadThroughput
optional

Example : 0.0

number (double)

flashCacheReadResponseTime
optional

Example : 0.0

number (double)

flashCacheHitPct
optional

Example : 0.0

number (double)

4.9. AnalysedControllerStatistics

Controller statistics for storage system.

Name Description Schema

observedTime
required

A timestamp representing when the data was collected
Example : "string"

string (date-time)

observedTimeInMS
required

The time in which this data was polled and generated in milliseconds
Example : "string"

string (int64)

readIOps
required

Read operations per second.
Example : 0.0

number (double)

writeIOps
required

Write operations per second.
Example : 0.0

number (double)

otherIOps
required

SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready.
Example : 0.0

number (double)

combinedIOps
required

All operations per second.
Example : 0.0

number (double)

readThroughput
required

Read throughput in MB/s.
Example : 0.0

number (double)

writeThroughput
required

Write throughput in MB/s.
Example : 0.0

number (double)

combinedThroughput
required

Combined read/write throughput in MB/s.
Example : 0.0

number (double)

readResponseTime
required

Read response time average in milliseconds.
Example : 0.0

number (double)

readResponseTimeStdDev
required

The standard deviation of read response times.
Example : 0.0

number (double)

writeResponseTime
required

Write response time average in milliseconds.
Example : 0.0

number (double)

writeResponseTimeStdDev
required

The standard deviation of write response times.
Example : 0.0

number (double)

combinedResponseTime
required

Combined average response time in milliseconds.
Example : 0.0

number (double)

combinedResponseTimeStdDev
required

The standard deviation of combined response times.
Example : 0.0

number (double)

averageReadOpSize
required

Average read operation size in bytes.
Example : 0.0

number (double)

averageWriteOpSize
required

Average write operation size in bytes.
Example : 0.0

number (double)

readOps
required

The amount of read operations in this analysed interval.
Example : 0.0

number (double)

writeOps
required

The amount of write operations in this analysed interval.
Example : 0.0

number (double)

readPhysicalIOps
required

Physical read operations per second.
Example : 0.0

number (double)

writePhysicalIOps
required

Physical write operations per second.
Example : 0.0

number (double)

controllerId
required

Example : "string"

string

cacheHitBytesPercent
optional

The percentage of bytes that hit cache.
Example : 0.0

number (double)

randomIosPercent
optional

The percentage of IOs that are classified as random.
Example : 0.0

number (double)

mirrorBytesPercent
optional

The percentage of bytes serviced by the controller that are characterized as cache mirroring related.
Example : 0.0

number (double)

fullStripeWritesBytesPercent
optional

The percentage of bytes serviced by the controller that are characterized as full stripe writes.
Example : 0.0

number (double)

maxCpuUtilization
optional

The max cpu utilization over the observation period.
Example : 0.0

number (double)

maxCpuUtilizationPerCore
optional

The max cpu utilization over the observation period per core.
Example : [ 0.0 ]

< number (double) > array

cpuAvgUtilization
optional

The average CPU utilization.
Example : 0.0

number (double)

cpuAvgUtilizationPerCore
optional

The average percentage of CPU core utilization.
Example : [ 0.0 ]

< number (double) > array

cpuAvgUtilizationPerCoreStdDev
optional

The standard deviation of CPU core utilization.
Example : [ 0.0 ]

< number (double) > array

raid0BytesPercent
optional

The percentage of raid 0 bytes serviced.
Example : 0.0

number (double)

raid1BytesPercent
optional

The percentage of raid 1 bytes serviced.
Example : 0.0

number (double)

raid5BytesPercent
optional

The percentage of raid 5 bytes serviced.
Example : 0.0

number (double)

raid6BytesPercent
optional

The percentage of raid 6 bytes serviced.
Example : 0.0

number (double)

ddpBytesPercent
optional

The percentage of dynamic disk pool(DDP) bytes serviced.
Example : 0.0

number (double)

readHitResponseTime
required

Read cache hit response time average in milliseconds.
Example : 0.0

number (double)

readHitResponseTimeStdDev
required

The standard deviation of read cache hit response times
Example : 0.0

number (double)

writeHitResponseTime
required

Write cache hit response time average in milliseconds.
Example : 0.0

number (double)

writeHitResponseTimeStdDev
required

The standard deviation of write cache hit response times
Example : 0.0

number (double)

combinedHitResponseTime
required

Combined average cache hit response time in milliseconds.
Example : 0.0

number (double)

combinedHitResponseTimeStdDev
required

The standard deviation of combined cache hit response times.
Example : 0.0

number (double)

4.10. AnalyzedInterfaceStatistics

Interface statistics for storage system.

Name Description Schema

observedTime
required

A timestamp representing when the data was collected
Example : "string"

string (date-time)

observedTimeInMS
required

The time in which this data was polled and generated in milliseconds
Example : "string"

string (int64)

readIOps
required

Read operations per second.
Example : 0.0

number (double)

writeIOps
required

Write operations per second.
Example : 0.0

number (double)

otherIOps
required

SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready.
Example : 0.0

number (double)

combinedIOps
required

All operations per second.
Example : 0.0

number (double)

readThroughput
required

Read throughput in MB/s.
Example : 0.0

number (double)

writeThroughput
required

Write throughput in MB/s.
Example : 0.0

number (double)

combinedThroughput
required

Combined read/write throughput in MB/s.
Example : 0.0

number (double)

readResponseTime
required

Read response time average in milliseconds.
Example : 0.0

number (double)

readResponseTimeStdDev
required

The standard deviation of read response times.
Example : 0.0

number (double)

writeResponseTime
required

Write response time average in milliseconds.
Example : 0.0

number (double)

writeResponseTimeStdDev
required

The standard deviation of write response times.
Example : 0.0

number (double)

combinedResponseTime
required

Combined average response time in milliseconds.
Example : 0.0

number (double)

combinedResponseTimeStdDev
required

The standard deviation of combined response times.
Example : 0.0

number (double)

averageReadOpSize
required

Average read operation size in bytes.
Example : 0.0

number (double)

averageWriteOpSize
required

Average write operation size in bytes.
Example : 0.0

number (double)

readOps
required

The amount of read operations in this analysed interval.
Example : 0.0

number (double)

writeOps
required

The amount of write operations in this analysed interval.
Example : 0.0

number (double)

interfaceId
required

Example : "string"

string

channelType
required

The channel type for the interface.
Example : "string"

enum (hostside, driveside, management, __UNDEFINED)

queueDepthTotal
required

Total channel queue depth.
Example : 0.0

number (double)

queueDepthMax
required

Maximum channel queue depth.
Example : 0.0

number (double)

channelNumber
required

Number of channels.
Example : 0

integer (int32)

channelErrorCounts
required

Maximum channel queue depth.
Example : 0.0

number (double)

4.11. RemoteCandidate

A storage-device candidate for use with ARVM.

Name Description Schema

wwn
required

Example : "string"

string

id
required

Example : "string"

string

name
required

Example : "string"

string

type
required

Example : "string"

enum (fibre, iscsi, fibreAndIscsi, none)

fcMirroringState
required

Example : "string"

enum (unknown, disabled, enabledLegacyRvm, enabledArvm, enabledAll, __UNDEFINED)

4.12. AsupResponse

API response object that includes basic information about asup.

Name Description Schema

enabled
required

AutoSupport is enabled or disabled
Example : true

boolean

scheduleType
required

The schedule frequency = ['0' is a daily schedule, '1' is a weekly schedule, '2' is a monthly schedule]
Example : 0

integer (int32)

weekdays
required

Days of the week
Example : [ 0 ]

< integer (int32) > array

months
required

Months
Example : [ 0 ]

< integer (int32) > array

scheduledDays
required

Days of the month
Example : [ 0 ]

< integer (int32) > array

deliveryType
required

The Delivery method = ['0' is unknown, '1' is https (default), '2' is http, '3' is smtp]
Example : 0

integer (int32)

destinationHttpAddr
required

Destination HTTP address
Example : "string"

string

destinationSmtpAddr
required

Destination SMTP address
Example : "string"

string

httpDeliveryType
required

Http delivery method = ['0' is a unknown, '1' is direct (default), '2' is proxy server, '3' is proxy configuration script]
Example : 0

integer (int32)

proxyHostAddr
optional

Proxy server address
Example : "string"

string

proxyHostPort
optional

Proxy server port
Example : "string"

string

authRequired
optional

Authentication required
Example : true

boolean

authUserName
optional

Authentication username
Example : "string"

string

authPassword
optional

Authentication password
Example : "string"

string

proxyScript
optional

Proxy configuration script
Example : "string"

string

mailServer
optional

SMTP mail server
Example : "string"

string

mailSenderAddr
optional

Sender email address
Example : "string"

string

mailReplyAddr
optional

Reply email address
Example : "string"

string

log
optional

Log entries
Example : "string"

string

sequence
optional

Bundle sequence number
Example : "string"

string (int64)

default
optional

Example : true

boolean

4.13. AsupUpdateRequest

Used to update asup settings.

Name Description Schema

enable
required

Enable or disable AutoSupport
Example : true

boolean

scheduleTypeReq
required

The schedule type = ['0' is a daily schedule, '1' is a weekly schedule, '2' is a monthly schedule]
Example : 0

integer (int32)

weekDaysReq
optional

Days of the week
Example : [ 0 ]

< integer (int32) > array

monthsReq
optional

Months
Example : [ 0 ]

< integer (int32) > array

scheduledDaysReq
optional

Days of the month
Example : [ 0 ]

< integer (int32) > array

deliveryType
required

The Delivery method = ['0' is unknown, '1' is https (default), '2' is http, '3' is smtp]
Example : 0

integer (int32)

httpDeliveryType
optional

Http delivery method = ['0' is a unknown, '1' is direct (default), '2' is proxy server, '3' is proxy configuration script]
Example : 0

integer (int32)

proxyHostAddr
optional

Proxy server address
Example : "string"

string

proxyHostPort
optional

Proxy server port
Example : "string"

string

authRequired
optional

Authentication required
Example : true

boolean

authUserName
optional

Authentication username
Example : "string"

string

authPassword
optional

Authentication password
Example : "string"

string

proxyScript
optional

Proxy configuration script
Example : "string"

string

mailServer
optional

SMTP mail server
Example : "string"

string

mailSenderAddr
optional

Sender email address
Example : "string"

string

mailReplyAddr
optional

Reply email address
Example : "string"

string

4.14. AsupDispatchRequest

Used to dispatch the asup bundle.

Name Description Schema

id
required

Id of the registered bundle to be dispatched
Example : "string"

string

dispatchType
optional

The type of dispatch to be executed = ['0' is daily, '1' is weekly, '2' is monthly, '3' is manual (default), '4' is test]
Example : 0

integer (int32)

4.15. AsupEntry

Name Description Schema

fileName
required

File name of the entry
Example : "string"

string

filePath
optional

File path of the entry
Example : "string"

string

priority
required

Priority of the entry
Example : 0

integer (int32)

contentType
required

Content type of the entry
Example : "string"

string

description
required

Description of the entry
Example : "string"

string

schedule
required

Scheduled dispatch of the entry
Example : [ 0 ]

< integer (int32) > array

4.16. AsupRegistrationRequest

Name Description Schema

entries
required

The bundle entries
Example : [ "AsupEntry" ]

< AsupEntry > array

id
optional

Id of bundle to be registered
Example : "string"

string

modelName
required

Model name of bundle to be registered
Example : "string"

string

subjectName
required

Subject name of bundle to be registered
Example : "string"

string

4.17. AsyncCommunicationData

Name Description Schema

timeout
required

Example : 0

integer (int32)

returnStatus
required

Example : "string"

enum (uninitialized, ok, error, busy, illegalParam, noHeap, driveNotExist, driveNotUnassigned, noSparesAssigned, someSparesAssigned, volumeNotExist, volumeReconfiguring, notDualActive, tryAlternate, background, notImplemented, reservationConflict, volumeDead, internalError, invalidRequest, iconFailure, volumeFormatting, altRemoved, cacheSyncFailure, invalidFile, reconfigSmallDacstore, reconfigFailure, nvramError, flashError, authFailParam, authFailPassword, memParityError, invalidControllerref, invalidVolumegroupref, invalidVolumeref, invalidDriveref, invalidFreeextentref, volumeOffline, volumeNotOptimal, modesenseError, invalidSegmentsize, invalidCacheblksize, invalidFlushThreshold, invalidFlushAmount, invalidLabel, invalidCacheModifier, invalidReadahead, invalidReconpriority, invalidScanperiod, invalidTrayposLength, invalidRegionid, invalidFibreid, invalidEncryption, invalidRaidlevel, invalidExpansionList, noSparesDeassigned, someSparesDeassigned, partDupId, partLabelInvalid, partNodeNonexistent, partPortIdInvalid, partVolumeNonexistent, partLunCollision, maxVolMappingExceeded, partMappingNonexistent, partNoHostports, imageTransferred, fileTooLarge, invalidOffset, overrun, invalidChunksize, invalidTotalsize, downloadNotPermitted, spawnError, voltransferError, invalidDlstate, cacheconfigError, downloadInProgress, driveNotOptimal, driveRemoved, duplicateDrives, numdrivesAdditional, numdrivesGroup, driveTooSmall, capacityConstrained, maxVolumesExceeded, partIsUtmLun, someSparesTooSmall, sparesSmallUnassigned, tooManyPartitions, parityScanInProgress, invalidSafeId, invalidSafeKey, invalidSafeCapability, invalidSafeVersion, partitionsDisabled, driveDownloadFailed, esmDownloadFailed, esmPartialUpdate, utmConflict, noVolumes, authFailReadpassword, partCrteFailTblFull, attemptToSetLocal, invalidHostTypeIndex, failVolumeVisible, noDeleteUtmInUse, invalidLun, utmTooManyMaps, diagReadFailure, diagSrcLinkDown, diagWriteFailure, diagLoopbackError, diagTimeout, diagInProgress, diagNoAlt, diagIconSendErr, diagInitErr, diagModeErr, diagInvalidTestId, diagDriveErr, diagLockErr, diagConfigErr, diagNoCacheMem, diagNotQuiesced, diagUtmNotEnabled, invalidModeSwitch, invalidPortname, duplicateVolMapping, maxSnapsPerBaseExceeded, maxSnapsExceeded, invalidBasevol, snapNotAvailable, notDisabled, snapshotFeatureDisabled, repositoryOffline, repositoryReconfiguring, rollbackInProgress, numVolumesGroup, ghostVolume, repositoryMissing, invalidRepositoryLabel, invalidSnapLabel, invalidRollbackPriority, invalidWarnThreshold, cannotMapVolume, cannotFormatVolume, dstNotFibre, repositoryTooSmall, repositoryFailed, baseVolumeFailed, baseVolumeOffline, baseVolumeFormatting, metadataVolNonexistent, rvmFeatureDisabled, mirrorsPresent, rvmFeatureDeactivated, maxMirrorsExceeded, invalidMirrorCandidateVol, invalidMirrorvol, metadataAlreadyExists, metadataMissing, metadataOffline, metadataReconfiguring, localRoleChangeFailed, remoteRoleChangeFailed, localRoleChangeSuccessful, onlyLocalMirrorDeleted, noValidMirrorCandidate, remoteMaxMirrorsExceeded, remoteRvmFeatureDisabled, remoteMetadataVolNonexistent, notRegistered, remoteInvalidCfgGen, localRoleChangedNotForced, remoteRoleChangedLocalFailed, rvmSpmError, remoteAuthFailPassword, rvmVersionMismatch, rvmRemoteArrayError, rvmCommunicationError, rvmFibreError, mirrorVolNotPrimary, secNotPromoteable, priNotDemoteable, metadataChildDeletion, rmtvolOrphanDeletion, rvmActivateDisallowed, invalidTrayref, partialDeletion, defaultUtmCollision, invalidCopyPriority, invalidVolumecopyref, copyChangeFailed, copyActive, copyInactive, copyIncompatibleSource, copyIncompatibleTarget, copyGhostSource, copyGhostTarget, copyInvalidSourceRef, copyInvalidTargetRef, copyInvalidSourceState, copyInvalidTargetState, copySourceReconfig, copyTargetReconfig, copyTargetTooSmall, copyTargetLimit, maxVolumeCopysExceeded, copySourceReservation, copyTargetReservation, copySourceFormat, copyTargetFormat, copyStartFailed, copyStopFailed, volcopyFeatureDisabled, writeLock, cannotReconfigure, authFailContLockout, prReservationConflict, regDeleteFailed, batteryNotInConfig, batteryMissing, noChannel, rvmOperNotAllowedOnSec, dataRedundancyRequired, copySourceZeroCapacity, invHostlunDefineMapping, invHostlunMoveMapping, invHostlunDefineHosttype, invHostlunMoveHostport, fwIncompatible, mirrorAlreadySuspended, insuffLocalMirRepResources, insuffRemtMirRepResources, ghostHasUnreadableSectors, rvmCommStatRecoveredTimeout, rvmCommStatRecoveredDelay, rvmCommStatNotReady, rvmCommStatTimeout, rvmCommStatChannelFailure, rvmCommStatNetworkFailure, rvmCommStatDeviceMissing, rvmCommStatLoginRejected, rvmCommStatLoginFailure, rvmCommStatInvNumSamplesReqd, rvmQuiescenceInProgress, rvmInvalidRemotevol, sodInProgress, invalidDrives, invalidSetid, invalidSetsize, missingData, quiescenceFailed, validationError, downloadHalted, allFailed, partialOk, obsolete, usmClearFailed, controllerInServiceMode, invalidDrive, databaseError, backgroundAutocfg, autocfgInprogress, unsupportedLhaSataEsm, parityScanFailed, parityRepairFailed, mediaRepairFailed, mirrorDegraded, prohibitedByMdtRestrictions, prohibitedByGoldKeyRestrictions, safeControllerNotSubjectToGoldKey, safeMdtNotPremiumFeature, alarmNotPresent, dltNotCompleted, dependancyError, cdmDatabaseFull, requiredConditionNotPresent, ddcUnavail, ddcIllegalParam, invalidDdcTag, hosttypeConflict, portConflict, invalidHosttypeString, invalidProtocol, portRemoved, disableNotPermitted, prohibitedByDriveTrayLimit, invalidEsmref, invalidBundleMigration, invalidBundleKey, noSparesNeeded, prohibitedByFeatureBundleViolation, invalidAuthMethod, invalidSecret, secretAlreadyInUse, manualConfigModeSet, noIscsiSessions, invalidInterfaceref, initiatorConflict, initiatorRemoved, basevolSizeChanged, volumeGroupNotExist, volumeGroupNotOnline, volumeGroupHasHotspare, volumeGroupReconfiguring, volumeGroupStateNotValid, controllerNotOptimal, insufficientCapacity, volumeGroupExported, volumeNotConfigurable, volumeGroupNotConfigurable, invalidDriveState, volumeGroupReconstructing, volumeGroupUndergoingCopyback, volumeGroupNotComplete, volumeGroupHasFailedDrives, volumeGroupHasNonOptimalVols, volumeGroupHasMirrorRelationship, volumeGroupHasVolcopyRelationship, volumeGroupHasMirroringMetadata, volumeGroupHasMappedVols, volumeGroupHasReservations, volumeGroupHasIncompatibleDacstores, volumeLimitExceeded, volumeGroupHasUnknownRaidLevel, volumeGroupHasUnsupportedRaidLevel, volumeGroupHasCloneOpportunity, volumeGroupHasInsufficientDrives, volumeGroupHasFailedVols, perfTierSafeUpgradeDisabled, raid6FeatureUnsupported, raid6FeatureDisabled, safeControllerNotSubjectToRaid6, volumeGroupNotContingent, channelDiagsRunning, channelDiagsResultsPartial, volumeGroupHasSnapshotRelationship, prohibitedBySafeViolation, legacyVg, vgNotForceable, channelDiagsLockErr, channelDiagsNotQuiesced, channelDiagsAltCommFailed, channelDiagsChanSetupFailed, channelDiagsDeviceBypassFailed, channelDiagsResultsNotAvailable, driveSpinUpError, driveTypeMismatch, localRemoteArrayHasSameWwn, volumeGroupHasIncompatibleDrive, volumeGroupVolumeEncroachesOnDacstore, volumeGroupImportInProgress, drivesNeedToBeSpunUp, noNativeSstor, noSuchDebugChunk, debugInfoConfigChanged, lockdown, drivesDacstoresOverlap, volumeHasAsyncMirror, reconfigLogSpaceError, volumeGroupInaccessible, volumeInitializing, insufficientCache, volumeInaccessible, noDrivesAdopted, someDrivesAdopted, exportingDrivesDatabaseResynchronizing, exportingDrivesDatabaseFailed, exportingDrivesQuiesced, learnActiveTryLater, noLockedDrives, driveSecurityEnabledFailed, lockkeyFailed, invalidSecurity, noFdeDrives, volumeGroupSecure, invalidBlob, unlockFailed, noKeySet, rekeyInProgress, defaultHostGroupMappingNotAllowed, ssdMediaScanNotAllowed, premiumFeatureLimitExceedsMaximum, disableEvaluationFeatureNotPermitted, requestFailedDueToLun0Restrictions, externalKmsEnabled, externalKmsFailed, externalKmsNotEnabled, keyNotNeeded, keyInvalidSequence, diagNotRunning, ctrlNotInServiceMode, invalidFeatureref, cacheBackupDevNotExist, noMatchingLockKeyIdFound, lockKeyValidationFailed, lockKeyValidationDisabled, externalKmsNotCompliant, externalKmsTimeout, cannotDisableNoKey, previouslyEnabledForEval, featureNotKeyable, evalNotSupported, rawdataTransferBadType, rawdataTransferNotStarted, rawdataTransferAlreadyStarted, rawdataTransferPreparing, rawdataTransferReadError, rawdataTransferNoDrives, rawdataTransferInvalidImage, rawdataTransferCrcError, dbmRestoreWriteError, dbmRestoreNoDrives, rawdataBadSeqNum, invalidCapability, externalKeyNotInMemory, invalidLockKeyId, invalidProtection, volumeHasSnapshotRelationship, volumeHasMirrorRelationship, externalKmsDisabledNoKey, dbmRestoreAltCtlNotOffline, copyApptagMismatch, invalidRequestForEnclosure, dqRetrieveNothingToTransfer, invalidIscsiConfiguration, volumeHasVolcopyRelationship, partPiIncapable, requestFailedDueToPiRestrictions, rawdataTransferUserCancelled, duplicateIscsiIpAddress, portSpeedConflict, factoryDefaultDownloadFailed, errorWritingToEeprom, factoryDefaultPartialUpdate, snapshotNotActive, cannotRollback, mirrorSyncNotPossible, psuFirmwareDownloadFailed, psuFirmwareUpdateMfgDeviceCodeMismatch, psuFirmwareUpdateNotAllRedundant, psuFirmwareUpdateNotAllOptimal, insufficientRepositoryCapacity, rollbackStartFailure, csbReserveFailed, csbReleaseFailedNoLock, csbReleaseFailedInvalidKey, flashcacheAlreadyExists, flashcacheFeatureDisabled, flashcacheAlreadySuspended, flashcacheNotSuspended, flashcacheInvalidConfigType, invalidPitGroupLabel, invalidPitConsistencyGroupLabel, invalidPitAutoDeleteLimit, invalidPitRepositoryFullPolicy, invalidConcatVolMemberLabel, concatVolMemberTooSmall, invalidPitGroupRef, invalidPitRef, dveNotAllowed, dssNotAllowed, dplCoreDumpInvalidTag, invalidPitViewLabel, invalidPitViewRef, invalidConcatVolRef, notFlashcacheVol, flashcacheDeleted, flashcacheEnabled, flashcacheNotEnabled, noRepDeletion, maxPitsPerGroupExceeded, maxPitsExceeded, maxPitGroupsPerBaseExceeded, maxPitGroupsExceeded, maxViewsPerPitExceeded, maxViewsExceeded, maxConsistencyGroupsExceeded, maxConsistencyGroupMembersExceeded, maxMappableVolumesExceeded, notOldestPit, viewStopped, concatMemberLimitExceeded, invalidMemberVol, memberVolMapped, invalidMemberVolState, invalidTrimCount, pitGroupInConsistencyGroup, pitInConsistencyGroup, pitViewInConsistencyGroup, incompatibleMemberVol, volumeInUse, rvmOverIscsiNotSupported, arvmGroupUserLabelExists, arvmGroupDoesNotExist, arvmGroupNotEmpty, concatVolumeFailed, invalidPitConsistencyGroupRef, invalidPitConsistencyGroupViewRef, invalidPitConsistencyGroupViewLabel, alternateRequiredForOperation, invalidPitForView, consistencyGroupArvmBindingConflict, attributeFixedByArvm, operationFailedVolumeCopyClone, pitCreatePending, dbmDbSourceUnavailable, dbmRestoreSourceMismatch, invalidCriticalThreshold, volumeGroupHasArvmRelationship, arvmRecoveryPointDeletionRequired, volumeGroupHasPitgroupRelationship, volumeGroupHasPitviewRelationship, volumeGroupHasConcatRelationship, flashcacheSuspended, flashcacheAlreadyEnabled, dbmDbImageCorrupt, illegalVolume, invalidRepositoryCapacity, invalidProvisionedCapacityQuota, invalidExpansionPolicy, invalidVirtualCapacity, cannotExpandConcatMember, thresholdBelowUsedCapacity, invalidExpansionOperation, repositoryFull, insufficientExpansionSpace, invalidExpansionSize, invalidReinitAction, invalidReinitCapacity, invalidIncompleteMemberRef, arvmGroupNotPrimary, arvmGroupNotSecondary, arvmMemberFailed, arvmGroupNotSuspended, arvmInvalidMirrorState, arvmVolumeAlreadyInMirrorRelationship, arvmMemberLimitExceeded, arvmSuspendFailure, arvmResumeFailure, arvmSynchronizeFailure, remoteTargetNotFound, arvmMirrorMemberDoesNotExist, snapConversionTooManySnaps, snapConversionMissingLabel, arvmFeatureDeactivated, incompatibleRepositorySecurity, incompatibleSecondarySecurity, mirrorProtocolMismatch, arvmAsyncMirrorGroupPresent, cacheParametersNotChangeable, flashcacheMaxCapacityExceeded, flashcacheFailed, dplCoreDumpRestoreInProgress, arvmGroupHasIncompleteMember, arvmConnectivityTestAlreadyInProgress, arvmConnectivityTestNetworkError, arvmConnectivityTestRemoteTimeout, arvmConnectivityTestLoginFailure, arvmConnectivityTestNameServiceError, arvmConnectivityTestTurError, arvmConnectivityTestMissingRemoteAmg, arvmConnectivityTestAmgMemberMismatch, invalidSyncPriority, invalidRecoveryPointAlertThreshold, invalidSyncAlertThreshold, mustSpecifyExistingVolumes, arvmConnectivityTestTimeoutExceeded, flashcacheMaxLimitExceeded, volsInVgUsingNonSecureCapableFlashcache, volsInVgUsingSecureDisabledFlashcache, invalidSubmodelId, premiumFeatureLimitMismatch, volumeGroupNotImportable, primaryCacheSizeMismatch, flashcacheUserLabelExists, maxThinVolumesExceeded, arvmInvalidSecondaryCapacity, arvmOnlyPrimaryMemberRemoved, arvmOnlySecondaryMemberRemoved, arvmInvalidAmgRequestWhileSuspended, arvmManualSyncAlreadyInProgress, arvmManualSyncRetryTooSoon, diskPoolNotEmpty, flashCacheInvalidBaseVol, flashCacheFdeEnablementDisallowed, remoteArvmFeatureDeactivated, remoteArvmFeatureDisabled, arvmOrphanGroup, arvmOrphanMember, volumeNotAvailable, volumeHasUnreadableSectors, thinProvisioningFeatureDisabled, pitGroupsFeatureDisabled, exceedDiskPoolLimit, flashcacheDegradedState, flashcacheNonDaCapableDriveDisallowed, arvmMaxAsyncMirrorGroupsExceeded, arvmMaxMirrorsPerArrayExceeded, maxTotalMirrorsPerArrayExceeded, exceedDiskPoolCapacity, exceedMaxVolumeCapacity, arvmRemoteMaxAsyncMirrorGroupsExceeded, arvmRemoteMaxMirrorsPerArrayExceeded, remoteMaxTotalMirrorsPerArrayExceeded, arvmInvalidSyncInterval, remoteNoHeap, remoteInternalError, remoteRvmSpmError, arvmRemoteMirrorMemberDoesNotExist, arvmRemoteGroupUserLabelExists, arvmRemoteGroupNotSecondary, arvmRemoteGroupDoesNotExist, remoteInvalidProtection, remoteDatabaseError, arvmRemoteGroupNotEmpty, arvmRemoteSuspendFailure, arvmRemoteResumeFailure, arvmRemoteSynchronizeFailure, flashcacheInvalidAnalyticsState, arvmExpansionSynchronizationInProgress, arvmRemoteExpansionSynchronizationInProgress, faultConditionStillExists, remoteTryAlternate, arvmOnlyLocalAmgDeleted, arvmRoleChangePending, arvmRoleChangeInProgress, arvmMemberStopped, reconstructionInProgress, copybackInProgress, adminPasswordNotSet, keyDoesNotExist, takeRecoveryActionsFirst, coredumpBackupInProgress, legacyRvmAsyncModeUnsupported, arvmIncorrectVolumeType, thinVolumeParametersCannotBeModified, arvmRemoteThinNotSupported, snmpInvalidCommunityName, snmpInvalidCommunityPermission, snmpInvalidCommunityRef, snmpInvalidTrapDestinationRef, invalidIpAddress, snmpMaxCommunitiesExceeded, snmpMaxTrapDestinationsExceeded, snmpCommunityNameInUse, snmpTrapDestinationAddressInUse, snmpUnknownSystemVariable, snmpInvalidSystemVariableValue, snmpIncompatibleFirmware, snmpAgentDisabled, snmpAgentInitFailed, arvmThinVolInitError, arvmRemoteThinVolInitError, snmpIncompatibleIpv4Address, snmpIncompatibleIpv6Address, drivesNotAvailableForRemoval, snmpCannotDisableIpv4, snmpCannotDisableIpv6, snmpIpv4ConfigError, iocDumpInProgress, iocRestoreInProgress, iocDumpInvalidTag, unsupportedEsmRequest, isnsDhcpNotSupported, dpcVolumeGroupNotRedundant, dpcVolumeNotInitialized, dpcExclusiveOperationActive, dpcUnableToPowerUpDrive, dpcFormatActive, dpcUnreadableSectorsPresent, dpcPowerCycleAlreadyInProgress, dpcEnclosureHardwareUnsupported, dpcEnclosureFwDownlevel, evacInProgress, noEvacFound, noHotspareAvailable, driveServiceInProgress, hdd4kbSegmentsizeNotAllowed, diskPoolNoSpareDrives, diskPoolExceedSpareCapacity, autoLoadBalanceUserDisabled, autoLoadBalanceInsufficientStatistics, invalidLoadBalanceAction, invalidLoadBalanceDelay, reservedAddress, volumeCreationInProgress, keyValueTagInvalidRef, keyValueTagInvalidDuplicate, keyValueTagInUse, workloadInvalidRef, invalidKeyValueTagObjectReference, mappingInvalidDuplicate, downloadCompleteNoReboot, downloadCompleteMswOnlyReboot, workloadInvalidDuplicate, mappingInvalidRef, workloadInUse, embeddedExternalKeyManagementEnabled, embeddedExternalKeyManagementCertificatesNotInstalled, illegalOperationOnAllConfigDrives, databaseResyncInProgress, embeddedEkmsKeyserverInfoMissing, embeddedEkmsClientKeyMissing, embeddedEkmsClientCertMissing, embeddedEkmsClientCertMismatch, embeddedEkmsCertExpired, embeddedEkmsProxyNotResponding, embeddedEkmsAuthenticationFailure, embeddedEkmsKeyOwnerRequired, embeddedEkmsServerError, embeddedEkmsServerCertMissing, embeddedEkmsCertDuplicate, embeddedEkmsCertInvalid, embeddedEkmsConnectionFailure, invalidPasswordLength, certRevoked, missingSignature, sigValidationFailed, unableToConnectToOcspResponder, requestFailedDueToAlbEnabled, __UNDEFINED)

successful
required

Example : true

boolean

controllerRef
required

Example : "string"

string

amgRef
required

Example : "string"

string

testType
required

Example : "string"

enum (connectivityTestUnknown, basicConnectivityTest, linkLatencyTest, linkBandwidthTest, __UNDEFINED)

bwTestResult
required

Example : "AsyncMirrorGroupLinkBandwidthTestResults"

AsyncMirrorGroupLinkBandwidthTestResults

latTestResult
required

Example : "AsyncMirrorGroupLinkLatencyTestResults"

AsyncMirrorGroupLinkLatencyTestResults

4.18. AsyncMirrorGroupLinkBandwidthTestResults

Name Description Schema

latencyMeasures
required

The bandwidth test also returns latency values since latency numbers are measured in order to factor them out of the bandwidth calculations.
Example : "AsyncMirrorGroupLinkLatencyTestResults"

AsyncMirrorGroupLinkLatencyTestResults

minBandwidthBitsPerSecond
required

The minimum bandwidth measured in bits per second.
Example : "string"

string (int64)

maxBandwidthBitsPerSecond
required

The maximum bandwidth measured in bits per second.
Example : "string"

string (int64)

avgBandwidthBitsPerSecond
required

The average bandwidth measured in bits per second.
Example : "string"

string (int64)

negotiatedLinkSpeedBitsPerSecond
required

The negotiated link speed measured in bits per second.
Example : "string"

string (int64)

4.19. AsyncMirrorGroupLinkLatencyTestResults

Name Description Schema

minLatencyInMicroseconds
required

The minimum latency measured in microseconds.
Example : 0

integer (int32)

maxLatencyInMicroseconds
required

The maximum latency measured in microseconds.
Example : 0

integer (int32)

avgLatencyInMicroseconds
required

The average latency measured in microseconds.
Example : 0

integer (int32)

4.20. AsyncMirrorGroupConnectivityTestRequest

Request that a connectivity test be performed between the local and remote Amg’s.

Name Description Schema

requestedTestType
optional

Type of test to perform.
Default : "basicConnectivityTest"
Example : "string"

enum (connectivityTestUnknown, basicConnectivityTest, linkLatencyTest, linkBandwidthTest, __UNDEFINED)

testIterations
optional

Number of test iterations to run.
Example : 0

integer (int32)

timeout
optional

Timeout in seconds. For no timeout, this value should be set to -1.
Example : 0

integer (int32)

4.21. AsyncMirrorGroupSyncRequest

Creates an async mirror group (issued to the array with the primary role).

Name Description Schema

deleteRecoveryPointIfNecessary
optional

Indicates whether the failures point can be deleted on the secondary if necessary to achieve the synchronization. If true, and if the amount of unsynchronized data exceeds the CoW repository capacity on the secondary for any member volume, the last failures point will be deleted and synchronization will continue. If false, the synchronization will be suspended if the amount of unsynchronized data exceeds the CoW Repository capacity on the secondary and the failures point will be preserved.
Default : false
Example : true

boolean

4.22. AsyncMirrorGroupMemberSyncProgress

Name Description Schema

percentComplete
required

The completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.
Example : 0

integer (int32)

timeToCompletion
required

The estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.
Example : 0

integer (int32)

syncBytes
required

The amount of data that remains to be synchronized in the current synchronization step.
Example : "string"

string (int64)

mirrorRef
required

A reference to the async mirror member.
Example : "string"

string

trackingBytes
required

Amount of data (in bytes) marked as unsynchronized in the tracking delta log for this member.
Example : "string"

string (int64)

4.23. AsyncMirrorGroupSyncProgress

Name Description Schema

groupPercentComplete
required

Completion percentage for the operation across the entire group. If synchronization is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.
Example : 0

integer (int32)

groupTimeToCompletion
required

Estimated time to completion in minutes for all members in the group that are undergoing synchronization. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.
Example : 0

integer (int32)

groupSyncBytes
required

Amount of data that needs to be synchronized for the entire group.
Example : "string"

string (int64)

groupRef
required

Reference to the async mirror group.
Example : "string"

string

memberProgress
required

List of progress information for each mirror group member.
Example : [ "AsyncMirrorGroupMemberSyncProgress" ]

< AsyncMirrorGroupMemberSyncProgress > array

groupTrackingBytes
required

The amount of data (in bytes) marked as unsynchronized in the tracking delta logs for the entire group.
Example : "string"

string (int64)

4.24. Amg

Asynchronous Mirror Group

Name Description Schema

groupRef
required

The reference (key) for the mirror group.
Example : "string"

string

worldWideName
required

The world wide name of the mirror group. This can be used to identify the AMG pair on both arrays. The AsyncMirrorGroupRef is not guaranteed to be unique across multiple arrays.
Example : "string"

string

label
required

The user assigned name for the mirror group.
Example : "string"

string

groupState
required

The Mirror Group State. This is determined primarily by the presence or lack of a recovery point.
Example : "string"

enum (unknown, initialSync, optimal, degraded, rpFailed, __UNDEFINED)

localRole
required

The current role of this (local) array with respect to this mirror group.
Example : "string"

enum (unknown, primary, secondary, __UNDEFINED)

remoteRole
required

The current role of the peer (remote) array with respect to this mirror group.
Example : "string"

enum (unknown, primary, secondary, __UNDEFINED)

roleChangeProgress
required

This field indicates the current state of the role change process. This may be an extended condition due to the data sync needed for an orderly role change or the recovery point rollback needed for a no-sync or forced role change.
Example : "string"

enum (unknown, none, pending, inProgress, __UNDEFINED)

syncIntervalMinutes
required

The time in minutes between starting points of periodic synchronization intervals. A value of ARVM_MANUAL_SYNC_INTERVAL indicates synchronization intervals are manually started by the user.
Example : 0

integer (int32)

syncCompletionTimeAlertThresholdMinutes
required

The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete. A value of ARVM_SYNC_COMPLETION_TIME_THRESHOLD_NONE indicates no threshold is set.
Example : 0

integer (int32)

recoveryPointAgeAlertThresholdMinutes
required

The recovery point age objective (in minutes). The user is notified via needs-attention when the age of the last good recovery point exceeds this value. A value of ARVM_RECOVERY_POINT_AGE_THRESHOLD_NONE indicates no threshold is set.
Example : 0

integer (int32)

repositoryUtilizationWarnThreshold
required

The repository utilization warning threshold (0-100 percent). A needs attention condition will be generated if the percent of the repository capacity currently utilized exceeds this threshold.
Example : 0

integer (int32)

mirrorChannelRemoteTarget
required

The path to the remote array to be used by this AMG (a reference to the associated RemoteTarget).
Example : "string"

string

syncActivity
required

Current synchronization activity.
Example : "string"

enum (unknown, idle, active, paused, userSuspended, internallySuspended, __UNDEFINED)

orphanGroup
required

If true, the mirror group is an orphan.
Example : true

boolean

connectionType
optional

The connection type used to create this mirror group.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

remoteTargetWwn
optional

The WWN of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created.
Example : "string"

string

remoteTargetName
optional

The user label of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode.
Example : "string"

string

remoteTargetId
optional

The id of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode.
Example : "string"

string

remoteTarget
optional

The connection information for the remote StorageSystem.
Example : "RemoteTarget"

RemoteTarget

id
optional

Example : "string"

string

4.25. IpVxAddress

Name Description Schema

addressType
required

This enumeration defines the different types of IP addresses, corresponding to different versions of the Internet protocol.
Example : "string"

enum (ipv4, ipv6, __UNDEFINED)

ipv4Address
optional

An IP address formatted according to version 4 of the Internet protocol. This field is only present if addressType is equal to IPV4.
Example : "string"

string

ipv6Address
optional

An IP address formatted according to version 6 of the Internet protocol. This field is only present if addressType is equal to IPV6.
Example : "string"

string

4.26. IscsiInitiatorTargetBaseParameters

Name Description Schema

portals
required

The IP addresses, portal group numbers, and port number for the initiator or target.
Example : [ "TargetPortal" ]

< TargetPortal > array

4.27. RemoteTarget

Name Description Schema

remoteRef
required

Unique identifier for this initiator/target object.
Example : "string"

string

nodeName
required

Node name associated with the local initiator.
Example : "ScsiNodeName"

ScsiNodeName

scsiinitiatorTargetBaseProperties
optional

Example : "ScsiInitiatorTargetBaseProperties"

ScsiInitiatorTargetBaseProperties

4.28. ScsiInitiatorTargetBaseProperties

Name Description Schema

ioInterfaceType
required

This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

iscsiinitiatorTargetBaseParameters
optional

Example : "IscsiInitiatorTargetBaseParameters"

IscsiInitiatorTargetBaseParameters

4.29. ScsiNodeName

Name Description Schema

ioInterfaceType
required

This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

iscsiNodeName
optional

The SCSI node name as defined under iSCSI. This field is only valid if the I/O interface type is equal to IO_IF_ISCSI.
Example : "string"

string

remoteNodeWWN
optional

The FC WWN for the remote node. This field is only valid if the I/O interface type is equal to IO_IF_FC.
Example : "string"

string

nvmeNodeName
optional

Host NVMe Qualified Name (NQN)
Example : "string"

string

4.30. TargetPortal

Name Description Schema

groupTag
required

A value identifying the portal group to which this portal belongs.
Example : 0

integer (int32)

ipAddress
required

The IP address of the portal.
Example : "IpVxAddress"

IpVxAddress

tcpListenPort
required

The number of the TCP port on which the target listens for incoming connections.
Example : 0

integer (int32)

4.31. AsyncMirrorGroupCreateRequest

Creates an async mirror group (issued to the array with the primary role).

Name Description Schema

name
required

The user-label to assign to the new async mirror group.
Example : "string"

string

secondaryArrayId
required

The id of the secondary array.
Example : "string"

string

syncIntervalMinutes
optional

Sync interval in (minutes)
Default : 10
Example : 0

integer (int32)

manualSync
optional

Set the synchronization method to manual, causing other synchronization values to be ignored.
Default : false
Example : true

boolean

recoveryWarnThresholdMinutes
optional

Recovery point warning threshold (minutes). The user will be warned when the age of the last good failures point exceeds this value
Default : 20
Example : 0

integer (int32)

repoUtilizationWarnThreshold
optional

Recovery point warning threshold (percentage)
Default : 80
Minimum value : 0
Maximum value : 100
Example : 0

integer (int32)

interfaceType
optional

The intended protocol to use if both Fibre and iSCSI are available.
Example : "string"

enum (fibre, iscsi)

syncWarnThresholdMinutes
optional

The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete.
Default : 10
Example : 0

integer (int32)

4.32. AsyncMirrorConnectionsResponse

The connections this Amg has to the remote StorageSystem.

Name Description Schema

amgRef
optional

Example : "string"

string

connections
optional

Example : [ "AsyncMirrorRemoteConnection" ]

< AsyncMirrorRemoteConnection > array

4.33. AsyncMirrorRemoteConnection

Name Description Schema

localPortName
optional

The unique WWN of the local port. Only valid if the interface type is fc.
Example : "string"

string

remotePortName
optional

The unique WWN of the remote port. Only valid if the interface type is fc.
Example : "string"

string

remotePortId
optional

The switch port identifier for the remote port. Only valid if the interface type is fc.
Example : "string"

string

localPortId
optional

The switch port identifier for the local port. Only valid if the interface type is fc.
Example : "string"

string

localPortNumber
optional

Example : 0

integer (int32)

remotePortNumber
optional

Example : 0

integer (int32)

controller
optional

Example : "string"

string

ioInterfaceType
optional

Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

localPortRef
required

Local initiator port for these connections.
Example : "string"

string

iscsiConnectionDetail
optional

Example : "IscsiRemoteTargetConnections"

IscsiRemoteTargetConnections

fibreConnectionDetail
optional

Example : "FibreRemoteTargetConnections"

FibreRemoteTargetConnections

remoteTargetConnections
optional

Example : "ScsiRemoteTargetConnections"

ScsiRemoteTargetConnections

4.34. FibrePortLogin

Name Description Schema

switchPortId
required

The switch port ID.
Example : "string"

string

targetPortName
required

The target port name.
Example : "string"

string

4.35. FibreRemoteTargetConnections

Name Description Schema

remoteNodeWWN
required

Remote node name.
Example : "string"

string

associatedSwitchPorts
required

Associated (visible) switch ports.
Example : [ "string" ]

< string > array

connectedRemoteTargetPorts
required

Connected remote target ports.
Example : [ "FibrePortLogin" ]

< FibrePortLogin > array

4.36. IscsiRemoteTargetConnections

Name Description Schema

connectedRemoteTargetPortals
required

Connected remote target ports.
Example : [ "TargetPortal" ]

< TargetPortal > array

4.37. ScsiRemoteTargetConnections

Name Description Schema

ioInterfaceType
required

This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

iscsiConnectionDetail
optional

This field is returned if the value of ioInterfaceType is equal to IO_IF_ISCSI.
Example : "IscsiRemoteTargetConnections"

IscsiRemoteTargetConnections

fibreConnectionDetail
optional

This field is returned if the value of ioInterfaceType is equal to IO_IF_FC.
Example : "FibreRemoteTargetConnections"

FibreRemoteTargetConnections

4.38. AsyncMirrorRepositoryUtilization

Name Description Schema

pitDataBytes
required

The total number of bytes used in the repository for copy-on-write data and related metadata.
Example : "string"

string (int64)

deltaLogBytes
required

The total number of bytes used for the delta logs (bitmaps).
Example : "string"

string (int64)

bytesAvailable
required

The total number of bytes available for ongoing copy-on-write operations.
Example : "string"

string (int64)

mirrorRef
required

The mirror group member for which this utilization information applies.
Example : "string"

string

id
optional

Example : "string"

string

4.39. AsyncMirrorGroupUpdateRequest

Name Description Schema

name
optional

Example : "string"

string

syncIntervalMinutes
optional

Sync interval (minutes)
Example : 0

integer (int32)

recoveryWarnThresholdMinutes
optional

Recovery point warning threshold (minutes)
Example : 0

integer (int32)

repoUtilizationWarnThreshold
optional

Recovery point warning threshold (percentage)
Example : 0

integer (int32)

syncWarnThresholdMinutes
optional

Example : 0

integer (int32)

4.40. AsyncMirrorGroupRoleUpdateRequest

Name Description Schema

role
required

new role
Example : "string"

enum (unknown, primary, secondary, __UNDEFINED)

noSync
optional

Default : false
Example : true

boolean

force
optional

Default : false
Example : true

boolean

4.41. AmgMember

A representation of an asynchronous mirroring relationship between a local and remote volume.

Name Description Schema

memberRef
required

The reference (key) for the group member.
Example : "string"

string

mirrorGroup
required

The AMG with which this member is associated.
Example : "string"

string

localVolume
required

The local volume for this mirror. This is the volume being mirrored if the AMG role is primary, otherwise this is the target of mirror synchronization.
Example : "string"

string

remoteVolume
required

The remote volume. This is the target of mirror synchronization on the remote array if the AMG role is primary, otherwise this is the volume on the remote array that is being mirrored.
Example : "string"

string

memberState
required

The state of this mirror relationship (as known by this array).
Example : "string"

enum (unknown, initialSync, optimal, failed, incomplete, orphan, stopped, __UNDEFINED)

lastRecoveryPointTime
required

The timestamp, represented in seconds since midnight GMT on January 1, 1970, of the last recovery point PiT on secondary. If no recovery point image exists, the value of this field will be ARVM_NO_RECOVERY_POINT_TIMESTAMP.
Example : "string"

string (int64)

overUtilizationWarnThreshold
required

If true, the repository capacity utilized is over the warning threshold.
Example : true

boolean

mirroredLocalCapacity
required

The current local volume capacity that is being mirrored. This will be less than the actual local volume capacity if we have not yet reached a point where the next PiT can be taken and delta-logs resized (and until that point the expanded local capacity will not be opened up to host writes).
Example : "string"

string (int64)

repositoryVolume
required

The metadata volume (Copy-on-Write / DeltaLog Repository) for this mirror.
Example : "string"

string

worldWideName
required

The WWN of the async mirror proxy.
Example : "string"

string

volumeHandle
required

The SSID of the async mirror proxy.
Example : 0

integer (int32)

repositoryFull
required

If true, the repository is full (100% of available capacity utilized).
Example : true

boolean

localVolumeName
optional

The label of the source volume on the local StorageSystem.
Example : "string"

string

remoteVolumeName
optional

The label of the remote target volume.
Example : "string"

string

remoteVolumeInfo
optional

Detailed information on the remote volume.
Example : "RemoteVolume"

RemoteVolume

remoteTargetWwn
optional

The WWN of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created.
Example : "string"

string

remoteTargetName
optional

The user label of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode.
Example : "string"

string

remoteTargetId
optional

The id of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode.
Example : "string"

string

totalSizeInBytes
optional

The capacity of the underlying repository volume in bytes.
Example : "string"

string (int64)

mediaScan
optional

The volume-specific media scan settings currently in effect for the repository volume.
Example : "VolumeMediaScanParams"

VolumeMediaScanParams

id
optional

Example : "string"

string

4.42. RemoteVolume

Name Description Schema

worldWideName
required

The WWN of the remote volume.
Example : "string"

string

remoteVolRef
required

The identifier of the remote volume.
Example : "string"

string

manager
required

The controller that owns the remote volume.
Example : "string"

string

remoteArrayId
required

The identifier of the remote array.
Example : "SAIdentifier"

SAIdentifier

remoteNodeWWN
required

This field is deprecated. It will continue to be supported if remoteNodeName is NULL (IOInterfaceType == IO_IF_NOT_IMPLEMENTED). This will allow continued compatibility with clients still using this field.
Example : "string"

string

remoteVolWWN
required

The WWN of the volume on the remote array.
Example : "string"

string

remoteVolUserLabel
required

The user assigned label of the remote volume.
Example : "string"

string

remoteVolState
required

The state of the current remote volume.
Example : "string"

enum (optimal, noLun, noArray, noFabric, initializing, wwnChangeFailed, __UNDEFINED)

remoteVolCapacity
required

The actual capacity of the volume on the remote array.
Example : "string"

string (int64)

volumeHandle
required

The SSID of the remote volume.
Example : 0

integer (int32)

perms
required

The permissions of the volume.
Example : "VolumePerms"

VolumePerms

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

remoteNodeName
required

The name of the RemoteVolume.
Example : "ScsiNodeName"

ScsiNodeName

remoteVolSecurityType
required

The security type of the volume on the remote array. Note this may be SECURITY_TYPE_UNKNOWN if connection to remote array is down.
Example : "string"

enum (unknown, none, capable, enabled, __UNDEFINED)

4.43. SAIdentifier

Name Description Schema

worldWideName
required

A variable-length, opaque byte array whose value is guaranteed to be globally unique, and thus serves as the unique identifier for the storage array. No assumptions may be made outside the controller firmware environment about the meaning of the various bytes within this array. The only operation that a SYMbol client is allowed to perform on this field is a comparison for equality with the same field of a different storage array object.
Example : "string"

string

4.44. VolumeMediaScanParams

Name Description Schema

enable
required

A true value means that the controller should perform a media scan for this volume as part of its background processing. A false value means that the volume should not participate in media scans.
Example : true

boolean

parityValidationEnable
required

A true value means that, in addition to ensuring that the volume’s media blocks are fully accessible, the controller should also compute and validate all parity blocks for the volume during the media scan. A false value means that parity validation should not occur in conjunction with media checking. Note that this field has no significance unless the enable field is set to true.
Example : true

boolean

4.45. VolumePerms

Name Description Schema

mapToLUN
required

Can this volume be mapped to a LUN
Example : true

boolean

snapShot
required

This is true if the volume can have a snapshot.
Example : true

boolean

format
required

This is true if the volume can be formatted.
Example : true

boolean

reconfigure
required

This is true if the volume can be reconfigured (DVE, DCE, DRM, etc.).
Example : true

boolean

mirrorPrimary
required

This is true if the volume can be a primary mirror.
Example : true

boolean

mirrorSecondary
required

This is true if the volume can be a secondary mirror.
Example : true

boolean

copySource
required

This is true if the volume can be the source for a copy.
Example : true

boolean

copyTarget
required

This is true if the volume can be the target for a copy.
Example : true

boolean

readable
required

This is true if the volume can be read by a host.
Example : true

boolean

writable
required

Can this volume be written by a host
Example : true

boolean

rollback
required

Set to true if a snapshot rollback can be applied to this volume.
Example : true

boolean

mirrorSync
required

Set to true if a remote volume mirror can actively synchronize this volume’s data
Example : true

boolean

newImage
required

Set to true when a new point-in-time image can be taken of this volume, either by creating a new snapshot or re-creating an existing snapshot.
Example : true

boolean

allowDVE
required

If true, this volume can be expanded via DVE. If false, this will still allow general reconfigures (providing the 'reconfigure' field is true), but disallow DVE specifically.
Example : true

boolean

allowDSS
required

If true, this volume can undergo a segment size change (DSS). If false, this will still allow general reconfigures (providing the 'reconfigure' field is true), but disallow DSS specifically.
Example : true

boolean

concatVolumeMember
required

If true, this volume can be a member of a ConcatVolume.
Example : true

boolean

flashReadCache
required

If true, this volume can have flash read cache enabled.
Example : true

boolean

asyncMirrorPrimary
required

If true, this volume can be an Async RVM primary.
Example : true

boolean

asyncMirrorSecondary
required

If true, this volume can be an Async RVM primary.
Example : true

boolean

pitGroup
required

If true, a PiT group can be created on this volume.
Example : true

boolean

cacheParametersChangeable
required

If true, cache parameters may be changed on this volume.
Example : true

boolean

allowThinManualExpansion
required

If true, changes to manual mode while the thin volume is in an Asynchronous Mirror Group (AMG) are allowed.
Example : true

boolean

allowThinGrowthParametersChange
required

If true, changes to the growth parameters (quota or warning threshold values) while the thin volume is in an Asynchronous Mirror Group (AMG) are allowed.
Example : true

boolean

4.46. AmgIncompleteMember

Name Description Schema

memberRef
required

The reference (key) for the group member.
Example : "string"

string

groupRef
required

The associated Async Mirror Group.
Example : "string"

string

primaryVolWWN
required

The WWN of the primary volume on the remote array.
Example : "string"

string

primaryVolCapacity
required

Capacity of the primary (used to aid in selection of mirror secondary volume).
Example : "string"

string (int64)

primaryVolRAIDLevel
required

RAID level of the primary volume.
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

primaryVolProtectionType
required

The protection type of the primary volume.
Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

primaryVolSecurityType
required

Security type of the primary volume.
Example : "string"

enum (unknown, none, capable, enabled, __UNDEFINED)

primaryVolUserLabel
required

User label of the primary volume.
Example : "string"

string

orphanIncompleteMember
required

If true, the incomplete member is an orphan.
Example : true

boolean

primaryVolumeParameters
required

The capacity provisioning parameters for the primary volume.
Example : "VolumeTypeParameters"

VolumeTypeParameters

primaryVolSecurityLevel
required

Refines the information in the securityType field to describe the set of drives.
Example : "string"

enum (unknown, none, mixed, fde, fips, __UNDEFINED)

remoteTargetWwn
optional

The WWN of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created.
Example : "string"

string

remoteTargetName
optional

The user label of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode.
Example : "string"

string

remoteTargetId
optional

The id of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode.
Example : "string"

string

id
optional

Example : "string"

string

4.47. ThinVolumeCapacityProvisioningDetails

Name Description Schema

capacityQuota
required

The maximum capacity to which the Expandable Repository Volume can grow (in bytes).
Example : "string"

string (int64)

growthAlertThreshold
required

The alert threshold percent value for the Expandable Repository Volume.
Example : 0

integer (int32)

repositoryExpansionPolicy
required

The expansion policy for the Expandable Repository Volume.
Example : "string"

enum (unknown, manual, automatic, __UNDEFINED)

4.48. VolumeTypeParameters

Name Description Schema

volumeType
required

This enumeration is used to identify the capacity provisioning of a volume.
Example : "string"

enum (unknown, thinProvisioned, thickProvisioned, __UNDEFINED)

capacityProvisioningDetails
optional

This field is returned if the value of returnCode is equal to RETCODE_OK.
Example : "ThinVolumeCapacityProvisioningDetails"

ThinVolumeCapacityProvisioningDetails

4.49. AsyncMirrorGroupMemberCompletionRequest

Name Description Schema

secondaryPoolId
optional

Storage pool on the target StorageSystem to create the mirrored pair repository volume on. This defaults to the pool that the secondaryVolume belongs to.
Example : "string"

string

secondaryVolumeRef
required

Example : "string"

string

scanMedia
optional

Default : false
Example : true

boolean

validateRepositoryParity
optional

Default : false
Example : true

boolean

secondaryPercentCapacity
optional

Percentage of the capacity of the secondary volume to use for the repository capacity.
Example : 0.0

number (double)

secondaryRepositoryCandidate
optional

Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected.
Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

4.50. ConcatVolumeCandidate

Name Description Schema

candType
required

This enumeration is used to specify the Concatenated Volume candidate type.
Example : "string"

enum (unknown, newVol, existingVols, expansion, __UNDEFINED)

newVolCandidate
optional

This field is present only if the ConcatVolumeCandidateType value is equal to CONCAT_VOL_CANDIDATE_TYPE_NEW_VOL.
Example : "ConcatVolumeNewVolumeCandidate"

ConcatVolumeNewVolumeCandidate

existVolCandidate
optional

This field is present only if the ConcatVolumeCandidateType value is equal to CONCAT_VOL_CANDIDATE_TYPE_EXISTING_VOLS.
Example : "ConcatVolumeExistingVolumeCandidate"

ConcatVolumeExistingVolumeCandidate

expansionDescriptor
optional

This field is present only if the ConcatVolumeCandidateType value is equal to CONCAT_VOL_CANDIDATE_TYPE_EXPANSION.
Example : "ConcatVolumeDirectExpansionDescriptor"

ConcatVolumeDirectExpansionDescriptor

4.51. ConcatVolumeDirectExpansionDescriptor

Name Description Schema

additionalCapacity
required

Additional capacity to add to the last member of the ConcatVolume.
Example : "string"

string (int64)

4.52. ConcatVolumeExistingVolumeCandidate

Name Description Schema

refType
required

This enumeration is used to specify the Concatenated Volume Member reference type.
Example : "string"

enum (unknown, volref, label, __UNDEFINED)

memberVolumeRef
optional

A list of member volumes specified using volume references. This field is present only if the value of refType is equal to CONCAT_VOL_MEMBER_REF_TYPE_VOLREF.
Example : [ "string" ]

< string > array

memberLabel
optional

A list of member volumes specified using volume labels. This field is present only if the value of refType is equal to CONCAT_VOL_MEMBER_REF_TYPE_LABEL.
Example : [ "string" ]

< string > array

4.53. ConcatVolumeNewVolumeCandidate

Name Description Schema

memberVolumeLabel
required

The label for the new member volume.
Example : "string"

string

memberVolumeGroupLabel
required

An optional volume group label if creating a new volume group.
Example : "string"

string

memberCandidate
required

The candidate to be used to create the member volume.
Example : "VolumeCandidate"

VolumeCandidate

memberCapacity
required

The capacity of the new volume to create, in bytes.
Example : "string"

string (int64)

4.54. DiskPoolVolumeCandidateData

Name Description Schema

reconstructionReservedDriveCount
required

The number of drives reserved for reconstruction of failed drives.
Example : 0

integer (int32)

reconstructionReservedAmt
required

The pool capacity reserved to hold rebuild data (in bytes). This value is calculated from the reconstructionReservedDriveCount.
Example : "string"

string (int64)

unusableCapacity
required

This value identifies how much capacity (in bytes) is being wasted due to a mix of drive sizes. This value will be zero as long as the pool consists of like drive sizes.
Example : "string"

string (int64)

4.55. DriveRefList

Name Description Schema

driveRef
required

A variable-length array of DriveRef objects.
Example : [ "string" ]

< string > array

4.56. ProtectionInformationCapabilities

Name Description Schema

protectionInformationCapable
required

True when all drive(s) are PI capable.
Example : true

boolean

protectionType
required

This field is set to the protection type provided for the drive(s).
Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

4.57. VolumeCandidate

Name Description Schema

raidLevel
required

The RAID level of the potential volume.
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

trayLossProtection
required

This field is set to true if the candidate has tray loss protection.
Example : true

boolean

rawSize
required

This value is the maximum allowed user data storage capacity for the volume if the smallest possible segment is used in creating the volume.
Example : "string"

string (int64)

usableSize
required

This value is the maximum allowed user data storage capacity for the volume if the largest possible segment is used in creating the volume.
Example : "string"

string (int64)

driveCount
required

The number of drives in the potential volume’s volume group.
Example : 0

integer (int32)

freeExtentRef
required

The reference value of the free extent on which the potential volume would be created. This field will be valid only if the volume candidate was obtained using a candidate selection type of CANDIDATE_SEL_FREE_EXTENT.
Example : "string"

string

driveRefList
required

A list of the reference values of the drives on which the volume group for the potential volume would be created. This field will be valid only if the volume candidate was obtained using a candidate selection type of CANDIDATE_SEL_MANUAL.
Example : "DriveRefList"

DriveRefList

candidateSelectionType
required

The type of candidate selection that was used to obtain this volume candidate.
Example : "string"

enum (freeExtent, manual, count, __UNDEFINED)

spindleSpeedMatch
required

True, if all drives have matching spindle speed.
Example : true

boolean

spindleSpeed
required

True, if all drives have matching spindle speed.
Example : 0

integer (int32)

phyDriveType
required

The physical drive type.
Example : "string"

enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED)

dssPreallocEnabled
required

True if dynamic segment sizing pre-allocation will be enabled for the volume created from this candidate, otherwise false.
Example : true

boolean

securityType
required

The desired security level of the drive group.
Example : "string"

enum (unknown, none, capable, enabled, __UNDEFINED)

drawerLossProtection
required

This field is set to true when the volume group has drawer loss protection; otherwise it is set to false
Example : true

boolean

driveMediaType
required

Drive media type (HDD or SSD) of the volume candidate.
Example : "string"

enum (all, unknown, hdd, ssd, __UNDEFINED)

protectionInformationCapable
required

This field is no longer used.
Example : true

boolean

protectionInformationCapabilities
required

This structure contains a protectionInformationCapable field which is set to true if all drives in the volume group where the volume candidate resides are Protection Information (PI) capable. It also contains the protection type for the volume group.
Example : "ProtectionInformationCapabilities"

ProtectionInformationCapabilities

volumeCandidateData
required

Information about the Volume Candidate.
Example : "VolumeCandidateTypeData"

VolumeCandidateTypeData

driveBlockFormat
required

Identifies the drive block format of the volume candidate.
Example : "string"

enum (unknown, allNative, allEmulated, mixed, __UNDEFINED)

allocateReservedSpace
required

Determines whether or not reserved space is allocated on the drives in the volume group.
Example : true

boolean

securityLevel
required

Describes the overall security level of the drive set. Values can include: FDE only, FIPS only, mixed, or no security. Used along with the SecurityType field.
Example : "string"

enum (unknown, none, mixed, fde, fips, __UNDEFINED)

4.58. VolumeCandidateTypeData

Name Description Schema

type
required

This enumeration is used to indicate the type of the volume group.
Example : "string"

enum (unknown, traditional, diskPool, __UNDEFINED)

diskPoolVolumeCandidateData
optional

This field is present only if the value of type is equal to VG_TYPE_DISK_POOL.
Example : "DiskPoolVolumeCandidateData"

DiskPoolVolumeCandidateData

4.59. AsyncMirrorGroupMemberCreateRequest

Name Description Schema

primaryPoolId
required

Storage pool on the source StorageSystem to create the mirrored pair repository volume on. This defaults to the pool that the primaryVolume belongs to.
Example : "string"

string

secondaryPoolId
required

Storage pool on the target StorageSystem to create the mirrored pair repository volume on. This defaults to the pool that the secondaryVolume belongs to.
Example : "string"

string

primaryVolumeRef
required

Example : "string"

string

secondaryVolumeRef
required

Example : "string"

string

primaryRepositoryCandidate
optional

Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected.
Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

secondaryRepositoryCandidate
optional

Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected.
Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

scanMedia
optional

Default : false
Example : true

boolean

validateRepositoryParity
optional

Default : false
Example : true

boolean

percentCapacity
optional

Percentage of the capacity of the primary volume to use for the repository capacity.
Default : 20.0
Example : 0.0

number (double)

secondaryPercentCapacity
optional

Percentage of the capacity of the secondary volume to use for the repository capacity. Defaults to percentCapacity.
Example : 0.0

number (double)

4.60. AuditLogGetResponse

Name Description Schema

totalLogRecords
required

Total audit log records in the database
Example : 0

integer (int32)

logRecords
required

A list of log records requested
Example : [ "AuditLogRecord" ]

< AuditLogRecord > array

firstRecordOrdinal
required

First record ordinal
Example : 0

integer (int32)

lastRecordOrdinal
required

Last record ordinal
Example : 0

integer (int32)

4.61. AuditLogRecord

Audit log record.

Name Description Schema

method
required

HTTP method, for example GET and POST.
Example : "string"

string

accessedUrl
required

Accessed URL.
Example : "string"

string

clientIp
required

IP address of client.
Example : "string"

string

userId
required

Username of the user accessing the URL.
Example : "string"

string

httpStatus
required

HTTP status code of the operation.
Example : 0

integer (int32)

httpReasonPhrase
required

HTTP reason phrase.
Example : "string"

string

isFederated
required

Indicates if the user was authenticated by WSP in a federated security environment.
Example : true

boolean

loggingAgent
required

Logging agent.
Example : "string"

string

cliCommandExecuted
optional

CLI command executed.
Example : "string"

string

cliReturnStatus
optional

CLI status code or request for input files.
Example : "string"

string

symbolProcedure
optional

Symbol procedure.
Example : "string"

string

sshEventType
optional

SSH login event type.
Example : "string"

enum (login, logout, login_fail, signature_validation_failure, ntp_time_change)

sshSessionPid
optional

SSH session process ID.
Example : 0

integer (int32)

sshSessionDuration
optional

SSH session duration (in seconds).
Example : 0

integer (int32)

timestamp
required

Date and time of accessed URL in seconds since midnight GMT on January 1, 1970.
Example : "string"

string (int64)

recordOrdinal
required

Record ordinal.
Example : 0

integer (int32)

optionalText
optional

Optional Text.
Example : "string"

string

4.62. AuditLogDeleteResponse

Name Description Schema

totalDeletedRecords
required

Total number of audit log records deleted
Example : 0

integer (int32)

4.63. AuditLogInfoResponse

Name Description Schema

totalLogRecords
required

Total audit log records.
Example : 0

integer (int32)

firstRecordTimestamp
required

First record timestamp.
Example : "string"

string (int64)

lastRecordTimestamp
required

Last record timestamp.
Example : "string"

string (int64)

4.64. AuditLogConfiguration

Name Description Schema

auditLogMaxRecords
required

Maximum number of records.
Example : 0

integer (int32)

auditLogLevel
required

Log level.
Example : "string"

enum (all, writeOnly)

auditLogFullPolicy
required

Full policy.
Example : "string"

enum (overWrite, preventSystemAccess)

auditLogWarningThresholdPct
required

Warning threshold percentage.
Example : 0

integer (int32)

4.65. RelativeDistinguishedName

Name Description Schema

attributes
optional

The attributes for the relative distinguished name.
Example : [ "RelativeDistinguishedNameAttribute" ]

< RelativeDistinguishedNameAttribute > array

4.66. RelativeDistinguishedNameAttribute

Name Description Schema

name
optional

The attribute name.
Example : "string"

string

value
optional

The attribute value.
Example : "string"

string

4.67. SSLCertConfiguration

Configuration information to setup certificates.

Name Description Schema

dn
optional

The distinguished name for the certificate. This is used by the LDAP API to reference the LDAP object. An example value would be "uid=john.doe,ou=People,dc=example,dc=com". If this value is provided then any values provided for the rdns will be ignored.
Example : "string"

string

rdns
optional

List of relative distinguished names that can be combined to create the distinguished name (dn). These values will be ignored if a domain name (dn) is provided.
Example : [ "RelativeDistinguishedName" ]

< RelativeDistinguishedName > array

subjectAlternateNames
optional

If provided, this will attach a Subject Alternate Name extension to the certificate to allow the user to bind additional properties (email address, DNS name, etc) to the subject of the certificate.
Example : [ "SubjectAlternateName" ]

< SubjectAlternateName > array

4.68. SubjectAlternateName

A Subject Alternate entry for the x509 Certificate

Name Description Schema

sanType
required

Type of Subject Alternate
Example : "string"

enum (ip, dns)

sanValue
required

The value for the alternate
Example : "string"

string

4.69. X509CertInfo

Basic information for X509 Certs stored in the system.

Name Description Schema

alias
optional

Example : "string"

string

subjectDN
optional

Example : "string"

string

issuerDN
optional

Example : "string"

string

start
optional

Example : "string"

string (date-time)

expire
optional

Example : "string"

string (date-time)

truststore
optional

Example : true

boolean

isUserInstalled
optional

Example : true

boolean

isKeyEntry
optional

Example : true

boolean

4.70. CertRevocatSettings

Server certificate revocation settings.

Name Description Schema

revocationChecking
required

Set to true to enable certificate revocation checking; by default this is not enabled.
Example : true

boolean

ocspResponderAddress
optional

The URL of the OCSP responder to be used by default; if left blank the OCSP responder address specified in the certificate will be used.
Example : "string"

string

4.71. PrivateFileInfo

Name Description Schema

fileSize
required

The size of the file
Example : "string"

string (int64)

fileID
required

The GUID for the file
Example : "string"

string

fileURL
required

The URL for the file
Example : "string"

string (uri)

4.72. ConfigurationResult

The results of the last configuration operation

Name Description Schema

startDate
optional

The time the configuration operation started
Example : "string"

string (date-time)

endDate
optional

The time the operation finished. Null if an operation is in progress
Example : "string"

string (date-time)

currentResults
optional

The list of results for each system being configured. The size of this list will be < total until the operation is finished
Example : [ "ConfigurationResultItem" ]

< ConfigurationResultItem > array

totalSystems
optional

the total number of systems requested to be configured
Example : 0

integer (int32)

numberDone
optional

the number of system currently attempted
Example : 0

integer (int32)

operationDone
optional

true when the configuration operation is finished
Example : true

boolean

4.73. ConfigurationResultItem

Holds the result of the configuration actiopn for a single storage system

Name Description Schema

systemKey
optional

The key from the csv file for the storage system
Example : "string"

string

success
optional

True if the configuration did not have any reported errors
Example : true

boolean

response
optional

If the operation did not succeed, this properties has the error information
Example : "CallResponse"

CallResponse

4.74. FileBasedConfigurationRequest

Defines the parameters for a file based bulk configuration request

Name Description Schema

skipHeader
optional

Indicates the first line of the file is a header line and should be skipped
Example : true

boolean

fileName
required

The name of a previously uploaded CSV file from which to pull configuration data
Example : "string"

string

configItems
required

A list of column to configuration items pairs
Example : [ "FileConfigItem" ]

< FileConfigItem > array

4.75. FileConfigItem

An element describing what column in a CSV file maps to what configuration item

Name Description Schema

column
required

The column in the CSV File. 0 based value
Example : 0

integer (int32)

type
optional

Example : "string"

enum (systemSerialNumber, controllerAPort1IP4, controllerAPort2IP4, controllerBPort1IP4, controllerBPort2IP4, controllerAPort1IP6, controllerAPort2IP6, controllerBPort1IP6, controllerBPort2IP6, controllerAPort1Netmask4, controllerAPort2Netmask4, controllerBPort1Netmask4, controllerBPort2Netmask4, controllerAPort1Netmask6, controllerAPort2Netmask6, controllerBPort1Netmask6, controllerBPort2Netmask6, controllerAIPv4GW, controllerAIPv6GW, controllerBIPv4GW, controllerBIPv6GW, systemLabel, saPassword, systemKey, metaData)

4.76. ValidateConfigurationFileResponseItem

This object contains the results of a spread sheet parse to allow the user to test without configuring systems

Name Description Schema

row
optional

The 1 based row identifier. Row 0 is the header row and is not returned
Example : 0

integer (int32)

type
optional

The configuration item type
Example : "string"

enum (systemSerialNumber, controllerAPort1IP4, controllerAPort2IP4, controllerBPort1IP4, controllerBPort2IP4, controllerAPort1IP6, controllerAPort2IP6, controllerBPort1IP6, controllerBPort2IP6, controllerAPort1Netmask4, controllerAPort2Netmask4, controllerBPort1Netmask4, controllerBPort2Netmask4, controllerAPort1Netmask6, controllerAPort2Netmask6, controllerBPort1Netmask6, controllerBPort2Netmask6, controllerAIPv4GW, controllerAIPv6GW, controllerBIPv4GW, controllerBIPv6GW, systemLabel, saPassword, systemKey, metaData)

value
optional

The data found for the row
Example : "string"

string

4.77. ValidateConfiurationFileResponse

The respoinse from a validate configuration file request

Name Description Schema

fileFound
optional

Example : true

boolean

items
optional

Example : [ "ValidateConfigurationFileResponseItem" ]

< ValidateConfigurationFileResponseItem > array

4.78. PITConsistencyGroup

Name Description Schema

cgRef
required

The reference (key) for this PITConsistencyGroup.
Example : "string"

string

label
required

The name of the Consistency Group.
Example : "string"

string

repFullPolicy
required

The behavior on repository full condition.
Example : "string"

enum (unknown, failbasewrites, purgepit, __UNDEFINED)

fullWarnThreshold
required

The repository utilization warning threshold percentage.
Example : 0

integer (int32)

autoDeleteLimit
required

The auto-delete indicator. If non-zero, the oldest PiT will be automatically deleted when creating a new one to keep the total number of PiTs limited to the number specified.
Example : 0

integer (int32)

rollbackPriority
required

The importance of the rollback operation.
Example : "string"

enum (highest, high, medium, low, lowest, __UNDEFINED)

uniqueSequenceNumber
required

A list of all unique sequence numbers for all existing PiTs of members in this consistency group.
Example : [ "string" ]

< string (int64) > array

creationPendingStatus
required

The status of Pending PiT Creation.
Example : "string"

enum (unknown, none, waiting, failed, __UNDEFINED)

name
optional

Example : "string"

string

id
optional

Example : "string"

string

4.79. ConsistencyGroupCreateRequest

Used to create a consistency group

Name Description Schema

name
required

The user-label to assign to the new consistency group
Example : "string"

string

fullWarnThresholdPercent
optional

The full warning threshold percent
Default : 75
Minimum value : 1
Maximum value : 100
Example : 0

integer (int32)

autoDeleteThreshold
optional

The auto-delete threshold. Automatically delete snapshots after this many.
Default : 32
Minimum value : 0
Maximum value : 32
Example : 0

integer (int32)

repositoryFullPolicy
optional

The repository full policy.
Default : "purgepit"
Example : "string"

enum (unknown, failbasewrites, purgepit, __UNDEFINED)

rollbackPriority
optional

Roll-back priority
Default : "medium"
Example : "string"

enum (highest, high, medium, low, lowest, __UNDEFINED)

4.80. ConsistencyGroupUpdateRequest

Updates a consistency group

Name Description Schema

name
optional

The user-label to assign to the new consistency group
Example : "string"

string

fullWarnThresholdPercent
optional

The full warning threshold percent
Example : 0

integer (int32)

autoDeleteThreshold
optional

The auto-delete threshold. Automatically delete snapshots after this many.
Example : 0

integer (int32)

repositoryFullPolicy
optional

The repository full policy.
Example : "string"

enum (unknown, failbasewrites, purgepit, __UNDEFINED)

rollbackPriority
optional

Roll-back priority
Example : "string"

enum (highest, high, medium, low, lowest, __UNDEFINED)

4.81. PITCGMember

Name Description Schema

consistencyGroupId
required

Example : "string"

string

volumeId
required

Example : "string"

string

volumeWwn
required

Example : "string"

string

baseVolumeName
required

Example : "string"

string

clusterSize
required

The cluster size (in bytes).
Example : 0

integer (int32)

totalRepositoryVolumes
required

Total number of repository volumes in use by the underlying snapshotGroup
Example : 0

integer (int32)

totalRepositoryCapacity
required

Total repository capacity
Example : "string"

string (int64)

usedRepositoryCapacity
required

The amount of repository capacity that is being utilized
Example : "string"

string (int64)

fullWarnThreshold
required

The capacity threshold at which the user will be warned about running out of capacity for the repository
Example : 0

integer (int32)

totalSnapshotImages
required

The total number of snapshot images defined for this member
Example : 0

integer (int32)

totalSnapshotVolumes
required

The total number of snapshot volumes defined for this member
Example : 0

integer (int32)

autoDeleteSnapshots
required

Automatically purge all snapshots over this value
Example : true

boolean

autoDeleteLimit
required

If autoDeleteSnapshots is enabled, the maximum number allowed before autoDeletion occurs
Example : 0

integer (int32)

pitGroupId
required

Reference to the snapshotGroup
Example : "string"

string

repositoryVolume
required

Reference to the repository volume of the pitGroup/snapshotGroup
Example : "string"

string

4.82. PITConsistencyGroupView

Name Description Schema

cgViewRef
required

The reference (key) for this PITConsistencyGroupView.
Example : "string"

string

groupRef
required

The PiT Consistency Group to which the Consistency Group View belongs.
Example : "string"

string

label
required

The name of the Consistency Group View.
Example : "string"

string

viewTime
required

The controller-time (measured in seconds since January 1, 1970) when the Consistency Group View was created or re-attached to another PiT. All member Views that are part of this Consistency Group View have this value in their corresponding fields.
Example : "string"

string (int64)

viewSequenceNumber
required

The view sequence number. This is a monotonically increasing sequence value that is common across all member Views that are part of this Consistency Group View.
Example : "string"

string (int64)

name
optional

Example : "string"

string

id
optional

Example : "string"

string

4.83. AddConsistencyGroupMemberRequest

Add consistency group member volume

Name Description Schema

volumeId
required

The member volume ref
Example : "string"

string

repositoryPoolId
optional

The repository volume pool
Example : "string"

string

scanMedia
optional

Default : false
Example : true

boolean

validateParity
optional

Default : false
Example : true

boolean

repositoryPercent
optional

Default : 20.0
Example : 0.0

number (double)

repositoryCandidate
optional

Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

4.84. AddBatchCGMembersRequest

Name Description Schema

volumeToCandidates
required

A map of volume refs to ConcatVolumeCandidates that will be used for creating the repository volumes.
Example : {
"string" : "ConcatVolumeCandidate"
}

< string, ConcatVolumeCandidate > map

scanMedia
optional

Default : false
Example : true

boolean

validateParity
optional

Default : false
Example : true

boolean

4.85. Snapshot

Name Description Schema

pitRef
required

The reference (key) for this PiT.
Example : "string"

string

pitGroupRef
required

A reference to the associated PiT Group.
Example : "string"

string

creationMethod
required

The PiT creation method.
Example : "string"

enum (unknown, user, schedule, __UNDEFINED)

pitTimestamp
required

The controller-time (measured in seconds since January 1, 1970) when the PiT was created.
Example : "string"

string (int64)

pitSequenceNumber
required

The sequence number within PITGroup. This is a monotonically increasing sequence value that can be used to determine the absolute order of the PiTs within a PiT group. Using this sequence number avoids issues with timestamps when real-time clocks are changed. Note that this sequence number will be the same on all PiTs taken in multiple PITGroups at the same time under a single IO suspension, either as part of a consistency group operation (createCGPIT) or when a list of PITGroups is passed to createPIT.
Example : "string"

string (int64)

status
required

The state of this PiT.
Example : "string"

enum (unknown, optimal, failed, purged, __UNDEFINED)

activeCOW
required

If true, the PiT is actively recording copy-on-write data.
Example : true

boolean

isRollbackSource
required

If true, the PiT is a rollback source.
Example : true

boolean

pitCapacity
required

The capacity in bytes of this PiT (capacity of the base at the time the PiT was created).
Example : "string"

string (int64)

repositoryCapacityUtilization
required

Repository utilization in bytes (only reported if activeCOW = false).
Example : "string"

string (int64)

baseVol
optional

Example : "string"

string

consistencyGroupId
optional

Example : "string"

string

id
optional

Example : "string"

string

4.86. CreateConsistencyGroupSnapshotRequest

Type : object

4.87. PITViewMembership

Name Description Schema

viewType
required

This enumeration identifies the possible types for a PITView.
Example : "string"

enum (unknown, individual, member, __UNDEFINED)

cgViewRef
optional

A reference to the PITConsistencyGroupView is returned if the value of viewType is equal to PIT_VIEW_TYPE_MEMBER.
Example : "string"

string

4.88. PitViewEx

Name Description Schema

viewRef
required

The reference (key) for this view.
Example : "string"

string

worldWideName
required

The WWN of the view.
Example : "string"

string

baseVol
required

A reference to the base volume with which this view is associated.
Example : "string"

string

basePIT
required

A reference to the particular PiT of the base for which this view applies. This field is only valid if the boundToPIT field is true.
Example : "string"

string

boundToPIT
required

If true, this flag indicates that the basePIT field is a valid reference to an associated PIT. If false, the view is disassociated from the PiT so the basePIT reference is invalid.
Example : true

boolean

accessMode
required

The view access mode.
Example : "string"

enum (modeUnknown, readWrite, readOnly, __UNDEFINED)

label
required

The name of the view.
Example : "string"

string

status
required

The view status.
Example : "string"

enum (unknown, optimal, stopped, failed, overThreshold, full, __UNDEFINED)

currentManager
required

The current owner of the view.
Example : "string"

string

preferredManager
required

The preferred owner of the view.
Example : "string"

string

repositoryVolume
required

The copy-on-write repository for this view.
Example : "string"

string

fullWarnThreshold
required

The repository utilization warning threshold percentage.
Example : 0

integer (int32)

viewTime
required

The controller-time (measured in seconds since January 1, 1970) when view was created or re-attached to another PiT.
Example : "string"

string (int64)

viewSequenceNumber
required

Sequence number. This is a monotonically increasing sequence value that can be used to determine related views when the view was created as part of a consistency group operation.
Example : "string"

string (int64)

perms
required

The permissions for the view.
Example : "VolumePerms"

VolumePerms

volumeHandle
required

The volume ssid. This is provided primarily for debug purposes.
Example : 0

integer (int32)

clusterSize
required

The cluster size in bytes.
Example : 0

integer (int32)

maxRepositoryCapacity
required

The maximum allowable repository size in bytes based on current cluster size.
Example : "string"

string (int64)

unusableRepositoryCapacity
required

The amount of repository capacity in bytes that is unusable due to limited addressability of the current cluster size.
Example : "string"

string (int64)

membership
required

This view’s relationship (if any) to a Consistency Group View.
Example : "PITViewMembership"

PITViewMembership

mgmtClientAttribute
required

The management client attribute.
Example : 0

integer (int32)

offline
required

The view is offline due to the associated repository volume state.
Example : true

boolean

extendedUniqueIdentifier
required

A variable-length opaque field that provides the volume’s extended unique identification value.
Example : "string"

string

volumeFull
optional

Example : true

boolean

repositoryCapacity
optional

Example : "string"

string (int64)

baseVolumeCapacity
optional

Example : "string"

string (int64)

totalSizeInBytes
optional

Example : "string"

string (int64)

consistencyGroupId
optional

Example : "string"

string

volumeCopyTarget
optional

Example : true

boolean

cloneCopy
optional

Example : true

boolean

volumeCopySource
optional

Example : true

boolean

pitBaseVolume
optional

Example : true

boolean

asyncMirrorTarget
optional

True if the volume is a target in an Asynchronous Mirror relationship.
Example : true

boolean

asyncMirrorSource
optional

True if the volume is a source in an Asynchronous Mirror relationship.
Example : true

boolean

protectionType
optional

Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

remoteMirrorSource
optional

True if the volume is a source (primary), in an Remote Volume Mirror relationship.
Example : true

boolean

remoteMirrorTarget
optional

True if the volume is a target (secondary), in an Remote Volume Mirror relationship.
Example : true

boolean

name
optional

Example : "string"

string

id
optional

Example : "string"

string

objectType
optional

Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

wwn
optional

Example : "string"

string

mapped
required

Example : true

boolean

preferredControllerId
optional

Example : "string"

string

onlineVolumeCopy
optional

Example : true

boolean

listOfMappings
optional

Example : [ "LUNMapping" ]

< LUNMapping > array

currentControllerId
optional

Example : "string"

string

4.89. CreateConsistencyGroupSnapshotViewRequest

Name Description Schema

name
required

Example : "string"

string

repositoryPoolId
optional

The reference to the pool that will be used for the repository creation.
Example : "string"

string

pitId
optional

The id of the PIT to create a View for. Either the pitSequenceNumber or a pitId is required.
Example : "string"

string

pitSequenceNumber
optional

The sequence number of the PITs to create Views for. Either the pitSequenceNumber or a pitId is required.
Example : "string"

string (int64)

accessMode
optional

The access mode determines whether or not a repository volume should be created.
Default : "readOnly"
Example : "string"

enum (modeUnknown, readWrite, readOnly, __UNDEFINED)

repositoryPercent
optional

Default : 20.0
Example : 0.0

number (double)

scanMedia
optional

Default : false
Example : true

boolean

validateParity
optional

Default : false
Example : true

boolean

4.90. CGSnapshotViewRequest

Name Description Schema

pitId
required

The id of the PIT to create a View for.
Example : "string"

string

candidate
optional

A manually specified ConcatVolumeCandidate of type newVol or existingVols. Required if accessMode == readWrite.
Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

accessMode
optional

The access mode determines whether or not a repository volume should be created.
Default : "readOnly"
Example : "string"

enum (modeUnknown, readWrite, readOnly, __UNDEFINED)

scanMedia
optional

Default : false
Example : true

boolean

validateParity
optional

Default : false
Example : true

boolean

4.91. CreateCGSnapshotViewManualRequest

Name Description Schema

name
required

Example : "string"

string

pitSequenceNumber
required

The sequence number of the PITs to create Views for. All provided PITs/Snapshots must have a matching sequenceNumber
Example : "string"

string (int64)

requests
required

A list of Snapshots to include in the view.
Example : [ "CGSnapshotViewRequest" ]

< CGSnapshotViewRequest > array

4.92. CFWPackageMetadata

Name Description Schema

filename
required

Example : "string"

string

version
required

Example : "string"

string

4.93. InitialAsyncResponse

Provides a unique identifier for requesting status of an asynchronous call.

Name Description Schema

requestId
required

A unique value that identifies the request for later retrieval.
Example : "string"

string (int64)

4.94. CfwUpgradeResponse

Name Description Schema

requestId
required

A unique value that identifies the request for later retrieval.
Example : "string"

string (int64)

healthCheck
required

Example : "FirmwareUpgradeHealthCheckResult"

FirmwareUpgradeHealthCheckResult

startTime
required

Example : "string"

string (date-time)

uploadStartTime
required

Example : "string"

string (date-time)

activationStartTime
required

Example : "string"

string (date-time)

uploadCompletionTime
required

Example : "string"

string (date-time)

uploadCompletionPercentage
required

Example : 0

integer (int32)

activationCompletionTime
required

Example : "string"

string (date-time)

running
required

Example : true

boolean

4.95. ConfigurationDbValidationCheck

Name Description Schema

result
required

Example : "string"

enum (ok, notCompleted, failedDataRetrieval, failed)

type
required

Example : "string"

enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, integratedHealthCheck)

severityLevel
required

Example : "string"

enum (unknown, low, medium, high, fatal)

resultsData
required

Results data to diagnose failures
Example : "string"

string

status
required

Status of the database validation check
Example : "string"

enum (ok, noHeap, ioError, earlyExecution, fatalFsInvalid, fatalRootOutOfBounds, fatalDupBlockPointers, fatalDirOutOfBounds, fatalCorruptMetadata, fatalMissingMetadata, fatalRecOutOfBounds, fatalDupRecPointers, fatalRecordUnallocated, fatalOrphanBlock, fatalFsOffline, noDrives, lockError, fatalMirrorMismatch, mirrorNotReady, __UNDEFINED)

successful
optional

Example : true

boolean

4.96. ExclusiveOperationCheck

Name Description Schema

result
required

Example : "string"

enum (ok, notCompleted, failedDataRetrieval, failed)

type
required

Example : "string"

enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, integratedHealthCheck)

severityLevel
required

Example : "string"

enum (unknown, low, medium, high, fatal)

resultsData
required

Results data to diagnose failures
Example : "string"

string

volumeRefToAction
optional

Example : {
"string" : "string"
}

< string, enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED) > map

successful
optional

Example : true

boolean

4.97. FirmwareUpgradeHealthCheckResult

Name Description Schema

storageDeviceId
required

Example : "string"

string

storageDeviceName
required

Example : "string"

string

storageDeviceWWN
required

Example : "string"

string

processingTimeMS
required

Example : "string"

string (int64)

rerun
required

Info about test run for internal use
Example : true

boolean

recommendedRecovery
required

Recommended recovery action for failures
Example : "string"

enum (noRecommendation, noAction, callSupport, recoveryGuru, waitLongLivedOps)

successful
required

Example : true

boolean

storageDeviceAccessible
required

Verify the storage-system is contactable.
Example : "StorageDeviceHealthCheck"

StorageDeviceHealthCheck

spmDatabaseVerification
required

Validate a database internal to the controller.
Example : "SpmDatabaseHealthCheck"

SpmDatabaseHealthCheck

configurationDatabaseCheck
required

Validate a database internal to the controller.
Example : "ConfigurationDbValidationCheck"

ConfigurationDbValidationCheck

objectGraphSyncCheck
required

Verify that ObjectGraph data is synchronized between the two controllers.
Example : "ObjectGraphSyncCheck"

ObjectGraphSyncCheck

volumeGroupsComplete
required

Verify there are no volume groups that are not in a full state of redundancy.
Example : "StorageDeviceHealthCheck"

StorageDeviceHealthCheck

controllerStatusOptimal
required

Verify the state of both controllers is optimal.
Example : "StorageDeviceHealthCheck"

StorageDeviceHealthCheck

hotSparesInUse
required

Verify that hot spares are not in use (due to drives in a non-optimal state).
Example : "StorageDeviceHealthCheck"

StorageDeviceHealthCheck

missingVolumes
required

Verify that there are no missing drives/volume-groups.
Example : "StorageDeviceHealthCheck"

StorageDeviceHealthCheck

driveCheck
required

Verify that at least one optimal drive is present
Example : "StorageDeviceHealthCheck"

StorageDeviceHealthCheck

exclusiveOperations
required

An upgrade operation cannot proceed if an exclusive operation is in progress on a volume. Examples: volume expansion, RAID type migration.
Example : "ExclusiveOperationCheck"

ExclusiveOperationCheck

failedDrivesPresent
required

Example : "StorageDeviceHealthCheck"

StorageDeviceHealthCheck

validPasswordSet
required

Example : "StorageDeviceHealthCheck"

StorageDeviceHealthCheck

melCheck
required

Example : "MelEventHealthCheck"

MelEventHealthCheck

integratedHealthCheck
required

Integrated tests not included in other health checks
Example : "IntegratedHealthCheck"

IntegratedHealthCheck

4.98. HealthCheckFailureResponse

Provided as a response when the operation failed because of a failure in the health check.

Name Description Schema

errorMessage
required

Example : "string"

string

localizedMessage
required

Example : "string"

string

retcode
required

The value of retcode can vary by the code type. To be unique, it must be combined with code type. It is a string. Even if the returned value looks like a number, don’t assume its a number. It is a short label that will not change based on Internationalization.
Example : "string"

string

codeType
required

Example : "string"

enum (symbol, systemerror, devicemgrerror)

invalidFieldsIfKnown
required

Example : [ "string" ]

< string > array

requestId
optional

Example : "string"

string (int64)

result
optional

Example : "CfwUpgradeResponse"

CfwUpgradeResponse

4.99. IntegratedHealthCheck

Name Description Schema

result
required

Example : "string"

enum (ok, notCompleted, failedDataRetrieval, failed)

type
required

Example : "string"

enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, integratedHealthCheck)

severityLevel
required

Example : "string"

enum (unknown, low, medium, high, fatal)

resultsData
required

Results data to diagnose failures
Example : "string"

string

healthCheckTests
required

List of tests from the integrated health check.
Example : [ "IntegratedHealthCheckTest" ]

< IntegratedHealthCheckTest > array

successful
optional

Example : true

boolean

4.100. IntegratedHealthCheckTest

Name Description Schema

testPassed
required

Test passed indicator.
Example : true

boolean

testName
required

Health check test name that was executed.
Example : "string"

string

resultsData
required

Results data from the test.
Example : "string"

string

4.101. MelEventHealthCheck

Name Description Schema

result
required

Example : "string"

enum (ok, notCompleted, failedDataRetrieval, failed)

type
required

Example : "string"

enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, integratedHealthCheck)

severityLevel
required

Example : "string"

enum (unknown, low, medium, high, fatal)

resultsData
required

Results data to diagnose failures
Example : "string"

string

warningMessages
required

Example : [ "string" ]

< string > array

successful
optional

Example : true

boolean

4.102. ObjectGraphSyncCheck

Name Description Schema

result
required

Example : "string"

enum (ok, notCompleted, failedDataRetrieval, failed)

type
required

Example : "string"

enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, integratedHealthCheck)

severityLevel
required

Example : "string"

enum (unknown, low, medium, high, fatal)

resultsData
required

Results data to diagnose failures
Example : "string"

string

cfwMatch
required

Example : true

boolean

nvsramMatch
required

Example : true

boolean

successful
optional

Example : true

boolean

4.103. SpmDatabaseHealthCheck

Name Description Schema

result
required

Example : "string"

enum (ok, notCompleted, failedDataRetrieval, failed)

type
required

Example : "string"

enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, integratedHealthCheck)

severityLevel
required

Example : "string"

enum (unknown, low, medium, high, fatal)

resultsData
required

Results data to diagnose failures
Example : "string"

string

failureMessages
optional

A description of the failure
Example : [ "string" ]

< string > array

successful
optional

Example : true

boolean

4.104. StorageDeviceHealthCheck

Name Description Schema

result
required

Example : "string"

enum (ok, notCompleted, failedDataRetrieval, failed)

type
required

Example : "string"

enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, integratedHealthCheck)

severityLevel
required

Example : "string"

enum (unknown, low, medium, high, fatal)

resultsData
required

Results data to diagnose failures
Example : "string"

string

successful
optional

Example : true

boolean

4.105. CfwUpgradeRequest

Run a controller firmware upgrade operation

Name Description Schema

cfwFile
optional

Example : "string"

string

nvsramFile
optional

Example : "string"

string

stageFirmware
optional

Default : false
Example : true

boolean

skipMelCheck
optional

Skip check of the MEL events for issues with the storage-system.
Default : false
Example : true

boolean

4.106. CfwActivationRequest

Name Description Schema

skipMelCheck
optional

Default : false
Example : true

boolean

4.107. StagedFirmwareResponse

Class that holds details on the Firmware staged on the array.

Name Description Schema

timeStamp
required

Timestamp when the staged FW was downloaded
Example : "string"

string (int64)

codeVersions
required

Version descriptors for staged code modules
Example : [ "VersionDescriptor" ]

< VersionDescriptor > array

4.108. VersionDescriptor

Name Description Schema

codeModule
required

The code module described
Example : "string"

enum (unspecified, raid, hypervisor, management, iom, nvsram, bundle, bundleDisplay, __UNDEFINED)

versionString
required

Textual representation of version
Example : "string"

string

4.109. ChannelPorts

Name Description Schema

speedDetError
required

This is set to true only if speed detection has failed.
Example : true

boolean

manuallyBypassed
required

This is set to true if the port is bypassed.
Example : true

boolean

portNumber
required

This is the ChannelPort port number, 1 based.
Example : "string"

enum (portUnknown, port1, port2, port3, port4, __UNDEFINED)

4.110. ComponentRemovalData

Name Description Schema

removalMethod
required

This enumeration defines the removal methods that apply to any component.
Example : "string"

enum (parent, self, __UNDEFINED)

rtrAttributes
optional

This field holds the component’s ready-to-remove attributes. It is only present when the removalMethod is equal to COMP_RMV_METHOD_REMOVE_SELF.
Example : "RTRAttributeData"

RTRAttributeData

4.111. Controller

Name Description Schema

active
required

True if the controller is in active mode; false otherwise.
Example : true

boolean

quiesced
required

True if the controller is quiesced.
Example : true

boolean

status
required

An indication of the current status of the controller.
Example : "string"

enum (unknown, optimal, failed, removed, rpaParErr, serviceMode, suspended, degraded, __UNDEFINED)

controllerRef
required

The identifier value for this controller. Other objects may use this reference value to refer to the controller.
Example : "string"

string

physicalLocation
required

The physical location of the controller. The parent reference in Location identifies the tray that physically houses the controller, and the position field is the parent-relative/like-component relative slot number of the controller, starting at one.
Example : "Location"

Location

manufacturer
required

The variable-length ASCII text string that identifies the controller manufacturer.
Example : "string"

string

manufacturerDate
required

The date of manufacture of the controller, represented in seconds since midnight GMT on January 1, 1970.
Example : "string"

string (int64)

appVersion
required

The version identification string for the application code that is running on the controller.
Example : "string"

string

bootVersion
required

The version identification string for the boot code that is running on the controller.
Example : "string"

string

productID
required

The variable-length ASCII text string that identifies the product by name, as assigned by the manufacturer.
Example : "string"

string

productRevLevel
required

The product revision level.
Example : "string"

string

serialNumber
required

The variable-length ASCII text string for the serial number of the controller.
Example : "string"

string

boardID
required

The variable-length ASCII text string that represents the board identifier (i.e. board type) of the controller.
Example : "string"

string

cacheMemorySize
required

The memory size, in MB, that will be used by the controller as cache memory.
Example : 0

integer (int32)

processorMemorySize
required

The size of the controller’s CPU memory, in MB.
Example : 0

integer (int32)

hostInterfaces
required

An array containing one entry for each host-side I/O interface that is present on the controller. A "host interface" is the controller’s means of accessing the host I/O channel; each host interface has a one-to-one relationship to a host channel. Although this array is indexed starting at zero, host channels in SYMbol are numbered starting at one. Host channels are numbered one through n per controller, without regard to different channel I/O protocols. Note that an interface may be physically present, but disabled for the particular controller model - in such a case, the corresponding channel is skipped over in the channel numbering.
Example : [ "IOInterfaceTypeData" ]

< IOInterfaceTypeData > array

driveInterfaces
required

An array containing one entry for each drive-side I/O interface that is present on the controller. A "drive interface" is the controller’s means of accessing the drive I/O channel. On the drive side, each channel is associated with two interfaces, one on each controller, giving each controller access to the same set of drive channels. Although this array is indexed starting at zero, drive channels can be numbered one through n, per storage array (not per controller).
Example : [ "IOInterfaceTypeData" ]

< IOInterfaceTypeData > array

netInterfaces
required

An array containing one entry for each network interface that is present on the controller.
Example : [ "NetInterfaceTypeData" ]

< NetInterfaceTypeData > array

inventory
required

This array of structures is deprecated.
Example : [ "InventoryItem" ]

< InventoryItem > array

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

hostBoardID
required

The board ID of the controller’s host card. This field is deprecated. The hostBoardId field in the HostBoard structure should be used instead.
Example : "string"

string

physicalCacheMemorySize
required

The physical cache memory size in MB
Example : 0

integer (int32)

readyToRemove
required

This is set to True if the component is ready to remove (and the Ready To Remove LED is on). This field is deprecated. The rtrAttributes field should be used instead.
Example : true

boolean

boardSubmodelID
required

The board sub-model ID of the controller card
Example : "string"

string

submodelSupported
required

Set to true if the sub-model feature is supported
Example : true

boolean

oemPartNumber
required

The OEM-specified part number of the controller canister
Example : "string"

string

partNumber
required

The part number of the controller board itself.
Example : "string"

string

rtrAttributes
required

The CRU type of the controller plus its ready-to-remove attributes, which are based on the CRU type.
Example : "RTRAttributes"

RTRAttributes

bootTime
required

The timestamp value for the time at which the controller last booted. Note that this value may be different for the other controller in the storage array. This value is defined as the number of seconds since midnight GMT on January 1, 1970.
Example : "string"

string (int64)

modelName
required

The model name associated with the controller. A model name is an identifier that is associated with each unique combination of base controller board and host interface card(s).
Example : "string"

string

networkSettings
required

A collection of network-related settings that apply to this controller.
Example : "ControllerNetworkSettings"

ControllerNetworkSettings

repairPolicy
required

The repair policy for the controller.
Example : "RepairPolicy"

RepairPolicy

flashCacheMemorySize
required

The total flash cache memory size (in GB) currently in use on the controller.
Example : 0

integer (int32)

ctrlIocDumpData
required

This structure contains information regarding the state of an IOC data dump – if it needs to be retrieved, and the tag and timestamp of the dump.
Example : "CtrlIOCDumpData"

CtrlIOCDumpData

locateInProgress
required

Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the tray.
Example : true

boolean

hasTrayIdentityIndicator
required

The device contains 7-segment indicators used to display the Tray Identity.
Example : true

boolean

controllerErrorMode
required

Indicates the error mode in which the controller is operating. A value of 0 indicates the controller is not operating in an error mode.
Example : "string"

enum (notInErrorMode, unknown, t10PiServiceMode, t10PiLockdown, __UNDEFINED)

codeVersions
required

Version descriptors for loaded code modules
Example : [ "VersionDescriptor" ]

< VersionDescriptor > array

id
optional

Example : "string"

string

4.112. ControllerDNSProperties

Name Description Schema

acquisitionProperties
required

DNS server acquisition properties
Example : "DnsAcquisitionDescriptor"

DnsAcquisitionDescriptor

dhcpAcquiredDnsServers
required

DNS servers provided by the DHCP responses. Will be non-empty only if at least one of the Controller’s network ports is set to acquire its address via DHCP and the DHCP response included one or more DNS servers to use. The presence of these servers does not imply their use. These DNS servers will only be used if the acquisition type is set to DHCP.
Example : [ "IpVxAddress" ]

< IpVxAddress > array

4.113. ControllerNTPProperties

Name Description Schema

acquisitionProperties
required

NTP server acquisition properties
Example : "NtpAcquisitionDescriptor"

NtpAcquisitionDescriptor

dhcpAcquiredNtpServers
required

NTP servers provided by the DHCP responses. Will be non-empty only if at least one of the Controller’s network ports is set to acquire its address via DHCP and the DHCP response included one or more NTP servers. The presence of these servers does not imply their use. These NTP servers will only be used if the NTP acquisition type is set to DHCP.
Example : [ "IpVxAddress" ]

< IpVxAddress > array

4.114. ControllerNetworkSettings

Name Description Schema

ipv4DefaultRouterAddress
required

The IPV4 static default router address for the controller (sometimes referred to as the "gateway address").
Example : "string"

string

ipv6DefaultRouterAddress
required

The IPV6 static default router address and associated data for the controller.
Example : "IpV6AddressData"

IpV6AddressData

ipv6CandidateDefaultRouterAddresses
required

The set of IPV6 candidate default router addresses for the controller.
Example : [ "IpV6AddressData" ]

< IpV6AddressData > array

remoteAccessEnabled
required

True if enabled for remote access
Example : true

boolean

dnsProperties
required

DNS configuration information.
Example : "ControllerDNSProperties"

ControllerDNSProperties

ntpProperties
required

NTP configuration information.
Example : "ControllerNTPProperties"

ControllerNTPProperties

4.115. CtrlIOCDumpData

Name Description Schema

iocDumpNeedsRetrieved
required

If true, an IOC Dump currently exists in controller memory and has not been retrieved.
Example : true

boolean

iocDumpTag
required

The tag value of the IOC Dump currently in controller memory. Each dump has a unique tag value. A value of IOC_DUMP_NULL_TAG indicates there is no IOC Dump to retrieve.
Example : 0

integer (int32)

timeStamp
required

The time that the dump was collected measured in seconds since midnight GMT on January 1, 1970.
Example : "string"

string (int64)

4.116. DnsAcquisitionDescriptor

Name Description Schema

dnsAcquisitionType
required

How the DNS addresses were acquired.
Example : "string"

enum (unknown, stat, dhcp, __UNDEFINED)

dnsServers
optional

This field is used if the method is set to DNS_ACQUISITION_METHOD_STATIC. If more than one address is specified, the first (lowest index) item is given highest precedence and the last item (highest index) is given the lowest precedence.
Example : [ "IpVxAddress" ]

< IpVxAddress > array

4.117. EthernetInterface

Name Description Schema

interfaceName
required

Name of the Ethernet port, as reported by the controller.
Example : "string"

string

channel
required

The channel number of this Ethernet interface.
Example : 0

integer (int32)

speed
required

The speed of the interface, as currently configured, in Mbit/sec.
Example : 0

integer (int32)

ip
required

The 32-bit IP protocol address assigned to the interface.
Example : 0

integer (int32)

alias
required

An ASCII string that identifies the alias name for the interface; this name is presumed to be associated with the IP protocol address.
Example : "string"

string

macAddr
required

An ASCII string representation of the globally-unique 48-bit MAC address assigned to the Ethernet interface.
Example : "string"

string

gatewayIp
required

IP address of the gateway.
Example : 0

integer (int32)

subnetMask
required

Network subnet mask.
Example : 0

integer (int32)

bootpUsed
required

Bootpserver used to get network parameters.
Example : true

boolean

rloginEnabled
required

True if rlogin sessions are allowed.
Example : true

boolean

reserved1
optional

Example : "string"

string

setupError
required

Set to true if there is a configuration error.
Example : true

boolean

reserved2
optional

Example : "string"

string

interfaceRef
required

The unique identifier for a given instance of this structure.
Example : "string"

string

linkStatus
required

The status of the network link for this interface.
Example : "string"

enum (none, up, down, failed, __UNDEFINED)

ipv4Enabled
required

True if IPV4 is enabled for this interface; otherwise false.
Example : true

boolean

ipv4Address
required

The IPV4 address for the interface.
Example : "string"

string

ipv4SubnetMask
required

The IPV4 subnet mask for the interface.
Example : "string"

string

ipv4AddressConfigMethod
required

The method by which the IPV4 address information is configured.
Example : "string"

enum (configDhcp, configStatic, __UNDEFINED)

ipv6Enabled
required

True if IPV6 is enabled for this interface; otherwise false.
Example : true

boolean

ipv6LocalAddress
required

The IPV6 local address for the interface and associated data.
Example : "IpV6AddressData"

IpV6AddressData

ipv6PortStaticRoutableAddress
required

The IPV6 static routable address for the interface and associated data.
Example : "IpV6AddressData"

IpV6AddressData

ipv6PortRoutableAddresses
required

The set of IPV6 port routable addresses for the interface.
Example : [ "IpV6AddressData" ]

< IpV6AddressData > array

ipv6AddressConfigMethod
required

The method by which the IPV6 address information is configured for the interface.
Example : "string"

enum (configStatic, configStateless, __UNDEFINED)

fullDuplex
required

If set to true, the interface is operating in full duplex mode; otherwise, it is operating in half-duplex mode.
Example : true

boolean

supportedSpeedSettings
required

Support speed setting for interface
Example : [ "string" ]

< enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED) > array

configuredSpeedSetting
required

Configured setting for the interface.
Example : "string"

enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED)

currentSpeed
required

Current speed of the interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

physicalLocation
required

The physical location of the Ethernet interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st ethernet interface relative to the parent," "2nd ethernet interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

4.118. EthernetInterfaceData

Name Description Schema

partData
required

Vendor-supplied about the physical part.
Example : "VendorPartData"

VendorPartData

macAddress
required

The Ethernet MAC address associated with the interface.
Example : "string"

string

fullDuplex
required

If set to true, the interface is operating in full duplex mode; otherwise, it is operating in half-duplex mode.
Example : true

boolean

maximumFramePayloadSize
required

The maximum size of the payload section in an Ethernet frame.
Example : 0

integer (int32)

currentInterfaceSpeed
required

The speed of the interface, as currently configured.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maximumInterfaceSpeed
required

The maximum speed supported by the interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

linkStatus
required

The status of the network link for this interface.
Example : "string"

enum (none, up, down, failed, __UNDEFINED)

supportedInterfaceSpeeds
required

A list of speeds supported by the Ethernet interface.
Example : [ "string" ]

< enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED) > array

autoconfigSupport
required

If set to true, autoconfiguration is supported.
Example : true

boolean

copperCableDiagnosticsSupport
required

If true, support is provided for copper cable diagnostics.
Example : true

boolean

4.119. FibreInterface

Name Description Schema

channel
required

The channel number of this interface.
Example : 0

integer (int32)

loopID
required

The FC loop ID value used by the controller on this channel.
Example : 0

integer (int32)

speed
required

The speed of the interface in MB/sec. This field is deprecated. The field currentInterfaceSpeed should be used instead.
Example : 0

integer (int32)

hardAddress
required

The hard (preferred) address of the interface, in loop ID format.
Example : 0

integer (int32)

nodeName
required

The unique identifier of the storage array node associated with this interface.
Example : "string"

string

portName
required

The unique identifier of the Fibre Channel port associated with this interface.
Example : "string"

string

portId
required

The NL_Port identifier assigned to this interface.
Example : "string"

string

topology
required

The Fibre Channel topology type being used.
Example : "string"

enum (unknown, ptp, fabric, arbLoop, fabLoop, __UNDEFINED)

part
required

An ASCII text string that describes the Fibre Channel controller chip type.
Example : "string"

string

revision
required

The revision level of the Fibre Channel controller chip.
Example : 0

integer (int32)

chanMiswire
required

True, if this channel is joined with another one.
Example : true

boolean

esmMiswire
required

True, if an ESM miswire condition exists somewhere on this channel.
Example : true

boolean

linkStatus
required

The status of the fibre channel link for this interface.
Example : "string"

enum (none, up, down, failed, __UNDEFINED)

isDegraded
required

True if the channel associated with this interface is degraded.
Example : true

boolean

speedControl
required

The speed of the interface in MB per sec. This field is deprecated. The fieldcurrentInterfaceSpeed should be used instead.
Example : "string"

enum (unknown, fixed, switched, auto, __UNDEFINED)

maxSpeed
required

The maximum speed in MB/s the interface can run. This field is deprecated. The field maximumInterfaceSpeed should be used instead.
Example : 0

integer (int32)

speedNegError
required

True if speed negotiation could not complete.
Example : true

boolean

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

ddsChannelState
required

The DDS state of this drive side channel: optimal, degraded, or failed.
Example : 0

integer (int32)

ddsStateReason
required

DDS state reason.
Example : 0

integer (int32)

ddsStateWho
required

Which controller placed the drive side channel in this DDS state.
Example : 0

integer (int32)

isLocal
required

Set to True if there are channel ports physically attached to this controller.
Example : true

boolean

channelPorts
required

Channel port speed information. This field is deprecated. The same information is available in the LinkSpeedDetectionError structure.
Example : [ "ChannelPorts" ]

< ChannelPorts > array

currentInterfaceSpeed
required

The current interface speed of the Fibre Channel interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maximumInterfaceSpeed
required

The maximum interface speed of the Fibre Channel interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

interfaceRef
required

The unique identifier for a given instance of this structure.
Example : "string"

string

physicalLocation
required

The physical location of the Fibre Channel interface. The parent reference in location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Fibre Channel interface relative to the parent," "2nd Fibre Channel interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

isTrunkCapable
required

This field is true if the Fibre interface on the controller board is trunk capable. This field is always false for host-side interfaces.
Example : true

boolean

trunkMiswire
required

True only when ESM is trunk capable and cabled incorrectly, or not trunk capable but connected in trunk mode.
Example : true

boolean

protectionInformationCapable
required

Example : true

boolean

oneWayMaxRate
required

Maximum one way data rate in B/s
Example : "string"

string (int64)

bidirectionalMaxRate
required

Maximum bi-directional data rate in B/s
Example : "string"

string (int64)

id
optional

Example : "string"

string

4.120. IOInterfaceTypeData

Name Description Schema

interfaceType
required

This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

fibre
optional

This field is present only if the interfaceType value is equal to IO_IF_FC. It contains the detailed interface information for a Fibre Channel I/O interface.
Example : "FibreInterface"

FibreInterface

ib
optional

This field is present only if the interfaceType value is equal to IO_IF_IB. It contains the detailed interface information for an Infiniband interface.
Example : "IbInterface"

IbInterface

iscsi
optional

This field is present only if the interface type value is equal to IO_IF_ISCSI. It contains the detailed interface information for an iSCSI I/O interface.
Example : "IscsiInterface"

IscsiInterface

sas
optional

This field is present only if the interfaceType value is equal to IO_IF_SAS. It contains the detailed interface information for a serial-attached SCSI I/O interface.
Example : "SasInterface"

SasInterface

sata
optional

This field is present only if the interfaceType value is equal to IO_IF_SATA. It contains the detailed interface information for a SATA I/O interface.
Example : "SATAInterface"

SATAInterface

scsi
optional

This field is present only if the interfaceType value is equal to IO_IF_SCSI. It contains the detailed interface information for a SCSI I/O interface.
Example : "SCSIInterface"

SCSIInterface

4.121. IbInterface

Name Description Schema

interfaceRef
required

The opaque data by which an instance of IbInterface is uniquely identified.
Example : "string"

string

channel
required

The number of the host channel associated with this interface.
Example : 0

integer (int32)

channelPortRef
required

A reference to the channel port for the channel associated with this interface.
Example : "string"

string

localIdentifier
required

The InfiniBand local identifier associated with this interface.
Example : 0

integer (int32)

globalIdentifier
required

The InfiniBand global identifier associated with this interface.
Example : "string"

string

linkState
required

The state of the InfiniBand link.
Example : "string"

enum (initialize, linkArm, active, defer, down, __UNDEFINED)

portState
required

The state of the InfiniBand port.
Example : "string"

enum (unknown, initialize, arm, active, defer, down, __UNDEFINED)

maximumTransmissionUnit
required

The size in bytes of the largest packet that the interface can transmit.
Example : 0

integer (int32)

currentSpeed
required

The speed at which the interface is currently operating.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

supportedSpeed
required

An array containing the different speeds at which the interface is capable of operating.
Example : [ "string" ]

< enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED) > array

currentLinkWidth
required

The width at which the link is currently operating, e.g., 1 means "1X," 4 means "4X,".etc.
Example : "string"

enum (width1x, width4x, width8x, width12x, __UNDEFINED)

supportedLinkWidth
required

An array containing the different link widths at which the link is capable of operating.
Example : [ "string" ]

< enum (width1x, width4x, width8x, width12x, __UNDEFINED) > array

currentDataVirtualLanes
required

The number of data virtual lanes that are currently active for this interface.
Example : 0

integer (int32)

maximumDataVirtualLanes
required

The maximum number of data virtual lanes supported by the interface.
Example : 0

integer (int32)

physicalLocation
required

The physical location of the Infiniband interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Infiniband interface relative to the parent," "2nd Infiniband interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

protectionInformationCapable
required

This field indicates whether or not the I/O interface is PI capable.
Example : true

boolean

isSRPSupported
required

This flag is true if SRP (SCSI RDMA Protocol) is currently supported.
Example : true

boolean

isISERSupported
required

This flag is true if iSER (iSCSI Extensions for RDMA) is currently supported.
Example : true

boolean

physPortState
required

This element contains the current state of the physical Infiniband port.
Example : "string"

enum (unknown, sleep, polling, disabled, cfgTrain, linkUp, linkErrRec, phyTest, __UNDEFINED)

oneWayMaxRate
required

Maximum one way data rate in B/s
Example : "string"

string (int64)

bidirectionalMaxRate
required

Maximum bi-directional data rate in B/s
Example : "string"

string (int64)

isNVMeSupported
required

Indicates if the interface is configured to support NVMe over Fabrics protocol
Example : true

boolean

id
optional

Example : "string"

string

4.122. InfinibandInterfaceData

Name Description Schema

isIser
required

If true, iSER (iSCSI Extensions for RDMA) is active and a corresponding IBInterface object exists
Example : true

boolean

4.123. InternetProtocolV4Data

Name Description Schema

ipv4Address
required

The various IPV4 address-related elements (IP address, gateway IP address, and subnet mask), along with the state of their configuration.
Example : "string"

string

ipv4AddressConfigMethod
required

IPV4 configuration method for the endpoint; always STATIC for iSER interfaces.
Example : "string"

enum (configDhcp, configStatic, __UNDEFINED)

ipv4OutboundPacketPriority
required

Priority associate with outbound IPV4 packets; always disabled for iSER interfaces.
Example : "SettingControl"

SettingControl

ipv4VlanId
required

Value of IPV4 VLAN id for the interface; always disabled for iSER interfaces.
Example : "SettingControl"

SettingControl

ipv4AddressData
required

The various IPV4 address-related elements (IP address, gateway IP address, and subnet mask), along with the state of their configuration.
Example : "IpV4AddressData"

IpV4AddressData

4.124. InternetProtocolV6Data

Name Description Schema

ipv6LocalAddresses
required

The set of IPV6 local addresses that have been assigned to the iSCSI Ethernet port.
Example : [ "IpV6AddressData" ]

< IpV6AddressData > array

ipv6RoutableAddresses
required

The set of IPV6 routable addresses that have been assigned to the iSCSI Ethernet port
Example : [ "IpV6AddressData" ]

< IpV6AddressData > array

ipv6PortRouterAddress
required

The IPV6 address of the port router.
Example : "IpV6AddressData"

IpV6AddressData

ipv6AddressConfigMethod
required

The method by which the IPV6 address information is configured for the endpoint.
Example : "string"

enum (configStatic, configStateless, __UNDEFINED)

ipv6OutboundPacketPriority
required

Settings that govern the priority to associate with outbound IPV6 packets sent over the interface
Example : "SettingControl"

SettingControl

ipv6VlanId
required

Settings that govern the value of the IPV6 VLAN identifier for the interface. VLAN identifiers are in the range 1 through 4094.
Example : "SettingControl"

SettingControl

ipv6HopLimit
required

The hop limit to use in IPV6 packets sent over the interface.
Example : 0

integer (int32)

ipv6NdReachableTime
required

A "neighbor discovery" parameter - the amount of time in milliseconds, within which a neighbor is assumed to be reachable.
Example : 0

integer (int32)

ipv6NdRetransmitTime
required

A "neighbor discovery" parameter - the number of milliseconds between neighbor solicitation probes.
Example : 0

integer (int32)

ipv6NdStaleTimeout
required

A "neighbor discovery" parameter - the time in milliseconds after which information for a neighbor that cannot be verified as reachable will be considered "stale."
Example : 0

integer (int32)

ipv6DuplicateAddressDetectionAttempts
required

The number of neighbor-solicitation messages to send in trying to determine IP address uniqueness.
Example : 0

integer (int32)

4.125. InventoryItem

Name Description Schema

itemName
required

An ASCII string that provides the symbolic name of the item.
Example : "string"

string

itemVersion
required

An ASCII string that represents the current version, or revision level, of the item.
Example : "string"

string

4.126. IpV4AddressData

Name Description Schema

configState
required

Configuration state for the various address elements; always IP_CONFIG_STATE_CONFIGURED for iSER interfaces.
Example : "string"

enum (unconfigured, acquiring, configured, invalid, __UNDEFINED)

ipv4Address
required

The IPV4 address associated with the endpoint.
Example : "string"

string

ipv4SubnetMask
required

IPV4 subnet mask associated w/ the endpoint; used for iSER interfaces.
Example : "string"

string

ipv4GatewayAddress
required

IPV4 gateway address associated w/ the endpoint; used for iSER interfaces.
Example : "string"

string

4.127. IpV6AddressData

Name Description Schema

address
required

The IPV6 address.
Example : "string"

string

addressState
required

The state of the IPV6 address.
Example : "IpV6AddressState"

IpV6AddressState

4.128. IpV6AddressState

Name Description Schema

addressType
required

This enumeration defines the two different types of IPV6 addresses - interface or router.
Example : "string"

enum (typeInterface, typeRouter, __UNDEFINED)

interfaceAddressState
optional

The interface address state. This field is only valid if addressType is equal to IPV6_ADDR_TYPE_INTERFACE.
Example : "string"

enum (unconfigured, acquiring, configured, invalid, __UNDEFINED)

routerAddressState
optional

The router address state. This field is only valid if addressType is equal to IPV6_ADDR_TYPE_ROUTER.
Example : "string"

enum (unknown, configured, advertised, stale, __UNDEFINED)

4.129. IscsiInterface

Name Description Schema

channel
required

The number of the channel controlled by this interface.
Example : 0

integer (int32)

channelPortRef
required

A reference to the channel port object associated with the channel controlled by this interface.
Example : "string"

string

tcpListenPort
required

The number of the TCP port on which the target listens for incoming connections.
Example : 0

integer (int32)

ipv4Enabled
required

True if IPV4 is enabled for this interface; always true for iSER interface.
Example : true

boolean

ipv4Data
required

IPV4-related information for the interface.
Example : "InternetProtocolV4Data"

InternetProtocolV4Data

interfaceData
required

Information about the physical interface (e.g., Ethernet).
Example : "PhysicalInterfaceTypeData"

PhysicalInterfaceTypeData

interfaceRef
required

The unique identifier for a given instance of this structure.
Example : "string"

string

ipv6Enabled
required

True if IPV6 is enabled for this interface; otherwise false.
Example : true

boolean

ipv6Data
required

IPV6-related information for the interface.
Example : "InternetProtocolV6Data"

InternetProtocolV6Data

physicalLocation
required

The physical location of the iSCSI interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st iSCSI interface relative to the parent," "2nd iSCSI interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

protectionInformationCapable
required

This field indicates whether or not the I/O interface is PI capable.
Example : true

boolean

isIPv6Capable
required

This flag is true if the interface is capable of IPv6 functionality.
Example : true

boolean

oneWayMaxRate
required

Maximum one way data rate in B/s
Example : "string"

string (int64)

bidirectionalMaxRate
required

Maximum bi-directional data rate in B/s
Example : "string"

string (int64)

id
optional

Example : "string"

string

4.130. Location

Name Description Schema

trayRef
required

The TrayRef reference value of the tray object in which the component resides.
Example : "string"

string

slot
required

The slot identifier, or ordinal identifier, of the component within its physical tray.
Example : 0

integer (int32)

locationParent
required

An object reference that identifies the parent physical component (e.g., Tray, CRU, etc.) of the object containing the Location attribute.
Example : "ObjectReference"

ObjectReference

locationPosition
required

The parent-relative/like-component relative position of the object containing the Location attribute.
Example : 0

integer (int32)

label
required

Label associated with the location (i.e., label printed on the canister or the enclosure).
Example : "string"

string

4.131. NetInterfaceTypeData

Name Description Schema

interfaceType
required

This enumeration defines the different network interface types that may be reported as part of the interface information associated with a controller.
Example : "string"

enum (ethernet, __UNDEFINED)

ethernet
optional

This field is present only if the interfaceType value is equal to NET_IF_ETHERNET. It contains the detailed interface information for an Ethernet network interface.
Example : "EthernetInterface"

EthernetInterface

4.132. NetworkAddress

Name Description Schema

addrType
required

This enum defines the possible network address types.
Example : "string"

enum (none, domainName, ipvx, __UNDEFINED)

domainName
optional

Fully qualified domain name. This should be considered an IDN-unaware domain name slot as per RFC3490.
Example : "string"

string

ipvxAddress
optional

IPv4 or IPv6 address
Example : "IpVxAddress"

IpVxAddress

4.133. NtpAcquisitionDescriptor

Name Description Schema

ntpAcquisitionType
required

How the NTP server addresses are acquired.
Example : "string"

enum (unknown, stat, dhcp, disabled, __UNDEFINED)

ntpServers
optional

This field is used if the method is set to NTP_ACQUISITION_METHOD_STATIC. If more than one address is specified, the first (lowest index) item is given highest precedence and the last item (highest index) is given the lowest precedence.
Example : [ "NetworkAddress" ]

< NetworkAddress > array

4.134. ObjectReference

Name Description Schema

refType
required

This enumeration identifies the different types of object references.
Example : "string"

enum (generic, controller, genericTyped, __UNDEFINED)

controllerRef
optional

A ControllerRef that refers to the object. Controllers are identified separately from other SYMbol objects because their refs require special handling by the firmware. This field is only valid if refType is equal to OBJ_REF_CONTROLLER.
Example : "string"

string

symbolRef
optional

A SYMbolRef that refers to the object. All non-controller objects can be identified by an untyped SYMbol reference. This field is only present if refType is equal to OBJ_REF_GENERIC.
Example : "string"

string

typedReference
optional

A reference to a SYMbol object that includes object type information. This value is only present if the discriminator refType is set to OBJ_REF_GENERIC_TYPED.
Example : "TypedSYMbolReference"

TypedSYMbolReference

4.135. ParentCru

Name Description Schema

type
required

This enumeration object is used to specify the type of reference that is contained in a ParentCru union.
Example : "string"

enum (controller, esm, fan, iccCru, supportCru, drawer, __UNDEFINED)

parentController
optional

This field contains a reference to the parent controller. It is only valid if the type field is equal to PARENT_CRU_TYPE_CONTROLLER.
Example : "string"

string

parentEsm
optional

This field contains a reference to the parent ESM. It is only valid if the type field is equal to PARENT_CRU_TYPE_ESM.
Example : "string"

string

parentFan
optional

This field contains a reference to the parent Fan. It is only valid if the type field is equal to PARENT_CRU_TYPE_FAN.
Example : "string"

string

parentInterconnectCru
optional

This field contains a reference to the parent interconnect CRU. It is only valid if the type field is equal to PARENT_CRU_TYPE_ICC_CRU.
Example : "string"

string

parentSupportCru
optional

This field contains a reference to the parent support CRU. It is only valid if the type field is equal to PARENT_CRU_TYPE_SUPPORT_CRU.
Example : "string"

string

parentDrawer
optional

This field contains a reference to the parent drawer. It is only valid if the type field is equal to PARENT_CRU_TYPE_DRAWER.
Example : "string"

string

4.136. PhysicalInterfaceTypeData

Name Description Schema

type
required

This enumeration object is used to indicate the physical type of an I/O interface, in contrast to the logical protocol used by the interface (iSCSI is a logical protocol; Ethernet is a physical interface).
Example : "string"

enum (unknown, ethernet, infiniband, __UNDEFINED)

ethernetData
optional

This field contains information about an Ethernet physical interface It is only present if the type field is equal to PHYSICAL_INTERFACE_ETHERNET.
Example : "EthernetInterfaceData"

EthernetInterfaceData

infinibandData
optional

This field indicates iSCSI/iSER interface.
Example : "InfinibandInterfaceData"

InfinibandInterfaceData

4.137. RTRAttributeData

Name Description Schema

hasReadyToRemoveIndicator
required

True if the component has a ready-to-remove LED.
Example : true

boolean

readyToRemove
required

True if the component is ready to remove.
Example : true

boolean

4.138. RTRAttributes

Name Description Schema

cruType
required

This enumeration identifies the type of CRU a component has.
Example : "string"

enum (unknown, dedicated, shared, aggregate, __UNDEFINED)

parentCru
optional

This field identifies the CRU that is the parent of this component, i.e., the CRU that it is sharing with other components. It is only present when the cruType field is set to CRU_TYPE_AGGREGATE.
Example : "ParentCru"

ParentCru

rtrAttributeData
optional

This field contains the actual settings for the ready-to-remove data. It is only present when the cruType field is set to CRU_TYPE_DEDICATED.
Example : "RTRAttributeData"

RTRAttributeData

4.139. RepairPolicy

Name Description Schema

removalData
required

This field contains the removal data for the component. This primary piece of data is a removal method. Additional "ready-to-remove" attributes may be defined, depending on the removal method.
Example : "ComponentRemovalData"

ComponentRemovalData

replacementMethod
required

This field defines the "replacement method" for the component.
Example : "string"

enum (parent, self, __UNDEFINED)

4.140. SATAInterface

Name Description Schema

channel
required

The channel number of this channel
Example : 0

integer (int32)

currentInterfaceSpeed
required

The current interface speed of the SATA interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maximumInterfaceSpeed
required

The maximum interface speed of the SATA interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

speedControl
required

An indicator of how the device speed is controlled.
Example : "string"

enum (unknown, fixed, switched, auto, __UNDEFINED)

part
required

A string indicating the chip type.
Example : "string"

string

revision
required

The revision level of the SATA part.
Example : 0

integer (int32)

interfaceRef
required

The unique identifier for a given instance of this structure.
Example : "string"

string

physicalLocation
required

The physical location of the SATA interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st SATA interface relative to the parent," "2nd SATA interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

protectionInformationCapable
required

This field indicates whether or not the I/O interface is PI capable.
Example : true

boolean

id
optional

Example : "string"

string

4.141. SCSIInterface

Name Description Schema

channel
required

The channel number of this interface.
Example : 0

integer (int32)

scsiID
required

The SCSI ID value used by the controller on this interface.
Example : 0

integer (int32)

speed
required

The speed of the interface in MB/sec.
Example : 0

integer (int32)

scsiType
required

The type of SCSI line driver (e.g. SE, LVD, etc.) being used.
Example : "string"

enum (se, hvd, lvd, __UNDEFINED)

width
required

The transfer width of the SCSI bus, in bits.
Example : 0

integer (int32)

part
required

An ASCII text string that describes the SCSI controller chip type.
Example : "string"

string

revision
required

The revision level of the SCSI controller chip.
Example : 0

integer (int32)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

4.142. SasAttachedDevice

Name Description Schema

channel
required

The number of the channel where the SAS-attached device is located.
Example : 0

integer (int32)

channelType
required

An indication of which "side" the channel is on - host or drive.
Example : "string"

enum (hostside, driveside, management, __UNDEFINED)

sasAttachedDeviceData
required

This field contains information that explicitly identifies the SAS-attached device.
Example : "SasAttachedDeviceTypeData"

SasAttachedDeviceTypeData

4.143. SasAttachedDeviceTypeData

Name Description Schema

type
required

This enumeration specifies the different kinds of devices that may be attached to a SAS port.
Example : "string"

enum (unknown, drive, expander, localController, alternateController, host, __UNDEFINED)

alternateController
optional

A reference to the alternate controller that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_ALTERNATE_CONTROLLER.
Example : "string"

string

drive
optional

A reference to a drive that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_DRIVE.
Example : "string"

string

expander
optional

A reference to the SAS expander that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_EXPANDER.
Example : "string"

string

remoteHostPortAddress
optional

The SAS address of the port in the host computer that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_HOST.
Example : "string"

string

localController
optional

A reference to the local controller that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_LOCAL_CONTROLLER.
Example : "string"

string

physicalLocation
optional

The tray-slot location of a device of unknown type. This field is only present if type equals SAS_ATTACHED_DEV_UNKNOWN.
Example : "Location"

Location

4.144. SasInterface

Name Description Schema

channel
required

The number of the channel corresponding to this interface.
Example : 0

integer (int32)

currentInterfaceSpeed
required

The current interface speed of the SAS interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maximumInterfaceSpeed
required

The maximum interface speed of the SAS interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

part
required

A string indicating the chip type.
Example : "string"

string

revision
required

The revision level of the firmware on the SAS I/O controller.
Example : 0

integer (int32)

isDegraded
required

True if the channel corresponding to this interface is degraded.
Example : true

boolean

iocPort
required

Information about the SAS I/O controller port corresponding to this interface.
Example : "SasPort"

SasPort

interfaceRef
required

The unique identifier for a given instance of this structure.
Example : "string"

string

physicalLocation
required

The physical location of the SAS interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st SAS interface relative to the parent," "2nd SAS interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

protectionInformationCapable
required

This field indicates whether or not the I/O interface is PI capable.
Example : true

boolean

oneWayMaxRate
required

Maximum one way data rate in B/s
Example : "string"

string (int64)

bidirectionalMaxRate
required

Maximum bi-directional data rate in B/s
Example : "string"

string (int64)

id
optional

Example : "string"

string

4.145. SasPhy

Name Description Schema

phyIdentifier
required

A number in the range 0-127 that is the PHY identifier.
Example : 0

integer (int32)

isOperational
required

True if the PHY is capable of normal operation.
Example : true

boolean

4.146. SasPort

Name Description Schema

parent
required

The device on which the port resides.
Example : "SasPortProviderDevice"

SasPortProviderDevice

attachedDevice
required

An indication of what device is attached to this port.
Example : "SasAttachedDevice"

SasAttachedDevice

state
required

The state of the SAS port.
Example : "string"

enum (unknown, optimal, degraded, failed, __UNDEFINED)

miswireType
required

The type of miswire involving this port (or "none").
Example : "string"

enum (none, topology, ctlrHostPort, ctlrDrivePortToHost, esm, ctlrDrivePortToEndDevice, __UNDEFINED)

channelPortRef
required

A reference to the channel port object identifying the external connector associated with this port. If the port is not associated with an external connector, then this field is set to a null SYMbol ref.
Example : "string"

string

sasPhys
required

A list of PHYs associated with this port.
Example : [ "SasPhy" ]

< SasPhy > array

portTypeData
required

Information about a SAS port that is type-dependent.
Example : "SasPortTypeData"

SasPortTypeData

portMode
required

The SAS port connection mode.
Example : "string"

enum (unknown, internal, externalIn, externalOut, endDevice, open, __UNDEFINED)

domainNumber
required

The domain number identifies which SAS domain this element is a part of. Domain numbers are arbitrarily assigned by the firmware and are consistent on a per controller basis – but not across controllers. So, the contents of domains will be consistent across controllers but the number identifying a particular domain may not be.
Example : 0

integer (int32)

attachedChannelPortRef
required

This ref identifies the connector on the attached device for a drive channel who’s external port is connected to another device.
Example : "string"

string

discoveryStatus
required

This element contains the status of the SAS discovery - the status is a bit field and could indicate a successful discovery or could indicate one or more failure conditions (indicated by one or more error flags being set).
Example : 0

integer (int32)

4.147. SasPortProviderDevice

Name Description Schema

type
required

This enumeration object is used to identify the specific type of "port provider" device.
Example : "string"

enum (controller, drive, expander, hostboard, __UNDEFINED)

controller
optional

A reference to a controller that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_CONTROLLER.
Example : "string"

string

drive
optional

A reference to a drive that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_DRIVE.
Example : "string"

string

expander
optional

A reference to a SAS expander that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_EXPANDER.
Example : "string"

string

hostBoardRef
optional

A reference to a SAS host board that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_HOSTBOARD.
Example : "string"

string

4.148. SasPortTypeData

Name Description Schema

portType
required

This enumeration specifies the different types of SAS ports.
Example : "string"

enum (endDevice, expander, __UNDEFINED)

portIdentifier
optional

This field is the SAS address that is the port identifier. It is present only if the portType value is equal to SAS_PORT_TYPE_END_DEVICE.
Example : "string"

string

routingType
optional

This field indicates the routing method used on this port. It is present only if the portType value is equal to SAS_PORT_TYPE_EXPANDER.
Example : "string"

enum (direct, table, subtractive, __UNDEFINED)

4.149. SettingControl

Name Description Schema

isEnabled
required

True when the property is enabled.
Example : true

boolean

value
required

The value of the property
Example : 0

integer (int32)

4.150. TypedSYMbolReference

Name Description Schema

componentType
required

An enumeration value indicating the type of component that the reference refers to.
Example : "string"

enum (unknown, fan, battery, powerSupply, thermalSensor, esm, ups, minihub, gbic, sfp, interconnectCru, supportCru, alarm, hostboard, icSasExpander, hostIoCard, cacheBackupDevice, cacheMemDimm, procMemDimm, channelPort, drive, controller, ethernetInterface, fibreInterface, ibInterface, iscsiInterface, sasInterface, tray, storageArray, drawer, __UNDEFINED)

symbolRef
required

A SYMbol reference that refers to an instance of an object of the type identified by componentType. If the component type is "storage array," this field is a null reference. This is because an object graph describes a single instance of a storage array, so there is no need to uniquely identify instances.
Example : "string"

string

4.151. VendorPartData

Name Description Schema

vendorName
required

The name of the vendor.
Example : "string"

string

partNumber
required

The part number.
Example : "string"

string

revisionNumber
required

The part revision number.
Example : "string"

string

serialNumber
required

The part serial number.
Example : "string"

string

4.152. ControllerStats

Controller I/O performance statistics.

Name Description Schema

observedTime
required

End time for this collection as measured by the number of seconds since baseTime.
Example : "string"

string (date-time)

observedTimeInMS
required

Example : "string"

string (int64)

lastResetTime
required

Example : "string"

string (date-time)

lastResetTimeInMS
required

Example : "string"

string (int64)

controllerId
required

Controller that generated this group.
Example : "string"

string

arrayId
required

Example : "string"

string

arrayWwn
required

Example : "string"

string

cpuUtilizationStats
required

CPU utilization statistics structure.
Example : [ "CpuUtilizationStats" ]

< CpuUtilizationStats > array

totalIopsServiced
required

Total number of IO operations serviced by the controller.
Example : 0.0

number (double)

totalBytesServiced
required

Total number of Bytes serviced by the controller.
Example : 0.0

number (double)

cacheHitsIopsTotal
required

Total number of IO operations that hit cache.
Example : 0.0

number (double)

cacheHitsBytesTotal
required

Total number of bytes that hit cache.
Example : 0.0

number (double)

randomIosTotal
required

Total number of IOs that are categorized as random.
Example : 0.0

number (double)

randomBytesTotal
required

Total number of Bytes that are categorized as random.
Example : 0.0

number (double)

readIopsTotal
required

Total number of Read IO operations.
Example : 0.0

number (double)

readBytesTotal
required

Total number of Bytes read.
Example : 0.0

number (double)

writeIopsTotal
required

Total number of Write IO operations.
Example : 0.0

number (double)

writeBytesTotal
required

Total number of Bytes written.
Example : 0.0

number (double)

mirrorIopsTotal
required

Total number of IO operations serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value.
Example : 0.0

number (double)

mirrorBytesTotal
required

Total number of Bytes serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value.
Example : 0.0

number (double)

fullStripeWritesBytes
required

Bytes written that are categorized as Full stripe writes.
Example : 0.0

number (double)

raid0BytesTransferred
required

Bytes transferred that are categorized as RAID 0 transfers.
Example : 0.0

number (double)

raid1BytesTransferred
required

Bytes transferred that are categorized as RAID 1 transfers.
Example : 0.0

number (double)

raid5BytesTransferred
required

Bytes transferred that are categorized as RAID 5 transfers.
Example : 0.0

number (double)

raid6BytesTransferred
required

Bytes transferred that are categorized as RAID 6 transfers.
Example : 0.0

number (double)

ddpBytesTransferred
required

Bytes transferred that are categorized as DDP transfers.
Example : 0.0

number (double)

maxPossibleBpsUnderCurrentLoad
required

Theoretical maximum possible Bytes per second under current load.
Example : 0.0

number (double)

maxPossibleIopsUnderCurrentLoad
required

Theoretical maximum possible IO per second under current load.
Example : 0.0

number (double)

4.153. CpuUtilizationStats

Name Description Schema

maxCpuUtilization
required

Max utilization stats value from CPU.
Example : 0

integer (int32)

sumCpuUtilization
required

Sum of utilization stats values from CPU.
Example : 0

integer (int32)

ssqCpuUtilization
required

Sum of squares of utilization stats values from CPU.
Example : 0

integer (int32)

4.154. DPLCoreDumpData

Name Description Schema

dplCoreDumpTag
required

The tag value of the DPL core dump currently in controller memory. Each core dump has a unique tag value. A value of DPL_CORE_DUMP_NULL_TAG indicates there is no DPL core dump to retrieve.
Example : 0

integer (int32)

dplCoreDumpNeedsRetrieved
required

If true, a DPL core dump currently exists in controller memory and has not been retrieved.
Example : true

boolean

dplCoreDumpEnabled
required

If true, DPL Core Dump is enabled in the controller.
Example : true

boolean

timeStamp
required

The time that the core dump was collected measured in seconds since midnight GMT on January 1, 1970.
Example : "string"

string (int64)

4.155. DeviceAlertConfiguration

API object that includes information about the Alert configuration for the system.

Name Description Schema

alertingEnabled
required

Alerting is enabled
Example : true

boolean

emailServerAddress
required

The Alert email server address
Example : "string"

string

emailSenderAddress
required

The Alert email senders address
Example : "string"

string

sendAdditionalContactInformation
required

Flag to send additional contact information with emails
Example : true

boolean

additionalContactInformation
required

Alert email additional contact information
Example : "string"

string

recipientEmailAddresses
required

Alert email recipient addresses
Example : [ "string" ]

< string > array

4.156. DeviceAlertTestResponse

Name Description Schema

response
required

Alert email test result code
Example : "string"

enum (emailSentOK, invalidEmailServerConfigured, invalidEmailSenderAddressConfigured, invalidRecipientAddressConfigured, smtpConnectionError, smtpTransportError, smtpUnknownError)

emailSendErrorString
required

Alert email error string
Example : "string"

string

4.157. DeviceAsupDelivery

Name Description Schema

method
required

ASUP delivery method
Example : "string"

enum (https, http, smtp)

routingType
optional

ASUP routing type
Example : "string"

enum (none, direct, proxyServer, proxyScript)

proxyHost
optional

ASUP proxy host
Example : "string"

string

proxyPort
optional

ASUP proxy port
Example : 0

integer (int32)

proxyUserName
optional

ASUP proxy user name
Example : "string"

string

proxyPassword
optional

ASUP proxy password
Example : "string"

string

proxyScript
optional

ASUP proxy PAC script
Example : "string"

string

mailRelayServer
optional

ASUP e-mail relay server
Example : "string"

string

mailSenderAddress
optional

ASUP e-mail sender address
Example : "string"

string

4.158. DeviceAsupResponse

API response object that includes basic information about storage system ASUP.

Name Description Schema

asupCapable
required

AutoSupport is supported
Example : true

boolean

onDemandCapable
required

AutoSupport OnDemand is supported
Example : true

boolean

asupEnabled
required

AutoSupport is enabled or disabled
Example : true

boolean

onDemandEnabled
required

ASUP OnDemand is enabled or disabled
Example : true

boolean

remoteDiagsEnabled
required

ASUP RemoteDiags is enabled or disabled
Example : true

boolean

delivery
required

ASUP delivery configuration
Example : "DeviceAsupDelivery"

DeviceAsupDelivery

destinationAddress
required

ASUP destination address
Example : "string"

string

schedule
required

ASUP schedule configuration
Example : "DeviceAsupSchedule"

DeviceAsupSchedule

4.159. DeviceAsupSchedule

Name Description Schema

dailyMinTime
required

ASUP daily minimum time
Example : 0

integer (int32)

dailyMaxTime
required

ASUP daily maximum time
Example : 0

integer (int32)

weeklyMinTime
required

ASUP weekly minimum time
Example : 0

integer (int32)

weeklyMaxTime
required

ASUP weekly maximum time
Example : 0

integer (int32)

daysOfWeek
required

ASUP days of week
Example : [ "string" ]

< enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED) > array

4.160. DeviceAsupUpdateRequest

Used to update asup settings.

Name Description Schema

asupEnabled
optional

AutoSupoprt enabled or disabled
Example : true

boolean

onDemandEnabled
optional

ASUP OnDemand is enabled or disabled
Example : true

boolean

remoteDiagsEnabled
optional

ASUP RemoteDiags is enabled or disabled
Example : true

boolean

delivery
optional

ASUP delivery configuration
Example : "DeviceAsupDelivery"

DeviceAsupDelivery

schedule
optional

ASUP schedule configuration
Example : "DeviceAsupSchedule"

DeviceAsupSchedule

4.161. DeviceAsupDevice

API response object that includes ASUP information for a storage device.

Name Description Schema

wwn
required

Device’s world-wide-name
Example : "string"

string

name
required

Device’s name
Example : "string"

string

asupCapable
required

ASUP capable
Example : true

boolean

asupEnabled
required

ASUP enabled
Example : true

boolean

onDemandCapable
required

ASUP OnDemand capable
Example : true

boolean

scheduled
required

Device has ASUP daily/weekly schedule
Example : true

boolean

dailyScheduleTime
required

ASUP daily scheduled time
Example : 0

integer (int32)

weeklyScheduleTime
required

ASUP weekly scheduled time
Example : 0

integer (int32)

weeklyDayOfWeek
required

ASUP weekly scheduled day of week
Example : "string"

enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED)

4.162. FileInfo

Name Description Schema

fileSize
required

Example : "string"

string (int64)

fileName
required

Example : "string"

string

4.163. DeviceAsupVerifyResponse

Used to return resuls of ASUP settings verification.

Name Description Schema

successful
optional

Indicates if verification was successful
Example : true

boolean

errorMessage
optional

Error message if verification failed
Example : "string"

string

aodAttempted
optional

Indicates if AOD verification was attempted
Example : true

boolean

aodSuccessful
optional

Indicates if AOD verification was successful
Example : true

boolean

aodErrorMessage
optional

Error message if AOD verification failed
Example : "string"

string

4.164. DeviceAsupVerifyRequest

Used to verify ASUP settings.

Name Description Schema

delivery
required

ASUP delivery configuration
Example : "DeviceAsupDelivery"

DeviceAsupDelivery

mailReplyAddress
optional

E-Mail reply address for SMTP
Example : "string"

string

4.165. AsupMaintenanceWindowResponse

Name Description Schema

emailAddresses
required

The list of email addresses to send confirmation the AutoSupport backend processed the configuration request
Example : [ "string" ]

< string > array

duration
optional

The duration in hours to enable AutoSupport the maintenance window (if not provided, the maximum supported duration will be used)
Example : 0

integer (int32)

maintenanceWindowEnabled
optional

Example : true

boolean

4.166. AsupMaintenanceWindowRequest

Name Description Schema

emailAddresses
required

The list of email addresses to send confirmation the AutoSupport backend processed the configuration request. The maximum number of email addresses allowed is limited to 5.
Example : [ "string" ]

< string > array

duration
optional

The duration in hours to enable AutoSupport maintenance mode (if not provided, the maximum supported duration will be used)
Default : 72
Minimum value : 1
Maximum value : 72
Example : 0

integer (int32)

maintenanceWindowEnabled
optional

Example : true

boolean

4.167. DeviceDataResponse

Name Description Schema

responseData
optional

The string representation of the data requested.
Example : "string"

string

4.168. DiagnosticDataRequest

Name Description Schema

requestType
optional

Data to request
Example : "string"

enum (deviceProfile, firmwareInventory)

4.169. DiscoverResponse

API response object that includes data for the current discover process

Name Description Schema

requestId
required

Unique request id
Example : "string"

string (int64)

currentCount
required

The number of addresses checked
Example : 0

integer (int32)

total
required

total number of addresses to check
Example : 0

integer (int32)

lastStart
required

Time when the last discovery was started null if a process has never been started
Example : "string"

string (date-time)

discoverProcessRunning
required

Indicates if a discovery process is running
Example : true

boolean

storageSystems
required

List of storage systems discovered so far
Example : [ "DiscoveredStorageSystem" ]

< DiscoveredStorageSystem > array

4.170. DiscoveredController

Information discovered for a storage system controller during a discover process

Name Description Schema

ipAddresses
required

The IP addresses that can be used to access this controller
Example : [ "string" ]

< string > array

certificateStatus
optional

SSL certificate status (applicable if this controller supports management via HTTP
Example : "string"

enum (trusted, selfSigned, expired, incompleteTrustChain, commonNameMismatch)

4.171. DiscoveredStorageSystem

Information discovered for a storage system during a discover process

Name Description Schema

serialNumber
required

Serial number for the chassis
Example : "string"

string

wwn
required

WWN for the storage system
Example : "string"

string

label
required

Label for the storage system
Example : "string"

string

firmware
required

Firmware version for the storage system
Example : "string"

string

nvsram
required

NVSRAM version for the storage system
Example : "string"

string

ipAddresses
required

Discovered controller IP addresses for the storage system
Example : [ "string" ]

< string > array

needsAttention
required

Needs attention alert for the storage system
Example : true

boolean

controllers
optional

Discovered controllers for the storage system
Example : [ "DiscoveredController" ]

< DiscoveredController > array

enabledManagementPorts
optional

Management ports that are enabled on this storage system
Example : [ "string" ]

< enum (symbol, https) > array

4.172. DiscoveryStartRequest

Used to to start a storage system discover cycle

Name Description Schema

startIP
required

Starting IP address
Example : "string"

string

endIP
required

Ending IP Address
Example : "string"

string

useAgents
optional

In-band management agents will be queried if this value is true. If you are not sure, its best to leave this as default
Default : false
Example : true

boolean

connectionTimeout
optional

Optional parameter. This defaults to 30 seconds. Longer times may be needed for WAN discoveries, but will slow down the whole process. Shorter times speed up the process. This is only the timeout value for the initial TCP connection
Default : 30
Example : 0

integer (int32)

maxPortsToUse
optional

Number of ports to use for discovery. A port is a file handler in most operating systems. Watch your ULimits. More ports the faster discovery goes. But, for example, windows only has a few thousand available ports. If file handlers are exceeded, then this process will adjust down but other processes on the server may be affected as well as client connections
Example : 0

integer (int32)

4.173. DriveEx

Name Description Schema

offline
required

True if the drive is in the offline state, false otherwise. This field is valid for missing drives.
Example : true

boolean

hotSpare
required

True if the drive has been designated as a hot spare; false otherwise. This field is valid for missing drives.
Example : true

boolean

invalidDriveData
required

True if no drive information (serial #, capacity, etc.) can be obtained. This field is always true for missing drives.
Example : true

boolean

available
required

True if the drive is available for use in creating a new volume group; false otherwise. This field is valid for missing drives.
Example : true

boolean

pfa
required

True if the drive is drive Predicted Failure analysis predicts a drive failure. This field is valid for missing drives.
Example : true

boolean

driveRef
required

The identifier value for this drive. Other objects may use this reference value to refer to the drive. This field is valid for missing drives.
Example : "string"

string

status
required

An indication of the current status of the drive. This field is valid for missing drives.
Example : "string"

enum (optimal, failed, replaced, bypassed, unresponsive, removed, incompatible, dataRelocation, preFailCopy, preFailCopyPending, __UNDEFINED)

cause
required

An indication of the reason for the current status of the drive. This field is most useful when the current status is something other than optimal; it identifies the event that caused the status to change to its current value. This field is valid for missing drives.
Example : "string"

enum (none, userOp, writeOp, uncertified, speedMismatch, bypassUnknown, wrongDriveType, incompatibleUprevDacstore, incompatibleDownrevDacstore, incompatibleInternalError, incompatibleSectorSizeMismatch, incompatibleNativeVgRefersToForeignDrive, incompatibleForeignVgRefersToNativeDrive, incompatibleNativeVgForeignDriveMutualRef, incompatibleVgCloned, incompatibleForeignDriveInconsistent, incompatibleVgHasDrivePartOfMultipleVgs, incompatibleForeignDriveHasInconsistentRole, incompatibleVgDrivePartOfMultipleVgs, incompatibleFailedLegacyDrive, incompatibleDdfOtherVendor, incompatibleDbAdoptionFailure, locked, insufficientDriveCapacity, supercapacitorFailure, unsupportedProtocolConnection, unsupportedCapacity, invalidLockKeyPresented, incompatiblePiType, incompatibleDatabaseValidationFailure, incompatibleUnsupportedInterposerFwVersion, incompatibleSataDriveSctUnsupported, incompatibleModelNumberUnsupported, incompatibleAlignmentForEmulationDrive, srcRelocation, dstRelocation, incompatibleDriveMetadataUnusable, pfa, spfa, __UNDEFINED)

interfaceType
required

Information about the I/O interface between the controller and the drive. For example, for a SCSI-attached drive, this field will contain information about the drive’s channel and SCSI ID values. For other interface types, different data will be available in this field.
Example : "DriveTypeData"

DriveTypeData

physicalLocation
required

The physical location of the drive. Beginning with the Allegheny release, the parent reference in Location identifies the tray or drawer containing the drive, and the position field is the parent-relative/like-component relative slot number of the drive, starting at 1. For missing drives this field contains the last known location.
Example : "Location"

Location

manufacturer
required

The variable-length ASCII text string that identifies the drive manufacturer. Note that this information is not returned for most Serial ATA (SATA) drives.
Example : "string"

string

manufacturerDate
required

The date of manufacture of the drive, represented in seconds since midnight GMT on January 1, 1970. Note that this information is not returned for most Serial ATA (SATA) drives.
Example : "string"

string (int64)

productID
required

The variable-length ASCII text string that identifies the product by name, as assigned by the manufacturer.
Example : "string"

string

serialNumber
required

The variable-length ASCII text string for the serial number of the drive.
Example : "string"

string

softwareVersion
required

This data is a variable-length ASCII text string. If an interposer is present in front of SATA drives, the string identifies the version of the interposer package. In this case, the SATA drive firmware version can be found in the physicalDriveTypeData field. If an interposer is not present (always the case for Fibre Channel drives) this field describes the drive firmware version.
Example : "string"

string

blkSize
required

The block (i.e. sector) size used by the drive, represented in bytes. This field is valid for missing drives.
Example : 0

integer (int32)

usableCapacity
required

The usable capacity of the drive, in bytes, after accounting for any space that is reserved for use by the array controller for overhead information. This field is valid for missing drives.
Example : "string"

string (int64)

rawCapacity
required

The raw capacity of the drive, in bytes. This field is valid for missing drives.
Example : "string"

string (int64)

worldWideName
required

A variable-length, opaque field that contains the drive’s world-wide name, or globally unique identifier value. This field is valid for missing drives.
Example : "string"

string

currentVolumeGroupRef
required

The reference value of the volume group, disk pool, or flash cache to which this drive is currently assigned. If a hot spare drive is actively sparing for a failed drive, this field will identify the volume group, disk pool, or flash cache that is using the hot spare drive. If the drive is not currently assigned, or is an idle hot spare, the reference value will be null. This field is valid for missing drives.
Example : "string"

string

sparedForDriveRef
required

The reference value of the drive for which this drive is acting as a hot spare. This field is only used if the Drive object represents a global hot spare that is actively sparing for a failed drive. This field is valid for missing drives.
Example : "string"

string

mirrorDrive
required

This field is only used if the Drive object represents a drive that is part of a RAID-1 volume group. It identifies the drive that is tied to this one for RAID-1 mirroring operations. This field is valid for missing drives.
Example : "string"

string

nonRedundantAccess
required

True if the drive does not have redundant access.
Example : true

boolean

workingChannel
required

The channel to the tray that is still operational (if nonRedundantAccess is True).
Example : 0

integer (int32)

volumeGroupIndex
required

The volume group index. This is the zero-relative position of the drive with respect to the stripe-ordering for the volume group. A value of -1 indicates that the drive does not belong to any group. This field is valid for missing drives.
Example : 0

integer (int32)

currentSpeed
required

The speed of the drive. Will be unknown for a SCSI drive.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maxSpeed
required

The maximum speed of the drive. Currently not used.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

uncertified
required

True, if the drive has the DR_UNCERTIFIED flag set. This field is valid for missing drives.
Example : true

boolean

hasDegradedChannel
required

True, if a path to this drive is degraded.
Example : true

boolean

degradedChannels
required

The IDs of degraded channels.
Example : [ 0 ]

< integer (int32) > array

phyDriveType
required

The physical drive type.
Example : "string"

enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED)

spindleSpeed
required

The drive reported spindle speed. Solid State Disk (SSD) drives report zero.
Example : 0

integer (int32)

rtrAttributes
required

The CRU type of the drive plus its ready-to-remove attributes, which are based on the CRU type.
Example : "RTRAttributes"

RTRAttributes

reserved
required

reserved.
Example : "string"

string

phyDriveTypeData
required

Information specific to a physical drive type.
Example : "PhysicalDriveTypeData"

PhysicalDriveTypeData

pfaReason
required

The reason a PFA condition has been raised for this drive.
Example : "string"

enum (unknown, none, driveReported, synthesized, ssdEndOfLife, __UNDEFINED)

bypassSource
required

A list of object references where each reference identifies the source of a drive bypass condition. Possible referenced objects include the drive itself, a controller, or the ESM(s). When the bypass source is a controller or the drive, the list will typically hold just one reference; when the bypass source is the ESM(s), the list can hold up to two references, indicating either one or both ESMs. The list normally holds valid data whenever the drive is in the bypassed state (DRIVE_STAT_BYPASSED) , however it may be empty if the source of the bypass is unknown. It is also possible for the list to hold valid data when the drive is optimal, if only one ESM has bypassed the drive.
Example : [ "ObjectReference" ]

< ObjectReference > array

repairPolicy
required

This field contains the repair policy for the Drive.
Example : "RepairPolicy"

RepairPolicy

fdeCapable
required

True if the drive supports FDE, false otherwise
Example : true

boolean

fdeEnabled
required

true if drive security is enabled; false if disabled
Example : true

boolean

fdeLocked
required

True if the drive is locked, false if the drive is unlocked
Example : true

boolean

lockKeyID
required

The lock key ID as read from the drive.
Example : "string"

string

ssdWearLife
required

Contains wear life data for the SSD drive.
Example : "SSDWearLife"

SSDWearLife

driveMediaType
required

This field is set to the drive media type of the drive.
Example : "string"

enum (all, unknown, hdd, ssd, __UNDEFINED)

fpgaVersion
required

This data is a variable-length ASCII text string that identifies the version of the FPGA package.
Example : "string"

string

protectionInformationCapabilities
required

This structure contains a protectionInformationCapable field which is set to true when the drive is formatted to support type 2 protection with a 512-byte logical block size, or if the drive is a type 0 drive formatted with a 520-byte logical block size. It also contains a field that is set to the protection type provided for the drive.
Example : "ProtectionInformationCapabilities"

ProtectionInformationCapabilities

protectionInformationCapable
required

Field is no longer used.
Example : true

boolean

protectionType
required

Field is no longer used.
Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

interposerPresent
required

A value of true for this property means the drive is behind an interposer.
Example : true

boolean

interposerRef
required

The drive interposer identifier. This field is valid only if the interposerPresent field is set to True.
Example : "string"

string

currentCommandAgingTimeout
required

The current command aging timeout value in hundreds of milliseconds. If this value is 0 the default command aging timeout value will be used, otherwise this value overrides the default value.
Example : 0

integer (int32)

defaultCommandAgingTimeout
required

The default command aging timeout value in hundreds of milliseconds as specified by the drive. If this value is 0, the drive command aging timeout cannot be changed.
Example : 0

integer (int32)

driveTemperature
required

Drive temperature data.
Example : "DriveTemperature"

DriveTemperature

blkSizePhysical
required

The physical block (i.e., sector) size for the drive, represented in bytes. This field is valid for missing drives.
Example : 0

integer (int32)

lowestAlignedLBA
required

The lowest aligned LBA for the physical sector. Typically this will be 0, but could be non-zero for emulation drives where LBA 0 starts at some logical sector offset within the physical sector.
Example : "string"

string (int64)

removed
required

True if the drive is in the process of being removed from the volume group. Only applies to Disk Pools
Example : true

boolean

locateInProgress
required

Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the drive.
Example : true

boolean

fipsCapable
required

This flag is true if the drive supports FIPS (Federal Information Processing Standard). FIPS 140-2 specification.
Example : true

boolean

firmwareVersion
optional

Example : "string"

string

lockKeyIDValue
optional

Example : "string"

string

id
optional

Example : "string"

string

4.174. DriveTemperature

Name Description Schema

currentTemp
required

The current drive temperature (in degrees Celsius).
Example : 0

integer (int32)

refTemp
required

Reference temperature (maximum safe operating temperature in degrees Celsius).
Example : 0

integer (int32)

4.175. DriveTypeData

Name Description Schema

driveType
required

This enumeration type is used to distinguish between the different I/O protocols used by the controller to communicate with drives. This is not necessarily the same as the physical drive interface type (PhysicalDriveType).
Example : "string"

enum (scsi, fibre, unknown, sas, sata, __UNDEFINED)

fibre
optional

This field is present only if the driveType value is DRIVE_TYPE_FIBRE. It contains the address information for a Fibre Channel drive. Such drives are typically multi-ported, so there will be one element in this variable-length array for each I/O port on the drive. The first element in the array is the drive address on the preferred channel, and the second element is the drive address on the redundant channel.
Example : [ "FibreDriveAddress" ]

< FibreDriveAddress > array

sas
optional

This field is present only if the driveType value is DRIVE_TYPE_SAS. It contains the address information for a serial-attached SCSI drive.
Example : "SasDriveAddress"

SasDriveAddress

scsi
optional

This field is present only if the driveType value is DRIVE_TYPE_SCSI. It contains the address information for a SCSI drive.
Example : "SCSIDriveAddress"

SCSIDriveAddress

4.176. FibreDriveAddress

Name Description Schema

channel
required

The controller drive-side channel number used to access the drive via this interface.
Example : 0

integer (int32)

loopID
required

The drive’s Fibre Channel loop ID value on the given channel.
Example : 0

integer (int32)

4.177. PhysicalDriveTypeData

Name Description Schema

phyDriveType
required

This enumeration object is used to describe the physical interface of the drive. This is not necessarily the same as the I/O protocol interface used by the controller to communicate with the drive (DriveType). In addition, the supportedDriveTypes array in the FeatureParams structure will contain values from this enumeration identifying which drive types are supported on the storage array.
Example : "string"

enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED)

sataDriveAttributes
optional

This field identifies the attributes of SATA drives It is only present if the phyDriveType field is equal to PHY_DRIVE_TYPE_SATA.
Example : "SataDriveAttributes"

SataDriveAttributes

4.178. SCSIDriveAddress

Name Description Schema

channel
required

The controller drive-side SCSI channel on which the drive resides.
Example : 0

integer (int32)

id
required

The drive’s SCSI ID value.
Example : 0

integer (int32)

4.179. SSDWearLife

Name Description Schema

averageEraseCountPercent
required

The percentage of average erase count.
Example : 0

integer (int32)

spareBlocksRemainingPercent
required

The percentage of spare blocks remaining in the solid state drive. Controller firmware checks and updates this percentage approximately once per hour.
Example : 0

integer (int32)

isWearLifeMonitoringSupported
required

This field is set to true if wear life monitoring is supported on the drive. If true then the values in the other fields in this structure are valid, otherwise they are not valid.
Example : true

boolean

percentEnduranceUsed
required

The percentage of endurance used for this drive. The value is obtained from the Solid State Media log page. A value of PERCENTAGE_ENDURANCE_USED_UNKNOWN indicates that the information is inaccessible or not populated in this release.
Example : 0

integer (int32)

4.180. SasDriveAddress

Name Description Schema

deviceName
required

The SAS address representing the device itself.
Example : "string"

string

drivePortAddresses
required

The SAS addresses of drive ports 0 and 1. The first element in the array is the drive address on the preferred channel, and the second element is the drive address on the redundant channel.
Example : [ "SasDrivePortAddress" ]

< SasDrivePortAddress > array

4.181. SasDrivePortAddress

Name Description Schema

channel
required

The number of the channel where the drive port is located.
Example : 0

integer (int32)

portIdentifier
required

The SAS address of the drive port.
Example : "string"

string

4.182. SataDriveAttributes

Name Description Schema

translatorData
required

This field provides information about the SCSI-to-ATA translator hardware.
Example : "ScsiToAtaTranslatorData"

ScsiToAtaTranslatorData

ataDiskModelNumber
required

This field is the disk model number as reported in the ATA protocol.
Example : "string"

string

ataDiskFwRevision
required

This field is the disk firmware revision number as reported in the ATA protocol.
Example : "string"

string

4.183. ScsiToAtaTranslatorData

Name Description Schema

vendorId
required

The vendor identification string.
Example : "string"

string

productId
required

The product identification string.
Example : "string"

string

productRevLevel
required

The product revision level string. When no interposer card is available, this string is set to "—-" (four dashes).
Example : "string"

string

satType
required

This field identifies the type of the SCSI-to-ATA translation hardware. Note that if this field is set to SAT_TYPE_UNKNOWN, the string in the productId field will have zero length, and the string in the productRevLevel field will be set to "—-" (four dashes).
Example : "string"

enum (unknown, driveCruResident, controllerResident, enclosureSlotResident, __UNDEFINED)

4.184. UnreadableSectorEntryResult

Identifies the location of an unreable sector.

Name Description Schema

driveRef
optional

Example : "string"

string

timeStamp
optional

Example : "string"

string (int64)

volumeRef
optional

Example : "string"

string

recordType
optional

Example : "string"

enum (physical, logical, injected, edcError, inconsistent, piError, __UNDEFINED)

volumeLBA
optional

Example : "string"

string (int64)

trayNo
optional

Example : 0

integer (int32)

slotNo
optional

Example : 0

integer (int32)

driveLBA
optional

Example : "string"

string (int64)

4.185. UnreadableSectorResponse

The list of unreadable drive sectors

Name Description Schema

maxLimit
optional

Example : 0

integer (int32)

database
optional

Example : [ "UnreadableSectorEntryResult" ]

< UnreadableSectorEntryResult > array

4.186. DriveSelectionRequest

Name Description Schema

driveCount
required

Minimum value : 1Example : 0

integer (int32)

selectedSpindleSpeeds
optional

Only select drives with these spindle speeds
Example : [ 0 ]

< integer (int32) > array

fdeCapableOnly
optional

Only select FDE capable drives
Default : false
Example : true

boolean

driveCapacityMin
optional

Only consider drives with at least this minimum raw capacity in SizeUnits
Default : "0"
Example : "string"

string (int64)

driveType
optional

Only consider drives of this media type
Example : "string"

enum (ssd, hdd)

interfaceType
optional

Only consider drives of this interface type
Example : "string"

enum (fibre, sas, sata)

protectionInformationCapable
optional

Only consider drives that have Data Assurance capability.
Default : false
Example : true

boolean

sizeUnit
optional

Use this unit for any capacity based parameters
Default : "gb"
Example : "string"

enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb)

raidLevel
optional

The intended RAID level for the storage-pool.
Default : "raidAll"
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

targetUsableCapacity
optional

The aggregate capacity of the selected drives must be at least this many SizeUnits
Minimum value : 1
Example : 0

integer (int32)

4.187. DiskIOStats

Drive I/O performance statistics. Note: the DELETE method clears all statistics for all drives.

Name Description Schema

observedTime
required

End time for this collection as measured by the number of seconds since baseTime.
Example : "string"

string (date-time)

observedTimeInMS
required

Example : "string"

string (int64)

lastResetTime
required

Example : "string"

string (date-time)

lastResetTimeInMS
required

Example : "string"

string (int64)

diskId
required

Example : "string"

string

serialNumber
required

Example : "string"

string

arrayId
required

Example : "string"

string

arrayWWN
required

Example : "string"

string

driveWWN
required

Example : "string"

string

volGroupId
required

Example : "string"

string

volGroupName
required

Example : "string"

string

volGroupWWN
required

Example : "string"

string

trayId
required

Example : "string"

string

slot
required

Example : 0

integer (int32)

diskManufacture
required

Example : "string"

string

diskSoftwareVersion
required

Example : "string"

string

idleTime
required

Example : 0.0

number (double)

otherOps
required

Example : 0.0

number (double)

otherTimeMax
required

Example : 0.0

number (double)

otherTimeTotal
required

Example : 0.0

number (double)

otherTimeTotalSq
required

Example : 0.0

number (double)

readBytes
required

Example : 0.0

number (double)

readOps
required

Example : 0.0

number (double)

readTimeMax
required

Example : 0.0

number (double)

readTimeTotal
required

Example : 0.0

number (double)

readTimeTotalSq
required

Example : 0.0

number (double)

recoveredErrors
required

Example : 0.0

number (double)

retriedIos
required

Example : 0.0

number (double)

timeouts
required

Example : 0.0

number (double)

unrecoveredErrors
required

Example : 0.0

number (double)

writeBytes
required

Example : 0.0

number (double)

writeOps
required

Example : 0.0

number (double)

writeTimeMax
required

Example : 0.0

number (double)

writeTimeTotal
required

Example : 0.0

number (double)

writeTimeTotalSq
required

Example : 0.0

number (double)

queueDepthTotal
required

Example : 0.0

number (double)

queueDepthMax
required

Example : 0.0

number (double)

randomIosTotal
required

Example : 0.0

number (double)

randomBytesTotal
required

Example : 0.0

number (double)

cumulativeLBA
required

Example : 0.0

number (double)

cumulativeDeltaLBA
required

Example : 0.0

number (double)

4.188. DriveFirmwareCompatabilityEntry

Drive compatibilty entry

Name Description Schema

driveRef
required

Example : "string"

string

onlineUpgradeCapable
required

Example : true

boolean

4.189. DriveFirmwareCompatibilityResponse

The list of drives compatible with the downloaded firmware files

Name Description Schema

contollerOffline
required

Controller status
Example : true

boolean

controllerMissing
required

Controller missing
Example : true

boolean

controllerServiceMode
required

Indicates if a Controller is in service mode
Example : true

boolean

simplexMode
required

Indicates if in simplex mode
Example : true

boolean

compatibilities
required

The list of drive to firmware compatibility compatibilities
Example : [ "DriveFirmwareCompatiblitySet" ]

< DriveFirmwareCompatiblitySet > array

4.190. DriveFirmwareCompatiblitySet

Drive firmware file to drive compatibility

Name Description Schema

filename
required

Example : "string"

string

firmwareVersion
required

The version of firmware in file
Example : "string"

string

supportedFirmwareVersions
required

Drive firmware versions supported by firmware file
Example : [ "string" ]

< string > array

compatibleDrives
required

List of drives that are compatible with firmware file
Example : [ "DriveFirmwareCompatabilityEntry" ]

< DriveFirmwareCompatabilityEntry > array

4.191. DriveDownloadDriveStatus

Name Description Schema

driveRef
required

The drive reference.
Example : "string"

string

status
required

The drive download status.
Example : "string"

enum (okay, invalidDriveref, duplicateDrive, notAttempted, invalidState, inProgress, partialUpdate, failedUpdate, inProgressRecon, pending, __UNDEFINED)

percentComplete
required

Will be set to zero unless the DriveDownloadStatus is equal to DRIVE_DL_STAT_IN_PROGRESS_RECON (meaning a reconstruction is in progress).
Example : 0

integer (int32)

4.192. DriveFirmwareStatus

Name Description Schema

overallStatus
required

The overall status.
Example : "string"

enum (uninitialized, ok, error, busy, illegalParam, noHeap, driveNotExist, driveNotUnassigned, noSparesAssigned, someSparesAssigned, volumeNotExist, volumeReconfiguring, notDualActive, tryAlternate, background, notImplemented, reservationConflict, volumeDead, internalError, invalidRequest, iconFailure, volumeFormatting, altRemoved, cacheSyncFailure, invalidFile, reconfigSmallDacstore, reconfigFailure, nvramError, flashError, authFailParam, authFailPassword, memParityError, invalidControllerref, invalidVolumegroupref, invalidVolumeref, invalidDriveref, invalidFreeextentref, volumeOffline, volumeNotOptimal, modesenseError, invalidSegmentsize, invalidCacheblksize, invalidFlushThreshold, invalidFlushAmount, invalidLabel, invalidCacheModifier, invalidReadahead, invalidReconpriority, invalidScanperiod, invalidTrayposLength, invalidRegionid, invalidFibreid, invalidEncryption, invalidRaidlevel, invalidExpansionList, noSparesDeassigned, someSparesDeassigned, partDupId, partLabelInvalid, partNodeNonexistent, partPortIdInvalid, partVolumeNonexistent, partLunCollision, maxVolMappingExceeded, partMappingNonexistent, partNoHostports, imageTransferred, fileTooLarge, invalidOffset, overrun, invalidChunksize, invalidTotalsize, downloadNotPermitted, spawnError, voltransferError, invalidDlstate, cacheconfigError, downloadInProgress, driveNotOptimal, driveRemoved, duplicateDrives, numdrivesAdditional, numdrivesGroup, driveTooSmall, capacityConstrained, maxVolumesExceeded, partIsUtmLun, someSparesTooSmall, sparesSmallUnassigned, tooManyPartitions, parityScanInProgress, invalidSafeId, invalidSafeKey, invalidSafeCapability, invalidSafeVersion, partitionsDisabled, driveDownloadFailed, esmDownloadFailed, esmPartialUpdate, utmConflict, noVolumes, authFailReadpassword, partCrteFailTblFull, attemptToSetLocal, invalidHostTypeIndex, failVolumeVisible, noDeleteUtmInUse, invalidLun, utmTooManyMaps, diagReadFailure, diagSrcLinkDown, diagWriteFailure, diagLoopbackError, diagTimeout, diagInProgress, diagNoAlt, diagIconSendErr, diagInitErr, diagModeErr, diagInvalidTestId, diagDriveErr, diagLockErr, diagConfigErr, diagNoCacheMem, diagNotQuiesced, diagUtmNotEnabled, invalidModeSwitch, invalidPortname, duplicateVolMapping, maxSnapsPerBaseExceeded, maxSnapsExceeded, invalidBasevol, snapNotAvailable, notDisabled, snapshotFeatureDisabled, repositoryOffline, repositoryReconfiguring, rollbackInProgress, numVolumesGroup, ghostVolume, repositoryMissing, invalidRepositoryLabel, invalidSnapLabel, invalidRollbackPriority, invalidWarnThreshold, cannotMapVolume, cannotFormatVolume, dstNotFibre, repositoryTooSmall, repositoryFailed, baseVolumeFailed, baseVolumeOffline, baseVolumeFormatting, metadataVolNonexistent, rvmFeatureDisabled, mirrorsPresent, rvmFeatureDeactivated, maxMirrorsExceeded, invalidMirrorCandidateVol, invalidMirrorvol, metadataAlreadyExists, metadataMissing, metadataOffline, metadataReconfiguring, localRoleChangeFailed, remoteRoleChangeFailed, localRoleChangeSuccessful, onlyLocalMirrorDeleted, noValidMirrorCandidate, remoteMaxMirrorsExceeded, remoteRvmFeatureDisabled, remoteMetadataVolNonexistent, notRegistered, remoteInvalidCfgGen, localRoleChangedNotForced, remoteRoleChangedLocalFailed, rvmSpmError, remoteAuthFailPassword, rvmVersionMismatch, rvmRemoteArrayError, rvmCommunicationError, rvmFibreError, mirrorVolNotPrimary, secNotPromoteable, priNotDemoteable, metadataChildDeletion, rmtvolOrphanDeletion, rvmActivateDisallowed, invalidTrayref, partialDeletion, defaultUtmCollision, invalidCopyPriority, invalidVolumecopyref, copyChangeFailed, copyActive, copyInactive, copyIncompatibleSource, copyIncompatibleTarget, copyGhostSource, copyGhostTarget, copyInvalidSourceRef, copyInvalidTargetRef, copyInvalidSourceState, copyInvalidTargetState, copySourceReconfig, copyTargetReconfig, copyTargetTooSmall, copyTargetLimit, maxVolumeCopysExceeded, copySourceReservation, copyTargetReservation, copySourceFormat, copyTargetFormat, copyStartFailed, copyStopFailed, volcopyFeatureDisabled, writeLock, cannotReconfigure, authFailContLockout, prReservationConflict, regDeleteFailed, batteryNotInConfig, batteryMissing, noChannel, rvmOperNotAllowedOnSec, dataRedundancyRequired, copySourceZeroCapacity, invHostlunDefineMapping, invHostlunMoveMapping, invHostlunDefineHosttype, invHostlunMoveHostport, fwIncompatible, mirrorAlreadySuspended, insuffLocalMirRepResources, insuffRemtMirRepResources, ghostHasUnreadableSectors, rvmCommStatRecoveredTimeout, rvmCommStatRecoveredDelay, rvmCommStatNotReady, rvmCommStatTimeout, rvmCommStatChannelFailure, rvmCommStatNetworkFailure, rvmCommStatDeviceMissing, rvmCommStatLoginRejected, rvmCommStatLoginFailure, rvmCommStatInvNumSamplesReqd, rvmQuiescenceInProgress, rvmInvalidRemotevol, sodInProgress, invalidDrives, invalidSetid, invalidSetsize, missingData, quiescenceFailed, validationError, downloadHalted, allFailed, partialOk, obsolete, usmClearFailed, controllerInServiceMode, invalidDrive, databaseError, backgroundAutocfg, autocfgInprogress, unsupportedLhaSataEsm, parityScanFailed, parityRepairFailed, mediaRepairFailed, mirrorDegraded, prohibitedByMdtRestrictions, prohibitedByGoldKeyRestrictions, safeControllerNotSubjectToGoldKey, safeMdtNotPremiumFeature, alarmNotPresent, dltNotCompleted, dependancyError, cdmDatabaseFull, requiredConditionNotPresent, ddcUnavail, ddcIllegalParam, invalidDdcTag, hosttypeConflict, portConflict, invalidHosttypeString, invalidProtocol, portRemoved, disableNotPermitted, prohibitedByDriveTrayLimit, invalidEsmref, invalidBundleMigration, invalidBundleKey, noSparesNeeded, prohibitedByFeatureBundleViolation, invalidAuthMethod, invalidSecret, secretAlreadyInUse, manualConfigModeSet, noIscsiSessions, invalidInterfaceref, initiatorConflict, initiatorRemoved, basevolSizeChanged, volumeGroupNotExist, volumeGroupNotOnline, volumeGroupHasHotspare, volumeGroupReconfiguring, volumeGroupStateNotValid, controllerNotOptimal, insufficientCapacity, volumeGroupExported, volumeNotConfigurable, volumeGroupNotConfigurable, invalidDriveState, volumeGroupReconstructing, volumeGroupUndergoingCopyback, volumeGroupNotComplete, volumeGroupHasFailedDrives, volumeGroupHasNonOptimalVols, volumeGroupHasMirrorRelationship, volumeGroupHasVolcopyRelationship, volumeGroupHasMirroringMetadata, volumeGroupHasMappedVols, volumeGroupHasReservations, volumeGroupHasIncompatibleDacstores, volumeLimitExceeded, volumeGroupHasUnknownRaidLevel, volumeGroupHasUnsupportedRaidLevel, volumeGroupHasCloneOpportunity, volumeGroupHasInsufficientDrives, volumeGroupHasFailedVols, perfTierSafeUpgradeDisabled, raid6FeatureUnsupported, raid6FeatureDisabled, safeControllerNotSubjectToRaid6, volumeGroupNotContingent, channelDiagsRunning, channelDiagsResultsPartial, volumeGroupHasSnapshotRelationship, prohibitedBySafeViolation, legacyVg, vgNotForceable, channelDiagsLockErr, channelDiagsNotQuiesced, channelDiagsAltCommFailed, channelDiagsChanSetupFailed, channelDiagsDeviceBypassFailed, channelDiagsResultsNotAvailable, driveSpinUpError, driveTypeMismatch, localRemoteArrayHasSameWwn, volumeGroupHasIncompatibleDrive, volumeGroupVolumeEncroachesOnDacstore, volumeGroupImportInProgress, drivesNeedToBeSpunUp, noNativeSstor, noSuchDebugChunk, debugInfoConfigChanged, lockdown, drivesDacstoresOverlap, volumeHasAsyncMirror, reconfigLogSpaceError, volumeGroupInaccessible, volumeInitializing, insufficientCache, volumeInaccessible, noDrivesAdopted, someDrivesAdopted, exportingDrivesDatabaseResynchronizing, exportingDrivesDatabaseFailed, exportingDrivesQuiesced, learnActiveTryLater, noLockedDrives, driveSecurityEnabledFailed, lockkeyFailed, invalidSecurity, noFdeDrives, volumeGroupSecure, invalidBlob, unlockFailed, noKeySet, rekeyInProgress, defaultHostGroupMappingNotAllowed, ssdMediaScanNotAllowed, premiumFeatureLimitExceedsMaximum, disableEvaluationFeatureNotPermitted, requestFailedDueToLun0Restrictions, externalKmsEnabled, externalKmsFailed, externalKmsNotEnabled, keyNotNeeded, keyInvalidSequence, diagNotRunning, ctrlNotInServiceMode, invalidFeatureref, cacheBackupDevNotExist, noMatchingLockKeyIdFound, lockKeyValidationFailed, lockKeyValidationDisabled, externalKmsNotCompliant, externalKmsTimeout, cannotDisableNoKey, previouslyEnabledForEval, featureNotKeyable, evalNotSupported, rawdataTransferBadType, rawdataTransferNotStarted, rawdataTransferAlreadyStarted, rawdataTransferPreparing, rawdataTransferReadError, rawdataTransferNoDrives, rawdataTransferInvalidImage, rawdataTransferCrcError, dbmRestoreWriteError, dbmRestoreNoDrives, rawdataBadSeqNum, invalidCapability, externalKeyNotInMemory, invalidLockKeyId, invalidProtection, volumeHasSnapshotRelationship, volumeHasMirrorRelationship, externalKmsDisabledNoKey, dbmRestoreAltCtlNotOffline, copyApptagMismatch, invalidRequestForEnclosure, dqRetrieveNothingToTransfer, invalidIscsiConfiguration, volumeHasVolcopyRelationship, partPiIncapable, requestFailedDueToPiRestrictions, rawdataTransferUserCancelled, duplicateIscsiIpAddress, portSpeedConflict, factoryDefaultDownloadFailed, errorWritingToEeprom, factoryDefaultPartialUpdate, snapshotNotActive, cannotRollback, mirrorSyncNotPossible, psuFirmwareDownloadFailed, psuFirmwareUpdateMfgDeviceCodeMismatch, psuFirmwareUpdateNotAllRedundant, psuFirmwareUpdateNotAllOptimal, insufficientRepositoryCapacity, rollbackStartFailure, csbReserveFailed, csbReleaseFailedNoLock, csbReleaseFailedInvalidKey, flashcacheAlreadyExists, flashcacheFeatureDisabled, flashcacheAlreadySuspended, flashcacheNotSuspended, flashcacheInvalidConfigType, invalidPitGroupLabel, invalidPitConsistencyGroupLabel, invalidPitAutoDeleteLimit, invalidPitRepositoryFullPolicy, invalidConcatVolMemberLabel, concatVolMemberTooSmall, invalidPitGroupRef, invalidPitRef, dveNotAllowed, dssNotAllowed, dplCoreDumpInvalidTag, invalidPitViewLabel, invalidPitViewRef, invalidConcatVolRef, notFlashcacheVol, flashcacheDeleted, flashcacheEnabled, flashcacheNotEnabled, noRepDeletion, maxPitsPerGroupExceeded, maxPitsExceeded, maxPitGroupsPerBaseExceeded, maxPitGroupsExceeded, maxViewsPerPitExceeded, maxViewsExceeded, maxConsistencyGroupsExceeded, maxConsistencyGroupMembersExceeded, maxMappableVolumesExceeded, notOldestPit, viewStopped, concatMemberLimitExceeded, invalidMemberVol, memberVolMapped, invalidMemberVolState, invalidTrimCount, pitGroupInConsistencyGroup, pitInConsistencyGroup, pitViewInConsistencyGroup, incompatibleMemberVol, volumeInUse, rvmOverIscsiNotSupported, arvmGroupUserLabelExists, arvmGroupDoesNotExist, arvmGroupNotEmpty, concatVolumeFailed, invalidPitConsistencyGroupRef, invalidPitConsistencyGroupViewRef, invalidPitConsistencyGroupViewLabel, alternateRequiredForOperation, invalidPitForView, consistencyGroupArvmBindingConflict, attributeFixedByArvm, operationFailedVolumeCopyClone, pitCreatePending, dbmDbSourceUnavailable, dbmRestoreSourceMismatch, invalidCriticalThreshold, volumeGroupHasArvmRelationship, arvmRecoveryPointDeletionRequired, volumeGroupHasPitgroupRelationship, volumeGroupHasPitviewRelationship, volumeGroupHasConcatRelationship, flashcacheSuspended, flashcacheAlreadyEnabled, dbmDbImageCorrupt, illegalVolume, invalidRepositoryCapacity, invalidProvisionedCapacityQuota, invalidExpansionPolicy, invalidVirtualCapacity, cannotExpandConcatMember, thresholdBelowUsedCapacity, invalidExpansionOperation, repositoryFull, insufficientExpansionSpace, invalidExpansionSize, invalidReinitAction, invalidReinitCapacity, invalidIncompleteMemberRef, arvmGroupNotPrimary, arvmGroupNotSecondary, arvmMemberFailed, arvmGroupNotSuspended, arvmInvalidMirrorState, arvmVolumeAlreadyInMirrorRelationship, arvmMemberLimitExceeded, arvmSuspendFailure, arvmResumeFailure, arvmSynchronizeFailure, remoteTargetNotFound, arvmMirrorMemberDoesNotExist, snapConversionTooManySnaps, snapConversionMissingLabel, arvmFeatureDeactivated, incompatibleRepositorySecurity, incompatibleSecondarySecurity, mirrorProtocolMismatch, arvmAsyncMirrorGroupPresent, cacheParametersNotChangeable, flashcacheMaxCapacityExceeded, flashcacheFailed, dplCoreDumpRestoreInProgress, arvmGroupHasIncompleteMember, arvmConnectivityTestAlreadyInProgress, arvmConnectivityTestNetworkError, arvmConnectivityTestRemoteTimeout, arvmConnectivityTestLoginFailure, arvmConnectivityTestNameServiceError, arvmConnectivityTestTurError, arvmConnectivityTestMissingRemoteAmg, arvmConnectivityTestAmgMemberMismatch, invalidSyncPriority, invalidRecoveryPointAlertThreshold, invalidSyncAlertThreshold, mustSpecifyExistingVolumes, arvmConnectivityTestTimeoutExceeded, flashcacheMaxLimitExceeded, volsInVgUsingNonSecureCapableFlashcache, volsInVgUsingSecureDisabledFlashcache, invalidSubmodelId, premiumFeatureLimitMismatch, volumeGroupNotImportable, primaryCacheSizeMismatch, flashcacheUserLabelExists, maxThinVolumesExceeded, arvmInvalidSecondaryCapacity, arvmOnlyPrimaryMemberRemoved, arvmOnlySecondaryMemberRemoved, arvmInvalidAmgRequestWhileSuspended, arvmManualSyncAlreadyInProgress, arvmManualSyncRetryTooSoon, diskPoolNotEmpty, flashCacheInvalidBaseVol, flashCacheFdeEnablementDisallowed, remoteArvmFeatureDeactivated, remoteArvmFeatureDisabled, arvmOrphanGroup, arvmOrphanMember, volumeNotAvailable, volumeHasUnreadableSectors, thinProvisioningFeatureDisabled, pitGroupsFeatureDisabled, exceedDiskPoolLimit, flashcacheDegradedState, flashcacheNonDaCapableDriveDisallowed, arvmMaxAsyncMirrorGroupsExceeded, arvmMaxMirrorsPerArrayExceeded, maxTotalMirrorsPerArrayExceeded, exceedDiskPoolCapacity, exceedMaxVolumeCapacity, arvmRemoteMaxAsyncMirrorGroupsExceeded, arvmRemoteMaxMirrorsPerArrayExceeded, remoteMaxTotalMirrorsPerArrayExceeded, arvmInvalidSyncInterval, remoteNoHeap, remoteInternalError, remoteRvmSpmError, arvmRemoteMirrorMemberDoesNotExist, arvmRemoteGroupUserLabelExists, arvmRemoteGroupNotSecondary, arvmRemoteGroupDoesNotExist, remoteInvalidProtection, remoteDatabaseError, arvmRemoteGroupNotEmpty, arvmRemoteSuspendFailure, arvmRemoteResumeFailure, arvmRemoteSynchronizeFailure, flashcacheInvalidAnalyticsState, arvmExpansionSynchronizationInProgress, arvmRemoteExpansionSynchronizationInProgress, faultConditionStillExists, remoteTryAlternate, arvmOnlyLocalAmgDeleted, arvmRoleChangePending, arvmRoleChangeInProgress, arvmMemberStopped, reconstructionInProgress, copybackInProgress, adminPasswordNotSet, keyDoesNotExist, takeRecoveryActionsFirst, coredumpBackupInProgress, legacyRvmAsyncModeUnsupported, arvmIncorrectVolumeType, thinVolumeParametersCannotBeModified, arvmRemoteThinNotSupported, snmpInvalidCommunityName, snmpInvalidCommunityPermission, snmpInvalidCommunityRef, snmpInvalidTrapDestinationRef, invalidIpAddress, snmpMaxCommunitiesExceeded, snmpMaxTrapDestinationsExceeded, snmpCommunityNameInUse, snmpTrapDestinationAddressInUse, snmpUnknownSystemVariable, snmpInvalidSystemVariableValue, snmpIncompatibleFirmware, snmpAgentDisabled, snmpAgentInitFailed, arvmThinVolInitError, arvmRemoteThinVolInitError, snmpIncompatibleIpv4Address, snmpIncompatibleIpv6Address, drivesNotAvailableForRemoval, snmpCannotDisableIpv4, snmpCannotDisableIpv6, snmpIpv4ConfigError, iocDumpInProgress, iocRestoreInProgress, iocDumpInvalidTag, unsupportedEsmRequest, isnsDhcpNotSupported, dpcVolumeGroupNotRedundant, dpcVolumeNotInitialized, dpcExclusiveOperationActive, dpcUnableToPowerUpDrive, dpcFormatActive, dpcUnreadableSectorsPresent, dpcPowerCycleAlreadyInProgress, dpcEnclosureHardwareUnsupported, dpcEnclosureFwDownlevel, evacInProgress, noEvacFound, noHotspareAvailable, driveServiceInProgress, hdd4kbSegmentsizeNotAllowed, diskPoolNoSpareDrives, diskPoolExceedSpareCapacity, autoLoadBalanceUserDisabled, autoLoadBalanceInsufficientStatistics, invalidLoadBalanceAction, invalidLoadBalanceDelay, reservedAddress, volumeCreationInProgress, keyValueTagInvalidRef, keyValueTagInvalidDuplicate, keyValueTagInUse, workloadInvalidRef, invalidKeyValueTagObjectReference, mappingInvalidDuplicate, downloadCompleteNoReboot, downloadCompleteMswOnlyReboot, workloadInvalidDuplicate, mappingInvalidRef, workloadInUse, embeddedExternalKeyManagementEnabled, embeddedExternalKeyManagementCertificatesNotInstalled, illegalOperationOnAllConfigDrives, databaseResyncInProgress, embeddedEkmsKeyserverInfoMissing, embeddedEkmsClientKeyMissing, embeddedEkmsClientCertMissing, embeddedEkmsClientCertMismatch, embeddedEkmsCertExpired, embeddedEkmsProxyNotResponding, embeddedEkmsAuthenticationFailure, embeddedEkmsKeyOwnerRequired, embeddedEkmsServerError, embeddedEkmsServerCertMissing, embeddedEkmsCertDuplicate, embeddedEkmsCertInvalid, embeddedEkmsConnectionFailure, invalidPasswordLength, certRevoked, missingSignature, sigValidationFailed, unableToConnectToOcspResponder, requestFailedDueToAlbEnabled, __UNDEFINED)

driveStatus
required

The drive status.
Example : [ "DriveDownloadDriveStatus" ]

< DriveDownloadDriveStatus > array

4.193. DriveFirmwareUpdateEntry

Name Description Schema

filename
required

Example : "string"

string

driveRefList
required

Example : [ "string" ]

< string > array

4.194. IomServiceUpdateRequest

API object for an IOM service change request.

Name Description Schema

enabled
required

true to enable the service, false to disable.
Example : true

boolean

4.195. EmbeddedCompatibilityCheckResponse

Reports the compatibility of the firmware/nvsram file and whether a signature is present on the file

Name Description Schema

signatureTestingPassed
required

Indicates if the initial signature validation test passed or not. Full validation will still be performed by the controller before the download can complete.
Example : true

boolean

fileCompatible
required

If the file is compatible
Example : true

boolean

versionContents
required

Enumerates all the versions on the bundle/nvsram file and what is on the controller
Example : [ "VersionContent" ]

< VersionContent > array

4.196. VersionContent

Object that contains definitions for on board and bundled code module versions

Name Description Schema

module
required

The code module described
Example : "string"

enum (unspecified, raid, hypervisor, management, iom, nvsram, bundle, bundleDisplay, __UNDEFINED)

bundledVersion
required

Code bundled with firmware file
Example : "string"

string

onboardVersion
required

Code active on storage system
Example : "string"

string

4.197. CurrentFirmwareResponse

Class that holds details on the Firmware on the array.

Name Description Schema

codeVersions
required

Version descriptors for code modules
Example : [ "VersionDescriptor" ]

< VersionDescriptor > array

4.198. EmbeddedFirmwareResponse

Class that holds details on the Firmware upgrade timestamps and logs.

Name Description Schema

cfwUpgradeTS
required

Timestamp of the last successful controller firmware upgrade
Example : "string"

string (date-time)

iomUpgradeTS
required

Timestamp of the last successful iom firmware upgrade
Example : "string"

string (date-time)

driveUpgradeTS
required

Timestamp of the last successful drive firmware upgrade
Example : "string"

string (date-time)

nvsramUpgradeTS
required

Timestamp of the last successful NVSRAM upgrade
Example : "string"

string (date-time)

cfwLog
required

Array of log records of controller firmware upgrades
Example : [ "LogRecord" ]

< LogRecord > array

iomLog
required

Array of log records of iom firmware upgrades
Example : [ "LogRecord" ]

< LogRecord > array

driveLog
required

Array of log records drive firmware upgrades
Example : [ "LogRecord" ]

< LogRecord > array

nvsramLog
required

Array of log records NVSRAM upgrades
Example : [ "LogRecord" ]

< LogRecord > array

4.199. Enumeration

Type : object

4.200. EnumerationString

Type : object

4.201. Level

Name Description Schema

name
optional

Example : "string"

string

resourceBundleName
optional

Example : "string"

string

localizedName
optional

Example : "string"

string

4.202. Locale

Name Description Schema

language
optional

Example : "string"

string

country
optional

Example : "string"

string

displayCountry
optional

Example : "string"

string

displayLanguage
optional

Example : "string"

string

displayName
optional

Example : "string"

string

displayScript
optional

Example : "string"

string

displayVariant
optional

Example : "string"

string

extensionKeys
optional

Example : [ "string" ]

< string > array

iso3Country
optional

Example : "string"

string

iso3Language
optional

Example : "string"

string

script
optional

Example : "string"

string

unicodeLocaleAttributes
optional

Example : [ "string" ]

< string > array

unicodeLocaleKeys
optional

Example : [ "string" ]

< string > array

variant
optional

Example : "string"

string

4.203. LogRecord

Name Description Schema

level
optional

Example : "Level"

Level

sequenceNumber
optional

Example : "string"

string (int64)

sourceClassName
optional

Example : "string"

string

sourceMethodName
optional

Example : "string"

string

message
optional

Example : "string"

string

threadID
optional

Example : 0

integer (int32)

millis
optional

Example : "string"

string (int64)

thrown
optional

Example : "Throwable"

Throwable

loggerName
optional

Example : "string"

string

resourceBundleName
optional

Example : "string"

string

parameters
optional

Example : [ "object" ]

< object > array

resourceBundle
optional

Example : "ResourceBundle"

ResourceBundle

4.204. ResourceBundle

Name Description Schema

locale
optional

Example : "Locale"

Locale

keys
optional

Example : "EnumerationString"

EnumerationString

baseBundleName
optional

Example : "string"

string

4.205. StackTraceElement

Name Description Schema

methodName
optional

Example : "string"

string

fileName
optional

Example : "string"

string

lineNumber
optional

Example : 0

integer (int32)

className
optional

Example : "string"

string

nativeMethod
optional

Example : true

boolean

4.206. Throwable

Name Description Schema

cause
optional

Example : "Throwable"

Throwable

stackTrace
optional

Example : [ "StackTraceElement" ]

< StackTraceElement > array

localizedMessage
optional

Example : "string"

string

message
optional

Example : "string"

string

suppressed
optional

Example : [ "Throwable" ]

< Throwable > array

4.207. IomServiceInfoResponse

API object that includes information about the IOM service.

Name Description Schema

iomServiceEnabled
required

Reports whether the IOM service is enabled.
Example : true

boolean

disruptiveIomFirmwareUpdate
required

Reports whether there are any trays for which an IOM firmware update would be disruptive.
Example : true

boolean

4.208. LocalUserInfoResponse

Local admin password

Name Description Schema

adminPasswordSet
required

True if the admin password is set
Example : true

boolean

minimumPasswordLength
required

The minimum required length
Example : 0

integer (int32)

4.209. LocalUserResponse

Information about a local user account

Name Description Schema

userName
required

The username for this local account
Example : "string"

string

roles
required

The list of roles assigned to this user
Example : [ "string" ]

< string > array

passwordSet
required

True if the password is not the default
Example : true

boolean

4.210. LocalUserPasswordRequest

Request to change the local user account password

Name Description Schema

userName
required

The local account user to update
Example : "string"

string

newPassword
optional

The new password to use for local account.
Example : "string"

string

4.211. LocalUserRequest

Request to change one or more local user account password

Name Description Schema

currentAdminPassword
optional

Password for the admin user
Example : "string"

string

updates
optional

List of updates to perform to local users
Example : [ "LocalUserPasswordRequest" ]

< LocalUserPasswordRequest > array

4.212. LocalUsersMinPasswordRequest

Set the minimum password length

Name Description Schema

minimumPasswordLength
required

The minimum password length required
Example : 0

integer (int32)

4.213. SessionSettingsResponse

Server session settings response.

Name Description Schema

minimumSessionInactivePeriod
required

Minimum session inactivity period, in seconds.
Example : 0

integer (int32)

sessionInactivePeriod
required

Session inactivity period, in seconds, before the session times out. A value of zero indicates the session should never timeout.
Example : 0

integer (int32)

4.214. SessionSettings

Server session settings.

Name Description Schema

sessionInactivePeriod
required

Session inactivity period, in seconds, before the session times out. A value of zero indicates the session should never timeout.
Example : 0

integer (int32)

4.215. AuthenticationSettings

Server authentication settings.

Name Description Schema

disableBasicAuthentication
required

Disable Basic Authentication, a value of false will allow Basic Authentication, a value of true will prevent Basic Authentication.
Example : true

boolean

4.216. Event

Base event object

Name Description Schema

timestamp
required

Example : "string"

string (date-time)

eventNumber
required

Example : "string"

string (int64)

eventType
optional

Example : "string"

enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent)

4.217. EventObjectIdentifier

This class identifies an object in the system. It is an Object Type and an Object Key. The get is usually the fields named "id" or xxxRef in the object. The type field indicates the type of object

Name Description Schema

type
required

Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

id
required

Example : "string"

string

userFriendlyId
required

Example : "string"

string

modifiedFields
required

Example : [ "string" ]

< string > array

4.218. FolderEvent

Polymorphism : Inheritance
Discriminator : eventType

Name Description Schema

timestamp
required

Example : "string"

string (date-time)

eventNumber
required

Example : "string"

string (int64)

eventType
required

Example : "string"

enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent)

addedObjects
required

List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

modifiedObjects
required

List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

deletedObjects
required

List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

4.219. MetadataChangeEvent

Polymorphism : Inheritance
Discriminator : eventType

Name Description Schema

timestamp
required

Example : "string"

string (date-time)

eventNumber
required

Example : "string"

string (int64)

eventType
required

Example : "string"

enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent)

addedObjects
required

List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

modifiedObjects
required

List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

deletedObjects
required

List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

storageSystemId
required

Example : "string"

string

4.220. ObjectChangeEvent

Polymorphism : Inheritance
Discriminator : eventType

Name Description Schema

timestamp
required

Example : "string"

string (date-time)

eventNumber
required

Example : "string"

string (int64)

eventType
optional

Example : "string"

enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent)

addedObjects
required

List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

modifiedObjects
required

List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

deletedObjects
required

List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

4.221. ObjectGraphChangeEvent

Polymorphism : Inheritance
Discriminator : eventType

Name Description Schema

timestamp
required

Example : "string"

string (date-time)

eventNumber
required

Example : "string"

string (int64)

eventType
required

Example : "string"

enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent)

addedObjects
required

List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

modifiedObjects
required

List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

deletedObjects
required

List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

storageSystemId
required

Example : "string"

string

currentConfigGen
required

The config gen number associated to the with these events.
Example : "string"

string (int64)

previousConfigGen
required

The config gen number that was currently known. It is possible for there to be a gap between currentConfig and previous Don’t expect them to be sequential
Example : "string"

string (int64)

systemWWN
required

The storage systems World Wide Name
Example : "string"

string

4.222. PasswordStatusEvent

Polymorphism : Inheritance
Discriminator : eventType

Name Description Schema

timestamp
required

Example : "string"

string (date-time)

eventNumber
required

Example : "string"

string (int64)

eventType
required

Example : "string"

enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent)

previousStatus
required

Example : "string"

enum (unknown, invalid, valid, securityLockout)

currentStatus
required

Example : "string"

enum (unknown, invalid, valid, securityLockout)

storageSystemId
required

Example : "string"

string

4.223. StorageDeviceStatusEvent

Polymorphism : Inheritance
Discriminator : eventType

Name Description Schema

timestamp
required

Example : "string"

string (date-time)

eventNumber
required

Example : "string"

string (int64)

eventType
required

Example : "string"

enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent)

previousStatus
required

Example : "string"

enum (neverContacted, offline, optimal, needsAttn, removed, newDevice, lockDown)

currentStatus
required

Example : "string"

enum (neverContacted, offline, optimal, needsAttn, removed, newDevice, lockDown)

storageSystemId
required

Example : "string"

string

systemWWN
required

Example : "string"

string

4.224. TagEvent

Polymorphism : Inheritance
Discriminator : eventType

Name Description Schema

timestamp
required

Example : "string"

string (date-time)

eventNumber
required

Example : "string"

string (int64)

eventType
required

Example : "string"

enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent)

addedObjects
required

List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

modifiedObjects
required

List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

deletedObjects
required

List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events
Example : [ "EventObjectIdentifier" ]

< EventObjectIdentifier > array

4.225. EKMSCommunicationResponse

Indicates whether the symbol command executed successfully along with the return code from the symbol command.

Name Description Schema

successful
required

Indicates if the symbol command executed successfully.
Example : true

boolean

returnCode
required

The return code returned by the symbol command.
Example : "string"

enum (uninitialized, ok, error, busy, illegalParam, noHeap, driveNotExist, driveNotUnassigned, noSparesAssigned, someSparesAssigned, volumeNotExist, volumeReconfiguring, notDualActive, tryAlternate, background, notImplemented, reservationConflict, volumeDead, internalError, invalidRequest, iconFailure, volumeFormatting, altRemoved, cacheSyncFailure, invalidFile, reconfigSmallDacstore, reconfigFailure, nvramError, flashError, authFailParam, authFailPassword, memParityError, invalidControllerref, invalidVolumegroupref, invalidVolumeref, invalidDriveref, invalidFreeextentref, volumeOffline, volumeNotOptimal, modesenseError, invalidSegmentsize, invalidCacheblksize, invalidFlushThreshold, invalidFlushAmount, invalidLabel, invalidCacheModifier, invalidReadahead, invalidReconpriority, invalidScanperiod, invalidTrayposLength, invalidRegionid, invalidFibreid, invalidEncryption, invalidRaidlevel, invalidExpansionList, noSparesDeassigned, someSparesDeassigned, partDupId, partLabelInvalid, partNodeNonexistent, partPortIdInvalid, partVolumeNonexistent, partLunCollision, maxVolMappingExceeded, partMappingNonexistent, partNoHostports, imageTransferred, fileTooLarge, invalidOffset, overrun, invalidChunksize, invalidTotalsize, downloadNotPermitted, spawnError, voltransferError, invalidDlstate, cacheconfigError, downloadInProgress, driveNotOptimal, driveRemoved, duplicateDrives, numdrivesAdditional, numdrivesGroup, driveTooSmall, capacityConstrained, maxVolumesExceeded, partIsUtmLun, someSparesTooSmall, sparesSmallUnassigned, tooManyPartitions, parityScanInProgress, invalidSafeId, invalidSafeKey, invalidSafeCapability, invalidSafeVersion, partitionsDisabled, driveDownloadFailed, esmDownloadFailed, esmPartialUpdate, utmConflict, noVolumes, authFailReadpassword, partCrteFailTblFull, attemptToSetLocal, invalidHostTypeIndex, failVolumeVisible, noDeleteUtmInUse, invalidLun, utmTooManyMaps, diagReadFailure, diagSrcLinkDown, diagWriteFailure, diagLoopbackError, diagTimeout, diagInProgress, diagNoAlt, diagIconSendErr, diagInitErr, diagModeErr, diagInvalidTestId, diagDriveErr, diagLockErr, diagConfigErr, diagNoCacheMem, diagNotQuiesced, diagUtmNotEnabled, invalidModeSwitch, invalidPortname, duplicateVolMapping, maxSnapsPerBaseExceeded, maxSnapsExceeded, invalidBasevol, snapNotAvailable, notDisabled, snapshotFeatureDisabled, repositoryOffline, repositoryReconfiguring, rollbackInProgress, numVolumesGroup, ghostVolume, repositoryMissing, invalidRepositoryLabel, invalidSnapLabel, invalidRollbackPriority, invalidWarnThreshold, cannotMapVolume, cannotFormatVolume, dstNotFibre, repositoryTooSmall, repositoryFailed, baseVolumeFailed, baseVolumeOffline, baseVolumeFormatting, metadataVolNonexistent, rvmFeatureDisabled, mirrorsPresent, rvmFeatureDeactivated, maxMirrorsExceeded, invalidMirrorCandidateVol, invalidMirrorvol, metadataAlreadyExists, metadataMissing, metadataOffline, metadataReconfiguring, localRoleChangeFailed, remoteRoleChangeFailed, localRoleChangeSuccessful, onlyLocalMirrorDeleted, noValidMirrorCandidate, remoteMaxMirrorsExceeded, remoteRvmFeatureDisabled, remoteMetadataVolNonexistent, notRegistered, remoteInvalidCfgGen, localRoleChangedNotForced, remoteRoleChangedLocalFailed, rvmSpmError, remoteAuthFailPassword, rvmVersionMismatch, rvmRemoteArrayError, rvmCommunicationError, rvmFibreError, mirrorVolNotPrimary, secNotPromoteable, priNotDemoteable, metadataChildDeletion, rmtvolOrphanDeletion, rvmActivateDisallowed, invalidTrayref, partialDeletion, defaultUtmCollision, invalidCopyPriority, invalidVolumecopyref, copyChangeFailed, copyActive, copyInactive, copyIncompatibleSource, copyIncompatibleTarget, copyGhostSource, copyGhostTarget, copyInvalidSourceRef, copyInvalidTargetRef, copyInvalidSourceState, copyInvalidTargetState, copySourceReconfig, copyTargetReconfig, copyTargetTooSmall, copyTargetLimit, maxVolumeCopysExceeded, copySourceReservation, copyTargetReservation, copySourceFormat, copyTargetFormat, copyStartFailed, copyStopFailed, volcopyFeatureDisabled, writeLock, cannotReconfigure, authFailContLockout, prReservationConflict, regDeleteFailed, batteryNotInConfig, batteryMissing, noChannel, rvmOperNotAllowedOnSec, dataRedundancyRequired, copySourceZeroCapacity, invHostlunDefineMapping, invHostlunMoveMapping, invHostlunDefineHosttype, invHostlunMoveHostport, fwIncompatible, mirrorAlreadySuspended, insuffLocalMirRepResources, insuffRemtMirRepResources, ghostHasUnreadableSectors, rvmCommStatRecoveredTimeout, rvmCommStatRecoveredDelay, rvmCommStatNotReady, rvmCommStatTimeout, rvmCommStatChannelFailure, rvmCommStatNetworkFailure, rvmCommStatDeviceMissing, rvmCommStatLoginRejected, rvmCommStatLoginFailure, rvmCommStatInvNumSamplesReqd, rvmQuiescenceInProgress, rvmInvalidRemotevol, sodInProgress, invalidDrives, invalidSetid, invalidSetsize, missingData, quiescenceFailed, validationError, downloadHalted, allFailed, partialOk, obsolete, usmClearFailed, controllerInServiceMode, invalidDrive, databaseError, backgroundAutocfg, autocfgInprogress, unsupportedLhaSataEsm, parityScanFailed, parityRepairFailed, mediaRepairFailed, mirrorDegraded, prohibitedByMdtRestrictions, prohibitedByGoldKeyRestrictions, safeControllerNotSubjectToGoldKey, safeMdtNotPremiumFeature, alarmNotPresent, dltNotCompleted, dependancyError, cdmDatabaseFull, requiredConditionNotPresent, ddcUnavail, ddcIllegalParam, invalidDdcTag, hosttypeConflict, portConflict, invalidHosttypeString, invalidProtocol, portRemoved, disableNotPermitted, prohibitedByDriveTrayLimit, invalidEsmref, invalidBundleMigration, invalidBundleKey, noSparesNeeded, prohibitedByFeatureBundleViolation, invalidAuthMethod, invalidSecret, secretAlreadyInUse, manualConfigModeSet, noIscsiSessions, invalidInterfaceref, initiatorConflict, initiatorRemoved, basevolSizeChanged, volumeGroupNotExist, volumeGroupNotOnline, volumeGroupHasHotspare, volumeGroupReconfiguring, volumeGroupStateNotValid, controllerNotOptimal, insufficientCapacity, volumeGroupExported, volumeNotConfigurable, volumeGroupNotConfigurable, invalidDriveState, volumeGroupReconstructing, volumeGroupUndergoingCopyback, volumeGroupNotComplete, volumeGroupHasFailedDrives, volumeGroupHasNonOptimalVols, volumeGroupHasMirrorRelationship, volumeGroupHasVolcopyRelationship, volumeGroupHasMirroringMetadata, volumeGroupHasMappedVols, volumeGroupHasReservations, volumeGroupHasIncompatibleDacstores, volumeLimitExceeded, volumeGroupHasUnknownRaidLevel, volumeGroupHasUnsupportedRaidLevel, volumeGroupHasCloneOpportunity, volumeGroupHasInsufficientDrives, volumeGroupHasFailedVols, perfTierSafeUpgradeDisabled, raid6FeatureUnsupported, raid6FeatureDisabled, safeControllerNotSubjectToRaid6, volumeGroupNotContingent, channelDiagsRunning, channelDiagsResultsPartial, volumeGroupHasSnapshotRelationship, prohibitedBySafeViolation, legacyVg, vgNotForceable, channelDiagsLockErr, channelDiagsNotQuiesced, channelDiagsAltCommFailed, channelDiagsChanSetupFailed, channelDiagsDeviceBypassFailed, channelDiagsResultsNotAvailable, driveSpinUpError, driveTypeMismatch, localRemoteArrayHasSameWwn, volumeGroupHasIncompatibleDrive, volumeGroupVolumeEncroachesOnDacstore, volumeGroupImportInProgress, drivesNeedToBeSpunUp, noNativeSstor, noSuchDebugChunk, debugInfoConfigChanged, lockdown, drivesDacstoresOverlap, volumeHasAsyncMirror, reconfigLogSpaceError, volumeGroupInaccessible, volumeInitializing, insufficientCache, volumeInaccessible, noDrivesAdopted, someDrivesAdopted, exportingDrivesDatabaseResynchronizing, exportingDrivesDatabaseFailed, exportingDrivesQuiesced, learnActiveTryLater, noLockedDrives, driveSecurityEnabledFailed, lockkeyFailed, invalidSecurity, noFdeDrives, volumeGroupSecure, invalidBlob, unlockFailed, noKeySet, rekeyInProgress, defaultHostGroupMappingNotAllowed, ssdMediaScanNotAllowed, premiumFeatureLimitExceedsMaximum, disableEvaluationFeatureNotPermitted, requestFailedDueToLun0Restrictions, externalKmsEnabled, externalKmsFailed, externalKmsNotEnabled, keyNotNeeded, keyInvalidSequence, diagNotRunning, ctrlNotInServiceMode, invalidFeatureref, cacheBackupDevNotExist, noMatchingLockKeyIdFound, lockKeyValidationFailed, lockKeyValidationDisabled, externalKmsNotCompliant, externalKmsTimeout, cannotDisableNoKey, previouslyEnabledForEval, featureNotKeyable, evalNotSupported, rawdataTransferBadType, rawdataTransferNotStarted, rawdataTransferAlreadyStarted, rawdataTransferPreparing, rawdataTransferReadError, rawdataTransferNoDrives, rawdataTransferInvalidImage, rawdataTransferCrcError, dbmRestoreWriteError, dbmRestoreNoDrives, rawdataBadSeqNum, invalidCapability, externalKeyNotInMemory, invalidLockKeyId, invalidProtection, volumeHasSnapshotRelationship, volumeHasMirrorRelationship, externalKmsDisabledNoKey, dbmRestoreAltCtlNotOffline, copyApptagMismatch, invalidRequestForEnclosure, dqRetrieveNothingToTransfer, invalidIscsiConfiguration, volumeHasVolcopyRelationship, partPiIncapable, requestFailedDueToPiRestrictions, rawdataTransferUserCancelled, duplicateIscsiIpAddress, portSpeedConflict, factoryDefaultDownloadFailed, errorWritingToEeprom, factoryDefaultPartialUpdate, snapshotNotActive, cannotRollback, mirrorSyncNotPossible, psuFirmwareDownloadFailed, psuFirmwareUpdateMfgDeviceCodeMismatch, psuFirmwareUpdateNotAllRedundant, psuFirmwareUpdateNotAllOptimal, insufficientRepositoryCapacity, rollbackStartFailure, csbReserveFailed, csbReleaseFailedNoLock, csbReleaseFailedInvalidKey, flashcacheAlreadyExists, flashcacheFeatureDisabled, flashcacheAlreadySuspended, flashcacheNotSuspended, flashcacheInvalidConfigType, invalidPitGroupLabel, invalidPitConsistencyGroupLabel, invalidPitAutoDeleteLimit, invalidPitRepositoryFullPolicy, invalidConcatVolMemberLabel, concatVolMemberTooSmall, invalidPitGroupRef, invalidPitRef, dveNotAllowed, dssNotAllowed, dplCoreDumpInvalidTag, invalidPitViewLabel, invalidPitViewRef, invalidConcatVolRef, notFlashcacheVol, flashcacheDeleted, flashcacheEnabled, flashcacheNotEnabled, noRepDeletion, maxPitsPerGroupExceeded, maxPitsExceeded, maxPitGroupsPerBaseExceeded, maxPitGroupsExceeded, maxViewsPerPitExceeded, maxViewsExceeded, maxConsistencyGroupsExceeded, maxConsistencyGroupMembersExceeded, maxMappableVolumesExceeded, notOldestPit, viewStopped, concatMemberLimitExceeded, invalidMemberVol, memberVolMapped, invalidMemberVolState, invalidTrimCount, pitGroupInConsistencyGroup, pitInConsistencyGroup, pitViewInConsistencyGroup, incompatibleMemberVol, volumeInUse, rvmOverIscsiNotSupported, arvmGroupUserLabelExists, arvmGroupDoesNotExist, arvmGroupNotEmpty, concatVolumeFailed, invalidPitConsistencyGroupRef, invalidPitConsistencyGroupViewRef, invalidPitConsistencyGroupViewLabel, alternateRequiredForOperation, invalidPitForView, consistencyGroupArvmBindingConflict, attributeFixedByArvm, operationFailedVolumeCopyClone, pitCreatePending, dbmDbSourceUnavailable, dbmRestoreSourceMismatch, invalidCriticalThreshold, volumeGroupHasArvmRelationship, arvmRecoveryPointDeletionRequired, volumeGroupHasPitgroupRelationship, volumeGroupHasPitviewRelationship, volumeGroupHasConcatRelationship, flashcacheSuspended, flashcacheAlreadyEnabled, dbmDbImageCorrupt, illegalVolume, invalidRepositoryCapacity, invalidProvisionedCapacityQuota, invalidExpansionPolicy, invalidVirtualCapacity, cannotExpandConcatMember, thresholdBelowUsedCapacity, invalidExpansionOperation, repositoryFull, insufficientExpansionSpace, invalidExpansionSize, invalidReinitAction, invalidReinitCapacity, invalidIncompleteMemberRef, arvmGroupNotPrimary, arvmGroupNotSecondary, arvmMemberFailed, arvmGroupNotSuspended, arvmInvalidMirrorState, arvmVolumeAlreadyInMirrorRelationship, arvmMemberLimitExceeded, arvmSuspendFailure, arvmResumeFailure, arvmSynchronizeFailure, remoteTargetNotFound, arvmMirrorMemberDoesNotExist, snapConversionTooManySnaps, snapConversionMissingLabel, arvmFeatureDeactivated, incompatibleRepositorySecurity, incompatibleSecondarySecurity, mirrorProtocolMismatch, arvmAsyncMirrorGroupPresent, cacheParametersNotChangeable, flashcacheMaxCapacityExceeded, flashcacheFailed, dplCoreDumpRestoreInProgress, arvmGroupHasIncompleteMember, arvmConnectivityTestAlreadyInProgress, arvmConnectivityTestNetworkError, arvmConnectivityTestRemoteTimeout, arvmConnectivityTestLoginFailure, arvmConnectivityTestNameServiceError, arvmConnectivityTestTurError, arvmConnectivityTestMissingRemoteAmg, arvmConnectivityTestAmgMemberMismatch, invalidSyncPriority, invalidRecoveryPointAlertThreshold, invalidSyncAlertThreshold, mustSpecifyExistingVolumes, arvmConnectivityTestTimeoutExceeded, flashcacheMaxLimitExceeded, volsInVgUsingNonSecureCapableFlashcache, volsInVgUsingSecureDisabledFlashcache, invalidSubmodelId, premiumFeatureLimitMismatch, volumeGroupNotImportable, primaryCacheSizeMismatch, flashcacheUserLabelExists, maxThinVolumesExceeded, arvmInvalidSecondaryCapacity, arvmOnlyPrimaryMemberRemoved, arvmOnlySecondaryMemberRemoved, arvmInvalidAmgRequestWhileSuspended, arvmManualSyncAlreadyInProgress, arvmManualSyncRetryTooSoon, diskPoolNotEmpty, flashCacheInvalidBaseVol, flashCacheFdeEnablementDisallowed, remoteArvmFeatureDeactivated, remoteArvmFeatureDisabled, arvmOrphanGroup, arvmOrphanMember, volumeNotAvailable, volumeHasUnreadableSectors, thinProvisioningFeatureDisabled, pitGroupsFeatureDisabled, exceedDiskPoolLimit, flashcacheDegradedState, flashcacheNonDaCapableDriveDisallowed, arvmMaxAsyncMirrorGroupsExceeded, arvmMaxMirrorsPerArrayExceeded, maxTotalMirrorsPerArrayExceeded, exceedDiskPoolCapacity, exceedMaxVolumeCapacity, arvmRemoteMaxAsyncMirrorGroupsExceeded, arvmRemoteMaxMirrorsPerArrayExceeded, remoteMaxTotalMirrorsPerArrayExceeded, arvmInvalidSyncInterval, remoteNoHeap, remoteInternalError, remoteRvmSpmError, arvmRemoteMirrorMemberDoesNotExist, arvmRemoteGroupUserLabelExists, arvmRemoteGroupNotSecondary, arvmRemoteGroupDoesNotExist, remoteInvalidProtection, remoteDatabaseError, arvmRemoteGroupNotEmpty, arvmRemoteSuspendFailure, arvmRemoteResumeFailure, arvmRemoteSynchronizeFailure, flashcacheInvalidAnalyticsState, arvmExpansionSynchronizationInProgress, arvmRemoteExpansionSynchronizationInProgress, faultConditionStillExists, remoteTryAlternate, arvmOnlyLocalAmgDeleted, arvmRoleChangePending, arvmRoleChangeInProgress, arvmMemberStopped, reconstructionInProgress, copybackInProgress, adminPasswordNotSet, keyDoesNotExist, takeRecoveryActionsFirst, coredumpBackupInProgress, legacyRvmAsyncModeUnsupported, arvmIncorrectVolumeType, thinVolumeParametersCannotBeModified, arvmRemoteThinNotSupported, snmpInvalidCommunityName, snmpInvalidCommunityPermission, snmpInvalidCommunityRef, snmpInvalidTrapDestinationRef, invalidIpAddress, snmpMaxCommunitiesExceeded, snmpMaxTrapDestinationsExceeded, snmpCommunityNameInUse, snmpTrapDestinationAddressInUse, snmpUnknownSystemVariable, snmpInvalidSystemVariableValue, snmpIncompatibleFirmware, snmpAgentDisabled, snmpAgentInitFailed, arvmThinVolInitError, arvmRemoteThinVolInitError, snmpIncompatibleIpv4Address, snmpIncompatibleIpv6Address, drivesNotAvailableForRemoval, snmpCannotDisableIpv4, snmpCannotDisableIpv6, snmpIpv4ConfigError, iocDumpInProgress, iocRestoreInProgress, iocDumpInvalidTag, unsupportedEsmRequest, isnsDhcpNotSupported, dpcVolumeGroupNotRedundant, dpcVolumeNotInitialized, dpcExclusiveOperationActive, dpcUnableToPowerUpDrive, dpcFormatActive, dpcUnreadableSectorsPresent, dpcPowerCycleAlreadyInProgress, dpcEnclosureHardwareUnsupported, dpcEnclosureFwDownlevel, evacInProgress, noEvacFound, noHotspareAvailable, driveServiceInProgress, hdd4kbSegmentsizeNotAllowed, diskPoolNoSpareDrives, diskPoolExceedSpareCapacity, autoLoadBalanceUserDisabled, autoLoadBalanceInsufficientStatistics, invalidLoadBalanceAction, invalidLoadBalanceDelay, reservedAddress, volumeCreationInProgress, keyValueTagInvalidRef, keyValueTagInvalidDuplicate, keyValueTagInUse, workloadInvalidRef, invalidKeyValueTagObjectReference, mappingInvalidDuplicate, downloadCompleteNoReboot, downloadCompleteMswOnlyReboot, workloadInvalidDuplicate, mappingInvalidRef, workloadInUse, embeddedExternalKeyManagementEnabled, embeddedExternalKeyManagementCertificatesNotInstalled, illegalOperationOnAllConfigDrives, databaseResyncInProgress, embeddedEkmsKeyserverInfoMissing, embeddedEkmsClientKeyMissing, embeddedEkmsClientCertMissing, embeddedEkmsClientCertMismatch, embeddedEkmsCertExpired, embeddedEkmsProxyNotResponding, embeddedEkmsAuthenticationFailure, embeddedEkmsKeyOwnerRequired, embeddedEkmsServerError, embeddedEkmsServerCertMissing, embeddedEkmsCertDuplicate, embeddedEkmsCertInvalid, embeddedEkmsConnectionFailure, invalidPasswordLength, certRevoked, missingSignature, sigValidationFailed, unableToConnectToOcspResponder, requestFailedDueToAlbEnabled, __UNDEFINED)

4.226. X509ExternalCertInfo

Basic information for X509 External certificates stored in the system.

Name Description Schema

kmsAddress
optional

Example : "NetworkAddress"

NetworkAddress

kmsPort
optional

Example : 0

integer (int32)

clientKmsType
optional

Example : "string"

enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED)

clientSubjectDN
optional

Example : "string"

string

clientIssuerDN
optional

Example : "string"

string

clientStart
optional

Example : "string"

string (date-time)

clientExpire
optional

Example : "string"

string (date-time)

serverKmsType
optional

Example : "string"

enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED)

serverSubjectDN
optional

Example : "string"

string

serverIssuerDN
optional

Example : "string"

string

serverStart
optional

Example : "string"

string (date-time)

serverExpire
optional

Example : "string"

string (date-time)

4.227. SecureVolumeExternalKeyResponse

Name Description Schema

fileSize
required

The size of the file
Example : "string"

string (int64)

fileID
required

The GUID for the file
Example : "string"

string

fileURL
required

The URL for the file
Example : "string"

string (uri)

lockKeyId
required

The id of the lock key.
Example : "string"

string

4.228. EnableDisableEkmsRequest

This class describes the input for a Certificate Signing Request needed to create a client side certificate for External Key Manager integration

Name Description Schema

passPhrase
required

The passPhrase for the security key that will be created
Example : "string"

string

ekmsOption
required

Indicates if EKMS should be enabled, disabled or the key should be changed
Example : "string"

enum (enable, disable, changeKey)

4.229. EnableExternalKeyServerRequest

Used to set the parameters necessary to communicate with an external key management server.

Name Description Schema

keyServerAddress
required

IP or DNS address of the KMS server
Example : "NetworkAddress"

NetworkAddress

port
required

Port for the KMS server
Example : 0

integer (int32)

4.230. ExternalKeyManagerCSR

This class describes the input for a Certificate Signing Request needed to create a client side certificate for External Key Manager integration

Name Description Schema

commonName
required

Typically pre-populated with the storage array name
Example : "string"

string

organizationName
required

The full legal name of the organization
Example : "string"

string

organizationalUnitName
optional

The division of the organization handling the certificate
Example : "string"

string

localityName
required

City or Locality for the organization
Example : "string"

string

stateProvinceName
optional

The full name of the state or province for the organization
Example : "string"

string

countryName
required

The two letter country ISO code for the organization
Example : "string"

string

4.231. FailureData

A failure currently active on the storage system

Name Description Schema

failureType
optional

The type of failure
Example : "string"

enum (unknownFailure, failedFan, failedPowerSupply, failedMinihub, failedEsm, batteryNearExpiration, failedBattery, nominalTempExceeded, maxTempExceeded, upsOnBattery, nonPreferredPath, memParityError, failedDriveScsiChannel, degradedVolume, failedVolumeInterruptedWrite, failedModifyingVolume, failedModifyingMultiRaid, failedVolume, failedVolumeMultiRaid, impairedVolume, failedVolumeAwaitingInit, volumeHotSpareInUse, offlineVolumeGroup, failedDrive, impendingDriveFailureRiskHigh, impendingDriveFailureRiskMed, impendingDriveFailureRiskLow, uncertifiedDrive, offlineCtl, passiveCtl, partitionsNotCompliant, esmCodeVersionMismatch, lostRedundancyDrive, lostRedundancyTray, lostRedundancyEsm, trayidMismatch, trayidConflict, failedTransceiverModule, channelMiswire, nonFruBatteryNearExpiration, nonFruFailedBattery, rpaErrCtl, repositoryOverThreshold, repositoryFull, snapshotFailed, unsupportedMinihub, esmMiswire, ghostVolume, snapshotNotCompliant, rvmNotCompliant, metadataOffline, mirrorDualPrimary, mirrorDualSecondary, mirrorUnsynchronized, remoteNoLun, remoteNoArray, remoteNoFabric, remoteWwnChangeFailed, fanUnknownStat, powerSupplyUnknownStat, esmUnknownStat, tempSensorUnknownStat, transModUnknownStat, driveBypassedSpeedMismatch, driveBypassedCauseUnknown, minihubSpeedMismatch, removedEsm, removedBattery, nonFruRemovedBattery, volcopyFailed, volcopyNotCompliant, channelDegraded, unsupportedTray, speedNegError, usmDatabaseFull, usmUnreadableSectorsExist, pathDegraded, netSetupError, mismatchedDriveType, ctlMismatch, failedDiscreteLine, channelFailed, linkSpeedDetectionMismatch, uncertifiedEsm, removedFan, removedPowerSupply, removedTempSensor, removedIccCru, removedSupportCru, failedIccCru, failedSupportCru, batteryUnknownStat, driveTraysNotGroupedTogether, goldKeyNotCompliant, mismatchedMdtSettings, mismatchedGoldKeySettings, ctlMiswire, supportCruNoinput, submodelNotSupported, submodelNotSet, submodelMismatch, failedBatterySystem, removedBatteryPack, batteryConfigMismatch, esmHardwareMismatch, hostBoardFault, ddcAvailable, replacedDriveWrongType, redundantPsRequired, driveTraysNotCompliant, sasDeviceLimitExceeded, sasPortMiswired, sasPortDegraded, sasPortFailed, corruptVpdEeprom, failedI2cBus, enclosureMisconfigured, featureBundleNotCompliant, driveBypassedSinglePort, esmFactoryDefaultsMismatch, hostBoardUnknownStat, failedHostIoCard, batteryWarn, volumeGroupPartiallyComplete, volumeGroupIncomplete, volumeGroupMissing, hotspareDriveMissing, driveIncompatibleUprevDacstore, driveIncompatibleDownrevDacstore, iccCruUnknownStat, removedAlarm, supportCruUnknownStat, performanceTierNotCompliant, raid6NotCompliant, driveIncompatibleSectorSize, foreignDriveInconsistent, foreignDriveRefersToNativeDrive, nativeVgRefersToForeignDrive, nativeVgForeignDriveMutualRef, vgCloned, foreignDriveHasInconsistentRole, vgDrivePartOfMultipleVgs, incompatibleFailedLegacyDrive, unsupportedCacheMemorySize, dedicatedMirrorChannelFailed, vgHasDrivePartOfMultipleVgs, ddfDriveOtherVendor, multipleConfigDatabasesDetected, adoptionFailedRaidLevelUnsupported, dbAdoptionHardLimitExceeded, legacyVgNotOptimal, cacheMemSizeMismatch, altCtlrBoardIdUnreadable, cacheBackupDeviceFailed, cacheBackupDeviceWriteProtected, cacheBackupDeviceInsufficientCapacity, expiredBattery, expiredIntegratedBattery, procMemTooSmallForCache, batteryOvertemp, invalidHostTypeIndex, insufficientProcMemory, ctlFailedCacheBackupDev, removedController, degradedHostIoCard, ldFwVersionMismatch, ldIncompatibleDatabase, hostBoardIdMismatch, iccMissing, linkSpeedMismatch, unsupportedHostBoard, writebackCachingDisabled, securityGetKey, securityKeyInconsistent, securityNotCompliant, mixedDriveEnclosureMiswire, unsuccessIsolationRedunMismatch, thresExcdedMismatchCorrected, inactiveHostPort, inactiveInitiator, protectionInformationNotCompliant, protectionInformationNotSupported, replacedInsufficientDriveCapacity, drawerFailed, drawerOpened, ssdNotCompliant, ssdAtEndOfLife, fibreTrunkMiswire, fibreTrunkIncompatibleEsm, driveSlotLimitNotCompliant, securityGetNewKey, externalKmsNotCompliant, sbbValidationFailure, invalidPowerSupply, enclosureThermalShutdown, wbCachingForciblyDisabled, driveUnsupportedProtocolConnection, failedTwiBus, mismatchedMidplaneEeproms, driveUnsupportedCapacity, evaluationLicenseExpirationImminent, externalKmsKeyInvalid, multipleMismatchedKeyIdsFound, securityKeyValidationLock, cacheDataLoss, baseControllerDiagFailed, featureNotCompliant, driveIncompatiblePiType, drawerDegraded, offlineCtlIocFail, invalidSataFlashConfiguration, iocDiagFail, sasPhyDisabledLocalWidePortDegraded, sasPhyDisabledSharedWidePortDegraded, drawerInvalid, drawerRemoved, driveUnsupportedInterposerFwVersion, redundancyGroupNotConsistentDuringReconfig, snapshotRollbackPaused, pitRollbackPaused, pitGroupRepositoryOverThreshold, pitViewRepositoryOverThreshold, pitGroupRepositoryFull, pitViewRepositoryFull, pitGroupFailed, pitViewFailed, pitPurged, arvmDegradedMirrorGroup, arvmFailedMirror, arvmSyncIntervalTimeOverThreshold, arvmRepositoryOverWarnThreshold, arvmMirrorGroupRoleConflict, incompatibleVolumeGroupSecurity, arvmOrphanGroup, arvmOrphanMember, arvmMirrorGroupRecoveryPointLost, diskPoolPartiallyPresent, diskPoolIncomplete, diskPoolMissing, diskPoolReconstructionDriveCountBelowThreshold, diskPoolUtilizationWarning, diskPoolUtilizationCritical, pendingPitCreationFailed, pendingCgpitCreationFailed, tpvRepositoryOverThreshold, tpvRepositoryFull, tpvFailed, arvmSecondaryRepositoryFull, arvmSyncInternallySuspended, databaseRecoveryMode, arvmPrimaryRepositoryFull, incompatibleSataDrive, diskPoolCapacityDepleted, driveIncompatibleModelNumberUnsupported, flashCacheNonOptimalDrives, flashCacheHotSpareInUse, allDrivesBypassedIncompatibleNvsram, diskPoolDriveFailure, diskPoolInsufficientMemory, arvmOrphanIncompleteMember, arvmSyncPausedAltState, arvmRoleChangePaused, driveIncompatibleAlignmentForEmulationDrive, lossOfExternalRedundancy, rvmWriteModeInconsistent, sasHostMiswire, sasCrossMiswire, sasLoopMiswire, copyThenFailWaitingOnHotSpare, missingDriveLockdown, hicConfigurationOoc, copyThenFailWaitingOnDdpCapacity, piErrorServiceMode, piErrorLockdown, sasPortDiscoveryError, netNtpResolutionFail, netNtpQueryFail, netNtpServiceUnavailable, multipathConfigurationError, hostRedundancyLost, excessiveRebootsDetected, cacheNotFlushedOnOnlyCtlr, securityAuditLogFull, securityAuditLogWarnThresh, directoryServicesConfigError, kmipServerCertificateNearingExpiration, kmipServerCertificateExpired, kmipServerDnsError, kmipServerCertificateError, kmipServerAuthenticationFailure, kmipServerConnectionFailure, kmipServerError, kmipServerKeyRequirementNotMet, ocspResponderUnreachable, certificateRevoked, __UNDEFINED)

objectRef
optional

The object that has the failure
Example : "string"

string

objectType
optional

The type of object described in objectData
Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

objectData
optional

The data for the object, equivalent to fetching the object via its URL
Example : "Serializable"

Serializable

extraData
optional

Supporting data used to debug the failure. This will vary by failureType
Example : "Serializable"

Serializable

4.232. Serializable

Type : object

4.233. FirmwareCompatibilityResponse

Name Description Schema

checkRunning
required

True if the compatibility check is currently running
Example : true

boolean

cancelled
required

True if the check was cancelled by a user
Example : true

boolean

lastStart
required

The last time that a compatibility check was started, null if it has not been initiated yet
Example : "string"

string (date-time)

inaccessibleStorageDevices
required

The list of devices that could not be contacted
Example : [ "string" ]

< string > array

results
required

The list of results
Example : [ "FirmwareCompatibilitySet" ]

< FirmwareCompatibilitySet > array

requestId
required

The unique identifier for this request
Example : "string"

string (int64)

failedStorageDevices
required

The list of devices that the call failed on
Example : [ "string" ]

< string > array

4.234. FirmwareCompatibilitySet

Name Description Schema

storageDeviceId
required

Example : "string"

string

storageDeviceWwn
required

Example : "string"

string

cfwFiles
required

The list of compatible controller firmware files
Example : [ "CFWPackageMetadata" ]

< CFWPackageMetadata > array

nvsramFiles
required

The list of compatible nvsram files
Example : [ "NvsramPackageMetadata" ]

< NvsramPackageMetadata > array

4.235. NvsramPackageMetadata

Name Description Schema

version
required

Example : "string"

string

filename
required

Example : "string"

string

4.236. FirmwareCompatibilityRequest

Name Description Schema

storageDeviceIds
optional

List of storage devices to find compatible firmware for.
Example : [ "string" ]

< string > array

releasedBuildsOnly
optional

Only consider released firmware builds as valid firmware files
Default : true
Example : true

boolean

4.237. FlashCacheBase

Name Description Schema

label
required

The user-assigned label of the flash cache.
Example : "string"

string

status
required

The status of the flash cache.
Example : "string"

enum (unknown, optimal, degraded, failed, suspended, __UNDEFINED)

configType
required

The flash cache configuration type.
Example : "string"

enum (unknown, filesystem, database, multimedia, __UNDEFINED)

analyticsStatus
required

The flash cache analytics status.
Example : "string"

enum (unknown, stopped, started, __UNDEFINED)

analyticsCause
required

The flash cache analytics status cause.
Example : "string"

enum (none, userStopped, userFcChanges, internalCtlrRebooted, internalCfgChanges, __UNDEFINED)

statusCause
required

The flash cache status cause.
Example : "string"

enum (none, hotspareInuse, drivesInaccessible, cacheSizeMismatch, missingDrives, __UNDEFINED)

4.238. FlashCacheDriveInfo

Name Description Schema

flashCacheType
required

This enumeration identifies the type of flash cache.
Example : "string"

enum (unknown, readOnlyCache, writeCache, virtual, __UNDEFINED)

fcWithDrives
optional

Test results are returned if the flashCacheType does not equal FC_TYPE_VIRTUAL.
Example : "FlashCacheWithDrives"

FlashCacheWithDrives

4.239. FlashCacheEx

Name Description Schema

wwn
required

The WWN of the high level flash cache volume.
Example : "string"

string

flashCacheRef
required

A reference to the high level flash cache volume.
Example : "string"

string

flashCacheBase
required

Contains the base-level Flash Cache attributes pertaining to all types of Flash Caches.
Example : "FlashCacheBase"

FlashCacheBase

fcDriveInfo
required

Drive information for the flash cache.
Example : "FlashCacheDriveInfo"

FlashCacheDriveInfo

cachedVolumes
optional

A list of references of volumes and thin volumes that are associated with this FlashCache
Example : [ "string" ]

< string > array

driveRefs
optional

The list of drives associated with this FlashCache
Example : [ "string" ]

< string > array

name
optional

Example : "string"

string

id
optional

Example : "string"

string

4.240. FlashCacheWithDrives

Name Description Schema

securityType
required

The security type of the drives.
Example : "string"

enum (unknown, none, capable, enabled, __UNDEFINED)

protectionInformationCapabilities
required

The protection information capabilities of the drives.
Example : "ProtectionInformationCapabilities"

ProtectionInformationCapabilities

usedCapacity
required

The used capacity of the drives (in bytes).
Example : "string"

string (int64)

securityLevel
required

Refines the information in the securityType field to describe the set of drives.
Example : "string"

enum (unknown, none, mixed, fde, fips, __UNDEFINED)

4.241. FlashCacheCreateRequest

Name Description Schema

driveRefs
required

A list of one or more drive refs belonging to SSD drives that will be utilized in the FlashCache
Example : [ "string" ]

< string > array

name
optional

The user label for the FlashCache
Default : "flashCache"
Example : "string"

string

enableExistingVolumes
optional

If true, all existing volumes that are mapped will have flash cache enabled
Default : false
Example : true

boolean

4.242. FlashCacheUpdateRequest

Name Description Schema

name
optional

The new name for the FlashCache
Example : "string"

string

configType
optional

The usage configuration for the flashCache
Example : "string"

enum (unknown, filesystem, database, multimedia, __UNDEFINED)

4.243. Folder

Folder used to represent storage system hierarchy.

Name Description Schema

folderId
required

Example : "string"

string

parentFolderId
required

Example : "string"

string

name
required

Example : "string"

string

reserved
required

Example : true

boolean

rules
required

Rules for dynamic folders
Example : [ "Rule" ]

< Rule > array

storageSystemIds
required

List of arrays for non-dynamic folders
Example : [ "string" ]

< string > array

4.244. Rule

Object containing a Key/Value pair along with a Type to be used to store data for a storage system.

Name Description Schema

ruleType
required

Example : "string"

string

key
required

Example : "string"

string

value
required

Example : "string"

string

4.245. FolderCreateRequest

Used to create a folder

Name Description Schema

parentId
optional

Optional Parent folder Id for nested folders.
Example : "string"

string

name
required

Name of the folder
Example : "string"

string

rules
optional

Optional List of rules used to define the folder. These rules are ANDed together Usually either rules OR a list of Ids are supplied.
Example : [ "Rule" ]

< Rule > array

storageSystemIds
optional

Optional list of storage system to include in the folder. Usually either rules OR a list of Ids are supplied.
Example : [ "string" ]

< string > array

4.246. FolderUpdateRequest

Used to update a folder

Name Description Schema

parentId
optional

Optional Parent folder Id for nested folders.
Example : "string"

string

name
optional

Name of the folder
Example : "string"

string

rules
optional

Optional List of rules used to define the folder. These rules are ANDed together Usually either rules OR a list of Ids are supplied. <br>This must be a complete list
Example : [ "Rule" ]

< Rule > array

storageSystemIds
optional

Option list of storage system to include in the folder. Usually either rules OR a list of Ids are supplied. <br>This must be a complete list
Example : [ "string" ]

< string > array

4.247. BatteryEx

Name Description Schema

batteryRef
required

The reference for this battery.
Example : "string"

string

status
required

The operational status of the battery.
Example : "string"

enum (optimal, fullCharging, nearExpiration, failed, removed, unknown, notInConfig, configMismatch, learning, overtemp, expired, maintenanceCharging, replacementRequired, __UNDEFINED)

physicalLocation
required

The physical location of the battery. The parent reference in Location identifies the CRU that physically houses the battery, and the position field is the parent-relative/like-component relative slot number of the battery, starting at one.
Example : "Location"

Location

batteryAge
required

Current battery age, in days.
Example : 0

integer (int32)

batteryLifeRemaining
required

Days of battery life remaining. A value of -1 indicates that the battery life expiration age has been set to 0xFF in NVSRAM, disabling cache battery expiration event notification.
Example : 0

integer (int32)

batteryTypeData
required

Used to determine the scope of the battery.
Example : "BatteryTypeData"

BatteryTypeData

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

manufacturerDate
required

VPD manufacture date.
Example : "string"

string (int64)

vendorName
required

VPD vendor name.
Example : "string"

string

vendorPN
required

VPD part number.
Example : "string"

string

vendorSN
required

VPD serial number.
Example : "string"

string

fruType
required

VPD field replaceable unit type.
Example : "string"

string

rtrAttributes
required

The CRU type of the battery plus its ready-to-remove attributes, which are based on the CRU type.
Example : "RTRAttributes"

RTRAttributes

repairPolicy
required

The repair policy for the battery component.
Example : "RepairPolicy"

RepairPolicy

batteryCanExpire
required

This boolean field is set to true when cache battery expired event notification is enabled.
Example : true

boolean

automaticAgeReset
required

This boolean field is set to true when the batteryCanExpire field in this structure is set to false and when the controller tracks the battery serial number.
Example : true

boolean

learnCycleData
required

Contains details about the learn cycle for this battery
Example : "SmartBatteryData"

SmartBatteryData

smartBatteryData
optional

Example : "SmartBatteryData"

SmartBatteryData

id
optional

Example : "string"

string

4.248. BatteryTypeData

Name Description Schema

batteryType
required

This enumeration object is used to specify the battery configurations present on a controller.
Example : "string"

enum (singleSharedCru, dualIndividualFrus, dualSharedCrus, dualIndividualCrus, __UNDEFINED)

cruParentController
optional

This field is present only if the batteryType value is equal to BATTERY_TYPE_DUAL_INDIVIDUAL_CRUS. It is a reference to the controller that the battery CRU is associated with.
Example : "string"

string

parentController
optional

This field is present only if the batteryType value is equal to BATTERY_TYPE_DUAL_INDIVIDUAL_FRUS. It is a reference to the the controller that the battery FRU is associated with.
Example : "string"

string

4.249. CacheBackupDevice

Name Description Schema

backupDeviceRef
required

The SYMbol reference that identifies the instance of the device
Example : "string"

string

backupDeviceControllerSlot
required

The number of the slot on the controller where the backup device resides. Cache backup device slots are numbered starting at one, independent of other types of slots (e.g., host board slots) on the controller. Note that this field is targeted for deletion in SYMbol rev. 85b.
Example : 0

integer (int32)

parentController
required

A reference to the controller where the backup device resides. Note that this field is targeted for deletion in SYMbol rev. 85b.
Example : "string"

string

backupDeviceType
required

The type of the backup device ( e.g., USB flash drive).
Example : "string"

enum (unknown, usbFlash, sdFlash, sataFlash, __UNDEFINED)

backupDeviceStatus
required

The status of the backup device
Example : "string"

enum (unknown, optimal, failed, removed, writeProtected, incompatible, __UNDEFINED)

backupDeviceVpd
required

Vital product data for the backup device.
Example : "CacheBackupDeviceVpd"

CacheBackupDeviceVpd

backupDeviceCapacity
required

The capacity of backup device, expressed in megabytes.
Example : 0

integer (int32)

repairPolicy
required

The repair policy for the cache backup device component.
Example : "RepairPolicy"

RepairPolicy

physicalLocation
required

The physical location of the cache backup device. The parent field of Location is set to the controller where the device physically resides, and the position field is the parent-relative/like-component-relative slot number of the device, starting at one.
Example : "Location"

Location

id
optional

Example : "string"

string

4.250. CacheBackupDeviceVpd

Name Description Schema

manufacturer
required

The variable-length ASCII text string that identifies the device manufacturer..
Example : "string"

string

manufactureDate
required

The date of manufacture of the device, represented in seconds since midnight GMT on January 1, 1970.
Example : "string"

string (int64)

productId
required

The variable-length ASCII text string that identifies the device by name.
Example : "string"

string

productRevLevel
required

The variable-length ASCII text string that identifies the device revision level.
Example : "string"

string

partNumber
required

The variable-length ASCII text string that identifies the device part number.
Example : "string"

string

serialNumber
required

The variable-length ASCII text string that identifies the device serial number.
Example : "string"

string

4.251. CacheMemoryDimm

Name Description Schema

cacheMemoryDimmRef
required

The SYMbol reference value that uniquely identifies an instance of a cache memory DIMM object.
Example : "string"

string

status
required

The operational status of the DIMM.
Example : "string"

enum (unknown, optimal, empty, failed, __UNDEFINED)

capacityInMegabytes
required

The capacity of the DIMM expressed in megabytes.
Example : 0

integer (int32)

serialNumber
required

The serial number of the DIMM.
Example : "string"

string

partNumber
required

The LSI Logic part number of the DIMM.
Example : "string"

string

oemPartNumber
required

The OEM part number of the DIMM.
Example : "string"

string

manufacturerPartNumber
required

The manufacturer part number of the DIMM.
Example : "string"

string

manufacturer
required

The manufacturer part number of the DIMM.
Example : "string"

string

manufactureDate
required

The manufacture date of the DIMM
Example : "string"

string (int64)

repairPolicy
required

The repair policy for the cache memory DIMM component.
Example : "RepairPolicy"

RepairPolicy

physicalLocation
required

The physical location of the cache memory DIMM. The parent reference in Location identifies the controller where the DIMM physically resides, and the position field is the parent-relative/like-component relative slot number of the DIMM, starting at 1.
Example : "Location"

Location

shared
required

This field is set to true if the DIMM is shared between processor and cache. It is set to false if the DIMM is dedicated to the cache.
Example : true

boolean

revisionCode
required

The module revision code of the DIMM.
Example : "string"

string

4.252. ChannelPort

Name Description Schema

portRef
required

A reference to this channel port.
Example : "string"

string

portParent
required

The parent of the channel port object (minihub, controller, or ESM).
Example : "ChannelPortParent"

ChannelPortParent

portNumber
required

The identifying number assigned to this channel port. The range for port numbers is 1..n. If the port number cannot be determined, this field is set to zero.
Example : 0

integer (int32)

channel
required

The number of the associated channel.
Example : 0

integer (int32)

channelType
required

The type of the associated channel - either host-side or drive-side.
Example : "string"

enum (hostside, driveside, management, __UNDEFINED)

physicalLocation
required

The physical location of the channel port. The parent reference in Location identifies the physical CRU where the port is located, and the position field is the parent-relative/like-port relative number of the port, starting at 1.
Example : "Location"

Location

isTrunkActive
required

This field is true if a trunk connection has been established and is being maintained on this controller or ESM channel port. This field is always false if the channel port is on a controller or ESM that does not have a Fibre Channel I/O interface type, or if the channel port is associated with a host-side channel.
Example : true

boolean

id
optional

Example : "string"

string

4.253. ChannelPortParent

Name Description Schema

type
required

This enumeration object is used to specify the type of channel port parent.
Example : "string"

enum (unknown, esm, minihub, controller, hic, __UNDEFINED)

controllerRef
optional

This field is present only if the type field is equal to CHANNEL_PORT_PARENT_CONTROLLER.
Example : "string"

string

esmRef
optional

This field is present only if the type field is equal to CHANNEL_PORT_PARENT_ESM.
Example : "string"

string

minihubRef
optional

This field is present only if the type field is equal to CHANNEL_PORT_PARENT_MINIHUB.
Example : "string"

string

hicRef
optional

This field is present only if the type field is equal to CHANNEL_PORT_PARENT_HIC.
Example : "string"

string

4.254. CommandProtocolProperties

Name Description Schema

commandProtocol
required

This enumeration describes the command protocol (e.g. SCSI vs. NVMe).
Example : "string"

enum (unknown, scsi, nvme, __UNDEFINED)

nvmeProperties
optional

This field describes the NVMe command protocol properties.
Example : "NVMeCommandProtocolProperties"

NVMeCommandProtocolProperties

4.255. ControllerSFP

Name Description Schema

controllerSFPType
required

The interface (host/drive) to which the SFP belongs.
Example : "string"

enum (hostside, driveside, __UNDEFINED)

parentController
required

The controller to which the SFP belongs.
Example : "string"

string

channel
required

The channel the SFP is associated with.
Example : 0

integer (int32)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

4.256. Drawer

Name Description Schema

drawerRef
required

The component reference associated with the drawer.
Example : "string"

string

isOpen
required

This value is set to true when the drawer is open; otherwise it is set to false.
Example : true

boolean

status
required

This field contains the drawer status.
Example : "string"

enum (unknown, optimal, failed, opened, removed, degraded, invalid, __UNDEFINED)

physicalLocation
required

This field contains the drawer location. This will be a tray reference to the tray containing the drawer.
Example : "Location"

Location

repairPolicy
required

This field contains the repair policy for the drawer component.
Example : "RepairPolicy"

RepairPolicy

softwareVersion
required

This data is a variable length ASCII text string. It contains the firmware version for the DCM (Drawer Control and Monitor) chip on the drawer component.
Example : "string"

string

partNumber
required

This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) chip part number on the drawer component. This part number is from VPD data.
Example : "string"

string

serialNumber
required

This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) chip serial number on the drawer component. This serial number is from VPD data.
Example : "string"

string

vendorName
required

This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) chip manufacturer name, obtained from VPD data.
Example : "string"

string

manufactureDate
required

This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) manufacture date, obtained from VPD data.
Example : "string"

string (int64)

fruType
required

This data is a variable length ASCII text string. It contains the Field Replaceable Unit (FRU) type, obtained from VPD data.
Example : "string"

string

drawerType
required

This data is a variable length ASCII text string describing the type of drawer.
Example : "string"

string

id
optional

Example : "string"

string

4.257. DriveLayout

Name Description Schema

driveOrientation
required

The drive orientation in the drawer or tray.
Example : "string"

enum (none, horizontal, vertical, __UNDEFINED)

numRows
required

The number of rows in the drive layout. If driveOrientation field is set to "None", the value of this field should be zero.
Example : 0

integer (int32)

numColumns
required

The number of columns in the drive layout. If driveOrientation field is set to "None", the value of this field should be zero.
Example : 0

integer (int32)

primaryTraversal
required

The primary traversal method for the drawer or tray. If driveOrientation field is set to "None", the value of this field should be TRAVERSAL_NONE
Example : "string"

enum (none, leftToRight, rightToLeft, topToBottom, frontToBack, __UNDEFINED)

secondaryTraversal
required

The secondary traversal method for the drawer or tray. If driveOrientation field is set to "None", the value of this field should be TRAVERSAL_NONE
Example : "string"

enum (none, leftToRight, rightToLeft, topToBottom, frontToBack, __UNDEFINED)

4.258. ESMInterfaceTypeData

Name Description Schema

ioInterfaceType
required

This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

portList
optional

A list of detailed information for each port.
Example : "PortList"

PortList

4.259. Esm

Name Description Schema

esmRef
required

The reference for this physical ESM.
Example : "string"

string

status
required

The operational status for this ESM.
Example : "string"

enum (optimal, failed, removed, unknown, unsupported, uncertified, __UNDEFINED)

physicalLocation
required

The physical location of the ESM. The parent reference in Location identifies the tray containing the ESM, and the position field is the parent-relative/like-component relative slot number of the ESM, starting at 1.
Example : "Location"

Location

nonRedundantAccess
required

True if the ESM does not have redundant access.
Example : true

boolean

partNumber
required

The part number of the ESM.
Example : "string"

string

serialNumber
required

The serial number of the ESM.
Example : "string"

string

manufacturerDate
required

The date the ESM was manufactured.
Example : "string"

string (int64)

manufacturer
required

The date the ESM was manufactured.
Example : "string"

string

fruType
required

The field replaceable unit type of the ESM.
Example : "string"

string

softwareVersion
required

The firmware version of the ESM.
Example : "string"

string

esmInterfaceData
required

The interface type information for the ESM. This field is now deprecated. The field esmInterfaceAttributes should be used instead.
Example : "ESMInterfaceTypeData"

ESMInterfaceTypeData

productID
required

The product identifier of the ESM.
Example : "string"

string

workingChannel
required

The channel to the tray that is still operational (if nonRedundantAccess is True).
Example : 0

integer (int32)

currentSpeed
required

The current speed of the ESM.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maxSpeed
required

The maximum speed of the ESM.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

fibreEsm
required

The Fibre Channel information for the ESM. This field is deprecated. The field fibreEsmAddress located within esmInterfaceAttributes should be used instead.
Example : "FibreESMAddress"

FibreESMAddress

rtrAttributes
required

The CRU type of the ESM plus its ready-to-remove attributes, which are based on the CRU type.
Example : "RTRAttributes"

RTRAttributes

esmInterfaceAttributes
required

Attributes that are specific to the ESM’s I/O interface type.
Example : "EsmInterfaceAttributes"

EsmInterfaceAttributes

boardId
required

The board ID of the ESM card.
Example : "string"

string

factoryDefaultsData
required

This field contains information about the version of the ESM’s factory default settings.
Example : "EsmFactoryDefaultsVersionData"

EsmFactoryDefaultsVersionData

repairPolicy
required

The repair policy for the ESM component.
Example : "RepairPolicy"

RepairPolicy

isTrunkCapable
required

True when ESM is trunk capable.
Example : true

boolean

trunkMiswire
required

True only when ESM is trunk capable and cabled incorrectly, or not trunk capable but connected in trunk mode.
Example : true

boolean

locateInProgress
required

Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the device.
Example : true

boolean

hasTrayIdentityIndicator
required

The device contains 7-segment indicators used to display the Tray Identity.
Example : true

boolean

esmType
required

Type of ESM or IOM.
Example : "string"

enum (unidentified, badger, devil, cyclone, polecat, otter, __UNDEFINED)

id
optional

Example : "string"

string

4.260. EsmFactoryDefaultsVersionData

Name Description Schema

isSupported
required

This field is set to true if the ESM supports version reporting and downloading of factory default settings, and false otherwise. A setting of false in this field can mean either (1) the ESM is a legacy ESM for which the version-reporting feature is unavailable or (2) the ESM is capable of supporting version-reporting, but is not running the correct firmware version to do so.
Example : true

boolean

factoryDefaultsVersion
required

The factory default version string. The format of the string is:
Example : "string"

string

4.261. EsmInterfaceAttributes

Name Description Schema

ioInterfaceType
required

This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

fibreEsmAttributes
optional

This field is only present if the ioInterfaceType value is IO_IF_FC. It contains attributes that are specific to fibre channel ESMs.
Example : "FibreEsmAttributes"

FibreEsmAttributes

sasEsmAttributes
optional

This field is only present if the ioInterfaceType value is IO_IF_SAS. It contains attributes that are specific serial-attached SCSI ESMs.
Example : "SasEsmAttributes"

SasEsmAttributes

4.262. FactoryDefaultsVersionData

Name Description Schema

factoryDefaultsVersion
required

The factory default version string
Example : "string"

string

isSupported
required

This field is set to true when version reporting is supported and factory default settings may be downloaded; otherwise it is set to false.
Example : true

boolean

4.263. Fan

Name Description Schema

fanRef
required

The reference for this physical fan.
Example : "string"

string

status
required

The operational status of the fan
Example : "string"

enum (optimal, failed, removed, unknown, __UNDEFINED)

physicalLocation
required

The physical location of the fan. The parent reference in Location identifies the CRU that houses the fan, and the position field is a firmware-assigned 1-relative number signifying "1st fan relative to parent CRU," 2nd fan relative to parent CRU." etc.
Example : "Location"

Location

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

rtrAttributes
required

The CRU type of the fan plus its ready-to-remove attributes, which are based on the CRU type.
Example : "RTRAttributes"

RTRAttributes

repairPolicy
required

The repair policy for the fan component.
Example : "RepairPolicy"

RepairPolicy

id
optional

Example : "string"

string

4.264. FibreESMAddress

Name Description Schema

esmPortRef
required

The esmPortRef identifies the drive port.
Example : "string"

string

loopID
required

The loop ID of the ESM.
Example : 0

integer (int32)

portRef
required

A reference to the controller drive side channel port associated with this ESM.
Example : "string"

string

4.265. FibreEsmAttributes

Name Description Schema

isSwitched
required

True if the fibre channel components use switched technology.
Example : true

boolean

fibreEsmAddress
required

Addressing information for the fibre channel ESM.
Example : "FibreESMAddress"

FibreESMAddress

4.266. FibreInterfacePort

Name Description Schema

channel
required

The channel number of this interface.
Example : 0

integer (int32)

loopID
required

The FC loop ID value used by the controller on this channel.
Example : 0

integer (int32)

speed
required

The speed of the interface in MB/sec. This field is deprecated. The field currentInterfaceSpeed should be used instead.
Example : 0

integer (int32)

hardAddress
required

The hard (preferred) address of the interface, in loop ID format.
Example : 0

integer (int32)

nodeName
required

The unique identifier of the storage array node associated with this interface.
Example : "string"

string

portName
required

The unique identifier of the Fibre Channel port associated with this interface.
Example : "string"

string

portId
required

The NL_Port identifier assigned to this interface.
Example : "string"

string

topology
required

The Fibre Channel topology type being used.
Example : "string"

enum (unknown, ptp, fabric, arbLoop, fabLoop, __UNDEFINED)

part
required

An ASCII text string that describes the Fibre Channel controller chip type.
Example : "string"

string

revision
required

The revision level of the Fibre Channel controller chip.
Example : 0

integer (int32)

chanMiswire
required

True, if this channel is joined with another one.
Example : true

boolean

esmMiswire
required

True, if an ESM miswire condition exists somewhere on this channel.
Example : true

boolean

linkStatus
required

The status of the fibre channel link for this interface.
Example : "string"

enum (none, up, down, failed, __UNDEFINED)

isDegraded
required

True if the channel associated with this interface is degraded.
Example : true

boolean

speedControl
required

The speed of the interface in MB per sec. This field is deprecated. The fieldcurrentInterfaceSpeed should be used instead.
Example : "string"

enum (unknown, fixed, switched, auto, __UNDEFINED)

maxSpeed
required

The maximum speed in MB/s the interface can run. This field is deprecated. The field maximumInterfaceSpeed should be used instead.
Example : 0

integer (int32)

speedNegError
required

True if speed negotiation could not complete.
Example : true

boolean

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

ddsChannelState
required

The DDS state of this drive side channel: optimal, degraded, or failed.
Example : 0

integer (int32)

ddsStateReason
required

DDS state reason.
Example : 0

integer (int32)

ddsStateWho
required

Which controller placed the drive side channel in this DDS state.
Example : 0

integer (int32)

isLocal
required

Set to True if there are channel ports physically attached to this controller.
Example : true

boolean

channelPorts
required

Channel port speed information. This field is deprecated. The same information is available in the LinkSpeedDetectionError structure.
Example : [ "ChannelPorts" ]

< ChannelPorts > array

currentInterfaceSpeed
required

The current interface speed of the Fibre Channel interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maximumInterfaceSpeed
required

The maximum interface speed of the Fibre Channel interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

interfaceRef
required

The unique identifier for a given instance of this structure.
Example : "string"

string

physicalLocation
required

The physical location of the Fibre Channel interface. The parent reference in location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Fibre Channel interface relative to the parent," "2nd Fibre Channel interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

isTrunkCapable
required

This field is true if the Fibre interface on the controller board is trunk capable. This field is always false for host-side interfaces.
Example : true

boolean

trunkMiswire
required

True only when ESM is trunk capable and cabled incorrectly, or not trunk capable but connected in trunk mode.
Example : true

boolean

protectionInformationCapable
required

Example : true

boolean

oneWayMaxRate
required

Maximum one way data rate in B/s
Example : "string"

string (int64)

bidirectionalMaxRate
required

Maximum bi-directional data rate in B/s
Example : "string"

string (int64)

controllerId
optional

Example : "string"

string

interfaceId
optional

Example : "string"

string

addressId
optional

Example : "string"

string

niceAddressId
optional

Example : "string"

string

id
optional

Example : "string"

string

4.267. HardwareInventoryResponse

Provides summary information for the physical components of the storage system.

Name Description Schema

drives
required

A list of the disk drives in the storage system.
Example : [ "DriveEx" ]

< DriveEx > array

ibPorts
required

IB Ports
Example : [ "IBInterfacePort" ]

< IBInterfacePort > array

iscsiPorts
required

ISCSI Port
Example : [ "IScsiInterfacePort" ]

< IScsiInterfacePort > array

fibrePorts
required

Fibre Ports
Example : [ "FibreInterfacePort" ]

< FibreInterfacePort > array

sasPorts
required

SAS Ports
Example : [ "SasInterfacePort" ]

< SasInterfacePort > array

sasExpanders
required

SAS Expanders
Example : [ "SasExpander" ]

< SasExpander > array

channelPorts
required

Channel Ports
Example : [ "ChannelPort" ]

< ChannelPort > array

trays
required

A list of the disk trays in the storage system.
Example : [ "TrayEx" ]

< TrayEx > array

drawers
required

A list of the disk drawers
Example : [ "Drawer" ]

< Drawer > array

controllers
required

A list of the controllers in the storage system.
Example : [ "Controller" ]

< Controller > array

batteries
required

A list of the batteries in the storage system.
Example : [ "BatteryEx" ]

< BatteryEx > array

fans
required

A list of the fans in the storage system.
Example : [ "Fan" ]

< Fan > array

hostBoards
required

A list of the host interface cards in the storage system.
Example : [ "HostBoard" ]

< HostBoard > array

powerSupplies
required

A list of the power supplies in the storage system.
Example : [ "PowerSupply" ]

< PowerSupply > array

nvsramVersion
required

The version of NVSRAM settings installed on the storage system.
Example : "string"

string

cacheMemoryDimms
required

The list of processor memory DIMMs installed on the storage system.
Example : [ "CacheMemoryDimm" ]

< CacheMemoryDimm > array

cacheBackupDevices
required

The list of cache backup modules installed on the storage system.
Example : [ "CacheBackupDevice" ]

< CacheBackupDevice > array

supportCRUs
required

A list of the support CRUs in the storage system.
Example : [ "SupportCRU" ]

< SupportCRU > array

esms
required

A list of the ESMs in the storage system.
Example : [ "Esm" ]

< Esm > array

sfps
required

A list of the SFPs in the storage system.
Example : [ "Sfp" ]

< Sfp > array

thermalSensors
required

A list of the thermal sensors in the storage system.
Example : [ "ThermalSensor" ]

< ThermalSensor > array

4.268. HostBoard

Name Description Schema

parentController
required

The controller associated with the host board.
Example : "string"

string

partNumber
required

The host board’s part number, from VPD.
Example : "string"

string

serialNumber
required

The host board’s serial number, from VPD.
Example : "string"

string

vendorName
required

The host board’s vendor name, from VPD.
Example : "string"

string

manufacturerDate
required

The host board’s date of manufacture, from VPD.
Example : "string"

string (int64)

fruType
required

The field replaceable unit type string, from VPD.
Example : "string"

string

hostBoardId
required

The board ID of the controller’s host card.
Example : "string"

string

status
required

The host board’s status.
Example : "string"

enum (unknown, optimal, needsAttention, notPresent, degraded, failed, diagInProgress, __UNDEFINED)

type
required

The host board’s type.
Example : "string"

enum (typeUnknown, type4portFc, type20portSwitchedFc, type1portSas, type2portFc, type2portIscsi, type2portSas, type2portIb, type8portFc, type4portIscsi, type4portSas, type4portSasGlacier, type2portFcIscsiSamoa, type4portFcIscsiSamoa, type2portIscsiZion, type2portSasAcadia, type4portSasAcadia, type2portIbDenali, type2portFcSamoa, type4portFcSamoa, type2portIscsiSamoa, type4portIscsiSamoa, type4portSas3, type2portIb100gb, type4portEthernet25gb, type4portFc32gb, __UNDEFINED)

hostBoardRef
required

The reference for this physical host board.
Example : "string"

string

numberOfPorts
required

The number of ports provided by the host board.
Example : 0

integer (int32)

hbTypeData
required

Data that is specific to the type of host board.
Example : "HostBoardTypeData"

HostBoardTypeData

oemPartNumber
required

The OEM part number of the host board.
Example : "string"

string

hostBoardControllerSlot
required

The number of the slot on the controller where the host board resides. Host board slots are numbered starting at one, independent of other types of slots (e.g., cache backup device slots) on the controller.
Example : 0

integer (int32)

repairPolicy
required

The repair policy for the host board component.
Example : "RepairPolicy"

RepairPolicy

physicalLocation
required

The physical location of the host board. The parent reference in Location identifies the controller where the host board is physically located, and the position field is the parent-relative/like-component relative slot number of the host card, starting at 1.
Example : "Location"

Location

id
optional

Example : "string"

string

4.269. HostBoard2PortIbTypeData

Name Description Schema

tcaGuid
required

The globally unique identifier (GUID) assigned to the host board.
Example : "string"

string

queuePairsSupported
required

The number of queue pairs supported by the host board.
Example : 0

integer (int32)

completionQueuesSupported
required

The number of completion queues supported by the host board.
Example : 0

integer (int32)

sharedReceiveQueuesSupported
required

The number of shared receive queues supported by the host board.
Example : 0

integer (int32)

4.270. HostBoardTypeData

Name Description Schema

type
required

This enumeration object is used to indicate the type of a controller’s host board.
Example : "string"

enum (typeUnknown, type4portFc, type20portSwitchedFc, type1portSas, type2portFc, type2portIscsi, type2portSas, type2portIb, type8portFc, type4portIscsi, type4portSas, type4portSasGlacier, type2portFcIscsiSamoa, type4portFcIscsiSamoa, type2portIscsiZion, type2portSasAcadia, type4portSasAcadia, type2portIbDenali, type2portFcSamoa, type4portFcSamoa, type2portIscsiSamoa, type4portIscsiSamoa, type4portSas3, type2portIb100gb, type4portEthernet25gb, type4portFc32gb, __UNDEFINED)

dualPortIbTypeData
optional

Host board data for two-port InfiniBand host board. This field is only present if type is equal to HB_TYPE_2PORT_IB.
Example : "HostBoard2PortIbTypeData"

HostBoard2PortIbTypeData

dualPortDenaliIbTypeData
optional

If the host board type is denali with two port infiniband, return the two port ib type data struct.
Example : "HostBoard2PortIbTypeData"

HostBoard2PortIbTypeData

4.271. IBInterfacePort

Name Description Schema

interfaceRef
required

The opaque data by which an instance of IbInterface is uniquely identified.
Example : "string"

string

channel
required

The number of the host channel associated with this interface.
Example : 0

integer (int32)

channelPortRef
required

A reference to the channel port for the channel associated with this interface.
Example : "string"

string

localIdentifier
required

The InfiniBand local identifier associated with this interface.
Example : 0

integer (int32)

globalIdentifier
required

The InfiniBand global identifier associated with this interface.
Example : "string"

string

linkState
required

The state of the InfiniBand link.
Example : "string"

enum (initialize, linkArm, active, defer, down, __UNDEFINED)

portState
required

The state of the InfiniBand port.
Example : "string"

enum (unknown, initialize, arm, active, defer, down, __UNDEFINED)

maximumTransmissionUnit
required

The size in bytes of the largest packet that the interface can transmit.
Example : 0

integer (int32)

currentSpeed
required

The speed at which the interface is currently operating.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

supportedSpeed
required

An array containing the different speeds at which the interface is capable of operating.
Example : [ "string" ]

< enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED) > array

currentLinkWidth
required

The width at which the link is currently operating, e.g., 1 means "1X," 4 means "4X,".etc.
Example : "string"

enum (width1x, width4x, width8x, width12x, __UNDEFINED)

supportedLinkWidth
required

An array containing the different link widths at which the link is capable of operating.
Example : [ "string" ]

< enum (width1x, width4x, width8x, width12x, __UNDEFINED) > array

currentDataVirtualLanes
required

The number of data virtual lanes that are currently active for this interface.
Example : 0

integer (int32)

maximumDataVirtualLanes
required

The maximum number of data virtual lanes supported by the interface.
Example : 0

integer (int32)

physicalLocation
required

The physical location of the Infiniband interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Infiniband interface relative to the parent," "2nd Infiniband interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

protectionInformationCapable
required

This field indicates whether or not the I/O interface is PI capable.
Example : true

boolean

isSRPSupported
required

This flag is true if SRP (SCSI RDMA Protocol) is currently supported.
Example : true

boolean

isISERSupported
required

This flag is true if iSER (iSCSI Extensions for RDMA) is currently supported.
Example : true

boolean

physPortState
required

This element contains the current state of the physical Infiniband port.
Example : "string"

enum (unknown, sleep, polling, disabled, cfgTrain, linkUp, linkErrRec, phyTest, __UNDEFINED)

oneWayMaxRate
required

Maximum one way data rate in B/s
Example : "string"

string (int64)

bidirectionalMaxRate
required

Maximum bi-directional data rate in B/s
Example : "string"

string (int64)

isNVMeSupported
required

Indicates if the interface is configured to support NVMe over Fabrics protocol
Example : true

boolean

controllerId
optional

Example : "string"

string

commandProtocolProperties
optional

List of properties that describe the command protocol.
Example : [ "CommandProtocolProperties" ]

< CommandProtocolProperties > array

interfaceId
optional

Example : "string"

string

addressId
optional

Example : "string"

string

niceAddressId
optional

Example : "string"

string

id
optional

Example : "string"

string

4.272. IScsiInterfacePort

Name Description Schema

channel
required

The number of the channel controlled by this interface.
Example : 0

integer (int32)

channelPortRef
required

A reference to the channel port object associated with the channel controlled by this interface.
Example : "string"

string

tcpListenPort
required

The number of the TCP port on which the target listens for incoming connections.
Example : 0

integer (int32)

ipv4Enabled
required

True if IPV4 is enabled for this interface; always true for iSER interface.
Example : true

boolean

ipv4Data
required

IPV4-related information for the interface.
Example : "InternetProtocolV4Data"

InternetProtocolV4Data

interfaceData
required

Information about the physical interface (e.g., Ethernet).
Example : "PhysicalInterfaceTypeData"

PhysicalInterfaceTypeData

interfaceRef
required

The unique identifier for a given instance of this structure.
Example : "string"

string

ipv6Enabled
required

True if IPV6 is enabled for this interface; otherwise false.
Example : true

boolean

ipv6Data
required

IPV6-related information for the interface.
Example : "InternetProtocolV6Data"

InternetProtocolV6Data

physicalLocation
required

The physical location of the iSCSI interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st iSCSI interface relative to the parent," "2nd iSCSI interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

protectionInformationCapable
required

This field indicates whether or not the I/O interface is PI capable.
Example : true

boolean

isIPv6Capable
required

This flag is true if the interface is capable of IPv6 functionality.
Example : true

boolean

oneWayMaxRate
required

Maximum one way data rate in B/s
Example : "string"

string (int64)

bidirectionalMaxRate
required

Maximum bi-directional data rate in B/s
Example : "string"

string (int64)

iqn
optional

Example : "string"

string

controllerId
optional

Example : "string"

string

interfaceId
optional

Example : "string"

string

addressId
optional

Example : "string"

string

niceAddressId
optional

Example : "string"

string

id
optional

Example : "string"

string

4.273. IpVxAddressData

Name Description Schema

addressType
required

This enumeration defines the different types of IP addresses, corresponding to different versions of the Internet protocol.
Example : "string"

enum (ipv4, ipv6, __UNDEFINED)

ipv4Data
optional

Contains the various IPV4 address elements.
Example : "IpV4AddressData"

IpV4AddressData

ipv6Data
optional

contains the various IPV6 address elements.
Example : "IpV6AddressData"

IpV6AddressData

4.274. NVMeCommandProtocolProperties

Name Description Schema

commandSet
required

This enumeration describes the command set type (e.g. to descriminate between the NVMe and NVMe over Fabrics command sets).
Example : "string"

enum (unknown, nvme, nvmeof, __UNDEFINED)

nvmeofProperties
optional

This describes the NVMe over Fabrics protocol properties.
Example : "NVMeoFProtocolProperties"

NVMeoFProtocolProperties

4.275. NVMeoFInfinibandProperties

Name Description Schema

ipAddressData
required

The IP address data associated with the NVMe over Fabrics over Infiniband transport.
Example : "IpVxAddressData"

IpVxAddressData

listeningPort
required

The listening port associated with the NVMe over Fabrics over Infiniband transport.
Example : 0

integer (int32)

4.276. NVMeoFProtocolProperties

Name Description Schema

provider
required

This enumeration is used to identify the provider (i.e. intermediate transport protocol) of the RDMA transport.
Example : "string"

enum (providerUnknown, providerUnspecified, providerInfiniband, providerRoce, providerRocev2, providerIwarp, noneFc, __UNDEFINED)

ibProperties
optional

This defines the Infiniband properties for NVMe over IB.
Example : "NVMeoFInfinibandProperties"

NVMeoFInfinibandProperties

4.277. Port

Name Description Schema

portStatus
required

An indication of the status of the fibre channel port.
Example : "string"

enum (bypassed, notBypassed, __UNDEFINED)

portType
required

An indication of the type of fibre channel port.
Example : "string"

enum (gbic, db9, sfp, __UNDEFINED)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

4.278. PortList

Name Description Schema

ports
required

A variable-length array of Port objects.
Example : [ "Port" ]

< Port > array

4.279. PowerSupply

Name Description Schema

powerSupplyRef
required

The physical location of the power supply. The parent reference in Location identifies the tray or CRU that physically houses the power supply, and the position field is the parent-relative/like-component relative number of the power supply, starting at one.
Example : "string"

string

status
required

The operation status of the power supply.
Example : "string"

enum (optimal, failed, removed, unknown, noinput, __UNDEFINED)

physicalLocation
required

The physical location of the power supply. Note that the tray reference identifies the enclosure containing the power supply. For non-XBB controller enclosures, the slot information does not apply. For XBB controller enclosures, the slot information is an ordinal identifier (a value of 1 means the first (left) power supply and a value of 2 means the second (right) power supply).
Example : "Location"

Location

partNumber
required

The part number of the power supply from VPD data.
Example : "string"

string

serialNumber
required

The serial number of the power supply.
Example : "string"

string

vendorName
required

The name of the manufacturer of the power supply.
Example : "string"

string

manufacturerDate
required

The date the power supply was manufactured.
Example : "string"

string (int64)

fruType
required

The field replaceable unit type of the power supply.
Example : "string"

string

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

rtrAttributes
required

The CRU type of the power supply plus its ready-to-remove attributes, which are based on the CRU type
Example : "RTRAttributes"

RTRAttributes

repairPolicy
required

The repair policy for the power supply component.
Example : "RepairPolicy"

RepairPolicy

firmwareRevision
required

An ASCII character string that identifies the version of the firmware.
Example : "string"

string

manufacturingDeviceCode
required

An integer value that specifies the Manufacturing Device Code.
Example : 0

integer (int32)

id
optional

Example : "string"

string

4.280. SFPParentTypeData

Name Description Schema

sfpParentType
required

This enumeration object is used to describe the parent type of a SFP.
Example : "string"

enum (unknown, esm, minihub, controller, __UNDEFINED)

controllerSFP
optional

This field is present only if the sfpParentType is equal to SFP_PARENT_TYPE_CONTROLLER. It contains the parent type of a SFP.
Example : "ControllerSFP"

ControllerSFP

parentEsm
optional

No information is returned
Example : "string"

string

parentMinihub
optional

This field is present only if the sfpParentType is equal to SFP_PARENT_TYPE_MINIHUB. It contains the parent type of a SFP.
Example : "string"

string

4.281. SFPType

Name Description Schema

sfpIdentType
required

Information about the SFP type.
Example : "string"

enum (unknown, gbic, soldered, sfp, __UNDEFINED)

sfpConnectType
required

Information about the SFP connector type.
Example : "string"

enum (unknown, sc, fcs1cc, fcs2cc, bncortnc, fcCoax, fJack, lc, mtRj, mu, sg, optPigtail, hssdcii, copPigtail, rj45, noSeparableConnector, __UNDEFINED)

sfpLinkLType
required

Information about the SFP link length.
Example : "string"

enum (typeUnknown, typeVlong, typeShort, typeIntermediate, typeLong, typeMedium, typeNa, __UNDEFINED)

sfpTransmitterType
required

Information about the SFP transmitter type.
Example : "string"

enum (unknown, lwlLc, eiee, eiae, swlwoofc, swlwofc, lwlLl, na, __UNDEFINED)

sfpSpeed
required

Information about the SFP speed.
Example : [ "string" ]

< enum (typeUnknown, type1gig, type2gig, type4gig, type8gig, type16gig, type10gig, type40gig, type56gig, type20gig, type25gig, type32gig, type100gig, __UNDEFINED) > array

sfpTransmissionMedia
required

Information about the SFP transmission media.
Example : [ "string" ]

< enum (unknown, twinAxialPair, tmShieldedTwistedPair, tmMiniatureCoax, tmVideoCoax, tmMultiModeM6, tmMultiModeM5, tmSingleMode, na, __UNDEFINED) > array

manufacturerDate
required

The date when the SFP was manufactured.
Example : "string"

string (int64)

vendorName
required

The vendor name of the SFP.
Example : "string"

string

vendorPN
required

The vendor part name of the SFP.
Example : "string"

string

vendorRev
required

The vendor revision of the SFP
Example : "string"

string

vendorSN
required

The vendor serial number of the SFP.
Example : "string"

string

vendorOUI
required

The vendor unique OUI field of the SFP.
Example : "string"

string

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

4.282. SasEsmAttributes

Name Description Schema

sasExpander
required

This field is a collection of references to objects representing the SAS expanders that physically reside on the ESM.
Example : [ "string" ]

< string > array

4.283. SasExpander

Name Description Schema

expanderRef
required

The reference value that uniquely identifies the SAS expander.
Example : "string"

string

parent
required

The reference value that uniquely identifies the parent (controller or ESM) of the SAS expander.
Example : "SasExpanderParent"

SasExpanderParent

channel
required

The drive channel location of the expander
Example : 0

integer (int32)

deviceName
required

The SAS address that is the expander device name
Example : "string"

string

vendorId
required

The Inquiry vendor identification string for the SAS expander.
Example : "string"

string

productId
required

The Inquiry product identification string for the SAS expander.
Example : "string"

string

fwVersion
required

The version of the firmware on the SAS expander.
Example : "string"

string

expanderPorts
required

List of ports that are part of this expander.
Example : [ "SasPort" ]

< SasPort > array

domainNumber
required

The domain number identifies which SAS domain this element is a part of. Domain numbers are arbitrarily assigned by the firmware and are consistent on a per controller basis – but not across controllers. So, the contents of domains will be consistent across controllers but the number identifying a particular domain may not be.
Example : 0

integer (int32)

id
optional

Example : "string"

string

4.284. SasExpanderParent

Name Description Schema

expanderParentType
required

This enumeration specifies the different types of parent elements a SAS expander may have.
Example : "string"

enum (unknown, controller, esm, drawer, __UNDEFINED)

parentController
optional

A reference to the parent controller of the SAS expander. This field is present only if the expanderParentType value is SAS_EXPANDER_PARENT_CONTROLLER.
Example : "string"

string

parentEsm
optional

A reference to the parent ESM of the SAS expander. This field is present only if the expanderParentType value is SAS_EXPANDER_PARENT_ESM.
Example : "string"

string

parentDrawer
optional

A reference to the parent drawer of the SAS expander. This field is present only if the expanderParentType value is SAS_EXPANDER_PARENT_DRAWER.
Example : "string"

string

4.285. SasInterfacePort

Name Description Schema

channel
required

The number of the channel corresponding to this interface.
Example : 0

integer (int32)

currentInterfaceSpeed
required

The current interface speed of the SAS interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maximumInterfaceSpeed
required

The maximum interface speed of the SAS interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

part
required

A string indicating the chip type.
Example : "string"

string

revision
required

The revision level of the firmware on the SAS I/O controller.
Example : 0

integer (int32)

isDegraded
required

True if the channel corresponding to this interface is degraded.
Example : true

boolean

iocPort
required

Information about the SAS I/O controller port corresponding to this interface.
Example : "SasPort"

SasPort

interfaceRef
required

The unique identifier for a given instance of this structure.
Example : "string"

string

physicalLocation
required

The physical location of the SAS interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st SAS interface relative to the parent," "2nd SAS interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

protectionInformationCapable
required

This field indicates whether or not the I/O interface is PI capable.
Example : true

boolean

oneWayMaxRate
required

Maximum one way data rate in B/s
Example : "string"

string (int64)

bidirectionalMaxRate
required

Maximum bi-directional data rate in B/s
Example : "string"

string (int64)

controllerId
optional

Example : "string"

string

interfaceId
optional

Example : "string"

string

addressId
optional

Example : "string"

string

niceAddressId
optional

Example : "string"

string

basePortAddress
optional

Example : "string"

string

id
optional

Example : "string"

string

4.286. Sfp

Name Description Schema

sfpRef
required

The reference for this physical SFP.
Example : "string"

string

status
required

The operational status of the SFP.
Example : "string"

enum (optimal, failed, removed, unknown, __UNDEFINED)

physicalLocation
required

The physical location of the SFP.
Example : "Location"

Location

sfpType
required

The type of the SFP.
Example : "SFPType"

SFPType

sfpPort
required

The port that the SFP is associated with.
Example : "string"

enum (portUnknown, port1, port2, port3, port4, __UNDEFINED)

parentData
required

Data specific to SFP parent type.
Example : "SFPParentTypeData"

SFPParentTypeData

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

sfpPortRef
required

A reference identifying the channel port that the SFP is plugged into.
Example : "string"

string

repairPolicy
required

The repair policy for the SFP component.
Example : "RepairPolicy"

RepairPolicy

id
optional

Example : "string"

string

4.287. SmartBatteryData

Name Description Schema

lastBatteryLearnCycle
required

The time of the last completed learn cycle, expressed in seconds since midnight GMT, January 1, 1970.
Example : "string"

string (int64)

nextBatteryLearnCycle
required

The time of the next scheduled learn cycle, expressed in seconds since midnight GMT, January 1, 1970.
Example : "string"

string (int64)

batteryLearnCycleInterval
required

The time between automatic learn cycles, expressed in weeks.
Example : 0

integer (int32)

4.288. SupportCRU

Name Description Schema

supportCRURef
required

The reference for this physical support CRU.
Example : "string"

string

status
required

The operational status of the support CRU.
Example : "string"

enum (unknown, optimal, failed, removed, noinput, incorrectConfig, __UNDEFINED)

physicalLocation
required

The physical location of the support CRU. The parent reference in Location identifies the tray containing the CRU, and the position field is the parent-relative/like-component relative slot number of the CRU, starting at one.
Example : "Location"

Location

manufacturerDate
required

VPD manufacture date.
Example : "string"

string (int64)

vendorName
required

VPD vendor name.
Example : "string"

string

vendorPN
required

VPD part number.
Example : "string"

string

vendorSN
required

VPD serial number.
Example : "string"

string

fruType
required

VPD field replaceable unit type.
Example : "string"

string

readyToRemove
required

When set to True, the component is ready to remove (and the Ready to Remove indicator light is turned on). This field is deprecated. The rtrAttributes field should be used instead.
Example : true

boolean

rtrAttributes
required

The CRU type of the support CRU plus its ready-to-remove attributes, which are based on the CRU type.
Example : "RTRAttributes"

RTRAttributes

configuredComponents
required

A variable-length list of the types of components that occupy the support CRU.
Example : [ "string" ]

< enum (unknown, fan, battery, powerSupply, thermalSensor, esm, ups, minihub, gbic, sfp, interconnectCru, supportCru, alarm, hostboard, icSasExpander, hostIoCard, cacheBackupDevice, cacheMemDimm, procMemDimm, channelPort, drive, controller, ethernetInterface, fibreInterface, ibInterface, iscsiInterface, sasInterface, tray, storageArray, drawer, __UNDEFINED) > array

type
required

The type of this support CRU (e.g., "power-fan" or "battery")
Example : "string"

enum (unknown, powerFan, battery, fan, powerSupply, __UNDEFINED)

repairPolicy
required

The repair policy for the support CRU component.
Example : "RepairPolicy"

RepairPolicy

id
optional

Example : "string"

string

4.289. ThermalSensor

Name Description Schema

thermalSensorRef
required

The reference for this physical thermal sensor.
Example : "string"

string

status
required

The operational status of the thermal sensor.
Example : "string"

enum (optimal, nominalTempExceed, maxTempExceed, removed, unknown, __UNDEFINED)

physicalLocation
required

The physical location of the thermal sensor. The parent reference in Location identifies the CRU that physically houses the thermal sensor, and the position field is the parent-relative/like-component relative number of the thermal sensor, starting at one.
Example : "Location"

Location

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

rtrAttributes
required

The CRU type of the thermal sensor plus its ready-to-remove attributes, which are based on the CRU type
Example : "RTRAttributes"

RTRAttributes

repairPolicy
required

The repair policy for the thermal sensor component.
Example : "RepairPolicy"

RepairPolicy

id
optional

Example : "string"

string

4.290. TrayAttribute

Name Description Schema

attributeId
required

An indication of which attribute this is.
Example : "string"

enum (assetTag, chassisName, serviceTag, spinUpDelay, spinUpCount, __UNDEFINED)

attributeValue
required

The value of the tray attribute.
Example : "string"

string

4.291. TrayEx

Name Description Schema

type
required

An indication of the type of the tray.
Example : "string"

enum (sym1000, sym2000, sym2772, pciraid, generic, sym2200, sym1200, sym2882, sym1500, fc4600, ss3600, md1000, md3000, xbb2, fc6900, md1200, md1220, de1600, de5600, de6600, de7600, de6650, sc12, sc24, de212c, de224c, de460c, __UNDEFINED)

orientation
required

An indication of the physical orientation (horizontal or vertical) of the tray.
Example : "string"

enum (horizontal, vertical, __UNDEFINED)

numControllerSlots
required

The number of slots available for holding RAID controller boards (i.e., set to zero for a drive-only tray).
Example : 0

integer (int32)

numDriveSlots
required

The total number of slots available for holding disk drives.
Example : 0

integer (int32)

trayId
required

The tray identifier value, which is typically set using physical switches on the tray itself.
Example : 0

integer (int32)

trayRef
required

The identifier value for this tray. Other objects may use this reference value to refer to the tray.
Example : "string"

string

nonRedundantAccess
required

True, if the tray does not have redundant access.
Example : true

boolean

partNumber
required

The part number of the tray from VPD data.
Example : "string"

string

serialNumber
required

The serial number of the tray.
Example : "string"

string

vendorName
required

The name of the manufacturer of the tray.
Example : "string"

string

manufacturerDate
required

The date the tray was manufactured.
Example : "string"

string (int64)

fruType
required

The field replaceable unit type of the tray.
Example : "string"

string

trayIDMismatch
required

True if the IDs on the ESMs do not match.
Example : true

boolean

trayIDConflict
required

True if this tray ID conflicts with that of another tray.
Example : true

boolean

esmVersionMismatch
required

True if the ESM firmware versions do not match.
Example : true

boolean

esmMiswire
required

True if this tray has an ESM join miswire.
Example : true

boolean

drvMHSpeedMismatch
required

True if this tray has a drive-side minihub speed mismatch.
Example : true

boolean

unsupportedTray
required

True if this tray is an unrecognized/unsupported hardware type.
Example : true

boolean

workingChannel
required

The channel to the tray that is still operational (if nonRedundantAccess is True).
Example : 0

integer (int32)

maxSpeed
required

The maximum speed of the drive channels,
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

trayTechnologyType
required

The interface technology. This field is deprecated. Equivalent information is available in the driveTechnologies and frontEndInterfaceTechnology fields.
Example : "string"

enum (unknown, scsiScsi, fibreFibre, fibreSata, fibrePata, __UNDEFINED)

esmGroupError
required

True if SBOD ESM trays are not properly clustered.
Example : true

boolean

uncertifiedTray
required

True if this tray is an uncertified hardware type.
Example : true

boolean

locateTray
required

True if this tray supports a locate operation.
Example : true

boolean

esmHardwareMismatch
required

True if the ESM hardware components in the tray are mismatched.
Example : true

boolean

hasConfigurableTrayId
required

True if the tray ID can be set using the updateTray procedure.
Example : true

boolean

frontEndInterfaceTechnology
required

The front-end I/O interface technology of the tray.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

driveTechnologies
required

A list of drive technologies that are present in the tray.
Example : [ "string" ]

< enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) > array

numDriveCompartments
required

The number of drive compartments in the tray. Some drive trays are subdivided into "compartments," each having the same number of drive slots. Looking at the front of such an enclosure, multiple compartments are arranged side by side along one dimension, while drives within a compartment are arranged side by side along the other dimension, allowing for greater overall drive density within the constraints of a given enclosure form factor. (Even when arranged as a series of compartments, drive slot numbering is still relative to the entire tray.)
Example : 0

integer (int32)

numDriveSlotsPerCompartment
required

The number of drive slots within an individual drive compartment.
Example : 0

integer (int32)

trayAttributes
required

The tray attribute data (see setTrayAttributes procedure).
Example : [ "TrayAttribute" ]

< TrayAttribute > array

isMisconfigured
required

True, if the tray has invalid configuration settings.
Example : true

boolean

esmFactoryDefaultsMismatch
required

True, if the two ESMs in the tray are reporting different version information for their factory default settings.
Example : true

boolean

physicalLocation
required

The physical location of the tray. The parent reference in Location identifies the storage array itself, and the position field is the tray position number as identified in setSATrayPositions procedure call, or the constant TRAY_POSITION_UNKNOWN.
Example : "Location"

Location

numDrawers
required

The total number of drawers available in the tray.
Example : 0

integer (int32)

driveLayout
required

If the tray contains drawers, this field specifies the layout within the drawer. Otherwise, this field specifies the layout for the tray.
Example : "DriveLayout"

DriveLayout

factoryDefaultsData
required

This field contains information about the version of the tray’s factory default settings.
Example : "FactoryDefaultsVersionData"

FactoryDefaultsVersionData

locateInProgress
required

Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the tray.
Example : true

boolean

hasTrayIdentityIndicator
required

The device contains 7-segment indicators used to display the Tray Identity.
Example : true

boolean

trayPositionIndex
optional

Example : 0

integer (int32)

id
optional

Example : "string"

string

4.292. EsmFibrePortConnection

Represents a Fibre connection between a Tray/Esm and another storageDevice component

Name Description Schema

tray
optional

The tray that the connection originates from
Example : "Tray"

Tray

esm
optional

The esm that the connection originates from
Example : "Esm"

Esm

channelPort
optional

The port that the Esm is connected to.
Example : "ChannelPort"

ChannelPort

attachedController
optional

The controller (if applicable) that the Esm is connected to
Example : "Controller"

Controller

type
optional

Example : "string"

enum (sas, fibre)

4.293. EsmPortConnectionResponse

Provides information on the connections between ESMs/Trays and other components

Name Description Schema

sasConnections
optional

Example : [ "EsmSasPortConnection" ]

< EsmSasPortConnection > array

fibreConnections
optional

Example : [ "EsmFibrePortConnection" ]

< EsmFibrePortConnection > array

4.294. EsmSasPortConnection

Represents a SAS connection between a Tray/Esm and another storageDevice component

Name Description Schema

tray
optional

The tray that the connection originates from
Example : "Tray"

Tray

esm
optional

The esm that the connection originates from
Example : "Esm"

Esm

sasExpander
optional

The SAS Expander on the Esm
Example : "SasExpander"

SasExpander

sasPort
optional

The SAS Port associated with the sasExpander on the ESM
Example : "SasPort"

SasPort

channelPort
optional

The Channel Port associated with the SAS Port and Expander on the ESM
Example : "ChannelPort"

ChannelPort

attachedSasExpander
optional

The SAS Expander that that SAS Connection on the ESM connects to
Example : "SasExpander"

SasExpander

attachedChannelPort
optional

The ChannelPort that that SAS Connection on the ESM connects to
Example : "ChannelPort"

ChannelPort

attachedController
optional

The Controller (if applicable) that that SAS Connection on the ESM connects to
Example : "Controller"

Controller

type
optional

Example : "string"

enum (sas, fibre)

4.295. Tray

Name Description Schema

type
required

An indication of the type of the tray.
Example : "string"

enum (sym1000, sym2000, sym2772, pciraid, generic, sym2200, sym1200, sym2882, sym1500, fc4600, ss3600, md1000, md3000, xbb2, fc6900, md1200, md1220, de1600, de5600, de6600, de7600, de6650, sc12, sc24, de212c, de224c, de460c, __UNDEFINED)

orientation
required

An indication of the physical orientation (horizontal or vertical) of the tray.
Example : "string"

enum (horizontal, vertical, __UNDEFINED)

numControllerSlots
required

The number of slots available for holding RAID controller boards (i.e., set to zero for a drive-only tray).
Example : 0

integer (int32)

numDriveSlots
required

The total number of slots available for holding disk drives.
Example : 0

integer (int32)

trayId
required

The tray identifier value, which is typically set using physical switches on the tray itself.
Example : 0

integer (int32)

trayRef
required

The identifier value for this tray. Other objects may use this reference value to refer to the tray.
Example : "string"

string

nonRedundantAccess
required

True, if the tray does not have redundant access.
Example : true

boolean

partNumber
required

The part number of the tray from VPD data.
Example : "string"

string

serialNumber
required

The serial number of the tray.
Example : "string"

string

vendorName
required

The name of the manufacturer of the tray.
Example : "string"

string

manufacturerDate
required

The date the tray was manufactured.
Example : "string"

string (int64)

fruType
required

The field replaceable unit type of the tray.
Example : "string"

string

trayIDMismatch
required

True if the IDs on the ESMs do not match.
Example : true

boolean

trayIDConflict
required

True if this tray ID conflicts with that of another tray.
Example : true

boolean

esmVersionMismatch
required

True if the ESM firmware versions do not match.
Example : true

boolean

esmMiswire
required

True if this tray has an ESM join miswire.
Example : true

boolean

drvMHSpeedMismatch
required

True if this tray has a drive-side minihub speed mismatch.
Example : true

boolean

unsupportedTray
required

True if this tray is an unrecognized/unsupported hardware type.
Example : true

boolean

workingChannel
required

The channel to the tray that is still operational (if nonRedundantAccess is True).
Example : 0

integer (int32)

maxSpeed
required

The maximum speed of the drive channels,
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

trayTechnologyType
required

The interface technology. This field is deprecated. Equivalent information is available in the driveTechnologies and frontEndInterfaceTechnology fields.
Example : "string"

enum (unknown, scsiScsi, fibreFibre, fibreSata, fibrePata, __UNDEFINED)

esmGroupError
required

True if SBOD ESM trays are not properly clustered.
Example : true

boolean

uncertifiedTray
required

True if this tray is an uncertified hardware type.
Example : true

boolean

locateTray
required

True if this tray supports a locate operation.
Example : true

boolean

esmHardwareMismatch
required

True if the ESM hardware components in the tray are mismatched.
Example : true

boolean

hasConfigurableTrayId
required

True if the tray ID can be set using the updateTray procedure.
Example : true

boolean

frontEndInterfaceTechnology
required

The front-end I/O interface technology of the tray.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

driveTechnologies
required

A list of drive technologies that are present in the tray.
Example : [ "string" ]

< enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) > array

numDriveCompartments
required

The number of drive compartments in the tray. Some drive trays are subdivided into "compartments," each having the same number of drive slots. Looking at the front of such an enclosure, multiple compartments are arranged side by side along one dimension, while drives within a compartment are arranged side by side along the other dimension, allowing for greater overall drive density within the constraints of a given enclosure form factor. (Even when arranged as a series of compartments, drive slot numbering is still relative to the entire tray.)
Example : 0

integer (int32)

numDriveSlotsPerCompartment
required

The number of drive slots within an individual drive compartment.
Example : 0

integer (int32)

trayAttributes
required

The tray attribute data (see setTrayAttributes procedure).
Example : [ "TrayAttribute" ]

< TrayAttribute > array

isMisconfigured
required

True, if the tray has invalid configuration settings.
Example : true

boolean

esmFactoryDefaultsMismatch
required

True, if the two ESMs in the tray are reporting different version information for their factory default settings.
Example : true

boolean

physicalLocation
required

The physical location of the tray. The parent reference in Location identifies the storage array itself, and the position field is the tray position number as identified in setSATrayPositions procedure call, or the constant TRAY_POSITION_UNKNOWN.
Example : "Location"

Location

numDrawers
required

The total number of drawers available in the tray.
Example : 0

integer (int32)

driveLayout
required

If the tray contains drawers, this field specifies the layout within the drawer. Otherwise, this field specifies the layout for the tray.
Example : "DriveLayout"

DriveLayout

factoryDefaultsData
required

This field contains information about the version of the tray’s factory default settings.
Example : "FactoryDefaultsVersionData"

FactoryDefaultsVersionData

locateInProgress
required

Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the tray.
Example : true

boolean

hasTrayIdentityIndicator
required

The device contains 7-segment indicators used to display the Tray Identity.
Example : true

boolean

id
optional

Example : "string"

string

4.296. HealthCheckResponse

A list of requested health check results

Name Description Schema

requestId
required

The unique request id
Example : "string"

string (int64)

healthCheckRunning
required

Indicates if a health check is currently running
Example : true

boolean

cancelled
required

The operation was cancelled while performing the pre-flight checks.
Example : true

boolean

remaining
required

Approximate number of devices that are still processing the health checks.
Example : 0

integer (int32)

results
required

Example : [ "FirmwareUpgradeHealthCheckResult" ]

< FirmwareUpgradeHealthCheckResult > array

start
required

The time that this operation was started.
Example : "string"

string (date-time)

4.297. HealthCheckRequest

Name Description Schema

onlineOnly
optional

Only run health checks on online storage-systems
Default : true
Example : true

boolean

storageDeviceIds
optional

An optional list of device ids (if not provided, all available devices will be used)
Example : [ "string" ]

< string > array

4.298. HostGroup

Name Description Schema

clusterRef
required

The unique identification value for this object. Other objects may use this reference value to refer to the cluster.
Example : "string"

string

label
required

The user-assigned, descriptive label string for the cluster.
Example : "string"

string

isSAControlled
required

If true, indicates that I/O accesses from this cluster are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the cluster are subject to cluster-specific LUN-to-volume mappings.
Example : true

boolean

confirmLUNMappingCreation
required

If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other clusters, in addition to this one.
Example : true

boolean

protectionInformationCapableAccessMethod
required

This field is true if the host has a PI capable access method.
Example : true

boolean

isLun0Restricted
required

Provides an indication as to whether LUN 0 is restricted (i.e., disallowed) for the associated cluster.
Example : true

boolean

id
optional

Example : "string"

string

name
optional

Example : "string"

string

4.299. HostGroupCreateRequest

Creates a Host Group in the Storage System

Name Description Schema

name
required

The user-label to assign to the new host group.
Example : "string"

string

hosts
optional

List of hostRefs to assign to the HostGroup
Example : [ "string" ]

< string > array

4.300. HostGroupUpdateRequest

Creates a Host Group in the Storage System

Name Description Schema

name
optional

The user-label to assign to the new host group.
Example : "string"

string

hosts
optional

List of hostRefs to add to the HostGroup
Example : [ "string" ]

< string > array

4.301. AuthMethodTypeData

Name Description Schema

authMethod
required

This enumeration type identifies the available iSCSIauthentication methods. The supportedAuthMethods array in the FeatureParams structure will contain values from this enumeration identifying which iSCSI authentication methods are supported on the storage array.
Example : "string"

enum (none, chap, __UNDEFINED)

chapSecret
optional

This field is present only if the authentication method is AUTH_METHOD_CHAP. If the field length indicator is zero, there is no associated secret; otherwise there is a secret and it may or may not be specified, depending on the usage context for this data type. If the client is using this structure to set a secret, the length indicator should be one and the secret should be filled in; if the client is using this structure to set an authentication method with no secret, the length indicator should be zero. If the array is reporting this data, it sets the length indicator according to whether or not there is a secret. (The actual secret is never reported by the array; instead it uses the ENCRYPT_UNSPECIFIED case of EncryptedPassword.) Finally, because CHAP secrets are, by definition, limited to the ASCII character set, the clear text submitted for encryption must be ASCII, not Unicode.
Example : [ "EncryptedPassword" ]

< EncryptedPassword > array

4.302. AuthenticationBundle

Name Description Schema

authMethodData
required

A variable-length array containing authentication methods and any associated data.
Example : [ "AuthMethodTypeData" ]

< AuthMethodTypeData > array

4.303. EncryptedPassword

Name Description Schema

type
required

This enumeration object is used to identify the type of encryption used for a particular operation or object.
Example : "string"

enum (pkcs5Sha1Des, unspecified, pkcs5Sha2Aes, __UNDEFINED)

pkcs5Data
optional

The PKCS #5 data associated with the encrypted password. This field is valid only if the encryption type is ENCRYPT_PKCS5_SHA1_DES.
Example : "PKCS5EncryptionData"

PKCS5EncryptionData

pkcs5AesData
optional

The PKCS#5 data associated with an AES encrypted password. This field is valid only if the encryption type is ENCRYPT_PKCS5_SHA2_AES.
Example : "PKCS5EncryptionData"

PKCS5EncryptionData

4.304. HostEx

Name Description Schema

hostRef
required

The unique identification value for this object. Other objects may use this reference value to refer to the host.
Example : "string"

string

clusterRef
required

The cluster reference value of the cluster in which this host resides. A NULL reference value indicates that the host has not been assigned to a cluster.
Example : "string"

string

label
required

The user-assigned, descriptive label string for the host.
Example : "string"

string

isSAControlled
required

If true, indicates that I/O accesses from this host are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the host are subject to host-specific or cluster-specific LUN-to-volume mappings.
Example : true

boolean

confirmLUNMappingCreation
required

If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other hosts, in addition to this one.
Example : true

boolean

hostTypeIndex
required

An integer index indicating the type of host.
Example : 0

integer (int32)

protectionInformationCapableAccessMethod
required

This field is true if the host has a PI capable access method.
Example : true

boolean

isLargeBlockFormatHost
required

If true, the host is capable of supporting large block formats.
Example : true

boolean

isLun0Restricted
required

Provides an indication as to whether LUN 0 is restricted (i.e., disallowed) for the associated host.
Example : true

boolean

ports
optional

Example : [ "HostPort" ]

< HostPort > array

initiators
optional

Example : [ "Initiator" ]

< Initiator > array

hostSidePorts
optional

Example : [ "HostSidePort" ]

< HostSidePort > array

id
optional

Example : "string"

string

name
optional

Example : "string"

string

4.305. HostPort

Name Description Schema

hostPortRef
required

The unique identification value for this object. Other objects may use this reference value to refer to the host port.
Example : "string"

string

hostPortName
required

The unique, externally-defined identifier for this object. For example, for a Fibre Channel host port, this field contains the value of the Fibre Channel world-wide name for the port.
Example : "string"

string

label
required

The user-assigned, descriptive label string for the host port.
Example : "string"

string

hostRef
required

The host reference value of the host in which this port resides.
Example : "string"

string

hostPortTypeIndex
required

An index value that indicates the type of host port. This value is used to reference the appropriate entry in the hostPortType field of the associated StorageArray object.
Example : 0

integer (int32)

isSAControlled
required

If true, indicates that I/O accesses from this host port are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the host port are subject to host-specific or cluster-specific LUN-to-volume mappings.
Example : true

boolean

confirmLUNMappingCreation
required

If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other host ports, in addition to this one.
Example : true

boolean

portId
required

The I/O-protocol-based unique port identifier. This field replaces the deprecated hostPortName field.
Example : "SCSIInitiatorPortId"

SCSIInitiatorPortId

portInactive
required

The host port has been marked inactive
Example : true

boolean

id
optional

Example : "string"

string

4.306. HostPortLocation

Name Description Schema

ioInterfaceType
required

This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

fcPortName
optional

This field is present only if the type value is equal to IO_IF_FC.
Example : "string"

string

ibPortName
optional

This field is present only if the type value is equal to IO_IF_IB.
Example : "string"

string

sasPortName
optional

This field is present only if the type value is equal to IO_IF_SAS.
Example : "string"

string

4.307. HostSidePort

Name Description Schema

type
optional

Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

address
optional

Example : "string"

string

label
optional

Example : "string"

string

4.308. Initiator

Name Description Schema

initiatorRef
required

The reference that uniquely identifies an instance of this object.
Example : "string"

string

nodeName
required

The unique node name associated with the initiator.
Example : "ScsiNodeName"

ScsiNodeName

alias
required

An additional name that can be assigned to an initiator, which is usually "friendlier" than the node name.
Example : "ScsiAlias"

ScsiAlias

label
required

An additional "friendly" name that can be assigned to an initiator through the Storage Manager application.
Example : "string"

string

configuredAuthMethods
required

The authentication methods that have been configured for the initiator. Associated secrets are not exposed. instead the type field of the EncryptedPassword is set to ENCRYPT_UNSPECIFIED.
Example : "AuthenticationBundle"

AuthenticationBundle

hostRef
required

A reference to the Host object to which the initiator belongs.
Example : "string"

string

initiatorInactive
required

The initiator is marked inactive.
Example : true

boolean

id
optional

Example : "string"

string

4.309. IscsiInitiatorPortId

Name Description Schema

initiatorNodeName
required

The iSCSI node name of the initiator.
Example : "string"

string

initiatorSessionId
required

The initiator session ID associated with the initiator port.
Example : "string"

string

4.310. NVMeInitiatorPortId

Name Description Schema

name
required

NVMe Qualified Name (NQN) of the host
Example : "string"

string

hostIdentifier
required

128-bit Host Identifier value
Example : "string"

string

portIdentifier
required

The unique identifier for the host port.
Example : "HostPortLocation"

HostPortLocation

4.311. PKCS5EncryptionData

Name Description Schema

iterations
required

The number of message digest iterations to be performed when generating the encryption key and initialization vector from the passphrase and salt values.
Example : 0

integer (int32)

salt
required

A byte array containing the salt, or random data, selected by the encryption code for this particular encryption operation.
Example : "string"

string

cipherText
required

A variable-length array containing the encrypted data, or cipher text. The length of this array must be a multiple of 8 in order to conform to the PKCS #5 standard. The standard specifies the appropriate technique for adding pad bytes to ensure that this constraint is met.
Example : "string"

string

4.312. SCSIInitiatorPortId

Name Description Schema

ioInterfaceType
required

This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

portName
optional

This field is present only if the type value is equal to IO_IF_FC.
Example : "string"

string

ibPortName
optional

This field is present only if the type value is equal to IO_IF_IB.
Example : "string"

string

iscsiPortName
optional

This field is present only if the type value is equal to IO_IF_ISCSI.
Example : "IscsiInitiatorPortId"

IscsiInitiatorPortId

sasPortName
optional

This field is present only if the type value is equal to IO_IF_SAS.
Example : "string"

string

nvmeInitiatorPortId
optional

Initiator Port ID for an NVMe over Fabrics host
Example : "NVMeInitiatorPortId"

NVMeInitiatorPortId

4.313. ScsiAlias

Name Description Schema

ioInterfaceType
required

This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

iscsiAlias
optional

The SCSI alias name as defined under iSCSI. This field is only valid if the I/O interface type is equal to IO_IF_ISCSI.
Example : "string"

string

4.314. HostMoveRequest

Name Description Schema

groupId
optional

The identifier of the host group to move the host under. If null, move the host to the default group..
Example : "string"

string

4.315. Host

Name Description Schema

hostRef
required

The unique identification value for this object. Other objects may use this reference value to refer to the host.
Example : "string"

string

clusterRef
required

The cluster reference value of the cluster in which this host resides. A NULL reference value indicates that the host has not been assigned to a cluster.
Example : "string"

string

label
required

The user-assigned, descriptive label string for the host.
Example : "string"

string

isSAControlled
required

If true, indicates that I/O accesses from this host are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the host are subject to host-specific or cluster-specific LUN-to-volume mappings.
Example : true

boolean

confirmLUNMappingCreation
required

If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other hosts, in addition to this one.
Example : true

boolean

hostTypeIndex
required

An integer index indicating the type of host.
Example : 0

integer (int32)

protectionInformationCapableAccessMethod
required

This field is true if the host has a PI capable access method.
Example : true

boolean

isLargeBlockFormatHost
required

If true, the host is capable of supporting large block formats.
Example : true

boolean

isLun0Restricted
required

Provides an indication as to whether LUN 0 is restricted (i.e., disallowed) for the associated host.
Example : true

boolean

name
optional

Example : "string"

string

id
optional

Example : "string"

string

4.316. HostCreateRequest

Creates a Host in the Storage System

Name Description Schema

name
required

The user-label to assign to the new host.
Example : "string"

string

hostType
optional

The host type string as returned from /host-types.
Example : "HostType"

HostType

groupId
optional

The host group identifier (optional).
Example : "string"

string

ports
optional

A list of host ports (optional).
Example : [ "HostPortCreateRequest" ]

< HostPortCreateRequest > array

4.317. HostPortCreateRequest

Creates a Host Port in the Storage System

Name Description Schema

type
required

The type of host port to create.
Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

port
required

The host port identifier such as the iSCSI IQN or fibre channel WWN
Example : "string"

string

label
required

The user-label for the host port
Example : "string"

string

iscsiChapSecret
optional

Required password if host-side CHAP is enabled
Example : "string"

string

4.318. HostType

A Host Type is a definition of the operating system of the Host computer that accesses the storage system, for example VmWare, Windows, Solaris, Linux, etc. The Host Type is used by the storage system to customize the I/O protocol based on the implementation of the host I/O drivers.

Name Description Schema

name
optional

Example : "string"

string

index
required

Example : 0

integer (int32)

code
optional

Example : "string"

string

used
optional

Example : true

boolean

default
optional

Example : true

boolean

4.319. HostPortUpdateRequest

Update a HostPort

Name Description Schema

portRef
required

The ref/id of the HostPort or Initiator
Example : "string"

string

hostRef
optional

The new owning host.
Example : "string"

string

port
optional

The host port identifier such as the iSCSI IQN or fibre channel WWN
Example : "string"

string

label
optional

The user-label for the host port
Example : "string"

string

iscsiChapSecret
optional

Required password if host-side CHAP is enabled
Example : "string"

string

4.320. HostUpdateRequest

Updates the Host data.

Name Description Schema

name
optional

The user-label to assign to the host (optional).
Example : "string"

string

groupId
optional

The host group identifier.
Example : "string"

string

ports
optional

A list of host ports to create.
Example : [ "HostPortCreateRequest" ]

< HostPortCreateRequest > array

portsToUpdate
optional

A list of host ports to update.
Example : [ "HostPortUpdateRequest" ]

< HostPortUpdateRequest > array

portsToRemove
optional

A list of HostPorts to delete.
Example : [ "string" ]

< string > array

hostType
optional

The host type string as returned from /host-types.
Example : "HostType"

HostType

4.321. SingleNumberValue

Object to represent a single number (int).

Name Description Schema

value
required

A numeric value
Example : 0

integer (int32)

4.322. HostTypeValues

Name Description Schema

waitForDownload
required

The download microcode status control.
Example : true

boolean

notReadySenseForQuiescenceInProgress
required

This value determines the response of the controller to commands received during the 'controller quiesced' state.
Example : true

boolean

notReadySenseForQuiescenceInProgress2
required

This value determines the response of the controller to commands received during the 'controller quiesced' state.
Example : true

boolean

checkConditionForVendorUniqueUAConditions
required

This value determines if the controller will report a vendor unique Unit Attention condition as a Check Condition status.
Example : true

boolean

reportDeferredErrors
required

This value is used to determine how deferred errors are reported to the host.
Example : true

boolean

ignoreForceUnitAccess
required

This value determines controller treatment of the Force Unit Access Option in the SCSI Read(10) and Write(10) commands.
Example : true

boolean

ignoreWriteCacheDisable
required

This value determines if the controller will allow the resetting of the WCE bit in the Mode Select Caching Page to disable write caching.
Example : true

boolean

allowReservationOnUnownedLUNs
required

This value determines the controller response to Reservation/Release commands that are received for LUNs that are not owned by the controller.
Example : true

boolean

worldWideNameInStandardInquiry
required

Set to true if the WWN is in the standard inquiry data.
Example : true

boolean

propagateHostBusResets
required

This value determines whether the controller will propagate a Host Bus Reset/Target Reset/Logical Unit Reset to the other controller in a dual controller subsystem to support Microsoft Clustering Services.
Example : true

boolean

reportSCCDeviceEnable
required

Report SCC Device Enable.
Example : true

boolean

conditionalFCLogout
required

Conditional Fibre Channel Logout.
Example : true

boolean

forceSCSI2
required

Report SCSI-2 Through Fibre Channel Host Interface.
Example : true

boolean

reportUnconfiguredLUNs
required

This value determines the LUN data returned by the Report LUNs command.
Example : true

boolean

ignoreSyncCache
required

Ignore Cache Sync Command.
Example : true

boolean

ignoreUTMLunOwnership
required

Ignore UTM LUN Ownership.
Example : true

boolean

reportLUNPreferredPathInStandardInquiry
required

Report LUN Preferred Path in Standard Inquiry Data.
Example : true

boolean

autoLUNTransfer
required

Auto Volume Transfer.
Example : true

boolean

inquiryUnconfiguredDeviceType
required

The value returned in the Inquiry Device Type Field when an unconfigured LUN is accessed.
Example : "string"

string

inquiryUnownedDeviceType
required

This value is used to define the device type the controller should return in the first byte of the Inquiry data, if the addressed logical unit is not owned by the addressed controller.
Example : "string"

string

unownedBlock0Read
required

This value is used to define how the controller handles a read request to Block 0 of an unowned volume. When this is enabled, the non-owning controller sends a request for the block 0 data to the owning controller and the owning controller sends the requested block 0 data back to the non-owning controller. If disabled, the controller will do a volume transfer (if AVT is enabled) and then a read of the now owned volume.
Example : "string"

string

retainLogins
required

This field is deprecated.
Example : true

boolean

hostPortType
required

The host type.
Example : "string"

string

maxRestrictedLUNs
required

Maximum number of LUNs allowed for host type.
Example : 0

integer (int32)

reserved1
optional

Example : "string"

string

avtExclusionExtentsEnabled
required

Enable the AVT exclusion extents for this heterogeneous host region.
Example : true

boolean

suppressVolOffPreferredPathAlert
required

If true, then volume-off-preferred events are not considered critical.
Example : true

boolean

hostType
required

The host type string. A zero-length string is allowed and indicates that the associated host-specific NVSRAM region has been cleared. This field should be used in place of the deprecated hostPortType field.
Example : "string"

string

tpgsSupported
required

This field is set to true if Target Port Group Support is provided; otherwise it is false.
Example : true

boolean

volumeFormatOptions
required

If true, a format unit request will interrupt any in-progress IAF and start a write-zeros initialization. If false, the format unit will be returned with no action.
Example : true

boolean

restrictedLun0
required

If true, LUN 0 is restricted and volume mapping to LUN 0 will not be allowed or be reported in the REPORT LUNS data. If false, a volume-to-LUN mapping can be created to LUN 0 and will be reported in a REPORT LUNS response.
Example : true

boolean

usePage2CQuiescenceTimeout
required

The quiescence timeout is the amount of time the controller should wait to achieve a "no I/Os active" state before invoking a forced transfer of LUN ownership. When this field is set to true, the timeout parameter provided by the host initiator in a mode select Page 2C will be used. When this field is set to false, the timeout value applied will be calculated by the controller.
Example : true

boolean

asymmetricLUAccess
required

If true, Asymmetric Logical Unit Access is enabled.
Example : true

boolean

ignoreISCSISessionIDInITN
required

If true, the array iSCSI target driver will not use the session identifier as part of its internal I_T Nexus identifiers. This reduces churn in I_T Nexus identifiers if the initiator does not re-use iSCSI session identifiers when re-opening a session.
Example : true

boolean

enableLUCheckConditionParallelResponses
required

If true, array may return multiple CHECK CONDITION responses simultaneously on a given logical unit.
Example : true

boolean

disableExplicitTPGS
required

If true, the standard INQUIRY data reporting TPGS support to the initiator will only indicate support for implicit mode (providing TPGS support is enabled, see tpgsSupported field).
Example : true

boolean

unownedCheckConditionDuringFWActivation
required

If true, controller will return a LUN NOT OWNED (05h/94h/01h) CHECK CONDITION when unable to handle I/O during firmware activation.
Example : true

boolean

allowPreferredOwnerReportingSuppression
required

If true, the controller will suppress reporting the preferred owner in REPORT TARGET PORT GROUPS or INQUIRY VPD data in conditions when the preferred controller cannot process I/O.
Example : true

boolean

enableTargetFailback
required

If true, controller initiates fail-back of volumes to the preferred owner .
Example : true

boolean

enableAutoLoadBalance
required

If true, the controller may issue volume ownership changes to balance IO load between controllers.
Example : true

boolean

quiescenceInProgressSenseKey
required

Sense Key returned to host for Quiescence In Progress Check Conditions.
Example : 0

integer (int32)

quiescenceInProgressASC
required

Additional Sense Code returned to host for Quiescence In Progress Check Conditions.
Example : 0

integer (int32)

quiescenceInProgressASCQ
required

Additional Sense Code Qualifier returned to host for Quiscence In Progress Check Conditions.
Example : 0

integer (int32)

persistentID
required

Unique identifier for this specific host type. This value is stored in the controller configuration database when persisting Host objects in order to uniquely identify this specific host type across all NVSRAM builds.
Example : 0

integer (int32)

nvmeVUFailoverSupported
required

If true, a vendor unique (VU) NVMe failover solution is supported on the host.
Example : true

boolean

nvmeStandardFailoverSupported
required

If true, the NVMe Asymmetric Namespace Access (ANA) failover solution is supported on the host.
Example : true

boolean

index
optional

Example : 0

integer (int32)

default
optional

Example : true

boolean

4.323. AnalysedStorageSystemStatistics

Statistics for storage system.

Name Description Schema

observedTime
required

A timestamp representing when the data was collected
Example : "string"

string (date-time)

observedTimeInMS
required

The time in which this data was polled and generated in milliseconds
Example : "string"

string (int64)

readIOps
required

Read operations per second.
Example : 0.0

number (double)

writeIOps
required

Write operations per second.
Example : 0.0

number (double)

otherIOps
required

SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready.
Example : 0.0

number (double)

combinedIOps
required

All operations per second.
Example : 0.0

number (double)

readThroughput
required

Read throughput in MB/s.
Example : 0.0

number (double)

writeThroughput
required

Write throughput in MB/s.
Example : 0.0

number (double)

combinedThroughput
required

Combined read/write throughput in MB/s.
Example : 0.0

number (double)

readResponseTime
required

Read response time average in milliseconds.
Example : 0.0

number (double)

readResponseTimeStdDev
required

The standard deviation of read response times.
Example : 0.0

number (double)

writeResponseTime
required

Write response time average in milliseconds.
Example : 0.0

number (double)

writeResponseTimeStdDev
required

The standard deviation of write response times.
Example : 0.0

number (double)

combinedResponseTime
required

Combined average response time in milliseconds.
Example : 0.0

number (double)

combinedResponseTimeStdDev
required

The standard deviation of combined response times.
Example : 0.0

number (double)

averageReadOpSize
required

Average read operation size in bytes.
Example : 0.0

number (double)

averageWriteOpSize
required

Average write operation size in bytes.
Example : 0.0

number (double)

readOps
required

The amount of read operations in this analysed interval.
Example : 0.0

number (double)

writeOps
required

The amount of write operations in this analysed interval.
Example : 0.0

number (double)

readPhysicalIOps
required

Physical read operations per second.
Example : 0.0

number (double)

writePhysicalIOps
required

Physical write operations per second.
Example : 0.0

number (double)

storageSystemId
required

Example : "string"

string

storageSystemWWN
required

Example : "string"

string

storageSystemName
required

Example : "string"

string

4.324. AnalyzedApplicationStatistics

Aggregation of volume statistics for application.

Name Description Schema

observedTime
required

A timestamp representing when the data was collected
Example : "string"

string (date-time)

observedTimeInMS
required

The time in which this data was polled and generated in milliseconds
Example : "string"

string (int64)

readIOps
required

Read operations per second.
Example : 0.0

number (double)

writeIOps
required

Write operations per second.
Example : 0.0

number (double)

otherIOps
required

SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready.
Example : 0.0

number (double)

combinedIOps
required

All operations per second.
Example : 0.0

number (double)

readThroughput
required

Read throughput in MB/s.
Example : 0.0

number (double)

writeThroughput
required

Write throughput in MB/s.
Example : 0.0

number (double)

combinedThroughput
required

Combined read/write throughput in MB/s.
Example : 0.0

number (double)

readResponseTime
required

Read response time average in milliseconds.
Example : 0.0

number (double)

readResponseTimeStdDev
required

The standard deviation of read response times.
Example : 0.0

number (double)

writeResponseTime
required

Write response time average in milliseconds.
Example : 0.0

number (double)

writeResponseTimeStdDev
required

The standard deviation of write response times.
Example : 0.0

number (double)

combinedResponseTime
required

Combined average response time in milliseconds.
Example : 0.0

number (double)

combinedResponseTimeStdDev
required

The standard deviation of combined response times.
Example : 0.0

number (double)

averageReadOpSize
required

Average read operation size in bytes.
Example : 0.0

number (double)

averageWriteOpSize
required

Average write operation size in bytes.
Example : 0.0

number (double)

readOps
required

The amount of read operations in this analysed interval.
Example : 0.0

number (double)

writeOps
required

The amount of write operations in this analysed interval.
Example : 0.0

number (double)

readPhysicalIOps
required

Physical read operations per second.
Example : 0.0

number (double)

writePhysicalIOps
required

Physical write operations per second.
Example : 0.0

number (double)

applicationId
required

The application id of the collection
Example : "string"

string

4.325. AnalyzedPoolStatistics

Volume statistics for storage pools.

Name Description Schema

observedTime
required

A timestamp representing when the data was collected
Example : "string"

string (date-time)

observedTimeInMS
required

The time in which this data was polled and generated in milliseconds
Example : "string"

string (int64)

readIOps
required

Read operations per second.
Example : 0.0

number (double)

writeIOps
required

Write operations per second.
Example : 0.0

number (double)

otherIOps
required

SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready.
Example : 0.0

number (double)

combinedIOps
required

All operations per second.
Example : 0.0

number (double)

readThroughput
required

Read throughput in MB/s.
Example : 0.0

number (double)

writeThroughput
required

Write throughput in MB/s.
Example : 0.0

number (double)

combinedThroughput
required

Combined read/write throughput in MB/s.
Example : 0.0

number (double)

readResponseTime
required

Read response time average in milliseconds.
Example : 0.0

number (double)

readResponseTimeStdDev
required

The standard deviation of read response times.
Example : 0.0

number (double)

writeResponseTime
required

Write response time average in milliseconds.
Example : 0.0

number (double)

writeResponseTimeStdDev
required

The standard deviation of write response times.
Example : 0.0

number (double)

combinedResponseTime
required

Combined average response time in milliseconds.
Example : 0.0

number (double)

combinedResponseTimeStdDev
required

The standard deviation of combined response times.
Example : 0.0

number (double)

averageReadOpSize
required

Average read operation size in bytes.
Example : 0.0

number (double)

averageWriteOpSize
required

Average write operation size in bytes.
Example : 0.0

number (double)

readOps
required

The amount of read operations in this analysed interval.
Example : 0.0

number (double)

writeOps
required

The amount of write operations in this analysed interval.
Example : 0.0

number (double)

readPhysicalIOps
required

Physical read operations per second.
Example : 0.0

number (double)

writePhysicalIOps
required

Physical write operations per second.
Example : 0.0

number (double)

poolId
required

The storage pool or volume group the volume is a member of
Example : "string"

string

4.326. AnalyzedWorkloadStatistics

Aggregation of volume statistics for a workload.

Name Description Schema

observedTime
required

A timestamp representing when the data was collected
Example : "string"

string (date-time)

observedTimeInMS
required

The time in which this data was polled and generated in milliseconds
Example : "string"

string (int64)

readIOps
required

Read operations per second.
Example : 0.0

number (double)

writeIOps
required

Write operations per second.
Example : 0.0

number (double)

otherIOps
required

SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready.
Example : 0.0

number (double)

combinedIOps
required

All operations per second.
Example : 0.0

number (double)

readThroughput
required

Read throughput in MB/s.
Example : 0.0

number (double)

writeThroughput
required

Write throughput in MB/s.
Example : 0.0

number (double)

combinedThroughput
required

Combined read/write throughput in MB/s.
Example : 0.0

number (double)

readResponseTime
required

Read response time average in milliseconds.
Example : 0.0

number (double)

readResponseTimeStdDev
required

The standard deviation of read response times.
Example : 0.0

number (double)

writeResponseTime
required

Write response time average in milliseconds.
Example : 0.0

number (double)

writeResponseTimeStdDev
required

The standard deviation of write response times.
Example : 0.0

number (double)

combinedResponseTime
required

Combined average response time in milliseconds.
Example : 0.0

number (double)

combinedResponseTimeStdDev
required

The standard deviation of combined response times.
Example : 0.0

number (double)

averageReadOpSize
required

Average read operation size in bytes.
Example : 0.0

number (double)

averageWriteOpSize
required

Average write operation size in bytes.
Example : 0.0

number (double)

readOps
required

The amount of read operations in this analysed interval.
Example : 0.0

number (double)

writeOps
required

The amount of write operations in this analysed interval.
Example : 0.0

number (double)

readPhysicalIOps
required

Physical read operations per second.
Example : 0.0

number (double)

writePhysicalIOps
required

Physical write operations per second.
Example : 0.0

number (double)

workloadId
required

The workload id of the collection
Example : "string"

string

4.327. HistoricalStatsResponse

The collection of stats that are returned from a call to get historical statistics Each list is sorted by capture timetsamp (earlier to later).

Name Description Schema

volumeStats
required

Example : [ "AnalysedVolumeStatistics" ]

< AnalysedVolumeStatistics > array

controllerStats
required

Example : [ "AnalysedControllerStatistics" ]

< AnalysedControllerStatistics > array

systemStats
required

Example : [ "AnalysedStorageSystemStatistics" ]

< AnalysedStorageSystemStatistics > array

interfaceStats
required

Example : [ "AnalyzedInterfaceStatistics" ]

< AnalyzedInterfaceStatistics > array

diskStats
required

Example : [ "AnalysedDiskStatistics" ]

< AnalysedDiskStatistics > array

poolStats
required

Example : [ "AnalyzedPoolStatistics" ]

< AnalyzedPoolStatistics > array

workloadStats
required

Example : [ "AnalyzedWorkloadStatistics" ]

< AnalyzedWorkloadStatistics > array

applicationStats
required

Example : [ "AnalyzedApplicationStatistics" ]

< AnalyzedApplicationStatistics > array

volumes
optional

Example : [ "AnalysedVolumeStatistics" ]

< AnalysedVolumeStatistics > array

4.328. ApplicationStatistics

Aggregation of volume statistics for application.

Name Description Schema

observedTime
required

End time for this collection as measured by the number of seconds since baseTime.
Example : "string"

string (date-time)

observedTimeInMS
required

Example : "string"

string (int64)

lastResetTime
required

Example : "string"

string (date-time)

lastResetTimeInMS
required

Example : "string"

string (int64)

arrayId
required

Example : "string"

string

arrayWwn
required

Example : "string"

string

memberIdsHash
required

Hash of member volume ids.
Example : "string"

string

readOps
required

Number of read operations
Example : 0.0

number (double)

readHitOps
required

Number of read operations that hit cache
Example : 0.0

number (double)

readHitBytes
required

Number of bytes read from cache
Example : 0.0

number (double)

readTimeTotal
required

Example : 0.0

number (double)

readHitTimeTotal
required

Example : 0.0

number (double)

writeOps
required

Number of write operations
Example : 0.0

number (double)

writeTimeTotal
required

Example : 0.0

number (double)

writeHitTimeTotal
required

Example : 0.0

number (double)

errRedundancyChkIndeterminateReads
required

Example : 0.0

number (double)

errRedundancyChkRecoveredReads
required

Example : 0.0

number (double)

errRedundancyChkUnrecoveredReads
required

Example : 0.0

number (double)

idleTime
required

Example : 0.0

number (double)

otherOps
required

Example : 0.0

number (double)

otherTimeMax
required

Example : 0.0

number (double)

otherTimeTotal
required

Example : 0.0

number (double)

readBytes
required

Example : 0.0

number (double)

readHitTimeMax
required

Example : 0.0

number (double)

readTimeMax
required

Example : 0.0

number (double)

writeBytes
required

Example : 0.0

number (double)

writeHitBytes
required

Number of bytes written to cache
Example : 0.0

number (double)

writeHitOps
required

Number of write operations that hit cache
Example : 0.0

number (double)

writeHitTimeMax
required

Example : 0.0

number (double)

writeTimeMax
required

Example : 0.0

number (double)

queueDepthTotal
required

Total channel queue depth.
Example : 0.0

number (double)

queueDepthMax
required

Maximum channel queue depth.
Example : 0.0

number (double)

flashCacheReadHitOps
required

The number of flash cache read hit operations.
Example : 0.0

number (double)

flashCacheReadHitBytes
required

The number of flash cache read hit bytes.
Example : 0.0

number (double)

flashCacheReadHitTimeTotal
required

The sum of all response times for all reads that have cache hits, in microseconds
Example : 0.0

number (double)

flashCacheReadHitTimeMax
required

Maximum I/O time in microseconds for any one read I/O that has a cache hit
Example : 0.0

number (double)

applicationId
required

The application id of the collection
Example : "string"

string

4.329. InterfaceStats

Interface I/O performance statistics.

Name Description Schema

observedTime
required

End time for this collection as measured by the number of seconds since baseTime.
Example : "string"

string (date-time)

observedTimeInMS
required

Example : "string"

string (int64)

lastResetTime
required

Example : "string"

string (date-time)

lastResetTimeInMS
required

Example : "string"

string (int64)

interfaceId
required

Interface that generated this group.
Example : "string"

string

arrayId
required

Example : "string"

string

arrayWwn
required

Example : "string"

string

channelType
required

Channel Type enumeration Drive side, host side, or management.
Example : "string"

enum (hostside, driveside, management, __UNDEFINED)

channelNumber
required

Channel numerical ID.
Example : 0

integer (int32)

readOps
required

Number of read operations.
Example : 0.0

number (double)

readBytes
required

Number of bytes read.
Example : 0.0

number (double)

readTimeTotal
required

Total time in microseconds spent in read operations.
Example : 0.0

number (double)

readTimeMax
required

Max time in microseconds spent processing one read operation.
Example : 0.0

number (double)

writeOps
required

Number of write operations.
Example : 0.0

number (double)

writeBytes
required

Number of bytes write.
Example : 0.0

number (double)

writeTimeTotal
required

Total time in microseconds spent in write operations.
Example : 0.0

number (double)

writeTimeMax
required

Max time in microseconds spent processing one write operation.
Example : 0.0

number (double)

otherOps
required

Number of non-read-write operations.
Example : 0.0

number (double)

otherTimeTotal
required

Total time in microseconds spent in non-read-write ops.
Example : 0.0

number (double)

otherTimeMax
required

Max time in microseconds spent processing one non-read-write op.
Example : 0.0

number (double)

readTimeTotalSq
required

Sum of the squares of microseconds spent in read operations.
Example : 0.0

number (double)

writeTimeTotalSq
required

Sum of the squares of microseconds spent in write operations.
Example : 0.0

number (double)

otherTimeTotalSq
required

Sum of the squares of microseconds spent in non-read-write operations.
Example : 0.0

number (double)

queueDepthTotal
required

Total channel queue depth.
Example : 0.0

number (double)

queueDepthMax
required

Maximum channel queue depth.
Example : 0.0

number (double)

channelErrorCount
required

The total number of errors detected on this channel.
Example : 0.0

number (double)

4.330. PoolStatistics

Raw volume statistics for storage pools.

Name Description Schema

observedTime
required

End time for this collection as measured by the number of seconds since baseTime.
Example : "string"

string (date-time)

observedTimeInMS
required

Example : "string"

string (int64)

lastResetTime
required

Example : "string"

string (date-time)

lastResetTimeInMS
required

Example : "string"

string (int64)

arrayId
required

Example : "string"

string

arrayWwn
required

Example : "string"

string

memberIdsHash
required

Hash of member volume ids.
Example : "string"

string

readOps
required

Number of read operations
Example : 0.0

number (double)

readHitOps
required

Number of read operations that hit cache
Example : 0.0

number (double)

readHitBytes
required

Number of bytes read from cache
Example : 0.0

number (double)

readTimeTotal
required

Example : 0.0

number (double)

readHitTimeTotal
required

Example : 0.0

number (double)

writeOps
required

Number of write operations
Example : 0.0

number (double)

writeTimeTotal
required

Example : 0.0

number (double)

writeHitTimeTotal
required

Example : 0.0

number (double)

errRedundancyChkIndeterminateReads
required

Example : 0.0

number (double)

errRedundancyChkRecoveredReads
required

Example : 0.0

number (double)

errRedundancyChkUnrecoveredReads
required

Example : 0.0

number (double)

idleTime
required

Example : 0.0

number (double)

otherOps
required

Example : 0.0

number (double)

otherTimeMax
required

Example : 0.0

number (double)

otherTimeTotal
required

Example : 0.0

number (double)

readBytes
required

Example : 0.0

number (double)

readHitTimeMax
required

Example : 0.0

number (double)

readTimeMax
required

Example : 0.0

number (double)

writeBytes
required

Example : 0.0

number (double)

writeHitBytes
required

Number of bytes written to cache
Example : 0.0

number (double)

writeHitOps
required

Number of write operations that hit cache
Example : 0.0

number (double)

writeHitTimeMax
required

Example : 0.0

number (double)

writeTimeMax
required

Example : 0.0

number (double)

queueDepthTotal
required

Total channel queue depth.
Example : 0.0

number (double)

queueDepthMax
required

Maximum channel queue depth.
Example : 0.0

number (double)

flashCacheReadHitOps
required

The number of flash cache read hit operations.
Example : 0.0

number (double)

flashCacheReadHitBytes
required

The number of flash cache read hit bytes.
Example : 0.0

number (double)

flashCacheReadHitTimeTotal
required

The sum of all response times for all reads that have cache hits, in microseconds
Example : 0.0

number (double)

flashCacheReadHitTimeMax
required

Maximum I/O time in microseconds for any one read I/O that has a cache hit
Example : 0.0

number (double)

poolId
required

The storage pool or volume group the volume is a member
Example : "string"

string

4.331. RawStatsResponse

The collection of stats that are returned from a call to get live statistics.

Name Description Schema

volumeStats
required

Example : [ "VolumeIOStats" ]

< VolumeIOStats > array

controllerStats
required

Example : [ "ControllerStats" ]

< ControllerStats > array

systemStats
required

Example : [ "StorageSystemStats" ]

< StorageSystemStats > array

interfaceStats
required

Example : [ "InterfaceStats" ]

< InterfaceStats > array

diskStats
required

Example : [ "DiskIOStats" ]

< DiskIOStats > array

poolStats
required

Example : [ "PoolStatistics" ]

< PoolStatistics > array

applicationStats
required

Example : [ "ApplicationStatistics" ]

< ApplicationStatistics > array

workloadStats
required

Example : [ "WorkloadStatistics" ]

< WorkloadStatistics > array

4.332. StorageSystemControllerStats

Controller statistics.

Name Description Schema

controllerId
required

Controller id.
Example : "string"

string

cpuUtilizationStats
required

CPU utilization statistics.
Example : [ "CpuUtilizationStats" ]

< CpuUtilizationStats > array

4.333. StorageSystemStats

Storage system performance statistics.

Name Description Schema

observedTime
required

End time for this collection as measured by the number of seconds since baseTime.
Example : "string"

string (date-time)

observedTimeInMS
required

Example : "string"

string (int64)

lastResetTime
required

Example : "string"

string (date-time)

lastResetTimeInMS
required

Example : "string"

string (int64)

arrayId
required

Example : "string"

string

arrayWwn
required

Example : "string"

string

memberIdsHash
required

Hash of member controller ids.
Example : "string"

string

controllerStats
required

Statistics for each controller.
Example : [ "StorageSystemControllerStats" ]

< StorageSystemControllerStats > array

totalIopsServiced
required

Total number of IO operations serviced by the controller.
Example : 0.0

number (double)

totalBytesServiced
required

Total number of Bytes serviced by the controller.
Example : 0.0

number (double)

cacheHitsIopsTotal
required

Total number of IO operations that hit cache.
Example : 0.0

number (double)

cacheHitsBytesTotal
required

Total number of bytes that hit cache.
Example : 0.0

number (double)

randomIosTotal
required

Total number of IOs that are categorized as random.
Example : 0.0

number (double)

randomBytesTotal
required

Total number of Bytes that are categorized as random.
Example : 0.0

number (double)

readIopsTotal
required

Total number of Read IO operations.
Example : 0.0

number (double)

readBytesTotal
required

Total number of Bytes read.
Example : 0.0

number (double)

writeIopsTotal
required

Total number of Write IO operations.
Example : 0.0

number (double)

writeBytesTotal
required

Total number of Bytes written.
Example : 0.0

number (double)

mirrorIopsTotal
required

Total number of IO operations serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value.
Example : 0.0

number (double)

mirrorBytesTotal
required

Total number of Bytes serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value.
Example : 0.0

number (double)

fullStripeWritesBytes
required

Bytes written that are categorized as Full stripe writes.
Example : 0.0

number (double)

raid0BytesTransferred
required

Bytes transferred that are categorized as RAID 0 transfers.
Example : 0.0

number (double)

raid1BytesTransferred
required

Bytes transferred that are categorized as RAID 1 transfers.
Example : 0.0

number (double)

raid5BytesTransferred
required

Bytes transferred that are categorized as RAID 5 transfers.
Example : 0.0

number (double)

raid6BytesTransferred
required

Bytes transferred that are categorized as RAID 6 transfers.
Example : 0.0

number (double)

ddpBytesTransferred
required

Bytes transferred that are categorized as DDP transfers.
Example : 0.0

number (double)

maxPossibleBpsUnderCurrentLoad
required

Theoretical maximum possible Bytes per second under current load.
Example : 0.0

number (double)

maxPossibleIopsUnderCurrentLoad
required

Theoretical maximum possible IO per second under current load.
Example : 0.0

number (double)

4.334. VolumeIOStats

A single Volume I/O performance statistics. Note: the DELETE method clears all statistics for all volumes.

Name Description Schema

observedTime
required

End time for this collection as measured by the number of seconds since baseTime.
Example : "string"

string (date-time)

observedTimeInMS
required

Example : "string"

string (int64)

lastResetTime
required

Example : "string"

string (date-time)

lastResetTimeInMS
required

Example : "string"

string (int64)

volumeGroupId
required

Example : "string"

string

controllerId
required

Example : "string"

string

volumeId
required

Example : "string"

string

arrayId
required

Example : "string"

string

arrayWwn
required

Example : "string"

string

volumeGroupWwn
required

Example : "string"

string

volumeName
required

Example : "string"

string

volumeWwn
required

Example : "string"

string

workloadId
required

The associated workload id
Example : "string"

string

readOps
required

Example : 0.0

number (double)

readHitOps
required

Number of read operations that hit cache
Example : 0.0

number (double)

readHitBytes
required

Number of bytes read from cache
Example : 0.0

number (double)

readTimeTotal
required

Example : 0.0

number (double)

readHitTimeTotal
required

Example : 0.0

number (double)

writeOps
required

Example : 0.0

number (double)

writeCacheHitOps
required

A redundant field to write Hit Ops
Example : 0.0

number (double)

writeTimeTotal
required

Example : 0.0

number (double)

writeHitTimeTotal
required

Example : 0.0

number (double)

errRedundancyChkIndeterminateReads
required

Example : 0.0

number (double)

errRedundancyChkRecoveredReads
required

Example : 0.0

number (double)

errRedundancyChkUnrecoveredReads
required

Example : 0.0

number (double)

idleTime
required

Example : 0.0

number (double)

otherOps
required

Example : 0.0

number (double)

otherTimeMax
required

Example : 0.0

number (double)

otherTimeTotal
required

Example : 0.0

number (double)

otherTimeTotalSq
required

Example : 0.0

number (double)

readBytes
required

Example : 0.0

number (double)

readHitTimeMax
required

Example : 0.0

number (double)

readHitTimeTotalSq
required

Example : 0.0

number (double)

readTimeMax
required

Example : 0.0

number (double)

readTimeTotalSq
required

Example : 0.0

number (double)

writeBytes
required

Example : 0.0

number (double)

writeHitBytes
required

Number of bytes written to cache
Example : 0.0

number (double)

writeHitOps
required

Number of write operations that hit cache
Example : 0.0

number (double)

writeHitTimeMax
required

Example : 0.0

number (double)

writeHitTimeTotalSq
required

Example : 0.0

number (double)

writeTimeMax
required

Example : 0.0

number (double)

writeTimeTotalSq
required

Example : 0.0

number (double)

queueDepthTotal
required

Total channel queue depth.
Example : 0.0

number (double)

queueDepthMax
required

Maximum channel queue depth.
Example : 0.0

number (double)

randomIosTotal
required

Example : 0.0

number (double)

randomBytesTotal
required

Example : 0.0

number (double)

cacheWriteWaitHitIops
required

Example : 0.0

number (double)

cacheWriteWaitHitBytes
required

Example : 0.0

number (double)

fullStripeWriteBytes
required

Storage-systems running a firmware version prior to 08.40.+ / 11.40.+ will have this field represent the number of stripes that use a full stripe write algorithm. storage-systems running a firmware version greater than or equal to 08.40.+ / 11.40.+ will have this field represent the number bytes that are written in a full stripe write algorithm.
Example : 0.0

number (double)

totalIosShipped
required

Example : 0.0

number (double)

totalBlksEvicted
required

Example : 0.0

number (double)

cacheBlksInUse
required

Example : 0.0

number (double)

prefetchHitBytes
required

The number of pre-fetched bytes that are ultimately read by the host
Example : 0.0

number (double)

prefetchMissBytes
required

The number of pre-fetched bytes that are evicted from cache without being read by the host.
Example : "string"

string (int64)

flashCacheReadHitOps
required

The number of flash cache read hit operations.
Example : 0.0

number (double)

flashCacheReadHitBytes
required

The number of flash cache read hit bytes.
Example : 0.0

number (double)

flashCacheReadHitTimeTotal
required

The sum of all response times for all reads that have cache hits, in microseconds
Example : 0.0

number (double)

flashCacheReadHitTimeMax
required

Maximum I/O time in microseconds for any one read I/O that has a cache hit
Example : 0.0

number (double)

flashCacheReadHitTimeTotalSq
required

The sum of the squares of the response times for all reads that have cache hits, in microseconds (used for standard deviation).
Example : 0.0

number (double)

4.335. WorkloadStatistics

Aggregation of volume statistics for a workload.

Name Description Schema

observedTime
required

End time for this collection as measured by the number of seconds since baseTime.
Example : "string"

string (date-time)

observedTimeInMS
required

Example : "string"

string (int64)

lastResetTime
required

Example : "string"

string (date-time)

lastResetTimeInMS
required

Example : "string"

string (int64)

arrayId
required

Example : "string"

string

arrayWwn
required

Example : "string"

string

memberIdsHash
required

Hash of member volume ids.
Example : "string"

string

readOps
required

Number of read operations
Example : 0.0

number (double)

readHitOps
required

Number of read operations that hit cache
Example : 0.0

number (double)

readHitBytes
required

Number of bytes read from cache
Example : 0.0

number (double)

readTimeTotal
required

Example : 0.0

number (double)

readHitTimeTotal
required

Example : 0.0

number (double)

writeOps
required

Number of write operations
Example : 0.0

number (double)

writeTimeTotal
required

Example : 0.0

number (double)

writeHitTimeTotal
required

Example : 0.0

number (double)

errRedundancyChkIndeterminateReads
required

Example : 0.0

number (double)

errRedundancyChkRecoveredReads
required

Example : 0.0

number (double)

errRedundancyChkUnrecoveredReads
required

Example : 0.0

number (double)

idleTime
required

Example : 0.0

number (double)

otherOps
required

Example : 0.0

number (double)

otherTimeMax
required

Example : 0.0

number (double)

otherTimeTotal
required

Example : 0.0

number (double)

readBytes
required

Example : 0.0

number (double)

readHitTimeMax
required

Example : 0.0

number (double)

readTimeMax
required

Example : 0.0

number (double)

writeBytes
required

Example : 0.0

number (double)

writeHitBytes
required

Number of bytes written to cache
Example : 0.0

number (double)

writeHitOps
required

Number of write operations that hit cache
Example : 0.0

number (double)

writeHitTimeMax
required

Example : 0.0

number (double)

writeTimeMax
required

Example : 0.0

number (double)

queueDepthTotal
required

Total channel queue depth.
Example : 0.0

number (double)

queueDepthMax
required

Maximum channel queue depth.
Example : 0.0

number (double)

flashCacheReadHitOps
required

The number of flash cache read hit operations.
Example : 0.0

number (double)

flashCacheReadHitBytes
required

The number of flash cache read hit bytes.
Example : 0.0

number (double)

flashCacheReadHitTimeTotal
required

The sum of all response times for all reads that have cache hits, in microseconds
Example : 0.0

number (double)

flashCacheReadHitTimeMax
required

Maximum I/O time in microseconds for any one read I/O that has a cache hit
Example : 0.0

number (double)

workloadId
required

he workload id of the collection
Example : "string"

string

4.336. AverageAnalysedApplicationStats

The statistics for a volume averaged over a time range.

Name Description Schema

id
required

Example : "string"

string

latencyRead
required

Lantency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

latencyWrite
required

Latency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsRead
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsWrite
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputRead
required

Read throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputWrite
required

Write throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

primaryCacheReadHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

primaryCacheWriteHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

ssdCacheReadHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

4.337. AverageAnalysedControllerStats

Controller statistics averaged over a time range.

Name Description Schema

id
required

Example : "string"

string

iopsRead
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsWrite
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputRead
required

Read throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputWrite
required

Write throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

cpuUtilization
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

headroomPct
required

Performance headroom percentage
Example : "AverageAnalysedValue"

AverageAnalysedValue

4.338. AverageAnalysedDriveStats

The statistics for a drive averaged over a time range.

Name Description Schema

id
required

Example : "string"

string

latencyRead
required

Latency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

latencyWrite
required

Latency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsRead
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsWrite
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputRead
required

Read throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputWrite
required

Write throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

4.339. AverageAnalysedInterfaceStats

The statistics for an interface averaged over a time range.

Name Description Schema

id
required

Example : "string"

string

latencyRead
required

Latency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

latencyWrite
required

Latency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsRead
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsWrite
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputRead
required

Read throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputWrite
required

Write throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

headroomPct
required

Performance headroom percentage
Example : "AverageAnalysedValue"

AverageAnalysedValue

4.340. AverageAnalysedPoolStats

The statistics for a volume averaged over a time range.

Name Description Schema

id
required

Example : "string"

string

latencyRead
required

Lantency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

latencyWrite
required

Latency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsRead
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsWrite
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputRead
required

Read throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputWrite
required

Write throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

primaryCacheReadHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

primaryCacheWriteHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

ssdCacheReadHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

4.341. AverageAnalysedStatsResponse

The collection of statistics averaged over a time range.

Name Description Schema

volumeStats
required

Example : [ "AverageAnalysedVolumeStats" ]

< AverageAnalysedVolumeStats > array

diskStats
required

Example : [ "AverageAnalysedDriveStats" ]

< AverageAnalysedDriveStats > array

controllerStats
required

Example : [ "AverageAnalysedControllerStats" ]

< AverageAnalysedControllerStats > array

interfaceStats
required

Example : [ "AverageAnalysedInterfaceStats" ]

< AverageAnalysedInterfaceStats > array

systemStats
required

Example : [ "AverageAnalysedSystemStats" ]

< AverageAnalysedSystemStats > array

poolStats
required

Example : [ "AverageAnalysedPoolStats" ]

< AverageAnalysedPoolStats > array

workloadStats
required

Example : [ "AverageAnalysedWorkloadStats" ]

< AverageAnalysedWorkloadStats > array

applicationStats
required

Example : [ "AverageAnalysedApplicationStats" ]

< AverageAnalysedApplicationStats > array

4.342. AverageAnalysedSystemControllerStats

The statistics for a controller averaged over a time range.

Name Description Schema

controllerId
required

Example : "string"

string

cpuUtilization
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

4.343. AverageAnalysedSystemStats

The statistics for a storage system averaged over a time range.

Name Description Schema

id
required

Example : "string"

string

iopsRead
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsWrite
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputRead
required

Read throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputWrite
required

Write throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

controllerStats
required

Example : [ "AverageAnalysedSystemControllerStats" ]

< AverageAnalysedSystemControllerStats > array

4.344. AverageAnalysedValue

Statistics data averaged over a time range.

Name Description Schema

min
required

Example : 0.0

number (double)

max
required

Example : 0.0

number (double)

value
required

Example : 0.0

number (double)

std
required

Example : 0.0

number (double)

4.345. AverageAnalysedVolumeStats

The statistics for a volume averaged over a time range.

Name Description Schema

id
required

Example : "string"

string

latencyRead
required

Lantency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

latencyWrite
required

Latency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsRead
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsWrite
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputRead
required

Read throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputWrite
required

Write throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

primaryCacheReadHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

primaryCacheWriteHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

ssdCacheReadHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

4.346. AverageAnalysedWorkloadStats

The statistics for a volume averaged over a time range.

Name Description Schema

id
required

Example : "string"

string

latencyRead
required

Lantency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

latencyWrite
required

Latency in milliseconds
Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsRead
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

iopsWrite
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputRead
required

Read throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

throughputWrite
required

Write throughput in B/s
Example : "AverageAnalysedValue"

AverageAnalysedValue

primaryCacheReadHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

primaryCacheWriteHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

ssdCacheReadHitPct
required

Example : "AverageAnalysedValue"

AverageAnalysedValue

4.347. IdentificationRequest

Name Description Schema

channels
optional

A list of channel ids. There must be an expansion drive tray attached to identify a channel.
Example : [ 0 ]

< integer (int32) > array

trays
optional

A list of tray ids.
Example : [ "string" ]

< string > array

drives
optional

A list of drive ids.
Example : [ "string" ]

< string > array

pools
optional

A list of storage pool ids. Associated, optimal drives will be identified.
Example : [ "string" ]

< string > array

volumes
optional

A list of volume ids. Associated, optimal drives will be identified.
Example : [ "string" ]

< string > array

storageSystem
optional

Set to "true" to identify the StorageSystem.
Example : true

boolean

4.348. Target

Name Description Schema

targetRef
required

The reference that uniquely identifies an instance of this object.
Example : "string"

string

nodeName
required

The unique node name associated with the target.
Example : "ScsiNodeName"

ScsiNodeName

alias
required

An additional name that can be assigned to a target, which is usually "friendlier" than the node name.
Example : "ScsiAlias"

ScsiAlias

configuredAuthMethods
required

The authentication methods that have been configured for the target. Associated secrets are not exposed. instead the type field of the EncryptedPassword is set to ENCRYPT_UNSPECIFIED.
Example : "AuthenticationBundle"

AuthenticationBundle

portals
required

The set of configured (i.e., either in-use or listening for connections) portals associated with this target.
Example : [ "TargetPortal" ]

< TargetPortal > array

4.349. IscsiEntityResponse

Provides information about the storage array in its role as "iSCSI entity."

Name Description Schema

icmpPingResponseEnabled
optional

Example : true

boolean

unnamedDiscoverySessionsEnabled
optional

Example : true

boolean

isnsServerTcpListenPort
optional

Example : 0

integer (int32)

ipv4IsnsServerAddress
optional

Example : "string"

string

ipv6IsnsServerAddress
optional

Example : "string"

string

isnsServerRegistrationEnabled
optional

Example : true

boolean

hostPortsConfiguredDHCP
optional

Example : true

boolean

ipv4IsnsServerAddressConfigMethod
optional

Example : "string"

enum (configDhcp, configStatic, __UNDEFINED)

ipv6IsnsServerAddressConfigMethod
optional

Example : "string"

enum (configStatic, configStateless, __UNDEFINED)

isnsRegistrationState
optional

Example : "string"

enum (disabled, locatingServer, connectingToServer, completed, __UNDEFINED)

4.350. IscsiEntityUpdateRequest

Updates the iSCSI entity data.

Name Description Schema

icmpPingResponseEnabled
optional

The setting for enabling or disabling the ICMP (Internet Control Message Protocol) ping messages.
Example : true

boolean

unnamedDiscoverySessionsEnabled
optional

The setting for enabling or disabling unnamed discovery sessions.
Example : true

boolean

isnsServerTcpListenPort
optional

The number of the TCP port on which the iSNS server listens for incoming connections.
Example : 0

integer (int32)

ipv4IsnsServerAddressConfigMethod
optional

The IPV4 configuration method to use for determining the IP address of the iSNS server. Whenever there is a transition of the configuration method from IPV4_CONFIG_STATIC to IPV4_CONFIG_DHCP, the storage array performs the equivalent of a refreshIsnsServerLocation operation.
Example : "string"

enum (configDhcp, configStatic, __UNDEFINED)

ipv4IsnsServerAddress
optional

The IPV4 configuration method to use for determining the IP address of the iSNS server. Whenever there is a transition of the configuration method from IPV4_CONFIG_STATIC to IPV4_CONFIG_DHCP, the storage array performs the equivalent of a refreshIsnsServerLocation operation.
Example : "string"

string

ipv6IsnsServerAddress
optional

The IPV6 address of the iSNS server.
Example : "string"

string

isnsServerRegistrationEnabled
optional

The setting is for enabling or disabling storage array registration with the iSNS server.
Example : true

boolean

4.351. IscsiTargetResponse

Provides information for the iSCSI target.

Name Description Schema

authMethod
required

Authentication type (None or CHAP)
Example : "string"

enum (none, chap, __UNDEFINED)

chapSecret
required

CHAP secret/password.
Example : "string"

string

iqn
required

iSCSI Qualified Name (iqn)
Example : "string"

string

alias
required

The iSCSI target alias.
Example : "string"

string

4.352. IscsiTargetUpdateRequest

Updates the iSCSI target data.

Name Description Schema

alias
optional

The iSCSI target alias.
Example : "string"

string

enableChapAuthentication
optional

Enable Challenge-Handshake Authentication Protocol (CHAP), defaults to false.
Example : true

boolean

chapSecret
optional

Enable Challenge-Handshake Authentication Protocol (CHAP) using the provided password. A secure password will be generated and returned if CHAP is enabled and this field is not provided.
Example : "string"

string

4.353. BindLookupUser

Name Description Schema

password
required

The password for the bind user
Example : "string"

string

user
required

The full DN for the bind user account
Example : "cn=BindUser,ou=system-accounts,dc=example,dc=com"

string

4.354. GroupMapping

Name Description Schema

groupRegex
optional

specifies the DN of the group. The wildcard .* can optionally be used to allow specifying only a partial DN.
Example : ".cn=data-admin."

string

ignorecase
optional

Whether or not to ignore case for the group mappings
Example : false

boolean

name
required

Specifies the role of the group
Example : "storage.monitor"

enum (security_admin, storage_none, support_admin, storage_monitor, storage_admin)

4.355. LdapDomain

Structure that contains information about an LDAP Domain

Name Description Schema

id
optional

Unique ID linked to this domain
Example : "string"

string

bindLookupUser
optional

If needed, you can configure a specific user to use when looking up the group membership for users. Typically, you would configure this whenever regular users might lack reader permissions to view their own group membership. The bind user information must be specified as a full DN.
Example : "BindLookupUser"

BindLookupUser

groupAttributes
required

A list of group attributes on the user that will be searched to for group to role mapping
Example : "memberOf"

< string > array

ldapUrl
required

The LDAP URL entry must be specified as either ldap or ldaps protocol and contain the IP address. In addition, the port for the LDAP URL must be specified (typically 389 for ldap and 636 for ldaps).
Example : "ldaps://ldap.example.com:636"

string

names
required

Each domain will have one ormultiple names and it is presumed the name will match the DNS domain for the LDAP server but it is not required. Domains can be named anything as long as they are valid DNS names.
Example : [ "string" ]

< string > array

roleMapCollection
optional

A list of regular expression patterns to match to the user’s group attributes to match to roles. (TODO: NEED TO FIX FOR A MAPPING TYPE)
Example : [ "GroupMapping" ]

< GroupMapping > array

searchBase
optional

The search base is used to find group memberships of the user. The search base is the DN in the directory of a container object of users. The filter base is used to find the user object within this container. After the user object is located, any associated group membership is identified.
Example : "ou=users,dc=example,dc=com"

string

userAttribute
optional

The user attribute is used match the username supplied to an object on the server
Example : "sAMAccountName"

string

4.356. LdapConfiguration

Structure that contains information about an LDAP Configuration

Name Description Schema

ldapDomains
required

The defined LDAP domains
Example : [ "LdapDomain" ]

< LdapDomain > array

4.357. RolePermissionData

Role permissions for an endpoint.

Name Description Schema

httpMethod
required

HTTP method
Example : "string"

string

endpoint
required

Endpoint path
Example : "string"

string

roles
required

List of roles allowed to access this endpoint
Example : [ "string" ]

< string > array

4.358. RolesResponse

API response object that includes current user roles and list of role permissions.

Name Description Schema

userRoles
required

Current user roles
Example : [ "string" ]

< string > array

endpoints
required

List of endpoints and their role permissions
Example : [ "RolePermissionData" ]

< RolePermissionData > array

4.359. LdapDomainTestResponse

Result of a test against an LDAP domain

Name Description Schema

id
optional

ID of the configured domain
Example : "string"

string

result
optional

Example : "LdapDomainTestResponseResults"

LdapDomainTestResponseResults

4.360. LdapDomainTestResponseResults

Result of a test against an LDAP domain

Name Description Schema

connectionTestResult
optional

Results of the connection test
Example : "string"

enum (ok, failed, notRun)

authenticationTestResult
optional

Results of the authentication test
Example : "string"

enum (ok, failed, notRun)

searchTestResult
optional

Results of the search test
Example : "string"

enum (ok, failed, notRun)

4.361. RepositoryUtilization

Name Description Schema

repositoryUsage
required

This field contains the number of bytes used in the repository.
Example : "string"

string (int64)

snapRef
required

The snapshot volume to which this utilization refers.
Example : "string"

string

4.362. LegacySnapshotEx

Name Description Schema

worldWideName
required

The World Wide Name of the snapshot.
Example : "string"

string

snapshotRef
required

Reference (key) for the snapshot volume.
Example : "string"

string

label
required

Name of the snapshot.
Example : "string"

string

status
required

Indicates status of the snapshot.
Example : "string"

enum (active, failed, disabled, offline, __UNDEFINED)

action
required

Long running action.
Example : "string"

enum (none, rollback, __UNDEFINED)

currentManager
required

Current owner of the snapshot.
Example : "string"

string

baseVolume
required

Base volume for this snapshot.
Example : "string"

string

repositoryVolume
required

Repository volume for this snapshot.
Example : "string"

string

fullWarnThreshold
required

Repository utilization warning threshold.
Example : 0

integer (int32)

overWarnThreshold
required

True if the repository utilization is over the warning threshold.
Example : true

boolean

repositoryFull
required

True, if the repository is full.
Example : true

boolean

repFullPolicy
required

Indication of the volume behavior when the repository is full.
Example : "string"

enum (failwrites, failsnap, __UNDEFINED)

rollbackPriority
required

The importance of the rollback operation (0-4). Not used in this release of software.
Example : 0

integer (int32)

extentStart
required

The start position of the extent in the base volume (bytes). Not used in this release of software.
Example : "string"

string (int64)

extentSize
required

The size of the extent in bytes. Not used in this release of software.
Example : "string"

string (int64)

snapshotTime
required

The controller time when the snapshot was created.
Example : "string"

string (int64)

perms
required

Permissions allowed on volume.
Example : "VolumePerms"

VolumePerms

childrenInactive
required

True if all child volumes are offline or failed. Child volumes are the base volume and the REPOSITORY volume.
Example : true

boolean

volumeHandle
required

Volume SSID.
Example : 0

integer (int32)

mgmtClientAttribute
required

For use by management client.
Example : 0

integer (int32)

rollbackStatus
required

Status of current action being performed on snapshot.
Example : "string"

enum (none, inProgress, pending, paused, __UNDEFINED)

baseVolumeSizeInBytes
optional

Example : "string"

string (int64)

totalSizeInBytes
optional

Example : "string"

string (int64)

preferredControllerId
optional

Example : "string"

string

repositoryCapacity
optional

Example : "string"

string (int64)

volumeCopyTarget
optional

Example : true

boolean

volumeCopySource
optional

Example : true

boolean

pitBaseVolume
optional

Example : true

boolean

asyncMirrorTarget
optional

True if the volume is a target in an Asynchronous Mirror relationship.
Example : true

boolean

asyncMirrorSource
optional

True if the volume is a source in an Asynchronous Mirror relationship.
Example : true

boolean

protectionType
optional

Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

remoteMirrorSource
optional

True if the volume is a source (primary), in an Remote Volume Mirror relationship.
Example : true

boolean

remoteMirrorTarget
optional

True if the volume is a target (secondary), in an Remote Volume Mirror relationship.
Example : true

boolean

name
optional

Example : "string"

string

id
optional

Example : "string"

string

objectType
optional

Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

wwn
optional

Example : "string"

string

mapped
required

Example : true

boolean

onlineVolumeCopy
optional

Example : true

boolean

listOfMappings
optional

Example : [ "LUNMapping" ]

< LUNMapping > array

currentControllerId
optional

Example : "string"

string

4.363. LegacySnapshotCreateRequest

Creates a legacy Snapshot (non-PiT).

Name Description Schema

baseVolumeId
required

The identifier of the volume or thin volume for the new snapshot group.
Example : "string"

string

name
required

The name of the new snapshot.
Example : "string"

string

repositoryPercentage
optional

Size of the snapshot repository in relation to the base volume capacity
Default : 20.0
Example : 0.0

number (double)

warningThreshold
required

Warn the user when the repository is % full.
Default : 80
Example : 0

integer (int32)

fullPolicy
optional

The behavior on when the data repository becomes full.
Default : "failsnap"
Example : "string"

enum (failwrites, failsnap, __UNDEFINED)

storagePoolId
optional

The identifier of the storage pool to allocate the repository volume.
Example : "string"

string

4.364. LegacySnapshotUpdateRequest

Updates the legacy Snapshot (non-PiT) data.

Name Description Schema

warningThreshold
optional

Warn the user when the repository is % full.
Example : 0

integer (int32)

fullPolicy
optional

The behavior on when the data repository becomes full.
Example : "string"

enum (failwrites, failsnap, __UNDEFINED)

newName
optional

New name for the snapshot.
Example : "string"

string

recreateSnapshot
optional

Recreate the snapshot.
Example : true

boolean

4.365. LocalizedLogMessage

Name Description Schema

loggerType
required

Logger type of this message
Example : "string"

enum (cfwUpgradeLogger, driveUpgradeLogger, iomServiceLogger, nvsramUpgradeLogger, cfwUpgradeTimestamp, driveUpgradeTimestamp, iomServiceTimestamp, nvsramUpgradeTimestamp, auditLogLogger)

timestamp
required

Timestamp for this log message
Example : "string"

string (date-time)

messageText
optional

Localized message text
Example : "string"

string

context
required

Log message context
Example : "string"

string

recordId
required

ReplicatedRecord ID for this message
Example : "string"

string (int64)

4.366. LoggerRecordResponse

Name Description Schema

recordType
optional

Type of log records returned
Example : "string"

enum (cfwUpgradeLogger, driveUpgradeLogger, iomServiceLogger, nvsramUpgradeLogger, cfwUpgradeTimestamp, driveUpgradeTimestamp, iomServiceTimestamp, nvsramUpgradeTimestamp, auditLogLogger)

logRecords
optional

A Map of log records requested
Example : [ "LocalizedLogMessage" ]

< LocalizedLogMessage > array

timeStamps
required

A Map of timestamps for each logger type
Example : {
"string" : "string"
}

< string, string (date-time) > map

4.367. LockdownStatusResponse

API response object that includes lockdown status of the system.

Name Description Schema

isLockdown
required

True if the storage system is in lockdown mode
Example : true

boolean

storageSystemLabel
optional

Storage system label provided by the user
Example : "string"

string

lockdownType
optional

Type of the storage systemLockdown
Example : "string"

string

4.368. MappableObject

Name Description Schema

name
optional

Example : "string"

string

id
optional

Example : "string"

string

objectType
optional

Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

wwn
optional

Example : "string"

string

mapped
required

Example : true

boolean

preferredControllerId
optional

Example : "string"

string

totalSizeInBytes
optional

Example : "string"

string (int64)

listOfMappings
optional

Example : [ "LUNMapping" ]

< LUNMapping > array

currentControllerId
optional

Example : "string"

string

4.369. CacheBackupDeviceLocation

Name Description Schema

controllerTray
required

The tray ID of the controller that houses the cache backup device.
Example : 0

integer (int32)

controllerSlot
required

The slot number of the controller that houses the cache backup device.
Example : 0

integer (int32)

cacheBackupDeviceSlot
required

The number of the slot on the controller in which the cache backup device resides.
Example : 0

integer (int32)

4.370. CacheMemoryDimmLocation

Name Description Schema

controllerTray
required

The tray ID of the controller where the DIMM is installed.
Example : 0

integer (int32)

controllerSlot
required

The slot number of the controller where the DIMM is installed.
Example : 0

integer (int32)

cacheMemoryDimmControllerSlot
required

The number of the slot on the controller where the cache memory DIMM is installed. Cache memory DIMM slots are numbered starting at one, independent of other types of slots (e.g., cache backup device slots) on the controller.
Example : 0

integer (int32)

4.371. ChannelLocation

Name Description Schema

channelType
required

The channel type.
Example : "string"

enum (hostside, driveside, management, __UNDEFINED)

index
required

The channel location.
Example : 0

integer (int32)

controllerSlot
required

Controller number 1 if in top slot. Controller number 2 if in bottom slot.
Example : 0

integer (int32)

4.372. ComponentLocation

Name Description Schema

eventComponentType
required

This enumeration object is used to specify the different component types that can be associated with entries in the Major Event Log.
Example : "string"

enum (unknown, drive, powerSply, fan, minihub, tempSensor, channel, esm, controller, battery, enclosure, ups, chip, volume, volumeGrp, portCru, interconnectCru, supportCru, alarm, channelPort, sfpPort, hostBoard, newFormat, ctlrSfp, ctlrSoc, initiator, target, isnsServer, hostIoCard, cacheBackupDevice, cacheMemDimm, host, hostPort, drawer, relative, schedule, asyncMirrorGroup, diskPool, pit, pitConsistencyGroup, cgpit, cgview, flashCache, snmpCommunity, snmpTrapDestination, fcTarget, blankOne, blankTwo, fanOnlyCru, psuCru, nvmeInitiator, __UNDEFINED)

alarmLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_ALARM.
Example : "TraySlot"

TraySlot

batteryTray
optional

The tray ID of the tray containing the battery for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_BATTERY.
Example : 0

integer (int32)

cacheBackupDeviceLocation
optional

This field is valid only when the eventComponentType value is equal toEVENT_COMP_TYPE_CACHE_BACKUP_DEVICE. It identifies the location of the cache backup device to which the event applies.
Example : "CacheBackupDeviceLocation"

CacheBackupDeviceLocation

cacheMemoryDimmLocation
optional

This field is only valid when the eventComponentType value is equal to EVENT_COMP_TYPE_CACHE_MEM_DIMM. It identifies the location of the cache memory DIMM to which the event applies.
Example : "CacheMemoryDimmLocation"

CacheMemoryDimmLocation

channelLoc
optional

The location of the channel. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CHANNEL.
Example : "ChannelLocation"

ChannelLocation

channelPort
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CHANNEL_PORT.
Example : 0

integer (int32)

chipLoc
optional

The physical location of the controller that owns the chip for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CHIP.
Example : "TraySlot"

TraySlot

controllerLoc
optional

The physical location of the controller for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CONTROLLER.
Example : "TraySlot"

TraySlot

ctlrSfpLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CTLR_SFP.
Example : "ControllerSfpLocation"

ControllerSfpLocation

socLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CTLR_SOC.
Example : "SocLocation"

SocLocation

driveLoc
optional

The physical location of the drive for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_DRIVE.
Example : "TraySlot"

TraySlot

enclosureTray
optional

The tray ID of the tray for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_ENCLOSURE.
Example : 0

integer (int32)

esmTray
optional

The tray ID of the tray containing the ESM card for which the MEL entry was generated. This field is not used and is considered deprecated. Instead the ESM tray/slot location is given by the ExtendedComponentLocation field.
Example : 0

integer (int32)

fanTray
optional

The tray ID of the tray containing the fan for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_FAN.
Example : 0

integer (int32)

hostIoCardLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_HOST_IO_CARD. It identifies the location of the host I/O card to which the event applies.
Example : "HostIoCardLocation"

HostIoCardLocation

initiatorLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_INITIATOR. It identifies the iSCSI initiator to which the event applies.
Example : "InitiatorLocation"

InitiatorLocation

interconnectCruLocation
optional

No information is returned
Example : "TraySlot"

TraySlot

isnsServerLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_ISNS_SERVER. It identifies the iSNS server to which the event applies.
Example : "IsnsServerLocation"

IsnsServerLocation

minihubLoc
optional

The location of the minihub. This filed is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_MINIHUB.
Example : "MinihubLocation"

MinihubLocation

portCruTray
optional

The tray ID of the tray containing the Fibre Channel port CRU for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_PORT_CRU. This field is deprecated.
Example : 0

integer (int32)

powerSupplyTray
optional

The tray ID of the tray containing the power supply for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_POWER_SPLY.
Example : 0

integer (int32)

sfpLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_SFP_PORT.
Example : "TraySlot"

TraySlot

supportCruLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_SUPPORT_CRU.
Example : "TraySlot"

TraySlot

targetLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_TARGET. It identifies the iSCSI target to which the event applies.
Example : "TargetLocation"

TargetLocation

tempSensorTray
optional

The tray ID of the tray containing the temperature sensor for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_TEMP_SENSOR.
Example : 0

integer (int32)

label
optional

The user-assigned label of the volume for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_VOLUME
Example : "string"

string

groupNumber
optional

The volume group sequence number of the volume group for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_VOLUME_GRP.
Example : 0

integer (int32)

hostLocation
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_HOST. It is the user-assigned label of the host for which the MEL entry is reporting a problem.
Example : "string"

string

hostPortLocation
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_HOST_PORT. It identifies the host port to which the event applies.
Example : "HostPortLocation"

HostPortLocation

drawerLocation
optional

The physical location of the drawer for which the MEL event was generated. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_DRAWER.
Example : "TraySlot"

TraySlot

componentRelativeLocation
optional

The component type and location are described in this field. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_RELATIVE.
Example : "ComponentRelativeLocation"

ComponentRelativeLocation

schedule
optional

The user-assigned label of the schedule. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_SCHEDULE.
Example : "string"

string

diskPool
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_DISK_POOL.
Example : 0

integer (int32)

asyncMirrorGroup
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_ASYNC_MIRROR_GROUP.
Example : "string"

string

pitLabel
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_PIT. Note that events for PITs also include extended component location information beyond just the associated PiT Group label (PITs themselves are identified by a combination of the label of the associated PiT Group plus a sequence number).
Example : "string"

string

cgLabel
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_PIT_CONSISTENCY_GROUP.
Example : "string"

string

cgPitLabel
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_CGPIT. Note that events for CGPITs also include extended component location information beyond just the associated CG label (CGPITs themselves are identified by a combination of the label of the associated Consistency Group plus a sequence number).
Example : "string"

string

cgViewLabel
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_CGVIEW.
Example : "string"

string

flashCacheLabel
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_FLASH_CACHE. It identifies the flash cache device to which this event applies.
Example : "string"

string

communityNameString
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_SNMP_COMMUNITY. The community name string can contain up to 31 characters.
Example : "string"

string

destinationIpAddress
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_SNMP_TRAP_DESTINATION. It contains an ASCII representation of the destination address (the maximum number of characters is 40 for IPV6, 15 characters for IPV4.
Example : "string"

string

fcTargetLocation
optional

This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_FC_TARGET. It contains location data that is an 8-byte binary SCSI name.
Example : "FibreChannelTargetLocation"

FibreChannelTargetLocation

fanCruLocation
optional

Location information for fan CRU.
Example : "TraySlot"

TraySlot

powerSupplyCruLocation
optional

Power supply CRU location.
Example : "TraySlot"

TraySlot

nvmeInitiatorLocation
optional

This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_NVME_INITIATOR. It identifies the NVMe initiator to which the event applies.
Example : "InitiatorLocation"

InitiatorLocation

4.373. ComponentRelativeLocation

Name Description Schema

componentType
required

The type of component.
Example : "string"

enum (unknown, drive, powerSply, fan, minihub, tempSensor, channel, esm, controller, battery, enclosure, ups, chip, volume, volumeGrp, portCru, interconnectCru, supportCru, alarm, channelPort, sfpPort, hostBoard, newFormat, ctlrSfp, ctlrSoc, initiator, target, isnsServer, hostIoCard, cacheBackupDevice, cacheMemDimm, host, hostPort, drawer, relative, schedule, asyncMirrorGroup, diskPool, pit, pitConsistencyGroup, cgpit, cgview, flashCache, snmpCommunity, snmpTrapDestination, fcTarget, blankOne, blankTwo, fanOnlyCru, psuCru, nvmeInitiator, __UNDEFINED)

trayId
required

The tray ID of the tray containing the component.
Example : 0

integer (int32)

relativePosition
required

The relative position within the component’s parent.
Example : 0

integer (int32)

parentSize
required

The size of the parent array that follows.
Example : 0

integer (int32)

parent
required

This is an array containing additional parent-relative location information. The first element in the array will contain the parent’s component type and its relative position within it’s parent.
Example : [ "ParentRelativeLocation" ]

< ParentRelativeLocation > array

componentLabel
required

Contains the label of the component.
Example : "string"

string

4.374. ControllerSfpLocation

Name Description Schema

channelType
required

The channel type.
Example : "string"

enum (hostside, driveside, management, __UNDEFINED)

channel
required

The channel type.
Example : 0

integer (int32)

sfpPort
required

The number of the SFP port on the channel, 1-based.
Example : 0

integer (int32)

controllerSlot
required

The slot number of the controller, 1 or 2
Example : 0

integer (int32)

4.375. EventControl

Name Description Schema

oemPriority
required

If this value if equal to EVENT_DEFAULT_PRIORITY then the management client should use the priority value from the MelEntry structure when filtering events for display, otherwise this value should be used.
Example : "string"

enum (priorityDefault, priorityCritical, priorityInfo, priorityEmergency, priorityAlert, priorityError, priorityWarning, priorityNotice, priorityDebug, __UNDEFINED)

defaultNeedsAttention
required

This is the default value for needs attention. Its value can be overridden by oemNeedsAttention.
Example : true

boolean

defaultSendAlert
required

This is the default value for sending an alert. Its value can be overridden by oemSendAlert.
Example : true

boolean

defaultVisibility
required

This is the default value for visibility. Its value can be overridden by oemVisibility.
Example : true

boolean

oemNeedsAttention
required

If this value is equal to EVENT_CONTROL_ACCEPT_DEFAULT then the value of defaultNeedsAttention determines whether Needs Attention is set on the array. Otherwise, this field determines whether Needs Attention is set on the array.
Example : "string"

enum (unknown, acceptDefault, overrideToTrue, overrideToFalse, __UNDEFINED)

oemSendAlert
required

If this value is equal to EVENT_CONTROL_ACCEPT_DEFAULT then the value of defaultSendAlert determines whether an alert will be sent. Otherwise this field determines whether an alert will be sent.
Example : "string"

enum (unknown, acceptDefault, overrideToTrue, overrideToFalse, __UNDEFINED)

oemVisibility
required

If this value is equal to EVENT_CONTROL_ACCEPT_DEFAULT then the value of defaultVisibility determines whether the event will be displayed. Otherwise, this field determines whether the event will be displayed.
Example : "string"

enum (unknown, acceptDefault, overrideToTrue, overrideToFalse, __UNDEFINED)

collectSupportBundle
required

If this value is true, a support bundle will be collected.
Example : true

boolean

priorityCaseCreationTrigger
required

This flag indicates whether or not this MEL event should be marked as the reason a customer case was automatically created. It’s possible that multiple MEL events could be present in the MEL log that would trigger case creation. But the first MEL event in the log that has this flag set will be tagged as the event that caused the case to be created.
Example : true

boolean

4.376. ExtendedComponentLocation

Name Description Schema

extLocType
required

This enumeration object contains a list of all possible extended component location types that can be returned in a MEL entry.
Example : "string"

enum (unknown, tray, trayslot, minihub, channel, volume, pit, controller, ref, label, volumeGrp, diskPool, __UNDEFINED)

compChannelLoc
optional

This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_CHANNEL. This field is deprecated.
Example : "ChannelLocation"

ChannelLocation

compMinihubLoc
optional

This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_MINIHUB. This field is deprecated.
Example : "MinihubLocation"

MinihubLocation

compTray
optional

This field is present only if the extLocType value is EXT_COMP_LOCTYPE_TRAY
Example : 0

integer (int32)

compTraySlot
optional

This field is present only if the extLocType value is EXT_COMP_LOCTYPE_TRAYSLOT
Example : "TraySlot"

TraySlot

compLabel
optional

This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_VOLUME. This field is deprecated.
Example : "string"

string

pitSequence
optional

This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_PIT.
Example : "string"

string (int64)

compReference
optional

SYMbolRef of the component or channelPort
Example : "string"

string

controllerReference
optional

Controller Reference
Example : "string"

string

locationLabel
optional

Label associated with the physical location of the component or port.
Example : "string"

string

volumeGroupLabel
optional

This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_VOLUME_GRP.
Example : "string"

string

diskPoolLabel
optional

This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_DISK_POOL.
Example : "string"

string

4.377. FibreChannelTargetLocation

Name Description Schema

targetName
required

The Fibre Channel node name of the target,a binary 8-byte SCSI name.
Example : "string"

string

4.378. HostIoCardLocation

Name Description Schema

controllerTray
required

The tray ID of the controller that houses the host card.
Example : 0

integer (int32)

controllerSlot
required

The slot number of the controller that houses the host card.
Example : 0

integer (int32)

hostIoCardControllerSlot
required

The number of the slot on the controller where the host I/O card (a.k.a., host board) resides. Host I/O card slots are numbered starting at one, independent of other types of slots (e.g., cache backup device slots) on the controller.
Example : 0

integer (int32)

4.379. InitiatorLocation

Name Description Schema

initiatorName
required

The iSCSI node name of the initiator, left-truncated if necessary. (Left-truncation preserves the part of the name most likely to vary.)
Example : "string"

string

4.380. IsnsServerLocation

Name Description Schema

ipAddress
required

The IP address of the iSNS server.
Example : "IpVxAddress"

IpVxAddress

tcpListenPort
required

The number of the TCP port on which the iSNS server listens for incoming connections.
Example : 0

integer (int32)

4.381. MelEntryEx

Name Description Schema

sequenceNumber
required

The sequence number of the MEL entry. The controller maintains a unique, monotonically increasing 64-bit sequence number value and stamps each MEL entry with the next value of this counter.
Example : "string"

string (int64)

eventType
required

An integer value that indicates the specific type of event being reported.
Example : 0

integer (int32)

timeStamp
required

The time at which the MEL entry was generated. This value is defined in terms of the number of seconds since midnight GMT on January 1, 1970.
Example : "string"

string (int64)

category
required

The category into which this event falls. This value identifies the general type of activity or event that occurred and caused the entry to be generated.
Example : "string"

enum (error, failure, command, notification, stateChange, hostEntry, general, __UNDEFINED)

componentType
required

The type of component that is associated with this entry.
Example : "string"

enum (unknown, drive, powerSply, fan, minihub, tempSensor, channel, esm, controller, battery, enclosure, ups, chip, volume, volumeGrp, portCru, interconnectCru, supportCru, alarm, channelPort, sfpPort, hostBoard, newFormat, ctlrSfp, ctlrSoc, initiator, target, isnsServer, hostIoCard, cacheBackupDevice, cacheMemDimm, host, hostPort, drawer, relative, schedule, asyncMirrorGroup, diskPool, pit, pitConsistencyGroup, cgpit, cgview, flashCache, snmpCommunity, snmpTrapDestination, fcTarget, blankOne, blankTwo, fanOnlyCru, psuCru, nvmeInitiator, __UNDEFINED)

componentLocation
required

The location, or other identifying value, of the component associated with this entry.
Example : "ComponentLocation"

ComponentLocation

locationValid
required

A true/false indication of whether the ComponentLocation field is valid for this entry.
Example : true

boolean

priority
required

The priority code associated with this event.
Example : "string"

enum (priorityDefault, priorityCritical, priorityInfo, priorityEmergency, priorityAlert, priorityError, priorityWarning, priorityNotice, priorityDebug, __UNDEFINED)

eventSourceController
required

The controller that is the source of the event (Controller 1 or 2).
Example : 0

integer (int32)

senseKey
required

The Sense Key value associated with this event, or zero if no key is applicable.
Example : 0

integer (int32)

rawData
required

The raw data stored for this event. This information may be useful for debugging or troubleshooting problems with the assistance of a field support or development representative.
Example : "string"

string

extComponentLocation
required

Extended component location information for this entry. This data type of this field is a union with discriminator extLocType. If the discriminator is set to something other than EXT_COMP_LOCTYPE_UNKNOWN, then the location information in this field overrides what is in the componentLocation field.
Example : "ExtendedComponentLocation"

ExtendedComponentLocation

controlParams
required

This field allows customized control over the handling of MEL events.
Example : "EventControl"

EventControl

description
optional

Example : "string"

string

location
optional

Example : "string"

string

id
optional

Example : "string"

string

critical
optional

Example : true

boolean

asc
optional

Example : 0

integer (int32)

ascq
optional

Example : 0

integer (int32)

4.382. MinihubLocation

Name Description Schema

minihubType
required

Information returned is based on the minihub type.
Example : "string"

enum (hostside, driveside, __UNDEFINED)

channel
required

The channel number that this minihub is associated with.
Example : 0

integer (int32)

controllerSlot
required

Controller number 1 if in top slot. Controller number 2 if in bottom slot.
Example : 0

integer (int32)

tray
required

Tray ID number. This field is not used and is considered deprecated.
Example : 0

integer (int32)

4.383. ParentRelativeLocation

Name Description Schema

componentType
required

The type of component.
Example : "string"

enum (unknown, drive, powerSply, fan, minihub, tempSensor, channel, esm, controller, battery, enclosure, ups, chip, volume, volumeGrp, portCru, interconnectCru, supportCru, alarm, channelPort, sfpPort, hostBoard, newFormat, ctlrSfp, ctlrSoc, initiator, target, isnsServer, hostIoCard, cacheBackupDevice, cacheMemDimm, host, hostPort, drawer, relative, schedule, asyncMirrorGroup, diskPool, pit, pitConsistencyGroup, cgpit, cgview, flashCache, snmpCommunity, snmpTrapDestination, fcTarget, blankOne, blankTwo, fanOnlyCru, psuCru, nvmeInitiator, __UNDEFINED)

relativePosition
required

The relative position within the component’s parent.
Example : 0

integer (int32)

4.384. SocLocation

Name Description Schema

channelType
required

The channel type.
Example : "string"

enum (hostside, driveside, management, __UNDEFINED)

channel
required

The channel type.
Example : 0

integer (int32)

soc
required

The SOC index, 0-based.
Example : 0

integer (int32)

port
required

The port number, 1-based
Example : 0

integer (int32)

controllerSlot
required

The controller slot number, 1 or 2
Example : 0

integer (int32)

4.385. TargetLocation

Name Description Schema

targetName
required

The iSCSI node name of the target, left-truncated if necessary. (Left-truncation preserves the part of the name most likely to vary.)
Example : "string"

string

4.386. TraySlot

Name Description Schema

tray
required

The tray ID of the tray in which the component resides. Note that a Tray ID of -1 means "the controller tray."
Example : 0

integer (int32)

slot
required

The slot number, or ordinal identifier, of the component within its tray.
Example : 0

integer (int32)

4.387. MelExtent

Name Description Schema

startingSeqNum
required

This is the sequence number of the entry at the low end of the extent. So, when this value is returned in getMelExtents, it is the sequence number of the first MEL event that can be returned in getMelEntries. When specified as an input to getMelEntries, it is the sequence number of the first MEL event to be returned.
Example : "string"

string (int64)

endingSeqNum
required

When this value is returned by getMelExtents, it is the sequence number that is one beyond the entry at the high end of the extent. For example, if the ending sequence number is 3232, then MEL entries up to sequence 3231 are retrievable. When this value is input to getMelEntries, it is the sequence number of the last MEL event to be returned.
Example : "string"

string (int64)

4.388. CommandProtocolPropertiesList

Name Description Schema

commandProtocolProperties
required

This describes a list of command protocol properties.
Example : [ "CommandProtocolProperties" ]

< CommandProtocolProperties > array

4.389. IoInterface

Name Description Schema

interfaceRef
required

The SYMbol array-wide unique name for the interface object.
Example : "string"

string

channelType
required

The type of channel (e.g., host-side, drive-side) that the interface is associated with.
Example : "string"

enum (hostside, driveside, management, __UNDEFINED)

ioInterfaceTypeData
required

A field whose contents vary depending on the I/O protocol type of the interface.
Example : "IOInterfaceTypeData"

IOInterfaceTypeData

controllerRef
required

Uniquely identifies a particular physical RAID controller within the storage array.
Example : "string"

string

commandProtocolPropertiesList
required

The list of properties that describe the command protocol.
Example : "CommandProtocolPropertiesList"

CommandProtocolPropertiesList

4.390. NVMeoFEntityUpdateRequest

Name Description Schema

nvmeInterface
required

Reference for the interface.
Example : "string"

string

ipv4Address
required

List of IPv4 addresses associated with the NVMe over Fabrics host interface.
Example : [ "string" ]

< string > array

4.391. AccessVolume

Name Description Schema

enabled
required

True if the access volume feature (and thus the UTM command transfer capability) is enabled, or false if it is disabled.
Example : true

boolean

volumeHandle
required

An identifier value for the AccessVolume object. This will generally correspond to the logical unit number (LUN) that is used to access the volume for UTM protocol command transactions.
Example : 0

integer (int32)

capacity
required

The (simulated) capacity of the AccessVolume maintained by the controller. Since there is essentially no true data storage capacity present for an AccessVolume, this value is used to determine the block addressing limit of the unit, which is an important aspect of the UTM command transfer protocol.
Example : "string"

string (int64)

accessVolumeRef
required

The identifier value for this AccessVolume. Other objects may use this reference value to refer to the AccessVolume.
Example : "string"

string

reserved1
optional

Example : "string"

string

4.392. Alarm

Name Description Schema

alarmRef
required

The reference for this physical alarm.
Example : "string"

string

physicalLocation
required

The location of the alarm. The parent reference in Location identifies the tray containing the alarm, and the position field is set to 1.
Example : "Location"

Location

status
required

The operational status of the alarm.
Example : "string"

enum (unknown, enabled, disabled, sounding, muted, removed, __UNDEFINED)

isManageable
required

True if the alarm is manageable using the setAlarm procedure.
Example : true

boolean

rtrAttributes
required

The CRU type of the alarm plus its ready-to-remove attributes, which are based on the CRU type
Example : "RTRAttributes"

RTRAttributes

repairPolicy
required

The repair policy for the alarm component.
Example : "RepairPolicy"

RepairPolicy

4.393. ApplicationAwarenessBundle

Name Description Schema

keyValueTag
required

This is an array of elements that report the a key-value tag and its reference.
Example : [ "KeyValueTag" ]

< KeyValueTag > array

keyValueTagMapping
required

This element is an array of the mappings (using references) between a key-value tag and a volume.
Example : [ "KeyValueTagMapping" ]

< KeyValueTagMapping > array

workload
required

This is an array of elements that reports Workload references.
Example : [ "Workload" ]

< Workload > array

workloadVolumeMapping
required

This is an array of elements that report the mapping between workloads and volumes.
Example : [ "WorkloadVolumeMapping" ]

< WorkloadVolumeMapping > array

4.394. AsyncMirrorGroup

Name Description Schema

groupRef
required

The reference (key) for the mirror group.
Example : "string"

string

worldWideName
required

The world wide name of the mirror group. This can be used to identify the AMG pair on both arrays. The AsyncMirrorGroupRef is not guaranteed to be unique across multiple arrays.
Example : "string"

string

label
required

The user assigned name for the mirror group.
Example : "string"

string

groupState
required

The Mirror Group State. This is determined primarily by the presence or lack of a recovery point.
Example : "string"

enum (unknown, initialSync, optimal, degraded, rpFailed, __UNDEFINED)

localRole
required

The current role of this (local) array with respect to this mirror group.
Example : "string"

enum (unknown, primary, secondary, __UNDEFINED)

remoteRole
required

The current role of the peer (remote) array with respect to this mirror group.
Example : "string"

enum (unknown, primary, secondary, __UNDEFINED)

roleChangeProgress
required

This field indicates the current state of the role change process. This may be an extended condition due to the data sync needed for an orderly role change or the recovery point rollback needed for a no-sync or forced role change.
Example : "string"

enum (unknown, none, pending, inProgress, __UNDEFINED)

syncIntervalMinutes
required

The time in minutes between starting points of periodic synchronization intervals. A value of ARVM_MANUAL_SYNC_INTERVAL indicates synchronization intervals are manually started by the user.
Example : 0

integer (int32)

syncCompletionTimeAlertThresholdMinutes
required

The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete. A value of ARVM_SYNC_COMPLETION_TIME_THRESHOLD_NONE indicates no threshold is set.
Example : 0

integer (int32)

recoveryPointAgeAlertThresholdMinutes
required

The recovery point age objective (in minutes). The user is notified via needs-attention when the age of the last good recovery point exceeds this value. A value of ARVM_RECOVERY_POINT_AGE_THRESHOLD_NONE indicates no threshold is set.
Example : 0

integer (int32)

repositoryUtilizationWarnThreshold
required

The repository utilization warning threshold (0-100 percent). A needs attention condition will be generated if the percent of the repository capacity currently utilized exceeds this threshold.
Example : 0

integer (int32)

mirrorChannelRemoteTarget
required

The path to the remote array to be used by this AMG (a reference to the associated RemoteTarget).
Example : "string"

string

syncActivity
required

Current synchronization activity.
Example : "string"

enum (unknown, idle, active, paused, userSuspended, internallySuspended, __UNDEFINED)

orphanGroup
required

If true, the mirror group is an orphan.
Example : true

boolean

4.395. AsyncMirrorGroupIncompleteMember

Name Description Schema

memberRef
required

The reference (key) for the group member.
Example : "string"

string

groupRef
required

The associated Async Mirror Group.
Example : "string"

string

primaryVolWWN
required

The WWN of the primary volume on the remote array.
Example : "string"

string

primaryVolCapacity
required

Capacity of the primary (used to aid in selection of mirror secondary volume).
Example : "string"

string (int64)

primaryVolRAIDLevel
required

RAID level of the primary volume.
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

primaryVolProtectionType
required

The protection type of the primary volume.
Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

primaryVolSecurityType
required

Security type of the primary volume.
Example : "string"

enum (unknown, none, capable, enabled, __UNDEFINED)

primaryVolUserLabel
required

User label of the primary volume.
Example : "string"

string

orphanIncompleteMember
required

If true, the incomplete member is an orphan.
Example : true

boolean

primaryVolumeParameters
required

The capacity provisioning parameters for the primary volume.
Example : "VolumeTypeParameters"

VolumeTypeParameters

primaryVolSecurityLevel
required

Refines the information in the securityType field to describe the set of drives.
Example : "string"

enum (unknown, none, mixed, fde, fips, __UNDEFINED)

4.396. AsyncMirrorGroupMember

Name Description Schema

memberRef
required

The reference (key) for the group member.
Example : "string"

string

mirrorGroup
required

The AMG with which this member is associated.
Example : "string"

string

localVolume
required

The local volume for this mirror. This is the volume being mirrored if the AMG role is primary, otherwise this is the target of mirror synchronization.
Example : "string"

string

remoteVolume
required

The remote volume. This is the target of mirror synchronization on the remote array if the AMG role is primary, otherwise this is the volume on the remote array that is being mirrored.
Example : "string"

string

memberState
required

The state of this mirror relationship (as known by this array).
Example : "string"

enum (unknown, initialSync, optimal, failed, incomplete, orphan, stopped, __UNDEFINED)

lastRecoveryPointTime
required

The timestamp, represented in seconds since midnight GMT on January 1, 1970, of the last recovery point PiT on secondary. If no recovery point image exists, the value of this field will be ARVM_NO_RECOVERY_POINT_TIMESTAMP.
Example : "string"

string (int64)

overUtilizationWarnThreshold
required

If true, the repository capacity utilized is over the warning threshold.
Example : true

boolean

mirroredLocalCapacity
required

The current local volume capacity that is being mirrored. This will be less than the actual local volume capacity if we have not yet reached a point where the next PiT can be taken and delta-logs resized (and until that point the expanded local capacity will not be opened up to host writes).
Example : "string"

string (int64)

repositoryVolume
required

The metadata volume (Copy-on-Write / DeltaLog Repository) for this mirror.
Example : "string"

string

worldWideName
required

The WWN of the async mirror proxy.
Example : "string"

string

volumeHandle
required

The SSID of the async mirror proxy.
Example : 0

integer (int32)

repositoryFull
required

If true, the repository is full (100% of available capacity utilized).
Example : true

boolean

id
optional

Example : "string"

string

4.397. Battery

Name Description Schema

batteryRef
required

The reference for this battery.
Example : "string"

string

status
required

The operational status of the battery.
Example : "string"

enum (optimal, fullCharging, nearExpiration, failed, removed, unknown, notInConfig, configMismatch, learning, overtemp, expired, maintenanceCharging, replacementRequired, __UNDEFINED)

physicalLocation
required

The physical location of the battery. The parent reference in Location identifies the CRU that physically houses the battery, and the position field is the parent-relative/like-component relative slot number of the battery, starting at one.
Example : "Location"

Location

batteryAge
required

Current battery age, in days.
Example : 0

integer (int32)

batteryLifeRemaining
required

Days of battery life remaining. A value of -1 indicates that the battery life expiration age has been set to 0xFF in NVSRAM, disabling cache battery expiration event notification.
Example : 0

integer (int32)

batteryTypeData
required

Used to determine the scope of the battery.
Example : "BatteryTypeData"

BatteryTypeData

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

manufacturerDate
required

VPD manufacture date.
Example : "string"

string (int64)

vendorName
required

VPD vendor name.
Example : "string"

string

vendorPN
required

VPD part number.
Example : "string"

string

vendorSN
required

VPD serial number.
Example : "string"

string

fruType
required

VPD field replaceable unit type.
Example : "string"

string

rtrAttributes
required

The CRU type of the battery plus its ready-to-remove attributes, which are based on the CRU type.
Example : "RTRAttributes"

RTRAttributes

repairPolicy
required

The repair policy for the battery component.
Example : "RepairPolicy"

RepairPolicy

batteryCanExpire
required

This boolean field is set to true when cache battery expired event notification is enabled.
Example : true

boolean

automaticAgeReset
required

This boolean field is set to true when the batteryCanExpire field in this structure is set to false and when the controller tracks the battery serial number.
Example : true

boolean

learnCycleData
required

Contains details about the learn cycle for this battery
Example : "SmartBatteryData"

SmartBatteryData

id
optional

Example : "string"

string

4.398. BundledFeature

Name Description Schema

featureId
required

This field indicate what feature this instance of BundledFeature represents.
Example : "string"

enum (volumesPerPartition, totalNumberOfVolumes, storagePartitions, snapshot, volumeCopy, remoteMirroring, driveTrayExpansion, mixedDriveTypes, mgmtApplication, supportedDrives, supportedDriveTrays, performanceTier, totalNumberOfSnapshots, totalNumberOfVolCopies, goldKey, snapshotsPerVolume, totalNumberOfMirrors, raid6, stateCapture, sataStrLen, secureVolume, protectionInformation, solidStateDisk, driveSlotLimit, fdeProxyKeyManagement, supportedInterposer, vendorSupportedDrives, flashReadCache, totalNumberOfAsyncMirrorGroups, totalNumberOfAsyncMirrorsPerGroup, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, pitGroupsPerVolume, totalNumberOfPitGroups, pitsPerPitGroup, memberVolsPerPitConsistencyGroup, totalNumberOfPitConsistencyGroups, totalNumberOfPitViews, totalNumberOfThinVolumesPerArray, nativeSataDriveSupport, solidStateDiskLimit, totalNumberOfRemoteMirrorsPerArray, asup, ectSelector, embeddedSnmpOid, asupOnDemand, dacstoreCompatId, samoaHicProtocol, targetPortLunMapping, hildaBaseboardProtocol, denali2Protocol, __UNDEFINED)

featureAttribute
required

This field is a variable-length array of FeatureAttribute instances representing the attributes that apply for this particular feature.
Example : [ "FeatureAttribute" ]

< FeatureAttribute > array

4.399. CertificateRevocationSettings

Name Description Schema

certificateRevocationCheckEnabled
required

Used to determine if certificate revocation checking is enabled.
Example : true

boolean

ocspResponderAddress
required

If set this will over-ride the OCSP (On-line Certificate Status Protocol) responder address found in the certificate.
Example : "string"

string

isOCSPResponderAddressSet
required

True if the OCSP (On-line Certificate Status Protocol) server address is set; otherwise false.
Example : true

boolean

4.400. Cluster

Name Description Schema

clusterRef
required

The unique identification value for this object. Other objects may use this reference value to refer to the cluster.
Example : "string"

string

label
required

The user-assigned, descriptive label string for the cluster.
Example : "string"

string

isSAControlled
required

If true, indicates that I/O accesses from this cluster are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the cluster are subject to cluster-specific LUN-to-volume mappings.
Example : true

boolean

confirmLUNMappingCreation
required

If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other clusters, in addition to this one.
Example : true

boolean

protectionInformationCapableAccessMethod
required

This field is true if the host has a PI capable access method.
Example : true

boolean

isLun0Restricted
required

Provides an indication as to whether LUN 0 is restricted (i.e., disallowed) for the associated cluster.
Example : true

boolean

name
optional

Example : "string"

string

id
optional

Example : "string"

string

4.401. CompatibleFirmware

Name Description Schema

fwVersion
required

A firmware package version identifier, which may or may not contain bytes with a value of FW_VERSION_WILDCARD.
Example : "string"

string

compatible
required

A true value indicates that any firmware version that matches the one specified in this structure is compatible with the currently-installed storage array firmware. A false value indicates that matching firmware versions are NOT compatible.
Example : true

boolean

4.402. ComponentBundle

Name Description Schema

fan
required

The fan component.
Example : [ "Fan" ]

< Fan > array

battery
required

The battery component.
Example : [ "Battery" ]

< Battery > array

powerSupply
required

The power supply component.
Example : [ "PowerSupply" ]

< PowerSupply > array

thermalSensor
required

The thermal sensor component.
Example : [ "ThermalSensor" ]

< ThermalSensor > array

esm
required

The ESM component.
Example : [ "Esm" ]

< Esm > array

ups
required

The UPS component.
Example : [ "Ups" ]

< Ups > array

minihub
required

The minihub component.
Example : [ "Minihub" ]

< Minihub > array

gbic
required

The GBIC component.
Example : [ "Gbic" ]

< Gbic > array

sfp
required

The SFP component.
Example : [ "Sfp" ]

< Sfp > array

interconnectCRU
required

The interconnect CRU.
Example : [ "InterconnectCRU" ]

< InterconnectCRU > array

supportCRU
required

The Support CRU.
Example : [ "SupportCRU" ]

< SupportCRU > array

alarm
required

The alarm.
Example : [ "Alarm" ]

< Alarm > array

hostBoard
required

The host board.
Example : [ "HostBoard" ]

< HostBoard > array

sasExpander
required

The SAS expanders.
Example : [ "SasExpander" ]

< SasExpander > array

cacheBackupDevice
required

The cache backup devices.
Example : [ "CacheBackupDevice" ]

< CacheBackupDevice > array

cacheMemoryDimm
required

List of field replaceable cache memory DIMM modules.
Example : [ "CacheMemoryDimm" ]

< CacheMemoryDimm > array

processorMemoryDimm
required

List of field replaceable processor memory DIMMs.
Example : [ "ProcessorMemoryDimm" ]

< ProcessorMemoryDimm > array

drawer
required

List of drawers.
Example : [ "Drawer" ]

< Drawer > array

4.403. ConcatVolume

Name Description Schema

concatVolRef
required

A reference (key) for ConcatVolume.
Example : "string"

string

status
required

The status/state of the concatenated volume. This will be the worst status among the member volumes.
Example : "string"

enum (unknown, optimal, degraded, failed, __UNDEFINED)

memberCount
required

The number of actual storage volumes comprising this volume. Note that this is just for convenience, this information can be derived from member objects.
Example : 0

integer (int32)

aggregateCapacity
required

The aggregate capacity in bytes of all member volumes.
Example : "string"

string (int64)

mediaScanParams
required

Media scan parameters.
Example : "VolumeMediaScanParams"

VolumeMediaScanParams

volumeHandle
required

The volume ssid. This is provided primarily for debug purposes.
Example : 0

integer (int32)

allowedOperations
required

Operations allowed on the ConcatVolume. This can be used if ConcatVolume is ever exposed as a host-addressable volume to specify whether the volume is host-mappable or not (repository volumes would never be mappable).
Example : "VolumePerms"

VolumePerms

id
optional

Example : "string"

string

4.404. ConcatVolumeMember

Name Description Schema

memberRef
required

A reference (key) for ConcatVolumeMember.
Example : "string"

string

concatVolRef
required

A reference to the parent ConcatVolume.
Example : "string"

string

storageVolumeRef
required

A reference to the member RAID volume providing storage capacity.
Example : "string"

string

parentIndex
required

The index (order) of the member in the aggregated parent volume capacity.
Example : 0

integer (int32)

4.405. ConsistencyGroup

Name Description Schema

groupRef
required

The consistency group reference.
Example : "string"

string

4.406. ConsistencyGroupBundle

Name Description Schema

consistencyGroup
required

Bundle of information about the write order consistency group objects.
Example : [ "ConsistencyGroup" ]

< ConsistencyGroup > array

4.407. ControllerGBIC

Name Description Schema

controllerGBICType
required

Interface (host/drive) to which the GBIC belongs.
Example : "string"

enum (hostside, driveside, __UNDEFINED)

parentController
required

Information on the controller associated with the GBIC.
Example : "string"

string

channel
required

The channel number that this GBIC is associated with.
Example : 0

integer (int32)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

4.408. DVEVolume

Name Description Schema

volume
required

The reference to the volume.
Example : "string"

string

amountOfIncrease
required

The amount of capacity increase for the volume.
Example : "string"

string (int64)

4.409. DailySchedule

Name Description Schema

timeOfDay
required

The number of seconds after midnight local time for the first occurrence during the day.
Example : 0

integer (int32)

everyNMinutes
required

Interval between schedules if timesPerDay is greater than 1.
Example : 0

integer (int32)

timesPerDay
required

The number of occurrences during the day based on everyNMinutes, including the first occurrence.
Example : 0

integer (int32)

4.410. DaylightSavingsTime

Name Description Schema

time
required

Time of day for DST change measured as seconds past midnight.
Example : 0

integer (int32)

clockMode
required

Reference for time.
Example : "string"

enum (unknown, wallClockTime, standardTime, utcTime, __UNDEFINED)

month
required

Month value: 0 to 12 (and negatives).
Example : 0

integer (int32)

dayOfMonth
required

Day of month: 0 to 31 (and negatives).
Example : 0

integer (int32)

dayOfWeek
required

Day of week: 0 to 7 (and negatives).
Example : 0

integer (int32)

4.411. DiskPoolData

Name Description Schema

reconstructionReservedDriveCount
required

The number of drives reserved for reconstruction of failed drives.
Example : 0

integer (int32)

reconstructionReservedAmt
required

The pool capacity reserved to hold rebuild data (in bytes). This value is calculated from the reconstructionReservedDriveCount.
Example : "string"

string (int64)

reconstructionReservedDriveCountCurrent
required

The reserved capacity that is currently available to hold rebuilt data (dynamic). If all of the reserved capacity is available, then this value will equal the reconstructionReservedDriveCount.
Example : 0

integer (int32)

poolUtilizationWarningThreshold
required

The pool utilization warning threshold as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity.
Example : 0

integer (int32)

poolUtilizationCriticalThreshold
required

The pool utilization critical threshold as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity.
Example : 0

integer (int32)

poolUtilizationState
required

The Disk pool state set based on state of the threshold.
Example : "string"

enum (utilizationInvalid, utilizationOptimal, utilizationWarning, utilizationCritical, capacityDepleted, __UNDEFINED)

unusableCapacity
required

This value identifies how much capacity (in bytes) is being wasted due to a mix of drive sizes. This value will be zero as long as the pool consists of like drive sizes.
Example : "string"

string (int64)

degradedReconstructPriority
required

One failed drive degraded reconstruction priority.
Example : "string"

enum (invalid, lowest, low, medium, high, highest, useDefault, __UNDEFINED)

criticalReconstructPriority
required

Two failed drive reconstruction critical priority.
Example : "string"

enum (invalid, lowest, low, medium, high, highest, useDefault, __UNDEFINED)

backgroundOperationPriority
required

Priority of other background operations (DVE,DCE,DCR, and IAF).
Example : "string"

enum (invalid, lowest, low, medium, high, highest, useDefault, __UNDEFINED)

allocGranularity
required

The allocation granularity (in bytes) for volumes in a disk pool.
Example : "string"

string (int64)

minimumDriveCount
required

Minimum number of drives required for this disk pool
Example : 0

integer (int32)

4.412. Drive

Name Description Schema

offline
required

True if the drive is in the offline state, false otherwise. This field is valid for missing drives.
Example : true

boolean

hotSpare
required

True if the drive has been designated as a hot spare; false otherwise. This field is valid for missing drives.
Example : true

boolean

invalidDriveData
required

True if no drive information (serial #, capacity, etc.) can be obtained. This field is always true for missing drives.
Example : true

boolean

available
required

True if the drive is available for use in creating a new volume group; false otherwise. This field is valid for missing drives.
Example : true

boolean

pfa
required

True if the drive is drive Predicted Failure analysis predicts a drive failure. This field is valid for missing drives.
Example : true

boolean

driveRef
required

The identifier value for this drive. Other objects may use this reference value to refer to the drive. This field is valid for missing drives.
Example : "string"

string

status
required

An indication of the current status of the drive. This field is valid for missing drives.
Example : "string"

enum (optimal, failed, replaced, bypassed, unresponsive, removed, incompatible, dataRelocation, preFailCopy, preFailCopyPending, __UNDEFINED)

cause
required

An indication of the reason for the current status of the drive. This field is most useful when the current status is something other than optimal; it identifies the event that caused the status to change to its current value. This field is valid for missing drives.
Example : "string"

enum (none, userOp, writeOp, uncertified, speedMismatch, bypassUnknown, wrongDriveType, incompatibleUprevDacstore, incompatibleDownrevDacstore, incompatibleInternalError, incompatibleSectorSizeMismatch, incompatibleNativeVgRefersToForeignDrive, incompatibleForeignVgRefersToNativeDrive, incompatibleNativeVgForeignDriveMutualRef, incompatibleVgCloned, incompatibleForeignDriveInconsistent, incompatibleVgHasDrivePartOfMultipleVgs, incompatibleForeignDriveHasInconsistentRole, incompatibleVgDrivePartOfMultipleVgs, incompatibleFailedLegacyDrive, incompatibleDdfOtherVendor, incompatibleDbAdoptionFailure, locked, insufficientDriveCapacity, supercapacitorFailure, unsupportedProtocolConnection, unsupportedCapacity, invalidLockKeyPresented, incompatiblePiType, incompatibleDatabaseValidationFailure, incompatibleUnsupportedInterposerFwVersion, incompatibleSataDriveSctUnsupported, incompatibleModelNumberUnsupported, incompatibleAlignmentForEmulationDrive, srcRelocation, dstRelocation, incompatibleDriveMetadataUnusable, pfa, spfa, __UNDEFINED)

interfaceType
required

Information about the I/O interface between the controller and the drive. For example, for a SCSI-attached drive, this field will contain information about the drive’s channel and SCSI ID values. For other interface types, different data will be available in this field.
Example : "DriveTypeData"

DriveTypeData

physicalLocation
required

The physical location of the drive. Beginning with the Allegheny release, the parent reference in Location identifies the tray or drawer containing the drive, and the position field is the parent-relative/like-component relative slot number of the drive, starting at 1. For missing drives this field contains the last known location.
Example : "Location"

Location

manufacturer
required

The variable-length ASCII text string that identifies the drive manufacturer. Note that this information is not returned for most Serial ATA (SATA) drives.
Example : "string"

string

manufacturerDate
required

The date of manufacture of the drive, represented in seconds since midnight GMT on January 1, 1970. Note that this information is not returned for most Serial ATA (SATA) drives.
Example : "string"

string (int64)

productID
required

The variable-length ASCII text string that identifies the product by name, as assigned by the manufacturer.
Example : "string"

string

serialNumber
required

The variable-length ASCII text string for the serial number of the drive.
Example : "string"

string

softwareVersion
required

This data is a variable-length ASCII text string. If an interposer is present in front of SATA drives, the string identifies the version of the interposer package. In this case, the SATA drive firmware version can be found in the physicalDriveTypeData field. If an interposer is not present (always the case for Fibre Channel drives) this field describes the drive firmware version.
Example : "string"

string

blkSize
required

The block (i.e. sector) size used by the drive, represented in bytes. This field is valid for missing drives.
Example : 0

integer (int32)

usableCapacity
required

The usable capacity of the drive, in bytes, after accounting for any space that is reserved for use by the array controller for overhead information. This field is valid for missing drives.
Example : "string"

string (int64)

rawCapacity
required

The raw capacity of the drive, in bytes. This field is valid for missing drives.
Example : "string"

string (int64)

worldWideName
required

A variable-length, opaque field that contains the drive’s world-wide name, or globally unique identifier value. This field is valid for missing drives.
Example : "string"

string

currentVolumeGroupRef
required

The reference value of the volume group, disk pool, or flash cache to which this drive is currently assigned. If a hot spare drive is actively sparing for a failed drive, this field will identify the volume group, disk pool, or flash cache that is using the hot spare drive. If the drive is not currently assigned, or is an idle hot spare, the reference value will be null. This field is valid for missing drives.
Example : "string"

string

sparedForDriveRef
required

The reference value of the drive for which this drive is acting as a hot spare. This field is only used if the Drive object represents a global hot spare that is actively sparing for a failed drive. This field is valid for missing drives.
Example : "string"

string

mirrorDrive
required

This field is only used if the Drive object represents a drive that is part of a RAID-1 volume group. It identifies the drive that is tied to this one for RAID-1 mirroring operations. This field is valid for missing drives.
Example : "string"

string

nonRedundantAccess
required

True if the drive does not have redundant access.
Example : true

boolean

workingChannel
required

The channel to the tray that is still operational (if nonRedundantAccess is True).
Example : 0

integer (int32)

volumeGroupIndex
required

The volume group index. This is the zero-relative position of the drive with respect to the stripe-ordering for the volume group. A value of -1 indicates that the drive does not belong to any group. This field is valid for missing drives.
Example : 0

integer (int32)

currentSpeed
required

The speed of the drive. Will be unknown for a SCSI drive.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maxSpeed
required

The maximum speed of the drive. Currently not used.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

uncertified
required

True, if the drive has the DR_UNCERTIFIED flag set. This field is valid for missing drives.
Example : true

boolean

hasDegradedChannel
required

True, if a path to this drive is degraded.
Example : true

boolean

degradedChannels
required

The IDs of degraded channels.
Example : [ 0 ]

< integer (int32) > array

phyDriveType
required

The physical drive type.
Example : "string"

enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED)

spindleSpeed
required

The drive reported spindle speed. Solid State Disk (SSD) drives report zero.
Example : 0

integer (int32)

rtrAttributes
required

The CRU type of the drive plus its ready-to-remove attributes, which are based on the CRU type.
Example : "RTRAttributes"

RTRAttributes

reserved
required

reserved.
Example : "string"

string

phyDriveTypeData
required

Information specific to a physical drive type.
Example : "PhysicalDriveTypeData"

PhysicalDriveTypeData

pfaReason
required

The reason a PFA condition has been raised for this drive.
Example : "string"

enum (unknown, none, driveReported, synthesized, ssdEndOfLife, __UNDEFINED)

bypassSource
required

A list of object references where each reference identifies the source of a drive bypass condition. Possible referenced objects include the drive itself, a controller, or the ESM(s). When the bypass source is a controller or the drive, the list will typically hold just one reference; when the bypass source is the ESM(s), the list can hold up to two references, indicating either one or both ESMs. The list normally holds valid data whenever the drive is in the bypassed state (DRIVE_STAT_BYPASSED) , however it may be empty if the source of the bypass is unknown. It is also possible for the list to hold valid data when the drive is optimal, if only one ESM has bypassed the drive.
Example : [ "ObjectReference" ]

< ObjectReference > array

repairPolicy
required

This field contains the repair policy for the Drive.
Example : "RepairPolicy"

RepairPolicy

fdeCapable
required

True if the drive supports FDE, false otherwise
Example : true

boolean

fdeEnabled
required

true if drive security is enabled; false if disabled
Example : true

boolean

fdeLocked
required

True if the drive is locked, false if the drive is unlocked
Example : true

boolean

lockKeyID
required

The lock key ID as read from the drive.
Example : "string"

string

ssdWearLife
required

Contains wear life data for the SSD drive.
Example : "SSDWearLife"

SSDWearLife

driveMediaType
required

This field is set to the drive media type of the drive.
Example : "string"

enum (all, unknown, hdd, ssd, __UNDEFINED)

fpgaVersion
required

This data is a variable-length ASCII text string that identifies the version of the FPGA package.
Example : "string"

string

protectionInformationCapabilities
required

This structure contains a protectionInformationCapable field which is set to true when the drive is formatted to support type 2 protection with a 512-byte logical block size, or if the drive is a type 0 drive formatted with a 520-byte logical block size. It also contains a field that is set to the protection type provided for the drive.
Example : "ProtectionInformationCapabilities"

ProtectionInformationCapabilities

protectionInformationCapable
required

Field is no longer used.
Example : true

boolean

protectionType
required

Field is no longer used.
Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

interposerPresent
required

A value of true for this property means the drive is behind an interposer.
Example : true

boolean

interposerRef
required

The drive interposer identifier. This field is valid only if the interposerPresent field is set to True.
Example : "string"

string

currentCommandAgingTimeout
required

The current command aging timeout value in hundreds of milliseconds. If this value is 0 the default command aging timeout value will be used, otherwise this value overrides the default value.
Example : 0

integer (int32)

defaultCommandAgingTimeout
required

The default command aging timeout value in hundreds of milliseconds as specified by the drive. If this value is 0, the drive command aging timeout cannot be changed.
Example : 0

integer (int32)

driveTemperature
required

Drive temperature data.
Example : "DriveTemperature"

DriveTemperature

blkSizePhysical
required

The physical block (i.e., sector) size for the drive, represented in bytes. This field is valid for missing drives.
Example : 0

integer (int32)

lowestAlignedLBA
required

The lowest aligned LBA for the physical sector. Typically this will be 0, but could be non-zero for emulation drives where LBA 0 starts at some logical sector offset within the physical sector.
Example : "string"

string (int64)

removed
required

True if the drive is in the process of being removed from the volume group. Only applies to Disk Pools
Example : true

boolean

locateInProgress
required

Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the drive.
Example : true

boolean

fipsCapable
required

This flag is true if the drive supports FIPS (Federal Information Processing Standard). FIPS 140-2 specification.
Example : true

boolean

id
optional

Example : "string"

string

4.413. DriveChannel

Name Description Schema

channel
required

The channel number.
Example : 0

integer (int32)

state
required

The operational state of the channel.
Example : "string"

enum (optimal, degraded, hwFailed, __UNDEFINED)

reason
required

The reason the channel was degraded.
Example : "string"

enum (none, thresholdExceeded, adminRequest, socNotOperational, socEepromFailure, clearHwFailure, controllerAction, __UNDEFINED)

degradingController
required

If auto degraded, the degraded controller.
Example : "string"

string

statsControllerA
required

The statistics for Controller A.
Example : "DriveChannelStatistics"

DriveChannelStatistics

statsControllerB
required

The statistics for Controller B.
Example : "DriveChannelStatistics"

DriveChannelStatistics

4.414. DriveChannelErrorCounts

Name Description Schema

nonChannelErrors
required

The number of non channel errors.
Example : 0

integer (int32)

timeoutErrors
required

The number of timeout errors.
Example : 0

integer (int32)

controllerDetectedErrors
required

The number of controller detected errors.
Example : 0

integer (int32)

driveDetectedErrors
required

The number of drive detected errors.
Example : 0

integer (int32)

linkDownErrors
required

The number of link down errors.
Example : 0

integer (int32)

4.415. DriveChannelParent

Name Description Schema

driveChannelParent
required

This enumeration object is used to specify the Drive Channel parent.
Example : "string"

enum (parentUnknown, minihub, controller, __UNDEFINED)

controllerRef
optional

This field is present only if the DriveChannelParentType is CONTROLLER.
Example : "string"

string

minihubRef
optional

This field is present only if the DriveChanelParentType is MINIHUB.
Example : "string"

string

4.416. DriveChannelPort

Name Description Schema

portRef
required

A reference to the drive channel port.
Example : "string"

string

channel
required

The Fibre Channel number of the port.
Example : 0

integer (int32)

portType
required

The type of port (XBB/expansion/internal).
Example : "string"

enum (portUnknown, port1, port2, port3, port4, port12, port34, port7, minihubInout, expansionOnly, expansionAndInternal, __UNDEFINED)

parentType
required

The parent type (minihub/controller).
Example : "DriveChannelParent"

DriveChannelParent

4.417. DriveChannelStatistics

Name Description Schema

startTimeStamp
required

The time stamp of when the error tracking began.
Example : "string"

string (int64)

endTimeStamp
required

The time stamp of when the error tracking ended.
Example : "string"

string (int64)

totalIoCount
required

The total number of I/Os.
Example : 0

integer (int32)

totalIoErrorCount
required

The total number of I/O errors.
Example : 0

integer (int32)

linkStatus
required

The status of the link - up, down, failed
Example : "string"

enum (none, up, down, failed, __UNDEFINED)

errorCounts
required

The error category counts.
Example : "DriveChannelErrorCounts"

DriveChannelErrorCounts

4.418. EmbeddedExternalKMSInformation

Name Description Schema

installedKMSCertificateFile
required

The list of KMS Certificate Files currently installed on the storage array. Only one certificate of each type can ever be installed at a time although not necessarily each possible type will be installed. The specific certificates that need to be installed will depend on the KMIP server, how it is configured, and the CA used to sign certificates. The signed client certificate will always be necessary.
Example : [ "string" ]

< enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED) > array

kmsEndpoint
required

The external key management server endpoint information.
Example : "ExternalKMSEndpoint"

ExternalKMSEndpoint

4.419. ExtendedSAData

Name Description Schema

reserved1
optional

Example : "string"

string

codeVersions
required

This is a list of versions for the various firmware components (RAID, NVSRAM, hypervisor, ….). The list contains an entry for every code module applicable to the current platform.
Example : [ "VersionDescriptor" ]

< VersionDescriptor > array

4.420. ExternalKMSEndpoint

Name Description Schema

kmsAddress
required

The IP or domain address of the key management server
Example : "NetworkAddress"

NetworkAddress

kmsPort
required

The port number to be used for communicating KMIP requests with the key management server.
Example : 0

integer (int32)

4.421. FeatureAttribute

Name Description Schema

featureAttrId
required

This enumeration identifies the defined feature attributes.
Example : "string"

enum (shippedEnabled, shippedLimit, keyEnabled, keyLimit, supportedValues, subjectToGoldKey, evalDuration, __UNDEFINED)

keyEnabled
optional

The boolean value for a "KEY ENABLED" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_KEY_ENABLED.
Example : true

boolean

keyLimit
optional

The integer value for a "KEY LIMIT" attribute. This field is only present if featureAttrId is equal to FEAUTRE_ATTR_KEY_LIMIT.
Example : 0

integer (int32)

shippedEnabled
optional

The boolean value for a "SHIPPED ENABLED" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_SHIPPED_ENABLED.
Example : true

boolean

shippedLimit
optional

The integer value for a "SHIPPED LIMIT" attribute. This field is only present if featurAttrId is equal to FEATURE_ATTR_SHIPPED_LIMIT.
Example : 0

integer (int32)

subjectToGoldKey
optional

The boolean value for a "SUBJECT_TO_GOLD_KEY" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_SUBJECT_TO_GOLD_KEY.
Example : true

boolean

supportedValues
optional

The set of string values for a "SUPPORTED VALUES" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_SUPPORTED_VALUES.
Example : [ "string" ]

< string > array

evaluationDuration
optional

An unsigned integer representing the number of days for the "EVALUATION DURATION" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_EVAL_DURATION.
Example : 0

integer (int32)

4.422. FeatureBundle

Name Description Schema

name
required

The name of the feature bundle.
Example : "string"

string

bundledFeatures
required

A variable-length collection of BundledFeature instances, one for every feature comprising the bundle.
Example : [ "BundledFeature" ]

< BundledFeature > array

bundleSubmodelId
required

The submodel Identifier associated with the feature bundle.
Example : "string"

string

4.423. FeatureParams

Name Description Schema

maxHotSpares
required

The maximum number of hot spare drives that can be assigned. If the value in this field is '0xFFFFFFFF' it means there is no limit to the number of hot spares.
Example : 0

integer (int32)

cacheBlockSizes
required

A variable-length array in which each element specifies one of the supported cache block sizes that can be set on the controller. Cache block sizes are reported in bytes.
Example : [ 0 ]

< integer (int32) > array

maxDCEDrives
required

The maximum number of drives that can be added, in a given operation, to an existing volume group to expand the capacity of the volume group.
Example : 0

integer (int32)

maxReadAheadMultiplier
required

The maximum multiplier value that can be specified when configuring cache the read-ahead parameter for a volume. (Realize, however, that the volume read-ahead parameter is no longer treated as a quantify, but as a simple on (non-zero) / off (zero) indicator.
Example : 0

integer (int32)

minMediaScanPeriod
required

The minimum supported period over which a complete media scan can be set to occur (measured in days).
Example : 0

integer (int32)

maxMediaScanPeriod
required

The maximum supported period over which a complete media scan can be set to occur (measured in days).
Example : 0

integer (int32)

supportedSegSizes
required

A variable-length array in which each element specifies one of the supported segment size values, in bytes. This array should be consulted prior to attempting to create a volume modify a volume’s segment size via the startVolumeSegmentSizing procedure.
Example : [ 0 ]

< integer (int32) > array

numStandardSegSizes
required

The number of standard segment size values (at beginning of list).
Example : 0

integer (int32)

segTransitions
required

A variable-length array in which each element specifies one of the supported segment size transition options. The user of the SYMbol interface should consult this list to determine a valid new segment size for a volume before attempting to use the startVolumeSegmentSizing procedure.
Example : [ "string" ]

< enum (transitionHalf, transitionDouble, __UNDEFINED) > array

mappableLUNCount
required

The maximum number of LUN addresses that are available for volume mapping operations. The range of supported LUN values is thus 0 through mappableLUNCoun-1.
Example : 0

integer (int32)

maxPartitionCount
required

The number of partitions supported by the controller.
Example : 0

integer (int32)

maxMappingsPerVolume
required

The number of mappings allowed per volume.
Example : 0

integer (int32)

maxVolumes
required

The maximum number of standard volumes allowed per array.
Example : 0

integer (int32)

maxSnapshots
required

The maximum number of snapshot volumes allowed per array.
Example : 0

integer (int32)

maxSnapshotsPerBase
required

The maximum number of snapshots allowed on any given base volume.
Example : 0

integer (int32)

minRepositorySize
required

The minimum size of a repository volume in bytes.
Example : 0

integer (int32)

maxMirrors
required

The maximum number of mirrored volumes allowed per array assuming full size repositories.
Example : 0

integer (int32)

maxVolCopys
required

The maximum number of volume copies allowed per array.
Example : 0

integer (int32)

maxConcurrentBackgroundCopys
required

The maximum number of background copies that can be active at any one time. This maximum number applies to the entire array, not just one controller.
Example : 0

integer (int32)

maxUtmLunValue
required

The maximum value a UTM LUN can be set to.
Example : 0

integer (int32)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

battery_not_in_configuration
required

The NVSRAM setting for optional controller battery.
Example : true

boolean

supportedDriveTypes
required

A list of supported drive types.
Example : [ "string" ]

< enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) > array

currentMaxMirrors
required

The maximum number of mirrored volumes allowed per array for existing repositories.
Example : 0

integer (int32)

maxVolumesPerGroup
required

The maximum number of volumes allowed per volume group.
Example : 0

integer (int32)

maxDriveDownloadFiles
required

The maximum number of drive download files permitted.
Example : 0

integer (int32)

maxMgmtClientRecords
required

The maximum number of records allowed in the client data storage area.
Example : 0

integer (int32)

maxMgmtClientRecordSize
required

The maximum record size of a client data record.
Example : 0

integer (int32)

redundancyMode
required

Indicates whether the system is Simplex or Duplex.
Example : "string"

enum (unknown, duplex, simplex, __UNDEFINED)

maxExpansionDriveTrays
required

The maximum number of expansion drive trays allowed for this storage array.
Example : 0

integer (int32)

supportedAuthMethods
required

The iSCSI authentication methods supported by the storage array.
Example : [ "string" ]

< enum (none, chap, __UNDEFINED) > array

maxIscsiIpv6LocalAddressesPerPort
required

Max number of iSCSI IPV6 local addresses
Example : 0

integer (int32)

maxIscsiIpv6RoutableAddressesPerPort
required

Max number of iSCSI IPV6 routable addresses
Example : 0

integer (int32)

absoluteMaxDssSegmentSize
required

The global upper bound, expressed in bytes, on the new segment size that may be requested on the startVolumeSegmentSizing procedure.
Example : 0

integer (int32)

smartBatteryTechnology
required

This field is set to true if the storage array uses smart battery technology, and false otherwise.
Example : true

boolean

writeCachingEnabledDuringLearnCycle
required

This field, which is only applicable if smartBatteryTechnology is true, is set to true if the charge level on a smart battery unit is expected to remain above the minimum level needed to support write caching.
Example : true

boolean

maxSSDsSupported
required

The maximum number of SSDs supported on the array. If SSDs are not supported this value is 0.
Example : 0

integer (int32)

ssdInterfaceTypeMixingSupported
required

True if different SSD interface types (e.g. Fibre Channel, SAS) can be used in the same volume group.
Example : true

boolean

maxDriveSlots
required

The maximum number of drive slots supported on the array.
Example : 0

integer (int32)

supportedProtectionTypes
required

The protection types supported by the storage array.
Example : [ "string" ]

< enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) > array

supportedEventPriorities
required

An array listing the MEL event priorities that are configured for use in the current controller firmware build.
Example : [ "string" ]

< enum (priorityDefault, priorityCritical, priorityInfo, priorityEmergency, priorityAlert, priorityError, priorityWarning, priorityNotice, priorityDebug, __UNDEFINED) > array

maxFlashCacheSize
required

The maximum flash cache repository size measured in bytes.
Example : "string"

string (int64)

defaultMediaScanPeriod
required

The default media scan period stored in the controller’s NVSRAM. Units are days.
Example : 0

integer (int32)

4.424. FeatureState

Name Description Schema

capability
required

This field will contain the value of the premium feature being described.
Example : "string"

enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, __UNDEFINED)

isEnabled
required

A true value in this field indicates that the feature is enabled (regardless of compliance)
Example : true

boolean

isCompliant
required

A true value in this field indicates that the feature has been purchased (in compliance). A false value indicates that the feature has not been purchased. The user will receive warning messages indicating that they are not in compliance. The warning message will continue until the feature is purchased or the feature is disabled.
Example : true

boolean

isWithinLimits
required

This field is deprecated. Use isCompliant field instead.
Example : true

boolean

featureId
required

This field contains the value of the feature ID associated with the feature.
Example : "string"

enum (volumesPerPartition, totalNumberOfVolumes, storagePartitions, snapshot, volumeCopy, remoteMirroring, driveTrayExpansion, mixedDriveTypes, mgmtApplication, supportedDrives, supportedDriveTrays, performanceTier, totalNumberOfSnapshots, totalNumberOfVolCopies, goldKey, snapshotsPerVolume, totalNumberOfMirrors, raid6, stateCapture, sataStrLen, secureVolume, protectionInformation, solidStateDisk, driveSlotLimit, fdeProxyKeyManagement, supportedInterposer, vendorSupportedDrives, flashReadCache, totalNumberOfAsyncMirrorGroups, totalNumberOfAsyncMirrorsPerGroup, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, pitGroupsPerVolume, totalNumberOfPitGroups, pitsPerPitGroup, memberVolsPerPitConsistencyGroup, totalNumberOfPitConsistencyGroups, totalNumberOfPitViews, totalNumberOfThinVolumesPerArray, nativeSataDriveSupport, solidStateDiskLimit, totalNumberOfRemoteMirrorsPerArray, asup, ectSelector, embeddedSnmpOid, asupOnDemand, dacstoreCompatId, samoaHicProtocol, targetPortLunMapping, hildaBaseboardProtocol, denali2Protocol, __UNDEFINED)

featureRef
required

This field contains a reference to the feature.
Example : "string"

string

limit
required

A numerical description associated with this FeatureState object, describing the level or tier for this feature. A zero value represents a feature that does not support tiering. Non-zero implies a tiering level.
Example : 0

integer (int32)

duration
required

Describes the timeframe this feature will be available. A zero value describes an infinite duration. The unit of duration is in days.
Example : 0

integer (int32)

enabledTime
required

Describes the time when this feature was enabled.
Example : "string"

string (int64)

supportedFeatureBundleId
required

The supported Feature Bundle ID. When not in use this value will be zero.
Example : 0

integer (int32)

permanentLicenseApplied
required

TRUE if a permanent license for this feature has been applied. FALSE if the feature is being evaluated or is not enabled at all.
Example : true

boolean

4.425. FlashCache

Name Description Schema

wwn
required

The WWN of the high level flash cache volume.
Example : "string"

string

flashCacheRef
required

A reference to the high level flash cache volume.
Example : "string"

string

flashCacheBase
required

Contains the base-level Flash Cache attributes pertaining to all types of Flash Caches.
Example : "FlashCacheBase"

FlashCacheBase

fcDriveInfo
required

Drive information for the flash cache.
Example : "FlashCacheDriveInfo"

FlashCacheDriveInfo

id
optional

Example : "string"

string

4.426. FlashCacheBundle

Name Description Schema

flashCacheMap
required

A list of structures that map between the cached volumes and their associated flash cache.
Example : [ "FlashCacheMap" ]

< FlashCacheMap > array

flashCache
required

A list of flash cache objects.
Example : [ "FlashCache" ]

< FlashCache > array

4.427. FlashCacheMap

Name Description Schema

flashCache
required

A reference to the associated flash cache.
Example : "string"

string

cachedVolume
required

A reference to the cached volume.
Example : "string"

string

flashCacheMapRef
required

A unique identifier for the map entry.
Example : "string"

string

id
optional

Example : "string"

string

4.428. FreeExtent

Name Description Schema

sectorOffset
required

The sector offset of this free extent within its volume group. This value is provided only to allow the client application to determine the relative positions of free extents and volumes within a given volume group. No other assumptions or computations should be made with this value.
Example : "string"

string (int64)

rawCapacity
required

The total raw capacity of this free extent. If the storage array supports mixed RAID levels per volume group, this value will represent the raw capacity without accounting for RAID parity requirements. Otherwise, this value will represent the RAID-factored capacity of the free extent, and thus provide an indication of the maximum volume (using the volume group’s RAID level) that can be created on this free extent.
Example : "string"

string (int64)

raidLevel
required

The RAID level of this free extent, which governs the allowed configuration of volumes that can be created on it.
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

volumeGroupRef
required

The volume group reference value of the volume group on which this free extent resides.
Example : "string"

string

freeExtentRef
required

The unique identification value for this free extent. Other objects may use this reference value to refer to the free extent.
Example : "string"

string

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

4.429. GBICParentTypeData

Name Description Schema

gbicParentType
required

This enumeration is used to identify the parent type of a GBIC component.
Example : "string"

enum (esm, minihub, controller, __UNDEFINED)

controllerGBIC
optional

This field is present only if the gbicParentType value is GBIC_PARENT_TYPE_CONTROLLER. It contains the detailed information about the controller channel.
Example : "ControllerGBIC"

ControllerGBIC

parentEsm
optional

No information is returned
Example : "string"

string

parentMinihub
optional

This field is present only if the gbicParentType value is GBIC_PARENT_TYPE_MINIHUB. It contains the detailed information about the minihub the GBIC belongs to.
Example : "string"

string

4.430. Gbic

Name Description Schema

gbicRef
required

The reference for this physical GBIC.
Example : "string"

string

status
required

The operational status of the GBIC.
Example : "string"

enum (optimal, failed, removed, unknown, __UNDEFINED)

physicalLocation
required

The physical location of the GBIC. Note that the tray reference identifies the enclosure containing the GBIC, but the slot information does not apply to this component.
Example : "Location"

Location

gbicType
required

This field is the discriminator value, which identifies the type of GBIC.
Example : "string"

enum (notPresent, cs12Active, cs12Passive, opticalLw, serialModule, opticalSw, opticalLwLxSingleMode, opticalSwSx, __UNDEFINED)

gbicPort
required

This field provides information about the port that the GBIC is associated with.
Example : "string"

enum (port1, port2, __UNDEFINED)

parentData
required

Information returned is based on the type of the GBIC parent. The data returned describes the component or controller that is associated with the GBIC.
Example : "GBICParentTypeData"

GBICParentTypeData

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

4.431. GhostVolBundle

Name Description Schema

ghostVol
required

An array of GhostVolume objects.
Example : [ "GhostVolume" ]

< GhostVolume > array

4.432. GhostVolume

Name Description Schema

worldWideName
required

The World Wide Name of the volume.
Example : "string"

string

volumeRef
required

The reference for this volume.
Example : "string"

string

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

4.433. HLVolumeBundle

Name Description Schema

snapshotVol
required

An array of SnapshotVolume objects.
Example : [ "SnapshotVolume" ]

< SnapshotVolume > array

mirrorVol
required

An array of MirrorProxyVolume objects.
Example : [ "MirrorProxyVolume" ]

< MirrorProxyVolume > array

metadataVol
required

An array of MetadataVolume objects.
Example : [ "MetadataVolume" ]

< MetadataVolume > array

remoteVol
required

An array of RemoteVolume objects.
Example : [ "RemoteVolume" ]

< RemoteVolume > array

volumeCopy
required

An array of VolumeCopy objects.
Example : [ "VolumeCopy" ]

< VolumeCopy > array

pitGroup
required

An array of PITGroup objects.
Example : [ "PITGroup" ]

< PITGroup > array

pit
required

An array of PiT objects.
Example : [ "PIT" ]

< PIT > array

pitView
required

An array of PITView objects.
Example : [ "PITView" ]

< PITView > array

pitConsistencyGroup
required

An array of PITConsistencyGroup objects.
Example : [ "PITConsistencyGroup" ]

< PITConsistencyGroup > array

concatVolume
required

An array of ConcatVolume objects.
Example : [ "ConcatVolume" ]

< ConcatVolume > array

concatVolMember
required

An array of ConcatVolumeMember objects.
Example : [ "ConcatVolumeMember" ]

< ConcatVolumeMember > array

pitConsistencyGroupView
required

An array of PITConsistencyGroupView objects.
Example : [ "PITConsistencyGroupView" ]

< PITConsistencyGroupView > array

thinVolume
required

An array of ThinVolume objects.
Example : [ "ThinVolume" ]

< ThinVolume > array

asyncMirrorGroup
required

Async Mirror Groups.
Example : [ "AsyncMirrorGroup" ]

< AsyncMirrorGroup > array

asyncMirrorGroupMember
required

Async Mirror Group Members.
Example : [ "AsyncMirrorGroupMember" ]

< AsyncMirrorGroupMember > array

asyncMirrorGroupIncompleteMember
required

"Incomplete" Async Mirror Group Members.
Example : [ "AsyncMirrorGroupIncompleteMember" ]

< AsyncMirrorGroupIncompleteMember > array

4.434. HostSpecificValues

Name Description Schema

waitForDownload
required

The download microcode status control.
Example : true

boolean

notReadySenseForQuiescenceInProgress
required

This value determines the response of the controller to commands received during the 'controller quiesced' state.
Example : true

boolean

notReadySenseForQuiescenceInProgress2
required

This value determines the response of the controller to commands received during the 'controller quiesced' state.
Example : true

boolean

checkConditionForVendorUniqueUAConditions
required

This value determines if the controller will report a vendor unique Unit Attention condition as a Check Condition status.
Example : true

boolean

reportDeferredErrors
required

This value is used to determine how deferred errors are reported to the host.
Example : true

boolean

ignoreForceUnitAccess
required

This value determines controller treatment of the Force Unit Access Option in the SCSI Read(10) and Write(10) commands.
Example : true

boolean

ignoreWriteCacheDisable
required

This value determines if the controller will allow the resetting of the WCE bit in the Mode Select Caching Page to disable write caching.
Example : true

boolean

allowReservationOnUnownedLUNs
required

This value determines the controller response to Reservation/Release commands that are received for LUNs that are not owned by the controller.
Example : true

boolean

worldWideNameInStandardInquiry
required

Set to true if the WWN is in the standard inquiry data.
Example : true

boolean

propagateHostBusResets
required

This value determines whether the controller will propagate a Host Bus Reset/Target Reset/Logical Unit Reset to the other controller in a dual controller subsystem to support Microsoft Clustering Services.
Example : true

boolean

reportSCCDeviceEnable
required

Report SCC Device Enable.
Example : true

boolean

conditionalFCLogout
required

Conditional Fibre Channel Logout.
Example : true

boolean

forceSCSI2
required

Report SCSI-2 Through Fibre Channel Host Interface.
Example : true

boolean

reportUnconfiguredLUNs
required

This value determines the LUN data returned by the Report LUNs command.
Example : true

boolean

ignoreSyncCache
required

Ignore Cache Sync Command.
Example : true

boolean

ignoreUTMLunOwnership
required

Ignore UTM LUN Ownership.
Example : true

boolean

reportLUNPreferredPathInStandardInquiry
required

Report LUN Preferred Path in Standard Inquiry Data.
Example : true

boolean

autoLUNTransfer
required

Auto Volume Transfer.
Example : true

boolean

inquiryUnconfiguredDeviceType
required

The value returned in the Inquiry Device Type Field when an unconfigured LUN is accessed.
Example : "string"

string

inquiryUnownedDeviceType
required

This value is used to define the device type the controller should return in the first byte of the Inquiry data, if the addressed logical unit is not owned by the addressed controller.
Example : "string"

string

unownedBlock0Read
required

This value is used to define how the controller handles a read request to Block 0 of an unowned volume. When this is enabled, the non-owning controller sends a request for the block 0 data to the owning controller and the owning controller sends the requested block 0 data back to the non-owning controller. If disabled, the controller will do a volume transfer (if AVT is enabled) and then a read of the now owned volume.
Example : "string"

string

retainLogins
required

This field is deprecated.
Example : true

boolean

hostPortType
required

The host type.
Example : "string"

string

maxRestrictedLUNs
required

Maximum number of LUNs allowed for host type.
Example : 0

integer (int32)

reserved1
optional

Example : "string"

string

avtExclusionExtentsEnabled
required

Enable the AVT exclusion extents for this heterogeneous host region.
Example : true

boolean

suppressVolOffPreferredPathAlert
required

If true, then volume-off-preferred events are not considered critical.
Example : true

boolean

hostType
required

The host type string. A zero-length string is allowed and indicates that the associated host-specific NVSRAM region has been cleared. This field should be used in place of the deprecated hostPortType field.
Example : "string"

string

tpgsSupported
required

This field is set to true if Target Port Group Support is provided; otherwise it is false.
Example : true

boolean

volumeFormatOptions
required

If true, a format unit request will interrupt any in-progress IAF and start a write-zeros initialization. If false, the format unit will be returned with no action.
Example : true

boolean

restrictedLun0
required

If true, LUN 0 is restricted and volume mapping to LUN 0 will not be allowed or be reported in the REPORT LUNS data. If false, a volume-to-LUN mapping can be created to LUN 0 and will be reported in a REPORT LUNS response.
Example : true

boolean

usePage2CQuiescenceTimeout
required

The quiescence timeout is the amount of time the controller should wait to achieve a "no I/Os active" state before invoking a forced transfer of LUN ownership. When this field is set to true, the timeout parameter provided by the host initiator in a mode select Page 2C will be used. When this field is set to false, the timeout value applied will be calculated by the controller.
Example : true

boolean

asymmetricLUAccess
required

If true, Asymmetric Logical Unit Access is enabled.
Example : true

boolean

ignoreISCSISessionIDInITN
required

If true, the array iSCSI target driver will not use the session identifier as part of its internal I_T Nexus identifiers. This reduces churn in I_T Nexus identifiers if the initiator does not re-use iSCSI session identifiers when re-opening a session.
Example : true

boolean

enableLUCheckConditionParallelResponses
required

If true, array may return multiple CHECK CONDITION responses simultaneously on a given logical unit.
Example : true

boolean

disableExplicitTPGS
required

If true, the standard INQUIRY data reporting TPGS support to the initiator will only indicate support for implicit mode (providing TPGS support is enabled, see tpgsSupported field).
Example : true

boolean

unownedCheckConditionDuringFWActivation
required

If true, controller will return a LUN NOT OWNED (05h/94h/01h) CHECK CONDITION when unable to handle I/O during firmware activation.
Example : true

boolean

allowPreferredOwnerReportingSuppression
required

If true, the controller will suppress reporting the preferred owner in REPORT TARGET PORT GROUPS or INQUIRY VPD data in conditions when the preferred controller cannot process I/O.
Example : true

boolean

enableTargetFailback
required

If true, controller initiates fail-back of volumes to the preferred owner .
Example : true

boolean

enableAutoLoadBalance
required

If true, the controller may issue volume ownership changes to balance IO load between controllers.
Example : true

boolean

quiescenceInProgressSenseKey
required

Sense Key returned to host for Quiescence In Progress Check Conditions.
Example : 0

integer (int32)

quiescenceInProgressASC
required

Additional Sense Code returned to host for Quiescence In Progress Check Conditions.
Example : 0

integer (int32)

quiescenceInProgressASCQ
required

Additional Sense Code Qualifier returned to host for Quiscence In Progress Check Conditions.
Example : 0

integer (int32)

persistentID
required

Unique identifier for this specific host type. This value is stored in the controller configuration database when persisting Host objects in order to uniquely identify this specific host type across all NVSRAM builds.
Example : 0

integer (int32)

nvmeVUFailoverSupported
required

If true, a vendor unique (VU) NVMe failover solution is supported on the host.
Example : true

boolean

nvmeStandardFailoverSupported
required

If true, the NVMe Asymmetric Namespace Access (ANA) failover solution is supported on the host.
Example : true

boolean

4.435. IOCDumpData

Name Description Schema

iocDumpEnabled
required

If true, IOC Dump is enabled in the controller.
Example : true

boolean

iocDumpNeedsRetrieved
required

If true, an IOC Dump currently exists in controller memory and has not been retrieved.
Example : true

boolean

iocDumpTag
required

The tag value of the IOC Dump currently in controller memory. Each dump has a unique tag value. A value of IOC_DUMP_NULL_TAG indicates there is no IOC Dump to retrieve.
Example : 0

integer (int32)

timeStamp
required

The time that the dump was collected measured in seconds since midnight GMT on January 1, 1970.
Example : "string"

string (int64)

4.436. InterconnectCRU

Name Description Schema

interconnectCRURef
required

The reference for this physical interconnect CRU
Example : "string"

string

status
required

The operational status of the interconnect CRU
Example : "string"

enum (optimal, failed, removed, __UNDEFINED)

physicalLocation
required

The physical location of the interconnect CRU. The parent reference in Location identifies the tray containing the CRU, and the position field is always one.
Example : "Location"

Location

manufacturerDate
required

VPD Manufacture Date
Example : "string"

string (int64)

vendorName
required

The VPD vendor name
Example : "string"

string

vendorPN
required

The VPD part number
Example : "string"

string

vendorSN
required

The VPD serial number
Example : "string"

string

fruType
required

The VPD field replaceable unit type
Example : "string"

string

readyToRemove
required

When set to True, it means that the component is ready to remove (and the Ready to Remove indicator will be turned on). This field is deprecated. The rtrAttributes field should be used instead.
Example : true

boolean

rtrAttributes
required

The CRU type of the interconnect CRU plus its ready-to-remove attributes, which are based on the CRU type.
Example : "RTRAttributes"

RTRAttributes

repairPolicy
required

The repair policy for the interconnect CRU component.
Example : "RepairPolicy"

RepairPolicy

4.437. Interposer

Name Description Schema

interposerRef
required

The drive interposer identifier.
Example : "string"

string

interposerTypeData
required

The vendor product data associated with the interposer.
Example : "InterposerTypeData"

InterposerTypeData

4.438. InterposerData

Name Description Schema

vendorID
required

This data is a variable length ASCII text string containing the vendor identification of the interposer.
Example : "string"

string

productID
required

This data is a variable length ASCII text string containing the product identification of the interposer.
Example : "string"

string

revision
required

This data is a variable length ASCII text string that represents the current version, or revision level, of the interposer.
Example : "string"

string

deviceWWN
required

This data represents the device name of the interposer.
Example : "string"

string

serialNumber
required

This data is a variable length ASCII text string that represents the serial number of the interposer.
Example : "string"

string

partNumber
required

This data is a variable length ASCII text string that represents the part number of the interposer.
Example : "string"

string

driveFwVersion
required

4 bytes left-justified ASCII drive firmware version as retrieved from the drive’s standard INQUIRY data, followed by 4 blank bytes.
Example : "string"

string

4.439. InterposerTypeData

Name Description Schema

interposerType
required

This enumeration defines the different interposer types.
Example : "string"

enum (unknown, fcToSas, __UNDEFINED)

fcSasInterposer
optional

This field is available when the interfaceTypeData is equal to INTERPOSER_TYPE_FC_TO_SAS
Example : "InterposerData"

InterposerData

reserved
optional

Reserved.
Example : "string"

string

4.440. IoInterfaceHicMap

Name Description Schema

interfaceRef
required

A reference to the I/O interface.
Example : "string"

string

hostBoardRef
required

The reference to the associated HIC.
Example : "string"

string

4.441. IscsiEntityData

Name Description Schema

icmpPingResponseEnabled
required

True if the storage array is enabled to respond to ICMP ping messages.
Example : true

boolean

unnamedDiscoverySessionsEnabled
required

True if the storage array is enabled to participate in unnamed discovery sessions.
Example : true

boolean

isnsServerTcpListenPort
required

The number of the TCP port on which the iSNS server listens for incoming connections.
Example : 0

integer (int32)

ipv4IsnsServerAddressConfigMethod
required

The method by which the storage array determines the IPV4 address of the iSNS server.
Example : "string"

enum (configDhcp, configStatic, __UNDEFINED)

ipv4IsnsServerAddress
required

The method by which the storage array determines the IPV4 address of the iSNS server.
Example : "string"

string

ipv6IsnsServerAddressConfigMethod
required

The method by which the storage array determines the IPV6 address of the iSNS server. This is always set to "static" and cannot be changed.
Example : "string"

enum (configStatic, configStateless, __UNDEFINED)

ipv6IsnsServerAddress
required

The method by which the storage array determines the IPV6 address of the iSNS server. This is always set to "static" and cannot be changed.
Example : "string"

string

isnsRegistrationState
required

The state of the iSCSI entity with respect to iSNS server registration.
Example : "string"

enum (disabled, locatingServer, connectingToServer, completed, __UNDEFINED)

isnsServerRegistrationEnabled
required

True if the storage array is enabled to register with the iSNS (Internet Storage Name Service) server.
Example : true

boolean

hostPortsConfiguredDHCP
required

True if all the host ports have DHCP enabled, regardless of the configuration state.
Example : true

boolean

4.442. KeyValueTag

Name Description Schema

keyValueTagRef
required

The unique handle for a key-value object contained within this structure.
Example : "string"

string

key
required

The key is a fixed length, opaque byte sequence that stores user-defined data.
Example : "string"

string

value
required

The value is a fixed length opaque byte sequence that stores user-defined data.
Example : "string"

string

4.443. KeyValueTagMapping

Name Description Schema

keyValueTagRef
required

This field identifies the key-value tag to be associated with the Volume or Workload.
Example : "string"

string

associatedObject
required

This element identifies the object that is associated with the key-value tag.
Example : "KeyValueTagObjectReference"

KeyValueTagObjectReference

mappingRef
required

The unique identifier for the specific mapping between the KeyValueTag and the KeyValueTagObjectReference identified in this structure.
Example : "string"

string

4.444. KeyValueTagObjectReference

Name Description Schema

objectType
required

Enumeration used to define the different type of object that can be associated with a key value tag.
Example : "string"

enum (unknown, volume, workload, __UNDEFINED)

volume
optional

This field is returned for an object of type Volume.
Example : "string"

string

workload
optional

This field is returned for an object of type Workload.
Example : "string"

string

4.445. LockKeyID

Name Description Schema

lockKeyIDRef
required

The unique reference to a lockKeyID.
Example : "string"

string

lockKeyID
required

The lock key ID.
Example : "string"

string

4.446. MetadataVolume

Name Description Schema

metadataVolRef
required

This object identifies the metadata volume.
Example : "string"

string

metadataVolType
required

This object specifies the metadata volume type.
Example : "string"

enum (allMdatTypes, remoteMirror, __UNDEFINED)

associatedVolume
required

Volume that contains data
Example : "string"

string

preferredManager
required

The controller that created the metadata volume.
Example : "string"

string

perms
required

The permissions allowed.
Example : "VolumePerms"

VolumePerms

offline
required

True, if the volume is offline.
Example : true

boolean

reserved1
optional

Example : "string"

string

4.447. Minihub

Name Description Schema

minihubRef
required

The reference for this physical minihub.
Example : "string"

string

status
required

The operational status of the minihub.
Example : "string"

enum (optimal, failed, unsupported, unknown, __UNDEFINED)

physicalLocation
required

The physical location of the minihub. Note that the tray reference identifies the enclosure containing the minihub, but the slot information does not apply to this component.
Example : "Location"

Location

minihubData
required

Information returned is based on the minihub type.
Example : "MinihubTypeData"

MinihubTypeData

currentSpeed
required

The current speed of the minihub.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

maxSpeed
required

The maximum speed of the minihub.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

channel
required

The channel number that this minihub is associated with.
Example : 0

integer (int32)

portList
required

Detailed information for each port of the minihub. This field is deprecated.
Example : "PortList"

PortList

vendorName
required

The vendor name of the minihub.
Example : "string"

string

partNumber
required

The part number of the minihub.
Example : "string"

string

serialNumber
required

The serial number of the minihub.
Example : "string"

string

fruType
required

The field replaceable unit type of the minihub.
Example : "string"

string

manufacturerDate
required

The date the minihub was manufactured.
Example : "string"

string (int64)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

rtrAttributes
required

The CRU type of the minihub plus its ready-to-remove attributes, which are based on the CRU type
Example : "RTRAttributes"

RTRAttributes

4.448. MinihubTypeData

Name Description Schema

minihubType
required

This enumeration is used to identify the type of a minihub.
Example : "string"

enum (hostside, driveside, __UNDEFINED)

parentController
optional

This field is present only if the minihubType value is equal to MINIHUB_TYPE_HOSTSIDE. It contains the detailed information about the controller the minihub is associated with.
Example : "string"

string

4.449. MirrorProxyVolume

Name Description Schema

worldWideName
required

The WWN of the local mirror volume.
Example : "string"

string

mirrorProxyRef
required

The reference to the local mirror volume.
Example : "string"

string

volumeHandle
required

The ssid of the local mirror volume.
Example : 0

integer (int32)

localMirrorStatus
required

The status of the local mirror volume.
Example : "string"

enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED)

remoteMirrorStatus
required

The status of the remote mirror volume.
Example : "string"

enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED)

localRole
required

The role of the local mirror volume.
Example : "string"

enum (primary, secondary, invalid, __UNDEFINED)

remoteRole
required

The role of the remote mirror volume.
Example : "string"

enum (primary, secondary, invalid, __UNDEFINED)

localPriority
required

The synchronization priority for the local mirror volume.
Example : "string"

enum (priority0, priority1, priority2, priority3, priority4, unknown, __UNDEFINED)

peerPriority
required

The synchronization priority for the remote mirror volume.
Example : "string"

enum (priority0, priority1, priority2, priority3, priority4, unknown, __UNDEFINED)

usableCapacity
required

The amount of capacity being used by the mirror.
Example : "string"

string (int64)

currentManager
required

The controller reference that owns the local mirror volume.
Example : "string"

string

baseVolume
required

The reference to the base volume of the local mirror.
Example : "string"

string

remoteVolRef
required

The reference to the remote volume.
Example : "string"

string

action
required

An indication of what current long-running activity, if any, is currently in progress on the volume.
Example : "string"

enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

localWriteMode
required

The local mirror volume’s write mode.
Example : "string"

enum (synchronousMode, asynchronousMode, consistentAsyncMode, __UNDEFINED)

autoResync
required

Indicates whether auto resynchronization is allowed.
Example : true

boolean

consistencyGroupRef
required

The write consistency group reference.
Example : "string"

string

4.450. NetworkInterface

Name Description Schema

interfaceRef
required

The SYMbol array-wide unique name for the interface object.
Example : "string"

string

channelType
required

The type of channel that the interface is associated with.
Example : "string"

enum (hostside, driveside, management, __UNDEFINED)

netInterfaceTypeData
required

A field whose contents vary depending on the type of the interface.
Example : "NetInterfaceTypeData"

NetInterfaceTypeData

4.451. ObjectBundle

Name Description Schema

configGeneration
required

The configuration generation number that was in effect at the time this object bundle was constructed by the controller. The client can use this value to determine if it currently holds the latest version of the object graph.
Example : "string"

string (int64)

sa
required

A StorageArray object that contains base information about the storage array as a whole.
Example : "StorageArray"

StorageArray

tray
required

A variable-length array of Tray structures. This array contains one element for each tray object that exists within the storage array.
Example : [ "Tray" ]

< Tray > array

componentBundle
required

A variable-length array of Component structures. This array contains one element for each physical component object that exists within the storage array.
Example : "ComponentBundle"

ComponentBundle

controller
required

A variable-length array of Controller structures. This array contains one element for each RAID controller object that exists within the storage array.
Example : [ "Controller" ]

< Controller > array

drive
required

A variable-length array of Drive structures. This array contains one element for each physical disk drive object that exists within the storage array.
Example : [ "Drive" ]

< Drive > array

volumeGroup
required

A variable-length array of VolumeGroup structures. This array contains one element for each volume group object that exists within the storage array.
Example : [ "VolumeGroup" ]

< VolumeGroup > array

volume
required

A variable-length array of VolumeGroup structures. This array contains one element for each volume group object that exists within the storage array.
Example : [ "Volume" ]

< Volume > array

freeExtent
required

A variable-length array of FreeExtent structures. This array contains one element for each free extent object that exists within the storage array.
Example : [ "FreeExtent" ]

< FreeExtent > array

dveVol
required

A variable-length array of DVE structures. This array contains one element for each volume being expanded.
Example : [ "DVEVolume" ]

< DVEVolume > array

storagePoolBundle
required

An embedded object bundle that contains all configuration information relative to the "Storage Partitions" feature.
Example : "StoragePoolBundle"

StoragePoolBundle

highLevelVolBundle
required

An embedded object bundle that contains all the information relative to the Higher-Level Volumes.
Example : "HLVolumeBundle"

HLVolumeBundle

ghostVolBundle
required

An embedded object bundle that contains all the information relative to missing volumes.
Example : "GhostVolBundle"

GhostVolBundle

consistencyGroupBundle
required

Write consistency group bundle.
Example : "ConsistencyGroupBundle"

ConsistencyGroupBundle

ioInterface
required

A variable-length array of IoInterface structures. This array contains one element for each I/O interface object that exists within the storage array
Example : [ "IoInterface" ]

< IoInterface > array

networkInterface
required

A variable-length array of NetworkInterface structures. This array contains one element for each network interface object that exists within the storage array
Example : [ "NetworkInterface" ]

< NetworkInterface > array

lockKeyIDs
required

A variable length array of LockKeyID structures. Contains lock key information for the array.
Example : [ "LockKeyID" ]

< LockKeyID > array

interposer
required

A variable length array of drive interposer data. An entry will appear in this array only if the interposerPresent field in the corresponding Drive structure is set to True.
Example : [ "Interposer" ]

< Interposer > array

ioInterfaceHicMap
required

This is a list of structures that provides a mapping from I/O interfaces to their associated HICs.
Example : [ "IoInterfaceHicMap" ]

< IoInterfaceHicMap > array

schedule
required

A list of current schedules.
Example : [ "ScheduleInstance" ]

< ScheduleInstance > array

remoteArray
required

This is a list of remote arrays which this array has visibility to for monitoring.
Example : [ "RemoteArray" ]

< RemoteArray > array

flashCacheBundle
required

An embedded object bundle that contains all of the information related to flash cache objects.
Example : "FlashCacheBundle"

FlashCacheBundle

snmpBundle
required

SNMP-related objects
Example : "SNMPAgentBundle"

SNMPAgentBundle

applicationAwarenessBundle
required

This reports the key-value pairs and their references, and the mappings between Volumes and these key-value pairs. The data is used by the application and is opaque to the CFW.
Example : "ApplicationAwarenessBundle"

ApplicationAwarenessBundle

4.452. PIT

Name Description Schema

pitRef
required

The reference (key) for this PiT.
Example : "string"

string

pitGroupRef
required

A reference to the associated PiT Group.
Example : "string"

string

creationMethod
required

The PiT creation method.
Example : "string"

enum (unknown, user, schedule, __UNDEFINED)

pitTimestamp
required

The controller-time (measured in seconds since January 1, 1970) when the PiT was created.
Example : "string"

string (int64)

pitSequenceNumber
required

The sequence number within PITGroup. This is a monotonically increasing sequence value that can be used to determine the absolute order of the PiTs within a PiT group. Using this sequence number avoids issues with timestamps when real-time clocks are changed. Note that this sequence number will be the same on all PiTs taken in multiple PITGroups at the same time under a single IO suspension, either as part of a consistency group operation (createCGPIT) or when a list of PITGroups is passed to createPIT.
Example : "string"

string (int64)

status
required

The state of this PiT.
Example : "string"

enum (unknown, optimal, failed, purged, __UNDEFINED)

activeCOW
required

If true, the PiT is actively recording copy-on-write data.
Example : true

boolean

isRollbackSource
required

If true, the PiT is a rollback source.
Example : true

boolean

pitCapacity
required

The capacity in bytes of this PiT (capacity of the base at the time the PiT was created).
Example : "string"

string (int64)

repositoryCapacityUtilization
required

Repository utilization in bytes (only reported if activeCOW = false).
Example : "string"

string (int64)

id
optional

Example : "string"

string

4.453. PITGroup

Name Description Schema

pitGroupRef
required

The reference (key) for the PiT Group.
Example : "string"

string

label
required

The name of the PiT Group. If this PiT group is part of a consistency group, then this label does not have to be present or unique as the parent consistency group label will be used.
Example : "string"

string

status
required

The status of the PiT Group.
Example : "string"

enum (unknown, optimal, full, failed, overThreshold, __UNDEFINED)

baseVolume
required

The base volume for this PiT Group.
Example : "string"

string

repositoryVolume
required

The copy-on-write (CoW) Repository for this PiT group.
Example : "string"

string

clusterSize
required

The cluster size (in bytes).
Example : 0

integer (int32)

maxRepositoryCapacity
required

The maximum allowable repository size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group.
Example : "string"

string (int64)

maxBaseCapacity
required

The maximum allowable base volume size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group.
Example : "string"

string (int64)

unusableRepositoryCapacity
required

The amount of repository capacity that is unusable due to limited addressability of the current cluster size.
Example : "string"

string (int64)

repFullPolicy
required

The behavior on repository full condition. Overridden by consistency group setting if this PITGroup is associated with a consistency group.
Example : "string"

enum (unknown, failbasewrites, purgepit, __UNDEFINED)

fullWarnThreshold
required

The repository utilization warning threshold percentage.
Example : 0

integer (int32)

autoDeleteLimit
required

The auto-delete indicator. If non-zero, the oldest PiT will be automatically deleted when creating a new one to keep the total number of PiTs limited to the number specified. This value is overridden by the consistency group setting if this PITGroup is associated with a consistency group.
Example : 0

integer (int32)

action
required

Long running operation.
Example : "string"

enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED)

rollbackStatus
required

The status of the rollback (if rollback is indicated in VolumeAction above).
Example : "string"

enum (unknown, none, inProgress, pending, paused, __UNDEFINED)

rollbackPriority
required

The importance of the rollback operation.
Example : "string"

enum (highest, high, medium, low, lowest, __UNDEFINED)

consistencyGroup
required

If true, this PiT group is part of a consistency group.
Example : true

boolean

consistencyGroupRef
required

A reference to the parent consistency group, if applicable. This value will be NULL if this PiT group is not part of a consistency group.
Example : "string"

string

creationPendingStatus
required

The status of Pending PiT Creation.
Example : "string"

enum (unknown, none, waiting, failed, __UNDEFINED)

volumeHandle
required

The PiT group SSID. This is provided primarily for debug purposes.
Example : 0

integer (int32)

name
optional

Example : "string"

string

id
optional

Example : "string"

string

4.454. PITView

Name Description Schema

viewRef
required

The reference (key) for this view.
Example : "string"

string

worldWideName
required

The WWN of the view.
Example : "string"

string

baseVol
required

A reference to the base volume with which this view is associated.
Example : "string"

string

basePIT
required

A reference to the particular PiT of the base for which this view applies. This field is only valid if the boundToPIT field is true.
Example : "string"

string

boundToPIT
required

If true, this flag indicates that the basePIT field is a valid reference to an associated PIT. If false, the view is disassociated from the PiT so the basePIT reference is invalid.
Example : true

boolean

accessMode
required

The view access mode.
Example : "string"

enum (modeUnknown, readWrite, readOnly, __UNDEFINED)

label
required

The name of the view.
Example : "string"

string

status
required

The view status.
Example : "string"

enum (unknown, optimal, stopped, failed, overThreshold, full, __UNDEFINED)

currentManager
required

The current owner of the view.
Example : "string"

string

preferredManager
required

The preferred owner of the view.
Example : "string"

string

repositoryVolume
required

The copy-on-write repository for this view.
Example : "string"

string

fullWarnThreshold
required

The repository utilization warning threshold percentage.
Example : 0

integer (int32)

viewTime
required

The controller-time (measured in seconds since January 1, 1970) when view was created or re-attached to another PiT.
Example : "string"

string (int64)

viewSequenceNumber
required

Sequence number. This is a monotonically increasing sequence value that can be used to determine related views when the view was created as part of a consistency group operation.
Example : "string"

string (int64)

perms
required

The permissions for the view.
Example : "VolumePerms"

VolumePerms

volumeHandle
required

The volume ssid. This is provided primarily for debug purposes.
Example : 0

integer (int32)

clusterSize
required

The cluster size in bytes.
Example : 0

integer (int32)

maxRepositoryCapacity
required

The maximum allowable repository size in bytes based on current cluster size.
Example : "string"

string (int64)

unusableRepositoryCapacity
required

The amount of repository capacity in bytes that is unusable due to limited addressability of the current cluster size.
Example : "string"

string (int64)

membership
required

This view’s relationship (if any) to a Consistency Group View.
Example : "PITViewMembership"

PITViewMembership

mgmtClientAttribute
required

The management client attribute.
Example : 0

integer (int32)

offline
required

The view is offline due to the associated repository volume state.
Example : true

boolean

extendedUniqueIdentifier
required

A variable-length opaque field that provides the volume’s extended unique identification value.
Example : "string"

string

name
optional

Example : "string"

string

id
optional

Example : "string"

string

4.455. ParityCheckOnMediaType

Name Description Schema

enabledOnHDD
required

Indicate whether or not P and Q parity validation is performed on HDD drives during reconstruction of RAID 6 and disk pool volumes.
Example : true

boolean

enabledOnSSD
required

Indicate whether or not P and Q parity validation is performed on SSD drives during reconstruction of RAID 6 and disk pool volumes.
Example : true

boolean

4.456. PremiumFeature

Name Description Schema

capability
required

This field will contain the value of the premium feature being described.
Example : "string"

enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, __UNDEFINED)

isEnabled
required

A true value in this field indicates that the feature is enabled (regardless of compliance)
Example : true

boolean

isCompliant
required

A true value in this field indicates that the feature has been purchased (in compliance). A false value indicates that the feature has not been purchased. The user will receive warning messages indicating that they are not in compliance. The warning message will continue until the feature is purchased or the feature is disabled.
Example : true

boolean

isWithinLimits
required

A true value in this field indicates that the feature has been purchased and the subsystem configuration does not exceed the feature options specified at purchase. A false value in this field indicates that the feature has been purchased but new subsystem configuration has caused the user to exceed the feature options that were purchased. The user will receive warning messages indicating that they are no longer in compliance. The user can change the subsystem configuration so that it is in compliance with feature options or the user can purchase additional feature options so that the subsystem is again in compliance. The warning messages will continue until the feature is again in compliance or is disabled.
Example : true

boolean

featureId
required

This field contains the value of the feature ID associated with the feature.
Example : "string"

enum (volumesPerPartition, totalNumberOfVolumes, storagePartitions, snapshot, volumeCopy, remoteMirroring, driveTrayExpansion, mixedDriveTypes, mgmtApplication, supportedDrives, supportedDriveTrays, performanceTier, totalNumberOfSnapshots, totalNumberOfVolCopies, goldKey, snapshotsPerVolume, totalNumberOfMirrors, raid6, stateCapture, sataStrLen, secureVolume, protectionInformation, solidStateDisk, driveSlotLimit, fdeProxyKeyManagement, supportedInterposer, vendorSupportedDrives, flashReadCache, totalNumberOfAsyncMirrorGroups, totalNumberOfAsyncMirrorsPerGroup, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, pitGroupsPerVolume, totalNumberOfPitGroups, pitsPerPitGroup, memberVolsPerPitConsistencyGroup, totalNumberOfPitConsistencyGroups, totalNumberOfPitViews, totalNumberOfThinVolumesPerArray, nativeSataDriveSupport, solidStateDiskLimit, totalNumberOfRemoteMirrorsPerArray, asup, ectSelector, embeddedSnmpOid, asupOnDemand, dacstoreCompatId, samoaHicProtocol, targetPortLunMapping, hildaBaseboardProtocol, denali2Protocol, __UNDEFINED)

4.457. ProcessorMemoryDimm

Name Description Schema

processorMemoryDimmRef
required

The SYMbol reference value that uniquely identifies an instance of a cache memory DIMM object.
Example : "string"

string

parentController
required

The SYMbol reference of the DIMM’s parent controller.
Example : "string"

string

dimmControllerSlot
required

The controller-relative slot number of the DIMM, where "1" is the first slot number.
Example : 0

integer (int32)

status
required

The operational status of the DIMM.
Example : "string"

enum (unknown, optimal, empty, failed, __UNDEFINED)

capacityInMegabytes
required

The capacity of the DIMM expressed in megabytes.
Example : 0

integer (int32)

serialNumber
required

The serial number of the DIMM.
Example : "string"

string

partNumber
required

The LSI Logic part number of the DIMM.
Example : "string"

string

oemPartNumber
required

The OEM part number of the DIMM.
Example : "string"

string

manufacturerPartNumber
required

The manufacturer part number of the DIMM.
Example : "string"

string

manufacturer
required

The manufacturer part number of the DIMM.
Example : "string"

string

manufactureDate
required

The manufacture date of the DIMM
Example : "string"

string (int64)

repairPolicy
required

The repair policy for the processor memory DIMM component.
Example : "RepairPolicy"

RepairPolicy

physicalLocation
required

The physical location of the processor memory DIMM. The parent field of Location is set to the controller where the DIMM physically resides, and the position field is the parent-relative/like-component-relative slot number of the DIMM, starting at one.
Example : "Location"

Location

revisionCode
required

The module revision code of the DIMM.
Example : "string"

string

4.458. Recurrence

Name Description Schema

recurrenceType
required

This enumeration is used to specify the type of schedule recurrence.
Example : "string"

enum (unknown, unlimited, count, endDate, __UNDEFINED)

recurrenceCount
optional

This field is present only if recurrenceType is equal to RECURRENCE_COUNT.
Example : 0

integer (int32)

recurrenceEndDate
optional

This field is present only if recurrenceType is equal to RECURRENCE_END_DATE.
Example : "string"

string (int64)

4.459. RemoteArray

Name Description Schema

remoteArrayRef
required

A unique identifier for this RemoteArray object.
Example : "string"

string

saId
required

The storage array ID of the remote array.
Example : "SAIdentifier"

SAIdentifier

remoteTargets
required

One or more paths to the remote array. Note these could be differing protocols.
Example : [ "string" ]

< string > array

4.460. SACache

Name Description Schema

cacheBlkSize
required

The characteristic size, in bytes, of a cache block.
Example : 0

integer (int32)

demandFlushAmount
required

Specifies the amount of cache data that will be flushed to disk when a cache flush operation is initiated. This value is specified as an integer in the range 0-100 that represents the percentage of the controller’s write cache data that can remain in the "dirty", or unflushed state. When demand flush operations are started, data will be flushed from cache to disk until the overall amount of dirty data drops to or below the percentage specified by this value.
Example : 0

integer (int32)

demandFlushThreshold
required

Specifies the "level of fullness" of "dirty" data in the controller’s write cache which, when reached, will cause the controller to begin flushing data from cache to disk. This value is specified as a percentage, in the range 0-100, of the overall write cache capacity of the controller. After flushing begins, it will continue until enough data has been flushed to drop the percentage of dirty data to or below the value specified in the demandFlushAmount parameter described above.
Example : 0

integer (int32)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

cacheMirroringProtectionInformation
required

True if checking of protection information during cache mirroring is enabled, false otherwise.
Example : true

boolean

4.461. SAData

Name Description Schema

needsAttention
required

An indication of whether the array needs attention. A value of true is returned if there are any components that have been marked failed for any reason. Otherwise, if all components are operating properly, a value of false is returned.
Example : true

boolean

fixing
required

An indication of whether the array is in the process of recovering from a Needs Attention condition. A value of true indicates that no physical components are currently marked failed, but that some residual recovery activity (such as reconstruction, copyback, etc.) is still in progress.
Example : true

boolean

saId
required

The globally-unique identifier value for this storage array.
Example : "SAIdentifier"

SAIdentifier

managementClassName
required

The name of the application-level entity required to manage configuration operations for the storage array.
Example : "string"

string

storageArrayLabel
required

The user-assigned label for the storage array.
Example : "string"

string

bootTime
required

The timestamp value for the time at which the responding controller last booted. Note that this value may differ between the individual controllers of a storage array. This value is defined in terms of the number of seconds since midnight GMT on January 1, 1970.
Example : "string"

string (int64)

fwVersion
required

The version identifier of the currently-installed array firmware.
Example : "string"

string

appVersion
required

The version identifier of the "application" component of the currently-installed array firmware.
Example : "string"

string

bootVersion
required

The version identifier of the "boot" component of the currently-installed array firmware.
Example : "string"

string

nvsramVersion
required

An ASCII string that describes the currently-installed NVSRAM contents.
Example : "string"

string

fwPrefix
required

An ASCII string that describes the firmware prefix.
Example : "string"

string

chassisSerialNumber
required

An ASCII string that describes the chassis serial number.
Example : "string"

string

eventConfigurationDataVersion
required

An ASCII string that identifies the version of the MEL event configuration data. This is used for the event logging enhancements in Chessie 2.
Example : "string"

string

arrayAttributes
required

SAAttributeID attribute-value pairs.
Example : [ 0 ]

< integer (int32) > array

res4
optional

Example : [ 0 ]

< integer (int32) > array

res5
optional

Example : [ 0 ]

< integer (int32) > array

res6
optional

Example : [ 0 ]

< integer (int32) > array

res7
optional

Example : "string"

string

extendedSAData
required

This element allows additional content to be added to SAData with actually adding any new elements to the struct. The element replaces a reserved field that was of variable length.
Example : "ExtendedSAData"

ExtendedSAData

4.462. SAPort

Name Description Schema

saPortRef
required

This object uniquely identifies an SAPort.
Example : "string"

string

saPortGroupRef
required

This object uniquely identifies an SAPortGroup.
Example : "string"

string

controllerRef
required

The reference value of the controller.
Example : "string"

string

portId
required

The host-side I/O port identifier of the port on the controller.
Example : 0

integer (int32)

4.463. SAPortGroup

Name Description Schema

saPortGroupRef
required

This object uniquely identifies a specific SAPortGroup.
Example : "string"

string

label
required

The user assigned label for the SAPortGroup.
Example : "string"

string

4.464. SNMPAgentBundle

Name Description Schema

community
required

All configured SNMP communities
Example : [ "SNMPCommunity" ]

< SNMPCommunity > array

trapDestination
required

SNMP Trap Destinations. Traps will be delivered to these destinations when an alertable MEL event is generated.
Example : [ "SNMPTrapDestination" ]

< SNMPTrapDestination > array

systemVariables
required

Current settings for SNMP "system" variables
Example : "SNMPSystemVariables"

SNMPSystemVariables

4.465. SNMPCommunity

Name Description Schema

communityRef
required

A reference to the SNMP community.
Example : "string"

string

communityName
required

Community name
Example : "string"

string

communityPermissions
required

Community permissions
Example : "string"

enum (unknown, readOnly, readWrite, __UNDEFINED)

4.466. SNMPSystemVariables

Name Description Schema

sysName
required

Value to be returned for system.sysName variable
Example : "string"

string

sysContact
required

Value to be returned for system.sysContact variable
Example : "string"

string

sysLocation
required

Value to be returned for system.sysLocation variable
Example : "string"

string

4.467. SNMPTrapDestination

Name Description Schema

trapDestinationRef
required

SNMP trap destination reference.
Example : "string"

string

trapReceiverIpAddress
required

IPVx address of the trap receiver
Example : "IpVxAddress"

IpVxAddress

communityRef
required

Community associated with the trap destination
Example : "string"

string

sendAuthenticationFailureTraps
required

Send authentication failure traps to this destination.
Example : true

boolean

4.468. Schedule

Name Description Schema

calendar
required

Daily, weekly, or monthly calendar information.
Example : "ScheduleCalendar"

ScheduleCalendar

startDate
required

The schedule will not run until this date/time, measured as seconds since midnight, January 1st, 1970 local time.
Example : "string"

string (int64)

recurrence
required

The number of days, weeks, or months to run.
Example : "Recurrence"

Recurrence

timezone
required

Specification of the time zone.
Example : "TimeZoneDescription"

TimeZoneDescription

4.469. ScheduleCalendar

Name Description Schema

scheduleMethod
required

This enumeration specifies the different types of scheduling methods.
Example : "string"

enum (unknown, daily, weekly, monthlyDate, monthlyDay, __UNDEFINED)

daily
optional

This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_DAILY.
Example : "ScheduleDaily"

ScheduleDaily

weekly
optional

This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_WEEKLY.
Example : "ScheduleWeekly"

ScheduleWeekly

monthlyByDate
optional

This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_MONTHLY_DATE.
Example : "ScheduleMonthlyByDate"

ScheduleMonthlyByDate

monthlyByDay
optional

This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_MONTHLY_DAY.
Example : "ScheduleMonthlyByDay"

ScheduleMonthlyByDay

4.470. ScheduleDaily

Name Description Schema

dailySchedule
required

Conveys time information, including time of day, recurrence and occurrence frequency.
Example : "DailySchedule"

DailySchedule

4.471. ScheduleInstance

Name Description Schema

schedRef
required

A reference to the schedule object.
Example : "string"

string

scheduleStatus
required

The current status of the schedule.
Example : "string"

enum (unknown, active, disabled, completed, __UNDEFINED)

action
required

The type of action to be taken.
Example : "string"

enum (unknown, resnap, newpit, newcgpit, __UNDEFINED)

targetObject
required

The object associated with schedule.
Example : "string"

string

schedule
required

The schedule information.
Example : "Schedule"

Schedule

creationTime
required

The schedule creation time (local time) measured as seconds since January 1, 1970.
Example : "string"

string (int64)

lastRunTime
required

The last run time (local time) measured as seconds since January 1, 1970.
Example : "string"

string (int64)

nextRunTime
required

The next run time (local time) measured as seconds since January 1, 1970.
Example : "string"

string (int64)

stopTime
required

The local time after which schedule is no longer active, measured as seconds since January 1, 1970.
Example : "string"

string (int64)

id
optional

Example : "string"

string

4.472. ScheduleMonthlyByDate

Name Description Schema

daysOfMonth
required

This is a bit mask. Values from the DayOfMonth enumeration should be added (or OR’ed) together to set this value.
Example : [ "string" ]

< enum (dayOfMonthLast, dayOfMonthNotSpecified, dayOfMonth01, dayOfMonth02, dayOfMonth03, dayOfMonth04, dayOfMonth05, dayOfMonth06, dayOfMonth07, dayOfMonth08, dayOfMonth09, dayOfMonth10, dayOfMonth11, dayOfMonth12, dayOfMonth13, dayOfMonth14, dayOfMonth15, dayOfMonth16, dayOfMonth17, dayOfMonth18, dayOfMonth19, dayOfMonth20, dayOfMonth21, dayOfMonth22, dayOfMonth23, dayOfMonth24, dayOfMonth25, dayOfMonth26, dayOfMonth27, dayOfMonth28, dayOfMonth29, __UNDEFINED, dayOfMonth30, dayOfMonth31) > array

monthsOfYear
required

This is a bit mask. Values from the MonthOfYear enumeration should be added (or OR’ed) together to set this value.
Example : [ "string" ]

< enum (notSpecified, january, february, march, april, may, june, july, august, september, october, november, december, __UNDEFINED) > array

dailySchedule
required

Conveys time information, including time of day, recurrence and occurrence frequency.
Example : "DailySchedule"

DailySchedule

4.473. ScheduleMonthlyByDay

Name Description Schema

dayOfWeek
required

The day of the week. This is NOT a bit mask.
Example : "string"

enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED)

dailySchedule
required

Conveys time information, including time of day, recurrence and occurrence frequency.
Example : "DailySchedule"

DailySchedule

weekNumber
required

The week number during the month. For example, 1 = first, 2 = second, etc., and 5 = last.
Example : 0

integer (int32)

monthsOfYear
required

This is a bit mask. Values from the MonthOfYear enumeration should be added (or OR’ed) together to set this value.
Example : [ "string" ]

< enum (notSpecified, january, february, march, april, may, june, july, august, september, october, november, december, __UNDEFINED) > array

4.474. ScheduleWeekly

Name Description Schema

daysOfWeek
required

This is a bit mask. Values from the DayOfWeek enumeration should be added (or OR’ed) together to set this value.
Example : [ "string" ]

< enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED) > array

dailySchedule
required

Conveys time information, including time of day, recurrence and occurrence frequency.
Example : "DailySchedule"

DailySchedule

4.475. SecuritySettings

Name Description Schema

certificateRevocationSettings
required

The certificate revocation settings.
Example : "CertificateRevocationSettings"

CertificateRevocationSettings

4.476. SnapshotVolume

Name Description Schema

worldWideName
required

The World Wide Name of the snapshot.
Example : "string"

string

snapshotRef
required

Reference (key) for the snapshot volume.
Example : "string"

string

label
required

Name of the snapshot.
Example : "string"

string

status
required

Indicates status of the snapshot.
Example : "string"

enum (active, failed, disabled, offline, __UNDEFINED)

action
required

Long running action.
Example : "string"

enum (none, rollback, __UNDEFINED)

currentManager
required

Current owner of the snapshot.
Example : "string"

string

baseVolume
required

Base volume for this snapshot.
Example : "string"

string

repositoryVolume
required

Repository volume for this snapshot.
Example : "string"

string

fullWarnThreshold
required

Repository utilization warning threshold.
Example : 0

integer (int32)

overWarnThreshold
required

True if the repository utilization is over the warning threshold.
Example : true

boolean

repositoryFull
required

True, if the repository is full.
Example : true

boolean

repFullPolicy
required

Indication of the volume behavior when the repository is full.
Example : "string"

enum (failwrites, failsnap, __UNDEFINED)

rollbackPriority
required

The importance of the rollback operation (0-4). Not used in this release of software.
Example : 0

integer (int32)

extentStart
required

The start position of the extent in the base volume (bytes). Not used in this release of software.
Example : "string"

string (int64)

extentSize
required

The size of the extent in bytes. Not used in this release of software.
Example : "string"

string (int64)

snapshotTime
required

The controller time when the snapshot was created.
Example : "string"

string (int64)

perms
required

Permissions allowed on volume.
Example : "VolumePerms"

VolumePerms

childrenInactive
required

True if all child volumes are offline or failed. Child volumes are the base volume and the REPOSITORY volume.
Example : true

boolean

volumeHandle
required

Volume SSID.
Example : 0

integer (int32)

mgmtClientAttribute
required

For use by management client.
Example : 0

integer (int32)

rollbackStatus
required

Status of current action being performed on snapshot.
Example : "string"

enum (none, inProgress, pending, paused, __UNDEFINED)

id
optional

Example : "string"

string

4.477. StagedFirmware

Name Description Schema

stagedFwValid
required

False, staged FW areas on the controllers are not valid and cannot be activated. True, the staged FW areas on the controllers are valid and can be activated.
Example : true

boolean

fwVersion
required

The firmware package version identifier.
Example : "string"

string

appVersion
required

The application code version number.
Example : "string"

string

bootVersion
required

The boot code version number.
Example : "string"

string

nvsramVersion
required

The NVSRAM version number.
Example : "string"

string

timeStamp
required

Timestamp when the staged FW was downloaded
Example : "string"

string (int64)

nvsramVersionString
required

The field is deprecated. The nvsramVersion field should be used instead.
Example : "string"

string

codeVersions
required

Version descriptors for staged code modules
Example : [ "VersionDescriptor" ]

< VersionDescriptor > array

4.478. StorageArray

Name Description Schema

saData
required

General information and characteristics of the storage array.
Example : "SAData"

SAData

safeId
required

This field contains a unique identifier maintained by SAFE for use by storage management software. Storage management software uses this data to enable SAFE features and perform Feature Bundle migration.
Example : "SAIdentifier"

SAIdentifier

cache
required

Information about cache settings that apply to the storage array as a whole.
Example : "SACache"

SACache

accessVolume
required

Information about the access volume that is used to convey configuration commands (via the UTM protocol) to the controllers within the storage array.
Example : "AccessVolume"

AccessVolume

featureParameters
required

An object that provides information about the parameters and limits of certain functions that are supported by the controllers that reside within the storage array.
Example : "FeatureParams"

FeatureParams

mediaScanPeriod
required

The current value of the media scan period parameter for the storage array. This value indicates the number of days over which a complete scan of the media will occur. The array controller(s) will attempt to achieve this configured period on a best-effort basis, but certain operational factors may cause slight deviations from the configured value.
Example : 0

integer (int32)

capabilities
required

A variable-length array that provides an enumeration of the high-level capabilities that are supported by the controllers that reside within the storage array.
Example : [ "string" ]

< enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, __UNDEFINED) > array

premiumFeatures
required

An object that provides information about the premium features that are currently enabled. This field is deprecated. The featureBundle and featureState fields can be used in its place to obtain information about how features are defined and the state they are in.
Example : [ "PremiumFeature" ]

< PremiumFeature > array

trayPositionList
required

A list of tray positions that provides information to the client of the SYMbol interface about the relative physical positions of the trays (i.e. enclosures) that comprise the storage array. In the current implementation of the SYMbol interface, the client is responsible for providing this information to the controller for long-term storage, and also for retrieving it from the controller via this object. That is, the controller does not initially contain a valid tray position list; in fact, the default is an empty list. The client is responsible for obtaining any pertinent information about tray positions via an appropriate external mechanism, and then informing the controller about it via the setSATrayPositions procedure. Once this is done, the controller will always return the position information as part of the StorageArray object.
Example : "TrayPositionList"

TrayPositionList

hostPortType
required

This variable-length array has label values that provide descriptive strings for each supported index value that can appear in the HostPort object and its associated elements.
Example : [ "string" ]

< string > array

hostSpecificVals
required

The values from the heterogeneous host regions. Each element in this array corresponds to a type in the hostPortType array, and the ordering of the types in this array matches that of the hostPortType array, i.e., hostPortType[i] is equal to hostSpecificVals[i].hostPortType.
Example : [ "HostSpecificValues" ]

< HostSpecificValues > array

compatibility
required

A variable-length array of firmware compatibility specifiers. These values generally identify certain levels of firmware that are allowed for downgrading the current storage array firmware.
Example : [ "CompatibleFirmware" ]

< CompatibleFirmware > array

usageHints
required

The recommended usage parameter combinations.
Example : [ "VolumeUsageHint" ]

< VolumeUsageHint > array

definedPartitionCount
required

The number of partitions calculated from the user’s current mappings.
Example : 0

integer (int32)

defaultHostPortTypeIndex
required

The Host Port Type Index to use for undefined and newly created host ports. The defaultHostPortTypeIndex can only be set if Storage Partitions are disabled through the SYMbol Interface.
Example : 0

integer (int32)

remoteAccessID
required

Array-specific ID used for remote device discovery.
Example : "string"

string

remoteMirroringActive
required

True if RVM is activated.
Example : true

boolean

volXferAlertDelayPeriod
required

Volume transfer alert delay period.
Example : 0

integer (int32)

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

stagedFirmware
required

Information on possible staged controller firmware.
Example : "StagedFirmware"

StagedFirmware

unreadableSectors
required

Storage array unreadable sector count and max limit.
Example : "UnreadableSectors"

UnreadableSectors

driveChannels
required

A list of drive channel structures.
Example : [ "DriveChannel" ]

< DriveChannel > array

portLocations
required

A list of drive channel port locations.
Example : [ "DriveChannelPort" ]

< DriveChannelPort > array

ddcTag
required

The tag value to be used in retrieving DDC log data. A value of DDC_NULL_TAG indicates there is no DDC log data to retrieve.
Example : 0

integer (int32)

featureBundle
required

A structure describing the features and feature limits that are associated with this storage array product.
Example : "FeatureBundle"

FeatureBundle

featureState
required

An array describing the current state of the array feature set - one element in the array per feature. This array is used by host software to track feature licensing compliance. It is populated with all supported features having both a feature ID and a capability code, regardless of their enabled or compliance state. Features that are not supported because of gold key restrictions or because there is no way to enable them (i.e., both SHIPPED_ENABLED and KEY_ENABLED are false) are not in the list.
Example : [ "FeatureState" ]

< FeatureState > array

channelPortLocations
required

A list of all channel ports in the storage array, including host channel ports, drive channel ports, and ESM channel ports.
Example : [ "ChannelPort" ]

< ChannelPort > array

iscsiEntityData
required

Information about the storage array pertaining to its role as an iSCSI entity.
Example : "IscsiEntityData"

IscsiEntityData

hostType
required

This variable-length array has label values that provide descriptive strings for each supported index value that can appear in the Host object. Zero-length strings are allowed and indicate that the associated host-specific NVSRAM regions have been cleared. This field should be used in place of the deprecated hostPortType field.
Example : [ "string" ]

< string > array

defaultHostTypeIndex
required

The Host Type Index to use for undefined and newly created host ports.
Example : 0

integer (int32)

rvmControllerHostChannel
required

The number (in the range 1 through n, where n is the number of host ports on an individual controller) of the controller host channel that the firmware uses for remote volume mirroring. This field is set to zero when the data is unavailable or not applicable, including when the RVM feature is disabled,
Example : 0

integer (int32)

smartBatteryData
required

sub-structure of StorageArray contains info relating to smart battery configuration. Meaningful if the smartBatteryTechnology field in the featureParameters sub-structure is set to true. Moved to the Battery object instead to support per-battery reporting
Example : "SmartBatteryData"

SmartBatteryData

invalidSystemConfig
required

True if the storage array has an invalid system configuration; otherwise false.
Example : true

boolean

securityLockKey
required

A boolean which describes the current state of the lock key. True if the array lock key has been set, otherwise false.
Example : true

boolean

lockKeyIDRef
required

The lock key ID for the storage array.
Example : "string"

string

syslogConfiguration
required

This field contains the configuration information used by the storage array for writing MEL events to a syslog server.
Example : "SyslogConfiguration"

SyslogConfiguration

securityExternalKmsEnable
required

True if external key management is in effect and false if controller is using local key management.
Example : true

boolean

newKeySequence
required

Sequence number used to serialize installNewKey requests from multiple proxy key management SYMbol servers.
Example : 0

integer (int32)

securityExternalKmsKeyStatus
required

The controller’s current key status. If external key management not enabled, set to EXTERNAL_KMS_KEY_STATUS_OK.
Example : "string"

enum (ok, keyNeeded, newKeyNeeded, validationNeeded, __UNDEFINED)

lockKeyNeededList
required

Contains the lock key IDs of keys needed by the array controller.
Example : [ "string" ]

< string > array

dplCoreDumpData
required

Information about a core dump in controller memory, if one exists.
Example : "DPLCoreDumpData"

DPLCoreDumpData

fcRVMState
required

Indicator of whether fibre channel remote mirroring has been enabled, and if so, whether it is enabled for use by legacy (synchronous) mirroring or ARVM. If this is set to something other than FC_MIRROR_STATE_DISABLED or FC_MIRROR_STATE_UNKNOWN, then the rvmControllerHostChannel field can be used to determine the particular host channel reserved for remote mirroring.
Example : "string"

enum (unknown, disabled, enabledLegacyRvm, enabledArvm, enabledAll, __UNDEFINED)

asupEnabled
required

True if Autosupport is enabled.
Example : true

boolean

asupOnDemandEnabled
required

True if Autosupport On Demand is enabled.
Example : true

boolean

asupRemoteDiagsEnabled
required

True if Autosupport On Demand Remote Diagnostics is enabled.
Example : true

boolean

iocDumpData
required

Information about an IOC Dump in controller memory, if one exists.
Example : "IOCDumpData"

IOCDumpData

driveChannelPortDisabled
required

True if one or more drive channel ports have been disabled by the controllers to protect against faulty expansion cabling. This could have been necessitated by a miswire condition or by a bad expansion cable. Check the Recovery Events for an indication of which connection(s) have been disabled and correct the cabling as required.
Example : true

boolean

directExpansionPortInUse
required

This boolean is true if direct expansion ports are in use by the controllers.
Example : true

boolean

highResolutionStatisticsEnabled
required

Cumulative Performance stats high resolution indicator
Example : true

boolean

autoLoadBalancingEnabled
required

Auto Load Balancing is user-enabled on this array
Example : true

boolean

reserved3
required

This reserved field is needed to maintain compatibility with host applications.
Example : "string"

string

embeddedExternalKMSInformation
required

This structure contains the external key management information. See the structure definition for details.
Example : "EmbeddedExternalKMSInformation"

EmbeddedExternalKMSInformation

isLun0RestrictedForDefaultPartition
required

Provides an indication of whether LUN 0 is restricted (disallowed) for the default storage partition.
Example : true

boolean

securitySettings
required

Storage array security settings.
Example : "SecuritySettings"

SecuritySettings

parityCheckOnMediaType
required

Indicate whether or not P and Q parity validation is performed on certain drive media types during reconstruction of RAID 6 and disk pool volumes on the Storage Array.
Example : "ParityCheckOnMediaType"

ParityCheckOnMediaType

hostConnectivityReportingEnabled
required

If host connectivity reporting is enabled/disabled for the the array.
Example : true

boolean

vaaienabled
optional

Example : true

boolean

odxenabled
optional

Example : true

boolean

4.479. StoragePoolBundle

Name Description Schema

saPortGroup
required

A variable-length array containing all SAPortGroup objects that are currently configured and available.
Example : [ "SAPortGroup" ]

< SAPortGroup > array

saPort
required

A variable-length array containing all SAPortGroup objects that are currently configured and available.
Example : [ "SAPort" ]

< SAPort > array

cluster
required

A variable-length array containing all defined Cluster objects for the storage array configuration.
Example : [ "Cluster" ]

< Cluster > array

host
required

A variable-length array containing all defined Host objects for the storage array configuration.
Example : [ "Host" ]

< Host > array

hostPort
required

A variable-length array containing all defined HostPort objects for the storage array configuration.
Example : [ "HostPort" ]

< HostPort > array

lunMapping
required

A variable-length array containing all defined LUNMapping objects for the storage array configuration.
Example : [ "LUNMapping" ]

< LUNMapping > array

initiator
required

A variable-length array containing all Initiator objects defined in the storage array configuration.
Example : [ "Initiator" ]

< Initiator > array

target
required

A variable-length array containing all Target objects defined in the storage array configuration.
Example : [ "Target" ]

< Target > array

remoteTarget
required

A variable-length array containing all Remote Target objects defined in the storage array configuration. Remote Target objects define the initiator/target on a remote array.
Example : [ "RemoteTarget" ]

< RemoteTarget > array

4.480. SyslogConfiguration

Name Description Schema

syslogEnabled
required

This field is set to true if the writing of MEL events to a syslog server is enabled; otherwise it is false.
Example : true

boolean

syslogServerPortNumber
required

This field holds the UDP port number of the syslog server. The default value of this field is SYSLOG_DEFAULT_UDP_PORT.
Example : 0

integer (int32)

syslogServerIpAddress
required

This field holds the IPVx address of the syslog server. The default value of this field is zero (0.0.0.0).
Example : "IpVxAddress"

IpVxAddress

4.481. ThinVolume

Name Description Schema

volumeHandle
required

The volumeHandle (SSID) for this volume.
Example : 0

integer (int32)

worldWideName
required

The World wide name of the volume.
Example : "string"

string

label
required

The name of the volume.
Example : "string"

string

allocationGranularity
required

The allocation cluster size for the Expandable Repository Volume.
Example : 0

integer (int32)

capacity
required

The virtual capacity of the volume in bytes.
Example : "string"

string (int64)

reconPriority
required

Importance of fixing the volume if failed (0-4).
Example : 0

integer (int32)

volumeRef
required

The reference (key) for this volume.
Example : "string"

string

status
required

The operational status of the volume.
Example : "string"

enum (unknown, optimal, full, overThresh, failed, initializing, __UNDEFINED)

repositoryRef
required

The Expandable Repository Volume underlying this Thin Volume.
Example : "string"

string

currentManager
required

The controller that currently manages the volume.
Example : "string"

string

preferredManager
required

The controller that should manage the volume.
Example : "string"

string

perms
required

Operations allowed on this volume.
Example : "VolumePerms"

VolumePerms

mgmtClientAttribute
required

For use by management client.
Example : 0

integer (int32)

preReadRedundancyCheckEnabled
required

If true, verify RAID redundancy on read operations.
Example : true

boolean

protectionType
required

The protection type of the volume.
Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

applicationTagOwned
required

True if application tag is owned by the storage array.
Example : true

boolean

maxVirtualCapacity
required

The maximum virtual capacity to which this thin volume can grow (in bytes).
Example : "string"

string (int64)

initialProvisionedCapacity
required

The initial provisioned capacity for the Expandable Repository Volume for this thin volume (in bytes).
Example : "string"

string (int64)

currentProvisionedCapacity
required

The current provisioned capacity of the Expandable Repository Volume (in bytes).
Example : "string"

string (int64)

provisionedCapacityQuota
required

The maximum capacity of the Expandable Repository Volume (in bytes).
Example : "string"

string (int64)

growthAlertThreshold
required

The percent value at which an alert is generated.
Example : 0

integer (int32)

expansionPolicy
required

The automatic Expandable Repository Volume expansion policy.
Example : "string"

enum (unknown, manual, automatic, __UNDEFINED)

volumeCache
required

The cache parameters of the underlying repository.
Example : "VolumeCache"

VolumeCache

offline
required

The thin volume is offline due to the associated repository volume state.
Example : true

boolean

reportingPolicy
required

Indicates how the thin volume is reported on the SCSI interface.
Example : "string"

enum (unknown, asThick, asThin, __UNDEFINED)

extendedUniqueIdentifier
required

A variable-length opaque field that provides the volume’s extended unique identification value.
Example : "string"

string

id
optional

Example : "string"

string

4.482. TimeZoneDescription

Name Description Schema

tzLabel
required

The time zone identifier (ASCII).
Example : "string"

string

tzOffset
required

The time zone offset measured in seconds +/- from GMT.
Example : 0

integer (int32)

dstStart
required

The DST start date and time.
Example : "DaylightSavingsTime"

DaylightSavingsTime

dstEnd
required

The DST end date and time.
Example : "DaylightSavingsTime"

DaylightSavingsTime

dstAdjust
required

The number of seconds to adjust the clock during DST
Example : 0

integer (int32)

4.483. TrayPosition

Name Description Schema

trayId
required

The tray ID of the tray.
Example : 0

integer (int32)

rackId
required

An identifier of the enclosure (i.e. rack) in which the tray resides. This is not supported in the current release of the firmware.
Example : 0

integer (int32)

4.484. TrayPositionList

Name Description Schema

trayPosition
required

A variable-length array of TrayPosition objects.
Example : [ "TrayPosition" ]

< TrayPosition > array

4.485. UnreadableSectors

Name Description Schema

count
required

The current number of unreadable sectors persisted.
Example : 0

integer (int32)

maxLimit
required

The maximum number of unreadable sectors allowed.
Example : 0

integer (int32)

4.486. Ups

Name Description Schema

upsRef
required

The reference for this physical UPS.
Example : "string"

string

status
required

The operational status of the UPS.
Example : "string"

enum (optimal, onBattery, __UNDEFINED)

physicalLocation
required

The physical location of the UPS. Note that the tray reference identifies the enclosure containing the UPS, but the slot information does not apply to this component.
Example : "Location"

Location

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

4.487. Volume

Name Description Schema

offline
required

An indication of whether the volume is currently offline.
Example : true

boolean

extremeProtection
required

An indication of whether the volume is configured for extreme protection. Such configurations generally call for extensive consistency checks and parity validations with each I/O request to the volume.
Example : true

boolean

volumeHandle
required

The internal identifier value associated with this volume. When the Storage Partitions feature is NOT present, this value represents the logical unit number (LUN) that is used to access the volume via the host I/O path. If the Storage Partitions feature IS enabled, this field has no external meaning.
Example : 0

integer (int32)

raidLevel
required

The RAID level for which this volume is configured.
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

sectorOffset
required

The sector offset of this volume within its volume group. This value is provided only to allow the client application to determine the relative positions of multiple volumes within a given volume group. No other assumptions or computations should be made with this value.
Example : "string"

string (int64)

worldWideName
required

A variable-length opaque field that provides the volume’s worldwide unique identification value.
Example : "string"

string

label
required

The user-assigned symbol label associated with the volume.
Example : "string"

string

blkSize
required

The block size (in bytes) of the volume.
Example : 0

integer (int32)

capacity
required

The capacity (in bytes) of the volume.
Example : "string"

string (int64)

reconPriority
required

The reconstruction priority value for the volume. This value is in the range 0-4, with 0 indicating that reconstruction is favored over any I/O, and 4 indicating that reconstruction should be performed with minimal impact to I/O. Intermediate values indicate various levels of compromise between these two extremes.
Example : 0

integer (int32)

segmentSize
required

The segment size (in bytes) of the volume. The segment size is, for the most part, an indication of the stripe depth used to lay out the volume’s block addresses.
Example : 0

integer (int32)

action
required

An indication of what current long-running activity, if any, is currently in progress on the volume.
Example : "string"

enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED)

cache
required

The volume-specific caching parameters currently in effect for the volume.
Example : "VolumeCache"

VolumeCache

mediaScan
required

The volume-specific media scan settings currently in effect for the volume.
Example : "VolumeMediaScanParams"

VolumeMediaScanParams

volumeRef
required

The unique identification value for this volume. Other objects may use this reference value to refer to the volume.
Example : "string"

string

status
required

The current operational state of the volume.
Example : "string"

enum (optimal, degraded, failed, impaired, creating, deleting, __UNDEFINED)

volumeGroupRef
required

The volume group reference value of the volume group on which this volume resides.
Example : "string"

string

currentManager
required

The reference value of the controller that currently owns (i.e. manages) this volume. In non-AVT (Auto Volume Transfer) mode, host I/O access to the blocks in this volume is permitted only through the controller that is the current manager. In AVT mode, an I/O access to the controller that is not the current manager causes it to automatically become the current manager.
Example : "string"

string

preferredManager
required

The reference value of the controller that is the preferred manager of the volume. The preferred manager is tracked independent of the current manager, since the current manager may be switched dynamically as a result of host-base multi-path transitions. Later, when the error conditions that cause a multi-path transition have been corrected it is still possible to determine the preferred manager and switch ownership back to it.
Example : "string"

string

perms
required

Operations allowed on this volume.
Example : "VolumePerms"

VolumePerms

mgmtClientAttribute
required

For use by management client.
Example : 0

integer (int32)

dssPreallocEnabled
required

True if dynamic segment sizing pre-allocation is enabled for the volume.
Example : true

boolean

dssMaxSegmentSize
required

The maximum segment size (in bytes) that this volume could assume with the dynamic segment sizing feature. This field is only meaningful if dssPreallocEnabled is true.
Example : 0

integer (int32)

preReadRedundancyCheckEnabled
required

If set to true, then the storage controller will, on READ operations, verify the consistency of RAID redundancy data for the stripe(s) containing the READ data.
Example : true

boolean

protectionInformationCapable
required

This field is no longer used.
Example : true

boolean

protectionType
required

The protection type of the volume.
Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

applicationTagOwned
required

True if application tag is owned by the storage array.
Example : true

boolean

repairedBlockCount
required

This element contains a count of the number of blocks in the volume that have had data assurance errors repaired.
Example : 0

integer (int32)

extendedUniqueIdentifier
required

A variable-length opaque field that provides the volume’s extended unique identification value.
Example : "string"

string

cacheMirroringValidateProtectionInformation
required

True if checking of protection information during cache mirroring is enabled for this volume, false otherwise
Example : true

boolean

expectedProtectionInformationAppTag
required

Expected Protection Information Application Tag for the volume
Example : 0

integer (int32)

name
optional

Example : "string"

string

id
optional

Example : "string"

string

4.488. VolumeCache

Name Description Schema

cwob
required

A true value means that the controller is allowed to use write-back caching of dirty data even when the cache memory’s battery-backup protection is not available or not operational. A false value means that any problems with the battery-backup protection of the write cache will cause the controller to suspend all write-back caching operations for the volume.
Example : true

boolean

enterpriseCacheDump
required

A true value means that all dirty data in the write cache will be flushed immediately and further write-back caching will be disabled if the controller detects that a UPS unit has switched from standard power to battery backup. A false value means that write-back caching is not impacted by the state of the UPS.
Example : true

boolean

mirrorActive
required

An indication of whether the cache mirroring option is active for the volume’s data.
Example : true

boolean

mirrorEnable
required

An indication of whether the cache mirroring feature is currently enabled for this volume. It is possible that the mirrorEnable and mirrorActive values differ; this may occur, for example, if the alternate controller is removed or failed.
Example : true

boolean

readCacheActive
required

An indication of whether read caching is active for the volume.
Example : true

boolean

readCacheEnable
required

An indication of whether read caching is enabled for the volume. Note that this value may not match the readCacheActive setting in cases where problems with the controller cache or its battery back-up have been detected.
Example : true

boolean

writeCacheActive
required

An indication of whether write-back caching is active for the volume.
Example : true

boolean

writeCacheEnable
required

An indication of whether write-back caching is enabled for the volume. Note that this value may not match the writeCacheActive setting in cases where problems with the controller cache or its battery back-up have been detected.
Example : true

boolean

cacheFlushModifier
required

The cache flush modifier value, which is used to specify the maximum amount of time that dirty data for this volume may be retained in the controller’s write cache prior to being flushed to disk.
Example : "string"

enum (flushImmediate, flush250Msec, flush500Msec, flush750Msec, flush1Sec, flush1500Msec, flush2Sec, flush5Sec, flush10Sec, flush20Sec, flush60Sec, flush120Sec, flush300Sec, flush1200Sec, flush3600Sec, flushInfinite, __UNDEFINED)

readAheadMultiplier
required

A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled.
Example : 0

integer (int32)

4.489. VolumeCopy

Name Description Schema

worldWideName
required

The World Wide Name of the volume copy.
Example : "string"

string

volcopyHandle
required

The Volume Copy ID(ssid of proxy).
Example : 0

integer (int32)

volcopyRef
required

Reference (key) for copy.
Example : "string"

string

status
required

Indicates status of copy.
Example : "string"

enum (inProgress, complete, halted, failed, pending, __UNDEFINED)

sourceVolume
required

Source volume reference.
Example : "string"

string

targetVolume
required

Target volume reference.
Example : "string"

string

currentManager
required

Current owner of copy.
Example : "string"

string

idleTargetWriteProt
required

Apply write protection to target volume when copy is idle (true/false).
Example : true

boolean

copyCompleteTime
required

Time copy operation completed.
Example : "string"

string (int64)

copyStartTime
required

Time copy operation began.
Example : "string"

string (int64)

copyPriority
required

Importance of copy operation.
Example : "string"

enum (priority0, priority1, priority2, priority3, priority4, __UNDEFINED)

reserved1
optional

Example : "string"

string

cloneCopy
required

The volume copy is a clone.
Example : true

boolean

pgRef
required

For clones based on PiT Groups, this will identify the PiT Group.
Example : "string"

string

id
optional

Example : "string"

string

4.490. VolumeGroup

Name Description Schema

sequenceNum
required

A sequence number that uniquely identifies this volume group within the array in which it resides. Sequence numbers are assigned to volume groups when they are created or imported into a storage array. The controller assigns the lowest unused sequence number during a creation or import operation.
Example : 0

integer (int32)

offline
required

An indication of whether the volume group is currently offline. A volume group can be taken offline by the operator in preparation for removing its drives and transporting them to another storage array.
Example : true

boolean

raidLevel
required

The RAID level associated with this volume group. If the storage array supports multiple RAID levels per volume group, this value will be set to RAID_ALL. Otherwise, it will indicate the precise RAID level defined for the volume group.
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

worldWideName
required

A variable-length opaque field that provides the volume group’s worldwide unique identification value.
Example : "string"

string

volumeGroupRef
required

The unique identification value for this volume group. Other objects may use this reference value to refer to the volume group.
Example : "string"

string

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

trayLossProtection
required

An indication as to whether the volume group has tray loss protection.
Example : true

boolean

label
required

The volume group label, which can be set by the user.
Example : "string"

string

state
required

The state of the volume group.
Example : "string"

enum (contingent, exported, forced, complete, partial, incomplete, missing, __UNDEFINED)

spindleSpeedMatch
required

Set to true if all of the drives in the group have matching normalized spindle speeds. (Normalized spindle speeds are standardized norms (e.g., 5400, 7200, etc.) that are used for spindle speed matching, even though actual spindle speeds may be within a designated delta of the normalized speed.)
Example : true

boolean

spindleSpeed
required

Set to true if all of the drives in the group have matching normalized spindle speeds. (Normalized spindle speeds are standardized norms (e.g., 5400, 7200, etc.) that are used for spindle speed matching, even though actual spindle speeds may be within a designated delta of the normalized speed.)
Example : 0

integer (int32)

isInaccessible
required

True if the volume group contains incompatible drives that have been locked out.
Example : true

boolean

securityType
required

security status of the drive group
Example : "string"

enum (unknown, none, capable, enabled, __UNDEFINED)

drawerLossProtection
required

This field is set to true when the volume group has drawer loss protection; otherwise it is set to false
Example : true

boolean

protectionInformationCapable
required

This field is no longer used.
Example : true

boolean

protectionInformationCapabilities
required

This structure contains a protectionInformationCapable field which is set to true if all drives in the volume group are Protection Information (PI) capable. It also contains a field that is set to the protection type for the volume group.
Example : "ProtectionInformationCapabilities"

ProtectionInformationCapabilities

volumeGroupData
required

Information about the Volume Group.
Example : "VolumeGroupTypeData"

VolumeGroupTypeData

usage
required

the volume group usage.
Example : "string"

enum (unknown, standard, flashcache, __UNDEFINED)

driveBlockFormat
required

Identifies the drive block format of the volume candidate.
Example : "string"

enum (unknown, allNative, allEmulated, mixed, __UNDEFINED)

reservedSpaceAllocated
required

This field will be used to report whether or not reserved space has been claimed on all drives in the volume group. The recovery-volume script will include this field for each volume group record it creates, so that during volume recovery the volume group is recreated correctly.
Example : true

boolean

securityLevel
required

Refines the information in the securityType field to describe the set of drives.
Example : "string"

enum (unknown, none, mixed, fde, fips, __UNDEFINED)

name
optional

Example : "string"

string

id
optional

Example : "string"

string

4.491. VolumeGroupTypeData

Name Description Schema

type
required

This enumeration is used to indicate the type of the volume group.
Example : "string"

enum (unknown, traditional, diskPool, __UNDEFINED)

diskPoolData
optional

This field is present only if the value of type is equal to VG_TYPE_DISK_POOL.
Example : "DiskPoolData"

DiskPoolData

4.492. VolumeUsageHint

Name Description Schema

usageHint
required

How the volume will be used (e.g. multimedia, transactional, file system).
Example : "string"

enum (multimedia, transactional, filesystem, __UNDEFINED)

segmentSize
required

The volume segment size.
Example : 0

integer (int32)

readAhead
required

A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled.
Example : 0

integer (int32)

4.493. Workload

Name Description Schema

workloadRef
required

The unique handle for the object contained within this structure (a 1st class object).
Example : "string"

string

description
required

The workload description describes the workload (not the workload type).
Example : "string"

string

4.494. WorkloadVolumeMapping

Name Description Schema

mappingRef
required

This field is the unique identifier for the mapping between the workload and the volume.
Example : "string"

string

workloadRef
required

This field is the unique identifier for the Workload.
Example : "string"

string

volumeRef
required

This field is the unique identifier for the volume.
Example : "string"

string

4.495. PasswordStatusResponse

Indicate if the passwords are set on the storage array

Name Description Schema

adminPasswordSet
required

Example : true

boolean

readOnlyPasswordSet
required

Example : true

boolean

4.496. PasswordSetRequest

Passed in to set the passwords. The security on this call is a little different. If the admin password is <n>not</b> set and adminPassword is true, than this call is allowed. If the admin password is set, then the user must have a valid login session as admin

Name Description Schema

currentAdminPassword
required

The current admin password
Example : "string"

string

adminPassword
required

If this is true, this call will set the admin password, if false, it sets the RO password
Example : true

boolean

newPassword
required

The new password
Example : "string"

string

4.497. RemoteMirrorPair

Name Description Schema

base
required

Example : "VolumeEx"

VolumeEx

target
required

Example : "VolumeEx"

VolumeEx

baseArray
required

Example : "string"

string

targetArray
required

Example : "string"

string

id
required

Example : "string"

string

lastStartTime
required

Example : "string"

string (date-time)

lastCompleteTime
required

Example : "string"

string (date-time)

state
required

Example : 0

integer (int32)

priority
required

Example : 0

integer (int32)

writeMode
required

Example : 0

integer (int32)

autoResync
required

Example : true

boolean

featureActive
required

Example : true

boolean

status
required

Example : "string"

enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED)

baseStatus
required

Example : "string"

enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED)

targetStatus
required

Example : "string"

enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED)

4.498. VolumeEx

Name Description Schema

offline
required

An indication of whether the volume is currently offline.
Example : true

boolean

extremeProtection
required

An indication of whether the volume is configured for extreme protection. Such configurations generally call for extensive consistency checks and parity validations with each I/O request to the volume.
Example : true

boolean

volumeHandle
required

The internal identifier value associated with this volume. When the Storage Partitions feature is NOT present, this value represents the logical unit number (LUN) that is used to access the volume via the host I/O path. If the Storage Partitions feature IS enabled, this field has no external meaning.
Example : 0

integer (int32)

raidLevel
required

The RAID level for which this volume is configured.
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

sectorOffset
required

The sector offset of this volume within its volume group. This value is provided only to allow the client application to determine the relative positions of multiple volumes within a given volume group. No other assumptions or computations should be made with this value.
Example : "string"

string (int64)

worldWideName
required

A variable-length opaque field that provides the volume’s worldwide unique identification value.
Example : "string"

string

label
required

The user-assigned symbol label associated with the volume.
Example : "string"

string

blkSize
required

The block size (in bytes) of the volume.
Example : 0

integer (int32)

capacity
required

The capacity (in bytes) of the volume.
Example : "string"

string (int64)

reconPriority
required

The reconstruction priority value for the volume. This value is in the range 0-4, with 0 indicating that reconstruction is favored over any I/O, and 4 indicating that reconstruction should be performed with minimal impact to I/O. Intermediate values indicate various levels of compromise between these two extremes.
Example : 0

integer (int32)

segmentSize
required

The segment size (in bytes) of the volume. The segment size is, for the most part, an indication of the stripe depth used to lay out the volume’s block addresses.
Example : 0

integer (int32)

action
required

An indication of what current long-running activity, if any, is currently in progress on the volume.
Example : "string"

enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED)

cache
required

The volume-specific caching parameters currently in effect for the volume.
Example : "VolumeCache"

VolumeCache

mediaScan
required

The volume-specific media scan settings currently in effect for the volume.
Example : "VolumeMediaScanParams"

VolumeMediaScanParams

volumeRef
required

The unique identification value for this volume. Other objects may use this reference value to refer to the volume.
Example : "string"

string

status
required

The current operational state of the volume.
Example : "string"

enum (optimal, degraded, failed, impaired, creating, deleting, __UNDEFINED)

volumeGroupRef
required

The volume group reference value of the volume group on which this volume resides.
Example : "string"

string

currentManager
required

The reference value of the controller that currently owns (i.e. manages) this volume. In non-AVT (Auto Volume Transfer) mode, host I/O access to the blocks in this volume is permitted only through the controller that is the current manager. In AVT mode, an I/O access to the controller that is not the current manager causes it to automatically become the current manager.
Example : "string"

string

preferredManager
required

The reference value of the controller that is the preferred manager of the volume. The preferred manager is tracked independent of the current manager, since the current manager may be switched dynamically as a result of host-base multi-path transitions. Later, when the error conditions that cause a multi-path transition have been corrected it is still possible to determine the preferred manager and switch ownership back to it.
Example : "string"

string

perms
required

Operations allowed on this volume.
Example : "VolumePerms"

VolumePerms

mgmtClientAttribute
required

For use by management client.
Example : 0

integer (int32)

dssPreallocEnabled
required

True if dynamic segment sizing pre-allocation is enabled for the volume.
Example : true

boolean

dssMaxSegmentSize
required

The maximum segment size (in bytes) that this volume could assume with the dynamic segment sizing feature. This field is only meaningful if dssPreallocEnabled is true.
Example : 0

integer (int32)

preReadRedundancyCheckEnabled
required

If set to true, then the storage controller will, on READ operations, verify the consistency of RAID redundancy data for the stripe(s) containing the READ data.
Example : true

boolean

protectionInformationCapable
required

This field is no longer used.
Example : true

boolean

protectionType
required

The protection type of the volume.
Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

applicationTagOwned
required

True if application tag is owned by the storage array.
Example : true

boolean

repairedBlockCount
required

This element contains a count of the number of blocks in the volume that have had data assurance errors repaired.
Example : 0

integer (int32)

extendedUniqueIdentifier
required

A variable-length opaque field that provides the volume’s extended unique identification value.
Example : "string"

string

cacheMirroringValidateProtectionInformation
required

True if checking of protection information during cache mirroring is enabled for this volume, false otherwise
Example : true

boolean

expectedProtectionInformationAppTag
required

Expected Protection Information Application Tag for the volume
Example : 0

integer (int32)

volumeUse
optional

Example : "string"

enum (standardVolume, repositoryVolume, mirrorTargetVolume, mirrorSourceVolume, concatVolume, freeRepositoryVolume, asyncMirrorSourceVolume, asyncMirrorTargetVolume)

volumeFull
optional

Example : true

boolean

volumeCopyTarget
optional

This value is true if the volume is currently the target of a volume copy pair.
Example : true

boolean

volumeCopySource
optional

This value is true if the volume is currently the source in a volume copy pair.
Example : true

boolean

pitBaseVolume
optional

Example : true

boolean

asyncMirrorTarget
optional

This value is true if the volume is currently the target in an Asynchronous Mirror relationship.
Example : true

boolean

asyncMirrorSource
optional

This value is true if the volume is currently the source in an Asynchronous Mirror relationship.
Example : true

boolean

remoteMirrorSource
optional

True if the volume is a source (primary), in an Remote Volume Mirror relationship.
Example : true

boolean

remoteMirrorTarget
optional

True if the volume is a target (secondary), in an Remote Volume Mirror relationship.
Example : true

boolean

diskPool
optional

True if the volume was defined on a DiskPool.
Example : true

boolean

flashCached
optional

True if this volume is added to a flashCache.
Example : true

boolean

increasingBy
optional

If a Dynamic Volume Expansion (DVE) is in progress, the total capacity the volume is being increased by, otherwise zero.
Example : "string"

string (int64)

metadata
optional

Metadata associated with the volume
Example : [ "VolumeMetadataItem" ]

< VolumeMetadataItem > array

dataAssurance
optional

Example : true

boolean

name
optional

Example : "string"

string

id
optional

Example : "string"

string

objectType
optional

Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

wwn
optional

Example : "string"

string

mapped
required

Example : true

boolean

cacheSettings
required

The volume-specific caching parameters currently in effect for the volume.
Example : "VolumeCache"

VolumeCache

preferredControllerId
optional

Example : "string"

string

totalSizeInBytes
optional

Example : "string"

string (int64)

onlineVolumeCopy
optional

Example : true

boolean

listOfMappings
optional

Example : [ "LUNMapping" ]

< LUNMapping > array

currentControllerId
optional

Example : "string"

string

thinProvisioned
optional

Example : true

boolean

4.499. VolumeMetadataItem

Key/Value pair for volume meta data

Name Description Schema

key
optional

They key for the property. Some keys are reserved include:workload
Example : "string"

string

value
optional

The value associated with the key
Example : "string"

string

4.500. RemoteVolumeMirrorCreateRequest

Creates new Remote Volume Mirror

Name Description Schema

srcVolID
required

Remote Volume Mirror source volume ID.
Example : "string"

string

tgtVolWWN
required

Example : "string"

string

remoteArrayId
required

Example : "string"

string

copyType
required

Example : 0

integer (int32)

priority
required

Example : 0

integer (int32)

autoResync
required

Example : true

boolean

4.501. RemoteVolumeMirrorUpdateRequest

Updates the RemoteVolumeMirror Data.

Name Description Schema

baseVolumeId
required

Remote Volume Mirror base volume.
Example : "string"

string

remoteVolumeId
required

Remote Volume Mirror remote volume.
Example : "string"

string

role
optional

Remote Volume Mirror role. 0, set role to primary. 1, set role to secondary
Example : 0

integer (int32)

updateType
required

Remote Volume Mirror update type request.
Example : "string"

enum (suspend, resume, resync, roleChange, updateParams)

priority
optional

Example : 0

integer (int32)

writeMode
optional

Example : 0

integer (int32)

autoResync
optional

Example : true

boolean

4.502. RemoteCommunicationData

Name Description Schema

samples
required

Example : [ 0 ]

< integer (int32) > array

timeout
required

Example : 0

integer (int32)

status
required

Example : 0

integer (int32)

4.503. JobProgress

A Volume Copy Job Control provides the start-stop operation for a <a href="VolumeCopyPair.html">Volume Copy Job</a> and reports the copy progress of the volume copy job. <br/><br/> The valid values for the PUT control attribute are "start" and "stop"

Name Description Schema

objectId
required

Example : "string"

string

percentComplete
required

Example : 0

integer (int32)

4.504. RemoteMirrorCandidate

Name Description Schema

sourceVolume
required

Example : "VolumeEx"

VolumeEx

targetVolumes
required

Example : [ "VolumeEx" ]

< VolumeEx > array

targetArrayName
required

Example : "string"

string

targetArrayId
required

Example : "string"

string

4.505. CVCandidateResponse

Name Description Schema

raidLevelMatch
optional

Example : true

boolean

samePool
optional

Example : true

boolean

candidate
optional

Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

volumeGroupId
optional

Example : "string"

string

capacityMatch
optional

Example : true

boolean

qosMatch
optional

Example : true

boolean

diskPool
optional

Example : true

boolean

capacity
optional

Example : "string"

string (int64)

baseMappableObjectId
optional

Example : "string"

string

candidateType
optional

Example : "string"

enum (unknown, newVol, existingVols, expansion, __UNDEFINED)

securityMatch
optional

True if the drive security settings for the base pool and the candidate’s pool match.
Example : true

boolean

daMatch
optional

True if the DataAssurance settings for the base and the candidate match.
Example : true

boolean

driveTypeMatch
optional

True if the drives for the base pool and the candidate’s pool match.
Example : true

boolean

existingCandidate
optional

True if the repository candidate is based on an existing volume and does not require a volume creation to occur.
Example : true

boolean

4.506. CVCandidateSelectionRequest

Name Description Schema

useFreeRepositoryVolumes
optional

Default : true
Example : true

boolean

candidateRequest
required

Example : "ConcatVolumeCandidateRequest"

ConcatVolumeCandidateRequest

exclusions
optional

Example : [ "ConcatVolumeCandidate" ]

< ConcatVolumeCandidate > array

4.507. ConcatVolumeCandidateRequest

Name Description Schema

baseVolumeRef
required

Example : "string"

string

percentCapacity
optional

Percent capacity of the baseVolume to use for the repository.
Default : 20.0
Example : 0.0

number (double)

concatVolumeType
optional

Define the type of object the repository will be utilized for. This will allow the capacity to be adjusted to meet required minimums.
Default : "snapshot"
Example : "string"

enum (snapshot, thinVolume, asyncMirror, other)

4.508. ConcatRepositoryVolume

Name Description Schema

concatVolRef
required

A reference (key) for ConcatVolume.
Example : "string"

string

status
required

The status/state of the concatenated volume. This will be the worst status among the member volumes.
Example : "string"

enum (unknown, optimal, degraded, failed, __UNDEFINED)

memberCount
required

The number of actual storage volumes comprising this volume. Note that this is just for convenience, this information can be derived from member objects.
Example : 0

integer (int32)

aggregateCapacity
required

The aggregate capacity in bytes of all member volumes.
Example : "string"

string (int64)

mediaScanParams
required

Media scan parameters.
Example : "VolumeMediaScanParams"

VolumeMediaScanParams

volumeHandle
required

The volume ssid. This is provided primarily for debug purposes.
Example : 0

integer (int32)

allowedOperations
required

Operations allowed on the ConcatVolume. This can be used if ConcatVolume is ever exposed as a host-addressable volume to specify whether the volume is host-mappable or not (repository volumes would never be mappable).
Example : "VolumePerms"

VolumePerms

memberRefs
optional

Example : [ "string" ]

< string > array

baseObjectType
optional

Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

baseObjectId
optional

Example : "string"

string

id
optional

Example : "string"

string

4.509. CVCandidateMultipleSelectionRequest

Name Description Schema

candidateRequests
optional

Example : [ "ConcatVolumeCandidateRequest" ]

< ConcatVolumeCandidateRequest > array

exclusions
optional

Example : [ "ConcatVolumeCandidate" ]

< ConcatVolumeCandidate > array

useFreeRepositoryVolumes
optional

Default : true
Example : true

boolean

4.510. ConcatVolumeExpansionRequest

Expand the repository of a Snapshot Group, Snapshot Volume, AsyncMirror Member, or ThinVolume.

Name Description Schema

repositoryRef
required

Identifier of the concatVolume to expand.
Example : "string"

string

expansionCandidate
required

An expansion candidate to use for expanding the capacity of the repository.
Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

4.511. SamlRole

SAML role instance

Name Description Schema

attribute
required

Group attributes from the Identity Provider
Example : "string"

string

match
required

Regex to match against
Example : "string"

string

roles
required

Local storage array roles
Example : [ "string" ]

< enum (security_admin, storage_none, support_admin, storage_monitor, storage_admin) > array

4.512. SamlConfiguration

The SAML configuration

Name Description Schema

samlEnabled
required

True if SAML enabled, false otherwise
Example : true

boolean

identityProviders
required

List of configured Identity Providers
Example : [ "SamlIdentityProvider" ]

< SamlIdentityProvider > array

serviceProviders
required

List of Service Providers
Example : [ "SamlServiceProvider" ]

< SamlServiceProvider > array

4.513. SamlIdentityProvider

Identity Provider instance

Name Description Schema

id
required

Identity Provider Id
Example : "string"

string

entityId
required

Globally unique name for SAML entity
Example : "string"

string

singleSignOnEndpoint
required

Single sign-on endpoint users will be redirected to for authentication
Example : "string"

string

singleLogoutEndpoint
required

Single sign-on endpoint users will be redirected to for logout
Example : "string"

string

namedIdFormats
required

List of named Id formats
Example : [ "string" ]

< string > array

roles
required

List of role mappings for this identity provider
Example : [ "SamlRole" ]

< SamlRole > array

signingCertificates
required

List of X.509 certificates used by the identity provider to sign messages
Example : [ "string" ]

< string > array

4.514. SamlServiceProvider

Service provider information

Name Description Schema

domainName
required

Service Provider domain name
Example : "string"

string

controllerPosition
required

Managing controller position
Minimum value : 1
Maximum value : 2
Example : 0

integer (int32)

4.515. SamlTestResponse

Response for SAML test

Name Description Schema

status
required

The status of the test
Example : "string"

enum (ok, failed, notRun, running, missingRequiredRoles)

startTime
required

Start time of the test
Example : "string"

string (int64)

4.516. SamlLoginRequest

Payload for a SAML authentication request

Name Description Schema

redirectUrl
required

The URL to return to after successful authentication
Example : "string"

string

4.517. SamlRolesRequest

Payload to map roles to an identity provider

Name Description Schema

roles
required

SAML role configuration
Example : [ "SamlRole" ]

< SamlRole > array

4.518. SecurityKeyFileRequest

This class describes the input for a obtaining a security key file

Name Description Schema

fileName
required

The name that the exported file should be given
Example : "string"

string

passPhrase
required

The passphrase for the security key
Example : "string"

string

4.519. SecureVolumeKeyResponse

Name Description Schema

fileSize
required

Example : "string"

string (int64)

fileName
required

Example : "string"

string

lockKeyId
required

The id of the lock key.
Example : "string"

string

4.520. SecureVolumeKeyRequest

Creates a secure volume (FDE) key.

Name Description Schema

lockKeyId
optional

An id used to identify the generated lock key.
Example : "string"

string

passPhrase
required

Passphrase for the key.
Example : "string"

string

setLockKey
optional

Apply the generated lock key.
Default : true
Example : true

boolean

4.521. SnapshotGroup

Name Description Schema

pitGroupRef
required

The reference (key) for the PiT Group.
Example : "string"

string

label
required

The name of the PiT Group. If this PiT group is part of a consistency group, then this label does not have to be present or unique as the parent consistency group label will be used.
Example : "string"

string

status
required

The status of the PiT Group.
Example : "string"

enum (unknown, optimal, full, failed, overThreshold, __UNDEFINED)

baseVolume
required

The base volume for this PiT Group.
Example : "string"

string

repositoryVolume
required

The copy-on-write (CoW) Repository for this PiT group.
Example : "string"

string

clusterSize
required

The cluster size (in bytes).
Example : 0

integer (int32)

maxRepositoryCapacity
required

The maximum allowable repository size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group.
Example : "string"

string (int64)

maxBaseCapacity
required

The maximum allowable base volume size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group.
Example : "string"

string (int64)

unusableRepositoryCapacity
required

The amount of repository capacity that is unusable due to limited addressability of the current cluster size.
Example : "string"

string (int64)

repFullPolicy
required

The behavior on repository full condition. Overridden by consistency group setting if this PITGroup is associated with a consistency group.
Example : "string"

enum (unknown, failbasewrites, purgepit, __UNDEFINED)

fullWarnThreshold
required

The repository utilization warning threshold percentage.
Example : 0

integer (int32)

autoDeleteLimit
required

The auto-delete indicator. If non-zero, the oldest PiT will be automatically deleted when creating a new one to keep the total number of PiTs limited to the number specified. This value is overridden by the consistency group setting if this PITGroup is associated with a consistency group.
Example : 0

integer (int32)

action
required

Long running operation.
Example : "string"

enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED)

rollbackStatus
required

The status of the rollback (if rollback is indicated in VolumeAction above).
Example : "string"

enum (unknown, none, inProgress, pending, paused, __UNDEFINED)

rollbackPriority
required

The importance of the rollback operation.
Example : "string"

enum (highest, high, medium, low, lowest, __UNDEFINED)

consistencyGroup
required

If true, this PiT group is part of a consistency group.
Example : true

boolean

consistencyGroupRef
required

A reference to the parent consistency group, if applicable. This value will be NULL if this PiT group is not part of a consistency group.
Example : "string"

string

creationPendingStatus
required

The status of Pending PiT Creation.
Example : "string"

enum (unknown, none, waiting, failed, __UNDEFINED)

volumeHandle
required

The PiT group SSID. This is provided primarily for debug purposes.
Example : 0

integer (int32)

volcopyId
optional

Example : "string"

string

snapshotCount
optional

Example : 0

integer (int32)

repositoryCapacity
optional

The aggregate capacity of the repository in bytes
Example : "string"

string (int64)

id
optional

Example : "string"

string

name
optional

Example : "string"

string

4.522. ScheduleCreateRequest

Creates a Schedule for a Snapshot (PiT) or Legacy Snapshot.

Name Description Schema

action
required

The schedule action type.
Example : "string"

enum (unknown, resnap, newpit, newcgpit, __UNDEFINED)

targetObject
optional

The SYMbol reference of the target object.
Example : "string"

string

scheduleMethod
required

The schedule calendar type.
Example : "string"

enum (unknown, daily, weekly, monthlyDate, monthlyDay, __UNDEFINED)

dailySchedule
required

The daily schedule times for all schedule methods.
Example : "DailySchedule"

DailySchedule

daysOfWeek
optional

The days of the week for the weekly schedule method.
Example : [ "string" ]

< enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED) > array

monthsOfYear
optional

The months of the year for the monthly by date schedule method.
Example : [ "string" ]

< enum (notSpecified, january, february, march, april, may, june, july, august, september, october, november, december, __UNDEFINED) > array

daysOfMonth
optional

The days of the month for the monthly by date schedule method.
Example : [ "string" ]

< enum (dayOfMonthLast, dayOfMonthNotSpecified, dayOfMonth01, dayOfMonth02, dayOfMonth03, dayOfMonth04, dayOfMonth05, dayOfMonth06, dayOfMonth07, dayOfMonth08, dayOfMonth09, dayOfMonth10, dayOfMonth11, dayOfMonth12, dayOfMonth13, dayOfMonth14, dayOfMonth15, dayOfMonth16, dayOfMonth17, dayOfMonth18, dayOfMonth19, dayOfMonth20, dayOfMonth21, dayOfMonth22, dayOfMonth23, dayOfMonth24, dayOfMonth25, dayOfMonth26, dayOfMonth27, dayOfMonth28, dayOfMonth29, __UNDEFINED, dayOfMonth30, dayOfMonth31) > array

startDate
required

The start date for the schedule.
Example : "string"

string (int64)

endDate
required

The end date for the schedule, 0 for no end date.
Example : "string"

string (int64)

timezone
required

The schedule time zone information.
Example : "TimeZoneDescription"

TimeZoneDescription

4.523. SnapshotGroupCreateRequest

Creates a Snapshot Group (PiT Group).

Name Description Schema

baseMappableObjectId
required

The identifier of the volume or thin volume to use as the base for the new snapshot group.
Example : "string"

string

name
required

The name of the new snapshot group.
Example : "string"

string

repositoryPercentage
optional

The size of the repository in relation to the size of the base volume.
Default : 20.0
Example : 0.0

number (double)

warningThreshold
optional

The repository utilization warning threshold, as a percentage of the repository volume capacity.
Default : 80
Example : 0

integer (int32)

autoDeleteLimit
optional

The automatic deletion indicator. If non-zero, the oldest snapshot image will be automatically deleted when creating a new snapshot image to keep the total number of snapshot images limited to the number specified. This value is overridden by the consistency group setting if this snapshot group is associated with a consistency group.
Default : 30
Example : 0

integer (int32)

fullPolicy
optional

The behavior on when the data repository becomes full. This value is overridden by consistency group setting if this snapshot group is associated with a consistency group.
Default : "purgepit"
Example : "string"

enum (unknown, failbasewrites, purgepit, __UNDEFINED)

storagePoolId
optional

The identifier of the storage pool on which to allocate the repository volume. Ignored if a repositoryCandidate is provided.
Example : "string"

string

repositoryCandidate
optional

Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected.
Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

schedule
optional

An optional schedule to be used to automatically create snapshot images.
Example : "ScheduleCreateRequest"

ScheduleCreateRequest

4.524. PITGroupRepositoryUtilization

Name Description Schema

pitGroupBytesUsed
required

The total number of bytes used in the repository for all PiTs in the group.
Example : "string"

string (int64)

pitGroupBytesAvailable
required

The total number of bytes available for ongoing copy-on-write operations.
Example : "string"

string (int64)

groupRef
required

The PiT Group for which this utilization information applies.
Example : "string"

string

pitUtilization
required

The repository utilization of each specific PiT in the PiT group.
Example : [ "PITRepositoryUtilization" ]

< PITRepositoryUtilization > array

4.525. PITRepositoryUtilization

Name Description Schema

pitRef
required

A reference to the specific PiT for which utilization is being reported.
Example : "string"

string

bytesUsed
required

The total number of bytes in use in the repository for this specific PiTs metadata, copy-on-write indexes, and copy-on-write data.
Example : "string"

string (int64)

4.526. SnapshotGroupUpdateRequest

Updates a Snapshot Group (PiT Group).

Name Description Schema

name
optional

The name of the new snapshot group.
Example : "string"

string

warningThreshold
optional

The repository utilization warning threshold, as a percentage of the repository volume capacity.
Example : 0

integer (int32)

autoDeleteLimit
optional

The automatic deletion indicator. If non-zero, the oldest snapshot image will be automatically deleted when creating a new snapshot image to keep the total number of snapshot images limited to the number specified.
Example : 0

integer (int32)

fullPolicy
optional

The behavior on when the data repository becomes full. This value is overridden by consistency group setting if this snapshot group is associated with a consistency group.
Example : "string"

enum (unknown, failbasewrites, purgepit, __UNDEFINED)

rollbackPriority
optional

The importance of the rollback operation. This value is overridden by consistency group setting if this snapshot group is associated with a consistency group.
Example : "string"

enum (highest, high, medium, low, lowest, __UNDEFINED)

4.527. SnapshotCreateRequest

Creates a Snapshot (PiT) within the specified Snapshot Group (PiT Group).

Name Description Schema

groupId
required

The identifier of the snapshot group for the new snapshot image.
Example : "string"

string

4.528. PITViewRepositoryUtilization

Name Description Schema

viewBytesUsed
required

The number of bytes used in the repository for the view metadata, copy-on-write indexes, and copy-on-write data.
Example : "string"

string (int64)

viewBytesAvailable
required

The total number of bytes available for ongoing copy-on-write operations.
Example : "string"

string (int64)

viewRef
required

The ViewRef for which this utilization applies.
Example : "string"

string

4.529. SnapshotVolumeModeConversionRequest

Convert a Snapshot Volume from ReadOnly to ReadWrite mode.

Name Description Schema

repositoryPercentage
optional

Percentage of the base capacity to make the repository.
Example : 0.0

number (double)

repositoryCandidate
optional

Allows a repository candidate to be manually specified for use in the conversion. By default, the best candidate will be selected.
Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

fullThreshold
optional

The repository utilization warning threshold percentage.
Example : 0

integer (int32)

4.530. SnapshotViewCreateRequest

Creates a Snapshot (PiT) View.

Name Description Schema

snapshotImageId
required

The identifier of the snapshot image used to create the new snapshot volume.
Example : "string"

string

fullThreshold
optional

The repository utilization warning threshold percentage.
Default : 85
Example : 0

integer (int32)

name
required

The name of the new snapshot volume.
Example : "string"

string

viewMode
optional

The snapshot volume access mode.
Default : "readOnly"
Example : "string"

enum (modeUnknown, readWrite, readOnly, __UNDEFINED)

repositoryPercentage
optional

The size of the view in relation to the size of the base volume.
Default : 20.0
Example : 0.0

number (double)

repositoryPoolId
optional

The identifier of the storage pool on which to allocate the repository volume. Ignored if a repositoryCandidate is provided.
Example : "string"

string

repositoryCandidate
optional

Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected.
Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

4.531. SnapshotViewUpdateRequest

Updates a Snapshot (PiT) View.

Name Description Schema

name
optional

The name of the new snapshot volume.
Example : "string"

string

fullThreshold
optional

The repository utilization warning threshold percentage.
Example : 0

integer (int32)

4.532. UserVolume

Name Description Schema

metadata
optional

Example : [ "VolumeMetadataItem" ]

< VolumeMetadataItem > array

volumeGroupRef
optional

Example : "string"

string

blkSize
optional

Example : 0

integer (int32)

mediaScan
optional

Example : "VolumeMediaScanParams"

VolumeMediaScanParams

diskPool
optional

Example : true

boolean

segmentSize
optional

Example : 0

integer (int32)

cacheSettings
required

The volume-specific caching parameters currently in effect for the volume.
Example : "VolumeCache"

VolumeCache

flashCached
optional

Example : true

boolean

dataAssurance
optional

Example : true

boolean

protectionType
optional

Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

thinProvisioned
optional

Example : true

boolean

name
optional

Example : "string"

string

id
optional

Example : "string"

string

objectType
optional

Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

wwn
optional

Example : "string"

string

mapped
required

Example : true

boolean

preferredControllerId
optional

Example : "string"

string

totalSizeInBytes
optional

Example : "string"

string (int64)

listOfMappings
optional

Example : [ "LUNMapping" ]

< LUNMapping > array

currentControllerId
optional

Example : "string"

string

4.533. SscVolumeCreateRequest

Name Description Schema

poolId
required

The id of the storage pool to create the volume on
Example : "string"

string

name
required

The name of the volume
Example : "string"

string

sizeUnit
optional

The unit for the request capacity
Example : "gb"

enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb)

size
required

The requested capacity of the volume in units
Example : "string"

string (int64)

readCacheEnable
optional

Example : true

boolean

writeCacheEnable
optional

Example : true

boolean

flashCacheEnable
optional

Add this volume to a flashCache
Example : false

boolean

dataAssuranceEnable
optional

Enable the dataAssurance capability
Example : false

boolean

thinProvision
optional

Define a thinProvisioned volume
Example : false

boolean

metaTags
optional

Optional list of MetaData tags to assign to the volume.
Example : [ "VolumeMetadataItem" ]

< VolumeMetadataItem > array

4.534. SscVolumeUpdateRequest

Updates a volume.

Name Description Schema

name
optional

The user-label to assign to the volume.
Example : "string"

string

newSize
optional

Expand the volume to this capacity.
Example : "string"

string (int64)

sizeUnit
optional

Expand the volume to this capacity.
Example : "gb"

enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb)

flashCache
optional

If true, add the volume to the flashCache if one is defined. If false, remove from the flashCache if one exists.
Example : true

boolean

owningControllerId
optional

Set the preferred owning controller
Example : "string"

string

readCacheEnable
optional

Example : true

boolean

writeCacheEnable
optional

Example : true

boolean

scanSettings
optional

Configure scan settings with regard to the controller’s background media scan operation
Example : "VolumeMediaScanParams"

VolumeMediaScanParams

metaTags
optional

Optional list of MetaData tags to assign to the volume. This will replace any existing tags.
Example : [ "VolumeMetadataItem" ]

< VolumeMetadataItem > array

4.535. PoolQosResponse

Name Description Schema

poolId
optional

The pool unique identifier
Example : "string"

string

name
optional

The pool name
Example : "string"

string

pool
optional

Example : "VolumeGroupEx"

VolumeGroupEx

flashCacheCapable
optional

True if the pool supports flashCaching created volumes
Example : true

boolean

dataAssuranceCapable
optional

True if created volumes can have dataAssurance enabled
Example : true

boolean

encrypted
optional

True if the pool supports encryption
Example : true

boolean

thinProvisioningCapable
optional

True if thin provisioned volumes can be defined on this pool
Example : true

boolean

spindleSpeed
optional

The normalized spindle speed for the drives on this pool
Example : "string"

enum (spindleSpeedUnknown, spindleSpeedSSD, spindleSpeed5400, spindleSpeed7200, spindleSpeed10k, spindleSpeed15k)

raidLevel
optional

The normalized RAID Level
Example : "string"

enum (raid0, raid1, raid5, raid6, raidDiskPool, unknown)

availableFreeExtentCapacities
optional

The available sections of freeSpace available, in descending order
Example : [ "string" ]

< string (int64) > array

4.536. VolumeGroupEx

Name Description Schema

sequenceNum
required

A sequence number that uniquely identifies this volume group within the array in which it resides. Sequence numbers are assigned to volume groups when they are created or imported into a storage array. The controller assigns the lowest unused sequence number during a creation or import operation.
Example : 0

integer (int32)

offline
required

An indication of whether the volume group is currently offline. A volume group can be taken offline by the operator in preparation for removing its drives and transporting them to another storage array.
Example : true

boolean

raidLevel
required

The RAID level associated with this volume group. If the storage array supports multiple RAID levels per volume group, this value will be set to RAID_ALL. Otherwise, it will indicate the precise RAID level defined for the volume group.
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

worldWideName
required

A variable-length opaque field that provides the volume group’s worldwide unique identification value.
Example : "string"

string

volumeGroupRef
required

The unique identification value for this volume group. Other objects may use this reference value to refer to the volume group.
Example : "string"

string

reserved1
optional

Example : "string"

string

reserved2
optional

Example : "string"

string

trayLossProtection
required

An indication as to whether the volume group has tray loss protection.
Example : true

boolean

label
required

The volume group label, which can be set by the user.
Example : "string"

string

state
required

The state of the volume group.
Example : "string"

enum (contingent, exported, forced, complete, partial, incomplete, missing, __UNDEFINED)

spindleSpeedMatch
required

Set to true if all of the drives in the group have matching normalized spindle speeds. (Normalized spindle speeds are standardized norms (e.g., 5400, 7200, etc.) that are used for spindle speed matching, even though actual spindle speeds may be within a designated delta of the normalized speed.)
Example : true

boolean

spindleSpeed
optional

The spindle speed of the drives composing the pool (RPM)
Example : 0

integer (int32)

isInaccessible
required

True if the volume group contains incompatible drives that have been locked out.
Example : true

boolean

securityType
required

security status of the drive group
Example : "string"

enum (unknown, none, capable, enabled, __UNDEFINED)

drawerLossProtection
required

This field is set to true when the volume group has drawer loss protection; otherwise it is set to false
Example : true

boolean

protectionInformationCapable
required

This field is no longer used.
Example : true

boolean

protectionInformationCapabilities
required

This structure contains a protectionInformationCapable field which is set to true if all drives in the volume group are Protection Information (PI) capable. It also contains a field that is set to the protection type for the volume group.
Example : "ProtectionInformationCapabilities"

ProtectionInformationCapabilities

volumeGroupData
required

Information about the Volume Group.
Example : "VolumeGroupTypeData"

VolumeGroupTypeData

usage
required

the volume group usage.
Example : "string"

enum (unknown, standard, flashcache, __UNDEFINED)

driveBlockFormat
required

Identifies the drive block format of the volume candidate.
Example : "string"

enum (unknown, allNative, allEmulated, mixed, __UNDEFINED)

reservedSpaceAllocated
required

This field will be used to report whether or not reserved space has been claimed on all drives in the volume group. The recovery-volume script will include this field for each volume group record it creates, so that during volume recovery the volume group is recreated correctly.
Example : true

boolean

securityLevel
required

Refines the information in the securityType field to describe the set of drives.
Example : "string"

enum (unknown, none, mixed, fde, fips, __UNDEFINED)

usedSpace
optional

Example : "string"

string (int64)

totalRaidedSpace
optional

Raw capacity of the volumeGroup
Example : "string"

string (int64)

extents
optional

Example : [ "FreeExtent" ]

< FreeExtent > array

largestFreeExtentSize
optional

Example : "string"

string (int64)

raidStatus
optional

The raid status reflects the worst case raid level of any volume on the group
Example : "string"

enum (optimal, degraded, failed, impaired, creating, deleting, __UNDEFINED)

freeSpace
optional

Example : "string"

string (int64)

drivePhysicalType
optional

Defines the physical interface type of the underlying drives.
Example : "string"

enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED)

driveMediaType
optional

Defines whether is an SSD or a spinning drive.
Example : "string"

enum (all, unknown, hdd, ssd, __UNDEFINED)

normalizedSpindleSpeed
optional

The normalized spindle speed of the drives composing the pool. Ex: 7200, 5400, 15000. If drives have mismatched spindle speeds, this value may not be accurate.
Example : "string"

enum (spindleSpeedUnknown, spindleSpeedSSD, spindleSpeed5400, spindleSpeed7200, spindleSpeed10k, spindleSpeed15k)

id
optional

Example : "string"

string

diskPool
optional

True if the RAID Level is defined as raidDiskPool.
Example : true

boolean

name
optional

Example : "string"

string

4.537. StorageSystemConfigResponse

Name Description Schema

name
optional

Name of the storage system
Example : "string"

string

4.538. StorageSystemConfigUpdateRequest

For updating StorageSystem configuration.

Name Description Schema

name
optional

New name for the storage system
Example : "string"

string

4.539. ManagementInterface

Name Description Schema

interfaceName
required

Name of the Ethernet port, as reported by the controller.
Example : "string"

string

channel
required

The channel number of this Ethernet interface.
Example : 0

integer (int32)

speed
required

The speed of the interface, as currently configured, in Mbit/sec.
Example : 0

integer (int32)

ip
required

The 32-bit IP protocol address assigned to the interface.
Example : 0

integer (int32)

alias
required

An ASCII string that identifies the alias name for the interface; this name is presumed to be associated with the IP protocol address.
Example : "string"

string

macAddr
required

An ASCII string representation of the globally-unique 48-bit MAC address assigned to the Ethernet interface.
Example : "string"

string

gatewayIp
required

IP address of the gateway.
Example : 0

integer (int32)

subnetMask
required

Network subnet mask.
Example : 0

integer (int32)

bootpUsed
required

Bootpserver used to get network parameters.
Example : true

boolean

rloginEnabled
required

True if rlogin sessions are allowed.
Example : true

boolean

reserved1
optional

Example : "string"

string

setupError
required

Set to true if there is a configuration error.
Example : true

boolean

reserved2
optional

Example : "string"

string

interfaceRef
required

The unique identifier for a given instance of this structure.
Example : "string"

string

linkStatus
required

The status of the network link for this interface.
Example : "string"

enum (none, up, down, failed, __UNDEFINED)

ipv4Enabled
required

True if IPV4 is enabled for this interface; otherwise false.
Example : true

boolean

ipv4Address
required

The IPV4 address for the interface.
Example : "string"

string

ipv4SubnetMask
required

The IPV4 subnet mask for the interface.
Example : "string"

string

ipv4AddressConfigMethod
required

The method by which the IPV4 address information is configured.
Example : "string"

enum (configDhcp, configStatic, __UNDEFINED)

ipv6Enabled
required

True if IPV6 is enabled for this interface; otherwise false.
Example : true

boolean

ipv6LocalAddress
required

The IPV6 local address for the interface and associated data.
Example : "IpV6AddressData"

IpV6AddressData

ipv6PortStaticRoutableAddress
required

The IPV6 static routable address for the interface and associated data.
Example : "IpV6AddressData"

IpV6AddressData

ipv6PortRoutableAddresses
required

The set of IPV6 port routable addresses for the interface.
Example : [ "IpV6AddressData" ]

< IpV6AddressData > array

ipv6AddressConfigMethod
required

The method by which the IPV6 address information is configured for the interface.
Example : "string"

enum (configStatic, configStateless, __UNDEFINED)

fullDuplex
required

If set to true, the interface is operating in full duplex mode; otherwise, it is operating in half-duplex mode.
Example : true

boolean

supportedSpeedSettings
required

Support speed setting for interface
Example : [ "string" ]

< enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED) > array

configuredSpeedSetting
required

Configured setting for the interface.
Example : "string"

enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED)

currentSpeed
required

Current speed of the interface.
Example : "string"

enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, __UNDEFINED)

physicalLocation
required

The physical location of the Ethernet interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st ethernet interface relative to the parent," "2nd ethernet interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association.
Example : "Location"

Location

ipv4GatewayAddress
optional

Example : "string"

string

controllerRef
optional

Example : "string"

string

controllerSlot
optional

Example : 0

integer (int32)

dnsProperties
optional

Example : "ControllerDNSProperties"

ControllerDNSProperties

ntpProperties
optional

Example : "ControllerNTPProperties"

ControllerNTPProperties

id
optional

Example : "string"

string

4.540. ManagementConfigurationRequest

Name Description Schema

controllerRef
required

Example : "string"

string

enableRemoteAccess
optional

If set to true, the controller is enabled for establishment of a remote access session. Depending on the controller platform, the method for remote access could be rlogin or telnet
Example : true

boolean

ipv4GatewayAddress
optional

Manually specify the address of the gateway.
Example : "string"

string

ipv6GatewayAddress
optional

Example : "string"

string

ipv6StaticRoutableAddress
optional

Example : "string"

string

interfaceRef
required

Reference to the Ethernet interface to configure
Example : "string"

string

interfaceName
optional

Name of Ethernet port
Example : "string"

string

ipv4Enabled
optional

True if 'ipv4' is to be enabled for this interface; otherwise false.
Example : true

boolean

ipv4Address
optional

The 'ipv4' address for the interface. Required for static configuration.
Example : "string"

string

ipv4SubnetMask
optional

The 'ipv4' subnet mask for the interface. Required for static configuration.
Example : "string"

string

ipv4AddressConfigMethod
optional

Setting that determines how the 'ipv4' address is configured. Required if ipv4 is enabled.
Example : "string"

enum (configDhcp, configStatic, __UNDEFINED)

ipv6Enabled
optional

True if 'ipv6' is to be enabled for this interface; otherwise false.
Example : true

boolean

ipv6LocalAddress
optional

The 'ipv6' local address for the interface.
Example : "string"

string

ipv6AddressConfigMethod
optional

The method by which the 'ipv6' address information is configured for the interface.
Example : "string"

enum (configStatic, configStateless, __UNDEFINED)

speedSetting
optional

The configured speed setting for the Ethernet interface.
Example : "string"

enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED)

dnsAcquisitionDescriptor
optional

The configuration for the DNS on this management interface
Example : "DnsAcquisitionDescriptor"

DnsAcquisitionDescriptor

ntpAcquisitionDescriptor
optional

The configuration for the NTP on this management interface
Example : "NtpAcquisitionDescriptor"

NtpAcquisitionDescriptor

4.541. KeyValue

Key value pair. Can be a key to single value or key to valueList.

Name Description Schema

key
required

Key
Example : "string"

string

valueList
required

Provide a list of values
Example : [ "string" ]

< string > array

4.542. StorageSystemResponse

A Storage System is a collection of both physical components and logical components. Physical components include disk drives, controllers, fans, and other hardware. The physical disk drives are grouped into Storage Pools. The storage capacity of these Storage Pools is provisioned into logical Volumes.

Name Description Schema

id
required

Example : "string"

string

name
required

Example : "string"

string

wwn
required

Example : "string"

string

passwordStatus
required

Example : "string"

enum (unknown, invalid, valid, securityLockout)

passwordSet
required

Example : true

boolean

status
required

Example : "string"

enum (neverContacted, offline, optimal, needsAttn, removed, newDevice, lockDown)

ip1
required

Example : "string"

string

ip2
required

Example : "string"

string

managementPaths
required

Example : [ "string" ]

< string > array

driveCount
required

Example : 0

integer (int32)

trayCount
required

Example : 0

integer (int32)

traceEnabled
required

Example : true

boolean

types
required

Example : "string"

string

model
required

Example : "string"

string

metaTags
required

Example : [ "KeyValue" ]

< KeyValue > array

hotSpareSize
required

Example : "string"

string (int64)

usedPoolSpace
required

Example : "string"

string (int64)

freePoolSpace
required

Example : "string"

string (int64)

unconfiguredSpace
required

Example : "string"

string (int64)

driveTypes
required

Example : [ "string" ]

< enum (scsi, fibre, unknown, sas, sata, __UNDEFINED) > array

hostSpareCountInStandby
required

Example : 0

integer (int32)

hotSpareCount
required

Example : 0

integer (int32)

hostSparesUsed
required

Example : 0

integer (int32)

bootTime
optional

Deprecated: The controller boot time.
Example : "string"

string (date-time)

fwVersion
required

Example : "string"

string

appVersion
required

Example : "string"

string

bootVersion
required

Example : "string"

string

nvsramVersion
required

Example : "string"

string

chassisSerialNumber
required

Example : "string"

string

accessVolume
required

Example : "AccessVolumeEx"

AccessVolumeEx

unconfiguredSpaceByDriveType
required

Example : {
"string" : "string"
}

< string, string (int64) > map

mediaScanPeriod
required

Example : 0

integer (int32)

driveChannelPortDisabled
required

True if one or more drive channel ports have been disabled by the controllers to protect against faulty expansion cabling.
Example : true

boolean

recoveryModeEnabled
required

True if recovery mode is enabled on the array.
Example : true

boolean

autoLoadBalancingEnabled
required

True if auto load balance is enabled on the array.
Example : true

boolean

hostConnectivityReportingEnabled
required

True if host connectivity reporting is enabled on the array.
Example : true

boolean

remoteMirroringEnabled
required

Can Remote Volume Mirrors be created on this StorageDevice?
Example : true

boolean

fcRemoteMirroringState
required

The remote mirroring state on this StorageDevice
Example : "string"

enum (unknown, disabled, enabledLegacyRvm, enabledArvm, enabledAll, __UNDEFINED)

asupEnabled
required

True if ASUP is enabled for this StorageDevice
Example : true

boolean

securityKeyEnabled
required

Example : true

boolean

externalKeyEnabled
required

Example : true

boolean

lastContacted
optional

The last time that the device was considered accessible.
Example : "string"

string (date-time)

definedPartitionCount
optional

The number of partitions calculated from the user’s current mappings.
Example : 0

integer (int32)

simplexModeEnabled
optional

True if the redundancy mode of the system is simplex.
Example : true

boolean

enabledManagementPorts
optional

The management ports that are enabled on this storage system
Example : [ "string" ]

< enum (symbol, https) > array

freePoolSpaceAsString
optional

Example : "string"

string

hotSpareSizeAsString
optional

Example : "string"

string

unconfiguredSpaceAsStrings
optional

Example : "string"

string

usedPoolSpaceAsString
optional

Example : "string"

string

4.543. StorageSystemUpdateRequest

Structure used to pass update information for the storage system

Name Description Schema

storedPassword
optional

The new password for the storage system stored. Note, this only updates the password stored on the proxy. To update the password on the storage system itself (as well as the stored password) the use the passwords URL
Example : "string"

string

metaTags
optional

Optional meta tags to associate to this storage system. This must be a complete list. If the list is empty or null, no action is taken. If you want to just remove all tags, just set the removeAllTags boolean to true/ The removeAllTags will be processed before this new list is processed
Example : [ "KeyValue" ]

< KeyValue > array

removeAllTags
optional

See the description for metaTags
Example : true

boolean

enableTrace
optional

Enable trace logging for SYMbol calls to the storage system.
Example : true

boolean

controllerAddresses
optional

Replacement list of controller IP addresses or host names.
Example : [ "string" ]

< string > array

4.544. CapabilitiesResponse

Information on StorageSystem capabilities, features, and limits.

Name Description Schema

featureBundle
required

Example : "FeatureBundle"

FeatureBundle

capabilities
required

Example : [ "string" ]

< enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, __UNDEFINED) > array

productCapabilities
required

Example : [ "string" ]

< enum (capabilityNone, capabilityCacheBackup, capabilityCoreIscsi, capabilityDap520b, capabilityDualPortedSata, capabilityFdeDriveSupport, capabilityFieldRepCacheMem, capabilityGbEthMgmtPort, capabilityInfinibandSupport, capabilityIpv6MgmtPortIpv6, capabilityIscsiIpv6, capabilitySasSupport, capabilitySimplex, capabilitySmartBatteryMgmt, capabilityCal6141, capabilityCal6334, capabilityCfgDbAdoption, capabilityCtrlLockdown, capabilityCtrlStateCapture, capabilityDiagDataCapture, capabilityDriveDataRelocation, capabilityDriveEnclosureMiswires, capabilityDriveMgmt, capabilityDriveMixWithinTray, capabilityDrvChannelDiags, capabilityFeatureBundles, capabilityHostContextAgent, capabilityImmediateHostTopology, capabilityOnlineDrvFwDwnld, capabilityParentRelativeLocation, capabilityParentRelativeStatus, capabilityPompanoSupport, capabilityRaid6, capabilitySocStatistics, capabilitySupportsVirtualization, capabilityT10, capabilityInfusion, capabilityDriveLimitManagement, capabilitySfpPlus, capabilityIscsi10gbHostCard, capabilityEnhancedLun0Support, capabilityEnhancedFormatUnitSupport, capabilityDriveSideTrunkSupport, capabilitySsdSupport, capabilityBaseControllerDiags, capabilityCacheMemoryDiags, capabilityDriveSlotLimit, capabilityFdeProxyKeyMgmt, capabilityIosSupport, capabilityLockout2tbDrives, capabilityParentRelativeMel, capabilityRaid6PrereadRedCheck, capabilitySataDriveLockout, capabilitySyslogMsgs, capabilityWembleyEnclosure, capabilityCacheBackupDeviceDiags, capabilityHicDiags, capabilitySetTrayAttributes, capabilityIscsiTarget, capabilityIscsiInitiator, capabilityPsuFirmwareUpdate, capabilityDplCoreDump, capabilityDiskPools, capabilityAsupSupport, capabilityEmbeddedSnmpAgent, capabilityFtdcTraceHistory, capabilityAdvancedFormatSupport, capability4knativeAdvancedFormatSupport, capabilityAsupOnDemandSupport, capabilityIocDump, capabilityDrivePowerCycle, capabilityLowAndHighSampling, capabilityAutoLoadBalancing, capabilityWlcLogging, capabilityFipsDriveSupport, capabilityApplicationAwareness, capabilityEmbeddedEkms, capabilityCacheMirroringProtectionInformation, capabilityIntegratedHealthCheck, capabilitySignedFirmware, __UNDEFINED) > array

featureStates
required

Example : [ "FeatureState" ]

< FeatureState > array

storageSystemAttributes
required

Configuration parameters, constants, and other useful information for clients that may vary between storage-systems.
Example : "StorageSystemAttributes"

StorageSystemAttributes

featureParameters
required

Example : "FeatureParams"

FeatureParams

4.545. StorageSystemAttributes

Name Description Schema

isLun0RestrictedForDefaultPartition
required

A true value in this field indicates that one or more host bus adapter (HBA) host ports in the default host group is using an I/O protocol that does not allow volumes to be mapped to LUN 0.
Example : true

boolean

4.546. AddStorageSystemReturn

Name Description Schema

id
required

Example : "string"

string

alreadyExists
required

Example : true

boolean

4.547. StorageSystemCreateRequest

Used to create a storage system.

Name Description Schema

id
optional

ID to assign to the storage system. This must be left null or be unique. If null, a unique ID will be assigned
Example : "string"

string

controllerAddresses
required

A list of controller IP addresses or host names.
Example : [ "string" ]

< string > array

validate
optional

Enables validation of the added storage array. Returns errors if there are wwn mismatches or if the storage array cannot be contacted.
Default : false
Example : true

boolean

password
optional

The SYMbol password for the storage system.
Example : "string"

string

wwn
optional

The world wide name for the storage system. This is only needed for in-band management with an in-band agent that is managing more than a single storage system.
Example : "string"

string

enableTrace
optional

Enable trace logging for SYMbol calls to the storage system.
Example : true

boolean

metaTags
optional

Optional meta tags to associate to this storage system
Example : [ "KeyValue" ]

< KeyValue > array

4.548. SupportArtifact

API object that includes information about a single support artifact.

Name Description Schema

fileName
required

Relative path to artifact.
Example : "string"

string

lastModifiedTime
required

Timestamp of last modification.
Example : "string"

string (date-time)

size
required

Size of artifact in bytes.
Example : "string"

string (int64)

4.549. SupportArtifacts

API object that includes information about all support artifacts of a single type.

Name Description Schema

type
required

Type of support artifacts.
Example : "string"

enum (recoveryProfile, supportBundle, dbCapture, ioStatistics, other)

artifacts
required

Array of support artifacts of the specified type.
Example : [ "SupportArtifact" ]

< SupportArtifact > array

4.550. SaveConfigSpec

Name Description Schema

storageArraySettings
optional

Set true to save general storage array settings.
Example : true

boolean

volumeConfiguration
optional

Set true to save storage array volume configuration.
Example : true

boolean

hostConfiguration
optional

Set true to save host and host port configuration.
Example : true

boolean

volumeMappings
optional

Set true to save volume mappings.
Example : true

boolean

4.551. SupportDataRequest

Name Description Schema

type
required

The name of the file to be retrieved.
Example : "string"

enum (driveData, traceBuffers, ioPathStatistics, supportBundle, coreDump, storageArrayConfiguration, deviceProfile, firmwareInventory, unreadableSectors, iscsiSessionsConnections)

filename
required

Specify the name of the file, which will be utilized if it doesn’t already exist.
Example : "string"

string

traceSpec
optional

Specifies the controllers to retrieve data from for type=traceBuffers
Example : "TraceBufferSpec"

TraceBufferSpec

driveSpec
optional

Specifies the drives to retrieve logs for for type=driveData
Example : "DriveRefList"

DriveRefList

saveConfigSpec
optional

Specifies the settings for type=storageArrayConfiguration
Example : "SaveConfigSpec"

SaveConfigSpec

4.552. TraceBufferSpec

Name Description Schema

controllerA
required

Example : true

boolean

controllerB
required

Example : true

boolean

4.553. Progress

Name Description Schema

complete
optional

Has the operation completed?
Example : true

boolean

percentage
optional

The approximate progress to completion of the operation.
Example : 0

integer (int32)

4.554. SupportDataResponse

Name Description Schema

requestId
optional

A unique identifier for the request
Example : "string"

string (int64)

progress
optional

The progress of the operation.
Example : "Progress"

Progress

sizeInBytes
optional

The size of the support file
Example : "string"

string (int64)

type
optional

The type of support data being collected.
Example : "string"

enum (driveData, traceBuffers, ioPathStatistics, supportBundle, coreDump, storageArrayConfiguration, deviceProfile, firmwareInventory, unreadableSectors, iscsiSessionsConnections)

filename
optional

The name of the file to be retrieved.
Example : "string"

string

4.555. SymbolPortResponse

Name Description Schema

symbolPortEnabled
required

If the symbol port is enabled
Example : true

boolean

4.556. SymbolPortRequest

Name Description Schema

enable
required

Enable the SYMbol port
Example : true

boolean

4.557. SyslogComponent

Syslog server component configuration.

Name Description Schema

type
required

Component type
Example : "string"

enum (auditLog)

4.558. SyslogServer

Syslog server configuration.

Name Description Schema

id
required

Syslog server configuration id
Example : "string"

string

serverAddress
required

Fully qualified name or IP address of receiver
Example : "string"

string

port
required

Port number
Example : 0

integer (int32)

protocol
required

Transmission protocol
Example : "string"

enum (udp, tcp, tls)

components
required

Array of associated components
Example : [ "SyslogComponent" ]

< SyslogComponent > array

4.559. SyslogServerRequest

Create or update syslog server configuration.

Name Description Schema

serverAddress
required

Fully qualified name or IP address
Example : "string"

string

port
required

Port number
Example : 0

integer (int32)

protocol
required

Transmission protocol
Example : "string"

enum (udp, tcp, tls)

components
required

Associated components
Example : [ "SyslogComponent" ]

< SyslogComponent > array

4.560. ThinVolumeEx

Name Description Schema

volumeHandle
required

The volumeHandle (SSID) for this volume.
Example : 0

integer (int32)

worldWideName
required

The World wide name of the volume.
Example : "string"

string

label
required

The name of the volume.
Example : "string"

string

allocationGranularity
required

The allocation cluster size for the Expandable Repository Volume.
Example : 0

integer (int32)

capacity
required

The virtual capacity of the volume in bytes.
Example : "string"

string (int64)

reconPriority
required

Importance of fixing the volume if failed (0-4).
Example : 0

integer (int32)

volumeRef
required

The reference (key) for this volume.
Example : "string"

string

status
required

The operational status of the volume.
Example : "string"

enum (unknown, optimal, full, overThresh, failed, initializing, __UNDEFINED)

repositoryRef
required

The Expandable Repository Volume underlying this Thin Volume.
Example : "string"

string

currentManager
required

The controller that currently manages the volume.
Example : "string"

string

preferredManager
required

The controller that should manage the volume.
Example : "string"

string

perms
required

Operations allowed on this volume.
Example : "VolumePerms"

VolumePerms

mgmtClientAttribute
required

For use by management client.
Example : 0

integer (int32)

preReadRedundancyCheckEnabled
required

If true, verify RAID redundancy on read operations.
Example : true

boolean

protectionType
required

The protection type of the volume.
Example : "string"

enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED)

applicationTagOwned
required

True if application tag is owned by the storage array.
Example : true

boolean

maxVirtualCapacity
required

The maximum virtual capacity to which this thin volume can grow (in bytes).
Example : "string"

string (int64)

initialProvisionedCapacity
required

The initial provisioned capacity for the Expandable Repository Volume for this thin volume (in bytes).
Example : "string"

string (int64)

currentProvisionedCapacity
required

The current provisioned capacity of the Expandable Repository Volume (in bytes).
Example : "string"

string (int64)

provisionedCapacityQuota
required

The maximum capacity of the Expandable Repository Volume (in bytes).
Example : "string"

string (int64)

growthAlertThreshold
required

The percent value at which an alert is generated.
Example : 0

integer (int32)

expansionPolicy
required

The automatic Expandable Repository Volume expansion policy.
Example : "string"

enum (unknown, manual, automatic, __UNDEFINED)

volumeCache
required

The cache parameters of the underlying repository.
Example : "VolumeCache"

VolumeCache

offline
required

The thin volume is offline due to the associated repository volume state.
Example : true

boolean

reportingPolicy
required

Indicates how the thin volume is reported on the SCSI interface.
Example : "string"

enum (unknown, asThick, asThin, __UNDEFINED)

extendedUniqueIdentifier
required

A variable-length opaque field that provides the volume’s extended unique identification value.
Example : "string"

string

volumeFull
optional

Example : true

boolean

volumeGroupRef
optional

Example : "string"

string

blkSize
optional

Example : 0

integer (int32)

storageVolumeRef
optional

Example : "string"

string

volumeCopyTarget
optional

Example : true

boolean

volumeCopySource
optional

Example : true

boolean

pitBaseVolume
optional

Example : true

boolean

asyncMirrorTarget
optional

True if the volume is a target in an Asynchronous Mirror relationship.
Example : true

boolean

asyncMirrorSource
optional

True if the volume is a source in an Asynchronous Mirror relationship.
Example : true

boolean

remoteMirrorSource
optional

True if the volume is a source (primary), in an Remote Volume Mirror relationship.
Example : true

boolean

remoteMirrorTarget
optional

True if the volume is a target (secondary), in an Remote Volume Mirror relationship.
Example : true

boolean

flashCached
optional

True if this volume is added to a flashCache.
Example : true

boolean

mediaScan
optional

Example : "VolumeMediaScanParams"

VolumeMediaScanParams

metadata
optional

Metadata associated with the volume
Example : [ "VolumeMetadataItem" ]

< VolumeMetadataItem > array

dataAssurance
optional

Example : true

boolean

name
optional

Example : "string"

string

id
optional

Example : "string"

string

objectType
optional

Example : "string"

enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings)

wwn
optional

Example : "string"

string

mapped
required

Example : true

boolean

diskPool
optional

Example : true

boolean

segmentSize
optional

Example : 0

integer (int32)

cacheSettings
required

The volume-specific caching parameters currently in effect for the volume.
Example : "VolumeCache"

VolumeCache

preferredControllerId
optional

Example : "string"

string

totalSizeInBytes
optional

Example : "string"

string (int64)

onlineVolumeCopy
optional

Example : true

boolean

listOfMappings
optional

Example : [ "LUNMapping" ]

< LUNMapping > array

currentControllerId
optional

Example : "string"

string

thinProvisioned
optional

Example : true

boolean

4.561. ThinVolumeCreateRequest

Creates a Thin Volume.

Name Description Schema

poolId
required

The identifier of the storage pool from which the volume will be allocated.
Example : "string"

string

name
required

The user-label to assign to the new volume.
Example : "string"

string

sizeUnit
required

Unit for "size"
Example : "string"

enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb)

virtualSize
required

Initial virtual capacity of the volume in units (See sizeUnit).
Example : "string"

string (int64)

repositorySize
required

Number of units (See sizeUnit) to make the repository volume, which is the backing for the thin volume. Must be between 4GB & 256GB. This value must align along a 4GB boundary. If it does not, it will be automatically adjusted to the next 4GB value.
Example : "string"

string (int64)

maximumRepositorySize
required

Maximum size (in sizeUnits) to which the thin volume repository can grow.
Example : "string"

string (int64)

owningControllerId
optional

Set the preferred owning controller. By default this field will alternate between available controllers
Example : "string"

string

growthAlertThreshold
optional

The repository utilization warning threshold (in percent). This parameter is only required for thin-provisioned volumes. Default: 95
Example : 0

integer (int32)

createDefaultMapping
optional

Create the default volume mapping. Defaults to false.
Default : false
Example : true

boolean

expansionPolicy
optional

Thin Volume expansion policy. If automatic, the thin volume will be expanded automatically when capacity is exceeded, if manual, the volume must be expanded manually. Defaults to automatic.
Default : "automatic"
Example : "string"

enum (unknown, manual, automatic, __UNDEFINED)

cacheReadAhead
optional

Deprecated(This field is no longer valid for thin volumes): Enable/Disable automatic cache read-ahead
Default : true
Example : true

boolean

dataAssuranceEnabled
optional

Example : true

boolean

metaTags
optional

Optional array of Meta Data tags for the volume.
Example : [ "VolumeMetadataItem" ]

< VolumeMetadataItem > array

4.562. ThinVolumeCacheSettings

Name Description Schema

readCacheEnable
optional

Indicates whether read caching should be enabled for the volume.
Example : true

boolean

writeCacheEnable
optional

Indicates whether write-back caching should be enabled for the volume.
Example : true

boolean

cacheFlushModifier
optional

The cache flush modifier value, which is used to specify the maximum amount of time that dirty data for this volume may be retained in the controller’s write cache prior to being flushed to disk.
Example : "string"

enum (flushImmediate, flush250Msec, flush500Msec, flush750Msec, flush1Sec, flush1500Msec, flush2Sec, flush5Sec, flush10Sec, flush20Sec, flush60Sec, flush120Sec, flush300Sec, flush1200Sec, flush3600Sec, flushInfinite, __UNDEFINED)

4.563. ThinVolumeUpdateRequest

Updates a Thin Volume.

Name Description Schema

name
optional

The user-label to assign to the volume.
Example : "string"

string

growthAlertThreshold
optional

The repository utilization warning threshold (in percent).
Example : 0

integer (int32)

flashCache
optional

If true, add the volume to the flashCache if one is defined. If false, remove from the flashCache if one exists.
Example : true

boolean

metaTags
optional

Optional array of Meta Data tags for the volume.
Example : [ "VolumeMetadataItem" ]

< VolumeMetadataItem > array

expansionPolicy
optional

Thin Volume expansion policy. If automatic, the thin volume will be expanded automatically when capacity is exceeded, if manual, the volume must be expanded manually.
Example : "string"

enum (unknown, manual, automatic, __UNDEFINED)

owningControllerId
optional

Set the preferred owning controller
Example : "string"

string

cacheSettings
optional

Configure cache settings for the volume
Example : "ThinVolumeCacheSettings"

ThinVolumeCacheSettings

scanSettings
optional

Configure scan settings with regard to the controller’s background media scan operation
Example : "VolumeMediaScanParams"

VolumeMediaScanParams

4.564. ThinVolumeExpansionRequest

Expands a Thin Volume.

Name Description Schema

sizeUnit
optional

Unit for "size"
Default : "gb"
Example : "string"

enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb)

newVirtualSize
optional

The new virtual capacity for the thin volume. New virtual capacity cannot be smaller than original value!
Example : "string"

string (int64)

newRepositorySize
optional

The new repository capacity of the thin volume. If expansion policy is Automatic, this will increase the maximum repository capacity. If the expansion policy is Manual, this will increase the capacity of the repository directly.
Example : "string"

string (int64)

4.565. UnassociatedHostPort

A Port seen on the Storage Area Network but not currently associated to a host

Name Description Schema

type
required

Example : "string"

enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, __UNDEFINED)

id
required

Example : "string"

string

address
required

Example : "string"

string

4.566. UpgradeManagerResponse

This response contains the correlation Id that can be used to correlate software download events from the global event channel to this request

Name Description Schema

correlationId
required

The correlation Id. This can be match to events from the event system to match events to this request
Example : "string"

string

4.567. SoftwareVersion

Version information for a component/context in the server

Name Description Schema

context
required

The context for the component
Example : "string"

string

version
required

The version for the component
Example : "string"

string

4.568. SoftwareVersions

Collection of version information for the current and staged versions of sotware

Name Description Schema

stagedVersions
required

The staged versions
Example : [ "SoftwareVersion" ]

< SoftwareVersion > array

currentVersions
required

The current versions
Example : [ "SoftwareVersion" ]

< SoftwareVersion > array

4.569. VolumeCopyProgress

Object to represent the Volume Copy progress.

Name Description Schema

percentComplete
required

The completion percentage of a "long-running" operation on a volume.
Example : 0

integer (int32)

timeToCompletion
required

The estimated elapsed time to completion in minutes. Note that this field is always set to -1 for basic RAID volumes.
Example : 0

integer (int32)

volumeCopyId
required

Example : "string"

string

4.570. VolumeCopyPair

Name Description Schema

worldWideName
required

The World Wide Name of the volume copy.
Example : "string"

string

volcopyHandle
required

The Volume Copy ID(ssid of proxy).
Example : 0

integer (int32)

volcopyRef
required

Reference (key) for copy.
Example : "string"

string

status
required

Indicates status of copy.
Example : "string"

enum (inProgress, complete, halted, failed, pending, __UNDEFINED)

sourceVolume
required

Source volume reference.
Example : "string"

string

targetVolume
required

Target volume reference.
Example : "string"

string

currentManager
required

Current owner of copy.
Example : "string"

string

idleTargetWriteProt
required

Apply write protection to target volume when copy is idle (true/false).
Example : true

boolean

copyCompleteTime
required

Time copy operation completed.
Example : "string"

string (int64)

copyStartTime
required

Time copy operation began.
Example : "string"

string (int64)

copyPriority
required

Importance of copy operation.
Example : "string"

enum (priority0, priority1, priority2, priority3, priority4, __UNDEFINED)

reserved1
optional

Example : "string"

string

cloneCopy
required

The volume copy is a clone.
Example : true

boolean

pgRef
required

For clones based on PiT Groups, this will identify the PiT Group.
Example : "string"

string

baseSourceVolumeId
optional

The source’s base volume identifier (the same as the sourceVolume in the case of an offline copy).
Example : "string"

string

id
optional

Example : "string"

string

onlineCopy
optional

Example : true

boolean

4.571. VolumeCopyCreateRequest

Creates a Volume Copy.

Name Description Schema

sourceId
required

The identifier of the source volume for the copy job.
Example : "string"

string

targetId
required

The identifier of the target volume for the copy job.
Example : "string"

string

copyPriority
optional

The priority of the copy job (0 is the lowest priority, 4 is the highest priority). Defaults to priority 2.
Default : "priority2"
Example : "string"

enum (priority0, priority1, priority2, priority3, priority4, __UNDEFINED)

targetWriteProtected
optional

Specifies whether to block write I/O to the target volume while the copy job exists.
Default : false
Example : true

boolean

onlineCopy
optional

If true, a snapshot will be created of the source volume, and the copy initiated on it to prevent any loss of use of the source volume.
Default : false
Example : true

boolean

repositoryCandidate
optional

Allows a repository candidate to be manually specified for use in the creation of the snapshot. By default, the best candidate will be selected if onlineCopy is specified as true
Example : "ConcatVolumeCandidate"

ConcatVolumeCandidate

4.572. VolumeCopyUpdateRequest

Updates a Volume Copy.

Name Description Schema

copyPriority
optional

The priority of the copy job (0 is the lowest priority, 4 is the highest priority). Defaults to priority 2.
Example : "string"

enum (priority0, priority1, priority2, priority3, priority4, __UNDEFINED)

targetWriteProtected
optional

Specifies whether to block write I/O to the target volume while the copy job exists.
Example : true

boolean

4.573. RaidMigrationRequest

Name Description Schema

raidLevel
required

Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

4.574. OperationProgress

Name Description Schema

volumeRef
required

Example : "string"

string

currentAction
required

Example : "string"

enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED)

progressPercentage
required

Example : 0

integer (int32)

estimatedTimeToCompletion
required

Example : 0

integer (int32)

4.575. StoragePoolCreateRequest

Creates a Storage Pool.

Name Description Schema

raidLevel
required

The RAID configuration for the new storage pool.
Example : "string"

enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED)

diskDriveIds
required

The identifiers of the disk drives to use for creating the storage pool.
Example : [ "string" ]

< string > array

eraseSecuredDrives
optional

Security-enabled drives that were previously part of a secured storage pool must be erased before they can be re-used. Enable to automatically erase such drives.
Example : true

boolean

name
required

The user-label to assign to the new storage pool.
Example : "string"

string

4.576. DiskPoolPriorityUpdateRequest

Name Description Schema

priority
required

Pool operation priority
Example : "string"

enum (invalid, lowest, low, medium, high, highest, useDefault, __UNDEFINED)

priorityType
required

The priority type
Example : "string"

enum (invalid, degraded, critical, background, __UNDEFINED)

4.577. DiskPoolThresholdUpdateRequest

Name Description Schema

thresholdType
required

The threshold type to configure
Example : "string"

enum (invalid, warning, critical, __UNDEFINED)

value
required

New threshold setting (0-100). 0 to disable the threshold.
Example : 0

integer (int32)

4.578. StoragePoolUpdateRequest

Updates a Storage Pool.

Name Description Schema

name
optional

The new user-label to assign to the storage pool.
Example : "string"

string

securePool
optional

Convert to a secure Storage Pool if all of the drives that constitute the Pool are security capable
Example : true

boolean

reservedDriveCount
optional

Set the number of drives reserved by the storage pool for reconstruction operations (only for RAID Type: raidDiskPool)
Example : 0

integer (int32)

poolPriority
optional

Set the reconstruction and background operation priorities (only for RAID Type: raidDiskPool)
Example : "DiskPoolPriorityUpdateRequest"

DiskPoolPriorityUpdateRequest

poolThreshold
optional

Set the reconstruction and background operation priorities (only for RAID Type: raidDiskPool)
Example : "DiskPoolThresholdUpdateRequest"

DiskPoolThresholdUpdateRequest

4.579. VolumeGroupExpansionCandidate

Name Description Schema

drives
required

An array of references to drives comprising the set that can be used to expand the volume group.
Example : [ "string" ]

< string > array

trayLossProtection
required

Set to true if the expanded volume group will have tray loss protection.
Example : true

boolean

wastedCapacity
required

The number of bytes of wasted capacity in the given drive set if is used to expand the volume. Wasting of capacity occurs when the drives in the set are larger than the drives in the volume group being expanded.
Example : "string"

string (int64)

spindleSpeedMatch
required

Set to true if the expanded volume group will have uniform spindle speed across its drives.
Example : true

boolean

drawerLossProtection
required

Set to true if the expanded volume group will have drawer loss protection.
Example : true

boolean

usableCapacity
required

The total usable capacity of the expansion candidate in bytes.
Example : "string"

string (int64)

driveBlockFormat
required

Identifies the drive block format of the volume candidate.
Example : "string"

enum (unknown, allNative, allEmulated, mixed, __UNDEFINED)

4.580. StoragePoolExpansionRequest

Used for expanding the capacity of a Storage Pool.

Name Description Schema

drives
required

The list of drives to add to the Pool. A maximum of 12 drives is allowed for Pools of type raidDiskPool and 2 for others.
Example : [ "string" ]

< string > array

4.581. RemovableDriveResponse

Name Description Schema

poolId
required

The id of the StoragePool.
Example : "string"

string

removableDriveCount
required

Maximum number of drives that can be removed from the StoragePool in order to shrink its capacity and disk usage.
Example : 0

integer (int32)

4.582. DiskPoolReductionRequest

Reduce the number of drives in a VolumeGroup.

Name Description Schema

drives
required

Id list of drives to remove.
Example : [ "string" ]

< string > array

4.583. VolumeCreateRequest

Creates a Volume.

Name Description Schema

poolId
required

The identifier of the storage pool from which the volume will be allocated.
Example : "string"

string

name
required

The user-label to assign to the new volume.
Example : "string"

string

sizeUnit
optional

Unit for "size"
Example : "gb"

enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb)

size
required

Number of units (See sizeUnit) to make the volume.
Example : "string"

string (int64)

segSize
required

The segment size (KB) of the volume. A zero value will set a system-specific default value.
Default : 0
Example : 0

integer (int32)

dataAssuranceEnabled
optional

Default : false
Example : true

boolean

owningControllerId
optional

Set the preferred owning controller. By default this field will alternate between available controllers
Example : "string"

string

metaTags
optional

Optional array of Meta Data tags for the volume.
Example : [ "VolumeMetadataItem" ]

< VolumeMetadataItem > array

4.584. VolumeActionProgressResponse

Object to represent an operation (VolumeAction) on a Volume along with operational data.

Name Description Schema

percentComplete
required

The completion percentage of a "long-running" operation on a volume.
Example : 0

integer (int32)

timeToCompletion
required

The estimated elapsed time to completion in minutes. Note that this field is always set to -1 for basic RAID volumes.
Example : 0

integer (int32)

action
required

Enum defining the current volume action in progress.
Example : "string"

enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED)

4.585. VolumeExpansionRequest

Expands a Volume.

Name Description Schema

sizeUnit
required

Unit for "expansionSize"
Example : "string"

enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb)

expansionSize
required

Number of units (See sizeUnit) to make the volume (must be greater than the current capacity).
Example : "string"

string (int64)

4.586. VolumeCacheSettings

Change configured cache settings for a volume.

Name Description Schema

readCacheEnable
optional

Indicates whether read caching should be enabled for the volume.
Example : true

boolean

writeCacheEnable
optional

Indicates whether write-back caching should be enabled for the volume.
Example : true

boolean

readAheadEnable
optional

Indicates whether or not automatic cache read-ahead is enabled
Example : true

boolean

cacheFlushModifier
optional

The cache flush modifier value, which is used to specify the maximum amount of time that dirty data for this volume may be retained in the controller’s write cache prior to being flushed to disk.
Example : "string"

enum (flushImmediate, flush250Msec, flush500Msec, flush750Msec, flush1Sec, flush1500Msec, flush2Sec, flush5Sec, flush10Sec, flush20Sec, flush60Sec, flush120Sec, flush300Sec, flush1200Sec, flush3600Sec, flushInfinite, __UNDEFINED)

mirrorEnable
optional

Indicates whether cache mirroring should be enabled for this volume. If enabled, all cache data will be mirrored across controllers to provide increased resilience to potential controller failures.
Example : true

boolean

cacheWithoutBatteries
optional

Indicates whether caching without batteries should be allowed for this volume. Note that setting this attribute to true may result in data loss if the array’s cache hold-up battery fails, and then a disorderly power-down of the array occurs. This feature should be used only with extreme caution.
Example : true

boolean

4.587. VolumeUpdateRequest

Updates a Volume.

Name Description Schema

name
optional

The user-label to assign to the new volume.
Example : "string"

string

owningControllerId
optional

Set the preferred owning controller
Example : "string"

string

cacheSettings
optional

Configure cache settings for the volume
Example : "VolumeCacheSettings"

VolumeCacheSettings

flashCache
optional

If true, add the volume to the flashCache if one is defined. If false, remove from the flashCache if one exists.
Example : true

boolean

scanSettings
optional

Configure scan settings with regard to the controller’s background media scan operation
Example : "VolumeMediaScanParams"

VolumeMediaScanParams

metaTags
optional

Optional array of Meta Data tags for the volume.
Example : [ "VolumeMetadataItem" ]

< VolumeMetadataItem > array

4.588. VolumeMappingCreateRequest

Creates a Volume Mapping - maps a Volume to a Host or Host Group.

Name Description Schema

mappableObjectId
required

The mappable object such as a volume or snapshot volume.
Example : "string"

string

targetId
optional

The host group or a host for the volume mapping. If left null, the default host group will be used
Example : "string"

string

lun
optional

The LUN for the volume mapping.
Example : 0

integer (int32)

4.589. VolumeMappingMoveRequest

Move a volume mapping from a Host/Group to another Host/Group

Name Description Schema

targetId
optional

The host group or a host for the volume mapping. If left null, the default host group will be used
Example : "string"

string

lun
optional

The LUN for the volume mapping.
Example : 0

integer (int32)

4.590. WorkloadAttribute

An attribute assigned to a work load. This is completely arbitrary and can be used for any purpose by the user..

Name Description Schema

key
required

The key for this attribute.
Example : "string"

string

value
required

The value for the attribute.
Example : "string"

string

4.591. WorkloadModel

A workload is a tag that can be assigned to a volume. It is completely arbitrary and can be used for any purpose by the user..

Name Description Schema

id
optional

The id for this workload.
Example : "string"

string

name
required

The name for this workload.
Example : "string"

string

workloadAttributes
optional

Key/Value pairs to assigned to this workload.
Example : [ "WorkloadAttribute" ]

< WorkloadAttribute > array

4.592. WorkloadCreateRequest

A workload is a tag that can be assigned to a volume. It is completely arbitrary and can be used for any purpose by the user..

Name Description Schema

name
optional

The id for this workload.
Example : "string"

string

workloadAttributes
optional

Key/Value pairs to assigned to this workload.
Example : [ "WorkloadAttribute" ]

< WorkloadAttribute > array

4.593. WorkloadCopyRequest

Copies a workload and names it with the given name

Name Description Schema

newWorkloadName
required

Name of the new workload.
Example : "string"

string

changeVolumeTags
optional

If true, volumes tagged to the old workload will be moved to be tagged to the new workload
Example : true

boolean

4.594. WorkloadUpdateRequest

A workload is a tag that can be assigned to a volume. It is completely arbitrary and can be used for any purpose by the user..

Name Description Schema

workloadAttributes
optional

Key/Value pairs to assigned to this workload.
Example : [ "WorkloadAttribute" ]

< WorkloadAttribute > array