1. Overview

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

1.1. Version information

Version : 04.00

1.2. URI scheme

BasePath : /devmgr/v2

1.3. Tags

  • Administration

  • Authentication

  • AutoSupport

  • Beta

  • Configuration

  • Containers

  • Copy-Services

  • Counters

  • Device-ASUP

  • Diagnostics

  • Drive-Firmware

  • File-Management

  • Firmware

  • Flash-Cache

  • Hardware

  • Key-Values

  • LDAP

  • Mapping

  • Mirroring

  • Monitoring

  • REST Forwarding

  • Security

  • Service-Catalog

  • Statistics

  • Storage-Systems

  • Synchronous-Mirroring

  • Upgrade

  • Volumes

  • Workloads

1.4. MetaData Descriptions

REST endpoint attribute descriptions

1.4.1. x-mode

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

1.4.2. x-allowedRoles

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

2. Security

2.1. basicAuth

Type : basic

3. Resources

3.1. Administration

3.1.1. Retrieve the login banner.

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

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

MetaData

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

Parameters
Type Name Description Schema Default

Path

system-id
required

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

string

Query

asFile
optional

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

boolean

"false"

Responses
HTTP Code Description Schema

200

The login banner was successfully returned

204

Access banner not configured

422

Unable to return the login banner

Consumes
  • application/json

Produces
  • application/octet-stream

  • text/plain

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

3.1.2. Upload a user defined login banner text file.

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

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

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

FormData

file
optional

login banner file

file

Responses
HTTP Code Description Schema

204

The login banner was successfully saved

422

Unable to save the login banner

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",
  "developerMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.3. Deletes the login banner file.

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

Deletes the login banner file.

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

204

The login banner was successfully deleted

422

Unable to delete the login banner

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",
  "developerMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.4. GET the SSL Configuration on the system

GET /devmgr/v2/certificates
MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

422

User input error

Consumes
  • application/json

Produces
  • application/json

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

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

POST /devmgr/v2/certificates
MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

202

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

422

User input error

Consumes
  • application/json

Produces
  • application/json

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

3.1.6. Get the list of storage system certificates

GET /devmgr/v2/certificates/storage-systems
Description

Retrieves a list of all server certificates that the https client has connected to.

MetaData

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

Parameters
Type Name Description Schema Default

Query

filterType
optional

Filters the certificates that are returned

enum (all, untrusted, trusted)

"all"

Responses
HTTP Code Description Schema

200

successful operation

404

An error occurred when attempting to retrieve certificate information

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/storage-systems
Example HTTP response
Response 200
{
  "storageArrayAssociation" : true,
  "associatedIP" : "string",
  "controller" : {
    "controllerId" : "string",
    "controllerSerialNumber" : "string",
    "arrayID" : "string",
    "arrayLabel" : "string",
    "arrayWWN" : "string"
  },
  "certificate" : {
    "alias" : "string",
    "shaFingerprint" : "string",
    "sha256Fingerprint" : "string",
    "subjectDN" : "string",
    "subjectRdns" : [ {
      "attributes" : [ {
        "name" : "string",
        "value" : "string"
      } ]
    } ],
    "issuerDN" : "string",
    "issuerRdns" : [ {
      "attributes" : [ {
        "name" : "string",
        "value" : "string"
      } ]
    } ],
    "start" : "string",
    "expire" : "string",
    "status" : "string",
    "truststore" : true,
    "isUserInstalled" : true,
    "isKeyEntry" : true,
    "type" : "string"
  }
} ]

3.1.7. Export a storage system certificate

POST /devmgr/v2/certificates/storage-systems/{shaFingerprint}/export
MetaData

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

Parameters
Type Name Description Schema

Path

shaFingerprint
required

The SHA Fingerprint for the certificate to be exported

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

An error occurred when attempting to retrieve the certificate

Consumes
  • application/json

Produces
  • application/json

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

3.1.8. Asynchronously reloads the SSL configuration

POST /devmgr/v2/certificates/reload
MetaData

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

Parameters
Type Name Description Schema Default

Query

reloadBoth
optional

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

boolean

"false"

Responses
HTTP Code Description Schema

202

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

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/reload

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

POST /devmgr/v2/certificates/reset
MetaData

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

Parameters
Type Name Description Schema Default

Query

reloadSSL
optional

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

boolean

"true"

Responses
HTTP Code Description Schema

202

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

422

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

Consumes
  • application/json

Produces
  • application/json

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

3.1.10. Retrieves the certificate revocation settings.

GET /devmgr/v2/certificates/settings
Description

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

MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

422

Unable to get the certificate revocation settings.

Consumes
  • application/json

Produces
  • application/json

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

3.1.11. Configure certificate revocation settings.

POST /devmgr/v2/certificates/settings
Description

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

MetaData

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

Parameters
Type Name Description Schema Default

Body

body
optional

Query

preventSslContextReload
optional

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

boolean

"false"

Responses
HTTP Code Description Schema

200

The certificate revocation options were successfully saved

422

Unable to save the certificate revocation settings

Consumes
  • application/json

Produces
  • application/json

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

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

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

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

Parameters
Type Name Description Schema

Query

ocspUrlString
optional

The URL of the OCSP address to test

string

Responses
HTTP Code Description Schema

200

successful operation

boolean

204

The test completed successfully.

404

Not able to find the OCSP URL.

422

Unable to connect to the OCSP’s URL.

Consumes
  • application/json

Produces
  • application/json

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

3.1.13. Retrieves information about the remote server certificates

GET /devmgr/v2/certificates/remote-server
MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

< X509CertInfo > array

422

An error occurred retrieving certificate data

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/remote-server
Example HTTP response
Response 200
{
  "alias" : "string",
  "shaFingerprint" : "string",
  "sha256Fingerprint" : "string",
  "subjectDN" : "string",
  "subjectRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "issuerDN" : "string",
  "issuerRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "start" : "string",
  "expire" : "string",
  "status" : "string",
  "truststore" : true,
  "isUserInstalled" : true,
  "isKeyEntry" : true,
  "type" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "developerMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.14. Uploads a certificate for a remote server

POST /devmgr/v2/certificates/remote-server
MetaData

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

Parameters
Type Name Description Schema

Query

alias
optional

The alias to associate with this certificate file. If the alias already exists on the system, the existing certificate will be overwritten. If no alias is provided a random one will be assigned.

string

FormData

file
optional

The certificate file to upload

file

Responses
HTTP Code Description Schema

204

The certificate was successfully uploaded

422

An error occurred when attempting to upload the file

Consumes
  • multipart/form-data

Produces
  • application/json

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

3.1.15. Retrieves information about a specific certificate

GET /devmgr/v2/certificates/remote-server/{alias}
MetaData

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

Parameters
Type Name Description Schema

Path

alias
required

The alias of the certificate file to get information about

string

Responses
HTTP Code Description Schema

200

successful operation

204

The certificate information was successfully returned

404

The certificate alias was not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/remote-server/string
Example HTTP response
Response 200
{
  "alias" : "string",
  "shaFingerprint" : "string",
  "sha256Fingerprint" : "string",
  "subjectDN" : "string",
  "subjectRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "issuerDN" : "string",
  "issuerRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "start" : "string",
  "expire" : "string",
  "status" : "string",
  "truststore" : true,
  "isUserInstalled" : true,
  "isKeyEntry" : true,
  "type" : "string"
}

3.1.16. Deletes a remote server certificate with the given alias

DELETE /devmgr/v2/certificates/remote-server/{alias}
MetaData

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

Parameters
Type Name Description Schema

Path

alias
required

The alias of the certificate file to delete

string

Responses
HTTP Code Description Schema

204

The certificate was successfully deleted

404

The certificate alias was not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/remote-server/string

3.1.17. Exports a remote server certificate

POST /devmgr/v2/certificates/remote-server/{alias}/export
MetaData

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

Parameters
Type Name Description Schema

Path

alias
required

The alias of the certificate file to export

string

Body

body
optional

Body to specify name of file

Responses
HTTP Code Description Schema

200

Certificate was successfully exported

404

The certificate alias was not found

422

An error occurred exporting the certificate file

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/remote-server/string/export
Request body
{
  "filename" : "string"
}

3.1.18. Retrieves an x509 certificate signing request.

POST /devmgr/v2/certificates/export
Description

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

MetaData

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

Parameters
Type Name Description Schema

Query

filename
optional

The name for the x509 certificate file

string

Responses
HTTP Code Description Schema

200

successful operation

404

Error retrieving file.

Consumes
  • application/json

Produces
  • application/json

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

3.1.19. Retrieves information about the server certificates

GET /devmgr/v2/certificates/server
MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

< X509CertInfo > array

422

An error occurred retrieving certificate data

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/server
Example HTTP response
Response 200
{
  "alias" : "string",
  "shaFingerprint" : "string",
  "sha256Fingerprint" : "string",
  "subjectDN" : "string",
  "subjectRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "issuerDN" : "string",
  "issuerRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "start" : "string",
  "expire" : "string",
  "status" : "string",
  "truststore" : true,
  "isUserInstalled" : true,
  "isKeyEntry" : true,
  "type" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "developerMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.1.20. Uploads a certificate for this server

POST /devmgr/v2/certificates/server
MetaData

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

Parameters
Type Name Description Schema Default

Query

alias
optional

The alias to associate with this certificate file. If the alias already exists on the system, the existing certificate will be overwritten. If no alias is provided a random one will be assigned. This parameter is mutually exclusive with the replaceMainServerCertificate parameter.

string

Query

replaceMainServerCertificate
optional

Indicates if the certificate being uploaded is meant to replace the main server certificate. Make sure to upload all root and intermediate certificates before using this option

boolean

"false"

FormData

file
optional

The certificate file to upload

file

Responses
HTTP Code Description Schema

204

The certificate was successfully uploaded

422

An error occurred when attempting to upload the file

Consumes
  • multipart/form-data

Produces
  • application/json

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

3.1.21. Retrieves information about a specific certificate

GET /devmgr/v2/certificates/server/{alias}
MetaData

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

Parameters
Type Name Description Schema

Path

alias
required

The alias of the certificate file to get information about

string

Responses
HTTP Code Description Schema

200

successful operation

204

The certificate information was successfully returned

404

The certificate alias was not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/server/string
Example HTTP response
Response 200
{
  "alias" : "string",
  "shaFingerprint" : "string",
  "sha256Fingerprint" : "string",
  "subjectDN" : "string",
  "subjectRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "issuerDN" : "string",
  "issuerRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "start" : "string",
  "expire" : "string",
  "status" : "string",
  "truststore" : true,
  "isUserInstalled" : true,
  "isKeyEntry" : true,
  "type" : "string"
}

3.1.22. Deletes a server certificate with the given alias

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

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

Parameters
Type Name Description Schema

Path

alias
required

The alias of the certificate file to delete

string

Responses
HTTP Code Description Schema

204

The certificate was successfully deleted

404

The certificate alias was not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/server/string

3.1.23. Exports a remote server certificate

POST /devmgr/v2/certificates/server/{alias}/export
MetaData

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

Parameters
Type Name Description Schema

Path

alias
required

The alias of the certificate file to export

string

Body

body
optional

Body to specify name of file

Responses
HTTP Code Description Schema

200

Certificate was successfully exported

404

The certificate alias was not found

422

An error occurred exporting the certificate file

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/certificates/server/string/export
Request body
{
  "filename" : "string"
}

3.1.24. Return a secure random token of 16 bytes

GET /devmgr/v2/client-token
MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • application/json

Produces
  • application/json

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

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

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

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

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

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.27. Retrieve the local users and if their password is set

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

< LocalUserResponse > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.1.28. Update/set the passwords for local users

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

204

Successfully set the password for local users.

404

An error occurred while attempting to set the password.

Consumes
  • application/json

Produces
  • application/json

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

3.1.29. Retrieve session settings.

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

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.30. Update session settings.

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

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.31. Retrieve lockout settings.

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

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

Parameters
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

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/settings/lockout
Example HTTP response
Response 200
{
  "lockoutMode" : "string",
  "lockoutTime" : 0,
  "maximumLoginAttempts" : 0
}

3.1.32. Update lockout settings.

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/settings/lockout
Request body
{
  "lockoutMode" : "string",
  "lockoutTime" : 0,
  "maximumLoginAttempts" : 0
}
Example HTTP response
Response 200
{
  "lockoutMode" : "string",
  "lockoutTime" : 0,
  "maximumLoginAttempts" : 0
}

3.1.33. Retrieve authentication settings.

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

Produces
  • application/json

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

3.1.34. Update authentication settings.

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

Produces
  • application/json

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

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

GET /devmgr/v2/local-users
MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

< LocalUserResponse > array

404

An error occurred while attempting to retrieve the local user information

Consumes
  • application/json

Produces
  • application/json

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

3.1.36. Set the password for local users

POST /devmgr/v2/local-users
MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

204

The password was updated successfully

404

An error occurred while attempting to update the password

Consumes
  • application/json

Produces
  • application/json

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

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

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

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

Responses
HTTP Code Description Schema

200

successful operation

404

An error occurred when attempting to retrieve the local user information

Consumes
  • application/json

Produces
  • application/json

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

3.1.38. Set the minimum password length

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

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

204

The minimum password length was updated successfully.

422

An error occurred while attempting to update the minimum password length

Consumes
  • application/json

Produces
  • application/json

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

3.1.39. Retrieve session settings.

GET /devmgr/v2/settings/sessions
MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

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

3.1.40. Update session settings.

POST /devmgr/v2/settings/sessions
MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

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.41. Retrieve authentication settings.

GET /devmgr/v2/settings/authentication
MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

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

3.1.42. Update authentication settings.

POST /devmgr/v2/settings/authentication
MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

Produces
  • application/json

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

3.1.43. GET the SSL Configuration

GET /devmgr/v2/sslconfig
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

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.44. Set the SSL Configuration causing a regeneration of the SSL Certificate.

POST /devmgr/v2/sslconfig
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Schema

Body

body
optional

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.45. Asynchonously Reloads SSL Configuration. When this call returns, the reload has been requested

POST /devmgr/v2/sslconfig/reload
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Description Schema

Query

reloadBoth
optional

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

boolean

Responses
HTTP Code Description Schema

202

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

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/reload

3.1.46. Retrieves an x509 certificate signing request

GET /devmgr/v2/sslconfig/export
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Description Schema

Query

filename
optional

fileName

string

Responses
HTTP Code Description Schema

200

successful operation

file

404

File not found.

Consumes
  • application/json

Produces
  • application/octet-stream

Example HTTP request
Request path
/devmgr/v2/sslconfig/export
Example HTTP response
Response 200
"file"

3.1.47. Upload a previously exported certificate signing request

POST /devmgr/v2/sslconfig/import
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Description Schema

FormData

file
optional

certificate file

file

Responses
HTTP Code Description Schema

200

successful operation

< FileInfo > array

422

An unexpected error occurred

Consumes
  • multipart/form-data

Produces
  • application/json

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

3.1.48. Gets the list of known trusted certificate authorities

GET /devmgr/v2/sslconfig/ca
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Description Schema

Query

useTruststore
optional

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

boolean

Responses
HTTP Code Description Schema

200

successful operation

< X509CertInfo > array

422

An unexpected error occurred

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/ca
Example HTTP response
Response 200
{
  "alias" : "string",
  "shaFingerprint" : "string",
  "sha256Fingerprint" : "string",
  "subjectDN" : "string",
  "subjectRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "issuerDN" : "string",
  "issuerRdns" : [ {
    "attributes" : [ {
      "name" : "string",
      "value" : "string"
    } ]
  } ],
  "start" : "string",
  "expire" : "string",
  "status" : "string",
  "truststore" : true,
  "isUserInstalled" : true,
  "isKeyEntry" : true,
  "type" : "string"
} ]
Response 422
{
  "errorMessage" : "string",
  "developerMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

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

POST /devmgr/v2/sslconfig/ca
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Description Schema

Query

useTruststore
optional

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

boolean

Query

alias
optional

The user specified alias for this CA certificate

string

FormData

file
optional

certificate file

file

Responses
HTTP Code Description Schema

422

An unexpected error occurred

Consumes
  • multipart/form-data

Produces
  • application/json

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

3.1.50. Deletes the CA with the given aliass

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

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Description Schema

Path

alias
required

string

Query

useTruststore
optional

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

boolean

Responses
HTTP Code Description Schema

204

Delete was successful

404

Alias not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/sslconfig/ca/string

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

POST /devmgr/v2/sslconfig/reset
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Description Schema Default

Query

reloadSSL
optional

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

boolean

"true"

Responses
HTTP Code Description Schema

202

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

422

An unexpected error occurred

Consumes
  • application/json

Produces
  • application/json

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

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

GET /devmgr/v2/sslconfig/settings
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Responses
HTTP Code Description Schema

200

The certificate revocation options were successfully returned.

422

Unable to get the certificate revocation settings.

Consumes
  • application/json

Produces
  • application/json

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

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

POST /devmgr/v2/sslconfig/settings
Caution

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Description Schema Default

Body

body
optional

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

422

Unable to save the certificate revocation settings

Consumes
  • application/json

Produces
  • application/json

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

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

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

operation.deprecated

Description

This endpoint has been deprecated. Use the /certificates endpoints going forward.

MetaData

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

Parameters
Type Name Description Schema

Query

ocspUrlString
optional

The URL of the OCSP address to test

string

Responses
HTTP Code Description Schema

200

successful operation

boolean

204

The test completed.

404

Not able to find the OCSP URL.

422

Unable to connect to the OCSP’s URL.

Consumes
  • application/json

Produces
  • application/json

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

3.1.55. Retrieve settings that apply to the entire Web Services instance.

GET /devmgr/v2/settings
MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/settings
Example HTTP response
Response 200
{
  "serverSettings" : {
    "httpResponseHeaders" : [ {
      "header" : "string",
      "value" : "string",
      "baseUrlPath" : "/devmgr"
    } ]
  }
}

3.1.56. Configure settings that apply to the entire Web Services instance.

POST /devmgr/v2/settings
MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/settings
Request body
{
  "serverSettings" : {
    "httpResponseHeaders" : [ {
      "header" : "string",
      "value" : "string",
      "baseUrlPath" : "/devmgr"
    } ]
  }
}
Example HTTP response
Response 200
{
  "serverSettings" : {
    "httpResponseHeaders" : [ {
      "header" : "string",
      "value" : "string",
      "baseUrlPath" : "/devmgr"
    } ]
  }
}

3.1.57. 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

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.58. Set if the SYMbol port is enabled

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.2. Authentication

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

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

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

Parameters
Type Name Description Schema Default

Path

system-id
required

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

string

Query

allUsers
optional

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

Produces
  • application/json

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

3.2.2. Retrieve a specific LDAP domain configuration

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.2.3. Deletes the specified domain from the LDAP configuration

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

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

string

Responses
HTTP Code Description Schema

204

The specified domain has been successfully deleted

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.2.4. Retrieve the LDAP configuration

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.2.5. Configure LDAP for a single or multiple domains

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

Warning: This will remove previous configurations

MetaData

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

Parameters
Type Name Description Schema Default

Path

system-id
required

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

string

Body

body
optional

Query

skipTest
optional

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

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

422

Testing of the LDAP configuration has failed

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.2.6. Remove the existing LDAP configuration

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.2.7. Adds an LDAP domain to the existing configuration

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

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

Parameters
Type Name Description Schema Default

Path

system-id
required

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

string

Body

body
optional

Query

skipTest
optional

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

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

422

Testing of the LDAP domain has failed

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.2.8. Updates LDAP configuration for a single domain

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

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

Parameters
Type Name Description Schema Default

Path

system-id
required

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

string

Path

domain-id
required

The id of the LDAP domain that needs to be updated

string

Body

body
optional

Query

skipTest
optional

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

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

422

Testing of the LDAP domain has failed

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.2.9. Test the current LDAP configuration.

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

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

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.2.10. Retrieve the metadata for a specific Identity Provider.

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

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Responses
HTTP Code Description Schema

200

Successful operation

404

Configuration not found

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

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

3.2.11. Delete the metadata for a specific Identity Provider.

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

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Responses
HTTP Code Description Schema

204

Successful operation

404

Configuration not found

422

SAML configuration error

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

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

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

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

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Responses
HTTP Code Description Schema

200

Successful operation

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

404

IdP not found

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

501

SAML service not found

502

There was an issue sending command to alternate

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/saml/identity-provider/string/test
Example HTTP response
Response 200
"string"
Response 404
"string"

3.2.13. Initiate a test for a specific Identity Provider.

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

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema Default

Path

id
required

Identity Provider ID

string

Query

redirect
optional

If the endpoint should issue a redirect or not

boolean

"true"

Responses
HTTP Code Description Schema

200

User is supplied with payload containing redirect URL

303

Redirect to the Identity Provider for authentication

404

Configuration not found

422

A test is already in progress

501

SAML service not found

502

There was an issue sending command to alternate

Consumes
  • application/json

Produces
  • application/json

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

3.2.14. Delete test results for an Identity Provider.

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

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Responses
HTTP Code Description Schema

204

Successful operation

501

SAML service not found

502

There was an issue sending command to alternate

Consumes
  • application/json

Produces
  • application/json

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

3.2.15. Retrieve SAML configuration data.

GET /devmgr/v2/saml
Description

Mode: Embedded only

MetaData

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

Responses
HTTP Code Description Schema

200

Successful operation

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

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

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

POST /devmgr/v2/saml/export
Description

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema

Body

body
optional

SAML service provider information

Responses
HTTP Code Description Schema

200

Successful operation

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

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

3.2.17. Retrieve the roles for a specific Identity Provider.

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

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Responses
HTTP Code Description Schema

200

Successful operation

404

Configuration not found

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

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

3.2.18. Configure the roles for a specific Identity Provider.

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

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema

Path

id
required

Identity Provider ID

string

Body

body
required

Updated requests

Responses
HTTP Code Description Schema

200

Successful operation

404

Configuration not found

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

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

3.2.19. Authenticate user against an Identity Provider.

POST /devmgr/v2/saml/login
Description

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema Default

Body

body
optional

The login request

Query

redirect
optional

If the endpoint should issue a redirect or not

boolean

"true"

Responses
HTTP Code Description Schema

200

User is supplied with payload containing redirect URL

303

User redirected to the Identity Provider for authentication

422

SAML configuration error

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

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

3.2.20. Enable SAML authentication.

POST /devmgr/v2/saml/enable
Description

Mode: Embedded only

MetaData

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

Responses
HTTP Code Description Schema

204

Successful operation

404

SAML configuration not found

501

SAML service not found

Consumes
  • application/json

Produces
  • application/json

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

3.2.21. Import an Identity Provider metadata file.

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

Mode: Embedded only

MetaData

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

Parameters
Type Name Description Schema

FormData

idpMetadata
optional

identity provider metadata file

file

Responses
HTTP Code Description Schema

200

Successful operation

422

Unexpected error occurred while importing metadata

501

SAML service not found

Consumes
  • multipart/form-data

Produces
  • application/json

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

3.3. AutoSupport

3.3.1. Gets the Web Services AutoSupport bundle request job

GET /devmgr/v2/auto-support/jobs/{id}
Description

Allows a user to retrieve the details of a given Web Services AutoSupport request job.

MetaData

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

Parameters
Type Name Description Schema

Path

id
required

The AutoSupport job id.

string

Responses
HTTP Code Description Schema

200

successful operation

404

Id not found.

422

Retrieve current AutoSupport configuration failed.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/auto-support/jobs/string
Example HTTP response
Response 200
{
  "id" : "string",
  "operationType" : "string",
  "dispatchType" : "string",
  "status" : "string",
  "dispatchStatus" : "string",
  "bundleFile" : {
    "fileSize" : "string",
    "fileID" : "string",
    "fileURL" : "string"
  },
  "errorMessage" : "string"
}

3.3.2. Triggers a Web Services AutoSupport bundle

POST /devmgr/v2/auto-support
Description

Allows a user to trigger a Web Services AutoSupport bundle asynchronously and retrieve the bundle locally or dispatch the bundle to the AutoSupport backend server. This operation will create a job that can then be used to query status of the bundle request. The AutoSupport feature must be enabled to dispatch bundles to the AutoSupport backend server.

MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

422

Retrieve current AutoSupport configuration failed or SMTP configuration is invalid.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/auto-support
Request body
{
  "operationType" : "string",
  "dispatchType" : "string"
}
Example HTTP response
Response 200
{
  "jobId" : "string",
  "operationType" : "string",
  "dispatchType" : "string"
}

3.3.3. Gets the list of all Web Services AutoSupport bundle request jobs

GET /devmgr/v2/auto-support/jobs
Description

Allows a user to retrieve the details of all Web Services AutoSupport request jobs.

MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

422

Retrieve current AutoSupport configuration failed.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/auto-support/jobs
Example HTTP response
Response 200
{
  "id" : "string",
  "operationType" : "string",
  "dispatchType" : "string",
  "status" : "string",
  "dispatchStatus" : "string",
  "bundleFile" : {
    "fileSize" : "string",
    "fileID" : "string",
    "fileURL" : "string"
  },
  "errorMessage" : "string"
} ]

3.3.4. Retrieves the current Web Services AutoSupport configuration

GET /devmgr/v2/auto-support/configuration
Description

Allows a user to retrieve and view the current Web Services AutoSupport configuration.

MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

422

Retrieve current AutoSupport configuration failed.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/auto-support/configuration
Example HTTP response
Response 200
{
  "autoSupportEnabled" : true,
  "scheduleType" : "string",
  "scheduledDays" : [ "string" ],
  "deliveryType" : "string",
  "httpDeliveryType" : "string",
  "smtpConfiguration" : {
    "mailServer" : "string",
    "mailSenderAddress" : "string",
    "mailReplyAddress" : "string"
  },
  "sequenceNumber" : "string"
}

3.3.5. Updates the Web Services AutoSupport configuration

POST /devmgr/v2/auto-support/configuration
Description

Allows a user to modify the Web Services' AutoSupport configuration.

MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

422

Retrieve current AutoSupport configuration failed.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/auto-support/configuration
Request body
{
  "autoSupportEnabled" : true,
  "scheduleType" : "string",
  "deliveryType" : "string",
  "smtpConfiguration" : {
    "mailServer" : "string",
    "mailSenderAddress" : "string",
    "mailReplyAddress" : "string"
  }
}
Example HTTP response
Response 200
{
  "autoSupportEnabled" : true,
  "scheduleType" : "string",
  "scheduledDays" : [ "string" ],
  "deliveryType" : "string",
  "httpDeliveryType" : "string",
  "smtpConfiguration" : {
    "mailServer" : "string",
    "mailSenderAddress" : "string",
    "mailReplyAddress" : "string"
  },
  "sequenceNumber" : "string"
}

3.4. Beta

3.4.1. Retrieve multiple time periods of storage-system statistics from newest to oldest

GET /devmgr/v2/storage-systems/{system-id}/analyzed/system-statistics
Description

This is a beta API and may not hold to the same backwards compatibility standards normal APIs have. This API is intended to transition to a non-beta API after 2 releases. Submit any comments or feedback to ng-eseries-restapi-feedback@netapp.com

The number of items in the statistics list are not guaranteed to be the same from different API revisions and not all items from the same time-period may be listed in the same request. This API can support simultaneous active queries by using a null or empty tokenId.

This API is available on SANtricity OS version 11.30.20.xx/08.30.20.xx or greater for all supported platforms.

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Query

token-id
optional

The token used to retrieve the next page of statistics. If this value is null or empty, a new query will be started.Once a token has been successfully used, it may not be used again. These tokens will expire after 1 minute and that expiration time may vary from different API revisions.

string

Query

statisticsFetchTime
required

The number of seconds of historical statistics data to retrieve. After the initial query has started (a token has been provided), this value is ignored.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Storage device not found

422

Failure retrieving the requested statistics

424

Storage device offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analyzed/system-statistics?statisticsFetchTime=0
Example HTTP response
Response 200
{
  "tokenId" : "string",
  "statistics" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "storageSystemId" : "string",
    "storageSystemWWN" : "string",
    "storageSystemName" : "string",
    "cacheHitBytesPercent" : 0.0,
    "randomIosPercent" : 0.0,
    "mirrorBytesPercent" : 0.0,
    "fullStripeWritesBytesPercent" : 0.0,
    "maxCpuUtilization" : 0.0,
    "cpuAvgUtilization" : 0.0,
    "raid0BytesPercent" : 0.0,
    "raid1BytesPercent" : 0.0,
    "raid5BytesPercent" : 0.0,
    "raid6BytesPercent" : 0.0,
    "ddpBytesPercent" : 0.0,
    "readHitResponseTime" : 0.0,
    "readHitResponseTimeStdDev" : 0.0,
    "writeHitResponseTime" : 0.0,
    "writeHitResponseTimeStdDev" : 0.0,
    "combinedHitResponseTime" : 0.0,
    "combinedHitResponseTimeStdDev" : 0.0
  } ]
}

3.4.2. Retrieve multiple time periods of controller statistics from newest to oldest

GET /devmgr/v2/storage-systems/{system-id}/analyzed/controller-statistics
Description

This is a beta API and may not hold to the same backwards compatibility standards normal APIs have. This API is intended to transition to a non-beta API after 2 releases. Submit any comments or feedback to ng-eseries-restapi-feedback@netapp.com

The number of items in the statistics list are not guaranteed to be the same from different API revisions and not all items from the same time-period may be listed in the same request. This API can support simultaneous active queries by using a null or empty tokenId.

This API is available on SANtricity OS version 11.30.20.xx/08.30.20.xx or greater for all supported platforms.

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Query

token-id
optional

The token used to retrieve the next page of statistics. If this value is null or empty, a new query will be started.Once a token has been successfully used, it may not be used again. These tokens will expire after 1 minute and that expiration time may vary from different API revisions.

string

Query

statisticsFetchTime
required

The number of seconds of historical statistics data to retrieve. After the initial query has started (a token has been provided), this value is ignored.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Storage device not found

422

Failure retrieving the requested statistics

424

Storage device offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analyzed/controller-statistics?statisticsFetchTime=0
Example HTTP response
Response 200
{
  "tokenId" : "string",
  "statistics" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "controllerId" : "string",
    "cacheHitBytesPercent" : 0.0,
    "randomIosPercent" : 0.0,
    "mirrorBytesPercent" : 0.0,
    "fullStripeWritesBytesPercent" : 0.0,
    "maxCpuUtilization" : 0.0,
    "maxCpuUtilizationPerCore" : [ 0.0 ],
    "cpuAvgUtilization" : 0.0,
    "cpuAvgUtilizationPerCore" : [ 0.0 ],
    "cpuAvgUtilizationPerCoreStdDev" : [ 0.0 ],
    "raid0BytesPercent" : 0.0,
    "raid1BytesPercent" : 0.0,
    "raid5BytesPercent" : 0.0,
    "raid6BytesPercent" : 0.0,
    "ddpBytesPercent" : 0.0,
    "readHitResponseTime" : 0.0,
    "readHitResponseTimeStdDev" : 0.0,
    "writeHitResponseTime" : 0.0,
    "writeHitResponseTimeStdDev" : 0.0,
    "combinedHitResponseTime" : 0.0,
    "combinedHitResponseTimeStdDev" : 0.0
  } ]
}

3.4.3. Retrieve multiple time periods of interface statistics from newest to oldest

GET /devmgr/v2/storage-systems/{system-id}/analyzed/interface-statistics
Description

This is a beta API and may not hold to the same backwards compatibility standards normal APIs have. This API is intended to transition to a non-beta API after 2 releases. Submit any comments or feedback to ng-eseries-restapi-feedback@netapp.com

The number of items in the statistics list are not guaranteed to be the same from different API revisions and not all items from the same time-period may be listed in the same request. This API can support simultaneous active queries by using a null or empty tokenId.

This API is available on SANtricity OS version 11.30.20.xx/08.30.20.xx or greater for all supported platforms.

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Query

token-id
optional

The token used to retrieve the next page of statistics. If this value is null or empty, a new query will be started.Once a token has been successfully used, it may not be used again. These tokens will expire after 1 minute and that expiration time may vary from different API revisions.

string

Query

statisticsFetchTime
required

The number of seconds of historical statistics data to retrieve. After the initial query has started (a token has been provided), this value is ignored.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Storage device not found

422

Failure retrieving the requested statistics

424

Storage device offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analyzed/interface-statistics?statisticsFetchTime=0
Example HTTP response
Response 200
{
  "tokenId" : "string",
  "statistics" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "interfaceId" : "string",
    "channelType" : "string",
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "channelNumber" : 0,
    "channelErrorCounts" : 0.0
  } ]
}

3.4.4. Retrieve multiple time periods of volume statistics from newest to oldest

GET /devmgr/v2/storage-systems/{system-id}/analyzed/volume-statistics
Description

This is a beta API and may not hold to the same backwards compatibility standards normal APIs have. This API is intended to transition to a non-beta API after 2 releases. Submit any comments or feedback to ng-eseries-restapi-feedback@netapp.com

The number of items in the statistics list are not guaranteed to be the same from different API revisions and not all items from the same time-period may be listed in the same request. This API can support simultaneous active queries by using a null or empty tokenId.

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Query

token-id
optional

The token used to retrieve the next page of statistics. If this value is null or empty, a new query will be started.Once a token has been successfully used, it may not be used again. These tokens will expire after 1 minute and that expiration time may vary from different API revisions.

string

Query

statisticsFetchTime
required

The number of seconds of historical statistics data to retrieve. After the initial query has started (a token has been provided), this value is ignored.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Storage device not found

422

Failure retrieving the requested statistics

424

Storage device offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analyzed/volume-statistics?statisticsFetchTime=0
Example HTTP response
Response 200
{
  "tokenId" : "string",
  "statistics" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "volumeId" : "string",
    "volumeName" : "string",
    "poolId" : "string",
    "controllerId" : "string",
    "workLoadId" : "string",
    "mapped" : true,
    "readHitOps" : 0.0,
    "readHitResponseTime" : 0.0,
    "readHitResponseTimeStdDev" : 0.0,
    "readHitBytes" : 0.0,
    "writeHitBytes" : 0.0,
    "writeHitOps" : 0.0,
    "writeHitResponseTime" : 0.0,
    "writeHitResponseTimeStdDev" : 0.0,
    "combinedHitResponseTime" : 0.0,
    "combinedHitResponseTimeStdDev" : 0.0,
    "readCacheUtilization" : 0.0,
    "writeCacheUtilization" : 0.0,
    "flashCacheReadHitOps" : 0.0,
    "flashCacheReadHitBytes" : 0.0,
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "queueDepthTotal" : 0.0,
    "queueDepthMax" : 0.0,
    "readTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "averageQueueDepth" : 0.0,
    "randomIosPercent" : 0.0,
    "randomBytesPercent" : 0.0,
    "cacheWriteWaitOpsPercent" : 0.0,
    "cacheWriteWaitBytesPercent" : 0.0,
    "prefetchHitPercent" : 0.0,
    "fullStripeWritesBytesPercent" : 0.0,
    "flashCacheReadThroughput" : 0.0,
    "flashCacheReadResponseTime" : 0.0,
    "flashCacheHitPct" : 0.0
  } ]
}

3.4.5. Retrieve multiple time periods of drive statistics from newest to oldest

GET /devmgr/v2/storage-systems/{system-id}/analyzed/drive-statistics
Description

This is a beta API and may not hold to the same backwards compatibility standards normal APIs have. This API is intended to transition to a non-beta API after 2 releases. Submit any comments or feedback to ng-eseries-restapi-feedback@netapp.com

The number of items in the statistics list are not guaranteed to be the same from different API revisions and not all items from the same time-period may be listed in the same request. This API can support simultaneous active queries by using a null or empty tokenId.

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Query

token-id
optional

The token used to retrieve the next page of statistics. If this value is null or empty, a new query will be started.Once a token has been successfully used, it may not be used again. These tokens will expire after 1 minute and that expiration time may vary from different API revisions.

string

Query

statisticsFetchTime
required

The number of seconds of historical statistics data to retrieve. After the initial query has started (a token has been provided), this value is ignored.

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

404

Storage device not found

422

Failure retrieving the requested statistics

424

Storage device offline

503

Statistics service is not running

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analyzed/drive-statistics?statisticsFetchTime=0
Example HTTP response
Response 200
{
  "tokenId" : "string",
  "statistics" : [ {
    "observedTime" : "string",
    "observedTimeInMS" : "string",
    "readIOps" : 0.0,
    "writeIOps" : 0.0,
    "otherIOps" : 0.0,
    "combinedIOps" : 0.0,
    "readThroughput" : 0.0,
    "writeThroughput" : 0.0,
    "combinedThroughput" : 0.0,
    "readResponseTime" : 0.0,
    "readResponseTimeStdDev" : 0.0,
    "writeResponseTime" : 0.0,
    "writeResponseTimeStdDev" : 0.0,
    "combinedResponseTime" : 0.0,
    "combinedResponseTimeStdDev" : 0.0,
    "averageReadOpSize" : 0.0,
    "averageWriteOpSize" : 0.0,
    "readOps" : 0.0,
    "writeOps" : 0.0,
    "diskId" : "string",
    "readPhysicalIOps" : 0.0,
    "writePhysicalIOps" : 0.0,
    "readTimeMax" : 0.0,
    "writeTimeMax" : 0.0,
    "queueDepthMax" : 0.0,
    "averageQueueDepth" : 0.0,
    "randomIosPercent" : 0.0,
    "randomBytesPercent" : 0.0
  } ]
}

3.5. Configuration

3.5.1. Retrieve ASUP configuration info

GET /devmgr/v2/asup
Caution

operation.deprecated

MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

Produces
  • application/json

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

3.5.2. Update ASUP configuration info

POST /devmgr/v2/asup
Caution

operation.deprecated

MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

Produces
  • application/json

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

3.5.3. Dispatch the ASUP bundle

POST /devmgr/v2/asup/dispatch
Caution

operation.deprecated

MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

422

Unregistered asup bundle ID

Consumes
  • application/json

Produces
  • application/json

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

3.5.4. Register the ASUP bundle

POST /devmgr/v2/asup/register
Caution

operation.deprecated

MetaData

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

Parameters
Type Name Schema

Body

body
optional

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.5.5. Retrieve results of the last configuration operation

GET /devmgr/v2/configuration
Caution

operation.deprecated

Description

If no operation has been performed, an empty body is returned. Going forward, users should implement this behavior on the client side if needed.

MetaData

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

Responses
HTTP Code Description Schema

200

Current result data for the last operation

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",
      "developerMessage" : "string",
      "localizedMessage" : "string",
      "retcode" : "string",
      "codeType" : "string",
      "invalidFieldsIfKnown" : [ "string" ]
    }
  } ],
  "totalSystems" : 0,
  "numberDone" : 0,
  "operationDone" : true
}

3.5.6. Initiates a new bulk configuration operation

POST /devmgr/v2/configuration
Caution

operation.deprecated

Description

Going forward, users should implement this behavior on the client side if needed.

MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

The operation is already running

201

A new bulk configuration task has been started

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",
      "developerMessage" : "string",
      "localizedMessage" : "string",
      "retcode" : "string",
      "codeType" : "string",
      "invalidFieldsIfKnown" : [ "string" ]
    }
  } ],
  "totalSystems" : 0,
  "numberDone" : 0,
  "operationDone" : true
}

3.5.7. Interrupts any current configuration process

DELETE /devmgr/v2/configuration
Caution

operation.deprecated

Description

Going forward, users should implement this behavior on the client side if needed.

MetaData

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

Responses
HTTP Code Description Schema

default

successful operation

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/configuration

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

GET /devmgr/v2/configuration/validate
Caution

operation.deprecated

Description

Going forward, users should implement this behavior on the client side if needed.

MetaData

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

Responses
HTTP Code Description Schema

200

successful operation

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

Consumes
  • application/json

Produces
  • application/json

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

3.5.9. Used to validate an input CSV file previously uploaded

POST /devmgr/v2/configuration/validate
Caution

operation.deprecated

Description

Going forward, users should implement this behavior on the client side if needed.

MetaData

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

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

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.5.10. Gets the storage array’s system configuration data

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

Allows the user to export the defined system configuration so that it can be applied to other storage-systems in full or in part.

MetaData

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

Parameters
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

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/system-config
Example HTTP response
Response 200
{
  "volumeGroups" : [ {
    "drives" : [ {
      "tray" : 0,
      "drawer" : 0,
      "slot" : 0
    } ],
    "label" : "string",
    "securityType" : "string",
    "reservedSpaceAllocated" : true,
    "raidLevel" : "string"
  } ],
  "pools" : [ {
    "drives" : [ {
      "tray" : 0,
      "drawer" : 0,
      "slot" : 0
    } ],
    "label" : "string",
    "securityType" : "string",
    "reservedSpaceAllocated" : true,
    "utilizationWarningThreshold" : 0,
    "utilizationCriticalThreshold" : 0,
    "backgroundOperationPriority" : "string",
    "criticalReconstructionPriority" : "string",
    "degradedReconstructionPriority" : "string",
    "reservedDriveCount" : 0
  } ],
  "volumes" : [ {
    "label" : "string",
    "volumeGroupLabel" : "string",
    "capacity" : "string",
    "segmentSize" : 0,
    "owningController" : "string",
    "t10ProtectionType" : "string",
    "dssPreallocateEnabled" : true,
    "cacheSettings" : {
      "cacheFlushModifier" : "string",
      "cachingWithoutBatteriesEnabled" : true,
      "mirrorEnabled" : true,
      "readAheadEnabled" : true,
      "readCacheEnabled" : true,
      "writeCacheEnabled" : true
    },
    "preReadRedundancyCheckEnabled" : true,
    "mediaScanSettings" : {
      "enabled" : true,
      "parityValidationEnabled" : true
    },
    "reconstructionPriority" : 0
  } ],
  "hotSpareDrives" : [ {
    "tray" : 0,
    "drawer" : 0,
    "slot" : 0
  } ],
  "systemSettings" : {
    "cacheSettings" : {
      "blockSize" : 0,
      "flushStart" : 0,
      "flushStop" : 0,
      "mirroringProtectionInformationEnabled" : true
    },
    "mediaScanPeriod" : 0,
    "autoLoadBalancingEnabled" : true
  }
}

3.5.11. Initiates an array configuration operation

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

Allows the user to configure the array based on the exported system configuration data of another array. The configuration may be applied in full or in part. After a configuration operation is launched, a Job ID is returned which should be used as input to the GET /system-config/job/{jobid} call.The GET /system-config/status call is used to get status on an in progress job.

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Query

applyElements
optional

List of configuration elements that should be applied during the operation. If missing, all elements are applied.
all - all array configuration elements are applied
pools - volume disk pool configuration is applied
volumeGroups - volume group configuration is applied
hotSpares - hot spare drive configuration is applied
arraySettings - various items like cache configuration are applied

< enum (all, pools, volumeGroups, volumes, hotSpares, arraySettings) > array(multi)

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

202

array configuration operation initiated

409

an array configuration operation is currently in progress

422

invalid configuration requested

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/system-config
Request body
{
  "volumeGroups" : [ {
    "drives" : [ {
      "tray" : 0,
      "drawer" : 0,
      "slot" : 0
    } ],
    "label" : "string",
    "securityType" : "string",
    "reservedSpaceAllocated" : true,
    "raidLevel" : "string"
  } ],
  "pools" : [ {
    "drives" : [ {
      "tray" : 0,
      "drawer" : 0,
      "slot" : 0
    } ],
    "label" : "string",
    "securityType" : "string",
    "reservedSpaceAllocated" : true,
    "utilizationWarningThreshold" : 0,
    "utilizationCriticalThreshold" : 0,
    "backgroundOperationPriority" : "string",
    "criticalReconstructionPriority" : "string",
    "degradedReconstructionPriority" : "string",
    "reservedDriveCount" : 0
  } ],
  "volumes" : [ {
    "label" : "string",
    "volumeGroupLabel" : "string",
    "capacity" : "string",
    "segmentSize" : 0,
    "owningController" : "string",
    "t10ProtectionType" : "string",
    "dssPreallocateEnabled" : true,
    "cacheSettings" : {
      "cacheFlushModifier" : "string",
      "cachingWithoutBatteriesEnabled" : true,
      "mirrorEnabled" : true,
      "readAheadEnabled" : true,
      "readCacheEnabled" : true,
      "writeCacheEnabled" : true
    },
    "preReadRedundancyCheckEnabled" : true,
    "mediaScanSettings" : {
      "enabled" : true,
      "parityValidationEnabled" : true
    },
    "reconstructionPriority" : 0
  } ],
  "hotSpareDrives" : [ {
    "tray" : 0,
    "drawer" : 0,
    "slot" : 0
  } ],
  "systemSettings" : {
    "cacheSettings" : {
      "blockSize" : 0,
      "flushStart" : 0,
      "flushStop" : 0,
      "mirroringProtectionInformationEnabled" : true
    },
    "mediaScanPeriod" : 0,
    "autoLoadBalancingEnabled" : true
  },
  "jobId" : "string"
}
Example HTTP response
Response 200
{
  "jobId" : "string"
}

3.5.12. Stops an in progress array configuration operation

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

Allows the user to cancel an in progress array configuration operation.

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

204

in progress operation cancelled or no operations in progress

Consumes
  • application/json

Produces
  • application/json

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

3.5.13. Retrieves the status of an in progress array configuration operation

GET /devmgr/v2/storage-systems/{system-id}/system-config/status
Description

Mode: Embedded only.

MetaData

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

Parameters
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

status information returned

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/system-config/status
Example HTTP response
Response 200
{
  "operationInProgress" : true,
  "job" : {
    "id" : "string",
    "startTime" : "string",
    "configTypes" : [ "string" ],
    "durationMs" : "string",
    "percentComplete" : 0,
    "numberSteps" : 0,
    "numberFailures" : 0
  }
}

3.5.14. Retrieves the details of an in progress or completed array configuration operation

GET /devmgr/v2/storage-systems/{system-id}/system-config/job/{job-id}
Description

Mode: Embedded only.

MetaData

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

Parameters
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

job-id
required

Job ID value to retrieve data for. If two or more jobs share the same ID, the most recent job’s data is returned.

string

Responses
HTTP Code Description Schema

200

configuration operation data returned

404

job not found

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/system-config/job/string
Example HTTP response
Response 200
{
  "id" : "string",
  "startTime" : "string",
  "configTypes" : [ "string" ],
  "configModel" : {
    "volumeGroups" : [ {
      "drives" : [ {
        "tray" : 0,
        "drawer" : 0,
        "slot" : 0
      } ],
      "label" : "string",
      "securityType" : "string",
      "reservedSpaceAllocated" : true,
      "raidLevel" : "string"
    } ],
    "pools" : [ {
      "drives" : [ {
        "tray" : 0,
        "drawer" : 0,
        "slot" : 0
      } ],
      "label" : "string",
      "securityType" : "string",
      "reservedSpaceAllocated" : true,
      "utilizationWarningThreshold" : 0,
      "utilizationCriticalThreshold" : 0,
      "backgroundOperationPriority" : "string",
      "criticalReconstructionPriority" : "string",
      "degradedReconstructionPriority" : "string",
      "reservedDriveCount" : 0
    } ],
    "volumes" : [ {
      "label" : "string",
      "volumeGroupLabel" : "string",
      "capacity" : "string",
      "segmentSize" : 0,
      "owningController" : "string",
      "t10ProtectionType" : "string",
      "dssPreallocateEnabled" : true,
      "cacheSettings" : {
        "cacheFlushModifier" : "string",
        "cachingWithoutBatteriesEnabled" : true,
        "mirrorEnabled" : true,
        "readAheadEnabled" : true,
        "readCacheEnabled" : true,
        "writeCacheEnabled" : true
      },
      "preReadRedundancyCheckEnabled" : true,
      "mediaScanSettings" : {
        "enabled" : true,
        "parityValidationEnabled" : true
      },
      "reconstructionPriority" : 0
    } ],
    "hotSpareDrives" : [ {
      "tray" : 0,
      "drawer" : 0,
      "slot" : 0
    } ],
    "systemSettings" : {
      "cacheSettings" : {
        "blockSize" : 0,
        "flushStart" : 0,
        "flushStop" : 0,
        "mirroringProtectionInformationEnabled" : true
      },
      "mediaScanPeriod" : 0,
      "autoLoadBalancingEnabled" : true
    }
  },
  "durationMs" : "string",
  "state" : "string",
  "percentComplete" : 0,
  "numberSteps" : 0,
  "numberFailures" : 0,
  "steps" : [ {
    "sequenceNumber" : 0,
    "type" : "string",
    "objectName" : "string",
    "startTime" : "string",
    "durationMs" : "string",
    "state" : "string",
    "errorType" : "string",
    "errorCode" : "string"
  } ]
}

3.5.15. Gets the capabilities supported by the system configuration end points

GET /devmgr/v2/storage-systems/{system-id}/system-config/capabilities
Description

Mode: Embedded only.

MetaData

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

Parameters
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

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/system-config/capabilities
Example HTTP response
Response 200
{
  "capabilities" : [ "string" ]
}

3.5.16. Retrieve the status of a specific system configuration job by Job Id.

GET /devmgr/v2/batch/system-config/{job-id}
Description

Mode: Proxy only.

MetaData

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

Parameters
Type Name Description Schema Default

Path

job-id
required

The job ID to fetch status for.

string

Query

includeDetail
optional

Include detailed data about the job.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

204

Job ID not found.

503

Service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/batch/system-config/string
Example HTTP response
Response 200
{
  "jobId" : "string",
  "sourceSystemId" : "string",
  "sourceSystemName" : "string",
  "targetSystemIds" : [ "string" ],
  "state" : "string",
  "processFailureReason" : "string",
  "percentComplete" : 0,
  "systemFailureCount" : 0,
  "startTime" : "string",
  "elapsedTime" : "string",
  "sourceDocument" : "string",
  "configTypes" : [ "string" ],
  "failureEntries" : [ {
    "startTime" : "string",
    "systemId" : "string",
    "systemName" : "string",
    "sequenceNum" : 0,
    "jobStepType" : "string",
    "jobStepTypeText" : "string",
    "stepDuration" : "string",
    "objectName" : "string",
    "statusDesc" : "string",
    "statusCode" : "string",
    "statusCodeSource" : "string"
  } ]
}
Response 204
{
  "jobId" : "string",
  "sourceSystemId" : "string",
  "sourceSystemName" : "string",
  "targetSystemIds" : [ "string" ],
  "state" : "string",
  "processFailureReason" : "string",
  "percentComplete" : 0,
  "systemFailureCount" : 0,
  "startTime" : "string",
  "elapsedTime" : "string",
  "sourceDocument" : "string",
  "configTypes" : [ "string" ],
  "failureEntries" : [ {
    "startTime" : "string",
    "systemId" : "string",
    "systemName" : "string",
    "sequenceNum" : 0,
    "jobStepType" : "string",
    "jobStepTypeText" : "string",
    "stepDuration" : "string",
    "objectName" : "string",
    "statusDesc" : "string",
    "statusCode" : "string",
    "statusCodeSource" : "string"
  } ]
}
Response 503
{
  "jobId" : "string",
  "sourceSystemId" : "string",
  "sourceSystemName" : "string",
  "targetSystemIds" : [ "string" ],
  "state" : "string",
  "processFailureReason" : "string",
  "percentComplete" : 0,
  "systemFailureCount" : 0,
  "startTime" : "string",
  "elapsedTime" : "string",
  "sourceDocument" : "string",
  "configTypes" : [ "string" ],
  "failureEntries" : [ {
    "startTime" : "string",
    "systemId" : "string",
    "systemName" : "string",
    "sequenceNum" : 0,
    "jobStepType" : "string",
    "jobStepTypeText" : "string",
    "stepDuration" : "string",
    "objectName" : "string",
    "statusDesc" : "string",
    "statusCode" : "string",
    "statusCodeSource" : "string"
  } ]
}

3.5.17. Submit a new batch operation.

POST /devmgr/v2/batch
Description

Mode: Proxy only.

MetaData

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

Parameters
Type Name Schema

Body

body
required

Responses
HTTP Code Description Schema

200

successful operation

202

Batch operation successfully initiated. Batch ID returned.

400

Request has invalid parameters.

integer (int32)

503

Service not available.Included with this set of errors are too many concurrent batch requests, and too many System ID’s to be executed against.

integer (int32)

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/batch
Request body
{
  "batchName" : "string",
  "batchGroupId" : "string",
  "jobDescription" : [ {
    "httpVerb" : "string",
    "apiURL" : "/devmgr/v2/storage-systems/{id}/device-alerts",
    "systemIds" : [ "string" ],
    "numberRetries" : 1,
    "timeoutSeconds" : 60,
    "requestBodyDocument" : "string"
  } ]
}
Example HTTP response
Response 200
{
  "requestId" : "string"
}
Response 202
{
  "requestId" : "string"
}
Response 400
0
Response 503
0

3.5.18. Invokes a new system replication job.

POST /devmgr/v2/batch/system-config
Description

Mode: Proxy only.

MetaData

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

Parameters
Type Name Description Schema Default

Query

timeout
optional

The timeout value for the operation in minutes. If not supplied a default timeout value is provided.

integer (int32)

40

Body

body
required

Responses
HTTP Code Description Schema

200

successful operation

202

System replication operation successfully initiated. Job ID returned.

400

Request has invalid parameters.

integer (int32)

503

Service not available. Included with this set of errors are too many concurrent batch requests, and too many System ID’s to be executed against.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/batch/system-config
Request body
{
  "sourceSystemId" : "string",
  "targetSystemIds" : [ "string" ],
  "configurationElements" : [ "string" ]
}
Example HTTP response
Response 200
{
  "requestId" : "string"
}
Response 202
{
  "requestId" : "string"
}
Response 400
0
Response 503
{
  "requestId" : "string"
}

3.5.19. Retrieve metadata associated with all existing batches. If no data exists a 204 status is returned.

GET /devmgr/v2/batch/info
Description

Mode: Proxy only.

MetaData

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

Responses
HTTP Code Description Schema

200

Successful, batch metadata returned.

204

No batches associated with the user.

503

Service not available.

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/batch/info
Example HTTP response
Response 200
{
  "info" : [ {
    "batchId" : 0,
    "batchName" : "string",
    "batchGroupId" : "string",
    "systemIds" : [ "string" ],
    "apiUrl" : [ "string" ],
    "state" : "string"
  } ]
}
Response 204
{
  "info" : [ {
    "batchId" : 0,
    "batchName" : "string",
    "batchGroupId" : "string",
    "systemIds" : [ "string" ],
    "apiUrl" : [ "string" ],
    "state" : "string"
  } ]
}
Response 503
{
  "info" : [ {
    "batchId" : 0,
    "batchName" : "string",
    "batchGroupId" : "string",
    "systemIds" : [ "string" ],
    "apiUrl" : [ "string" ],
    "state" : "string"
  } ]
}

3.5.20. Retrieve the status of a batch based on the Batch ID passed in.

GET /devmgr/v2/batch/{batch-id}
Description

Mode: Proxy only.

MetaData

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

Parameters
Type Name Description Schema Default

Path

batch-id
required

The Batch ID to retrieve status for.

integer (int32)

Query

returnJobResultData
optional

True if detailed job result data should be returned in response.

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

404

Batch ID not found.

503

Service not available.

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/batch/0
Example HTTP response
Response 200
{
  "batchId" : 0,
  "batchName" : "string",
  "batchGroupId" : "string",
  "startTime" : "string",
  "batchComplete" : true,
  "percentComplete" : 0,
  "batchState" : "string",
  "numberJobs" : 0,
  "numberSystemIds" : 0,
  "numberJobSteps" : 0,
  "jobStepStatus" : [ {
    "jobName" : "string",
    "jobId" : 0,
    "jobComplete" : true,
    "percentComplete" : 0,
    "systemId" : "string",
    "systemName" : "string",
    "httpVerb" : "string",
    "executionUrl" : "string",
    "executionMillis" : 0,
    "retriesAttempted" : 0,
    "resultStatus" : "string",
    "stepResult" : {
      "httpStatusCode" : 0,
      "httpStatusPhrase" : "string",
      "httpResultHeaders" : [ {
        "key" : "string",
        "value" : "string"
      } ],
      "httpReturnBody" : "string"
    }
  } ]
}
Response 404
{
  "batchId" : 0,
  "batchName" : "string",
  "batchGroupId" : "string",
  "startTime" : "string",
  "batchComplete" : true,
  "percentComplete" : 0,
  "batchState" : "string",
  "numberJobs" : 0,
  "numberSystemIds" : 0,
  "numberJobSteps" : 0,
  "jobStepStatus" : [ {
    "jobName" : "string",
    "jobId" : 0,
    "jobComplete" : true,
    "percentComplete" : 0,
    "systemId" : "string",
    "systemName" : "string",
    "httpVerb" : "string",
    "executionUrl" : "string",
    "executionMillis" : 0,
    "retriesAttempted" : 0,
    "resultStatus" : "string",
    "stepResult" : {
      "httpStatusCode" : 0,
      "httpStatusPhrase" : "string",
      "httpResultHeaders" : [ {
        "key" : "string",
        "value" : "string"
      } ],
      "httpReturnBody" : "string"
    }
  } ]
}
Response 503
{
  "batchId" : 0,
  "batchName" : "string",
  "batchGroupId" : "string",
  "startTime" : "string",
  "batchComplete" : true,
  "percentComplete" : 0,
  "batchState" : "string",
  "numberJobs" : 0,
  "numberSystemIds" : 0,
  "numberJobSteps" : 0,
  "jobStepStatus" : [ {
    "jobName" : "string",
    "jobId" : 0,
    "jobComplete" : true,
    "percentComplete" : 0,
    "systemId" : "string",
    "systemName" : "string",
    "httpVerb" : "string",
    "executionUrl" : "string",
    "executionMillis" : 0,
    "retriesAttempted" : 0,
    "resultStatus" : "string",
    "stepResult" : {
      "httpStatusCode" : 0,
      "httpStatusPhrase" : "string",
      "httpResultHeaders" : [ {
        "key" : "string",
        "value" : "string"
      } ],
      "httpReturnBody" : "string"
    }
  } ]
}

3.6. Containers

3.6.1. Used to upload container environment files to the array

POST /devmgr/v2/containers/{id}/upload-environment
Description

The environment file follows the convention of a Docker .env file

MetaData

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

Parameters
Type Name Description Schema

Path

id
required

ID of the container package. Currently only "1" is supported

integer (int32)

FormData

environmentFile
optional

file

Responses
HTTP Code Description Schema

204

Operation completed successfully

422

An unexpected error occurred

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/containers/0/upload-environment
Request formData
"file"

3.6.2. Used to upload container files to the array

POST /devmgr/v2/containers/{id}/upload-package
MetaData

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

Parameters
Type Name Description Schema

Path

id
required

ID of the container package. Currently only "1" is supported

integer (int32)

FormData

containerFile
optional

file

Responses
HTTP Code Description Schema

204

Operation completed successfully

422

An unexpected error occurred

Consumes
  • multipart/form-data

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/containers/0/upload-package
Request formData
"file"

3.7. Copy-Services

3.7.1. Get consistency group

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.2. Update consistency group

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.3. Delete consistency group

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.4. Get all consistency groups

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.5. Create consistency group

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.6. Get a list of all consistency group members

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

< PITCGMember > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.7. Get a list of all consistency group snapshot views

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.8. Get ConsistencyGroup members

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

< PITCGMember > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.9. Add ConsistencyGroup member

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.10. Get ConsistencyGroup member

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Path

volumeRef
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.11. Remove ConsistencyGroup member

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

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

Parameters
Type Name Description Schema Default

Path

system-id
required

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

string

Path

cg-id
required

string

Path

volumeRef
required

string

Query

retainRepositories
optional

boolean

"false"

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.12. Add multiple ConsistencyGroup members at once

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Body

body
optional

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.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.13. Rollback a ConsistencyGroup snapshot

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

The consistency group’s unique identifier

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

The consistency group’s unique identifier

string

Responses
HTTP Code Description Schema

200

successful operation

< Snapshot > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.15. Create ConsistencyGroup snapshot

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

The consistency group’s unique identifier

string

Responses
HTTP Code Description Schema

200

successful operation

< Snapshot > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.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 = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

The consistency group’s unique identifier

string

Path

sequenceNumber
required

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

< Snapshot > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.17. Remove ConsistencyGroup snapshot

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

The consistency group’s unique identifier

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.7.18. Get Snapshot views associated with the ConsistencyGroup

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.19. Create Snapshot Views from a ConsistencyGroup Snapshot

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

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

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.20. Get a Snapshot view associated with the ConsistencyGroup

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Path

viewId
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.21. Delete an existing Snapshot View

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Path

viewId
required

string

Responses
HTTP Code Description Schema

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.22. Retrieve the underlying SnapshotVolumes associated with the PITConsistencyGroupView

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Path

viewId
required

string

Responses
HTTP Code Description Schema

200

successful operation

< PitViewEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.23. Create Snapshot Views from a ConsistencyGroup Snapshot

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

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

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

cg-id
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

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

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

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

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.26. Get Legacy Snapshots

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

< LegacySnapshotEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "snapshotRef" : "string",
  "label" : "string",
  "status" : "string",
  "action" : "string",
  "currentManager" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "overWarnThreshold" : true,
  "repositoryFull" : true,
  "repFullPolicy" : "string",
  "rollbackPriority" : 0,
  "extentStart" : "string",
  "extentSize" : "string",
  "snapshotTime" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : "string",
  "totalSizeInBytes" : "string",
  "preferredControllerId" : "string",
  "repositoryCapacity" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "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.7.27. Create Legacy Snapshot

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

201

Snapshot Created

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots
Request body
{
  "baseVolumeId" : "string",
  "name" : "string",
  "repositoryPercentage" : 0.0,
  "warningThreshold" : 0,
  "fullPolicy" : "string",
  "storagePoolId" : "string"
}
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "snapshotRef" : "string",
  "label" : "string",
  "status" : "string",
  "action" : "string",
  "currentManager" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "overWarnThreshold" : true,
  "repositoryFull" : true,
  "repFullPolicy" : "string",
  "rollbackPriority" : 0,
  "extentStart" : "string",
  "extentSize" : "string",
  "snapshotTime" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : "string",
  "totalSizeInBytes" : "string",
  "preferredControllerId" : "string",
  "repositoryCapacity" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "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.7.28. Get Legacy Snapshot

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots/string
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "snapshotRef" : "string",
  "label" : "string",
  "status" : "string",
  "action" : "string",
  "currentManager" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "overWarnThreshold" : true,
  "repositoryFull" : true,
  "repFullPolicy" : "string",
  "rollbackPriority" : 0,
  "extentStart" : "string",
  "extentSize" : "string",
  "snapshotTime" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : "string",
  "totalSizeInBytes" : "string",
  "preferredControllerId" : "string",
  "repositoryCapacity" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "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.7.29. Update a Legacy Snapshot

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots/string
Request body
{
  "warningThreshold" : 0,
  "fullPolicy" : "string",
  "newName" : "string",
  "recreateSnapshot" : true
}
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "snapshotRef" : "string",
  "label" : "string",
  "status" : "string",
  "action" : "string",
  "currentManager" : "string",
  "baseVolume" : "string",
  "repositoryVolume" : "string",
  "fullWarnThreshold" : 0,
  "overWarnThreshold" : true,
  "repositoryFull" : true,
  "repFullPolicy" : "string",
  "rollbackPriority" : 0,
  "extentStart" : "string",
  "extentSize" : "string",
  "snapshotTime" : "string",
  "perms" : {
    "mapToLUN" : true,
    "snapShot" : true,
    "format" : true,
    "reconfigure" : true,
    "mirrorPrimary" : true,
    "mirrorSecondary" : true,
    "copySource" : true,
    "copyTarget" : true,
    "readable" : true,
    "writable" : true,
    "rollback" : true,
    "mirrorSync" : true,
    "newImage" : true,
    "allowDVE" : true,
    "allowDSS" : true,
    "concatVolumeMember" : true,
    "flashReadCache" : true,
    "asyncMirrorPrimary" : true,
    "asyncMirrorSecondary" : true,
    "pitGroup" : true,
    "cacheParametersChangeable" : true,
    "allowThinManualExpansion" : true,
    "allowThinGrowthParametersChange" : true
  },
  "childrenInactive" : true,
  "volumeHandle" : 0,
  "mgmtClientAttribute" : 0,
  "rollbackStatus" : "string",
  "baseVolumeSizeInBytes" : "string",
  "totalSizeInBytes" : "string",
  "preferredControllerId" : "string",
  "repositoryCapacity" : "string",
  "volumeCopyTarget" : true,
  "volumeCopySource" : true,
  "pitBaseVolume" : true,
  "asyncMirrorTarget" : true,
  "asyncMirrorSource" : true,
  "protectionType" : "string",
  "remoteMirrorSource" : true,
  "remoteMirrorTarget" : true,
  "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.7.30. Delete a Legacy Snapshot

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Delete successful

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

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

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.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 = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.33. Retrieve the list of Concat Repository Volumes.

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.34. Get a specific Concat Repository Volume.

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

Concat Repository Volume not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

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

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

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

MetaData

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

Concat Repository Volume not found

422

The expansion operation failed.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.36. Get a Snapshot Group

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.37. Update a Snapshot Group

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.38. Delete a Snapshot Group

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Delete was successful

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.39. Get all Snapshot Groups

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

< SnapshotGroup > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.40. Create a snapshot group

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

Storage system not found or created snapshot group could not be found

424

Storage system offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.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 = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

204

No utilization data available for this snapshot group

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.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 = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.43. Get all Snapshots

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

< Snapshot > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.44. Create a Snapshot

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

Storage system not found

422

Created snapshot could not be found

424

Storage system offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.45. Get a Snapshot Volume

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.46. Delete a Snapshot Volume

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Delete was successful

404

Object not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.47. Get all Snapshot Schedules

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

< ScheduleInstance > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.48. Get a Snapshot Schedule

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

Snapshot Schedule not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

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

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.50. Retrieve the repository usage statistics for all SnapshotVolumes.

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.51. Get all Snapshot Volumes

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

< PitViewEx > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.52. Create a Snapshot Volume

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

StorageDevice not found

422

Created object not found.

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.53. Get a Snapshot Volume

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

404

Snapshot Volume not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.54. Update a Snapshot Volume

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

Snapshot Volume not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.55. Delete a Snapshot Volume

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

204

Delete was successful

404

Snapshot Volume not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.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 = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

viewId
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404

Snapshot Volume not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.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 = [root.admin, storage.monitor, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

successful operation

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.7.58. Get progress of all copy pairs

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Responses
HTTP Code Description Schema

200

successful operation

< VolumeCopyProgress > array

404

StorageDevice not found

424

StorageDevice offline

Consumes
  • application/json

Produces
  • application/json

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

3.7.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 = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

ids
required

A comma separated list of id’s

string

Query

control
required

control

enum (start, stop)

Responses
HTTP Code Description Schema

200

successful operation

< VolumeCopyProgress > array

404

No valid IDs found

424

StorageDevice offline

Consumes
  • */*

Produces
  • application/json

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

3.7.60. Get a volume copy pair

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

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

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

vcId
required

string

Responses
HTTP Code Description Schema

200

successful operation

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
Example HTTP response
Response 200
{
  "worldWideName" : "string",
  "volcopyHandle" : 0,
  "volcopyRef" : "string",
  "status" : "string",
  "sourceVolume" : "string",
  "targetVolume" : "string",
  "currentManager" : "string",
  "idleTargetWriteProt" : true,
  "copyCompleteTime" : "string",
  "copyStartTime" : "string",
  "copyPriority" : "string",
  "reserved1" : "string",
  "cloneCopy" : true,
  "pgRef" : "string",
  "baseSourceVolumeId" : "string",
  "onlineCopy" : true,
  "id" : "string"
}
Response 404
{
  "errorMessage" : "string",
  "developerMessage" : "string",
  "localizedMessage" : "string",
  "retcode" : "string",
  "codeType" : "string",
  "invalidFieldsIfKnown" : [ "string" ]
}

3.7.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 = [root.admin, storage.admin]

Parameters
Type Name Description Schema

Path

system-id
required

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

string

Path

vcId
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

404