1. Overview

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

1.1. Version information

Version : 2.1.1

1.2. URI scheme

BasePath : /devmgr/v2

1.3. Tags

  • Administration

  • 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 used in. 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 run the SANtricity REST endpoint. Users must authenticate with the correct user role type to authorized 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 = [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 = [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. Return a secure random token of 16 bytes

GET /devmgr/v2/client-token
MetaData

x-mode = both
x-allowedRoles = [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.5. Retrieve local users information.

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

EmbeddedLocalUserInfoResponse

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.6. 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 = [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

< EmbeddedLocalUserResponse > 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.7. Set the password for local users

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

x-mode = embedded
x-allowedRoles = [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

EmbeddedLocalUserRequest

Responses
HTTP Code Description Schema

default

successful operation

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.8. Set the minimum password length

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

x-mode = embedded
x-allowedRoles = [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

EmbeddedLocalUsersMinPasswordRequest

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.9. Retrieve session settings.

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

x-mode = embedded
x-allowedRoles = [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.10. Update session settings.

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

x-mode = embedded
x-allowedRoles = [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.11. Retrieve session settings.

GET /devmgr/v2/settings/sessions
MetaData

x-mode = proxy
x-allowedRoles = [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.12. Update session settings.

POST /devmgr/v2/settings/sessions
MetaData

x-mode = proxy
x-allowedRoles = [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.13. GET the SSL Configuration

GET /devmgr/v2/sslconfig
MetaData

x-mode = both
x-allowedRoles = [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.14. Set the SSL Configuration causing a regeneration of the SSL Certificate.

POST /devmgr/v2/sslconfig
MetaData

x-mode = both
x-allowedRoles = [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.15. Asynchonously Reloads SSL Configuration. When this call returns, the reload has been requested

POST /devmgr/v2/sslconfig/reload
MetaData

x-mode = both
x-allowedRoles = [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.16. Upload a previously exported certificate signing request

POST /devmgr/v2/sslconfig/import
MetaData

x-mode = both
x-allowedRoles = [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" : 0,
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.17. Gets the list of known trusted certificate authorities

GET /devmgr/v2/sslconfig/ca
MetaData

x-mode = both
x-allowedRoles = [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.18. Upload the root/intermediate certificates from a certificate authority that signed the certificate used for this server

POST /devmgr/v2/sslconfig/ca
MetaData

x-mode = both
x-allowedRoles = [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.19. Retrieves an x509 certificate signing request

GET /devmgr/v2/sslconfig/export
Description

The response type of this method is a file stream.

MetaData

x-mode = both
x-allowedRoles = [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.20. Deletes the CA with the given aliass

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

x-mode = both
x-allowedRoles = [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.21. Reset the webserer back to a self-signed certificate

POST /devmgr/v2/sslconfig/reset
Description

Removes all previously uploaded certificates from the keystore and asynchronously reloads the SSL configuration.

MetaData

x-mode = both
x-allowedRoles = [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.22. Retrieves the certificate revocation settings.

GET /devmgr/v2/sslconfig/settings
Description

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

MetaData

x-mode = both
x-allowedRoles = [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.23. Configure certificate revocation settings.

POST /devmgr/v2/sslconfig/settings
Description

Used to configure certificate settings such as if revocation checking should be enabled and if a specific OCSP responder URL should be used.

MetaData

x-mode = both
x-allowedRoles = [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.24. 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.25. Set if the SYMbol port is enabled

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

x-mode = embedded
x-allowedRoles = [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. Configuration

3.2.1. Retrieve ASUP configuration info

GET /devmgr/v2/asup
MetaData

x-mode = proxy
x-allowedRoles = [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" : 0,
  "default" : true
}

3.2.2. Update ASUP configuration info

POST /devmgr/v2/asup
MetaData

x-mode = proxy
x-allowedRoles = [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" : 0,
  "default" : true
}

3.2.3. Dispatch the ASUP bundle

POST /devmgr/v2/asup/dispatch
MetaData

x-mode = proxy
x-allowedRoles = [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" : 0,
  "default" : true
}

3.2.4. Register the ASUP bundle

POST /devmgr/v2/asup/register
MetaData

x-mode = proxy
x-allowedRoles = [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.2.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 = [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.2.6. Initiates a new bulk configuration operation

POST /devmgr/v2/configuration
MetaData

x-mode = proxy
x-allowedRoles = [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.2.7. Interrupts any current configuration process

DELETE /devmgr/v2/configuration
MetaData

x-mode = proxy
x-allowedRoles = [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.2.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 = [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.2.9. Used to validate an input CSV file previously uploaded

POST /devmgr/v2/configuration/validate
MetaData

x-mode = proxy
x-allowedRoles = [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.3. Copy-Services

3.3.1. Get consistency group

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

x-mode = both
x-allowedRoles = [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" : [ 0 ],
  "creationPendingStatus" : "string",
  "name" : "string",
  "id" : "string"
}

3.3.2. Update consistency group

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

x-mode = both
x-allowedRoles = [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" : [ 0 ],
  "creationPendingStatus" : "string",
  "name" : "string",
  "id" : "string"
}

3.3.3. Delete consistency group

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

x-mode = both
x-allowedRoles = [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.3.4. Get all consistency groups

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

x-mode = both
x-allowedRoles = [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" : [ 0 ],
  "creationPendingStatus" : "string",
  "name" : "string",
  "id" : "string"
} ]

3.3.5. Create consistency group

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

x-mode = both
x-allowedRoles = [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" : [ 0 ],
  "creationPendingStatus" : "string",
  "name" : "string",
  "id" : "string"
}

3.3.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 = [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" : 0,
  "usedRepositoryCapacity" : 0,
  "fullWarnThreshold" : 0,
  "totalSnapshotImages" : 0,
  "totalSnapshotVolumes" : 0,
  "autoDeleteSnapshots" : true,
  "autoDeleteLimit" : 0,
  "pitGroupId" : "string",
  "repositoryVolume" : "string"
} ]

3.3.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 = [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" : 0,
  "viewSequenceNumber" : 0,
  "name" : "string",
  "id" : "string"
} ]

3.3.8. Get ConsistencyGroup members

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

x-mode = both
x-allowedRoles = [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" : 0,
  "usedRepositoryCapacity" : 0,
  "fullWarnThreshold" : 0,
  "totalSnapshotImages" : 0,
  "totalSnapshotVolumes" : 0,
  "autoDeleteSnapshots" : true,
  "autoDeleteLimit" : 0,
  "pitGroupId" : "string",
  "repositoryVolume" : "string"
} ]

3.3.9. Add ConsistencyGroup member

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

x-mode = both
x-allowedRoles = [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" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 0
    }
  }
}
Example HTTP response
Response 200
{
  "consistencyGroupId" : "string",
  "volumeId" : "string",
  "volumeWwn" : "string",
  "baseVolumeName" : "string",
  "clusterSize" : 0,
  "totalRepositoryVolumes" : 0,
  "totalRepositoryCapacity" : 0,
  "usedRepositoryCapacity" : 0,
  "fullWarnThreshold" : 0,
  "totalSnapshotImages" : 0,
  "totalSnapshotVolumes" : 0,
  "autoDeleteSnapshots" : true,
  "autoDeleteLimit" : 0,
  "pitGroupId" : "string",
  "repositoryVolume" : "string"
}

3.3.10. Get ConsistencyGroup member

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

x-mode = both
x-allowedRoles = [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" : 0,
  "usedRepositoryCapacity" : 0,
  "fullWarnThreshold" : 0,
  "totalSnapshotImages" : 0,
  "totalSnapshotVolumes" : 0,
  "autoDeleteSnapshots" : true,
  "autoDeleteLimit" : 0,
  "pitGroupId" : "string",
  "repositoryVolume" : "string"
}

3.3.11. Remove ConsistencyGroup member

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

x-mode = both
x-allowedRoles = [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.3.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 = [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" : 0,
  "usedRepositoryCapacity" : 0,
  "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.3.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 = [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.3.14. Get Snapshots associated with the ConsistencyGroup

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

x-mode = both
x-allowedRoles = [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" : 0,
  "pitSequenceNumber" : 0,
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : 0,
  "repositoryCapacityUtilization" : 0,
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
} ]

3.3.15. Create ConsistencyGroup snapshot

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

x-mode = both
x-allowedRoles = [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" : 0,
  "pitSequenceNumber" : 0,
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : 0,
  "repositoryCapacityUtilization" : 0,
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
} ]

3.3.16. 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 = [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" : 0,
  "pitSequenceNumber" : 0,
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : 0,
  "repositoryCapacityUtilization" : 0,
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
} ]

3.3.17. Remove ConsistencyGroup snapshot

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

x-mode = both
x-allowedRoles = [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.3.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 = [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" : 0,
  "viewSequenceNumber" : 0,
  "name" : "string",
  "id" : "string"
} ]

3.3.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 = [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" : 0,
  "accessMode" : "string",
  "repositoryPercent" : 0.0,
  "scanMedia" : true,
  "validateParity" : true
}
Example HTTP response
Response 200
{
  "cgViewRef" : "string",
  "groupRef" : "string",
  "label" : "string",
  "viewTime" : 0,
  "viewSequenceNumber" : 0,
  "name" : "string",
  "id" : "string"
}

3.3.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 = [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" : 0,
  "viewSequenceNumber" : 0,
  "name" : "string",
  "id" : "string"
}

3.3.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 = [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.3.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 = [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" : 0,
  "viewSequenceNumber" : 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
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "volumeFull" : true,
  "repositoryCapacity" : 0,
  "baseVolumeCapacity" : 0,
  "totalSizeInBytes" : 0,
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
} ]

3.3.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 = [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" : 0,
  "requests" : [ {
    "pitId" : "string",
    "candidate" : {
      "candType" : "string",
      "newVolCandidate" : {
        "memberVolumeLabel" : "string",
        "memberVolumeGroupLabel" : "string",
        "memberCandidate" : {
          "raidLevel" : "string",
          "trayLossProtection" : true,
          "rawSize" : 0,
          "usableSize" : 0,
          "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" : 0,
              "unusableCapacity" : 0
            }
          },
          "driveBlockFormat" : "string",
          "allocateReservedSpace" : true,
          "securityLevel" : "string"
        },
        "memberCapacity" : 0
      },
      "existVolCandidate" : {
        "refType" : "string",
        "memberVolumeRef" : [ "string" ],
        "memberLabel" : [ "string" ]
      },
      "expansionDescriptor" : {
        "additionalCapacity" : 0
      }
    },
    "accessMode" : "string",
    "scanMedia" : true,
    "validateParity" : true
  } ]
}
Example HTTP response
Response 200
{
  "cgViewRef" : "string",
  "groupRef" : "string",
  "label" : "string",
  "viewTime" : 0,
  "viewSequenceNumber" : 0,
  "name" : "string",
  "id" : "string"
}

3.3.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 = [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" : 0,
  "snapRef" : "string"
} ]

3.3.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 = [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" : 0,
  "snapRef" : "string"
}

3.3.26. Get Legacy Snapshots

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

x-mode = both
x-allowedRoles = [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" : 0,
  "extentSize" : 0,
  "snapshotTime" : 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
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : 0,
  "totalSizeInBytes" : 0,
  "preferredControllerId" : "string",
  "repositoryCapacity" : 0,
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
} ]

3.3.27. Create Legacy Snapshot

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

x-mode = both
x-allowedRoles = [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" : 0,
  "extentSize" : 0,
  "snapshotTime" : 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
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : 0,
  "totalSizeInBytes" : 0,
  "preferredControllerId" : "string",
  "repositoryCapacity" : 0,
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
}

3.3.28. Get Legacy Snapshot

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

x-mode = both
x-allowedRoles = [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" : 0,
  "extentSize" : 0,
  "snapshotTime" : 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
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : 0,
  "totalSizeInBytes" : 0,
  "preferredControllerId" : "string",
  "repositoryCapacity" : 0,
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
}

3.3.29. Update a Legacy Snapshot

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

x-mode = both
x-allowedRoles = [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" : 0,
  "extentSize" : 0,
  "snapshotTime" : 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
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : 0,
  "totalSizeInBytes" : 0,
  "preferredControllerId" : "string",
  "repositoryCapacity" : 0,
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
}

3.3.30. Delete a Legacy Snapshot

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

x-mode = both
x-allowedRoles = [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.3.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 = [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" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 0
    }
  } ]
}
Example HTTP response
Response 200
{
  "raidLevelMatch" : true,
  "samePool" : true,
  "candidate" : {
    "candType" : "string",
    "newVolCandidate" : {
      "memberVolumeLabel" : "string",
      "memberVolumeGroupLabel" : "string",
      "memberCandidate" : {
        "raidLevel" : "string",
        "trayLossProtection" : true,
        "rawSize" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 0
    }
  },
  "volumeGroupId" : "string",
  "capacityMatch" : true,
  "qosMatch" : true,
  "diskPool" : true,
  "capacity" : 0,
  "baseMappableObjectId" : "string",
  "candidateType" : "string",
  "securityMatch" : true,
  "daMatch" : true,
  "driveTypeMatch" : true,
  "existingCandidate" : true
} ]

3.3.32. 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 = [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" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 0
    }
  } ],
  "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" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 0
    }
  },
  "volumeGroupId" : "string",
  "capacityMatch" : true,
  "qosMatch" : true,
  "diskPool" : true,
  "capacity" : 0,
  "baseMappableObjectId" : "string",
  "candidateType" : "string",
  "securityMatch" : true,
  "daMatch" : true,
  "driveTypeMatch" : true,
  "existingCandidate" : true
} ]

3.3.33. Retrieve the list of Concat Repository Volumes.

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

x-mode = both
x-allowedRoles = [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" : 0,
  "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.3.34. Get a specific Concat Repository Volume.

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

x-mode = both
x-allowedRoles = [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" : 0,
  "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.3.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 = [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" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 0
    }
  }
}
Example HTTP response
Response 200
{
  "concatVolRef" : "string",
  "status" : "string",
  "memberCount" : 0,
  "aggregateCapacity" : 0,
  "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.3.36. Get a Snapshot Group

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

x-mode = both
x-allowedRoles = [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" : 0,
  "maxBaseCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "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" : 0,
  "id" : "string",
  "name" : "string"
}

3.3.37. Update a Snapshot Group

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

x-mode = both
x-allowedRoles = [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" : 0,
  "maxBaseCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "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" : 0,
  "id" : "string",
  "name" : "string"
}

3.3.38. Delete a Snapshot Group

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

x-mode = both
x-allowedRoles = [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.3.39. Get all Snapshot Groups

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

x-mode = both
x-allowedRoles = [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" : 0,
  "maxBaseCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "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" : 0,
  "id" : "string",
  "name" : "string"
} ]

3.3.40. Create a Snapshot Group

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

x-mode = both
x-allowedRoles = [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" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 0
    }
  },
  "schedule" : {
    "action" : "string",
    "targetObject" : "string",
    "scheduleMethod" : "string",
    "dailySchedule" : {
      "timeOfDay" : 0,
      "everyNMinutes" : 0,
      "timesPerDay" : 0
    },
    "daysOfWeek" : [ "string" ],
    "monthsOfYear" : [ "string" ],
    "daysOfMonth" : [ "string" ],
    "startDate" : 0,
    "endDate" : 0,
    "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" : 0,
  "maxBaseCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "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" : 0,
  "id" : "string",
  "name" : "string"
}

3.3.41. 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 = [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" : 0,
  "pitGroupBytesAvailable" : 0,
  "groupRef" : "string",
  "pitUtilization" : [ {
    "pitRef" : "string",
    "bytesUsed" : 0
  } ]
}

3.3.42. 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 = [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" : 0,
  "pitGroupBytesAvailable" : 0,
  "groupRef" : "string",
  "pitUtilization" : [ {
    "pitRef" : "string",
    "bytesUsed" : 0
  } ]
} ]

3.3.43. Get all Snapshots

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

x-mode = both
x-allowedRoles = [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" : 0,
  "pitSequenceNumber" : 0,
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : 0,
  "repositoryCapacityUtilization" : 0,
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
} ]

3.3.44. Create a Snapshot

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

x-mode = both
x-allowedRoles = [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" : 0,
  "pitSequenceNumber" : 0,
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : 0,
  "repositoryCapacityUtilization" : 0,
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
}

3.3.45. Get a Snapshot Volume

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

x-mode = both
x-allowedRoles = [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" : 0,
  "pitSequenceNumber" : 0,
  "status" : "string",
  "activeCOW" : true,
  "isRollbackSource" : true,
  "pitCapacity" : 0,
  "repositoryCapacityUtilization" : 0,
  "baseVol" : "string",
  "consistencyGroupId" : "string",
  "id" : "string"
}

3.3.46. Delete a Snapshot Volume

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

x-mode = both
x-allowedRoles = [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.3.47. Get all Snapshot Schedules

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

x-mode = both
x-allowedRoles = [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" : 0,
    "recurrence" : {
      "recurrenceType" : "string",
      "recurrenceCount" : 0,
      "recurrenceEndDate" : 0
    },
    "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" : 0,
  "lastRunTime" : 0,
  "nextRunTime" : 0,
  "stopTime" : 0,
  "id" : "string"
} ]

3.3.48. Get a Snapshot Schedule

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

x-mode = both
x-allowedRoles = [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" : 0,
    "recurrence" : {
      "recurrenceType" : "string",
      "recurrenceCount" : 0,
      "recurrenceEndDate" : 0
    },
    "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" : 0,
  "lastRunTime" : 0,
  "nextRunTime" : 0,
  "stopTime" : 0,
  "id" : "string"
}

3.3.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 = [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" : 0,
  "viewBytesAvailable" : 0,
  "viewRef" : "string"
}

3.3.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 = [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" : 0,
  "viewBytesAvailable" : 0,
  "viewRef" : "string"
} ]

3.3.51. Get all Snapshot Volumes

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

x-mode = both
x-allowedRoles = [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" : 0,
  "viewSequenceNumber" : 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
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "volumeFull" : true,
  "repositoryCapacity" : 0,
  "baseVolumeCapacity" : 0,
  "totalSizeInBytes" : 0,
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
} ]

3.3.52. Create a Snapshot Volume

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

x-mode = both
x-allowedRoles = [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" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 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" : 0,
  "viewSequenceNumber" : 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
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "volumeFull" : true,
  "repositoryCapacity" : 0,
  "baseVolumeCapacity" : 0,
  "totalSizeInBytes" : 0,
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
}

3.3.53. Get a Snapshot Volume

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

x-mode = both
x-allowedRoles = [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" : 0,
  "viewSequenceNumber" : 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
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "volumeFull" : true,
  "repositoryCapacity" : 0,
  "baseVolumeCapacity" : 0,
  "totalSizeInBytes" : 0,
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
}

3.3.54. Update a Snapshot Volume

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

x-mode = both
x-allowedRoles = [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" : 0,
  "viewSequenceNumber" : 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
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "volumeFull" : true,
  "repositoryCapacity" : 0,
  "baseVolumeCapacity" : 0,
  "totalSizeInBytes" : 0,
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
}

3.3.55. Delete a Snapshot Volume

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

x-mode = both
x-allowedRoles = [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.3.56. 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 = [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" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 0
    }
  },
  "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" : 0,
  "viewSequenceNumber" : 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
  },
  "volumeHandle" : 0,
  "clusterSize" : 0,
  "maxRepositoryCapacity" : 0,
  "unusableRepositoryCapacity" : 0,
  "membership" : {
    "viewType" : "string",
    "cgViewRef" : "string"
  },
  "mgmtClientAttribute" : 0,
  "offline" : true,
  "volumeFull" : true,
  "repositoryCapacity" : 0,
  "baseVolumeCapacity" : 0,
  "totalSizeInBytes" : 0,
  "consistencyGroupId" : "string",
  "volumeCopyTarget" : true,
  "cloneCopy" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "objectType" : "string",
  "currentControllerId" : "string",
  "wwn" : "string",
  "listOfMappings" : [ {
    "lunMappingRef" : "string",
    "lun" : 0,
    "ssid" : 0,
    "perms" : 0,
    "volumeRef" : "string",
    "type" : "string",
    "mapRef" : "string",
    "id" : "string"
  } ],
  "mapped" : true,
  "preferredControllerId" : "string",
  "onlineVolumeCopy" : true,
  "name" : "string",
  "id" : "string"
}

3.3.57. Get progress of a copy pair

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

x-mode = both
x-allowedRoles = [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.3.58. Get progress of all copy pairs

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

x-mode = both
x-allowedRoles = [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.3.59. Start/Stop a copy pair operation

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

x-mode = both
x-allowedRoles = [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.3.60. Get a volume copy pair

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

x-mode = both
x-allowedRoles = [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" : 0,
  "copyStartTime" : 0,
  "copyPriority" : "string",
  "reserved1" : "string",
  "cloneCopy" : true,
  "pgRef" : "string",
  "baseSourceVolumeId" : "string",
  "onlineCopy" : true,
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.3.61. Update parameters of a volume copy pair

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

x-mode = both
x-allowedRoles = [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" : 0,
  "copyStartTime" : 0,
  "copyPriority" : "string",
  "reserved1" : "string",
  "cloneCopy" : true,
  "pgRef" : "string",
  "baseSourceVolumeId" : "string",
  "onlineCopy" : true,
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.3.62. 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 = [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.3.63. Get the list of volume copy pairs

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

x-mode = both
x-allowedRoles = [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" : 0,
  "copyStartTime" : 0,
  "copyPriority" : "string",
  "reserved1" : "string",
  "cloneCopy" : true,
  "pgRef" : "string",
  "baseSourceVolumeId" : "string",
  "onlineCopy" : true,
  "id" : "string"
} ]

3.3.64. 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 = [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" : 0,
        "usableSize" : 0,
        "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" : 0,
            "unusableCapacity" : 0
          }
        },
        "driveBlockFormat" : "string",
        "allocateReservedSpace" : true,
        "securityLevel" : "string"
      },
      "memberCapacity" : 0
    },
    "existVolCandidate" : {
      "refType" : "string",
      "memberVolumeRef" : [ "string" ],
      "memberLabel" : [ "string" ]
    },
    "expansionDescriptor" : {
      "additionalCapacity" : 0
    }
  }
}
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "volcopyHandle" : 0,
  "volcopyRef" : "string",
  "status" : "string",
  "sourceVolume" : "string",
  "targetVolume" : "string",
  "currentManager" : "string",
  "idleTargetWriteProt" : true,
  "copyCompleteTime" : 0,
  "copyStartTime" : 0,
  "copyPriority" : "string",
  "reserved1" : "string",
  "cloneCopy" : true,
  "pgRef" : "string",
  "baseSourceVolumeId" : "string",
  "onlineCopy" : true,
  "id" : "string"
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.4. Device-ASUP

3.4.1. Retrieve ASUP information for all storage devices

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

x-mode = embedded
x-allowedRoles = [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.4.2. Verify a device ASUP configuration

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

x-mode = embedded
x-allowedRoles = [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.4.3. Retrieve a list of ASUP transimission log files

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

x-mode = embedded
x-allowedRoles = [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" : 0,
  "fileName" : "string"
} ]

3.4.4. 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 = [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.4.5. Retrieve the device ASUP configuration

GET /devmgr/v2/device-asup
MetaData

x-mode = embedded
x-allowedRoles = [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.4.6. Update the device ASUP configuration

POST /devmgr/v2/device-asup
MetaData

x-mode = embedded
x-allowedRoles = [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. Diagnostics

3.5.1. Retrieve the syslog configuration

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

x-mode = embedded
x-allowedRoles = [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.5.2. Update the syslog configuration

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

x-mode = embedded
x-allowedRoles = [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.5.3. 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 = [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.5.4. Get the core dump information

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

x-mode = both
x-allowedRoles = [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" : 0
}

3.5.5. 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 = [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.5.6. Retrieve the device Alerts configuration

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

x-mode = embedded
x-allowedRoles = [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.5.7. Update the device Alerts configuration

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

x-mode = embedded
x-allowedRoles = [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.5.8. Retrieve diagnostic data about the managed device

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

x-mode = embedded
x-allowedRoles = [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.5.9. Get list of failures

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

x-mode = both
x-allowedRoles = [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.5.10. 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 = [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" : 0,
  "progress" : {
    "complete" : true,
    "percentage" : 0
  },
  "sizeInBytes" : 0,
  "type" : "string",
  "filename" : "string"
}

3.5.11. Initiate a support data retrieval request

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

x-mode = embedded
x-allowedRoles = [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" : 0
}

3.5.12. Retrieves a particular syslog server configuration.

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

x-mode = embedded
x-allowedRoles = [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.5.13. Update an existing syslog server configuration.

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

x-mode = embedded
x-allowedRoles = [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.5.14. Delete a syslog server configuration.

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

x-mode = embedded
x-allowedRoles = [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.5.15. 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 = [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.5.16. Retrieve all syslog server configurations.

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

x-mode = embedded
x-allowedRoles = [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.5.17. Add a new syslog server configuration.

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

x-mode = embedded
x-allowedRoles = [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. Drive-Firmware

3.6.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 = [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.6.2. Cancel the on going update operations.

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

x-mode = both
x-allowedRoles = [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.6.3. 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 = [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.6.4. Deletes a drive firmware file

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

x-mode = both
x-allowedRoles = [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.6.5. Retrieve list of files in the drive firmware directory

GET /devmgr/v2/files/drive
MetaData

x-mode = both
x-allowedRoles = [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" : 0,
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.6.6. 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 = [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" : 0,
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.6.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 = [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.6.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 = [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.7. File-Management

3.7.1. 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 = [storage.monitor, storage.admin, support.admin, security.admin]

Parameters
Type Name Description Schema

Path

id
required

The ID of the file to be retrieved

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/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.7.2. Deletes a file from the private file directory

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

x-mode = both
x-allowedRoles = [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.7.3. 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 = [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" : 0,
  "fileID" : "string",
  "fileURL" : "string"
}

3.7.4. Gets a file from the scratch directory

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

The response type of this method is a file stream.

MetaData

x-mode = both
x-allowedRoles = [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.7.5. Deletes a generic file

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

x-mode = both
x-allowedRoles = [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.7.6. Retrieve a file from the scratch directory

GET /devmgr/v2/files
MetaData

x-mode = both
x-allowedRoles = [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" : 0,
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.7.7. 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 = [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" : 0,
  "fileName" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.7.8. Retrieve the list of support artifacts by type

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

x-mode = embedded
x-allowedRoles = [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" : 0
  } ]
} ]

3.7.9. Retrieve a specific support artifact.

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

x-mode = embedded
x-allowedRoles = [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.7.10. Deletes a specific support artifact.

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

x-mode = embedded
x-allowedRoles = [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.8. Firmware

3.8.1. Get the list of firmware files

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

x-mode = proxy
x-allowedRoles = [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.8.2. Get a specific firmware file

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

x-mode = proxy
x-allowedRoles = [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.8.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 = [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" : 0,
  "healthCheck" : {
    "storageDeviceId" : "string",
    "storageDeviceName" : "string",
    "storageDeviceWWN" : "string",
    "processingTimeMS" : 0,
    "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" : 0,
  "result" : {
    "requestId" : 0,
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : 0,
      "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.8.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 = [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" : 0
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ],
  "requestId" : 0,
  "result" : {
    "requestId" : 0,
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : 0,
      "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.8.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 = [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" : 0,
  "healthCheck" : {
    "storageDeviceId" : "string",
    "storageDeviceName" : "string",
    "storageDeviceWWN" : "string",
    "processingTimeMS" : 0,
    "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" : 0,
  "result" : {
    "requestId" : 0,
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : 0,
      "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.8.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 = [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" : 0,
  "codeVersions" : [ {
    "codeModule" : "string",
    "versionString" : "string"
  } ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ],
  "requestId" : 0,
  "result" : {
    "requestId" : 0,
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : 0,
      "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.8.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 = [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.8.8. 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 = [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.8.9. Get last successful firmware upgrade timestamps and firmware upgrade logs

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

x-mode = embedded
x-allowedRoles = [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" : 0,
    "sourceClassName" : "string",
    "sourceMethodName" : "string",
    "message" : "string",
    "threadID" : 0,
    "millis" : 0,
    "thrown" : {
      "cause" : {
        "cause" : "...",
        "stackTrace" : [ {
          "methodName" : "string",
          "fileName" : "string",
          "lineNumber" : 0,
          "className" : "string",
          "nativeMethod" : true
        } ],
        "message" : "string",
        "localizedMessage" : "string",
        "suppressed" : [ "..." ]
      },
      "stackTrace" : [ {
        "methodName" : "string",
        "fileName" : "string",
        "lineNumber" : 0,
        "className" : "string",
        "nativeMethod" : true
      } ],
      "message" : "string",
      "localizedMessage" : "string",
      "suppressed" : [ "..." ]
    },
    "loggerName" : "string",
    "resourceBundleName" : "string",
    "parameters" : [ "object" ],
    "resourceBundle" : {
      "locale" : {
        "language" : "string",
        "script" : "string",
        "country" : "string",
        "variant" : "string",
        "extensionKeys" : [ "string" ],
        "unicodeLocaleAttributes" : [ "string" ],
        "unicodeLocaleKeys" : [ "string" ],
        "iso3Language" : "string",
        "iso3Country" : "string",
        "displayLanguage" : "string",
        "displayScript" : "string",
        "displayCountry" : "string",
        "displayVariant" : "string",
        "displayName" : "string"
      },
      "baseBundleName" : "string",
      "keys" : { }
    }
  } ],
  "iomLog" : [ {
    "level" : {
      "name" : "string",
      "resourceBundleName" : "string",
      "localizedName" : "string"
    },
    "sequenceNumber" : 0,
    "sourceClassName" : "string",
    "sourceMethodName" : "string",
    "message" : "string",
    "threadID" : 0,
    "millis" : 0,
    "thrown" : "...",
    "loggerName" : "string",
    "resourceBundleName" : "string",
    "parameters" : [ "object" ],
    "resourceBundle" : {
      "locale" : {
        "language" : "string",
        "script" : "string",
        "country" : "string",
        "variant" : "string",
        "extensionKeys" : [ "string" ],
        "unicodeLocaleAttributes" : [ "string" ],
        "unicodeLocaleKeys" : [ "string" ],
        "iso3Language" : "string",
        "iso3Country" : "string",
        "displayLanguage" : "string",
        "displayScript" : "string",
        "displayCountry" : "string",
        "displayVariant" : "string",
        "displayName" : "string"
      },
      "baseBundleName" : "string",
      "keys" : { }
    }
  } ],
  "driveLog" : [ {
    "level" : {
      "name" : "string",
      "resourceBundleName" : "string",
      "localizedName" : "string"
    },
    "sequenceNumber" : 0,
    "sourceClassName" : "string",
    "sourceMethodName" : "string",
    "message" : "string",
    "threadID" : 0,
    "millis" : 0,
    "thrown" : "...",
    "loggerName" : "string",
    "resourceBundleName" : "string",
    "parameters" : [ "object" ],
    "resourceBundle" : {
      "locale" : {
        "language" : "string",
        "script" : "string",
        "country" : "string",
        "variant" : "string",
        "extensionKeys" : [ "string" ],
        "unicodeLocaleAttributes" : [ "string" ],
        "unicodeLocaleKeys" : [ "string" ],
        "iso3Language" : "string",
        "iso3Country" : "string",
        "displayLanguage" : "string",
        "displayScript" : "string",
        "displayCountry" : "string",
        "displayVariant" : "string",
        "displayName" : "string"
      },
      "baseBundleName" : "string",
      "keys" : { }
    }
  } ],
  "nvsramLog" : [ {
    "level" : {
      "name" : "string",
      "resourceBundleName" : "string",
      "localizedName" : "string"
    },
    "sequenceNumber" : 0,
    "sourceClassName" : "string",
    "sourceMethodName" : "string",
    "message" : "string",
    "threadID" : 0,
    "millis" : 0,
    "thrown" : "...",
    "loggerName" : "string",
    "resourceBundleName" : "string",
    "parameters" : [ "object" ],
    "resourceBundle" : {
      "locale" : {
        "language" : "string",
        "script" : "string",
        "country" : "string",
        "variant" : "string",
        "extensionKeys" : [ "string" ],
        "unicodeLocaleAttributes" : [ "string" ],
        "unicodeLocaleKeys" : [ "string" ],
        "iso3Language" : "string",
        "iso3Country" : "string",
        "displayLanguage" : "string",
        "displayScript" : "string",
        "displayCountry" : "string",
        "displayVariant" : "string",
        "displayName" : "string"
      },
      "baseBundleName" : "string",
      "keys" : { }
    }
  } ]
}

3.8.10. 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 = [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.8.11. 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 = [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" : 0,
  "codeVersions" : [ {
    "codeModule" : "string",
    "versionString" : "string"
  } ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ],
  "requestId" : 0,
  "result" : {
    "requestId" : 0,
    "healthCheck" : {
      "storageDeviceId" : "string",
      "storageDeviceName" : "string",
      "storageDeviceWWN" : "string",
      "processingTimeMS" : 0,
      "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.8.12. 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 = [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.8.13. 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 = [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.8.14. Performs a compatibility check on a NVSRAM file.

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

x-mode = embedded
x-allowedRoles = [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
{
  "fileCompatible" : true,
  "versionContents" : [ {
    "module" : "string",
    "bundledVersion" : "string",
    "onboardVersion" : "string"
  } ]
}

3.8.15. Performs a compatibility check 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 = [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
{
  "fileCompatible" : true,
  "versionContents" : [ {
    "module" : "string",
    "bundledVersion" : "string",
    "onboardVersion" : "string"
  } ]
}

3.8.16. 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 = [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.8.17. Get IOM service information

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

x-mode = embedded
x-allowedRoles = [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.8.18. Updates the IOM service configuration

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

x-mode = embedded
x-allowedRoles = [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.8.19. Request status of a firmware compatibility check operation

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

x-mode = proxy
x-allowedRoles = [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" : 0,
  "failedStorageDevices" : [ "string" ]
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.8.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 = [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" : 0,
  "failedStorageDevices" : [ "string" ]
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.8.21. Cancel a firmware compatibility check operation

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

x-mode = proxy
x-allowedRoles = [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.8.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 = [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" : 0,
  "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.8.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 = [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" : 0,
  "fileName" : "string"
}
Response 422
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.8.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 = [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.8.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 = [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" : 0,
  "healthCheckRunning" : true,
  "cancelled" : true,
  "remaining" : 0,
  "results" : [ {
    "storageDeviceId" : "string",
    "storageDeviceName" : "string",
    "storageDeviceWWN" : "string",
    "processingTimeMS" : 0,
    "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.8.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 = [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" : 0
}

3.8.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 = [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.9. Flash-Cache

3.9.1. 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 = [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.9.2. Retrieve the FlashCache, if it exists.

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

x-mode = both
x-allowedRoles = [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" : 0,
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.9.3. Define a new FlashCache

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

x-mode = both
x-allowedRoles = [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" : 0,
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}

3.9.4. Delete the defined FlashCache

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

x-mode = both
x-allowedRoles = [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.9.5. Remove drives currently being used by the FlashCache

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

x-mode = both
x-allowedRoles = [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" : 0,
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.9.6. Add drives to an existing FlashCache

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

x-mode = both
x-allowedRoles = [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" : 0,
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.9.7. Modify FlashCache parameters

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

x-mode = both
x-allowedRoles = [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" : 0,
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}

3.9.8. Suspend the FlashCache

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

x-mode = both
x-allowedRoles = [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" : 0,
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}

3.9.9. Resume a suspended FlashCache

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

x-mode = both
x-allowedRoles = [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" : 0,
      "securityLevel" : "string"
    }
  },
  "cachedVolumes" : [ "string" ],
  "driveRefs" : [ "string" ],
  "name" : "string",
  "id" : "string"
}

3.10. Hardware

3.10.1. Get a controller

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

x-mode = both
x-allowedRoles = [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" : 0,
  "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
  "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"
      } ],
      "ntpAuthenticationParams" : [ {
        "keyID" : 0,
        "messageDigestType" : "string",
        "sharedKey" : "string"
      } ]
    }
  },
  "repairPolicy" : {
    "removalData" : {
      "removalMethod" : "string",
      "rtrAttributes" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "replacementMethod" : "string"
  },
  "flashCacheMemorySize" : 0,
  "ctrlIocDumpData" : {
    "iocDumpNeedsRetrieved" : true,
    "iocDumpTag" : 0,
    "timeStamp" : 0
  },
  "locateInProgress" : true,
  "hasTrayIdentityIndicator" : true,
  "controllerErrorMode" : "string",
  "codeVersions" : [ {
    "codeModule" : "string",
    "versionString" : "string"
  } ],
  "id" : "string"
}

3.10.2. Get the list of controllers

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

x-mode = both
x-allowedRoles = [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" : 0,
  "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
      "bidirectionalMaxRate" : 0,
      "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" : 0,
  "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"
      } ],
      "ntpAuthenticationParams" : [ {
        "keyID" : 0,
        "messageDigestType" : "string",
        "sharedKey" : "string"
      } ]
    }
  },
  "repairPolicy" : {
    "removalData" : {
      "removalMethod" : "string",
      "rtrAttributes" : {
        "hasReadyToRemoveIndicator" : true,
        "readyToRemove" : true
      }
    },
    "replacementMethod" : "string"
  },
  "flashCacheMemorySize" : 0,
  "ctrlIocDumpData" : {
    "iocDumpNeedsRetrieved" : true,
    "iocDumpTag" : 0,
    "timeStamp" : 0
  },
  "locateInProgress" : true,
  "hasTrayIdentityIndicator" : true,
  "controllerErrorMode" : "string",
  "codeVersions" : [ {
    "codeModule" : "string",
    "versionString" : "string"
  } ],
  "id" : "string"
} ]

3.10.3. Get a drive

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

x-mode = both
x-allowedRoles = [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" : 0,
  "productID" : "string",
  "serialNumber" : "string",
  "softwareVersion" : "string",
  "blkSize" : 0,
  "usableCapacity" : 0,
  "rawCapacity" : 0,
  "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" : 0,
  "removed" : true,
  "locateInProgress" : true,
  "fipsCapable" : true,
  "firmwareVersion" : "string",
  "lockKeyIDValue" : "string",
  "id" : "string"
}

3.10.4. Get the list of unreadable sectors

GET /devmgr/v2/storage-systems/{system-id}/drives/unreadable-sectors
MetaData

x-mode = both
x-allowedRoles = [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" : 0,
    "volumeRef" : "string",
    "recordType" : "string",
    "trayNo" : 0,
    "volumeLBA" : 0,
    "slotNo" : 0,
    "driveLBA" : 0
  } ]
}

3.10.5. Get the list of drives

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

x-mode = both
x-allowedRoles = [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" : 0,
  "productID" : "string",
  "serialNumber" : "string",
  "softwareVersion" : "string",
  "blkSize" : 0,
  "usableCapacity" : 0,
  "rawCapacity" : 0,
  "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" : 0,
  "removed" : true,
  "locateInProgress" : true,
  "fipsCapable" : true,
  "firmwareVersion" : "string",
  "lockKeyIDValue" : "string",
  "id" : "string"
} ]

3.10.6. 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 = [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" : 0,
  "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" : 0,
  "productID" : "string",
  "serialNumber" : "string",
  "softwareVersion" : "string",
  "blkSize" : 0,
  "usableCapacity" : 0,
  "rawCapacity" : 0,
  "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" : 0,
  "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.10.7. Get hardware information

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

x-mode = both
x-allowedRoles = [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