1. Overview
Documentation for the RESTful API provided for management and monitoring of E-Series storage-systems.
1.1. Version information
Version : 03.00
1.2. URI scheme
BasePath : /devmgr/v2
1.3. Tags
-
Administration
-
Authentication
-
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
-
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
asFile |
Set to true to get the login banner as a file and set to false to get it as plain text. |
boolean |
|
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
Request query
{
"asFile" : true
}
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
FormData |
file |
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 |
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 |
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 |
Filters the certificates that are returned |
enum (all, untrusted, trusted) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< ManagementCertificates > array |
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
Request query
{
"filterType" : "string"
}
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 |
The SHA Fingerprint for the certificate to be exported |
string |
Body |
body |
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 |
This parameter is only applicable for embedded environments. True if wanting to restart the SSL certificate configuration on both controllers |
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/certificates/reload
Request query
{
"reloadBoth" : true
}
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 |
Set to false if you don’t want to reload the SSL Context immediately; default value is true. |
boolean |
|
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
Request query
{
"reloadSSL" : true
}
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 |
|||
Query |
preventSslContextReload |
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 |
|
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
}
Request query
{
"preventSslContextReload" : 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 |
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
Request query
{
"ocspUrlString" : "string"
}
Example HTTP response
Response 200
true
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.1.13. 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 |
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
Request query
{
"filename" : "string"
}
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileID" : "string",
"fileURL" : "string"
}
3.1.14. 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.15. 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 |
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 |
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 query
{
"alias" : "string"
}
Request formData
"file"
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.1.16. 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 |
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.17. 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 |
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.18. 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 |
The alias of the certificate file to export |
string |
Body |
body |
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.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 |
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 |
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 |
|
FormData |
file |
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 query
{
"alias" : "string",
"replaceMainServerCertificate" : true
}
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 |
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 |
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 |
The alias of the certificate file to export |
string |
Body |
body |
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 |
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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 |
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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 |
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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 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 |
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.32. 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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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.33. 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 |
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.34. 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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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.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 |
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 |
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 |
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 |
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 |
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 |
True if wanting to restart both controllers SSL Configuration; only applies to embedded systems. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Request accepted, no data is returned. The changes will take affect the next web server restart |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/sslconfig/reload
Request query
{
"reloadBoth" : true
}
3.1.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 |
fileName |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
file |
404 |
File not found. |
Consumes
-
application/json
Produces
-
application/octet-stream
Example HTTP request
Request path
/devmgr/v2/sslconfig/export
Request query
{
"filename" : "string"
}
Example HTTP response
Response 200
"file"
3.1.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 |
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 |
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
Request query
{
"useTruststore" : true
}
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 |
True if this CA certificate needs to be stored in the truststore, false otherwise. |
boolean |
Query |
alias |
The user specified alias for this CA certificate |
string |
FormData |
file |
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 query
{
"useTruststore" : true,
"alias" : "string"
}
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 |
string |
|
Query |
useTruststore |
True if this CA certificate needs to be deleted from the truststore, false otherwise. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Delete was successful |
|
404 |
Alias not found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/sslconfig/ca/string
Request query
{
"useTruststore" : true
}
3.1.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 |
Set to false if you don’t want to reload the SSL Context immediately; default value is true. |
boolean |
|
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
Request query
{
"reloadSSL" : true
}
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 |
|||
Query |
preventSslContextReload |
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 |
|
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
}
Request query
{
"preventSslContextReload" : 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 |
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
Request query
{
"ocspUrlString" : "string"
}
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 |
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 |
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
allUsers |
boolean |
|
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
Request query
{
"allUsers" : true
}
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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 |
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Body |
body |
|||
Query |
skipTest |
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 |
|
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"
} ]
}
Request query
{
"skipTest" : true
}
Example HTTP response
Response 200
{
"ldapDomains" : [ {
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
} ]
}
3.2.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 |
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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Body |
body |
|||
Query |
skipTest |
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 |
|
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"
}
Request query
{
"skipTest" : true
}
Example HTTP response
Response 200
{
"ldapDomains" : [ {
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
} ]
}
3.2.8. Updates LDAP configuration for a single domain
POST /devmgr/v2/storage-systems/{system-id}/ldap/{domain-id}
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
domain-id |
The id of the LDAP domain that needs to be updated |
string |
|
Body |
body |
|||
Query |
skipTest |
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 |
|
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"
}
Request query
{
"skipTest" : true
}
Example HTTP response
Response 200
{
"ldapDomains" : [ {
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
} ]
}
3.2.9. Test the current LDAP configuration.
POST /devmgr/v2/storage-systems/{system-id}/ldap/test
Description
If no bind user is defined only a communication test will be performed
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< LdapDomainTestResponse > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ldap/test
Example HTTP response
Response 200
{
"id" : "string",
"result" : {
"connectionTestResult" : "string",
"authenticationTestResult" : "string",
"searchTestResult" : "string"
}
} ]
3.2.10. Retrieve 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.11. 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 |
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.12. 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 |
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.13. Retrieve the status of a test for a specific Identity Provider.
GET /devmgr/v2/saml/identity-provider/{id}/test
Description
Mode: Embedded only
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
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.14. Initiate a test for a specific Identity Provider.
POST /devmgr/v2/saml/identity-provider/{id}/test
Description
Mode: Embedded only
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
id |
Identity Provider ID |
string |
|
Query |
redirect |
If the endpoint should issue a redirect or not |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User is supplied with payload containing redirect URL |
|
303 |
Redirect to the Identity Provider for authentication |
|
404 |
Configuration not found |
|
422 |
A test is already in progress |
|
501 |
SAML service not found |
|
502 |
There was an issue sending command to alternate |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/saml/identity-provider/string/test
Request query
{
"redirect" : true
}
3.2.15. Delete test results for an Identity Provider.
DELETE /devmgr/v2/saml/identity-provider/{id}/test
Description
Mode: Embedded only
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
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.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 |
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 |
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 |
Identity Provider ID |
string |
Body |
body |
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 |
The login request |
||
Query |
redirect |
If the endpoint should issue a redirect or not |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User is supplied with payload containing redirect URL |
|
303 |
User redirected to the Identity Provider for authentication |
|
422 |
SAML configuration error |
|
501 |
SAML service not found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/saml/login
Request body
{
"redirectUrl" : "string"
}
Request query
{
"redirect" : true
}
3.2.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 |
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. Configuration
3.3.1. Retrieve ASUP configuration info
GET /devmgr/v2/asup
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, support.admin, storage.monitor]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/asup
Example HTTP response
Response 200
{
"enabled" : true,
"scheduleType" : 0,
"weekdays" : [ 0 ],
"months" : [ 0 ],
"scheduledDays" : [ 0 ],
"deliveryType" : 0,
"destinationHttpAddr" : "string",
"destinationSmtpAddr" : "string",
"httpDeliveryType" : 0,
"proxyHostAddr" : "string",
"proxyHostPort" : "string",
"authRequired" : true,
"authUserName" : "string",
"authPassword" : "string",
"proxyScript" : "string",
"mailServer" : "string",
"mailSenderAddr" : "string",
"mailReplyAddr" : "string",
"log" : "string",
"sequence" : "string",
"default" : true
}
3.3.2. Update ASUP configuration info
POST /devmgr/v2/asup
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
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.3.3. Dispatch the ASUP bundle
POST /devmgr/v2/asup/dispatch
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
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.3.4. Register the ASUP bundle
POST /devmgr/v2/asup/register
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
string |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/asup/register
Request body
{
"entries" : [ {
"fileName" : "string",
"filePath" : "string",
"priority" : 0,
"contentType" : "string",
"description" : "string",
"schedule" : [ 0 ]
} ],
"id" : "string",
"modelName" : "string",
"subjectName" : "string"
}
Example HTTP response
Response 200
"string"
3.3.5. Retrieve results of the last configuration operation
GET /devmgr/v2/configuration
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.3.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 |
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.3.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.3.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.3.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 |
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.3.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 |
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.3.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.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
applyElements |
list of configuration elements that should be applied during the operation. If missing, all elements are applied. |
< enum (all, pools, volumeGroups, volumes, hotSpares, arraySettings) > array(multi) |
Body |
body |
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 query
{
"applyElements" : "string"
}
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.3.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 |
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.3.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 |
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.3.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
job-id |
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.3.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 |
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.3.16. 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 |
The Batch ID to retrieve status for. |
integer (int32) |
|
Query |
returnJobResultData |
True if detailed job result data should be returned in response. |
boolean |
|
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
Request query
{
"returnJobResultData" : true
}
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.3.17. 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.3.18. 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 |
The job ID to fetch status for. |
string |
|
Query |
includeDetail |
Include detailed data about the job. |
boolean |
|
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
Request query
{
"includeDetail" : true
}
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.3.19. 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 |
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.3.20. 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 |
The timeout value for the operation in minutes. If not supplied a default timeout value is provided. |
integer (int32) |
|
Body |
body |
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 query
{
"timeout" : 0
}
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.4. Containers
3.4.1. 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 |
ID of the container package. Currently only "1" is supported |
integer (int32) |
FormData |
containerFile |
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.4.2. Used to upload container environment files to the array
POST /devmgr/v2/containers/{id}/upload-environment
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
ID of the container package. Currently only "1" is supported |
integer (int32) |
FormData |
environmentFile |
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.5. Copy-Services
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< PITConsistencyGroup > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups
Example HTTP response
Response 200
{
"cgRef" : "string",
"label" : "string",
"repFullPolicy" : "string",
"fullWarnThreshold" : 0,
"autoDeleteLimit" : 0,
"rollbackPriority" : "string",
"uniqueSequenceNumber" : [ "string" ],
"creationPendingStatus" : "string",
"name" : "string",
"id" : "string"
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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.5.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 |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< PITConsistencyGroupView > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/views
Example HTTP response
Response 200
{
"cgViewRef" : "string",
"groupRef" : "string",
"label" : "string",
"viewTime" : "string",
"viewSequenceNumber" : "string",
"name" : "string",
"id" : "string"
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Body |
body |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Path |
volumeRef |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
cg-id |
string |
||
Path |
volumeRef |
string |
||
Query |
retainRepositories |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/member-volumes/string
Request query
{
"retainRepositories" : true
}
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Body |
body |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Path |
sequenceNumber |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Snapshot > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/snapshots
Request body
{ }
Example HTTP response
Response 200
{
"pitRef" : "string",
"pitGroupRef" : "string",
"creationMethod" : "string",
"pitTimestamp" : "string",
"pitSequenceNumber" : "string",
"status" : "string",
"activeCOW" : true,
"isRollbackSource" : true,
"pitCapacity" : "string",
"repositoryCapacityUtilization" : "string",
"baseVol" : "string",
"consistencyGroupId" : "string",
"id" : "string"
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Path |
sequenceNumber |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Path |
sequenceNumber |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< PITConsistencyGroupView > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/consistency-groups/string/views
Example HTTP response
Response 200
{
"cgViewRef" : "string",
"groupRef" : "string",
"label" : "string",
"viewTime" : "string",
"viewSequenceNumber" : "string",
"name" : "string",
"id" : "string"
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Body |
body |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Path |
viewId |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Path |
viewId |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Path |
viewId |
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"
} ],
"mapped" : true,
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"name" : "string",
"id" : "string"
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
cg-id |
string |
|
Body |
body |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< RepositoryUtilization > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/legacy-snapshots/repository-utilization
Example HTTP response
Response 200
{
"repositoryUsage" : "string",
"snapRef" : "string"
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< CVCandidateResponse > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/repositories/concat/single
Request body
{
"useFreeRepositoryVolumes" : true,
"candidateRequest" : {
"baseVolumeRef" : "string",
"percentCapacity" : 0.0,
"concatVolumeType" : "string"
},
"exclusions" : [ {
"candType" : "string",
"newVolCandidate" : {
"memberVolumeLabel" : "string",
"memberVolumeGroupLabel" : "string",
"memberCandidate" : {
"raidLevel" : "string",
"trayLossProtection" : true,
"rawSize" : "string",
"usableSize" : "string",
"driveCount" : 0,
"freeExtentRef" : "string",
"driveRefList" : {
"driveRef" : [ "string" ]
},
"candidateSelectionType" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"phyDriveType" : "string",
"dssPreallocEnabled" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"driveMediaType" : "string",
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeCandidateData" : {
"type" : "string",
"diskPoolVolumeCandidateData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"unusableCapacity" : "string"
}
},
"driveBlockFormat" : "string",
"allocateReservedSpace" : true,
"securityLevel" : "string"
},
"memberCapacity" : "string"
},
"existVolCandidate" : {
"refType" : "string",
"memberVolumeRef" : [ "string" ],
"memberLabel" : [ "string" ]
},
"expansionDescriptor" : {
"additionalCapacity" : "string"
}
} ]
}
Example HTTP response
Response 200
{
"raidLevelMatch" : true,
"samePool" : true,
"candidate" : {
"candType" : "string",
"newVolCandidate" : {
"memberVolumeLabel" : "string",
"memberVolumeGroupLabel" : "string",
"memberCandidate" : {
"raidLevel" : "string",
"trayLossProtection" : true,
"rawSize" : "string",
"usableSize" : "string",
"driveCount" : 0,
"freeExtentRef" : "string",
"driveRefList" : {
"driveRef" : [ "string" ]
},
"candidateSelectionType" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"phyDriveType" : "string",
"dssPreallocEnabled" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"driveMediaType" : "string",
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeCandidateData" : {
"type" : "string",
"diskPoolVolumeCandidateData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"unusableCapacity" : "string"
}
},
"driveBlockFormat" : "string",
"allocateReservedSpace" : true,
"securityLevel" : "string"
},
"memberCapacity" : "string"
},
"existVolCandidate" : {
"refType" : "string",
"memberVolumeRef" : [ "string" ],
"memberLabel" : [ "string" ]
},
"expansionDescriptor" : {
"additionalCapacity" : "string"
}
},
"volumeGroupId" : "string",
"capacityMatch" : true,
"qosMatch" : true,
"diskPool" : true,
"capacity" : "string",
"baseMappableObjectId" : "string",
"candidateType" : "string",
"securityMatch" : true,
"daMatch" : true,
"driveTypeMatch" : true,
"existingCandidate" : true
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< CVCandidateResponse > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/repositories/concat/multiple
Request body
{
"candidateRequests" : [ {
"baseVolumeRef" : "string",
"percentCapacity" : 0.0,
"concatVolumeType" : "string"
} ],
"exclusions" : [ {
"candType" : "string",
"newVolCandidate" : {
"memberVolumeLabel" : "string",
"memberVolumeGroupLabel" : "string",
"memberCandidate" : {
"raidLevel" : "string",
"trayLossProtection" : true,
"rawSize" : "string",
"usableSize" : "string",
"driveCount" : 0,
"freeExtentRef" : "string",
"driveRefList" : {
"driveRef" : [ "string" ]
},
"candidateSelectionType" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"phyDriveType" : "string",
"dssPreallocEnabled" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"driveMediaType" : "string",
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeCandidateData" : {
"type" : "string",
"diskPoolVolumeCandidateData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"unusableCapacity" : "string"
}
},
"driveBlockFormat" : "string",
"allocateReservedSpace" : true,
"securityLevel" : "string"
},
"memberCapacity" : "string"
},
"existVolCandidate" : {
"refType" : "string",
"memberVolumeRef" : [ "string" ],
"memberLabel" : [ "string" ]
},
"expansionDescriptor" : {
"additionalCapacity" : "string"
}
} ],
"useFreeRepositoryVolumes" : true
}
Example HTTP response
Response 200
{
"raidLevelMatch" : true,
"samePool" : true,
"candidate" : {
"candType" : "string",
"newVolCandidate" : {
"memberVolumeLabel" : "string",
"memberVolumeGroupLabel" : "string",
"memberCandidate" : {
"raidLevel" : "string",
"trayLossProtection" : true,
"rawSize" : "string",
"usableSize" : "string",
"driveCount" : 0,
"freeExtentRef" : "string",
"driveRefList" : {
"driveRef" : [ "string" ]
},
"candidateSelectionType" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"phyDriveType" : "string",
"dssPreallocEnabled" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"driveMediaType" : "string",
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeCandidateData" : {
"type" : "string",
"diskPoolVolumeCandidateData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"unusableCapacity" : "string"
}
},
"driveBlockFormat" : "string",
"allocateReservedSpace" : true,
"securityLevel" : "string"
},
"memberCapacity" : "string"
},
"existVolCandidate" : {
"refType" : "string",
"memberVolumeRef" : [ "string" ],
"memberLabel" : [ "string" ]
},
"expansionDescriptor" : {
"additionalCapacity" : "string"
}
},
"volumeGroupId" : "string",
"capacityMatch" : true,
"qosMatch" : true,
"diskPool" : true,
"capacity" : "string",
"baseMappableObjectId" : "string",
"candidateType" : "string",
"securityMatch" : true,
"daMatch" : true,
"driveTypeMatch" : true,
"existingCandidate" : true
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< ConcatRepositoryVolume > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/repositories/concat
Example HTTP response
Response 200
{
"concatVolRef" : "string",
"status" : "string",
"memberCount" : 0,
"aggregateCapacity" : "string",
"mediaScanParams" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeHandle" : 0,
"allowedOperations" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"memberRefs" : [ "string" ],
"baseObjectType" : "string",
"baseObjectId" : "string",
"id" : "string"
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< PITGroupRepositoryUtilization > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-groups/repository-utilization
Example HTTP response
Response 200
{
"pitGroupBytesUsed" : "string",
"pitGroupBytesAvailable" : "string",
"groupRef" : "string",
"pitUtilization" : [ {
"pitRef" : "string",
"bytesUsed" : "string"
} ]
} ]
3.5.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 |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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-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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< PITViewRepositoryUtilization > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snapshot-volumes/repository-utilization
Example HTTP response
Response 200
{
"viewBytesUsed" : "string",
"viewBytesAvailable" : "string",
"viewRef" : "string"
} ]
3.5.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 |
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"
} ],
"mapped" : true,
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"name" : "string",
"id" : "string"
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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"
} ],
"mapped" : true,
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"name" : "string",
"id" : "string"
}
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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"
} ],
"mapped" : true,
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"name" : "string",
"id" : "string"
}
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
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"
} ],
"mapped" : true,
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"name" : "string",
"id" : "string"
}
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
viewId |
string |
|
Body |
body |
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"
} ],
"mapped" : true,
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"name" : "string",
"id" : "string"
}
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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.5.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 |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
ids |
A comma separated list of id’s |
string |
Query |
control |
control |
enum (start, stop) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< VolumeCopyProgress > array |
404 |
No valid IDs found |
|
424 |
StorageDevice offline |
Consumes
-
/
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs-control/string
Request query
{
"control" : "string"
}
Example HTTP response
Response 200
{
"percentComplete" : 0,
"timeToCompletion" : 0,
"volumeCopyId" : "string"
} ]
3.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
vcId |
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.5.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 |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
vcId |
string |
|
Body |
body |
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
Request body
{
"copyPriority" : "string",
"targetWriteProtected" : true
}
Example HTTP response
Response 200
{
"worldWideName" : "string",
"volcopyHandle" : 0,
"volcopyRef" : "string",
"status" : "string",
"sourceVolume" : "string",
"targetVolume" : "string",
"currentManager" : "string",
"idleTargetWriteProt" : true,
"copyCompleteTime" : "string",
"copyStartTime" : "string",
"copyPriority" : "string",
"reserved1" : "string",
"cloneCopy" : true,
"pgRef" : "string",
"baseSourceVolumeId" : "string",
"onlineCopy" : true,
"id" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.5.62. Remove a volume copy pair
DELETE /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs/{vcId}
Description
Online volume copies, or copies based on snapshots, require multiple operations to delete all repository volumes (if enabled). If there is a service interruption, it is possible that all repository volumes will not be deleted.These repository volumes can be retrieved using the volumes resource, and will be marked with a volumeUse of 'freeRepositoryVolume'.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
vcId |
string |
||
Query |
retainRepositories |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Removal was successful |
|
404 |
VolumeCopy not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs/string
Request query
{
"retainRepositories" : true
}
3.5.63. Get the list of volume copy pairs
GET /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< VolumeCopyPair > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs
Example HTTP response
Response 200
{
"worldWideName" : "string",
"volcopyHandle" : 0,
"volcopyRef" : "string",
"status" : "string",
"sourceVolume" : "string",
"targetVolume" : "string",
"currentManager" : "string",
"idleTargetWriteProt" : true,
"copyCompleteTime" : "string",
"copyStartTime" : "string",
"copyPriority" : "string",
"reserved1" : "string",
"cloneCopy" : true,
"pgRef" : "string",
"baseSourceVolumeId" : "string",
"onlineCopy" : true,
"id" : "string"
} ]
3.5.64. Create a new volume copy pair
POST /devmgr/v2/storage-systems/{system-id}/volume-copy-jobs
Description
Establish a new volume copy pair by providing a source and a target volume. The target volume must be of greater or equal size to the source.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Created pair not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-copy-jobs
Request body
{
"sourceId" : "string",
"targetId" : "string",
"copyPriority" : "string",
"targetWriteProtected" : true,
"onlineCopy" : true,
"repositoryCandidate" : {
"candType" : "string",
"newVolCandidate" : {
"memberVolumeLabel" : "string",
"memberVolumeGroupLabel" : "string",
"memberCandidate" : {
"raidLevel" : "string",
"trayLossProtection" : true,
"rawSize" : "string",
"usableSize" : "string",
"driveCount" : 0,
"freeExtentRef" : "string",
"driveRefList" : {
"driveRef" : [ "string" ]
},
"candidateSelectionType" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"phyDriveType" : "string",
"dssPreallocEnabled" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"driveMediaType" : "string",
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeCandidateData" : {
"type" : "string",
"diskPoolVolumeCandidateData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"unusableCapacity" : "string"
}
},
"driveBlockFormat" : "string",
"allocateReservedSpace" : true,
"securityLevel" : "string"
},
"memberCapacity" : "string"
},
"existVolCandidate" : {
"refType" : "string",
"memberVolumeRef" : [ "string" ],
"memberLabel" : [ "string" ]
},
"expansionDescriptor" : {
"additionalCapacity" : "string"
}
}
}
Example HTTP response
Response 200
{
"worldWideName" : "string",
"volcopyHandle" : 0,
"volcopyRef" : "string",
"status" : "string",
"sourceVolume" : "string",
"targetVolume" : "string",
"currentManager" : "string",
"idleTargetWriteProt" : true,
"copyCompleteTime" : "string",
"copyStartTime" : "string",
"copyPriority" : "string",
"reserved1" : "string",
"cloneCopy" : true,
"pgRef" : "string",
"baseSourceVolumeId" : "string",
"onlineCopy" : true,
"id" : "string"
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.6. Counters
3.6.1. Decrements the counter.
POST /devmgr/v2/counters/{key}/decrement
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
key |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
Could not decrement counter. |
Example HTTP request
Request path
/devmgr/v2/counters/string/decrement
Example HTTP response
Response 200
{
"key" : "string",
"value" : "string"
}
3.6.2. List all existing counters.
GET /devmgr/v2/counters
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< KeyValuePair > array |
422 |
Could not retrieve counters. |
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/counters
Example HTTP response
Response 200
{
"key" : "string",
"value" : "string"
} ]
3.6.3. Retrieve a counter value by its key.
GET /devmgr/v2/counters/{key}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
key |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
Could not retrieve counter. |
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/counters/string
Example HTTP response
Response 200
{
"key" : "string",
"value" : "string"
}
3.6.4. Removes a counter pair.
DELETE /devmgr/v2/counters/{key}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
key |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Successful operation |
|
422 |
Could not delete counter. |
Example HTTP request
Request path
/devmgr/v2/counters/string
3.6.5. Increments the counter.
POST /devmgr/v2/counters/{key}/increment
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
key |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
Could not increment counter. |
Example HTTP request
Request path
/devmgr/v2/counters/string/increment
Example HTTP response
Response 200
{
"key" : "string",
"value" : "string"
}
3.6.6. Sets the counter to an explicit value.
POST /devmgr/v2/counters/{key}/setCounter
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
key |
string |
|
Query |
value |
The value to set |
integer (int32) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
Could not set the counter. |
Example HTTP request
Request path
/devmgr/v2/counters/string/setCounter
Request query
{
"value" : 0
}
Example HTTP response
Response 200
{
"key" : "string",
"value" : "string"
}
3.7. Device-ASUP
3.7.1. Retrieve ASUP information for all storage devices
GET /devmgr/v2/device-asup/devices
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< DeviceAsupDevice > array |
501 |
Device ASUP service not available. |
|
503 |
Device ASUP service is initializing. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/device-asup/devices
Example HTTP response
Response 200
{
"wwn" : "string",
"name" : "string",
"asupCapable" : true,
"asupEnabled" : true,
"onDemandCapable" : true,
"scheduled" : true,
"dailyScheduleTime" : 0,
"weeklyScheduleTime" : 0,
"weeklyDayOfWeek" : "string"
} ]
3.7.2. Verify a device ASUP configuration
POST /devmgr/v2/device-asup/verify-config
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
Invalid parameter. |
|
501 |
Device ASUP service not available. |
|
503 |
Device ASUP service is initializing. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/device-asup/verify-config
Request body
{
"delivery" : {
"method" : "string",
"routingType" : "string",
"proxyHost" : "string",
"proxyPort" : 0,
"proxyUserName" : "string",
"proxyPassword" : "string",
"proxyScript" : "string",
"mailRelayServer" : "string",
"mailSenderAddress" : "string"
},
"mailReplyAddress" : "string"
}
Example HTTP response
Response 200
{
"successful" : true,
"errorMessage" : "string",
"aodAttempted" : true,
"aodSuccessful" : true,
"aodErrorMessage" : "string"
}
3.7.3. Retrieve a list of ASUP transimission log files
GET /devmgr/v2/device-asup/logs
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< FileInfo > array |
501 |
Device ASUP service not available. |
|
503 |
Device ASUP service is initializing. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/device-asup/logs
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileName" : "string"
} ]
3.7.4. Gets an ASUP transmission log file
GET /devmgr/v2/device-asup/logs/{filename}
Description
The response type of this method is a file stream.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
filename |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
file |
404 |
File not found. |
|
501 |
Device ASUP service not available. |
|
503 |
Device ASUP service is initializing. |
Consumes
-
application/json
Produces
-
application/octet-stream
Example HTTP request
Request path
/devmgr/v2/device-asup/logs/string
Example HTTP response
Response 200
"file"
3.7.5. Set the storage system ASUP maintenance window configuration
POST /devmgr/v2/device-asup/maintenance-window
Description
Sets the ASUP maintenance window configuration
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ASUP maintenance window configuration set successfully. |
|
422 |
ASUP maintenance window configuration error. |
|
501 |
Device ASUP service not available. |
|
503 |
Device ASUP service is initializing. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/device-asup/maintenance-window
Request body
{
"emailAddresses" : [ "string" ],
"duration" : 0,
"maintenanceWindowEnabled" : true
}
3.7.6. Retrieve the device ASUP configuration
GET /devmgr/v2/device-asup
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
501 |
Device ASUP service not available. |
|
503 |
Device ASUP service is initializing. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/device-asup
Example HTTP response
Response 200
{
"asupCapable" : true,
"onDemandCapable" : true,
"asupEnabled" : true,
"onDemandEnabled" : true,
"remoteDiagsEnabled" : true,
"delivery" : {
"method" : "string",
"routingType" : "string",
"proxyHost" : "string",
"proxyPort" : 0,
"proxyUserName" : "string",
"proxyPassword" : "string",
"proxyScript" : "string",
"mailRelayServer" : "string",
"mailSenderAddress" : "string"
},
"destinationAddress" : "string",
"schedule" : {
"dailyMinTime" : 0,
"dailyMaxTime" : 0,
"weeklyMinTime" : 0,
"weeklyMaxTime" : 0,
"daysOfWeek" : [ "string" ]
}
}
3.7.7. Update the device ASUP configuration
POST /devmgr/v2/device-asup
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
501 |
Device ASUP service not available. |
|
503 |
Device ASUP service is initializing. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/device-asup
Request body
{
"asupEnabled" : true,
"onDemandEnabled" : true,
"remoteDiagsEnabled" : true,
"delivery" : {
"method" : "string",
"routingType" : "string",
"proxyHost" : "string",
"proxyPort" : 0,
"proxyUserName" : "string",
"proxyPassword" : "string",
"proxyScript" : "string",
"mailRelayServer" : "string",
"mailSenderAddress" : "string"
},
"schedule" : {
"dailyMinTime" : 0,
"dailyMaxTime" : 0,
"weeklyMinTime" : 0,
"weeklyMaxTime" : 0,
"daysOfWeek" : [ "string" ]
}
}
Example HTTP response
Response 200
{
"asupCapable" : true,
"onDemandCapable" : true,
"asupEnabled" : true,
"onDemandEnabled" : true,
"remoteDiagsEnabled" : true,
"delivery" : {
"method" : "string",
"routingType" : "string",
"proxyHost" : "string",
"proxyPort" : 0,
"proxyUserName" : "string",
"proxyPassword" : "string",
"proxyScript" : "string",
"mailRelayServer" : "string",
"mailSenderAddress" : "string"
},
"destinationAddress" : "string",
"schedule" : {
"dailyMinTime" : 0,
"dailyMaxTime" : 0,
"weeklyMinTime" : 0,
"weeklyMaxTime" : 0,
"daysOfWeek" : [ "string" ]
}
}
3.8. Diagnostics
3.8.1. Retrieve the syslog configuration
GET /devmgr/v2/storage-systems/{system-id}/device-alerts/alert-syslog
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
501 |
Syslog service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts/alert-syslog
Example HTTP response
Response 200
{
"syslogReceivers" : [ {
"serverName" : "string",
"portNumber" : 0
} ],
"defaultFacility" : 0,
"defaultTag" : "string"
}
3.8.2. Update the syslog configuration
POST /devmgr/v2/storage-systems/{system-id}/device-alerts/alert-syslog
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
501 |
Syslog service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts/alert-syslog
Request body
{
"syslogReceivers" : [ {
"serverName" : "string",
"portNumber" : 0
} ],
"defaultFacility" : 0,
"defaultTag" : "string"
}
Example HTTP response
Response 200
{
"syslogReceivers" : [ {
"serverName" : "string",
"portNumber" : 0
} ],
"defaultFacility" : 0,
"defaultTag" : "string"
}
3.8.3. Initiate sending test syslog messages using the syslog settings
POST /devmgr/v2/storage-systems/{system-id}/device-alerts/alert-syslog-test
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
501 |
Device Alert service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts/alert-syslog-test
Example HTTP response
Response 200
{
"response" : "string"
}
3.8.4. Get the core dump information
GET /devmgr/v2/storage-systems/{system-id}/core-dump-info
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/core-dump-info
Example HTTP response
Response 200
{
"dplCoreDumpTag" : 0,
"dplCoreDumpNeedsRetrieved" : true,
"dplCoreDumpEnabled" : true,
"timeStamp" : "string"
}
3.8.5. Initiate a test email using the storage system e-mail alert settings
POST /devmgr/v2/storage-systems/{system-id}/device-alerts/alert-email-test
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
501 |
Device Alert service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts/alert-email-test
Example HTTP response
Response 200
{
"response" : "string",
"emailSendErrorString" : "string"
}
3.8.6. Retrieve the storage system e-mail alert configuration
GET /devmgr/v2/storage-systems/{system-id}/device-alerts
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
501 |
Device Alert service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts
Example HTTP response
Response 200
{
"alertingEnabled" : true,
"emailServerAddress" : "string",
"emailSenderAddress" : "string",
"sendAdditionalContactInformation" : true,
"additionalContactInformation" : "string",
"recipientEmailAddresses" : [ "string" ]
}
3.8.7. Update the storage system e-mail alert configuration
POST /devmgr/v2/storage-systems/{system-id}/device-alerts
Description
Once properly configured and enabled, alert e-mails will be sent to the recipient e-mail address from the server and e-mail address provided for all 'alertable' events. 'Alertable' events include all critical events, along with some warning and informational events.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
updateRequest |
Alert configuration request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
501 |
Device Alert service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/device-alerts
Request body
{
"alertingEnabled" : true,
"emailServerAddress" : "string",
"emailSenderAddress" : "string",
"sendAdditionalContactInformation" : true,
"additionalContactInformation" : "string",
"recipientEmailAddresses" : [ "string" ]
}
Example HTTP response
Response 200
{
"alertingEnabled" : true,
"emailServerAddress" : "string",
"emailSenderAddress" : "string",
"sendAdditionalContactInformation" : true,
"additionalContactInformation" : "string",
"recipientEmailAddresses" : [ "string" ]
}
3.8.8. Retrieve diagnostic data about the managed device
POST /devmgr/v2/storage-systems/{system-id}/diagnostic-data
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
dataRequest |
Diagnostic data request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
501 |
Service not available |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/diagnostic-data
Request body
{
"requestType" : "string"
}
Example HTTP response
Response 200
{
"responseData" : "string"
}
3.8.9. Get list of failures
GET /devmgr/v2/storage-systems/{system-id}/failures
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
details |
Whether or not to fetch object data and extra data |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< FailureData > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/failures
Request query
{
"details" : true
}
Example HTTP response
Response 200
{
"failureType" : "string",
"objectRef" : "string",
"objectType" : "string",
"objectData" : { },
"extraData" : { }
} ]
3.8.10. Retrieve the status of a pending data retrieval request
GET /devmgr/v2/storage-systems/{system-id}/support-data/{requestId}
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
requestId |
integer (int64) |
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/support-data/0
Example HTTP response
Response 200
{
"requestId" : "string",
"progress" : {
"complete" : true,
"percentage" : 0
},
"sizeInBytes" : "string",
"type" : "string",
"filename" : "string"
}
3.8.11. Initiate a support data retrieval request
POST /devmgr/v2/storage-systems/{system-id}/support-data
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
202 |
Request accepted |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/support-data
Request body
{
"type" : "string",
"filename" : "string",
"traceSpec" : {
"controllerA" : true,
"controllerB" : true
},
"driveSpec" : {
"driveRef" : [ "string" ]
},
"saveConfigSpec" : {
"storageArraySettings" : true,
"volumeConfiguration" : true,
"hostConfiguration" : true,
"volumeMappings" : true
}
}
Example HTTP response
Response 200
{
"requestId" : "string"
}
3.8.12. Retrieve all syslog server configurations.
GET /devmgr/v2/storage-systems/{system-id}/syslog
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< SyslogServer > array |
404 |
StorageDevice not found |
|
422 |
Failure loading syslog configurations |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog
Example HTTP response
Response 200
{
"id" : "string",
"serverAddress" : "string",
"port" : 0,
"protocol" : "string",
"components" : [ {
"type" : "string"
} ]
} ]
3.8.13. Add a new syslog server configuration.
POST /devmgr/v2/storage-systems/{system-id}/syslog
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
data |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Error with input data |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog
Request body
{
"serverAddress" : "string",
"port" : 514,
"protocol" : "udp",
"components" : [ {
"type" : "string"
} ]
}
Example HTTP response
Response 200
{
"id" : "string",
"serverAddress" : "string",
"port" : 0,
"protocol" : "string",
"components" : [ {
"type" : "string"
} ]
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.8.14. Retrieves a particular syslog server configuration.
GET /devmgr/v2/storage-systems/{system-id}/syslog/{id}
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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/syslog/string
Example HTTP response
Response 200
{
"id" : "string",
"serverAddress" : "string",
"port" : 0,
"protocol" : "string",
"components" : [ {
"type" : "string"
} ]
}
3.8.15. Update an existing syslog server configuration.
POST /devmgr/v2/storage-systems/{system-id}/syslog/{id}
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
data |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Object not found |
|
422 |
Error with input data |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog/string
Request body
{
"serverAddress" : "string",
"port" : 0,
"protocol" : "string",
"components" : [ {
"type" : "string"
} ]
}
Example HTTP response
Response 200
{
"id" : "string",
"serverAddress" : "string",
"port" : 0,
"protocol" : "string",
"components" : [ {
"type" : "string"
} ]
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.8.16. Delete a syslog server configuration.
DELETE /devmgr/v2/storage-systems/{system-id}/syslog/{id}
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Syslog server removed without error |
|
404 |
Object not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog/string
3.8.17. Initiate sending a test syslog message to the current syslog server.
POST /devmgr/v2/storage-systems/{system-id}/syslog/{id}/test
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
404 |
Object not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/syslog/string/test
3.9. Drive-Firmware
3.9.1. Performs a mini health check and fetchs firmware to drive associations
GET /devmgr/v2/storage-systems/{system-id}/firmware/drives
Description
This is used to determine which drives are compatible with with firmware files that have been previously uploaded.The information returned about the drives also indicates if it can be updated online.This action also performs a mini health check to help determine if there are any storage system conditions that would prevent a firmware update to proceed.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/firmware/drives
Example HTTP response
Response 200
{
"contollerOffline" : true,
"controllerMissing" : true,
"controllerServiceMode" : true,
"simplexMode" : true,
"compatibilities" : [ {
"filename" : "string",
"firmwareVersion" : "string",
"supportedFirmwareVersions" : [ "string" ],
"compatibleDrives" : [ {
"driveRef" : "string",
"onlineUpgradeCapable" : true
} ]
} ]
}
3.9.2. Cancel the on going update operations.
DELETE /devmgr/v2/storage-systems/{system-id}/firmware/drives
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Cancelling on going update operation success |
|
422 |
An unexpected error occurred cancelling the operation. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/firmware/drives
3.9.3. Retrieve list of files in the drive firmware directory
GET /devmgr/v2/files/drive
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< FileInfo > array |
422 |
An unexpected error retrieving the list of drive firmware files. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/files/drive
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileName" : "string"
} ]
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.9.4. Upload a drive firmware file
POST /devmgr/v2/files/drive
Description
Firmware file is uploaded to staging area and referenced in other drive firmware operations. If your multipart form has non-file data, it will be ignored and only the files handled.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
FormData |
file |
drive firmware file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< FileInfo > array |
422 |
An unexpected error occurred saving the drive firmware file. |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/files/drive
Request formData
"file"
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileName" : "string"
} ]
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.9.5. Gets a file from the drive firmware directory
GET /devmgr/v2/files/drive/{filename}
Description
The response type of this method is a file stream.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
filename |
The name of the file |
string |
Query |
auto-delete |
Automatically remove the file after the retrieval completes |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
file |
404 |
File not found. |
Consumes
-
application/json
Produces
-
application/octet-stream
-
application/json
Example HTTP request
Request path
/devmgr/v2/files/drive/string
Request query
{
"auto-delete" : true
}
Example HTTP response
Response 200
"file"
3.9.6. Deletes a drive firmware file
DELETE /devmgr/v2/files/drive/{filename}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
filename |
The name of the file to delete |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
422 |
An unexpected error occurred removing the firmware file. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/files/drive/string
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.9.7. Get the status of the on going update operations.
GET /devmgr/v2/storage-systems/{system-id}/firmware/drives/state
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/firmware/drives/state
Example HTTP response
Response 200
{
"overallStatus" : "string",
"driveStatus" : [ {
"driveRef" : "string",
"status" : "string",
"percentComplete" : 0
} ]
}
3.9.8. Initiate a drive firmware update
POST /devmgr/v2/storage-systems/{system-id}/firmware/drives/initiate-upgrade
Description
The firmware files to be used for the update should be uploaded previously.When the update has been successfully initiated, the firmware files that were uploaded and used in the update will be automatically removedIf there are files uploaded but not used by the update, they not be immediately removed but may be culled later if they remain unused.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Data for which drives to update. |
< DriveFirmwareUpdateEntry > array |
Query |
onlineUpdate |
Perform the update with the drives online. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
string |
422 |
Error processing drive firmware file. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/firmware/drives/initiate-upgrade
Request body
{
"filename" : "string",
"driveRefList" : [ "string" ]
} ]
Request query
{
"onlineUpdate" : true
}
Example HTTP response
Response 200
"string"
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.10. File-Management
3.10.1. Upload a private file for later reference in an API call.
POST /devmgr/v2/files/private
Description
If the provided multipart form has non-file data, that data will be ignored and only the files will be handled.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
FormData |
file |
file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
An unexpected error occurred while attempting to save the file. |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/files/private
Request formData
"file"
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileID" : "string",
"fileURL" : "string"
}
3.10.2. Gets a file from the private file directory
GET /devmgr/v2/files/private/{id}
Description
The response type of this method is a file stream.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
id |
The ID of the file to be retrieved |
string |
|
Query |
auto-delete |
Automatically remove the file after the retrieval completes. The default value is false. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
file |
422 |
An unexpected error occurred while attempting to retrieve the file. |
Consumes
-
application/json
Produces
-
application/json
-
application/octet-stream
Example HTTP request
Request path
/devmgr/v2/files/private/string
Request query
{
"auto-delete" : true
}
Example HTTP response
Response 200
"file"
3.10.3. Deletes a file from the private file directory
DELETE /devmgr/v2/files/private/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
The ID of the file to be deleted |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
422 |
An unexpected error occurred when attempting to delete the file. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/files/private/string
3.10.4. Retrieve a file from the scratch directory
GET /devmgr/v2/files
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< FileInfo > array |
422 |
An unexpected error occurred saving the firmware file. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/files
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileName" : "string"
} ]
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.10.5. Upload a generic file for later reference in an API call.
POST /devmgr/v2/files
Description
If your multipart form has non-file data, it will be ignored and only the files handled.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
FormData |
file |
file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< FileInfo > array |
422 |
An unexpected error occurred saving the firmware file. |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/files
Request formData
"file"
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileName" : "string"
} ]
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.10.6. Gets a file from the scratch directory
GET /devmgr/v2/files/{filename}
Description
The response type of this method is a file stream.
This API will accept a filename (only), as a parameter to retrieve. Paths of any kind will be ignored.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
filename |
string |
|
Query |
auto-delete |
Automatically remove the file after the retrieval completes |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
file |
404 |
File not found. |
Consumes
-
application/json
Produces
-
application/octet-stream
Example HTTP request
Request path
/devmgr/v2/files/string
Request query
{
"auto-delete" : true
}
Example HTTP response
Response 200
"file"
3.10.7. Deletes a generic file
DELETE /devmgr/v2/files/{filename}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
filename |
Name of file to delete |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
422 |
An unexpected error occurred removing the firmware file. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/files/string
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.10.8. Retrieve the list of support artifacts by type
GET /devmgr/v2/support-data/files
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< SupportArtifacts > array |
501 |
Support artifacts service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/support-data/files
Example HTTP response
Response 200
{
"type" : "string",
"artifacts" : [ {
"fileName" : "string",
"lastModifiedTime" : "string",
"size" : "string"
} ]
} ]
3.10.9. Retrieve a specific support artifact.
GET /devmgr/v2/support-data/files/{identifier}
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
identifier |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
file |
403 |
Support artifact not accessible with current roles. |
|
404 |
Support artifact not found. |
|
501 |
Support artifacts service not available. |
Consumes
-
application/json
Produces
-
application/octet-stream
Example HTTP request
Request path
/devmgr/v2/support-data/files/string
Example HTTP response
Response 200
"file"
3.10.10. Deletes a specific support artifact.
DELETE /devmgr/v2/support-data/files/{identifier}
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
identifier |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
403 |
Support artifact not accessible with current roles. |
|
404 |
Support artifact not found. |
|
501 |
Support artifacts service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/support-data/files/string
3.11. Firmware
3.11.1. Get the list of firmware files
GET /devmgr/v2/firmware/cfw-files
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< CFWPackageMetadata > array |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/cfw-files
Example HTTP response
Response 200
{
"filename" : "string",
"version" : "string"
} ]
3.11.2. Get a specific firmware file
GET /devmgr/v2/firmware/cfw-files/{filename}
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
filename |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/cfw-files/string
Example HTTP response
Response 200
{
"filename" : "string",
"version" : "string"
}
3.11.3. Retrieve status of a Controller Firmware upgrade operation
GET /devmgr/v2/storage-systems/{system-id}/cfw-upgrade
Description
Retrieve the status of a running controller firmware or nvsram upgrade operation.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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 |
|
422 |
Health check failure |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade
Example HTTP response
Response 200
{
"requestId" : "string",
"healthCheck" : {
"storageDeviceId" : "string",
"storageDeviceName" : "string",
"storageDeviceWWN" : "string",
"processingTimeMS" : "string",
"rerun" : true,
"recommendedRecovery" : "string",
"successful" : true,
"storageDeviceAccessible" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"spmDatabaseVerification" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"failureMessages" : [ "string" ],
"successful" : true
},
"configurationDatabaseCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"status" : "string",
"successful" : true
},
"objectGraphSyncCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"cfwMatch" : true,
"nvsramMatch" : true,
"successful" : true
},
"volumeGroupsComplete" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"controllerStatusOptimal" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"hotSparesInUse" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"missingVolumes" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"driveCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"exclusiveOperations" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"volumeRefToAction" : {
"string" : "string"
},
"successful" : true
},
"failedDrivesPresent" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"validPasswordSet" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"melCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"warningMessages" : [ "string" ],
"successful" : true
},
"dbSubRecordsValidation" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"integratedHealthCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"healthCheckTests" : [ {
"testPassed" : true,
"testName" : "string",
"resultsData" : "string"
} ],
"successful" : true
}
},
"startTime" : "string",
"uploadStartTime" : "string",
"activationStartTime" : "string",
"uploadCompletionTime" : "string",
"uploadCompletionPercentage" : 0,
"activationCompletionTime" : "string",
"running" : true
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ],
"requestId" : "string",
"result" : {
"requestId" : "string",
"healthCheck" : {
"storageDeviceId" : "string",
"storageDeviceName" : "string",
"storageDeviceWWN" : "string",
"processingTimeMS" : "string",
"rerun" : true,
"recommendedRecovery" : "string",
"successful" : true,
"storageDeviceAccessible" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"spmDatabaseVerification" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"failureMessages" : [ "string" ],
"successful" : true
},
"configurationDatabaseCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"status" : "string",
"successful" : true
},
"objectGraphSyncCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"cfwMatch" : true,
"nvsramMatch" : true,
"successful" : true
},
"volumeGroupsComplete" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"controllerStatusOptimal" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"hotSparesInUse" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"missingVolumes" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"driveCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"exclusiveOperations" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"volumeRefToAction" : {
"string" : "string"
},
"successful" : true
},
"failedDrivesPresent" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"validPasswordSet" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"melCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"warningMessages" : [ "string" ],
"successful" : true
},
"dbSubRecordsValidation" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"integratedHealthCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"healthCheckTests" : [ {
"testPassed" : true,
"testName" : "string",
"resultsData" : "string"
} ],
"successful" : true
}
},
"startTime" : "string",
"uploadStartTime" : "string",
"activationStartTime" : "string",
"uploadCompletionTime" : "string",
"uploadCompletionPercentage" : 0,
"activationCompletionTime" : "string",
"running" : true
}
}
3.11.4. Initiate a Controller Firmware upgrade operation
POST /devmgr/v2/storage-systems/{system-id}/cfw-upgrade
Description
Start a controller firmware or nvsram upgrade operation.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Request accepted |
|
404 |
StorageDevice not found |
|
422 |
Health check failure |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade
Request body
{
"cfwFile" : "string",
"nvsramFile" : "string",
"stageFirmware" : true,
"skipMelCheck" : true
}
Example HTTP response
Response 202
{
"requestId" : "string"
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ],
"requestId" : "string",
"result" : {
"requestId" : "string",
"healthCheck" : {
"storageDeviceId" : "string",
"storageDeviceName" : "string",
"storageDeviceWWN" : "string",
"processingTimeMS" : "string",
"rerun" : true,
"recommendedRecovery" : "string",
"successful" : true,
"storageDeviceAccessible" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"spmDatabaseVerification" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"failureMessages" : [ "string" ],
"successful" : true
},
"configurationDatabaseCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"status" : "string",
"successful" : true
},
"objectGraphSyncCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"cfwMatch" : true,
"nvsramMatch" : true,
"successful" : true
},
"volumeGroupsComplete" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"controllerStatusOptimal" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"hotSparesInUse" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"missingVolumes" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"driveCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"exclusiveOperations" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"volumeRefToAction" : {
"string" : "string"
},
"successful" : true
},
"failedDrivesPresent" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"validPasswordSet" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"melCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"warningMessages" : [ "string" ],
"successful" : true
},
"dbSubRecordsValidation" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"integratedHealthCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"healthCheckTests" : [ {
"testPassed" : true,
"testName" : "string",
"resultsData" : "string"
} ],
"successful" : true
}
},
"startTime" : "string",
"uploadStartTime" : "string",
"activationStartTime" : "string",
"uploadCompletionTime" : "string",
"uploadCompletionPercentage" : 0,
"activationCompletionTime" : "string",
"running" : true
}
}
3.11.5. Activate staged controller firmware
POST /devmgr/v2/storage-systems/{system-id}/cfw-upgrade/activate
Description
Activate Controller Firmware that was previous staged for a later upgrade operation. This operation will begin activation of the uploaded package.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Health check failure |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade/activate
Request body
{
"skipMelCheck" : true
}
Example HTTP response
Response 200
{
"requestId" : "string",
"healthCheck" : {
"storageDeviceId" : "string",
"storageDeviceName" : "string",
"storageDeviceWWN" : "string",
"processingTimeMS" : "string",
"rerun" : true,
"recommendedRecovery" : "string",
"successful" : true,
"storageDeviceAccessible" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"spmDatabaseVerification" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"failureMessages" : [ "string" ],
"successful" : true
},
"configurationDatabaseCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"status" : "string",
"successful" : true
},
"objectGraphSyncCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"cfwMatch" : true,
"nvsramMatch" : true,
"successful" : true
},
"volumeGroupsComplete" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"controllerStatusOptimal" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"hotSparesInUse" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"missingVolumes" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"driveCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"exclusiveOperations" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"volumeRefToAction" : {
"string" : "string"
},
"successful" : true
},
"failedDrivesPresent" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"validPasswordSet" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"melCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"warningMessages" : [ "string" ],
"successful" : true
},
"dbSubRecordsValidation" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"integratedHealthCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"healthCheckTests" : [ {
"testPassed" : true,
"testName" : "string",
"resultsData" : "string"
} ],
"successful" : true
}
},
"startTime" : "string",
"uploadStartTime" : "string",
"activationStartTime" : "string",
"uploadCompletionTime" : "string",
"uploadCompletionPercentage" : 0,
"activationCompletionTime" : "string",
"running" : true
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ],
"requestId" : "string",
"result" : {
"requestId" : "string",
"healthCheck" : {
"storageDeviceId" : "string",
"storageDeviceName" : "string",
"storageDeviceWWN" : "string",
"processingTimeMS" : "string",
"rerun" : true,
"recommendedRecovery" : "string",
"successful" : true,
"storageDeviceAccessible" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"spmDatabaseVerification" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"failureMessages" : [ "string" ],
"successful" : true
},
"configurationDatabaseCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"status" : "string",
"successful" : true
},
"objectGraphSyncCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"cfwMatch" : true,
"nvsramMatch" : true,
"successful" : true
},
"volumeGroupsComplete" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"controllerStatusOptimal" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"hotSparesInUse" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"missingVolumes" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"driveCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"exclusiveOperations" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"volumeRefToAction" : {
"string" : "string"
},
"successful" : true
},
"failedDrivesPresent" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"validPasswordSet" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"melCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"warningMessages" : [ "string" ],
"successful" : true
},
"dbSubRecordsValidation" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"integratedHealthCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"healthCheckTests" : [ {
"testPassed" : true,
"testName" : "string",
"resultsData" : "string"
} ],
"successful" : true
}
},
"startTime" : "string",
"uploadStartTime" : "string",
"activationStartTime" : "string",
"uploadCompletionTime" : "string",
"uploadCompletionPercentage" : 0,
"activationCompletionTime" : "string",
"running" : true
}
}
3.11.6. Retrieve details on the staged firmware
GET /devmgr/v2/storage-systems/{system-id}/cfw-upgrade/staged
Description
Retrieve the list of code modules and versions of the firmware staged on the storage array.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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 |
|
422 |
Health check failure |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade/staged
Example HTTP response
Response 200
{
"timeStamp" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ]
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ],
"requestId" : "string",
"result" : {
"requestId" : "string",
"healthCheck" : {
"storageDeviceId" : "string",
"storageDeviceName" : "string",
"storageDeviceWWN" : "string",
"processingTimeMS" : "string",
"rerun" : true,
"recommendedRecovery" : "string",
"successful" : true,
"storageDeviceAccessible" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"spmDatabaseVerification" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"failureMessages" : [ "string" ],
"successful" : true
},
"configurationDatabaseCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"status" : "string",
"successful" : true
},
"objectGraphSyncCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"cfwMatch" : true,
"nvsramMatch" : true,
"successful" : true
},
"volumeGroupsComplete" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"controllerStatusOptimal" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"hotSparesInUse" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"missingVolumes" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"driveCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"exclusiveOperations" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"volumeRefToAction" : {
"string" : "string"
},
"successful" : true
},
"failedDrivesPresent" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"validPasswordSet" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"melCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"warningMessages" : [ "string" ],
"successful" : true
},
"dbSubRecordsValidation" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"integratedHealthCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"healthCheckTests" : [ {
"testPassed" : true,
"testName" : "string",
"resultsData" : "string"
} ],
"successful" : true
}
},
"startTime" : "string",
"uploadStartTime" : "string",
"activationStartTime" : "string",
"uploadCompletionTime" : "string",
"uploadCompletionPercentage" : 0,
"activationCompletionTime" : "string",
"running" : true
}
}
3.11.7. Clear staged firmware details on the array
DELETE /devmgr/v2/storage-systems/{system-id}/cfw-upgrade/staged
Description
Clear staged firmware details on the storage array
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Staged Firmware details were successfully cleared |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/cfw-upgrade/staged
3.11.8. Get last successful firmware upgrade timestamps and firmware upgrade logs
GET /devmgr/v2/firmware/embedded-firmware
Caution
|
operation.deprecated |
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
cfwUpgrade |
Controller Firmware Upgrade |
boolean |
Query |
iomUpgrade |
IOM Firmware Upgrade |
boolean |
Query |
driveUpgrade |
Drive Firmware Upgrade |
boolean |
Query |
nvsramUpgrade |
NVSRAM Upgrade |
boolean |
Query |
includeLogs |
Include firmware log |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware
Request query
{
"cfwUpgrade" : true,
"iomUpgrade" : true,
"driveUpgrade" : true,
"nvsramUpgrade" : true,
"includeLogs" : true
}
Example HTTP response
Response 200
{
"cfwUpgradeTS" : "string",
"iomUpgradeTS" : "string",
"driveUpgradeTS" : "string",
"nvsramUpgradeTS" : "string",
"cfwLog" : [ {
"level" : {
"name" : "string",
"resourceBundleName" : "string",
"localizedName" : "string"
},
"sequenceNumber" : "string",
"sourceClassName" : "string",
"sourceMethodName" : "string",
"message" : "string",
"threadID" : 0,
"millis" : "string",
"thrown" : {
"cause" : {
"cause" : "...",
"stackTrace" : [ {
"methodName" : "string",
"fileName" : "string",
"lineNumber" : 0,
"className" : "string",
"nativeMethod" : true
} ],
"localizedMessage" : "string",
"message" : "string",
"suppressed" : [ "..." ]
},
"stackTrace" : [ {
"methodName" : "string",
"fileName" : "string",
"lineNumber" : 0,
"className" : "string",
"nativeMethod" : true
} ],
"localizedMessage" : "string",
"message" : "string",
"suppressed" : [ "..." ]
},
"loggerName" : "string",
"resourceBundleName" : "string",
"parameters" : [ "object" ],
"resourceBundle" : {
"locale" : {
"language" : "string",
"country" : "string",
"displayCountry" : "string",
"displayLanguage" : "string",
"displayName" : "string",
"displayScript" : "string",
"displayVariant" : "string",
"extensionKeys" : [ "string" ],
"iso3Country" : "string",
"iso3Language" : "string",
"script" : "string",
"unicodeLocaleAttributes" : [ "string" ],
"unicodeLocaleKeys" : [ "string" ],
"variant" : "string"
},
"baseBundleName" : "string",
"keys" : { }
}
} ],
"iomLog" : [ {
"level" : {
"name" : "string",
"resourceBundleName" : "string",
"localizedName" : "string"
},
"sequenceNumber" : "string",
"sourceClassName" : "string",
"sourceMethodName" : "string",
"message" : "string",
"threadID" : 0,
"millis" : "string",
"thrown" : "...",
"loggerName" : "string",
"resourceBundleName" : "string",
"parameters" : [ "object" ],
"resourceBundle" : {
"locale" : {
"language" : "string",
"country" : "string",
"displayCountry" : "string",
"displayLanguage" : "string",
"displayName" : "string",
"displayScript" : "string",
"displayVariant" : "string",
"extensionKeys" : [ "string" ],
"iso3Country" : "string",
"iso3Language" : "string",
"script" : "string",
"unicodeLocaleAttributes" : [ "string" ],
"unicodeLocaleKeys" : [ "string" ],
"variant" : "string"
},
"baseBundleName" : "string",
"keys" : { }
}
} ],
"driveLog" : [ {
"level" : {
"name" : "string",
"resourceBundleName" : "string",
"localizedName" : "string"
},
"sequenceNumber" : "string",
"sourceClassName" : "string",
"sourceMethodName" : "string",
"message" : "string",
"threadID" : 0,
"millis" : "string",
"thrown" : "...",
"loggerName" : "string",
"resourceBundleName" : "string",
"parameters" : [ "object" ],
"resourceBundle" : {
"locale" : {
"language" : "string",
"country" : "string",
"displayCountry" : "string",
"displayLanguage" : "string",
"displayName" : "string",
"displayScript" : "string",
"displayVariant" : "string",
"extensionKeys" : [ "string" ],
"iso3Country" : "string",
"iso3Language" : "string",
"script" : "string",
"unicodeLocaleAttributes" : [ "string" ],
"unicodeLocaleKeys" : [ "string" ],
"variant" : "string"
},
"baseBundleName" : "string",
"keys" : { }
}
} ],
"nvsramLog" : [ {
"level" : {
"name" : "string",
"resourceBundleName" : "string",
"localizedName" : "string"
},
"sequenceNumber" : "string",
"sourceClassName" : "string",
"sourceMethodName" : "string",
"message" : "string",
"threadID" : 0,
"millis" : "string",
"thrown" : "...",
"loggerName" : "string",
"resourceBundleName" : "string",
"parameters" : [ "object" ],
"resourceBundle" : {
"locale" : {
"language" : "string",
"country" : "string",
"displayCountry" : "string",
"displayLanguage" : "string",
"displayName" : "string",
"displayScript" : "string",
"displayVariant" : "string",
"extensionKeys" : [ "string" ],
"iso3Country" : "string",
"iso3Language" : "string",
"script" : "string",
"unicodeLocaleAttributes" : [ "string" ],
"unicodeLocaleKeys" : [ "string" ],
"variant" : "string"
},
"baseBundleName" : "string",
"keys" : { }
}
} ]
}
3.11.9. Upload and activate firmware files
POST /devmgr/v2/firmware/embedded-firmware
Description
Directly loads firmware files to the controller and optionally activate the files. File can be named 'veosimage' or 'nvsramimage.'
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
staged |
Set to upload the files to the controller without activation. |
boolean |
Query |
nvsram |
Set to true if the nvsram file is included in the request. |
boolean |
FormData |
nvsramfile |
An image file for the non-volatile random-access memory on the controller. If included, this file must be the first file in the request. If not, an error will be generated. |
file |
FormData |
dlpfile |
An image file for the controller firmware. |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Controller firmware successfully uploaded. |
|
422 |
An unexpected error occurred saving the firmware file. |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware
Request query
{
"staged" : true,
"nvsram" : true
}
Request formData
"file"
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.11.10. Upload a nvsram file.
POST /devmgr/v2/firmware/embedded-firmware/{system-id}/nvsram
Description
Upload endpoint for nvsram to download to the controller. Controllers will reboot when operation completes
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
system-id |
string |
FormData |
nvsramimage |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
422 |
An unexpected error occurred saving the nvsram file. |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/nvsram
Request formData
"file"
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.11.11. Retrieve details on the staged firmware
GET /devmgr/v2/firmware/embedded-firmware/{system-id}/staged
Description
Retrieve the list of code modules and versions of the firmware staged on the storage array.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
system-id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Health check failure |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/staged
Example HTTP response
Response 200
{
"timeStamp" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ]
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ],
"requestId" : "string",
"result" : {
"requestId" : "string",
"healthCheck" : {
"storageDeviceId" : "string",
"storageDeviceName" : "string",
"storageDeviceWWN" : "string",
"processingTimeMS" : "string",
"rerun" : true,
"recommendedRecovery" : "string",
"successful" : true,
"storageDeviceAccessible" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"spmDatabaseVerification" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"failureMessages" : [ "string" ],
"successful" : true
},
"configurationDatabaseCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"status" : "string",
"successful" : true
},
"objectGraphSyncCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"cfwMatch" : true,
"nvsramMatch" : true,
"successful" : true
},
"volumeGroupsComplete" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"controllerStatusOptimal" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"hotSparesInUse" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"missingVolumes" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"driveCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"exclusiveOperations" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"volumeRefToAction" : {
"string" : "string"
},
"successful" : true
},
"failedDrivesPresent" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"validPasswordSet" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"melCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"warningMessages" : [ "string" ],
"successful" : true
},
"dbSubRecordsValidation" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"integratedHealthCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"healthCheckTests" : [ {
"testPassed" : true,
"testName" : "string",
"resultsData" : "string"
} ],
"successful" : true
}
},
"startTime" : "string",
"uploadStartTime" : "string",
"activationStartTime" : "string",
"uploadCompletionTime" : "string",
"uploadCompletionPercentage" : 0,
"activationCompletionTime" : "string",
"running" : true
}
}
3.11.12. Clear staged firmware details on the array
DELETE /devmgr/v2/firmware/embedded-firmware/{system-id}/staged
Description
Clear staged firmware details on the storage array
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
system-id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Staged Firmware details were successfully cleared |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/staged
3.11.13. Activates previously staged firmware.
POST /devmgr/v2/firmware/embedded-firmware/activate
Description
A successful activation will shut the web server down which may result in the request to timeout, be canceled, or return with a 503 Service Unavailable before the success response could be returned.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Activation successful. |
|
422 |
An unexpected error occurred activating the firmware file. |
|
503 |
Activation was successful but the web server was shut down before the success response could be returned. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/activate
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.11.14. Performs compatibility and signature checks on an NVSRAM file.
POST /devmgr/v2/firmware/embedded-firmware/{system-id}/nvsram-compatibility-check
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
system-id |
string |
FormData |
file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Compatibility check completed successfully |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/nvsram-compatibility-check
Request formData
"file"
Example HTTP response
Response 200
{
"signatureTestingPassed" : true,
"fileCompatible" : true,
"versionContents" : [ {
"module" : "string",
"bundledVersion" : "string",
"onboardVersion" : "string"
} ]
}
3.11.15. Performs compatibility and signature checks on a controller firmware bundle.
POST /devmgr/v2/firmware/embedded-firmware/{system-id}/bundle-compatibility-check
Description
Speed up the process by sending only first 8KB of a file.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
system-id |
string |
FormData |
file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Compatibility check completed successfully |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/string/bundle-compatibility-check
Request formData
"file"
Example HTTP response
Response 200
{
"signatureTestingPassed" : true,
"fileCompatible" : true,
"versionContents" : [ {
"module" : "string",
"bundledVersion" : "string",
"onboardVersion" : "string"
} ]
}
3.11.16. Retrieve details on the current firmware
GET /devmgr/v2/firmware/embedded-firmware/{system-id}/versions
Description
Retrieve the list of code modules and versions of the firmware on the storage array.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
system-id |
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/firmware/embedded-firmware/string/versions
Example HTTP response
Response 200
{
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ]
}
3.11.17. Get the last successful firmware upgrade timestamp(s) and log messages for the firmware upgrades
GET /devmgr/v2/firmware/embedded-firmware/logs
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
cfwUpgrade |
Set to true to retrieve the timestamp for the most recent controller firmware upgrade |
boolean |
Query |
iomUpgrade |
Set to true to retrieve the timestamp for the most recent IOM upgrade |
boolean |
Query |
driveUpgrade |
Set to true to retrieve the timestamp for the most recent drive firmware upgrade |
boolean |
Query |
nvsramUpgrade |
Set to true to retrieve the timestamp for the most recent NVSRAM upgrade |
boolean |
Query |
includeLogs |
Set to true to include upgrade log messages in addition to timestamps |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/logs
Request query
{
"cfwUpgrade" : true,
"iomUpgrade" : true,
"driveUpgrade" : true,
"nvsramUpgrade" : true,
"includeLogs" : true
}
Example HTTP response
Response 200
{
"cfwUpgradeTS" : "string",
"iomUpgradeTS" : "string",
"driveUpgradeTS" : "string",
"nvsramUpgradeTS" : "string",
"cfwLog" : [ {
"message" : "string",
"timestamp" : "string"
} ],
"iomLog" : [ {
"message" : "string",
"timestamp" : "string"
} ],
"driveLog" : [ {
"message" : "string",
"timestamp" : "string"
} ],
"nvsramLog" : [ {
"message" : "string",
"timestamp" : "string"
} ]
}
3.11.18. Get IOM service information
GET /devmgr/v2/firmware/embedded-firmware/iom/service
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
501 |
IOM service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/iom/service
Example HTTP response
Response 200
{
"iomServiceEnabled" : true,
"disruptiveIomFirmwareUpdate" : true
}
3.11.19. Updates the IOM service configuration
POST /devmgr/v2/firmware/embedded-firmware/iom/service
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
501 |
IOM service not available. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/embedded-firmware/iom/service
Request body
{
"enabled" : true
}
3.11.20. Request status of a firmware compatibility check operation
GET /devmgr/v2/firmware/compatibility-check
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
requestId |
Retrieve result of a previously submitted request. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
A requested request result no longer exists. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/compatibility-check
Request query
{
"requestId" : 0
}
Example HTTP response
Response 200
{
"checkRunning" : true,
"cancelled" : true,
"lastStart" : "string",
"inaccessibleStorageDevices" : [ "string" ],
"results" : [ {
"storageDeviceId" : "string",
"storageDeviceWwn" : "string",
"cfwFiles" : [ {
"filename" : "string",
"version" : "string"
} ],
"nvsramFiles" : [ {
"version" : "string",
"filename" : "string"
} ]
} ],
"requestId" : "string",
"failedStorageDevices" : [ "string" ]
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.11.21. Begin a firmware compatibility check operation
POST /devmgr/v2/firmware/compatibility-check
Description
This endpoint allows a user to request all firmware and nvsram files that are compatible with a StorageSystem, or list of StorageSystems.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
A compatibility check is already running. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/compatibility-check
Request body
{
"storageDeviceIds" : [ "string" ],
"releasedBuildsOnly" : true
}
Example HTTP response
Response 200
{
"checkRunning" : true,
"cancelled" : true,
"lastStart" : "string",
"inaccessibleStorageDevices" : [ "string" ],
"results" : [ {
"storageDeviceId" : "string",
"storageDeviceWwn" : "string",
"cfwFiles" : [ {
"filename" : "string",
"version" : "string"
} ],
"nvsramFiles" : [ {
"version" : "string",
"filename" : "string"
} ]
} ],
"requestId" : "string",
"failedStorageDevices" : [ "string" ]
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.11.22. Cancel a firmware compatibility check operation
DELETE /devmgr/v2/firmware/compatibility-check
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
successful operation |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/compatibility-check
3.11.23. Initiate a health check operation on the storage-system
POST /devmgr/v2/storage-systems/{system-id}/health-check
Description
The health checks are designed to test whether or not a storage-system’s state is healthy enough to safely allow a firmware upgrade operation to proceed.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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 |
|
408 |
Request timed out |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/health-check
Example HTTP response
Response 200
{
"storageDeviceId" : "string",
"storageDeviceName" : "string",
"storageDeviceWWN" : "string",
"processingTimeMS" : "string",
"rerun" : true,
"recommendedRecovery" : "string",
"successful" : true,
"storageDeviceAccessible" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"spmDatabaseVerification" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"failureMessages" : [ "string" ],
"successful" : true
},
"configurationDatabaseCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"status" : "string",
"successful" : true
},
"objectGraphSyncCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"cfwMatch" : true,
"nvsramMatch" : true,
"successful" : true
},
"volumeGroupsComplete" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"controllerStatusOptimal" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"hotSparesInUse" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"missingVolumes" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"driveCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"exclusiveOperations" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"volumeRefToAction" : {
"string" : "string"
},
"successful" : true
},
"failedDrivesPresent" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"validPasswordSet" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"melCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"warningMessages" : [ "string" ],
"successful" : true
},
"dbSubRecordsValidation" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"integratedHealthCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"healthCheckTests" : [ {
"testPassed" : true,
"testName" : "string",
"resultsData" : "string"
} ],
"successful" : true
}
}
3.11.24. Delete an uploaded firmware file
DELETE /devmgr/v2/firmware/upload/{filename}
Description
Delete an uploaded firmware file by providing the filename. If the file is locked the file will be scheduled for deletion on service shutdown.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
filename |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
File deletion was successful. |
|
423 |
The file is locked and could not be deleted, but an attempt will be made to delete it upon shutdown. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/upload/string
3.11.25. Upload a firmware file.
POST /devmgr/v2/firmware/upload
Description
The firmware file will be uploaded to the server and will be available for firmware upgrade operations. It is recommended to keep the file names the same as they were named by the company. Some file types require this and will fail of renamed
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
validate |
Validate firmware file |
boolean |
|
FormData |
firmwareFile |
The firmware file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
An unexpected error occurred saving the firmware file. |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/firmware/upload
Request query
{
"validate" : true
}
Request formData
"file"
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileName" : "string"
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.11.26. Get health check status
GET /devmgr/v2/health-check
Description
This endpoint should be utilized to retrieve the results of the health check. There are multiple parts to the health check process. If a critical portion fails, the entire check will be set to failed. If an invalid password is detected or a controller cannot be contacted, the check will return without completing additional unnecessary steps.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
requestId |
Retrieve result of a previously submitted request. |
integer (int64) |
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/health-check
Request query
{
"requestId" : 0
}
Example HTTP response
Response 200
{
"requestId" : "string",
"healthCheckRunning" : true,
"cancelled" : true,
"remaining" : 0,
"results" : [ {
"storageDeviceId" : "string",
"storageDeviceName" : "string",
"storageDeviceWWN" : "string",
"processingTimeMS" : "string",
"rerun" : true,
"recommendedRecovery" : "string",
"successful" : true,
"storageDeviceAccessible" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"spmDatabaseVerification" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"failureMessages" : [ "string" ],
"successful" : true
},
"configurationDatabaseCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"status" : "string",
"successful" : true
},
"objectGraphSyncCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"cfwMatch" : true,
"nvsramMatch" : true,
"successful" : true
},
"volumeGroupsComplete" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"controllerStatusOptimal" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"hotSparesInUse" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"missingVolumes" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"driveCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"exclusiveOperations" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"volumeRefToAction" : {
"string" : "string"
},
"successful" : true
},
"failedDrivesPresent" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"validPasswordSet" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"melCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"warningMessages" : [ "string" ],
"successful" : true
},
"dbSubRecordsValidation" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"successful" : true
},
"integratedHealthCheck" : {
"result" : "string",
"type" : "string",
"severityLevel" : "string",
"resultsData" : "string",
"healthCheckTests" : [ {
"testPassed" : true,
"testName" : "string",
"resultsData" : "string"
} ],
"successful" : true
}
} ],
"start" : "string"
}
3.11.27. Begin a health check
POST /devmgr/v2/health-check
Description
The health checks are designed to test whether or not a StorageSystem is stable enough to safely allow a firmware upgrade operation to proceed. They can also be used in a generic fashion to probe a large number of StorageSystems for issues requiring attention.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
202 |
Request accepted |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/health-check
Request body
{
"onlineOnly" : true,
"storageDeviceIds" : [ "string" ]
}
Example HTTP response
Response 200
{
"requestId" : "string"
}
3.11.28. Cancel a running health check
DELETE /devmgr/v2/health-check
Description
This operation may take some time to cancel, as pending operations must be completed first.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Cancelled |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/health-check
3.12. Flash-Cache
3.12.1. Retrieve the FlashCache, if it exists.
GET /devmgr/v2/storage-systems/{system-id}/flash-cache
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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 |
No FlashCache has been defined |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache
Example HTTP response
Response 200
{
"wwn" : "string",
"flashCacheRef" : "string",
"flashCacheBase" : {
"label" : "string",
"status" : "string",
"configType" : "string",
"analyticsStatus" : "string",
"analyticsCause" : "string",
"statusCause" : "string"
},
"fcDriveInfo" : {
"flashCacheType" : "string",
"fcWithDrives" : {
"securityType" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"usedCapacity" : "string",
"securityLevel" : "string"
}
},
"cachedVolumes" : [ "string" ],
"driveRefs" : [ "string" ],
"name" : "string",
"id" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.12.2. Define a new FlashCache
POST /devmgr/v2/storage-systems/{system-id}/flash-cache
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/flash-cache
Request body
{
"driveRefs" : [ "string" ],
"name" : "string",
"enableExistingVolumes" : true
}
Example HTTP response
Response 200
{
"wwn" : "string",
"flashCacheRef" : "string",
"flashCacheBase" : {
"label" : "string",
"status" : "string",
"configType" : "string",
"analyticsStatus" : "string",
"analyticsCause" : "string",
"statusCause" : "string"
},
"fcDriveInfo" : {
"flashCacheType" : "string",
"fcWithDrives" : {
"securityType" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"usedCapacity" : "string",
"securityLevel" : "string"
}
},
"cachedVolumes" : [ "string" ],
"driveRefs" : [ "string" ],
"name" : "string",
"id" : "string"
}
3.12.3. Delete the defined FlashCache
DELETE /devmgr/v2/storage-systems/{system-id}/flash-cache
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Delete FlashCache successful |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache
3.12.4. Suspend the FlashCache
POST /devmgr/v2/storage-systems/{system-id}/flash-cache/suspend
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/flash-cache/suspend
Example HTTP response
Response 200
{
"wwn" : "string",
"flashCacheRef" : "string",
"flashCacheBase" : {
"label" : "string",
"status" : "string",
"configType" : "string",
"analyticsStatus" : "string",
"analyticsCause" : "string",
"statusCause" : "string"
},
"fcDriveInfo" : {
"flashCacheType" : "string",
"fcWithDrives" : {
"securityType" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"usedCapacity" : "string",
"securityLevel" : "string"
}
},
"cachedVolumes" : [ "string" ],
"driveRefs" : [ "string" ],
"name" : "string",
"id" : "string"
}
3.12.5. Resume a suspended FlashCache
POST /devmgr/v2/storage-systems/{system-id}/flash-cache/resume
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/flash-cache/resume
Example HTTP response
Response 200
{
"wwn" : "string",
"flashCacheRef" : "string",
"flashCacheBase" : {
"label" : "string",
"status" : "string",
"configType" : "string",
"analyticsStatus" : "string",
"analyticsCause" : "string",
"statusCause" : "string"
},
"fcDriveInfo" : {
"flashCacheType" : "string",
"fcWithDrives" : {
"securityType" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"usedCapacity" : "string",
"securityLevel" : "string"
}
},
"cachedVolumes" : [ "string" ],
"driveRefs" : [ "string" ],
"name" : "string",
"id" : "string"
}
3.12.6. Retrieve a list of volumes that are compatible with the defined flashCache
GET /devmgr/v2/storage-systems/{system-id}/flash-cache/compatibleVolumes
Description
Volumes must be compatible with the security and DataAssurance settings of the FlashCache to be added.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< string > array |
404 |
No FlashCache has been defined |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache/compatibleVolumes
Example HTTP response
Response 200
[ "string" ]
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.12.7. Remove drives currently being used by the FlashCache
POST /devmgr/v2/storage-systems/{system-id}/flash-cache/removeDrives
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
No FlashCache has been defined |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache/removeDrives
Request body
{
"driveRef" : [ "string" ]
}
Example HTTP response
Response 200
{
"wwn" : "string",
"flashCacheRef" : "string",
"flashCacheBase" : {
"label" : "string",
"status" : "string",
"configType" : "string",
"analyticsStatus" : "string",
"analyticsCause" : "string",
"statusCause" : "string"
},
"fcDriveInfo" : {
"flashCacheType" : "string",
"fcWithDrives" : {
"securityType" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"usedCapacity" : "string",
"securityLevel" : "string"
}
},
"cachedVolumes" : [ "string" ],
"driveRefs" : [ "string" ],
"name" : "string",
"id" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.12.8. Add drives to an existing FlashCache
POST /devmgr/v2/storage-systems/{system-id}/flash-cache/addDrives
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
No FlashCache has been defined |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/flash-cache/addDrives
Request body
{
"driveRef" : [ "string" ]
}
Example HTTP response
Response 200
{
"wwn" : "string",
"flashCacheRef" : "string",
"flashCacheBase" : {
"label" : "string",
"status" : "string",
"configType" : "string",
"analyticsStatus" : "string",
"analyticsCause" : "string",
"statusCause" : "string"
},
"fcDriveInfo" : {
"flashCacheType" : "string",
"fcWithDrives" : {
"securityType" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"usedCapacity" : "string",
"securityLevel" : "string"
}
},
"cachedVolumes" : [ "string" ],
"driveRefs" : [ "string" ],
"name" : "string",
"id" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.12.9. Modify FlashCache parameters
POST /devmgr/v2/storage-systems/{system-id}/flash-cache/configure
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/flash-cache/configure
Request body
{
"name" : "string",
"configType" : "string"
}
Example HTTP response
Response 200
{
"wwn" : "string",
"flashCacheRef" : "string",
"flashCacheBase" : {
"label" : "string",
"status" : "string",
"configType" : "string",
"analyticsStatus" : "string",
"analyticsCause" : "string",
"statusCause" : "string"
},
"fcDriveInfo" : {
"flashCacheType" : "string",
"fcWithDrives" : {
"securityType" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"usedCapacity" : "string",
"securityLevel" : "string"
}
},
"cachedVolumes" : [ "string" ],
"driveRefs" : [ "string" ],
"name" : "string",
"id" : "string"
}
3.13. Hardware
3.13.1. Get a controller
GET /devmgr/v2/storage-systems/{system-id}/controllers/{controllerId}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
controllerId |
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/controllers/string
Example HTTP response
Response 200
{
"active" : true,
"quiesced" : true,
"status" : "string",
"controllerRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"productID" : "string",
"productRevLevel" : "string",
"serialNumber" : "string",
"boardID" : "string",
"cacheMemorySize" : 0,
"processorMemorySize" : 0,
"hostInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"driveInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"netInterfaces" : [ {
"interfaceType" : "string",
"ethernet" : {
"interfaceName" : "string",
"channel" : 0,
"speed" : 0,
"ip" : 0,
"alias" : "string",
"macAddr" : "string",
"gatewayIp" : 0,
"subnetMask" : 0,
"bootpUsed" : true,
"rloginEnabled" : true,
"reserved1" : "string",
"setupError" : true,
"reserved2" : "string",
"interfaceRef" : "string",
"linkStatus" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortStaticRoutableAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortRoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6AddressConfigMethod" : "string",
"fullDuplex" : true,
"supportedSpeedSettings" : [ "string" ],
"configuredSpeedSetting" : "string",
"currentSpeed" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
} ],
"inventory" : [ {
"itemName" : "string",
"itemVersion" : "string"
} ],
"reserved1" : "string",
"reserved2" : "string",
"hostBoardID" : "string",
"physicalCacheMemorySize" : 0,
"readyToRemove" : true,
"boardSubmodelID" : "string",
"submodelSupported" : true,
"oemPartNumber" : "string",
"partNumber" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"bootTime" : "string",
"modelName" : "string",
"networkSettings" : {
"ipv4DefaultRouterAddress" : "string",
"ipv6DefaultRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6CandidateDefaultRouterAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"remoteAccessEnabled" : true,
"dnsProperties" : {
"acquisitionProperties" : {
"dnsAcquisitionType" : "string",
"dnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"dhcpAcquiredDnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"ntpProperties" : {
"acquisitionProperties" : {
"ntpAcquisitionType" : "string",
"ntpServers" : [ {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
} ]
},
"dhcpAcquiredNtpServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"flashCacheMemorySize" : 0,
"ctrlIocDumpData" : {
"iocDumpNeedsRetrieved" : true,
"iocDumpTag" : 0,
"timeStamp" : "string"
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"controllerErrorMode" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ],
"id" : "string"
}
3.13.2. Get the list of controllers
GET /devmgr/v2/storage-systems/{system-id}/controllers
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Controller > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/controllers
Example HTTP response
Response 200
{
"active" : true,
"quiesced" : true,
"status" : "string",
"controllerRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"productID" : "string",
"productRevLevel" : "string",
"serialNumber" : "string",
"boardID" : "string",
"cacheMemorySize" : 0,
"processorMemorySize" : 0,
"hostInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"driveInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"netInterfaces" : [ {
"interfaceType" : "string",
"ethernet" : {
"interfaceName" : "string",
"channel" : 0,
"speed" : 0,
"ip" : 0,
"alias" : "string",
"macAddr" : "string",
"gatewayIp" : 0,
"subnetMask" : 0,
"bootpUsed" : true,
"rloginEnabled" : true,
"reserved1" : "string",
"setupError" : true,
"reserved2" : "string",
"interfaceRef" : "string",
"linkStatus" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortStaticRoutableAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortRoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6AddressConfigMethod" : "string",
"fullDuplex" : true,
"supportedSpeedSettings" : [ "string" ],
"configuredSpeedSetting" : "string",
"currentSpeed" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
} ],
"inventory" : [ {
"itemName" : "string",
"itemVersion" : "string"
} ],
"reserved1" : "string",
"reserved2" : "string",
"hostBoardID" : "string",
"physicalCacheMemorySize" : 0,
"readyToRemove" : true,
"boardSubmodelID" : "string",
"submodelSupported" : true,
"oemPartNumber" : "string",
"partNumber" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"bootTime" : "string",
"modelName" : "string",
"networkSettings" : {
"ipv4DefaultRouterAddress" : "string",
"ipv6DefaultRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6CandidateDefaultRouterAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"remoteAccessEnabled" : true,
"dnsProperties" : {
"acquisitionProperties" : {
"dnsAcquisitionType" : "string",
"dnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"dhcpAcquiredDnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"ntpProperties" : {
"acquisitionProperties" : {
"ntpAcquisitionType" : "string",
"ntpServers" : [ {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
} ]
},
"dhcpAcquiredNtpServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"flashCacheMemorySize" : 0,
"ctrlIocDumpData" : {
"iocDumpNeedsRetrieved" : true,
"iocDumpTag" : 0,
"timeStamp" : "string"
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"controllerErrorMode" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ],
"id" : "string"
} ]
3.13.3. Get the list of drives
GET /devmgr/v2/storage-systems/{system-id}/drives
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< DriveEx > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drives
Example HTTP response
Response 200
{
"offline" : true,
"hotSpare" : true,
"invalidDriveData" : true,
"available" : true,
"pfa" : true,
"driveRef" : "string",
"status" : "string",
"cause" : "string",
"interfaceType" : {
"driveType" : "string",
"fibre" : [ {
"channel" : 0,
"loopID" : 0
} ],
"sas" : {
"deviceName" : "string",
"drivePortAddresses" : [ {
"channel" : 0,
"portIdentifier" : "string"
} ]
},
"scsi" : {
"channel" : 0,
"id" : 0
}
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"productID" : "string",
"serialNumber" : "string",
"softwareVersion" : "string",
"blkSize" : 0,
"usableCapacity" : "string",
"rawCapacity" : "string",
"worldWideName" : "string",
"currentVolumeGroupRef" : "string",
"sparedForDriveRef" : "string",
"mirrorDrive" : "string",
"nonRedundantAccess" : true,
"workingChannel" : 0,
"volumeGroupIndex" : 0,
"currentSpeed" : "string",
"maxSpeed" : "string",
"uncertified" : true,
"hasDegradedChannel" : true,
"degradedChannels" : [ 0 ],
"phyDriveType" : "string",
"spindleSpeed" : 0,
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"reserved" : "string",
"phyDriveTypeData" : {
"phyDriveType" : "string",
"sataDriveAttributes" : {
"translatorData" : {
"vendorId" : "string",
"productId" : "string",
"productRevLevel" : "string",
"satType" : "string"
},
"ataDiskModelNumber" : "string",
"ataDiskFwRevision" : "string"
}
},
"pfaReason" : "string",
"bypassSource" : [ {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
} ],
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"fdeCapable" : true,
"fdeEnabled" : true,
"fdeLocked" : true,
"lockKeyID" : "string",
"ssdWearLife" : {
"averageEraseCountPercent" : 0,
"spareBlocksRemainingPercent" : 0,
"isWearLifeMonitoringSupported" : true,
"percentEnduranceUsed" : 0
},
"driveMediaType" : "string",
"fpgaVersion" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"protectionInformationCapable" : true,
"protectionType" : "string",
"interposerPresent" : true,
"interposerRef" : "string",
"currentCommandAgingTimeout" : 0,
"defaultCommandAgingTimeout" : 0,
"driveTemperature" : {
"currentTemp" : 0,
"refTemp" : 0
},
"blkSizePhysical" : 0,
"lowestAlignedLBA" : "string",
"removed" : true,
"locateInProgress" : true,
"fipsCapable" : true,
"firmwareVersion" : "string",
"lockKeyIDValue" : "string",
"id" : "string"
} ]
3.13.4. Select drives for storage-pool creation
POST /devmgr/v2/storage-systems/{system-id}/drives
Description
Retrieve a list of drives based on provided selection criteria. If the number of drives you have selected is not available based on the request parameters, then a 204 is returned.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
A valid list of drives was found |
< DriveEx > array |
204 |
Couldn’t find a set of drives that satisfies request parameters |
|
404 |
StorageDevice not found |
|
422 |
Invalid Parameter |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drives
Request body
{
"driveCount" : 0,
"selectedSpindleSpeeds" : [ 0 ],
"fdeCapableOnly" : true,
"driveCapacityMin" : "string",
"driveType" : "string",
"interfaceType" : "string",
"protectionInformationCapable" : true,
"sizeUnit" : "string",
"raidLevel" : "string",
"targetUsableCapacity" : 0
}
Example HTTP response
Response 200
{
"offline" : true,
"hotSpare" : true,
"invalidDriveData" : true,
"available" : true,
"pfa" : true,
"driveRef" : "string",
"status" : "string",
"cause" : "string",
"interfaceType" : {
"driveType" : "string",
"fibre" : [ {
"channel" : 0,
"loopID" : 0
} ],
"sas" : {
"deviceName" : "string",
"drivePortAddresses" : [ {
"channel" : 0,
"portIdentifier" : "string"
} ]
},
"scsi" : {
"channel" : 0,
"id" : 0
}
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"productID" : "string",
"serialNumber" : "string",
"softwareVersion" : "string",
"blkSize" : 0,
"usableCapacity" : "string",
"rawCapacity" : "string",
"worldWideName" : "string",
"currentVolumeGroupRef" : "string",
"sparedForDriveRef" : "string",
"mirrorDrive" : "string",
"nonRedundantAccess" : true,
"workingChannel" : 0,
"volumeGroupIndex" : 0,
"currentSpeed" : "string",
"maxSpeed" : "string",
"uncertified" : true,
"hasDegradedChannel" : true,
"degradedChannels" : [ 0 ],
"phyDriveType" : "string",
"spindleSpeed" : 0,
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"reserved" : "string",
"phyDriveTypeData" : {
"phyDriveType" : "string",
"sataDriveAttributes" : {
"translatorData" : {
"vendorId" : "string",
"productId" : "string",
"productRevLevel" : "string",
"satType" : "string"
},
"ataDiskModelNumber" : "string",
"ataDiskFwRevision" : "string"
}
},
"pfaReason" : "string",
"bypassSource" : [ {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
} ],
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"fdeCapable" : true,
"fdeEnabled" : true,
"fdeLocked" : true,
"lockKeyID" : "string",
"ssdWearLife" : {
"averageEraseCountPercent" : 0,
"spareBlocksRemainingPercent" : 0,
"isWearLifeMonitoringSupported" : true,
"percentEnduranceUsed" : 0
},
"driveMediaType" : "string",
"fpgaVersion" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"protectionInformationCapable" : true,
"protectionType" : "string",
"interposerPresent" : true,
"interposerRef" : "string",
"currentCommandAgingTimeout" : 0,
"defaultCommandAgingTimeout" : 0,
"driveTemperature" : {
"currentTemp" : 0,
"refTemp" : 0
},
"blkSizePhysical" : 0,
"lowestAlignedLBA" : "string",
"removed" : true,
"locateInProgress" : true,
"fipsCapable" : true,
"firmwareVersion" : "string",
"lockKeyIDValue" : "string",
"id" : "string"
} ]
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
Response 424
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.13.5. Get a drive
GET /devmgr/v2/storage-systems/{system-id}/drives/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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/drives/string
Example HTTP response
Response 200
{
"offline" : true,
"hotSpare" : true,
"invalidDriveData" : true,
"available" : true,
"pfa" : true,
"driveRef" : "string",
"status" : "string",
"cause" : "string",
"interfaceType" : {
"driveType" : "string",
"fibre" : [ {
"channel" : 0,
"loopID" : 0
} ],
"sas" : {
"deviceName" : "string",
"drivePortAddresses" : [ {
"channel" : 0,
"portIdentifier" : "string"
} ]
},
"scsi" : {
"channel" : 0,
"id" : 0
}
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"productID" : "string",
"serialNumber" : "string",
"softwareVersion" : "string",
"blkSize" : 0,
"usableCapacity" : "string",
"rawCapacity" : "string",
"worldWideName" : "string",
"currentVolumeGroupRef" : "string",
"sparedForDriveRef" : "string",
"mirrorDrive" : "string",
"nonRedundantAccess" : true,
"workingChannel" : 0,
"volumeGroupIndex" : 0,
"currentSpeed" : "string",
"maxSpeed" : "string",
"uncertified" : true,
"hasDegradedChannel" : true,
"degradedChannels" : [ 0 ],
"phyDriveType" : "string",
"spindleSpeed" : 0,
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"reserved" : "string",
"phyDriveTypeData" : {
"phyDriveType" : "string",
"sataDriveAttributes" : {
"translatorData" : {
"vendorId" : "string",
"productId" : "string",
"productRevLevel" : "string",
"satType" : "string"
},
"ataDiskModelNumber" : "string",
"ataDiskFwRevision" : "string"
}
},
"pfaReason" : "string",
"bypassSource" : [ {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
} ],
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"fdeCapable" : true,
"fdeEnabled" : true,
"fdeLocked" : true,
"lockKeyID" : "string",
"ssdWearLife" : {
"averageEraseCountPercent" : 0,
"spareBlocksRemainingPercent" : 0,
"isWearLifeMonitoringSupported" : true,
"percentEnduranceUsed" : 0
},
"driveMediaType" : "string",
"fpgaVersion" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"protectionInformationCapable" : true,
"protectionType" : "string",
"interposerPresent" : true,
"interposerRef" : "string",
"currentCommandAgingTimeout" : 0,
"defaultCommandAgingTimeout" : 0,
"driveTemperature" : {
"currentTemp" : 0,
"refTemp" : 0
},
"blkSizePhysical" : 0,
"lowestAlignedLBA" : "string",
"removed" : true,
"locateInProgress" : true,
"fipsCapable" : true,
"firmwareVersion" : "string",
"lockKeyIDValue" : "string",
"id" : "string"
}
3.13.6. Get the list of unreadable sectors
GET /devmgr/v2/storage-systems/{system-id}/drives/unreadable-sectors
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/drives/unreadable-sectors
Example HTTP response
Response 200
{
"maxLimit" : 0,
"database" : [ {
"driveRef" : "string",
"timeStamp" : "string",
"recordType" : "string",
"volumeRef" : "string",
"driveLBA" : "string",
"trayNo" : 0,
"volumeLBA" : "string",
"slotNo" : 0
} ]
}
3.13.7. Get hardware information
GET /devmgr/v2/storage-systems/{system-id}/hardware-inventory
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/hardware-inventory
Example HTTP response
Response 200
{
"drives" : [ {
"offline" : true,
"hotSpare" : true,
"invalidDriveData" : true,
"available" : true,
"pfa" : true,
"driveRef" : "string",
"status" : "string",
"cause" : "string",
"interfaceType" : {
"driveType" : "string",
"fibre" : [ {
"channel" : 0,
"loopID" : 0
} ],
"sas" : {
"deviceName" : "string",
"drivePortAddresses" : [ {
"channel" : 0,
"portIdentifier" : "string"
} ]
},
"scsi" : {
"channel" : 0,
"id" : 0
}
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"productID" : "string",
"serialNumber" : "string",
"softwareVersion" : "string",
"blkSize" : 0,
"usableCapacity" : "string",
"rawCapacity" : "string",
"worldWideName" : "string",
"currentVolumeGroupRef" : "string",
"sparedForDriveRef" : "string",
"mirrorDrive" : "string",
"nonRedundantAccess" : true,
"workingChannel" : 0,
"volumeGroupIndex" : 0,
"currentSpeed" : "string",
"maxSpeed" : "string",
"uncertified" : true,
"hasDegradedChannel" : true,
"degradedChannels" : [ 0 ],
"phyDriveType" : "string",
"spindleSpeed" : 0,
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"reserved" : "string",
"phyDriveTypeData" : {
"phyDriveType" : "string",
"sataDriveAttributes" : {
"translatorData" : {
"vendorId" : "string",
"productId" : "string",
"productRevLevel" : "string",
"satType" : "string"
},
"ataDiskModelNumber" : "string",
"ataDiskFwRevision" : "string"
}
},
"pfaReason" : "string",
"bypassSource" : [ {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
} ],
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"fdeCapable" : true,
"fdeEnabled" : true,
"fdeLocked" : true,
"lockKeyID" : "string",
"ssdWearLife" : {
"averageEraseCountPercent" : 0,
"spareBlocksRemainingPercent" : 0,
"isWearLifeMonitoringSupported" : true,
"percentEnduranceUsed" : 0
},
"driveMediaType" : "string",
"fpgaVersion" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"protectionInformationCapable" : true,
"protectionType" : "string",
"interposerPresent" : true,
"interposerRef" : "string",
"currentCommandAgingTimeout" : 0,
"defaultCommandAgingTimeout" : 0,
"driveTemperature" : {
"currentTemp" : 0,
"refTemp" : 0
},
"blkSizePhysical" : 0,
"lowestAlignedLBA" : "string",
"removed" : true,
"locateInProgress" : true,
"fipsCapable" : true,
"firmwareVersion" : "string",
"lockKeyIDValue" : "string",
"id" : "string"
} ],
"ibPorts" : [ {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"controllerId" : "string",
"commandProtocolProperties" : [ {
"commandProtocol" : "string",
"nvmeProperties" : {
"commandSet" : "string",
"nvmeofProperties" : {
"provider" : "string",
"ibProperties" : {
"ipAddressData" : {
"addressType" : "string",
"ipv4Data" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
},
"ipv6Data" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
}
},
"listeningPort" : 0
},
"roceV2Properties" : {
"ipv4Enabled" : true,
"ipv6Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"listeningPort" : 0
}
}
}
} ],
"interfaceId" : "string",
"niceAddressId" : "string",
"addressId" : "string",
"id" : "string"
} ],
"iscsiPorts" : [ {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"iqn" : "string",
"controllerId" : "string",
"interfaceId" : "string",
"niceAddressId" : "string",
"addressId" : "string",
"id" : "string"
} ],
"fibrePorts" : [ {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"controllerId" : "string",
"interfaceId" : "string",
"niceAddressId" : "string",
"addressId" : "string",
"id" : "string"
} ],
"sasPorts" : [ {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"controllerId" : "string",
"interfaceId" : "string",
"niceAddressId" : "string",
"addressId" : "string",
"basePortAddress" : "string",
"id" : "string"
} ],
"ethernetPorts" : [ {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"controllerId" : "string",
"commandProtocolProperties" : [ {
"commandProtocol" : "string",
"nvmeProperties" : {
"commandSet" : "string",
"nvmeofProperties" : {
"provider" : "string",
"ibProperties" : {
"ipAddressData" : {
"addressType" : "string",
"ipv4Data" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
},
"ipv6Data" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
}
},
"listeningPort" : 0
},
"roceV2Properties" : {
"ipv4Enabled" : true,
"ipv6Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"listeningPort" : 0
}
}
}
} ],
"interfaceId" : "string",
"niceAddressId" : "string",
"addressId" : "string",
"id" : "string"
} ],
"sasExpanders" : [ {
"expanderRef" : "string",
"parent" : {
"expanderParentType" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentDrawer" : "string"
},
"channel" : 0,
"deviceName" : "string",
"vendorId" : "string",
"productId" : "string",
"fwVersion" : "string",
"expanderPorts" : [ {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
} ],
"domainNumber" : 0,
"id" : "string"
} ],
"channelPorts" : [ {
"portRef" : "string",
"portParent" : {
"type" : "string",
"controllerRef" : "string",
"esmRef" : "string",
"minihubRef" : "string",
"hicRef" : "string"
},
"portNumber" : 0,
"channel" : 0,
"channelType" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkActive" : true,
"id" : "string"
} ],
"trays" : [ {
"type" : "string",
"orientation" : "string",
"numControllerSlots" : 0,
"numDriveSlots" : 0,
"trayId" : 0,
"trayRef" : "string",
"nonRedundantAccess" : true,
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufacturerDate" : "string",
"fruType" : "string",
"trayIDMismatch" : true,
"trayIDConflict" : true,
"esmVersionMismatch" : true,
"esmMiswire" : true,
"drvMHSpeedMismatch" : true,
"unsupportedTray" : true,
"workingChannel" : 0,
"maxSpeed" : "string",
"trayTechnologyType" : "string",
"esmGroupError" : true,
"uncertifiedTray" : true,
"locateTray" : true,
"esmHardwareMismatch" : true,
"hasConfigurableTrayId" : true,
"frontEndInterfaceTechnology" : "string",
"driveTechnologies" : [ "string" ],
"numDriveCompartments" : 0,
"numDriveSlotsPerCompartment" : 0,
"trayAttributes" : [ {
"attributeId" : "string",
"attributeValue" : "string"
} ],
"isMisconfigured" : true,
"esmFactoryDefaultsMismatch" : true,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"numDrawers" : 0,
"driveLayout" : {
"driveOrientation" : "string",
"numRows" : 0,
"numColumns" : 0,
"primaryTraversal" : "string",
"secondaryTraversal" : "string"
},
"factoryDefaultsData" : {
"factoryDefaultsVersion" : "string",
"isSupported" : true
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"oemPartNumber" : "string",
"trayPositionIndex" : 0,
"id" : "string"
} ],
"drawers" : [ {
"drawerRef" : "string",
"isOpen" : true,
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"softwareVersion" : "string",
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufactureDate" : "string",
"fruType" : "string",
"drawerType" : "string",
"id" : "string"
} ],
"controllers" : [ {
"active" : true,
"quiesced" : true,
"status" : "string",
"controllerRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"productID" : "string",
"productRevLevel" : "string",
"serialNumber" : "string",
"boardID" : "string",
"cacheMemorySize" : 0,
"processorMemorySize" : 0,
"hostInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"driveInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"netInterfaces" : [ {
"interfaceType" : "string",
"ethernet" : {
"interfaceName" : "string",
"channel" : 0,
"speed" : 0,
"ip" : 0,
"alias" : "string",
"macAddr" : "string",
"gatewayIp" : 0,
"subnetMask" : 0,
"bootpUsed" : true,
"rloginEnabled" : true,
"reserved1" : "string",
"setupError" : true,
"reserved2" : "string",
"interfaceRef" : "string",
"linkStatus" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortStaticRoutableAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortRoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6AddressConfigMethod" : "string",
"fullDuplex" : true,
"supportedSpeedSettings" : [ "string" ],
"configuredSpeedSetting" : "string",
"currentSpeed" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
} ],
"inventory" : [ {
"itemName" : "string",
"itemVersion" : "string"
} ],
"reserved1" : "string",
"reserved2" : "string",
"hostBoardID" : "string",
"physicalCacheMemorySize" : 0,
"readyToRemove" : true,
"boardSubmodelID" : "string",
"submodelSupported" : true,
"oemPartNumber" : "string",
"partNumber" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"bootTime" : "string",
"modelName" : "string",
"networkSettings" : {
"ipv4DefaultRouterAddress" : "string",
"ipv6DefaultRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6CandidateDefaultRouterAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"remoteAccessEnabled" : true,
"dnsProperties" : {
"acquisitionProperties" : {
"dnsAcquisitionType" : "string",
"dnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"dhcpAcquiredDnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"ntpProperties" : {
"acquisitionProperties" : {
"ntpAcquisitionType" : "string",
"ntpServers" : [ {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
} ]
},
"dhcpAcquiredNtpServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"flashCacheMemorySize" : 0,
"ctrlIocDumpData" : {
"iocDumpNeedsRetrieved" : true,
"iocDumpTag" : 0,
"timeStamp" : "string"
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"controllerErrorMode" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ],
"id" : "string"
} ],
"batteries" : [ {
"batteryRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"batteryAge" : 0,
"batteryLifeRemaining" : 0,
"batteryTypeData" : {
"batteryType" : "string",
"cruParentController" : "string",
"parentController" : "string"
},
"reserved1" : "string",
"reserved2" : "string",
"manufacturerDate" : "string",
"vendorName" : "string",
"vendorPN" : "string",
"vendorSN" : "string",
"fruType" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"batteryCanExpire" : true,
"automaticAgeReset" : true,
"learnCycleData" : {
"lastBatteryLearnCycle" : "string",
"nextBatteryLearnCycle" : "string",
"batteryLearnCycleInterval" : 0
},
"smartBatteryData" : {
"lastBatteryLearnCycle" : "string",
"nextBatteryLearnCycle" : "string",
"batteryLearnCycleInterval" : 0
},
"id" : "string"
} ],
"fans" : [ {
"fanRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"reserved1" : "string",
"reserved2" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"id" : "string"
} ],
"hostBoards" : [ {
"parentController" : "string",
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufacturerDate" : "string",
"fruType" : "string",
"hostBoardId" : "string",
"status" : "string",
"type" : "string",
"hostBoardRef" : "string",
"numberOfPorts" : 0,
"hbTypeData" : {
"type" : "string",
"dualPortIbTypeData" : {
"tcaGuid" : "string",
"queuePairsSupported" : 0,
"completionQueuesSupported" : 0,
"sharedReceiveQueuesSupported" : 0
},
"dualPortDenaliIbTypeData" : {
"tcaGuid" : "string",
"queuePairsSupported" : 0,
"completionQueuesSupported" : 0,
"sharedReceiveQueuesSupported" : 0
}
},
"oemPartNumber" : "string",
"hostBoardControllerSlot" : 0,
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"id" : "string"
} ],
"powerSupplies" : [ {
"powerSupplyRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufacturerDate" : "string",
"fruType" : "string",
"reserved1" : "string",
"reserved2" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"firmwareRevision" : "string",
"manufacturingDeviceCode" : 0,
"id" : "string"
} ],
"nvsramVersion" : "string",
"cacheMemoryDimms" : [ {
"cacheMemoryDimmRef" : "string",
"status" : "string",
"capacityInMegabytes" : 0,
"serialNumber" : "string",
"partNumber" : "string",
"oemPartNumber" : "string",
"manufacturerPartNumber" : "string",
"manufacturer" : "string",
"manufactureDate" : "string",
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"shared" : true,
"revisionCode" : "string"
} ],
"cacheBackupDevices" : [ {
"backupDeviceRef" : "string",
"backupDeviceControllerSlot" : 0,
"parentController" : "string",
"backupDeviceType" : "string",
"backupDeviceStatus" : "string",
"backupDeviceVpd" : {
"manufacturer" : "string",
"manufactureDate" : "string",
"productId" : "string",
"productRevLevel" : "string",
"partNumber" : "string",
"serialNumber" : "string"
},
"backupDeviceCapacity" : 0,
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"id" : "string"
} ],
"supportCRUs" : [ {
"supportCRURef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturerDate" : "string",
"vendorName" : "string",
"vendorPN" : "string",
"vendorSN" : "string",
"fruType" : "string",
"readyToRemove" : true,
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"configuredComponents" : [ "string" ],
"type" : "string",
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"id" : "string"
} ],
"esms" : [ {
"esmRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"nonRedundantAccess" : true,
"partNumber" : "string",
"serialNumber" : "string",
"manufacturerDate" : "string",
"manufacturer" : "string",
"fruType" : "string",
"softwareVersion" : "string",
"esmInterfaceData" : {
"ioInterfaceType" : "string",
"portList" : {
"ports" : [ {
"portStatus" : "string",
"portType" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ]
}
},
"productID" : "string",
"workingChannel" : 0,
"currentSpeed" : "string",
"maxSpeed" : "string",
"reserved1" : "string",
"reserved2" : "string",
"fibreEsm" : {
"esmPortRef" : "string",
"loopID" : 0,
"portRef" : "string"
},
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"esmInterfaceAttributes" : {
"ioInterfaceType" : "string",
"fibreEsmAttributes" : {
"isSwitched" : true,
"fibreEsmAddress" : {
"esmPortRef" : "string",
"loopID" : 0,
"portRef" : "string"
}
},
"sasEsmAttributes" : {
"sasExpander" : [ "string" ]
}
},
"boardId" : "string",
"factoryDefaultsData" : {
"isSupported" : true,
"factoryDefaultsVersion" : "string"
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"esmType" : "string",
"id" : "string"
} ],
"sfps" : [ {
"sfpRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"sfpType" : {
"sfpIdentType" : "string",
"sfpConnectType" : "string",
"sfpLinkLType" : "string",
"sfpTransmitterType" : "string",
"sfpSpeed" : [ "string" ],
"sfpTransmissionMedia" : [ "string" ],
"manufacturerDate" : "string",
"vendorName" : "string",
"vendorPN" : "string",
"vendorRev" : "string",
"vendorSN" : "string",
"vendorOUI" : "string",
"reserved1" : "string",
"reserved2" : "string"
},
"sfpPort" : "string",
"parentData" : {
"sfpParentType" : "string",
"controllerSFP" : {
"controllerSFPType" : "string",
"parentController" : "string",
"channel" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"parentEsm" : "string",
"parentMinihub" : "string"
},
"reserved1" : "string",
"reserved2" : "string",
"sfpPortRef" : "string",
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"id" : "string"
} ],
"thermalSensors" : [ {
"thermalSensorRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"reserved1" : "string",
"reserved2" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"id" : "string"
} ]
}
3.13.8. Get connectivity information for drive trays
GET /devmgr/v2/storage-systems/{system-id}/hardware-inventory/connections
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/hardware-inventory/connections
Example HTTP response
Response 200
{
"sasConnections" : [ {
"tray" : {
"type" : "string",
"orientation" : "string",
"numControllerSlots" : 0,
"numDriveSlots" : 0,
"trayId" : 0,
"trayRef" : "string",
"nonRedundantAccess" : true,
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufacturerDate" : "string",
"fruType" : "string",
"trayIDMismatch" : true,
"trayIDConflict" : true,
"esmVersionMismatch" : true,
"esmMiswire" : true,
"drvMHSpeedMismatch" : true,
"unsupportedTray" : true,
"workingChannel" : 0,
"maxSpeed" : "string",
"trayTechnologyType" : "string",
"esmGroupError" : true,
"uncertifiedTray" : true,
"locateTray" : true,
"esmHardwareMismatch" : true,
"hasConfigurableTrayId" : true,
"frontEndInterfaceTechnology" : "string",
"driveTechnologies" : [ "string" ],
"numDriveCompartments" : 0,
"numDriveSlotsPerCompartment" : 0,
"trayAttributes" : [ {
"attributeId" : "string",
"attributeValue" : "string"
} ],
"isMisconfigured" : true,
"esmFactoryDefaultsMismatch" : true,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"numDrawers" : 0,
"driveLayout" : {
"driveOrientation" : "string",
"numRows" : 0,
"numColumns" : 0,
"primaryTraversal" : "string",
"secondaryTraversal" : "string"
},
"factoryDefaultsData" : {
"factoryDefaultsVersion" : "string",
"isSupported" : true
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"oemPartNumber" : "string",
"id" : "string"
},
"esm" : {
"esmRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"nonRedundantAccess" : true,
"partNumber" : "string",
"serialNumber" : "string",
"manufacturerDate" : "string",
"manufacturer" : "string",
"fruType" : "string",
"softwareVersion" : "string",
"esmInterfaceData" : {
"ioInterfaceType" : "string",
"portList" : {
"ports" : [ {
"portStatus" : "string",
"portType" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ]
}
},
"productID" : "string",
"workingChannel" : 0,
"currentSpeed" : "string",
"maxSpeed" : "string",
"reserved1" : "string",
"reserved2" : "string",
"fibreEsm" : {
"esmPortRef" : "string",
"loopID" : 0,
"portRef" : "string"
},
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"esmInterfaceAttributes" : {
"ioInterfaceType" : "string",
"fibreEsmAttributes" : {
"isSwitched" : true,
"fibreEsmAddress" : {
"esmPortRef" : "string",
"loopID" : 0,
"portRef" : "string"
}
},
"sasEsmAttributes" : {
"sasExpander" : [ "string" ]
}
},
"boardId" : "string",
"factoryDefaultsData" : {
"isSupported" : true,
"factoryDefaultsVersion" : "string"
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"esmType" : "string",
"id" : "string"
},
"sasExpander" : {
"expanderRef" : "string",
"parent" : {
"expanderParentType" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentDrawer" : "string"
},
"channel" : 0,
"deviceName" : "string",
"vendorId" : "string",
"productId" : "string",
"fwVersion" : "string",
"expanderPorts" : [ {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
} ],
"domainNumber" : 0,
"id" : "string"
},
"sasPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"channelPort" : {
"portRef" : "string",
"portParent" : {
"type" : "string",
"controllerRef" : "string",
"esmRef" : "string",
"minihubRef" : "string",
"hicRef" : "string"
},
"portNumber" : 0,
"channel" : 0,
"channelType" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkActive" : true,
"id" : "string"
},
"attachedSasExpander" : {
"expanderRef" : "string",
"parent" : {
"expanderParentType" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentDrawer" : "string"
},
"channel" : 0,
"deviceName" : "string",
"vendorId" : "string",
"productId" : "string",
"fwVersion" : "string",
"expanderPorts" : [ {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
} ],
"domainNumber" : 0,
"id" : "string"
},
"attachedChannelPort" : {
"portRef" : "string",
"portParent" : {
"type" : "string",
"controllerRef" : "string",
"esmRef" : "string",
"minihubRef" : "string",
"hicRef" : "string"
},
"portNumber" : 0,
"channel" : 0,
"channelType" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkActive" : true,
"id" : "string"
},
"attachedController" : {
"active" : true,
"quiesced" : true,
"status" : "string",
"controllerRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"productID" : "string",
"productRevLevel" : "string",
"serialNumber" : "string",
"boardID" : "string",
"cacheMemorySize" : 0,
"processorMemorySize" : 0,
"hostInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"driveInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"netInterfaces" : [ {
"interfaceType" : "string",
"ethernet" : {
"interfaceName" : "string",
"channel" : 0,
"speed" : 0,
"ip" : 0,
"alias" : "string",
"macAddr" : "string",
"gatewayIp" : 0,
"subnetMask" : 0,
"bootpUsed" : true,
"rloginEnabled" : true,
"reserved1" : "string",
"setupError" : true,
"reserved2" : "string",
"interfaceRef" : "string",
"linkStatus" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortStaticRoutableAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortRoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6AddressConfigMethod" : "string",
"fullDuplex" : true,
"supportedSpeedSettings" : [ "string" ],
"configuredSpeedSetting" : "string",
"currentSpeed" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
} ],
"inventory" : [ {
"itemName" : "string",
"itemVersion" : "string"
} ],
"reserved1" : "string",
"reserved2" : "string",
"hostBoardID" : "string",
"physicalCacheMemorySize" : 0,
"readyToRemove" : true,
"boardSubmodelID" : "string",
"submodelSupported" : true,
"oemPartNumber" : "string",
"partNumber" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"bootTime" : "string",
"modelName" : "string",
"networkSettings" : {
"ipv4DefaultRouterAddress" : "string",
"ipv6DefaultRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6CandidateDefaultRouterAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"remoteAccessEnabled" : true,
"dnsProperties" : {
"acquisitionProperties" : {
"dnsAcquisitionType" : "string",
"dnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"dhcpAcquiredDnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"ntpProperties" : {
"acquisitionProperties" : {
"ntpAcquisitionType" : "string",
"ntpServers" : [ {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
} ]
},
"dhcpAcquiredNtpServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"flashCacheMemorySize" : 0,
"ctrlIocDumpData" : {
"iocDumpNeedsRetrieved" : true,
"iocDumpTag" : 0,
"timeStamp" : "string"
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"controllerErrorMode" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ],
"id" : "string"
},
"type" : "string"
} ],
"fibreConnections" : [ {
"tray" : {
"type" : "string",
"orientation" : "string",
"numControllerSlots" : 0,
"numDriveSlots" : 0,
"trayId" : 0,
"trayRef" : "string",
"nonRedundantAccess" : true,
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufacturerDate" : "string",
"fruType" : "string",
"trayIDMismatch" : true,
"trayIDConflict" : true,
"esmVersionMismatch" : true,
"esmMiswire" : true,
"drvMHSpeedMismatch" : true,
"unsupportedTray" : true,
"workingChannel" : 0,
"maxSpeed" : "string",
"trayTechnologyType" : "string",
"esmGroupError" : true,
"uncertifiedTray" : true,
"locateTray" : true,
"esmHardwareMismatch" : true,
"hasConfigurableTrayId" : true,
"frontEndInterfaceTechnology" : "string",
"driveTechnologies" : [ "string" ],
"numDriveCompartments" : 0,
"numDriveSlotsPerCompartment" : 0,
"trayAttributes" : [ {
"attributeId" : "string",
"attributeValue" : "string"
} ],
"isMisconfigured" : true,
"esmFactoryDefaultsMismatch" : true,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"numDrawers" : 0,
"driveLayout" : {
"driveOrientation" : "string",
"numRows" : 0,
"numColumns" : 0,
"primaryTraversal" : "string",
"secondaryTraversal" : "string"
},
"factoryDefaultsData" : {
"factoryDefaultsVersion" : "string",
"isSupported" : true
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"oemPartNumber" : "string",
"id" : "string"
},
"esm" : {
"esmRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"nonRedundantAccess" : true,
"partNumber" : "string",
"serialNumber" : "string",
"manufacturerDate" : "string",
"manufacturer" : "string",
"fruType" : "string",
"softwareVersion" : "string",
"esmInterfaceData" : {
"ioInterfaceType" : "string",
"portList" : {
"ports" : [ {
"portStatus" : "string",
"portType" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ]
}
},
"productID" : "string",
"workingChannel" : 0,
"currentSpeed" : "string",
"maxSpeed" : "string",
"reserved1" : "string",
"reserved2" : "string",
"fibreEsm" : {
"esmPortRef" : "string",
"loopID" : 0,
"portRef" : "string"
},
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"esmInterfaceAttributes" : {
"ioInterfaceType" : "string",
"fibreEsmAttributes" : {
"isSwitched" : true,
"fibreEsmAddress" : {
"esmPortRef" : "string",
"loopID" : 0,
"portRef" : "string"
}
},
"sasEsmAttributes" : {
"sasExpander" : [ "string" ]
}
},
"boardId" : "string",
"factoryDefaultsData" : {
"isSupported" : true,
"factoryDefaultsVersion" : "string"
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"esmType" : "string",
"id" : "string"
},
"channelPort" : {
"portRef" : "string",
"portParent" : {
"type" : "string",
"controllerRef" : "string",
"esmRef" : "string",
"minihubRef" : "string",
"hicRef" : "string"
},
"portNumber" : 0,
"channel" : 0,
"channelType" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkActive" : true,
"id" : "string"
},
"attachedController" : {
"active" : true,
"quiesced" : true,
"status" : "string",
"controllerRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"productID" : "string",
"productRevLevel" : "string",
"serialNumber" : "string",
"boardID" : "string",
"cacheMemorySize" : 0,
"processorMemorySize" : 0,
"hostInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"driveInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"netInterfaces" : [ {
"interfaceType" : "string",
"ethernet" : {
"interfaceName" : "string",
"channel" : 0,
"speed" : 0,
"ip" : 0,
"alias" : "string",
"macAddr" : "string",
"gatewayIp" : 0,
"subnetMask" : 0,
"bootpUsed" : true,
"rloginEnabled" : true,
"reserved1" : "string",
"setupError" : true,
"reserved2" : "string",
"interfaceRef" : "string",
"linkStatus" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortStaticRoutableAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortRoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6AddressConfigMethod" : "string",
"fullDuplex" : true,
"supportedSpeedSettings" : [ "string" ],
"configuredSpeedSetting" : "string",
"currentSpeed" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
} ],
"inventory" : [ {
"itemName" : "string",
"itemVersion" : "string"
} ],
"reserved1" : "string",
"reserved2" : "string",
"hostBoardID" : "string",
"physicalCacheMemorySize" : 0,
"readyToRemove" : true,
"boardSubmodelID" : "string",
"submodelSupported" : true,
"oemPartNumber" : "string",
"partNumber" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"bootTime" : "string",
"modelName" : "string",
"networkSettings" : {
"ipv4DefaultRouterAddress" : "string",
"ipv6DefaultRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6CandidateDefaultRouterAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"remoteAccessEnabled" : true,
"dnsProperties" : {
"acquisitionProperties" : {
"dnsAcquisitionType" : "string",
"dnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"dhcpAcquiredDnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"ntpProperties" : {
"acquisitionProperties" : {
"ntpAcquisitionType" : "string",
"ntpServers" : [ {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
} ]
},
"dhcpAcquiredNtpServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"flashCacheMemorySize" : 0,
"ctrlIocDumpData" : {
"iocDumpNeedsRetrieved" : true,
"iocDumpTag" : 0,
"timeStamp" : "string"
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"controllerErrorMode" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ],
"id" : "string"
},
"type" : "string"
} ]
}
3.13.9. Start hardware identification
POST /devmgr/v2/storage-systems/{system-id}/identify
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/identify
Request body
{
"channels" : [ 0 ],
"trays" : [ "string" ],
"drives" : [ "string" ],
"pools" : [ "string" ],
"volumes" : [ "string" ],
"storageSystem" : true
}
3.13.10. Cancel any active hardware identification
DELETE /devmgr/v2/storage-systems/{system-id}/identify
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Cancel successful |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/identify
3.13.11. Gets the list of storage-system I/O interfaces
GET /devmgr/v2/storage-systems/{system-id}/interfaces
MetaData
x-mode = both
x-netapp-api-status = beta
x-allowedRoles = [root.admin, storage.admin, storage.monitor]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
interfaceType |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
|
Query |
channelType |
enum (hostside, driveside, management, __UNDEFINED) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< IoInterface > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/interfaces
Request query
{
"interfaceType" : "string",
"channelType" : "string"
}
Example HTTP response
Response 200
{
"interfaceRef" : "string",
"channelType" : "string",
"ioInterfaceTypeData" : {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
},
"controllerRef" : "string",
"commandProtocolPropertiesList" : {
"commandProtocolProperties" : [ {
"commandProtocol" : "string",
"nvmeProperties" : {
"commandSet" : "string",
"nvmeofProperties" : {
"provider" : "string",
"ibProperties" : {
"ipAddressData" : {
"addressType" : "string",
"ipv4Data" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
},
"ipv6Data" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
}
},
"listeningPort" : 0
},
"roceV2Properties" : {
"ipv4Enabled" : true,
"ipv6Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"listeningPort" : 0
}
}
}
} ]
}
} ]
3.13.12. Gets a specific I/O interface
GET /devmgr/v2/storage-systems/{system-id}/interfaces/{id}
MetaData
x-mode = both
x-netapp-api-status = beta
x-allowedRoles = [root.admin, storage.admin, storage.monitor]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
I/O interface not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/interfaces/string
Example HTTP response
Response 200
{
"interfaceRef" : "string",
"channelType" : "string",
"ioInterfaceTypeData" : {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
},
"controllerRef" : "string",
"commandProtocolPropertiesList" : {
"commandProtocolProperties" : [ {
"commandProtocol" : "string",
"nvmeProperties" : {
"commandSet" : "string",
"nvmeofProperties" : {
"provider" : "string",
"ibProperties" : {
"ipAddressData" : {
"addressType" : "string",
"ipv4Data" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
},
"ipv6Data" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
}
},
"listeningPort" : 0
},
"roceV2Properties" : {
"ipv4Enabled" : true,
"ipv6Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"listeningPort" : 0
}
}
}
} ]
}
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.13.13. Get the iSCSI Entity data
GET /devmgr/v2/storage-systems/{system-id}/iscsi/entity
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/iscsi/entity
Example HTTP response
Response 200
{
"icmpPingResponseEnabled" : true,
"unnamedDiscoverySessionsEnabled" : true,
"isnsServerTcpListenPort" : 0,
"ipv4IsnsServerAddress" : "string",
"ipv6IsnsServerAddress" : "string",
"isnsServerRegistrationEnabled" : true,
"hostPortsConfiguredDHCP" : true,
"ipv4IsnsServerAddressConfigMethod" : "string",
"ipv6IsnsServerAddressConfigMethod" : "string",
"isnsRegistrationState" : "string"
}
3.13.14. Update iSCSI Entity data
POST /devmgr/v2/storage-systems/{system-id}/iscsi/entity
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/iscsi/entity
Request body
{
"icmpPingResponseEnabled" : true,
"unnamedDiscoverySessionsEnabled" : true,
"isnsServerTcpListenPort" : 0,
"ipv4IsnsServerAddressConfigMethod" : "string",
"ipv4IsnsServerAddress" : "string",
"ipv6IsnsServerAddress" : "string",
"isnsServerRegistrationEnabled" : true
}
Example HTTP response
Response 200
{
"icmpPingResponseEnabled" : true,
"unnamedDiscoverySessionsEnabled" : true,
"isnsServerTcpListenPort" : 0,
"ipv4IsnsServerAddress" : "string",
"ipv6IsnsServerAddress" : "string",
"isnsServerRegistrationEnabled" : true,
"hostPortsConfiguredDHCP" : true,
"ipv4IsnsServerAddressConfigMethod" : "string",
"ipv6IsnsServerAddressConfigMethod" : "string",
"isnsRegistrationState" : "string"
}
3.13.15. Get the iSCSI Target
GET /devmgr/v2/storage-systems/{system-id}/iscsi/target-settings
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/iscsi/target-settings
Example HTTP response
Response 200
{
"targetRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"alias" : {
"ioInterfaceType" : "string",
"iscsiAlias" : "string"
},
"configuredAuthMethods" : {
"authMethodData" : [ {
"authMethod" : "string",
"chapSecret" : [ {
"type" : "string",
"pkcs5Data" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
},
"pkcs5AesData" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
}
} ]
} ]
},
"portals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
}
3.13.16. Update the iSCSI Target
POST /devmgr/v2/storage-systems/{system-id}/iscsi/target-settings
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/iscsi/target-settings
Request body
{
"alias" : "string",
"enableChapAuthentication" : true,
"chapSecret" : "string"
}
Example HTTP response
Response 200
{
"authMethod" : "string",
"chapSecret" : "string",
"iqn" : "string",
"alias" : "string"
}
3.13.17. Get NVMeoF entity
GET /devmgr/v2/storage-systems/{system-id}/nvmeof/entity
Caution
|
operation.deprecated |
Description
This API is deprecated. The replacement may be found at: /storage-systems/{system-id}/interfaces
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< IoInterface > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/nvmeof/entity
Example HTTP response
Response 200
{
"interfaceRef" : "string",
"channelType" : "string",
"ioInterfaceTypeData" : {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
},
"controllerRef" : "string",
"commandProtocolPropertiesList" : {
"commandProtocolProperties" : [ {
"commandProtocol" : "string",
"nvmeProperties" : {
"commandSet" : "string",
"nvmeofProperties" : {
"provider" : "string",
"ibProperties" : {
"ipAddressData" : {
"addressType" : "string",
"ipv4Data" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
},
"ipv6Data" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
}
},
"listeningPort" : 0
},
"roceV2Properties" : {
"ipv4Enabled" : true,
"ipv6Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"listeningPort" : 0
}
}
}
} ]
}
} ]
3.13.18. Update NVMeoF entity
POST /devmgr/v2/storage-systems/{system-id}/nvmeof/entity
Caution
|
operation.deprecated |
Description
This API is deprecated. The replacement may be found at: /storage-systems/{system-id}/nvmeof/interfaces/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< IoInterface > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/nvmeof/entity
Request body
{
"nvmeInterface" : "string",
"ipv4Address" : [ "string" ]
}
Example HTTP response
Response 200
{
"interfaceRef" : "string",
"channelType" : "string",
"ioInterfaceTypeData" : {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
},
"controllerRef" : "string",
"commandProtocolPropertiesList" : {
"commandProtocolProperties" : [ {
"commandProtocol" : "string",
"nvmeProperties" : {
"commandSet" : "string",
"nvmeofProperties" : {
"provider" : "string",
"ibProperties" : {
"ipAddressData" : {
"addressType" : "string",
"ipv4Data" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
},
"ipv6Data" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
}
},
"listeningPort" : 0
},
"roceV2Properties" : {
"ipv4Enabled" : true,
"ipv6Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"listeningPort" : 0
}
}
}
} ]
}
} ]
3.13.19. Sets the NVMeoF network settings
POST /devmgr/v2/storage-systems/{system-id}/nvmeof/interfaces/{id}
Description
Mode: Both Embedded and Proxy.
MetaData
x-mode = both
x-netapp-api-status = beta
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
NVMeoF interface not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/nvmeof/interfaces/string
Request body
{
"settings" : {
"ibSettings" : {
"networkSettings" : {
"ipv4Address" : "string"
}
},
"roceV2Settings" : {
"networkSettings" : {
"interfaceSpeed" : "string",
"interfaceMtu" : 0,
"ipv4Enabled" : true,
"ipv4Settings" : {
"configurationMethod" : "string",
"address" : "string",
"subnetMask" : "string",
"gatewayAddress" : "string"
},
"ipv6Enabled" : true,
"ipv6Settings" : {
"configurationMethod" : "string",
"localAddresses" : [ "string" ],
"routableAddresses" : [ "string" ],
"routerAddress" : "string"
}
}
}
}
}
Example HTTP response
Response 200
{
"interfaceRef" : "string",
"channelType" : "string",
"ioInterfaceTypeData" : {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
},
"controllerRef" : "string",
"commandProtocolPropertiesList" : {
"commandProtocolProperties" : [ {
"commandProtocol" : "string",
"nvmeProperties" : {
"commandSet" : "string",
"nvmeofProperties" : {
"provider" : "string",
"ibProperties" : {
"ipAddressData" : {
"addressType" : "string",
"ipv4Data" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
},
"ipv6Data" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
}
},
"listeningPort" : 0
},
"roceV2Properties" : {
"ipv4Enabled" : true,
"ipv6Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"listeningPort" : 0
}
}
}
} ]
}
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.13.20. Get NVMeoF initiator settings
GET /devmgr/v2/storage-systems/{system-id}/nvmeof/initiator-settings
Description
Mode: Both Embedded and Proxy.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/nvmeof/initiator-settings
Example HTTP response
Response 200
{
"targetRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"alias" : {
"ioInterfaceType" : "string",
"iscsiAlias" : "string"
},
"configuredAuthMethods" : {
"authMethodData" : [ {
"authMethod" : "string",
"chapSecret" : [ {
"type" : "string",
"pkcs5Data" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
},
"pkcs5AesData" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
}
} ]
} ]
},
"portals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
}
3.14. Key-Values
3.14.1. List all existing the key-value pairs
GET /devmgr/v2/key-values
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< KeyValuePair > array |
422 |
Could not retrieve key-value pairs |
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/key-values
Example HTTP response
Response 200
{
"key" : "string",
"value" : "string"
} ]
3.14.2. Retrieve a key-value pair by its key.
GET /devmgr/v2/key-values/{key}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
key |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
Could not retrieve key-value pair |
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/key-values/string
Example HTTP response
Response 200
{
"key" : "string",
"value" : "string"
}
3.14.3. Sets a key to a provided value.
POST /devmgr/v2/key-values/{key}
Description
The value may be provided using either the body or a query parameter. The query parameter will take precedence if both are specified.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
key |
string |
|
Body |
body |
string |
|
Query |
value |
The value for the key |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
Could not add key-value pair. |
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/key-values/string
Request body
{ }
Request query
{
"value" : "string"
}
Example HTTP response
Response 200
{
"key" : "string",
"value" : "string"
}
3.14.4. Removes a key-value pair.
DELETE /devmgr/v2/key-values/{key}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
key |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Successful operation |
|
422 |
Could not remove key-value pair. |
Example HTTP request
Request path
/devmgr/v2/key-values/string
3.15. LDAP
3.15.1. Get the user’s current roles and list of role permissions.
GET /devmgr/v2/ldap/roles
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, security.admin, storage.admin, support.admin]
Parameters
Type | Name | Schema | Default |
---|---|---|---|
Query |
allUsers |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/ldap/roles
Request query
{
"allUsers" : true
}
Example HTTP response
Response 200
{
"userRoles" : [ "string" ],
"endpoints" : [ {
"httpMethod" : "string",
"endpoint" : "string",
"roles" : [ "string" ]
} ]
}
3.15.2. Retrieve the LDAP configuration on the proxy server
GET /devmgr/v2/ldap
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Unable to load proxy LDAP configuration |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/ldap
Example HTTP response
Response 200
{
"ldapDomains" : [ {
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
} ]
}
3.15.3. Configure LDAP on the proxy server for a single or multiple domains
POST /devmgr/v2/ldap
Description
Warning: This will remove previous configurations
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
|||
Query |
skipTest |
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 |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Unable to configure LDAP |
|
422 |
Testing of the LDAP configuration has failed |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/ldap
Request body
{
"ldapDomains" : [ {
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
} ]
}
Request query
{
"skipTest" : true
}
Example HTTP response
Response 200
{
"ldapDomains" : [ {
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
} ]
}
3.15.4. Remove the existing LDAP configuration
DELETE /devmgr/v2/ldap
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/ldap
Example HTTP response
Response 200
{
"ldapDomains" : [ {
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
} ]
}
3.15.5. Retrieve a specific LDAP domain configuration on the proxy server
GET /devmgr/v2/ldap/{id}
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
The id of the LDAP domain that configuration information should be retrieved for |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Unable to retrieve the specified domain |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/ldap/string
Example HTTP response
Response 200
{
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
}
3.15.6. Deletes the specified domain from the LDAP configuration on the proxy server
DELETE /devmgr/v2/ldap/{id}
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
The id of the LDAP domain to be deleted from the configuration |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
The specified domain has been successfully deleted |
|
404 |
Unable to delete specified domain |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/ldap/string
3.15.7. Adds an LDAP domain to the existing configuration on the proxy server
POST /devmgr/v2/ldap/addDomain
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
|||
Query |
skipTest |
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 |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Unable to add domain |
|
422 |
Testing of the LDAP domain has failed |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/ldap/addDomain
Request body
{
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
}
Request query
{
"skipTest" : true
}
Example HTTP response
Response 200
{
"ldapDomains" : [ {
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
} ]
}
3.15.8. Updates LDAP configuration for a single domain on the proxy server
POST /devmgr/v2/ldap/{domain-id}
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
domain-id |
The id of the LDAP domain that needs to be updated |
string |
|
Body |
body |
|||
Query |
skipTest |
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 |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Unable to update configuration |
|
422 |
Testing of the LDAP domain has failed |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/ldap/string
Request body
{
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
}
Request query
{
"skipTest" : true
}
Example HTTP response
Response 200
{
"ldapDomains" : [ {
"id" : "string",
"bindLookupUser" : {
"password" : "string",
"user" : "cn=BindUser,ou=system-accounts,dc=example,dc=com"
},
"groupAttributes" : "memberOf",
"ldapUrl" : "ldaps://ldap.example.com:636",
"names" : [ "string" ],
"roleMapCollection" : [ {
"groupRegex" : ".*cn=data-admin.*",
"ignorecase" : false,
"name" : "storage.monitor"
} ],
"searchBase" : "ou=users,dc=example,dc=com",
"userAttribute" : "sAMAccountName"
} ]
}
3.15.9. Test the current LDAP configuration on the proxy server.
POST /devmgr/v2/ldap/test
Description
If no bind user is defined only a communication test will be performed
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< LdapDomainTestResponse > array |
404 |
Unable to test the LDAP configuration |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/ldap/test
Example HTTP response
Response 200
{
"id" : "string",
"result" : {
"connectionTestResult" : "string",
"authenticationTestResult" : "string",
"searchTestResult" : "string"
}
} ]
3.16. Mapping
3.16.1. Get all HostGroups
GET /devmgr/v2/storage-systems/{system-id}/host-groups
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< HostGroup > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-groups
Example HTTP response
Response 200
{
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"protectionInformationCapableAccessMethod" : true,
"isLun0Restricted" : true,
"id" : "string",
"name" : "string"
} ]
3.16.2. Create a HostGroup
POST /devmgr/v2/storage-systems/{system-id}/host-groups
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/host-groups
Request body
{
"name" : "string",
"hosts" : [ "string" ]
}
Example HTTP response
Response 200
{
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"protectionInformationCapableAccessMethod" : true,
"isLun0Restricted" : true,
"id" : "string",
"name" : "string"
}
3.16.3. Get a HostGroup
GET /devmgr/v2/storage-systems/{system-id}/host-groups/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
The id of the hostgroup |
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/host-groups/string
Example HTTP response
Response 200
{
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"protectionInformationCapableAccessMethod" : true,
"isLun0Restricted" : true,
"id" : "string",
"name" : "string"
}
3.16.4. Update a HostGroup
POST /devmgr/v2/storage-systems/{system-id}/host-groups/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
The id of the hostgroup |
string |
Body |
body |
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/host-groups/string
Request body
{
"name" : "string",
"hosts" : [ "string" ]
}
Example HTTP response
Response 200
{
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"protectionInformationCapableAccessMethod" : true,
"isLun0Restricted" : true,
"id" : "string",
"name" : "string"
}
3.16.5. Delete a HostGroup
DELETE /devmgr/v2/storage-systems/{system-id}/host-groups/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
The id of the hostgroup |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Delete HostGroup successful |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-groups/string
3.16.6. Move a Host under a different HostGroup
POST /devmgr/v2/storage-systems/{system-id}/hosts/{hostId}/move
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
hostId |
The id of an existing host entry configured on the specified array |
string |
Body |
body |
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/hosts/string/move
Request body
{
"groupId" : "string"
}
Example HTTP response
Response 200
{
"hostRef" : "string",
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"hostTypeIndex" : 0,
"protectionInformationCapableAccessMethod" : true,
"isLargeBlockFormatHost" : true,
"isLun0Restricted" : true,
"ports" : [ {
"hostPortRef" : "string",
"hostPortName" : "string",
"label" : "string",
"hostRef" : "string",
"hostPortTypeIndex" : 0,
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"portId" : {
"ioInterfaceType" : "string",
"portName" : "string",
"ibPortName" : "string",
"iscsiPortName" : {
"initiatorNodeName" : "string",
"initiatorSessionId" : "string"
},
"sasPortName" : "string",
"nvmeInitiatorPortId" : {
"name" : "string",
"hostIdentifier" : "string",
"portIdentifier" : {
"ioInterfaceType" : "string",
"fcPortName" : "string",
"ibPortName" : "string",
"sasPortName" : "string"
}
}
},
"portInactive" : true,
"id" : "string"
} ],
"initiators" : [ {
"initiatorRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"alias" : {
"ioInterfaceType" : "string",
"iscsiAlias" : "string"
},
"label" : "string",
"configuredAuthMethods" : {
"authMethodData" : [ {
"authMethod" : "string",
"chapSecret" : [ {
"type" : "string",
"pkcs5Data" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
},
"pkcs5AesData" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
}
} ]
} ]
},
"hostRef" : "string",
"initiatorInactive" : true,
"initiatorNodeName" : {
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"interfaceType" : "string"
},
"id" : "string"
} ],
"hostSidePorts" : [ {
"id" : "string",
"type" : "string",
"address" : "string",
"label" : "string",
"mtpIoInterfaceType" : "string",
"name" : "string"
} ],
"id" : "string",
"name" : "string"
}
3.16.7. Get all Hosts
GET /devmgr/v2/storage-systems/{system-id}/hosts
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< HostEx > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hosts
Example HTTP response
Response 200
{
"hostRef" : "string",
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"hostTypeIndex" : 0,
"protectionInformationCapableAccessMethod" : true,
"isLargeBlockFormatHost" : true,
"isLun0Restricted" : true,
"ports" : [ {
"hostPortRef" : "string",
"hostPortName" : "string",
"label" : "string",
"hostRef" : "string",
"hostPortTypeIndex" : 0,
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"portId" : {
"ioInterfaceType" : "string",
"portName" : "string",
"ibPortName" : "string",
"iscsiPortName" : {
"initiatorNodeName" : "string",
"initiatorSessionId" : "string"
},
"sasPortName" : "string",
"nvmeInitiatorPortId" : {
"name" : "string",
"hostIdentifier" : "string",
"portIdentifier" : {
"ioInterfaceType" : "string",
"fcPortName" : "string",
"ibPortName" : "string",
"sasPortName" : "string"
}
}
},
"portInactive" : true,
"id" : "string"
} ],
"initiators" : [ {
"initiatorRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"alias" : {
"ioInterfaceType" : "string",
"iscsiAlias" : "string"
},
"label" : "string",
"configuredAuthMethods" : {
"authMethodData" : [ {
"authMethod" : "string",
"chapSecret" : [ {
"type" : "string",
"pkcs5Data" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
},
"pkcs5AesData" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
}
} ]
} ]
},
"hostRef" : "string",
"initiatorInactive" : true,
"initiatorNodeName" : {
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"interfaceType" : "string"
},
"id" : "string"
} ],
"hostSidePorts" : [ {
"id" : "string",
"type" : "string",
"address" : "string",
"label" : "string",
"mtpIoInterfaceType" : "string",
"name" : "string"
} ],
"id" : "string",
"name" : "string"
} ]
3.16.8. Create a new Host
POST /devmgr/v2/storage-systems/{system-id}/hosts
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Invalid HostGroup reference |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hosts
Request body
{
"name" : "string",
"hostType" : {
"name" : "string",
"index" : 0,
"code" : "string",
"used" : true,
"default" : true
},
"groupId" : "string",
"ports" : [ {
"type" : "string",
"port" : "string",
"label" : "string",
"iscsiChapSecret" : "string"
} ]
}
Example HTTP response
Response 200
{
"hostRef" : "string",
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"hostTypeIndex" : 0,
"protectionInformationCapableAccessMethod" : true,
"isLargeBlockFormatHost" : true,
"isLun0Restricted" : true,
"name" : "string",
"id" : "string"
}
3.16.9. Get a Host
GET /devmgr/v2/storage-systems/{system-id}/hosts/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
The id of the host |
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/hosts/string
Example HTTP response
Response 200
{
"hostRef" : "string",
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"hostTypeIndex" : 0,
"protectionInformationCapableAccessMethod" : true,
"isLargeBlockFormatHost" : true,
"isLun0Restricted" : true,
"ports" : [ {
"hostPortRef" : "string",
"hostPortName" : "string",
"label" : "string",
"hostRef" : "string",
"hostPortTypeIndex" : 0,
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"portId" : {
"ioInterfaceType" : "string",
"portName" : "string",
"ibPortName" : "string",
"iscsiPortName" : {
"initiatorNodeName" : "string",
"initiatorSessionId" : "string"
},
"sasPortName" : "string",
"nvmeInitiatorPortId" : {
"name" : "string",
"hostIdentifier" : "string",
"portIdentifier" : {
"ioInterfaceType" : "string",
"fcPortName" : "string",
"ibPortName" : "string",
"sasPortName" : "string"
}
}
},
"portInactive" : true,
"id" : "string"
} ],
"initiators" : [ {
"initiatorRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"alias" : {
"ioInterfaceType" : "string",
"iscsiAlias" : "string"
},
"label" : "string",
"configuredAuthMethods" : {
"authMethodData" : [ {
"authMethod" : "string",
"chapSecret" : [ {
"type" : "string",
"pkcs5Data" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
},
"pkcs5AesData" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
}
} ]
} ]
},
"hostRef" : "string",
"initiatorInactive" : true,
"initiatorNodeName" : {
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"interfaceType" : "string"
},
"id" : "string"
} ],
"hostSidePorts" : [ {
"id" : "string",
"type" : "string",
"address" : "string",
"label" : "string",
"mtpIoInterfaceType" : "string",
"name" : "string"
} ],
"id" : "string",
"name" : "string"
}
3.16.10. Update the parameters of a Host
POST /devmgr/v2/storage-systems/{system-id}/hosts/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
The id of the host |
string |
Body |
body |
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/hosts/string
Request body
{
"name" : "string",
"groupId" : "string",
"ports" : [ {
"type" : "string",
"port" : "string",
"label" : "string",
"iscsiChapSecret" : "string"
} ],
"portsToUpdate" : [ {
"portRef" : "string",
"hostRef" : "string",
"port" : "string",
"label" : "string",
"iscsiChapSecret" : "string"
} ],
"portsToRemove" : [ "string" ],
"hostType" : {
"name" : "string",
"index" : 0,
"code" : "string",
"used" : true,
"default" : true
}
}
Example HTTP response
Response 200
{
"hostRef" : "string",
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"hostTypeIndex" : 0,
"protectionInformationCapableAccessMethod" : true,
"isLargeBlockFormatHost" : true,
"isLun0Restricted" : true,
"ports" : [ {
"hostPortRef" : "string",
"hostPortName" : "string",
"label" : "string",
"hostRef" : "string",
"hostPortTypeIndex" : 0,
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"portId" : {
"ioInterfaceType" : "string",
"portName" : "string",
"ibPortName" : "string",
"iscsiPortName" : {
"initiatorNodeName" : "string",
"initiatorSessionId" : "string"
},
"sasPortName" : "string",
"nvmeInitiatorPortId" : {
"name" : "string",
"hostIdentifier" : "string",
"portIdentifier" : {
"ioInterfaceType" : "string",
"fcPortName" : "string",
"ibPortName" : "string",
"sasPortName" : "string"
}
}
},
"portInactive" : true,
"id" : "string"
} ],
"initiators" : [ {
"initiatorRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"alias" : {
"ioInterfaceType" : "string",
"iscsiAlias" : "string"
},
"label" : "string",
"configuredAuthMethods" : {
"authMethodData" : [ {
"authMethod" : "string",
"chapSecret" : [ {
"type" : "string",
"pkcs5Data" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
},
"pkcs5AesData" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
}
} ]
} ]
},
"hostRef" : "string",
"initiatorInactive" : true,
"initiatorNodeName" : {
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"interfaceType" : "string"
},
"id" : "string"
} ],
"hostSidePorts" : [ {
"id" : "string",
"type" : "string",
"address" : "string",
"label" : "string",
"mtpIoInterfaceType" : "string",
"name" : "string"
} ],
"id" : "string",
"name" : "string"
}
3.16.11. Delete a Host
DELETE /devmgr/v2/storage-systems/{system-id}/hosts/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
The id of the host |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Delete host successful |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/hosts/string
3.16.12. Get a HostType
GET /devmgr/v2/storage-systems/{system-id}/host-types/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
The id of the HostType |
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/host-types/string
Example HTTP response
Response 200
{
"name" : "string",
"index" : 0,
"code" : "string",
"used" : true,
"default" : true
}
3.16.13. Get all HostTypes
GET /devmgr/v2/storage-systems/{system-id}/host-types
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< HostType > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-types
Example HTTP response
Response 200
{
"name" : "string",
"index" : 0,
"code" : "string",
"used" : true,
"default" : true
} ]
3.16.14. Set default HostType
POST /devmgr/v2/storage-systems/{system-id}/host-types
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Invalid HostType |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-types
Request body
{
"value" : 0
}
Example HTTP response
Response 200
{
"name" : "string",
"index" : 0,
"code" : "string",
"used" : true,
"default" : true
}
3.16.15. Get the list of HostTypes
GET /devmgr/v2/storage-systems/{system-id}/host-type-values
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< HostTypeValues > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-type-values
Example HTTP response
Response 200
{
"waitForDownload" : true,
"notReadySenseForQuiescenceInProgress" : true,
"notReadySenseForQuiescenceInProgress2" : true,
"checkConditionForVendorUniqueUAConditions" : true,
"reportDeferredErrors" : true,
"ignoreForceUnitAccess" : true,
"ignoreWriteCacheDisable" : true,
"allowReservationOnUnownedLUNs" : true,
"worldWideNameInStandardInquiry" : true,
"propagateHostBusResets" : true,
"reportSCCDeviceEnable" : true,
"conditionalFCLogout" : true,
"forceSCSI2" : true,
"reportUnconfiguredLUNs" : true,
"ignoreSyncCache" : true,
"ignoreUTMLunOwnership" : true,
"reportLUNPreferredPathInStandardInquiry" : true,
"autoLUNTransfer" : true,
"inquiryUnconfiguredDeviceType" : "string",
"inquiryUnownedDeviceType" : "string",
"unownedBlock0Read" : "string",
"retainLogins" : true,
"hostPortType" : "string",
"maxRestrictedLUNs" : 0,
"reserved1" : "string",
"avtExclusionExtentsEnabled" : true,
"suppressVolOffPreferredPathAlert" : true,
"hostType" : "string",
"tpgsSupported" : true,
"volumeFormatOptions" : true,
"restrictedLun0" : true,
"usePage2CQuiescenceTimeout" : true,
"asymmetricLUAccess" : true,
"ignoreISCSISessionIDInITN" : true,
"enableLUCheckConditionParallelResponses" : true,
"disableExplicitTPGS" : true,
"unownedCheckConditionDuringFWActivation" : true,
"allowPreferredOwnerReportingSuppression" : true,
"enableTargetFailback" : true,
"enableAutoLoadBalance" : true,
"quiescenceInProgressSenseKey" : 0,
"quiescenceInProgressASC" : 0,
"quiescenceInProgressASCQ" : 0,
"persistentID" : 0,
"nvmeVUFailoverSupported" : true,
"nvmeStandardFailoverSupported" : true,
"index" : 0,
"default" : true
} ]
3.16.16. Get the list of HostTypes
GET /devmgr/v2/storage-systems/{system-id}/host-type-values/{index}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
index |
"The value of the index for the desired host type value. This value corresponds to the index attribute of the HostTypeValues model" |
integer (int32) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/host-type-values/0
Example HTTP response
Response 200
{
"waitForDownload" : true,
"notReadySenseForQuiescenceInProgress" : true,
"notReadySenseForQuiescenceInProgress2" : true,
"checkConditionForVendorUniqueUAConditions" : true,
"reportDeferredErrors" : true,
"ignoreForceUnitAccess" : true,
"ignoreWriteCacheDisable" : true,
"allowReservationOnUnownedLUNs" : true,
"worldWideNameInStandardInquiry" : true,
"propagateHostBusResets" : true,
"reportSCCDeviceEnable" : true,
"conditionalFCLogout" : true,
"forceSCSI2" : true,
"reportUnconfiguredLUNs" : true,
"ignoreSyncCache" : true,
"ignoreUTMLunOwnership" : true,
"reportLUNPreferredPathInStandardInquiry" : true,
"autoLUNTransfer" : true,
"inquiryUnconfiguredDeviceType" : "string",
"inquiryUnownedDeviceType" : "string",
"unownedBlock0Read" : "string",
"retainLogins" : true,
"hostPortType" : "string",
"maxRestrictedLUNs" : 0,
"reserved1" : "string",
"avtExclusionExtentsEnabled" : true,
"suppressVolOffPreferredPathAlert" : true,
"hostType" : "string",
"tpgsSupported" : true,
"volumeFormatOptions" : true,
"restrictedLun0" : true,
"usePage2CQuiescenceTimeout" : true,
"asymmetricLUAccess" : true,
"ignoreISCSISessionIDInITN" : true,
"enableLUCheckConditionParallelResponses" : true,
"disableExplicitTPGS" : true,
"unownedCheckConditionDuringFWActivation" : true,
"allowPreferredOwnerReportingSuppression" : true,
"enableTargetFailback" : true,
"enableAutoLoadBalance" : true,
"quiescenceInProgressSenseKey" : 0,
"quiescenceInProgressASC" : 0,
"quiescenceInProgressASCQ" : 0,
"persistentID" : 0,
"nvmeVUFailoverSupported" : true,
"nvmeStandardFailoverSupported" : true,
"index" : 0,
"default" : true
}
3.16.17. Get the list of unassociated HostPorts
GET /devmgr/v2/storage-systems/{system-id}/unassociated-host-ports
Description
Mode: Both Embedded and Proxy.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< UnassociatedHostPort > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/unassociated-host-ports
Example HTTP response
Response 200
{
"type" : "string",
"id" : "string",
"address" : "string",
"mediaTransportProtocolType" : "string"
} ]
3.17. Mirroring
3.17.1. Get a list of storage-systems that support Asynchronous Mirroring
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/arvm-arrays
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
compatibleOnly |
Only return storage-systems supporting async mirroring that compatible with the target storage-system. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< RemoteCandidate > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/arvm-arrays
Request query
{
"compatibleOnly" : true
}
Example HTTP response
Response 200
{
"wwn" : "string",
"id" : "string",
"name" : "string",
"type" : "string",
"fcMirroringState" : "string"
} ]
3.17.2. Retrieve sync progress of an Async Mirror Group
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirrorGroupId}/progress
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
mirrorGroupId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/progress
Example HTTP response
Response 200
{
"groupPercentComplete" : 0,
"groupTimeToCompletion" : 0,
"groupSyncBytes" : "string",
"groupRef" : "string",
"memberProgress" : [ {
"percentComplete" : 0,
"timeToCompletion" : 0,
"syncBytes" : "string",
"mirrorRef" : "string",
"trackingBytes" : "string"
} ],
"groupTrackingBytes" : "string"
}
3.17.3. Retrieve the sync progress of all Async Mirror Groups at once
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/progress
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AsyncMirrorGroupSyncProgress > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/progress
Example HTTP response
Response 200
{
"groupPercentComplete" : 0,
"groupTimeToCompletion" : 0,
"groupSyncBytes" : "string",
"groupRef" : "string",
"memberProgress" : [ {
"percentComplete" : 0,
"timeToCompletion" : 0,
"syncBytes" : "string",
"mirrorRef" : "string",
"trackingBytes" : "string"
} ],
"groupTrackingBytes" : "string"
} ]
3.17.4. Get an Async Mirror Group
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string
Example HTTP response
Response 200
{
"groupRef" : "string",
"worldWideName" : "string",
"label" : "string",
"groupState" : "string",
"localRole" : "string",
"remoteRole" : "string",
"roleChangeProgress" : "string",
"syncIntervalMinutes" : 0,
"syncCompletionTimeAlertThresholdMinutes" : 0,
"recoveryPointAgeAlertThresholdMinutes" : 0,
"repositoryUtilizationWarnThreshold" : 0,
"mirrorChannelRemoteTarget" : "string",
"syncActivity" : "string",
"orphanGroup" : true,
"connectionType" : "string",
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"remoteTarget" : {
"remoteRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"scsiinitiatorTargetBaseProperties" : {
"ioInterfaceType" : "string",
"iscsiinitiatorTargetBaseParameters" : {
"portals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
}
}
},
"id" : "string"
}
3.17.5. Update an Async Mirror Group
POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string
Request body
{
"name" : "string",
"syncIntervalMinutes" : 0,
"recoveryWarnThresholdMinutes" : 0,
"repoUtilizationWarnThreshold" : 0,
"syncWarnThresholdMinutes" : 0
}
Example HTTP response
Response 200
{
"groupRef" : "string",
"worldWideName" : "string",
"label" : "string",
"groupState" : "string",
"localRole" : "string",
"remoteRole" : "string",
"roleChangeProgress" : "string",
"syncIntervalMinutes" : 0,
"syncCompletionTimeAlertThresholdMinutes" : 0,
"recoveryPointAgeAlertThresholdMinutes" : 0,
"repositoryUtilizationWarnThreshold" : 0,
"mirrorChannelRemoteTarget" : "string",
"syncActivity" : "string",
"orphanGroup" : true,
"connectionType" : "string",
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"remoteTarget" : {
"remoteRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"scsiinitiatorTargetBaseProperties" : {
"ioInterfaceType" : "string",
"iscsiinitiatorTargetBaseParameters" : {
"portals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
}
}
},
"id" : "string"
}
3.17.6. Delete an Async Mirror Group
DELETE /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string
3.17.7. Get Async Mirror Groups
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Amg > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors
Example HTTP response
Response 200
{
"groupRef" : "string",
"worldWideName" : "string",
"label" : "string",
"groupState" : "string",
"localRole" : "string",
"remoteRole" : "string",
"roleChangeProgress" : "string",
"syncIntervalMinutes" : 0,
"syncCompletionTimeAlertThresholdMinutes" : 0,
"recoveryPointAgeAlertThresholdMinutes" : 0,
"repositoryUtilizationWarnThreshold" : 0,
"mirrorChannelRemoteTarget" : "string",
"syncActivity" : "string",
"orphanGroup" : true,
"connectionType" : "string",
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"remoteTarget" : {
"remoteRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"scsiinitiatorTargetBaseProperties" : {
"ioInterfaceType" : "string",
"iscsiinitiatorTargetBaseParameters" : {
"portals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
}
}
},
"id" : "string"
} ]
3.17.8. Create an Async Mirror Group
POST /devmgr/v2/storage-systems/{system-id}/async-mirrors
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Created AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors
Request body
{
"name" : "string",
"secondaryArrayId" : "string",
"syncIntervalMinutes" : 0,
"manualSync" : true,
"recoveryWarnThresholdMinutes" : 0,
"repoUtilizationWarnThreshold" : 0,
"interfaceType" : "string",
"syncWarnThresholdMinutes" : 0
}
Example HTTP response
Response 200
{
"groupRef" : "string",
"worldWideName" : "string",
"label" : "string",
"groupState" : "string",
"localRole" : "string",
"remoteRole" : "string",
"roleChangeProgress" : "string",
"syncIntervalMinutes" : 0,
"syncCompletionTimeAlertThresholdMinutes" : 0,
"recoveryPointAgeAlertThresholdMinutes" : 0,
"repositoryUtilizationWarnThreshold" : 0,
"mirrorChannelRemoteTarget" : "string",
"syncActivity" : "string",
"orphanGroup" : true,
"connectionType" : "string",
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"remoteTarget" : {
"remoteRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"scsiinitiatorTargetBaseProperties" : {
"ioInterfaceType" : "string",
"iscsiinitiatorTargetBaseParameters" : {
"portals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
}
}
},
"id" : "string"
}
3.17.9. Retrieve the repository usage statistics for all AmgMembers.
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/pairs/repository-utilization
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AsyncMirrorRepositoryUtilization > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/pairs/repository-utilization
Example HTTP response
Response 200
{
"pitDataBytes" : "string",
"deltaLogBytes" : "string",
"bytesAvailable" : "string",
"mirrorRef" : "string",
"id" : "string"
} ]
3.17.10. Retrieve the repository usage statistics for a single AmgMember.
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/pairs/{id}/repository-utilization
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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/async-mirrors/pairs/string/repository-utilization
Example HTTP response
Response 200
{
"pitDataBytes" : "string",
"deltaLogBytes" : "string",
"bytesAvailable" : "string",
"mirrorRef" : "string",
"id" : "string"
}
3.17.11. Update the mirror role of an Async Mirror Group.
POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/role
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
StorageDevice role for AMG updated. |
|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/role
Request body
{
"role" : "string",
"noSync" : true,
"force" : true
}
3.17.12. Get all Async Mirror Group Members
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/pairs
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AmgMember > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/pairs
Example HTTP response
Response 200
{
"memberRef" : "string",
"mirrorGroup" : "string",
"localVolume" : "string",
"remoteVolume" : "string",
"memberState" : "string",
"lastRecoveryPointTime" : "string",
"overUtilizationWarnThreshold" : true,
"mirroredLocalCapacity" : "string",
"repositoryVolume" : "string",
"worldWideName" : "string",
"volumeHandle" : 0,
"repositoryFull" : true,
"localVolumeName" : "string",
"remoteVolumeName" : "string",
"remoteVolumeInfo" : {
"worldWideName" : "string",
"remoteVolRef" : "string",
"manager" : "string",
"remoteArrayId" : {
"worldWideName" : "string"
},
"remoteNodeWWN" : "string",
"remoteVolWWN" : "string",
"remoteVolUserLabel" : "string",
"remoteVolState" : "string",
"remoteVolCapacity" : "string",
"volumeHandle" : 0,
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"reserved1" : "string",
"reserved2" : "string",
"remoteNodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"remoteVolSecurityType" : "string"
},
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"totalSizeInBytes" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"id" : "string"
} ]
3.17.13. Get a specific Async Mirror Group Member
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/pairs/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
AMG member was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/pairs/string
Example HTTP response
Response 200
{
"memberRef" : "string",
"mirrorGroup" : "string",
"localVolume" : "string",
"remoteVolume" : "string",
"memberState" : "string",
"lastRecoveryPointTime" : "string",
"overUtilizationWarnThreshold" : true,
"mirroredLocalCapacity" : "string",
"repositoryVolume" : "string",
"worldWideName" : "string",
"volumeHandle" : 0,
"repositoryFull" : true,
"localVolumeName" : "string",
"remoteVolumeName" : "string",
"remoteVolumeInfo" : {
"worldWideName" : "string",
"remoteVolRef" : "string",
"manager" : "string",
"remoteArrayId" : {
"worldWideName" : "string"
},
"remoteNodeWWN" : "string",
"remoteVolWWN" : "string",
"remoteVolUserLabel" : "string",
"remoteVolState" : "string",
"remoteVolCapacity" : "string",
"volumeHandle" : 0,
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"reserved1" : "string",
"reserved2" : "string",
"remoteNodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"remoteVolSecurityType" : "string"
},
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"totalSizeInBytes" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"id" : "string"
}
3.17.14. Retrieve the current remote StorageDevice mirroring connections
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/connections
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AsyncMirrorConnectionsResponse > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/connections
Example HTTP response
Response 200
{
"amgRef" : "string",
"connections" : [ {
"localPortName" : "string",
"remotePortName" : "string",
"remotePortId" : "string",
"localPortId" : "string",
"localPortNumber" : 0,
"remotePortNumber" : 0,
"controller" : "string",
"ioInterfaceType" : "string",
"fibreConnectionDetail" : {
"remoteNodeWWN" : "string",
"associatedSwitchPorts" : [ "string" ],
"connectedRemoteTargetPorts" : [ {
"switchPortId" : "string",
"targetPortName" : "string"
} ]
},
"remoteTargetConnections" : {
"ioInterfaceType" : "string",
"iscsiConnectionDetail" : {
"connectedRemoteTargetPortals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
},
"fibreConnectionDetail" : {
"remoteNodeWWN" : "string",
"associatedSwitchPorts" : [ "string" ],
"connectedRemoteTargetPorts" : [ {
"switchPortId" : "string",
"targetPortName" : "string"
} ]
}
},
"localPortRef" : "string",
"iscsiConnectionDetail" : {
"connectedRemoteTargetPortals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
}
} ]
} ]
3.17.15. Retrieve the current remote StorageDevice mirroring connections for an Amg
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirrorGroupId}/connections
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
mirrorGroupId |
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/async-mirrors/string/connections
Example HTTP response
Response 200
{
"amgRef" : "string",
"connections" : [ {
"localPortName" : "string",
"remotePortName" : "string",
"remotePortId" : "string",
"localPortId" : "string",
"localPortNumber" : 0,
"remotePortNumber" : 0,
"controller" : "string",
"ioInterfaceType" : "string",
"fibreConnectionDetail" : {
"remoteNodeWWN" : "string",
"associatedSwitchPorts" : [ "string" ],
"connectedRemoteTargetPorts" : [ {
"switchPortId" : "string",
"targetPortName" : "string"
} ]
},
"remoteTargetConnections" : {
"ioInterfaceType" : "string",
"iscsiConnectionDetail" : {
"connectedRemoteTargetPortals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
},
"fibreConnectionDetail" : {
"remoteNodeWWN" : "string",
"associatedSwitchPorts" : [ "string" ],
"connectedRemoteTargetPorts" : [ {
"switchPortId" : "string",
"targetPortName" : "string"
} ]
}
},
"localPortRef" : "string",
"iscsiConnectionDetail" : {
"connectedRemoteTargetPortals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
}
} ]
}
3.17.16. Resume synchronization of an Async Mirror Group
POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/resume
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
id |
string |
||
Query |
deleteRecoveryPointIfNecessary |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
AMG synchronization resumed. |
|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/resume
Request query
{
"deleteRecoveryPointIfNecessary" : true
}
3.17.17. Suspend synchronization of an Async Mirror Group
POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/suspend
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
AMG synchronization suspended. |
|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/suspend
3.17.18. Test connectivity of an Async Mirror Group
POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/test
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AsyncCommunicationData > array |
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/test
Request body
{
"requestedTestType" : "string",
"testIterations" : 0,
"timeout" : 0
}
Example HTTP response
Response 200
{
"timeout" : 0,
"returnStatus" : "string",
"successful" : true,
"controllerRef" : "string",
"amgRef" : "string",
"testType" : "string",
"bwTestResult" : {
"latencyMeasures" : {
"minLatencyInMicroseconds" : 0,
"maxLatencyInMicroseconds" : 0,
"avgLatencyInMicroseconds" : 0
},
"minBandwidthBitsPerSecond" : "string",
"maxBandwidthBitsPerSecond" : "string",
"avgBandwidthBitsPerSecond" : "string",
"negotiatedLinkSpeedBitsPerSecond" : "string"
},
"latTestResult" : {
"minLatencyInMicroseconds" : 0,
"maxLatencyInMicroseconds" : 0,
"avgLatencyInMicroseconds" : 0
}
} ]
3.17.19. Begin synchronization of an Async Mirror Group
POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{id}/sync
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
AMG synchronization started. |
|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/sync
Request body
{
"deleteRecoveryPointIfNecessary" : true
}
3.17.20. Complete an incomplete Async Mirror relationship
POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/incomplete-pairs/{incompleteMirrorId}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
incompleteMirrorId |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Created AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/incomplete-pairs/string
Request body
{
"secondaryPoolId" : "string",
"secondaryVolumeRef" : "string",
"scanMedia" : true,
"validateRepositoryParity" : true,
"secondaryPercentCapacity" : 0.0,
"secondaryRepositoryCandidate" : {
"candType" : "string",
"newVolCandidate" : {
"memberVolumeLabel" : "string",
"memberVolumeGroupLabel" : "string",
"memberCandidate" : {
"raidLevel" : "string",
"trayLossProtection" : true,
"rawSize" : "string",
"usableSize" : "string",
"driveCount" : 0,
"freeExtentRef" : "string",
"driveRefList" : {
"driveRef" : [ "string" ]
},
"candidateSelectionType" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"phyDriveType" : "string",
"dssPreallocEnabled" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"driveMediaType" : "string",
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeCandidateData" : {
"type" : "string",
"diskPoolVolumeCandidateData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"unusableCapacity" : "string"
}
},
"driveBlockFormat" : "string",
"allocateReservedSpace" : true,
"securityLevel" : "string"
},
"memberCapacity" : "string"
},
"existVolCandidate" : {
"refType" : "string",
"memberVolumeRef" : [ "string" ],
"memberLabel" : [ "string" ]
},
"expansionDescriptor" : {
"additionalCapacity" : "string"
}
}
}
Example HTTP response
Response 200
{
"memberRef" : "string",
"mirrorGroup" : "string",
"localVolume" : "string",
"remoteVolume" : "string",
"memberState" : "string",
"lastRecoveryPointTime" : "string",
"overUtilizationWarnThreshold" : true,
"mirroredLocalCapacity" : "string",
"repositoryVolume" : "string",
"worldWideName" : "string",
"volumeHandle" : 0,
"repositoryFull" : true,
"localVolumeName" : "string",
"remoteVolumeName" : "string",
"remoteVolumeInfo" : {
"worldWideName" : "string",
"remoteVolRef" : "string",
"manager" : "string",
"remoteArrayId" : {
"worldWideName" : "string"
},
"remoteNodeWWN" : "string",
"remoteVolWWN" : "string",
"remoteVolUserLabel" : "string",
"remoteVolState" : "string",
"remoteVolCapacity" : "string",
"volumeHandle" : 0,
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"reserved1" : "string",
"reserved2" : "string",
"remoteNodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"remoteVolSecurityType" : "string"
},
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"totalSizeInBytes" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"id" : "string"
}
3.17.21. Remove an Async Mirror relationship that has not been completed
DELETE /devmgr/v2/storage-systems/{system-id}/async-mirrors/incomplete-pairs/{incompleteMirrorId}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
incompleteMirrorId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/incomplete-pairs/string
3.17.22. Get Async Mirror Group relationships that have not yet been completed
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/incomplete-pairs/{mirror-id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
mirrorId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AmgIncompleteMember > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/incomplete-pairs/{mirror-id}
Example HTTP response
Response 200
{
"memberRef" : "string",
"groupRef" : "string",
"primaryVolWWN" : "string",
"primaryVolCapacity" : "string",
"primaryVolRAIDLevel" : "string",
"primaryVolProtectionType" : "string",
"primaryVolSecurityType" : "string",
"primaryVolUserLabel" : "string",
"orphanIncompleteMember" : true,
"primaryVolumeParameters" : {
"volumeType" : "string",
"capacityProvisioningDetails" : {
"capacityQuota" : "string",
"growthAlertThreshold" : 0,
"repositoryExpansionPolicy" : "string"
}
},
"primaryVolSecurityLevel" : "string",
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"id" : "string"
} ]
3.17.23. Get Async Mirror Group relationships that have not yet been completed
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/incomplete-pairs
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AmgIncompleteMember > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/incomplete-pairs
Example HTTP response
Response 200
{
"memberRef" : "string",
"groupRef" : "string",
"primaryVolWWN" : "string",
"primaryVolCapacity" : "string",
"primaryVolRAIDLevel" : "string",
"primaryVolProtectionType" : "string",
"primaryVolSecurityType" : "string",
"primaryVolUserLabel" : "string",
"orphanIncompleteMember" : true,
"primaryVolumeParameters" : {
"volumeType" : "string",
"capacityProvisioningDetails" : {
"capacityQuota" : "string",
"growthAlertThreshold" : 0,
"repositoryExpansionPolicy" : "string"
}
},
"primaryVolSecurityLevel" : "string",
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"id" : "string"
} ]
3.17.24. Retrieve a member volume associated with an AMG
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirror-id}/pairs/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
mirror-id |
string |
|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/pairs/string
Example HTTP response
Response 200
{
"memberRef" : "string",
"mirrorGroup" : "string",
"localVolume" : "string",
"remoteVolume" : "string",
"memberState" : "string",
"lastRecoveryPointTime" : "string",
"overUtilizationWarnThreshold" : true,
"mirroredLocalCapacity" : "string",
"repositoryVolume" : "string",
"worldWideName" : "string",
"volumeHandle" : 0,
"repositoryFull" : true,
"localVolumeName" : "string",
"remoteVolumeName" : "string",
"remoteVolumeInfo" : {
"worldWideName" : "string",
"remoteVolRef" : "string",
"manager" : "string",
"remoteArrayId" : {
"worldWideName" : "string"
},
"remoteNodeWWN" : "string",
"remoteVolWWN" : "string",
"remoteVolUserLabel" : "string",
"remoteVolState" : "string",
"remoteVolCapacity" : "string",
"volumeHandle" : 0,
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"reserved1" : "string",
"reserved2" : "string",
"remoteNodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"remoteVolSecurityType" : "string"
},
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"totalSizeInBytes" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"id" : "string"
}
3.17.25. Remove a member from an Async Mirror Group
DELETE /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirror-id}/pairs/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
mirror-id |
string |
|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/pairs/string
3.17.26. Retrieve the member volumes associated with an AMG
GET /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirror-id}/pairs
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
mirror-id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AmgMember > array |
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/pairs
Example HTTP response
Response 200
{
"memberRef" : "string",
"mirrorGroup" : "string",
"localVolume" : "string",
"remoteVolume" : "string",
"memberState" : "string",
"lastRecoveryPointTime" : "string",
"overUtilizationWarnThreshold" : true,
"mirroredLocalCapacity" : "string",
"repositoryVolume" : "string",
"worldWideName" : "string",
"volumeHandle" : 0,
"repositoryFull" : true,
"localVolumeName" : "string",
"remoteVolumeName" : "string",
"remoteVolumeInfo" : {
"worldWideName" : "string",
"remoteVolRef" : "string",
"manager" : "string",
"remoteArrayId" : {
"worldWideName" : "string"
},
"remoteNodeWWN" : "string",
"remoteVolWWN" : "string",
"remoteVolUserLabel" : "string",
"remoteVolState" : "string",
"remoteVolCapacity" : "string",
"volumeHandle" : 0,
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"reserved1" : "string",
"reserved2" : "string",
"remoteNodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"remoteVolSecurityType" : "string"
},
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"totalSizeInBytes" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"id" : "string"
} ]
3.17.27. Add a new member to an Async Mirror Group
POST /devmgr/v2/storage-systems/{system-id}/async-mirrors/{mirror-id}/pairs
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
mirror-id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
AMG was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/async-mirrors/string/pairs
Request body
{
"primaryPoolId" : "string",
"secondaryPoolId" : "string",
"primaryVolumeRef" : "string",
"secondaryVolumeRef" : "string",
"primaryRepositoryCandidate" : {
"candType" : "string",
"newVolCandidate" : {
"memberVolumeLabel" : "string",
"memberVolumeGroupLabel" : "string",
"memberCandidate" : {
"raidLevel" : "string",
"trayLossProtection" : true,
"rawSize" : "string",
"usableSize" : "string",
"driveCount" : 0,
"freeExtentRef" : "string",
"driveRefList" : {
"driveRef" : [ "string" ]
},
"candidateSelectionType" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"phyDriveType" : "string",
"dssPreallocEnabled" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"driveMediaType" : "string",
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeCandidateData" : {
"type" : "string",
"diskPoolVolumeCandidateData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"unusableCapacity" : "string"
}
},
"driveBlockFormat" : "string",
"allocateReservedSpace" : true,
"securityLevel" : "string"
},
"memberCapacity" : "string"
},
"existVolCandidate" : {
"refType" : "string",
"memberVolumeRef" : [ "string" ],
"memberLabel" : [ "string" ]
},
"expansionDescriptor" : {
"additionalCapacity" : "string"
}
},
"secondaryRepositoryCandidate" : {
"candType" : "string",
"newVolCandidate" : {
"memberVolumeLabel" : "string",
"memberVolumeGroupLabel" : "string",
"memberCandidate" : {
"raidLevel" : "string",
"trayLossProtection" : true,
"rawSize" : "string",
"usableSize" : "string",
"driveCount" : 0,
"freeExtentRef" : "string",
"driveRefList" : {
"driveRef" : [ "string" ]
},
"candidateSelectionType" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"phyDriveType" : "string",
"dssPreallocEnabled" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"driveMediaType" : "string",
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeCandidateData" : {
"type" : "string",
"diskPoolVolumeCandidateData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"unusableCapacity" : "string"
}
},
"driveBlockFormat" : "string",
"allocateReservedSpace" : true,
"securityLevel" : "string"
},
"memberCapacity" : "string"
},
"existVolCandidate" : {
"refType" : "string",
"memberVolumeRef" : [ "string" ],
"memberLabel" : [ "string" ]
},
"expansionDescriptor" : {
"additionalCapacity" : "string"
}
},
"scanMedia" : true,
"validateRepositoryParity" : true,
"percentCapacity" : 0.0,
"secondaryPercentCapacity" : 0.0
}
Example HTTP response
Response 200
{
"memberRef" : "string",
"mirrorGroup" : "string",
"localVolume" : "string",
"remoteVolume" : "string",
"memberState" : "string",
"lastRecoveryPointTime" : "string",
"overUtilizationWarnThreshold" : true,
"mirroredLocalCapacity" : "string",
"repositoryVolume" : "string",
"worldWideName" : "string",
"volumeHandle" : 0,
"repositoryFull" : true,
"localVolumeName" : "string",
"remoteVolumeName" : "string",
"remoteVolumeInfo" : {
"worldWideName" : "string",
"remoteVolRef" : "string",
"manager" : "string",
"remoteArrayId" : {
"worldWideName" : "string"
},
"remoteNodeWWN" : "string",
"remoteVolWWN" : "string",
"remoteVolUserLabel" : "string",
"remoteVolState" : "string",
"remoteVolCapacity" : "string",
"volumeHandle" : 0,
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"reserved1" : "string",
"reserved2" : "string",
"remoteNodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"remoteVolSecurityType" : "string"
},
"remoteTargetWwn" : "string",
"remoteTargetName" : "string",
"remoteTargetId" : "string",
"totalSizeInBytes" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"id" : "string"
}
3.17.28. Get Remote Volume Mirrors
GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< RemoteMirrorPair > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs
Example HTTP response
Response 200
{
"base" : {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
},
"target" : {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
},
"baseArray" : "string",
"targetArray" : "string",
"id" : "string",
"lastStartTime" : "string",
"lastCompleteTime" : "string",
"state" : 0,
"priority" : 0,
"writeMode" : 0,
"autoResync" : true,
"featureActive" : true,
"status" : "string",
"baseStatus" : "string",
"targetStatus" : "string"
} ]
3.17.29. Create Remote Volume Mirror
POST /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/remote-mirror-pairs
Request body
{
"srcVolID" : "string",
"tgtVolWWN" : "string",
"remoteArrayId" : "string",
"copyType" : 0,
"priority" : 0,
"autoResync" : true
}
Example HTTP response
Response 200
{
"base" : {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
},
"target" : {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
},
"baseArray" : "string",
"targetArray" : "string",
"id" : "string",
"lastStartTime" : "string",
"lastCompleteTime" : "string",
"state" : 0,
"priority" : 0,
"writeMode" : 0,
"autoResync" : true,
"featureActive" : true,
"status" : "string",
"baseStatus" : "string",
"targetStatus" : "string"
}
3.17.30. Get Remote Volume Mirror
GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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/remote-mirror-pairs/string
Example HTTP response
Response 200
{
"base" : {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
},
"target" : {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
},
"baseArray" : "string",
"targetArray" : "string",
"id" : "string",
"lastStartTime" : "string",
"lastCompleteTime" : "string",
"state" : 0,
"priority" : 0,
"writeMode" : 0,
"autoResync" : true,
"featureActive" : true,
"status" : "string",
"baseStatus" : "string",
"targetStatus" : "string"
}
3.17.31. Update a Remote Volume Mirror
POST /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
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/remote-mirror-pairs/string
Request body
{
"baseVolumeId" : "string",
"remoteVolumeId" : "string",
"role" : 0,
"updateType" : "string",
"priority" : 0,
"writeMode" : 0,
"autoResync" : true
}
Example HTTP response
Response 200
{
"base" : {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
},
"target" : {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
},
"baseArray" : "string",
"targetArray" : "string",
"id" : "string",
"lastStartTime" : "string",
"lastCompleteTime" : "string",
"state" : 0,
"priority" : 0,
"writeMode" : 0,
"autoResync" : true,
"featureActive" : true,
"status" : "string",
"baseStatus" : "string",
"targetStatus" : "string"
}
3.17.32. Remove a Remote Volume Mirror
DELETE /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Removal was successful |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/string
3.17.33. Test Remote Mirror Communication
GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/test-remote-mirror-communication/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Remote mirror not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/test-remote-mirror-communication/string
Example HTTP response
Response 200
{
"samples" : [ 0 ],
"timeout" : 0
}
3.17.34. Get Remote Mirror synchronization status
GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/mirror-sync-progress/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Remote mirror not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/mirror-sync-progress/string
Example HTTP response
Response 200
{
"objectId" : "string",
"percentComplete" : 0
}
3.17.35. Retrieve potential mirror candidates for a volume
GET /devmgr/v2/storage-systems/{system-id}/remote-mirror-pairs/remote-mirror-target-candidates/{volumeId}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
volumeId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< RemoteMirrorCandidate > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/remote-mirror-pairs/remote-mirror-target-candidates/string
Example HTTP response
Response 200
{
"sourceVolume" : {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
},
"targetVolumes" : [ {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
} ],
"targetArrayName" : "string",
"targetArrayId" : "string"
} ]
3.18. Monitoring
3.18.1. Get the current audit log configuration.
GET /devmgr/v2/storage-systems/{system-id}/audit-log/config
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/audit-log/config
Example HTTP response
Response 200
{
"auditLogMaxRecords" : 50000,
"auditLogLevel" : "writeOnly",
"auditLogFullPolicy" : "overWrite",
"auditLogWarningThresholdPct" : 80
}
3.18.2. Updates the audit log configuration.
POST /devmgr/v2/storage-systems/{system-id}/audit-log/config
Description
The audit log can be used to see information regarding the endpoints that have been executed on the storage system
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/audit-log/config
Request body
{
"auditLogMaxRecords" : 50000,
"auditLogLevel" : "writeOnly",
"auditLogFullPolicy" : "overWrite",
"auditLogWarningThresholdPct" : 80
}
Example HTTP response
Response 200
{
"auditLogMaxRecords" : 50000,
"auditLogLevel" : "writeOnly",
"auditLogFullPolicy" : "overWrite",
"auditLogWarningThresholdPct" : 80
}
3.18.3. Get audit log metadata.
GET /devmgr/v2/storage-systems/{system-id}/audit-log/info
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/audit-log/info
Example HTTP response
Response 200
{
"totalLogRecords" : 0,
"firstRecordTimestamp" : "string",
"firstRecordDate" : "string",
"lastRecordTimestamp" : "string",
"lastRecordDate" : "string"
}
3.18.4. Get a list of audit log messages.
GET /devmgr/v2/storage-systems/{system-id}/audit-log
Caution
|
operation.deprecated |
Description
This endpoint has been deprecated. Refer to GET:/storage-systems/{system-id}/audit-log/messages and POST:/storage-systems/{system-id}/audit-log/messages for all future use. The audit log uses zero-based indexing.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
startRecordOrdinal |
Starting record ordinal inclusive. |
integer (int32) |
|
Query |
endingRecordOrdinal |
Ending record ordinal inclusive. |
integer (int32) |
|
Query |
beginDate |
Beginning date |
integer (int64) |
|
Query |
endDate |
Ending date |
integer (int64) |
|
Query |
file |
Return CSV file |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Invalid Parameter |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/octet-stream
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/audit-log
Request query
{
"startRecordOrdinal" : 0,
"endingRecordOrdinal" : 0,
"beginDate" : 0,
"endDate" : 0,
"file" : true
}
Example HTTP response
Response 200
{
"totalLogRecords" : 0,
"logRecords" : [ {
"method" : "string",
"accessedUrl" : "string",
"clientIp" : "string",
"userId" : "string",
"httpStatus" : 0,
"httpReasonPhrase" : "string",
"isFederated" : true,
"loggingAgent" : "string",
"cliCommandExecuted" : "string",
"cliReturnStatus" : "string",
"symbolProcedure" : "string",
"sshEventType" : "string",
"sshSessionPid" : 0,
"sshSessionDuration" : 0,
"timestamp" : "string",
"dateTime" : "string",
"recordOrdinal" : 0,
"optionalText" : "string"
} ],
"firstRecordOrdinal" : 0,
"lastRecordOrdinal" : 0
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.18.5. Delete specified subset or all embedded audit log messages.
DELETE /devmgr/v2/storage-systems/{system-id}/audit-log
Description
One of The following values must be selected and are mutually exclusive: retentionCount, endDate, or clearAll
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
retentionCount |
Number of records to preserve within the log after deleting the audit logs from oldest to newest. |
integer (int32) |
Query |
endDate |
Delete all audit log records older than the specified time as a Unix timestamp in milliseconds. |
integer (int64) |
Query |
clearAll |
Clear all records |
boolean |
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/audit-log
Request query
{
"retentionCount" : 0,
"endDate" : 0,
"clearAll" : true
}
Example HTTP response
Response 200
{
"totalDeletedRecords" : 0
}
3.18.6. Get a list of audit log messages.
GET /devmgr/v2/storage-systems/{system-id}/audit-log/messages
Description
The audit log uses zero-based indexing.
beginTime and endTime can be the following formats(UTC):
'yyyy-mm-ddThh:mm:ssZ',
'yyyy-mm-ddThh:mm:ss.sssZ',
'yyyy-mm-ddThh:mm:ss+|-hh:mm
EXAMPLES:
'2018-01-15T05:06:08Z',
'2018-07-12T17:57:14.922Z',
'2018-07-13T14:59:52+00:00'
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
startRecordOrdinal |
Starting record ordinal inclusive. |
integer (int32) |
Query |
endingRecordOrdinal |
Ending record ordinal inclusive. |
integer (int32) |
Query |
beginTime |
Beginning time in the form of 'yyyy-mm-ddThh:mm:ssZ' |
string |
Query |
endTime |
Ending time in the form of 'yyyy-mm-ddThh:mm:ssZ' |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
An error occurred when attempting to retrieve audit log messages |
|
422 |
Invalid Parameter |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/audit-log/messages
Request query
{
"startRecordOrdinal" : 0,
"endingRecordOrdinal" : 0,
"beginTime" : "string",
"endTime" : "string"
}
Example HTTP response
Response 200
{
"totalLogRecords" : 0,
"logRecords" : [ {
"method" : "string",
"accessedUrl" : "string",
"clientIp" : "string",
"userId" : "string",
"httpStatus" : 0,
"httpReasonPhrase" : "string",
"isFederated" : true,
"loggingAgent" : "string",
"cliCommandExecuted" : "string",
"cliReturnStatus" : "string",
"symbolProcedure" : "string",
"sshEventType" : "string",
"sshSessionPid" : 0,
"sshSessionDuration" : 0,
"timestamp" : "string",
"dateTime" : "string",
"recordOrdinal" : 0,
"optionalText" : "string"
} ],
"firstRecordOrdinal" : 0,
"lastRecordOrdinal" : 0
}
3.18.7. Retrieves the requested list of audit log messages as a private file.
POST /devmgr/v2/storage-systems/{system-id}/audit-log/messages
Description
This API will return a URL path to the file to be retrieved in the response. This API will also returna fileID to be used with URI files/private/{id}. The audit log uses zero-based indexing.
beginTime and endTime can be the following formats(UTC):
'yyyy-mm-ddThh:mm:ssZ',
'yyyy-mm-ddThh:mm:ss.sssZ',
'yyyy-mm-ddThh:mm:ss+|-hhmm
EXAMPLES:
'2018-01-15T05:06:08Z',
'2018-07-12T17:57:14.922Z',
'2018-07-13T14:59:52+00:00'
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
An error occurred when attempting to retrieve audit log messages |
|
422 |
Invalid Parameter |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/audit-log/messages
Request body
{
"startRecordOrdinal" : 0,
"endingRecordOrdinal" : 0,
"beginTime" : "string",
"endTime" : "string"
}
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileID" : "string",
"fileURL" : "string"
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.18.8. Get the list of status Events for the StorageDevice
GET /devmgr/v2/storage-systems/{system-id}/events
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
lastKnown |
integer (int64) |
|
|
Query |
wait |
Amount of time to wait for a new event |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Event > array |
404 |
StorageDevice not found |
|
503 |
StorageDevice is in lockdown |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/events
Request query
{
"lastKnown" : 0,
"wait" : 0
}
Example HTTP response
Response 200
{
"timestamp" : "string",
"eventNumber" : "string",
"eventType" : "string"
} ]
3.18.9. Get all global status events
GET /devmgr/v2/events
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
lastKnown |
The sequence number of the last event you have received |
integer (int64) |
|
Query |
wait |
seconds to wait for a new event |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Event > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/events
Request query
{
"lastKnown" : 0,
"wait" : 0
}
Example HTTP response
Response 200
{
"timestamp" : "string",
"eventNumber" : "string",
"eventType" : "string"
} ]
3.18.10. Get a list of log messages for a component.
GET /devmgr/v2/storage-systems/{system-id}/service-logs
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
loggerType |
LoggerType to retrieve records for |
enum (cfwUpgradeLogger, driveUpgradeLogger, iomServiceLogger, nvsramUpgradeLogger, cfwUpgradeTimestamp, driveUpgradeTimestamp, iomServiceTimestamp, nvsramUpgradeTimestamp) |
|
Query |
startRecord |
Starting record number |
integer (int32) |
|
Query |
endingRecord |
Ending record number |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/service-logs
Request query
{
"loggerType" : "string",
"startRecord" : 0,
"endingRecord" : 0
}
Example HTTP response
Response 200
{
"recordType" : "string",
"logRecords" : [ {
"loggerType" : "string",
"timestamp" : "string",
"messageText" : "string",
"context" : "string",
"recordId" : "string"
} ],
"timeStamps" : {
"string" : "string"
}
}
3.18.11. Retrieve MelEvents
GET /devmgr/v2/storage-systems/{system-id}/mel-events
Description
This operation may take a substantial amount of time to return large numbers of events. In this case, the client may timeout. To avoid this, either the number of events to be retrieved should be reduced and multiple requests made, or the client-side timeout should be increased.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
startSequenceNumber |
The starting sequence number for the MEL events to be retrieved. If this value is set to a negative value then the events will be retrieved starting with the most recent event that was logged and then working backwards based on what the count value is set to. |
integer (int32) |
|
Query |
count |
Maximum number of events to retrieve |
integer (int32) |
|
Query |
critical |
Only retrieve events classified as critical |
boolean |
|
Query |
includeDebug |
Whether or not to retrieve debug entries |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< MelEntryEx > array |
404 |
StorageDevice not found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mel-events
Request query
{
"startSequenceNumber" : 0,
"count" : 0,
"critical" : true,
"includeDebug" : true
}
Example HTTP response
Response 200
{
"sequenceNumber" : "string",
"eventType" : 0,
"timeStamp" : "string",
"category" : "string",
"componentType" : "string",
"componentLocation" : {
"eventComponentType" : "string",
"alarmLocation" : {
"tray" : 0,
"slot" : 0
},
"batteryTray" : 0,
"cacheBackupDeviceLocation" : {
"controllerTray" : 0,
"controllerSlot" : 0,
"cacheBackupDeviceSlot" : 0
},
"cacheMemoryDimmLocation" : {
"controllerTray" : 0,
"controllerSlot" : 0,
"cacheMemoryDimmControllerSlot" : 0
},
"channelLoc" : {
"channelType" : "string",
"index" : 0,
"controllerSlot" : 0
},
"channelPort" : 0,
"chipLoc" : {
"tray" : 0,
"slot" : 0
},
"controllerLoc" : {
"tray" : 0,
"slot" : 0
},
"ctlrSfpLocation" : {
"channelType" : "string",
"channel" : 0,
"sfpPort" : 0,
"controllerSlot" : 0
},
"socLocation" : {
"channelType" : "string",
"channel" : 0,
"soc" : 0,
"port" : 0,
"controllerSlot" : 0
},
"driveLoc" : {
"tray" : 0,
"slot" : 0
},
"enclosureTray" : 0,
"esmTray" : 0,
"fanTray" : 0,
"hostIoCardLocation" : {
"controllerTray" : 0,
"controllerSlot" : 0,
"hostIoCardControllerSlot" : 0
},
"initiatorLocation" : {
"initiatorName" : "string"
},
"interconnectCruLocation" : {
"tray" : 0,
"slot" : 0
},
"isnsServerLocation" : {
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
},
"minihubLoc" : {
"minihubType" : "string",
"channel" : 0,
"controllerSlot" : 0,
"tray" : 0
},
"portCruTray" : 0,
"powerSupplyTray" : 0,
"sfpLocation" : {
"tray" : 0,
"slot" : 0
},
"supportCruLocation" : {
"tray" : 0,
"slot" : 0
},
"targetLocation" : {
"targetName" : "string"
},
"tempSensorTray" : 0,
"label" : "string",
"groupNumber" : 0,
"hostLocation" : "string",
"hostPortLocation" : {
"ioInterfaceType" : "string",
"fcPortName" : "string",
"ibPortName" : "string",
"sasPortName" : "string"
},
"drawerLocation" : {
"tray" : 0,
"slot" : 0
},
"componentRelativeLocation" : {
"componentType" : "string",
"trayId" : 0,
"relativePosition" : 0,
"parentSize" : 0,
"parent" : [ {
"componentType" : "string",
"relativePosition" : 0
} ],
"componentLabel" : "string"
},
"schedule" : "string",
"diskPool" : 0,
"asyncMirrorGroup" : "string",
"pitLabel" : "string",
"cgLabel" : "string",
"cgPitLabel" : "string",
"cgViewLabel" : "string",
"flashCacheLabel" : "string",
"communityNameString" : "string",
"destinationIpAddress" : "string",
"fcTargetLocation" : {
"targetName" : "string"
},
"fanCruLocation" : {
"tray" : 0,
"slot" : 0
},
"powerSupplyCruLocation" : {
"tray" : 0,
"slot" : 0
},
"nvmeInitiatorLocation" : {
"initiatorName" : "string"
}
},
"locationValid" : true,
"priority" : "string",
"eventSourceController" : 0,
"senseKey" : 0,
"rawData" : "string",
"extComponentLocation" : {
"extLocType" : "string",
"compChannelLoc" : {
"channelType" : "string",
"index" : 0,
"controllerSlot" : 0
},
"compMinihubLoc" : {
"minihubType" : "string",
"channel" : 0,
"controllerSlot" : 0,
"tray" : 0
},
"compTray" : 0,
"compTraySlot" : {
"tray" : 0,
"slot" : 0
},
"compLabel" : "string",
"pitSequence" : "string",
"compReference" : "string",
"controllerReference" : "string",
"locationLabel" : "string",
"volumeGroupLabel" : "string",
"diskPoolLabel" : "string"
},
"controlParams" : {
"oemPriority" : "string",
"defaultNeedsAttention" : true,
"defaultSendAlert" : true,
"defaultVisibility" : true,
"oemNeedsAttention" : "string",
"oemSendAlert" : "string",
"oemVisibility" : "string",
"collectSupportBundle" : true,
"priorityCaseCreationTrigger" : true
},
"description" : "string",
"location" : "string",
"critical" : true,
"id" : "string",
"asc" : 0,
"ascq" : 0
} ]
3.18.12. Clear all MEL events
DELETE /devmgr/v2/storage-systems/{system-id}/mel-events
Description
Gives the user the ability to clear the event cache and the event log directly on the StorageDevice.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
clearCache |
boolean |
|
|
Query |
resetMel |
Reset the EventLog on the StorageDevice |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Successfully cleared |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mel-events
Request query
{
"clearCache" : true,
"resetMel" : true
}
3.18.13. Check the oldest and newest available events
GET /devmgr/v2/storage-systems/{system-id}/mel-events/available
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
cacheOnly |
Only retrieve events currently in the cache |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mel-events/available
Request query
{
"cacheOnly" : true
}
Example HTTP response
Response 200
{
"startingSeqNum" : "string",
"endingSeqNum" : "string"
}
3.18.14. Get a list of audit log messages.
GET /devmgr/v2/audit-log/messages
Description
The audit log uses zero-based indexing.
beginTime and endTime can be the following formats(UTC):
'yyyy-mm-ddThh:mm:ssZ',
'yyyy-mm-ddThh:mm:ss.sssZ',
'yyyy-mm-ddThh:mm:ss+|-hh:mm
EXAMPLES:
'2018-01-15T05:06:08Z',
'2018-07-12T17:57:14.922Z',
'2018-07-13T14:59:52+00:00'
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
startRecordOrdinal |
Starting record ordinal inclusive. |
integer (int32) |
Query |
endingRecordOrdinal |
Ending record ordinal inclusive. |
integer (int32) |
Query |
beginTime |
Beginning time. |
string |
Query |
endTime |
Ending time. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
An error occurred when attempting to retrieve audit log messages |
|
422 |
Invalid Parameter |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/audit-log/messages
Request query
{
"startRecordOrdinal" : 0,
"endingRecordOrdinal" : 0,
"beginTime" : "string",
"endTime" : "string"
}
Example HTTP response
Response 200
{
"totalLogRecords" : 0,
"logRecords" : [ {
"method" : "string",
"accessedUrl" : "string",
"clientIp" : "string",
"userId" : "string",
"httpStatus" : 0,
"httpReasonPhrase" : "string",
"isFederated" : true,
"loggingAgent" : "string",
"cliCommandExecuted" : "string",
"cliReturnStatus" : "string",
"symbolProcedure" : "string",
"sshEventType" : "string",
"sshSessionPid" : 0,
"sshSessionDuration" : 0,
"timestamp" : "string",
"dateTime" : "string",
"recordOrdinal" : 0,
"optionalText" : "string"
} ],
"firstRecordOrdinal" : 0,
"lastRecordOrdinal" : 0
}
3.18.15. Retrieves the requested list of audit log messages as a private file.
POST /devmgr/v2/audit-log/messages
Description
This API will return a URL path to the file to be retrieved in the response. This API will also returna fileID to be used with URI files/private/{id}.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
An error occurred when attempting to retrieve audit log messages |
|
422 |
Invalid Parameter |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/audit-log/messages
Request body
{
"startRecordOrdinal" : 0,
"endingRecordOrdinal" : 0,
"beginTime" : "string",
"endTime" : "string"
}
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileID" : "string",
"fileURL" : "string"
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.18.16. Get the current audit log configuration.
GET /devmgr/v2/audit-log/config
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
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/audit-log/config
Example HTTP response
Response 200
{
"auditLogMaxRecords" : 50000,
"auditLogLevel" : "writeOnly",
"auditLogFullPolicy" : "overWrite",
"auditLogWarningThresholdPct" : 80
}
3.18.17. Updates the audit long configuration.
POST /devmgr/v2/audit-log/config
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
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/audit-log/config
Request body
{
"auditLogMaxRecords" : 50000,
"auditLogLevel" : "writeOnly",
"auditLogFullPolicy" : "overWrite",
"auditLogWarningThresholdPct" : 80
}
Example HTTP response
Response 200
{
"auditLogMaxRecords" : 50000,
"auditLogLevel" : "writeOnly",
"auditLogFullPolicy" : "overWrite",
"auditLogWarningThresholdPct" : 80
}
3.18.18. Get audit log metadata.
GET /devmgr/v2/audit-log/info
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
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/audit-log/info
Example HTTP response
Response 200
{
"totalLogRecords" : 0,
"firstRecordTimestamp" : "string",
"firstRecordDate" : "string",
"lastRecordTimestamp" : "string",
"lastRecordDate" : "string"
}
3.18.19. Delete specified subset or all proxy audit log messages.
DELETE /devmgr/v2/audit-log
Description
This will not delete entries from the audit log on a system with embedded webservices. One of The following values must be selected and are mutually exclusive: retentionCount, endDate, or clearAll
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
retentionCount |
Number of records to preserve within the log after deleting the audit logs from oldest to newest. |
integer (int32) |
Query |
endDate |
Delete all audit log records older than the specified time as a Unix timestamp in milliseconds. |
integer (int64) |
Query |
clearAll |
Clear all records |
boolean |
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/audit-log
Request query
{
"retentionCount" : 0,
"endDate" : 0,
"clearAll" : true
}
Example HTTP response
Response 200
{
"totalDeletedRecords" : 0
}
3.18.20. Retrieves the SNMP settings for this storage system
GET /devmgr/v2/storage-systems/{system-id}/snmp
Description
Mode: Both Embedded and Proxy.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin, storage.monitor]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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 |
Error finding object |
|
422 |
Error completing request |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snmp
Example HTTP response
Response 200
{
"sysName" : "string",
"sysLocation" : "string",
"sysContact" : "string",
"communities" : [ {
"id" : "string",
"name" : "string",
"permissions" : "string",
"trapDestinations" : [ {
"id" : "string",
"receiverAddress" : "string",
"sendAuthenticationFailureTraps" : true
} ]
} ]
}
3.18.21. Updates storage system configuration for SNMP
POST /devmgr/v2/storage-systems/{system-id}/snmp
Description
Mode: Both Embedded and Proxy.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successful operation |
|
404 |
Error finding object |
|
422 |
Error completing request |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/snmp
Request body
{
"sysName" : "string",
"sysLocation" : "string",
"sysContact" : "string",
"communities" : [ {
"name" : "string",
"permissions" : "string",
"trapDestinations" : [ {
"receiverAddress" : "string",
"sendAuthenticationFailureTraps" : true
} ]
} ]
}
Example HTTP response
Response 200
{
"sysName" : "string",
"sysLocation" : "string",
"sysContact" : "string",
"communities" : [ {
"id" : "string",
"name" : "string",
"permissions" : "string",
"trapDestinations" : [ {
"id" : "string",
"receiverAddress" : "string",
"sendAuthenticationFailureTraps" : true
} ]
} ]
}
3.18.22. Get a list of log messages for a Logging component.
GET /devmgr/v2/service-logs
Description
Localized Logger retrieval API for proxy server.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
loggerType |
The LoggerType to retrieve log records for. |
enum (batchLogger, systemReplLogger) |
|
Query |
startRecord |
Starting record number |
integer (int32) |
|
Query |
endingRecord |
Ending record number |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successful, log records returned. |
|
204 |
Logger type invalid. |
|
503 |
Service not available. |
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/service-logs
Request query
{
"loggerType" : "string",
"startRecord" : 0,
"endingRecord" : 0
}
Example HTTP response
Response 200
{
"recordType" : "string",
"logRecords" : [ {
"loggerType" : "string",
"timestamp" : "string",
"messageText" : "string",
"context" : "string",
"recordId" : "string"
} ],
"timeStamps" : {
"string" : "string"
}
}
Response 204
{
"recordType" : "string",
"logRecords" : [ {
"loggerType" : "string",
"timestamp" : "string",
"messageText" : "string",
"context" : "string",
"recordId" : "string"
} ],
"timeStamps" : {
"string" : "string"
}
}
Response 503
{
"recordType" : "string",
"logRecords" : [ {
"loggerType" : "string",
"timestamp" : "string",
"messageText" : "string",
"context" : "string",
"recordId" : "string"
} ],
"timeStamps" : {
"string" : "string"
}
}
3.19. REST Forwarding
3.19.1. Forwards a REST GET call to a storage system
GET /devmgr/v2/storage-systems/{system-id}/forward/{path}
Description
Provides a reverse proxy mechanism by which clients can send REST API GET calls to storage systems which support an embedded webserver. This allows access to embedded functionality not currently support by the proxy.
Mode: Proxy only.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
path |
path to be used in forwarded request. This path is treated as an absolute path on the embedded webserver. For example, to access |
string |
|
Query |
controller |
identifier of controller |
enum (a, b, auto) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
499 |
Storage system does not support embedded webserver |
Produces
-
/
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/forward/string
Request query
{
"controller" : "string"
}
3.19.2. Forwards a REST POST call to a storage system
POST /devmgr/v2/storage-systems/{system-id}/forward/{path}
Description
Provides a reverse proxy mechanism by which clients can send REST API POST calls to storage systems which support an embedded webserver. This allows access to embedded functionality not currently support by the proxy.
Mode: Proxy only.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
path |
path to be used in forwarded request. This path is treated as an absolute path on the embedded webserver. For example, to access |
string |
|
Query |
controller |
identifier of controller |
enum (a, b, auto) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
499 |
Storage system does not support embedded webserver |
Consumes
-
/
Produces
-
/
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/forward/string
Request query
{
"controller" : "string"
}
3.19.3. Forwards a REST DELETE call to a storage system
DELETE /devmgr/v2/storage-systems/{system-id}/forward/{path}
Description
Provides a reverse proxy mechanism by which clients can send REST API DELETE calls to storage systems which support an embedded webserver. This allows access to embedded functionality not currently support by the proxy.
Mode: Proxy only.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
path |
path to be used in forwarded request. This path is treated as an absolute path on the embedded webserver. For example, to access |
string |
|
Query |
controller |
identifier of controller |
enum (a, b, auto) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
499 |
Storage system does not support embedded webserver |
Consumes
-
/
Produces
-
/
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/forward/string
Request query
{
"controller" : "string"
}
3.19.4. Forwards a REST OPTIONS call to a storage system
OPTIONS /devmgr/v2/storage-systems/{system-id}/forward/{path}
Description
Provides a reverse proxy mechanism by which clients can send REST API OPTIONS calls to storage systems which support an embedded webserver. This allows access to embedded functionality not currently support by the proxy. <br> Mode: Proxy only.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
path |
path to be used in forwarded request. This path is treated as an absolute path on the embedded webserver. For example, to access |
string |
|
Query |
controller |
identifier of controller |
enum (a, b, auto) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
499 |
Storage system does not support embedded webserver |
Consumes
-
/
Produces
-
/
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/forward/string
Request query
{
"controller" : "string"
}
3.20. Security
3.20.1. Retrieves the specified certificate file
GET /devmgr/v2/storage-systems/{system-id}/external-key-server/certificate
Description
This API is designed to return a file. It will only return a content-type of application/json in cases where the file retrieval did not succeed.
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
certificateType |
Type of certificate being retrieved |
enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
file |
404 |
Storage device not found |
|
422 |
Cannot retrieve certificate file |
Consumes
-
application/json
Produces
-
application/octet-stream
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/certificate
Request query
{
"certificateType" : "string"
}
Example HTTP response
Response 200
"file"
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.20.2. Install a KMS Certificate or a certificate in a chain
POST /devmgr/v2/storage-systems/{system-id}/external-key-server/certificate
Description
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
certificateType |
Type of certificate being installed |
enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED) |
FormData |
file |
certificate file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
The certificate file was installed successfully |
|
404 |
Storage Device not found |
|
422 |
Unable to install certificate |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/certificate
Request query
{
"certificateType" : "string"
}
Request formData
"file"
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.20.3. Removes the specified certificate type
DELETE /devmgr/v2/storage-systems/{system-id}/external-key-server/certificate
Description
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
certificateType |
Type of certificate being removed |
enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED) |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
The specified certificate type was removed |
|
404 |
Storage device not found |
|
422 |
Unable to remove the specified certificate type |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/certificate
Request query
{
"certificateType" : "string"
}
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.20.4. Request a certificate signing request for a client side certificate used to validate with the external key server
POST /devmgr/v2/storage-systems/{system-id}/external-key-server/certificate/csr
Description
This will return the ID for the file (for use with other endpoints) and a URL (can be used directly).
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
The certificate signing request could not be generated |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/certificate/csr
Request body
{
"commonName" : "string",
"organizationName" : "string",
"organizationalUnitName" : "string",
"localityName" : "string",
"stateProvinceName" : "string",
"countryName" : "string"
}
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileID" : "string",
"fileURL" : "string"
}
3.20.5. Retrieves the details for the certificate files on the system as well as the associated Key Management Server IP and port.
GET /devmgr/v2/storage-systems/{system-id}/external-key-server
Description
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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 |
Storage device not found |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server
Example HTTP response
Response 200
{
"kmsAddress" : {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
},
"kmsPort" : 0,
"clientKmsType" : "string",
"clientSubjectDN" : "string",
"clientIssuerDN" : "string",
"clientStart" : "string",
"clientExpire" : "string",
"serverKmsType" : "string",
"serverSubjectDN" : "string",
"serverIssuerDN" : "string",
"serverStart" : "string",
"serverExpire" : "string"
}
3.20.6. Sets (enables/updates) the key server information
POST /devmgr/v2/storage-systems/{system-id}/external-key-server
Description
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
The key server information was updated successfully |
|
404 |
Storage device not found |
|
422 |
Unable to update the key server information |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server
Request body
{
"keyServerAddress" : {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
},
"port" : 0
}
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.20.7. Verify the storage system is able to communicate with the KMS server
POST /devmgr/v2/storage-systems/{system-id}/external-key-server/test
Description
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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 |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/test
Example HTTP response
Response 200
{
"successful" : true,
"returnCode" : "string"
}
3.20.8. Enables, disables or changes the external security key on the storage system
POST /devmgr/v2/storage-systems/{system-id}/external-key-server/security-key
Description
If the ekmsOption field is set to enable, the storage array will communicate with the KMS server to obtain a security key and install it on the storage system. In order for this to be successful, the following things must first occur:
-
The KMS server IP and port must be set
-
A CSR must be generated and uploaded to the KMS server to retrieve the client certificate
-
Both the client and server certificates need to be installed on the storage system
If the ekmsOption field is set to disable and external key management is currently enabled, the storage array will switch to internal key management and a new security key will be generated on the storage system.
If the ekmsOption is set to changeKey and external key management is currently enabled, a new security key will be generated on the storage system to replace the existing key.
This endpoint will only work on firmware versions 08.40.xx.xx and later. At this time, it is only supported on 28xx and 5700 controllers.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Storage device not found |
|
422 |
Cannot complete the requested action. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/external-key-server/security-key
Request body
{
"passPhrase" : "string",
"ekmsOption" : "string"
}
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileID" : "string",
"fileURL" : "string",
"lockKeyId" : "string"
}
3.20.9. Export a full disk encryption key
GET /devmgr/v2/storage-systems/{system-id}/security-key/export
Caution
|
operation.deprecated |
Description
The response type of this method is a file stream. This endpoint has been deprecated. The following endpoint should instead be used: POST:/storage-systems/{system-id}/security-key/export
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
passPhrase |
Pass phrase |
string |
Query |
fileName |
File name |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
file |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/octet-stream
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/security-key/export
Request query
{
"passPhrase" : "string",
"fileName" : "string"
}
Example HTTP response
Response 200
"file"
3.20.10. Request a full disk encryption key file
POST /devmgr/v2/storage-systems/{system-id}/security-key/export
Description
This will return the ID for the security key file (for use with other endpoints) and a URL which can be used to directly access the file.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/security-key/export
Request body
{
"fileName" : "string",
"passPhrase" : "string"
}
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileID" : "string",
"fileURL" : "string"
}
3.20.11. Create or change a full disk encryption key
POST /devmgr/v2/storage-systems/{system-id}/security-key
Description
The result of this method is the creation of a new key file. Retrieve with the /file/{filename} endpoint.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/security-key
Request body
{
"lockKeyId" : "string",
"passPhrase" : "string",
"setLockKey" : true
}
Example HTTP response
Response 200
{
"fileSize" : "string",
"fileName" : "string",
"lockKeyId" : "string"
}
3.20.12. Import a full disk encryption key
POST /devmgr/v2/storage-systems/{system-id}/security-key/import
Description
Use secure pass phrase for additional security instead of pass phrase.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
passPhrase |
Pass phrase |
string |
FormData |
keyfile |
file |
file |
FormData |
securePassPhrase |
Secure pass phrase |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The key was successfully imported |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/security-key/import
Request query
{
"passPhrase" : "string"
}
Request formData
"string"
3.20.13. Validate a full disk encryption key
POST /devmgr/v2/storage-systems/{system-id}/security-key/validate
Description
Use secure pass phrase for additional security instead of pass phrase.
MetaData
x-mode = both
x-allowedRoles = [root.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
passPhrase |
Pass phrase |
string |
FormData |
keyfile |
file |
file |
FormData |
securePassPhrase |
Secure pass phrase |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The key is valid |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/security-key/validate
Request query
{
"passPhrase" : "string"
}
Request formData
"string"
3.21. Service-Catalog
3.21.1. Retrieve the list of volumes
GET /devmgr/v2/storage-systems/{system-id}/ssc/volumes
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< UserVolume > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/volumes
Example HTTP response
Response 200
{
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"volumeGroupRef" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"protectionType" : "string",
"blkSize" : 0,
"flashCached" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"dataAssurance" : true,
"diskPool" : 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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
} ]
3.21.2. Define a new volume and configure its QOS parameters
POST /devmgr/v2/storage-systems/{system-id}/ssc/volumes
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/ssc/volumes
Request body
{
"poolId" : "string",
"name" : "string",
"sizeUnit" : "gb",
"size" : "string",
"readCacheEnable" : true,
"writeCacheEnable" : true,
"flashCacheEnable" : false,
"dataAssuranceEnable" : false,
"thinProvision" : false,
"metaTags" : [ {
"key" : "string",
"value" : "string"
} ]
}
Example HTTP response
Response 200
{
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"volumeGroupRef" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"protectionType" : "string",
"blkSize" : 0,
"flashCached" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"dataAssurance" : true,
"diskPool" : 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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
}
3.21.3. Retrieve a pool by name or ID
GET /devmgr/v2/storage-systems/{system-id}/ssc/pools/{poolId}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
poolId |
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/ssc/pools/string
Example HTTP response
Response 200
{
"poolId" : "string",
"name" : "string",
"pool" : {
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"usedSpace" : "string",
"totalRaidedSpace" : "string",
"extents" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"largestFreeExtentSize" : "string",
"raidStatus" : "string",
"freeSpace" : "string",
"drivePhysicalType" : "string",
"driveMediaType" : "string",
"normalizedSpindleSpeed" : "string",
"diskPool" : true,
"id" : "string",
"name" : "string"
},
"flashCacheCapable" : true,
"dataAssuranceCapable" : true,
"encrypted" : true,
"thinProvisioningCapable" : true,
"spindleSpeed" : "string",
"raidLevel" : "string",
"availableFreeExtentCapacities" : [ "string" ]
}
3.21.4. Retrieve the list of pools
GET /devmgr/v2/storage-systems/{system-id}/ssc/pools
Description
Retrieve the list of pools and their service quality features. The list is sorted in descending order by the largest block of freeSpace that each has available.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< PoolQosResponse > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/pools
Example HTTP response
Response 200
{
"poolId" : "string",
"name" : "string",
"pool" : {
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"usedSpace" : "string",
"totalRaidedSpace" : "string",
"extents" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"largestFreeExtentSize" : "string",
"raidStatus" : "string",
"freeSpace" : "string",
"drivePhysicalType" : "string",
"driveMediaType" : "string",
"normalizedSpindleSpeed" : "string",
"diskPool" : true,
"id" : "string",
"name" : "string"
},
"flashCacheCapable" : true,
"dataAssuranceCapable" : true,
"encrypted" : true,
"thinProvisioningCapable" : true,
"spindleSpeed" : "string",
"raidLevel" : "string",
"availableFreeExtentCapacities" : [ "string" ]
} ]
3.21.5. Retrieve a volume by id or label
GET /devmgr/v2/storage-systems/{system-id}/ssc/volumes/{volumeId}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
volumeId |
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/ssc/volumes/string
Example HTTP response
Response 200
{
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"volumeGroupRef" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"protectionType" : "string",
"blkSize" : 0,
"flashCached" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"dataAssurance" : true,
"diskPool" : 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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
}
3.21.6. Update an existing volume
POST /devmgr/v2/storage-systems/{system-id}/ssc/volumes/{volumeId}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
volumeId |
string |
|
Body |
body |
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/ssc/volumes/string
Request body
{
"name" : "string",
"newSize" : "string",
"sizeUnit" : "gb",
"flashCache" : true,
"owningControllerId" : "string",
"readCacheEnable" : true,
"writeCacheEnable" : true,
"scanSettings" : {
"enable" : true,
"parityValidationEnable" : true
},
"metaTags" : [ {
"key" : "string",
"value" : "string"
} ]
}
Example HTTP response
Response 200
{
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"volumeGroupRef" : "string",
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"protectionType" : "string",
"blkSize" : 0,
"flashCached" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"dataAssurance" : true,
"diskPool" : 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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
}
3.21.7. Delete a volume by id or label
DELETE /devmgr/v2/storage-systems/{system-id}/ssc/volumes/{volumeId}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
volumeId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Delete was successful |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/ssc/volumes/string
Example HTTP response
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
Response 424
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.22. Statistics
3.22.1. Get all analysed disk statistics
GET /devmgr/v2/storage-systems/{system-id}/analysed-drive-statistics
Description
This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AnalysedDiskStatistics > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
|
503 |
Statistics service is not running |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-drive-statistics
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"diskId" : "string",
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0
} ]
3.22.2. Get a subset of analysed disk statistics
GET /devmgr/v2/storage-systems/{system-id}/analysed-drive-statistics/{idlist}
Description
This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
idlist |
A comma separated list of disk ids |
< string > array(csv) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AnalysedDiskStatistics > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
|
503 |
Statistics service is not running |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-drive-statistics/string
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"diskId" : "string",
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0
} ]
3.22.3. Get a subset of analysed volume statistics
GET /devmgr/v2/storage-systems/{system-id}/analysed-volume-statistics/{idlist}
Description
This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
idlist |
A comma separated list of volume ids |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AnalysedVolumeStatistics > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
|
503 |
Statistics service is not running |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-volume-statistics/string
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"volumeId" : "string",
"volumeName" : "string",
"poolId" : "string",
"controllerId" : "string",
"workLoadId" : "string",
"mapped" : true,
"readHitOps" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"readHitBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0,
"readCacheUtilization" : 0.0,
"writeCacheUtilization" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0,
"cacheWriteWaitOpsPercent" : 0.0,
"cacheWriteWaitBytesPercent" : 0.0,
"prefetchHitPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"flashCacheReadThroughput" : 0.0,
"flashCacheReadResponseTime" : 0.0,
"flashCacheHitPct" : 0.0
} ]
3.22.4. Get all analysed volume statistics
GET /devmgr/v2/storage-systems/{system-id}/analysed-volume-statistics
Description
This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AnalysedVolumeStatistics > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
|
503 |
Statistics service is not running |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-volume-statistics
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"volumeId" : "string",
"volumeName" : "string",
"poolId" : "string",
"controllerId" : "string",
"workLoadId" : "string",
"mapped" : true,
"readHitOps" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"readHitBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0,
"readCacheUtilization" : 0.0,
"writeCacheUtilization" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0,
"cacheWriteWaitOpsPercent" : 0.0,
"cacheWriteWaitBytesPercent" : 0.0,
"prefetchHitPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"flashCacheReadThroughput" : 0.0,
"flashCacheReadResponseTime" : 0.0,
"flashCacheHitPct" : 0.0
} ]
3.22.5. Get all analysed controller statistics
GET /devmgr/v2/storage-systems/{system-id}/analysed-controller-statistics
Description
This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.
This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AnalysedControllerStatistics > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
|
503 |
Statistics service is not running |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-controller-statistics
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"controllerId" : "string",
"cacheHitBytesPercent" : 0.0,
"randomIosPercent" : 0.0,
"mirrorBytesPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"maxCpuUtilization" : 0.0,
"maxCpuUtilizationPerCore" : [ 0.0 ],
"cpuAvgUtilization" : 0.0,
"cpuAvgUtilizationPerCore" : [ 0.0 ],
"cpuAvgUtilizationPerCoreStdDev" : [ 0.0 ],
"raid0BytesPercent" : 0.0,
"raid1BytesPercent" : 0.0,
"raid5BytesPercent" : 0.0,
"raid6BytesPercent" : 0.0,
"ddpBytesPercent" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0
} ]
3.22.6. Get a subset of analysed controller statistics
GET /devmgr/v2/storage-systems/{system-id}/analysed-controller-statistics/{idlist}
Caution
|
operation.deprecated |
Description
This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.
This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
idlist |
A comma separated list of controller id’s |
< string > array(csv) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AnalysedControllerStatistics > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
|
503 |
Statistics service is not running |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-controller-statistics/string
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"controllerId" : "string",
"cacheHitBytesPercent" : 0.0,
"randomIosPercent" : 0.0,
"mirrorBytesPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"maxCpuUtilization" : 0.0,
"maxCpuUtilizationPerCore" : [ 0.0 ],
"cpuAvgUtilization" : 0.0,
"cpuAvgUtilizationPerCore" : [ 0.0 ],
"cpuAvgUtilizationPerCoreStdDev" : [ 0.0 ],
"raid0BytesPercent" : 0.0,
"raid1BytesPercent" : 0.0,
"raid5BytesPercent" : 0.0,
"raid6BytesPercent" : 0.0,
"ddpBytesPercent" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0
} ]
3.22.7. Get all analysed interface statistics
GET /devmgr/v2/storage-systems/{system-id}/analysed-interface-statistics
Description
This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.
This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AnalyzedInterfaceStatistics > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
|
503 |
Statistics service is not running |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-interface-statistics
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"interfaceId" : "string",
"channelType" : "string",
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelNumber" : 0,
"channelErrorCounts" : 0.0
} ]
3.22.8. Get a subset of analysed interface statistics
GET /devmgr/v2/storage-systems/{system-id}/analysed-interface-statistics/{idlist}
Description
This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.
This API requires at least two prior collections worth of raw statistics data in order to provide an analyzed result. If we have not yet collected at least two relevant statistics snapshots from the storage-system, the result will be an empty list.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
idlist |
A comma separated list of interface id’s |
< string > array(csv) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< AnalyzedInterfaceStatistics > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
|
503 |
Statistics service is not running |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/analysed-interface-statistics/string
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"interfaceId" : "string",
"channelType" : "string",
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelNumber" : 0,
"channelErrorCounts" : 0.0
} ]
3.22.9. Get a subset of raw controller statistics
GET /devmgr/v2/storage-systems/{system-id}/controller-statistics/{idlist}
Caution
|
operation.deprecated |
Description
This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.
This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
idlist |
A comma separated list of controller id’s |
< string > array(csv) |
|
Query |
usecache |
When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< ControllerStats > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/controller-statistics/string
Request query
{
"usecache" : true
}
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"controllerId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ]
3.22.10. Get all raw controller statistics
GET /devmgr/v2/storage-systems/{system-id}/controller-statistics
Description
This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.
This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
usecache |
When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< ControllerStats > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/controller-statistics
Request query
{
"usecache" : true
}
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"controllerId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ]
3.22.11. Get a subset of the raw disk statistics
GET /devmgr/v2/storage-systems/{system-id}/drive-statistics/{idlist}
Description
This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
idlist |
A comma separated list of disk ids |
< string > array(csv) |
|
Query |
usecache |
When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< DiskIOStats > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drive-statistics/string
Request query
{
"usecache" : true
}
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"diskId" : "string",
"serialNumber" : "string",
"arrayId" : "string",
"arrayWWN" : "string",
"driveWWN" : "string",
"volGroupId" : "string",
"volGroupName" : "string",
"volGroupWWN" : "string",
"trayId" : "string",
"slot" : 0,
"diskManufacture" : "string",
"diskSoftwareVersion" : "string",
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readOps" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotal" : 0.0,
"readTimeTotalSq" : 0.0,
"recoveredErrors" : 0.0,
"retriedIos" : 0.0,
"timeouts" : 0.0,
"unrecoveredErrors" : 0.0,
"writeBytes" : 0.0,
"writeOps" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cumulativeLBA" : 0.0,
"cumulativeDeltaLBA" : 0.0
} ]
3.22.12. Get raw disk statistics
GET /devmgr/v2/storage-systems/{system-id}/drive-statistics
Description
This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
usecache |
When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< DiskIOStats > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/drive-statistics
Request query
{
"usecache" : true
}
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"diskId" : "string",
"serialNumber" : "string",
"arrayId" : "string",
"arrayWWN" : "string",
"driveWWN" : "string",
"volGroupId" : "string",
"volGroupName" : "string",
"volGroupWWN" : "string",
"trayId" : "string",
"slot" : 0,
"diskManufacture" : "string",
"diskSoftwareVersion" : "string",
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readOps" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotal" : 0.0,
"readTimeTotalSq" : 0.0,
"recoveredErrors" : 0.0,
"retriedIos" : 0.0,
"timeouts" : 0.0,
"unrecoveredErrors" : 0.0,
"writeBytes" : 0.0,
"writeOps" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cumulativeLBA" : 0.0,
"cumulativeDeltaLBA" : 0.0
} ]
3.22.13. Get the list supported statistics types
GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/supported-types
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< enum (volume, controller, storageSystem, drive, ioInterface, storagePool, application, workload) > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/supported-types
Example HTTP response
Response 200
[ "string" ]
3.22.14. Get the list supported raw statistics types
GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/supported-types/raw
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< enum (volume, controller, storageSystem, drive, ioInterface, storagePool, application, workload) > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/supported-types/raw
Example HTTP response
Response 200
[ "string" ]
3.22.15. Get the list supported average analyzed statistics types
GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/supported-types/average
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< enum (volume, controller, storageSystem, drive, ioInterface, storagePool, application, workload) > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/historical-statistics/supported-types/average
Example HTTP response
Response 200
[ "string" ]
3.22.16. Get selected historical performance statistics
GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/{idlist}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
idlist |
A comma separated list of object ids |
< string > array(csv) |
Query |
type |
Statistics type |
string |
Query |
start |
start time in milliseconds since the epoch |
integer (int64) |
Query |
end |
end time in milliseconds since the epoch |
integer (int64) |
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/historical-statistics/string
Request query
{
"type" : "string",
"start" : 0,
"end" : 0
}
Example HTTP response
Response 200
{
"volumeStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"volumeId" : "string",
"volumeName" : "string",
"poolId" : "string",
"controllerId" : "string",
"workLoadId" : "string",
"mapped" : true,
"readHitOps" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"readHitBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0,
"readCacheUtilization" : 0.0,
"writeCacheUtilization" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0,
"cacheWriteWaitOpsPercent" : 0.0,
"cacheWriteWaitBytesPercent" : 0.0,
"prefetchHitPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"flashCacheReadThroughput" : 0.0,
"flashCacheReadResponseTime" : 0.0,
"flashCacheHitPct" : 0.0
} ],
"controllerStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"controllerId" : "string",
"cacheHitBytesPercent" : 0.0,
"randomIosPercent" : 0.0,
"mirrorBytesPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"maxCpuUtilization" : 0.0,
"maxCpuUtilizationPerCore" : [ 0.0 ],
"cpuAvgUtilization" : 0.0,
"cpuAvgUtilizationPerCore" : [ 0.0 ],
"cpuAvgUtilizationPerCoreStdDev" : [ 0.0 ],
"raid0BytesPercent" : 0.0,
"raid1BytesPercent" : 0.0,
"raid5BytesPercent" : 0.0,
"raid6BytesPercent" : 0.0,
"ddpBytesPercent" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0
} ],
"systemStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"storageSystemId" : "string",
"storageSystemWWN" : "string",
"storageSystemName" : "string"
} ],
"interfaceStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"interfaceId" : "string",
"channelType" : "string",
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelNumber" : 0,
"channelErrorCounts" : 0.0
} ],
"diskStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"diskId" : "string",
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0
} ],
"poolStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"poolId" : "string"
} ],
"workloadStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"workloadId" : "string"
} ],
"applicationStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"applicationId" : "string"
} ],
"volumes" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"volumeId" : "string",
"volumeName" : "string",
"poolId" : "string",
"controllerId" : "string",
"workLoadId" : "string",
"mapped" : true,
"readHitOps" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"readHitBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0,
"readCacheUtilization" : 0.0,
"writeCacheUtilization" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0,
"cacheWriteWaitOpsPercent" : 0.0,
"cacheWriteWaitBytesPercent" : 0.0,
"prefetchHitPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"flashCacheReadThroughput" : 0.0,
"flashCacheReadResponseTime" : 0.0,
"flashCacheHitPct" : 0.0
} ]
}
3.22.17. Get historical performance statistics
GET /devmgr/v2/storage-systems/{system-id}/historical-statistics
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
type |
Statistics type |
string |
Query |
start |
start time in milliseconds since the epoch |
integer (int64) |
Query |
end |
end time in milliseconds since the epoch |
integer (int64) |
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/historical-statistics
Request query
{
"type" : "string",
"start" : 0,
"end" : 0
}
Example HTTP response
Response 200
{
"volumeStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"volumeId" : "string",
"volumeName" : "string",
"poolId" : "string",
"controllerId" : "string",
"workLoadId" : "string",
"mapped" : true,
"readHitOps" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"readHitBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0,
"readCacheUtilization" : 0.0,
"writeCacheUtilization" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0,
"cacheWriteWaitOpsPercent" : 0.0,
"cacheWriteWaitBytesPercent" : 0.0,
"prefetchHitPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"flashCacheReadThroughput" : 0.0,
"flashCacheReadResponseTime" : 0.0,
"flashCacheHitPct" : 0.0
} ],
"controllerStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"controllerId" : "string",
"cacheHitBytesPercent" : 0.0,
"randomIosPercent" : 0.0,
"mirrorBytesPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"maxCpuUtilization" : 0.0,
"maxCpuUtilizationPerCore" : [ 0.0 ],
"cpuAvgUtilization" : 0.0,
"cpuAvgUtilizationPerCore" : [ 0.0 ],
"cpuAvgUtilizationPerCoreStdDev" : [ 0.0 ],
"raid0BytesPercent" : 0.0,
"raid1BytesPercent" : 0.0,
"raid5BytesPercent" : 0.0,
"raid6BytesPercent" : 0.0,
"ddpBytesPercent" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0
} ],
"systemStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"storageSystemId" : "string",
"storageSystemWWN" : "string",
"storageSystemName" : "string"
} ],
"interfaceStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"interfaceId" : "string",
"channelType" : "string",
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelNumber" : 0,
"channelErrorCounts" : 0.0
} ],
"diskStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"diskId" : "string",
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0
} ],
"poolStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"poolId" : "string"
} ],
"workloadStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"workloadId" : "string"
} ],
"applicationStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"applicationId" : "string"
} ],
"volumes" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"readIOps" : 0.0,
"writeIOps" : 0.0,
"otherIOps" : 0.0,
"combinedIOps" : 0.0,
"readThroughput" : 0.0,
"writeThroughput" : 0.0,
"combinedThroughput" : 0.0,
"readResponseTime" : 0.0,
"readResponseTimeStdDev" : 0.0,
"writeResponseTime" : 0.0,
"writeResponseTimeStdDev" : 0.0,
"combinedResponseTime" : 0.0,
"combinedResponseTimeStdDev" : 0.0,
"averageReadOpSize" : 0.0,
"averageWriteOpSize" : 0.0,
"readOps" : 0.0,
"writeOps" : 0.0,
"volumeId" : "string",
"volumeName" : "string",
"poolId" : "string",
"controllerId" : "string",
"workLoadId" : "string",
"mapped" : true,
"readHitOps" : 0.0,
"readHitResponseTime" : 0.0,
"readHitResponseTimeStdDev" : 0.0,
"readHitBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitResponseTime" : 0.0,
"writeHitResponseTimeStdDev" : 0.0,
"combinedHitResponseTime" : 0.0,
"combinedHitResponseTimeStdDev" : 0.0,
"readCacheUtilization" : 0.0,
"writeCacheUtilization" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"readPhysicalIOps" : 0.0,
"writePhysicalIOps" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"readTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"averageQueueDepth" : 0.0,
"randomIosPercent" : 0.0,
"randomBytesPercent" : 0.0,
"cacheWriteWaitOpsPercent" : 0.0,
"cacheWriteWaitBytesPercent" : 0.0,
"prefetchHitPercent" : 0.0,
"fullStripeWritesBytesPercent" : 0.0,
"flashCacheReadThroughput" : 0.0,
"flashCacheReadResponseTime" : 0.0,
"flashCacheHitPct" : 0.0
} ]
}
3.22.18. Get selected historical performance raw statistics
GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/raw/{idlist}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
idlist |
A comma separated list of object ids |
< string > array(csv) |
Query |
type |
Statistics type |
string |
Query |
start |
start time in milliseconds since the epoch |
integer (int64) |
Query |
end |
end time in milliseconds since the epoch |
integer (int64) |
Query |
length |
Length of time in ms. |
integer (int64) |
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/historical-statistics/raw/string
Request query
{
"type" : "string",
"start" : 0,
"end" : 0,
"length" : 0
}
Example HTTP response
Response 200
{
"volumeStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"volumeGroupId" : "string",
"controllerId" : "string",
"volumeId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"volumeGroupWwn" : "string",
"volumeName" : "string",
"volumeWwn" : "string",
"workloadId" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeCacheHitOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readHitTimeTotalSq" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeHitTimeTotalSq" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cacheWriteWaitHitIops" : 0.0,
"cacheWriteWaitHitBytes" : 0.0,
"fullStripeWriteBytes" : 0.0,
"totalIosShipped" : 0.0,
"totalBlksEvicted" : 0.0,
"cacheBlksInUse" : 0.0,
"prefetchHitBytes" : 0.0,
"prefetchMissBytes" : "string",
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"flashCacheReadHitTimeTotalSq" : 0.0
} ],
"controllerStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"controllerId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ],
"systemStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"controllerStats" : [ {
"controllerId" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ]
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ],
"interfaceStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"interfaceId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"channelType" : "string",
"channelNumber" : 0,
"readOps" : 0.0,
"readBytes" : 0.0,
"readTimeTotal" : 0.0,
"readTimeMax" : 0.0,
"writeOps" : 0.0,
"writeBytes" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeMax" : 0.0,
"otherOps" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeTimeTotalSq" : 0.0,
"otherTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelErrorCount" : 0.0
} ],
"diskStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"diskId" : "string",
"serialNumber" : "string",
"arrayId" : "string",
"arrayWWN" : "string",
"driveWWN" : "string",
"volGroupId" : "string",
"volGroupName" : "string",
"volGroupWWN" : "string",
"trayId" : "string",
"slot" : 0,
"diskManufacture" : "string",
"diskSoftwareVersion" : "string",
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readOps" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotal" : 0.0,
"readTimeTotalSq" : 0.0,
"recoveredErrors" : 0.0,
"retriedIos" : 0.0,
"timeouts" : 0.0,
"unrecoveredErrors" : 0.0,
"writeBytes" : 0.0,
"writeOps" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cumulativeLBA" : 0.0,
"cumulativeDeltaLBA" : 0.0
} ],
"poolStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"poolId" : "string"
} ],
"applicationStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"applicationId" : "string"
} ],
"workloadStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"workloadId" : "string"
} ]
}
3.22.19. Get historical performance raw statistics
GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/raw
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
type |
Statistics type |
string |
Query |
start |
start time in milliseconds since the epoch |
integer (int64) |
Query |
end |
end time in milliseconds since the epoch |
integer (int64) |
Query |
length |
Length of time in ms. |
integer (int64) |
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/historical-statistics/raw
Request query
{
"type" : "string",
"start" : 0,
"end" : 0,
"length" : 0
}
Example HTTP response
Response 200
{
"volumeStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"volumeGroupId" : "string",
"controllerId" : "string",
"volumeId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"volumeGroupWwn" : "string",
"volumeName" : "string",
"volumeWwn" : "string",
"workloadId" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeCacheHitOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readHitTimeTotalSq" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeHitTimeTotalSq" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cacheWriteWaitHitIops" : 0.0,
"cacheWriteWaitHitBytes" : 0.0,
"fullStripeWriteBytes" : 0.0,
"totalIosShipped" : 0.0,
"totalBlksEvicted" : 0.0,
"cacheBlksInUse" : 0.0,
"prefetchHitBytes" : 0.0,
"prefetchMissBytes" : "string",
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"flashCacheReadHitTimeTotalSq" : 0.0
} ],
"controllerStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"controllerId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ],
"systemStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"controllerStats" : [ {
"controllerId" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ]
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ],
"interfaceStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"interfaceId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"channelType" : "string",
"channelNumber" : 0,
"readOps" : 0.0,
"readBytes" : 0.0,
"readTimeTotal" : 0.0,
"readTimeMax" : 0.0,
"writeOps" : 0.0,
"writeBytes" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeMax" : 0.0,
"otherOps" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeTimeTotalSq" : 0.0,
"otherTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelErrorCount" : 0.0
} ],
"diskStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"diskId" : "string",
"serialNumber" : "string",
"arrayId" : "string",
"arrayWWN" : "string",
"driveWWN" : "string",
"volGroupId" : "string",
"volGroupName" : "string",
"volGroupWWN" : "string",
"trayId" : "string",
"slot" : 0,
"diskManufacture" : "string",
"diskSoftwareVersion" : "string",
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readOps" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotal" : 0.0,
"readTimeTotalSq" : 0.0,
"recoveredErrors" : 0.0,
"retriedIos" : 0.0,
"timeouts" : 0.0,
"unrecoveredErrors" : 0.0,
"writeBytes" : 0.0,
"writeOps" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cumulativeLBA" : 0.0,
"cumulativeDeltaLBA" : 0.0
} ],
"poolStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"poolId" : "string"
} ],
"applicationStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"applicationId" : "string"
} ],
"workloadStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"workloadId" : "string"
} ]
}
3.22.20. Get historical performance statistics averaged over a time range.
GET /devmgr/v2/storage-systems/{system-id}/historical-statistics/average
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
type |
Statistics type |
string |
Query |
length |
Length of time in ms. |
integer (int64) |
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/historical-statistics/average
Request query
{
"type" : "string",
"length" : 0
}
Example HTTP response
Response 200
{
"volumeStats" : [ {
"id" : "string",
"latencyRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"latencyWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"primaryCacheReadHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"primaryCacheWriteHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"ssdCacheReadHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
}
} ],
"diskStats" : [ {
"id" : "string",
"latencyRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"latencyWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
}
} ],
"controllerStats" : [ {
"id" : "string",
"iopsRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"cpuUtilization" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"headroomPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
}
} ],
"interfaceStats" : [ {
"id" : "string",
"latencyRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"latencyWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"headroomPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
}
} ],
"systemStats" : [ {
"id" : "string",
"iopsRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"controllerStats" : [ {
"controllerId" : "string",
"cpuUtilization" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
}
} ]
} ],
"poolStats" : [ {
"id" : "string",
"latencyRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"latencyWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"primaryCacheReadHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"primaryCacheWriteHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"ssdCacheReadHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
}
} ],
"workloadStats" : [ {
"id" : "string",
"latencyRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"latencyWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"primaryCacheReadHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"primaryCacheWriteHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"ssdCacheReadHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
}
} ],
"applicationStats" : [ {
"id" : "string",
"latencyRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"latencyWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"iopsWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputRead" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"throughputWrite" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"primaryCacheReadHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"primaryCacheWriteHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
},
"ssdCacheReadHitPct" : {
"min" : 0.0,
"max" : 0.0,
"std" : 0.0,
"value" : 0.0
}
} ]
}
3.22.21. Get a subset of raw interface statistics
GET /devmgr/v2/storage-systems/{system-id}/interface-statistics/{idlist}
Description
This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.
This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
idlist |
A comma separated list of interface id’s |
< string > array(csv) |
|
Query |
usecache |
When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< InterfaceStats > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/interface-statistics/string
Request query
{
"usecache" : true
}
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"interfaceId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"channelType" : "string",
"channelNumber" : 0,
"readOps" : 0.0,
"readBytes" : 0.0,
"readTimeTotal" : 0.0,
"readTimeMax" : 0.0,
"writeOps" : 0.0,
"writeBytes" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeMax" : 0.0,
"otherOps" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeTimeTotalSq" : 0.0,
"otherTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelErrorCount" : 0.0
} ]
3.22.22. Get all raw interface statistics
GET /devmgr/v2/storage-systems/{system-id}/interface-statistics
Description
This API is available on all model 28xx+ systems, as well as any model 27xx or 56xx that is running 08.30.20.xx/11.30.20.xx or greater code versions.
This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
usecache |
When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< InterfaceStats > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/interface-statistics
Request query
{
"usecache" : true
}
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"interfaceId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"channelType" : "string",
"channelNumber" : 0,
"readOps" : 0.0,
"readBytes" : 0.0,
"readTimeTotal" : 0.0,
"readTimeMax" : 0.0,
"writeOps" : 0.0,
"writeBytes" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeMax" : 0.0,
"otherOps" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeTimeTotalSq" : 0.0,
"otherTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelErrorCount" : 0.0
} ]
3.22.23. Get selected Live performance statistics
GET /devmgr/v2/storage-systems/{system-id}/live-statistics/{idlist}
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
idlist |
A comma separated list of object ids |
< string > array(csv) |
Query |
type |
Statistics type |
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/live-statistics/string
Request query
{
"type" : "string"
}
Example HTTP response
Response 200
{
"volumeStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"volumeGroupId" : "string",
"controllerId" : "string",
"volumeId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"volumeGroupWwn" : "string",
"volumeName" : "string",
"volumeWwn" : "string",
"workloadId" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeCacheHitOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readHitTimeTotalSq" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeHitTimeTotalSq" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cacheWriteWaitHitIops" : 0.0,
"cacheWriteWaitHitBytes" : 0.0,
"fullStripeWriteBytes" : 0.0,
"totalIosShipped" : 0.0,
"totalBlksEvicted" : 0.0,
"cacheBlksInUse" : 0.0,
"prefetchHitBytes" : 0.0,
"prefetchMissBytes" : "string",
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"flashCacheReadHitTimeTotalSq" : 0.0
} ],
"controllerStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"controllerId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ],
"systemStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"controllerStats" : [ {
"controllerId" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ]
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ],
"interfaceStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"interfaceId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"channelType" : "string",
"channelNumber" : 0,
"readOps" : 0.0,
"readBytes" : 0.0,
"readTimeTotal" : 0.0,
"readTimeMax" : 0.0,
"writeOps" : 0.0,
"writeBytes" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeMax" : 0.0,
"otherOps" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeTimeTotalSq" : 0.0,
"otherTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelErrorCount" : 0.0
} ],
"diskStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"diskId" : "string",
"serialNumber" : "string",
"arrayId" : "string",
"arrayWWN" : "string",
"driveWWN" : "string",
"volGroupId" : "string",
"volGroupName" : "string",
"volGroupWWN" : "string",
"trayId" : "string",
"slot" : 0,
"diskManufacture" : "string",
"diskSoftwareVersion" : "string",
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readOps" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotal" : 0.0,
"readTimeTotalSq" : 0.0,
"recoveredErrors" : 0.0,
"retriedIos" : 0.0,
"timeouts" : 0.0,
"unrecoveredErrors" : 0.0,
"writeBytes" : 0.0,
"writeOps" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cumulativeLBA" : 0.0,
"cumulativeDeltaLBA" : 0.0
} ],
"poolStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"poolId" : "string"
} ],
"applicationStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"applicationId" : "string"
} ],
"workloadStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"workloadId" : "string"
} ]
}
3.22.24. Get Live performance statistics
GET /devmgr/v2/storage-systems/{system-id}/live-statistics
MetaData
x-mode = embedded
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
type |
Statistics type |
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/live-statistics
Request query
{
"type" : "string"
}
Example HTTP response
Response 200
{
"volumeStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"volumeGroupId" : "string",
"controllerId" : "string",
"volumeId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"volumeGroupWwn" : "string",
"volumeName" : "string",
"volumeWwn" : "string",
"workloadId" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeCacheHitOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readHitTimeTotalSq" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeHitTimeTotalSq" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cacheWriteWaitHitIops" : 0.0,
"cacheWriteWaitHitBytes" : 0.0,
"fullStripeWriteBytes" : 0.0,
"totalIosShipped" : 0.0,
"totalBlksEvicted" : 0.0,
"cacheBlksInUse" : 0.0,
"prefetchHitBytes" : 0.0,
"prefetchMissBytes" : "string",
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"flashCacheReadHitTimeTotalSq" : 0.0
} ],
"controllerStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"controllerId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ],
"systemStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"controllerStats" : [ {
"controllerId" : "string",
"cpuUtilizationStats" : [ {
"maxCpuUtilization" : 0,
"sumCpuUtilization" : 0,
"ssqCpuUtilization" : 0
} ]
} ],
"totalIopsServiced" : 0.0,
"totalBytesServiced" : 0.0,
"cacheHitsIopsTotal" : 0.0,
"cacheHitsBytesTotal" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"readIopsTotal" : 0.0,
"readBytesTotal" : 0.0,
"writeIopsTotal" : 0.0,
"writeBytesTotal" : 0.0,
"mirrorIopsTotal" : 0.0,
"mirrorBytesTotal" : 0.0,
"fullStripeWritesBytes" : 0.0,
"raid0BytesTransferred" : 0.0,
"raid1BytesTransferred" : 0.0,
"raid5BytesTransferred" : 0.0,
"raid6BytesTransferred" : 0.0,
"ddpBytesTransferred" : 0.0,
"maxPossibleBpsUnderCurrentLoad" : 0.0,
"maxPossibleIopsUnderCurrentLoad" : 0.0
} ],
"interfaceStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"interfaceId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"channelType" : "string",
"channelNumber" : 0,
"readOps" : 0.0,
"readBytes" : 0.0,
"readTimeTotal" : 0.0,
"readTimeMax" : 0.0,
"writeOps" : 0.0,
"writeBytes" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeMax" : 0.0,
"otherOps" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeTimeTotalSq" : 0.0,
"otherTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"channelErrorCount" : 0.0
} ],
"diskStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"diskId" : "string",
"serialNumber" : "string",
"arrayId" : "string",
"arrayWWN" : "string",
"driveWWN" : "string",
"volGroupId" : "string",
"volGroupName" : "string",
"volGroupWWN" : "string",
"trayId" : "string",
"slot" : 0,
"diskManufacture" : "string",
"diskSoftwareVersion" : "string",
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readOps" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotal" : 0.0,
"readTimeTotalSq" : 0.0,
"recoveredErrors" : 0.0,
"retriedIos" : 0.0,
"timeouts" : 0.0,
"unrecoveredErrors" : 0.0,
"writeBytes" : 0.0,
"writeOps" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotal" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cumulativeLBA" : 0.0,
"cumulativeDeltaLBA" : 0.0
} ],
"poolStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"poolId" : "string"
} ],
"applicationStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"applicationId" : "string"
} ],
"workloadStats" : [ {
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"memberIdsHash" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readTimeMax" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeTimeMax" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"workloadId" : "string"
} ]
}
3.22.25. Get a subset of raw volume statistics
GET /devmgr/v2/storage-systems/{system-id}/volume-statistics/{idlist}
Description
This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
idlist |
A comma separated list of volume ids |
< string > array(csv) |
|
Query |
usecache |
When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< VolumeIOStats > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-statistics/string
Request query
{
"usecache" : true
}
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"volumeGroupId" : "string",
"controllerId" : "string",
"volumeId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"volumeGroupWwn" : "string",
"volumeName" : "string",
"volumeWwn" : "string",
"workloadId" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeCacheHitOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readHitTimeTotalSq" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeHitTimeTotalSq" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cacheWriteWaitHitIops" : 0.0,
"cacheWriteWaitHitBytes" : 0.0,
"fullStripeWriteBytes" : 0.0,
"totalIosShipped" : 0.0,
"totalBlksEvicted" : 0.0,
"cacheBlksInUse" : 0.0,
"prefetchHitBytes" : 0.0,
"prefetchMissBytes" : "string",
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"flashCacheReadHitTimeTotalSq" : 0.0
} ]
3.22.26. Get all raw volume statistics
GET /devmgr/v2/storage-systems/{system-id}/volume-statistics
Description
This API will either retrieve a cached, previously collected statistics snapshot (default), or it will attempt to retrieve the statistics from the storage-system directly. If no previous statistics collections have been successful or have occurred, the statistics will be retrieved directly from the storage-system.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Query |
usecache |
When true, the statistics data will be returned from the cache. If there is no data in the cache then the storage system will be queried directly for the statistics data. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< VolumeIOStats > array |
404 |
StorageDevice not found |
|
422 |
Failure retrieving the requested statistics |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-statistics
Request query
{
"usecache" : true
}
Example HTTP response
Response 200
{
"observedTime" : "string",
"observedTimeInMS" : "string",
"lastResetTime" : "string",
"lastResetTimeInMS" : "string",
"volumeGroupId" : "string",
"controllerId" : "string",
"volumeId" : "string",
"arrayId" : "string",
"arrayWwn" : "string",
"volumeGroupWwn" : "string",
"volumeName" : "string",
"volumeWwn" : "string",
"workloadId" : "string",
"readOps" : 0.0,
"readHitOps" : 0.0,
"readHitBytes" : 0.0,
"readTimeTotal" : 0.0,
"readHitTimeTotal" : 0.0,
"writeOps" : 0.0,
"writeCacheHitOps" : 0.0,
"writeTimeTotal" : 0.0,
"writeHitTimeTotal" : 0.0,
"errRedundancyChkIndeterminateReads" : 0.0,
"errRedundancyChkRecoveredReads" : 0.0,
"errRedundancyChkUnrecoveredReads" : 0.0,
"idleTime" : 0.0,
"otherOps" : 0.0,
"otherTimeMax" : 0.0,
"otherTimeTotal" : 0.0,
"otherTimeTotalSq" : 0.0,
"readBytes" : 0.0,
"readHitTimeMax" : 0.0,
"readHitTimeTotalSq" : 0.0,
"readTimeMax" : 0.0,
"readTimeTotalSq" : 0.0,
"writeBytes" : 0.0,
"writeHitBytes" : 0.0,
"writeHitOps" : 0.0,
"writeHitTimeMax" : 0.0,
"writeHitTimeTotalSq" : 0.0,
"writeTimeMax" : 0.0,
"writeTimeTotalSq" : 0.0,
"queueDepthTotal" : 0.0,
"queueDepthMax" : 0.0,
"randomIosTotal" : 0.0,
"randomBytesTotal" : 0.0,
"cacheWriteWaitHitIops" : 0.0,
"cacheWriteWaitHitBytes" : 0.0,
"fullStripeWriteBytes" : 0.0,
"totalIosShipped" : 0.0,
"totalBlksEvicted" : 0.0,
"cacheBlksInUse" : 0.0,
"prefetchHitBytes" : 0.0,
"prefetchMissBytes" : "string",
"flashCacheReadHitOps" : 0.0,
"flashCacheReadHitBytes" : 0.0,
"flashCacheReadHitTimeTotal" : 0.0,
"flashCacheReadHitTimeMax" : 0.0,
"flashCacheReadHitTimeTotalSq" : 0.0
} ]
3.23. Storage-Systems
3.23.1. Retrieve results of a previously initiated discovery operation
GET /devmgr/v2/discovery
Description
Retrieve the results of a previously initiated discovery operation. Recent previous results can be retrieved using their requestId, otherwise we’ll simply retrieve the most recent results.
If you run multiple POST /discovery operations, the results will not be aggregated; you may retrieve the results from a given request by providing the applicable requestId.
This operation may take some time depending on the number of addresses. You can query the discoverProcessRunning attribute to determine if the process has completed.
This operation is not standalone, but must be initiated using POST /discovery. See the documentation for POST /discovery.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Query |
requestId |
integer (int64) |
Query |
excludeManagedSystems |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Response not available |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/discovery
Request query
{
"requestId" : 0,
"excludeManagedSystems" : true
}
Example HTTP response
Response 200
{
"requestId" : "string",
"currentCount" : 0,
"total" : 0,
"lastStart" : "string",
"discoverProcessRunning" : true,
"storageSystems" : [ {
"serialNumber" : "string",
"wwn" : "string",
"label" : "string",
"firmware" : "string",
"nvsram" : "string",
"ipAddresses" : [ "string" ],
"needsAttention" : true,
"controllers" : [ {
"controllerId" : "string",
"ipAddresses" : [ "string" ],
"certificateStatus" : "string"
} ],
"supportedManagementPorts" : [ "string" ]
} ]
}
3.23.2. Discover storage-systems over a range of IP addresses
POST /devmgr/v2/discovery
Description
Initiate a discovery operation on a range of IP addresses.
This API allows you to scan a large (or small), range of IP addresses and discover E-Series systems. You submit the initial request with the POST and then request incremental results with GET /discovery. Discovering the systems doesn’t automatically place them under management. In order to place the discovered systems under management, you can add individual systems using POST /storage-systems.
Currently, only a single discovery operation may be run at a time, regardless of the number of users. If a second operation is initiated while the former is still in progress, an error status will be returned.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Discovery request accepted |
|
422 |
Invalid parameter |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/discovery
Request body
{
"startIP" : "string",
"endIP" : "string",
"useAgents" : true,
"connectionTimeout" : 30,
"maxPortsToUse" : 0
}
Example HTTP response
Response 202
{
"requestId" : "string",
"currentCount" : 0,
"total" : 0,
"lastStart" : "string",
"discoverProcessRunning" : true,
"storageSystems" : [ {
"serialNumber" : "string",
"wwn" : "string",
"label" : "string",
"firmware" : "string",
"nvsram" : "string",
"ipAddresses" : [ "string" ],
"needsAttention" : true,
"controllers" : [ {
"controllerId" : "string",
"ipAddresses" : [ "string" ],
"certificateStatus" : "string"
} ],
"supportedManagementPorts" : [ "string" ]
} ]
}
3.23.3. Cancel discovery operation
DELETE /devmgr/v2/discovery
Description
This API will allow you to cancel a running discovery operation.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Operation cancelled |
|
422 |
Error cancelling operation |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/discovery
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.23.4. Get a Folder
GET /devmgr/v2/folders/{folder-id}
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
folder-id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The folder was retrieved successfully |
|
404 |
No folders were found that matched the provided folder ID |
|
422 |
A problem occurred when attempting to retrieve the folder |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/folders/string
Example HTTP response
Response 200
{
"folderId" : "string",
"parentFolderId" : "string",
"name" : "string",
"reserved" : true,
"rules" : [ {
"ruleType" : "string",
"key" : "string",
"value" : "string"
} ],
"storageSystemIds" : [ "string" ]
}
3.23.5. Update a Folder
POST /devmgr/v2/folders/{folder-id}
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
folder-id |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The folder was successfully updated |
|
404 |
No folders were found that matched the provided folder ID |
|
422 |
A problem occurred when attempting to update the folder |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/folders/string
Request body
{
"parentId" : "string",
"name" : "string",
"rules" : [ {
"ruleType" : "string",
"key" : "string",
"value" : "string"
} ],
"storageSystemIds" : [ "string" ]
}
Example HTTP response
Response 200
{
"folderId" : "string",
"parentFolderId" : "string",
"name" : "string",
"reserved" : true,
"rules" : [ {
"ruleType" : "string",
"key" : "string",
"value" : "string"
} ],
"storageSystemIds" : [ "string" ]
}
3.23.6. Delete a Folder
DELETE /devmgr/v2/folders/{folder-id}
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
folder-id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
The folder was successfully deleted |
|
404 |
No folders were found that matched the provided folder ID |
|
422 |
A problem occurred when attempting to delete the folder |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/folders/string
3.23.7. Get StorageDevices associated with a Folder
GET /devmgr/v2/folders/{folder-id}/storage-devices
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Path |
folder-id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The storage devices were retrieved successfully |
< string > array |
404 |
No folders were found that matched the provided folder ID |
|
422 |
A problem occurred when attempting to retrieve the storage devices |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/folders/string/storage-devices
Example HTTP response
Response 200
[ "string" ]
3.23.8. Get all Folders
GET /devmgr/v2/folders
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The folders were retrieved successfully |
< Folder > array |
422 |
A problem occurred when attempting to retrieve the folders |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/folders
Example HTTP response
Response 200
{
"folderId" : "string",
"parentFolderId" : "string",
"name" : "string",
"reserved" : true,
"rules" : [ {
"ruleType" : "string",
"key" : "string",
"value" : "string"
} ],
"storageSystemIds" : [ "string" ]
} ]
3.23.9. Create a Folder
POST /devmgr/v2/folders
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The folder was successfully created |
|
422 |
A problem occurred when attempting to create the folder |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/folders
Request body
{
"parentId" : "string",
"name" : "string",
"rules" : [ {
"ruleType" : "string",
"key" : "string",
"value" : "string"
} ],
"storageSystemIds" : [ "string" ]
}
Example HTTP response
Response 200
{
"folderId" : "string",
"parentFolderId" : "string",
"name" : "string",
"reserved" : true,
"rules" : [ {
"ruleType" : "string",
"key" : "string",
"value" : "string"
} ],
"storageSystemIds" : [ "string" ]
}
3.23.10. Retrieve information about the storage system lockdown status.
GET /devmgr/v2/storage-systems/{system-id}/lockdownstatus
MetaData
x-mode = both
x-allowedRoles = [ALL_ACCESS, NO_XSRF_PROTECTION]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
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 |
Storage device not found |
|
422 |
System-id invalid, unable to process |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/lockdownstatus
Example HTTP response
Response 200
{
"isLockdown" : true,
"storageSystemLabel" : "string",
"lockdownType" : "string"
}
3.23.11. Retrieve the ObjectGraph, which contains all configuration details for the storage-system.
GET /devmgr/v2/storage-systems/{system-id}/graph
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/graph
Example HTTP response
Response 200
{
"configGeneration" : "string",
"sa" : {
"saData" : {
"needsAttention" : true,
"fixing" : true,
"saId" : {
"worldWideName" : "string"
},
"managementClassName" : "string",
"storageArrayLabel" : "string",
"bootTime" : "string",
"fwVersion" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"nvsramVersion" : "string",
"fwPrefix" : "string",
"chassisSerialNumber" : "string",
"eventConfigurationDataVersion" : "string",
"arrayAttributes" : [ 0 ],
"res4" : [ 0 ],
"res5" : [ 0 ],
"res6" : [ 0 ],
"res7" : "string",
"extendedSAData" : {
"reserved1" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ]
}
},
"safeId" : {
"worldWideName" : "string"
},
"cache" : {
"cacheBlkSize" : 0,
"demandFlushAmount" : 0,
"demandFlushThreshold" : 0,
"reserved1" : "string",
"reserved2" : "string",
"cacheMirroringProtectionInformation" : true
},
"accessVolume" : {
"enabled" : true,
"volumeHandle" : 0,
"capacity" : "string",
"accessVolumeRef" : "string",
"reserved1" : "string"
},
"featureParameters" : {
"maxHotSpares" : 0,
"cacheBlockSizes" : [ 0 ],
"maxDCEDrives" : 0,
"maxReadAheadMultiplier" : 0,
"minMediaScanPeriod" : 0,
"maxMediaScanPeriod" : 0,
"supportedSegSizes" : [ 0 ],
"numStandardSegSizes" : 0,
"segTransitions" : [ "string" ],
"mappableLUNCount" : 0,
"maxPartitionCount" : 0,
"maxMappingsPerVolume" : 0,
"maxVolumes" : 0,
"maxSnapshots" : 0,
"maxSnapshotsPerBase" : 0,
"minRepositorySize" : 0,
"maxMirrors" : 0,
"maxVolCopys" : 0,
"maxConcurrentBackgroundCopys" : 0,
"maxUtmLunValue" : 0,
"reserved1" : "string",
"reserved2" : "string",
"battery_not_in_configuration" : true,
"supportedDriveTypes" : [ "string" ],
"currentMaxMirrors" : 0,
"maxVolumesPerGroup" : 0,
"maxDriveDownloadFiles" : 0,
"maxMgmtClientRecords" : 0,
"maxMgmtClientRecordSize" : 0,
"redundancyMode" : "string",
"maxExpansionDriveTrays" : 0,
"supportedAuthMethods" : [ "string" ],
"maxIscsiIpv6LocalAddressesPerPort" : 0,
"maxIscsiIpv6RoutableAddressesPerPort" : 0,
"absoluteMaxDssSegmentSize" : 0,
"smartBatteryTechnology" : true,
"writeCachingEnabledDuringLearnCycle" : true,
"maxSSDsSupported" : 0,
"ssdInterfaceTypeMixingSupported" : true,
"maxDriveSlots" : 0,
"supportedProtectionTypes" : [ "string" ],
"supportedEventPriorities" : [ "string" ],
"maxFlashCacheSize" : "string",
"defaultMediaScanPeriod" : 0,
"maxNvmeofRoceV2Ipv6LocalAddressesPerPort" : 0,
"maxNvmeofRoceV2RoutableAddressesPerPort" : 0
},
"mediaScanPeriod" : 0,
"capabilities" : [ "string" ],
"premiumFeatures" : [ {
"capability" : "string",
"isEnabled" : true,
"isCompliant" : true,
"isWithinLimits" : true,
"featureId" : "string"
} ],
"trayPositionList" : {
"trayPosition" : [ {
"trayId" : 0,
"rackId" : 0
} ]
},
"hostPortType" : [ "string" ],
"hostSpecificVals" : [ {
"waitForDownload" : true,
"notReadySenseForQuiescenceInProgress" : true,
"notReadySenseForQuiescenceInProgress2" : true,
"checkConditionForVendorUniqueUAConditions" : true,
"reportDeferredErrors" : true,
"ignoreForceUnitAccess" : true,
"ignoreWriteCacheDisable" : true,
"allowReservationOnUnownedLUNs" : true,
"worldWideNameInStandardInquiry" : true,
"propagateHostBusResets" : true,
"reportSCCDeviceEnable" : true,
"conditionalFCLogout" : true,
"forceSCSI2" : true,
"reportUnconfiguredLUNs" : true,
"ignoreSyncCache" : true,
"ignoreUTMLunOwnership" : true,
"reportLUNPreferredPathInStandardInquiry" : true,
"autoLUNTransfer" : true,
"inquiryUnconfiguredDeviceType" : "string",
"inquiryUnownedDeviceType" : "string",
"unownedBlock0Read" : "string",
"retainLogins" : true,
"hostPortType" : "string",
"maxRestrictedLUNs" : 0,
"reserved1" : "string",
"avtExclusionExtentsEnabled" : true,
"suppressVolOffPreferredPathAlert" : true,
"hostType" : "string",
"tpgsSupported" : true,
"volumeFormatOptions" : true,
"restrictedLun0" : true,
"usePage2CQuiescenceTimeout" : true,
"asymmetricLUAccess" : true,
"ignoreISCSISessionIDInITN" : true,
"enableLUCheckConditionParallelResponses" : true,
"disableExplicitTPGS" : true,
"unownedCheckConditionDuringFWActivation" : true,
"allowPreferredOwnerReportingSuppression" : true,
"enableTargetFailback" : true,
"enableAutoLoadBalance" : true,
"quiescenceInProgressSenseKey" : 0,
"quiescenceInProgressASC" : 0,
"quiescenceInProgressASCQ" : 0,
"persistentID" : 0,
"nvmeVUFailoverSupported" : true,
"nvmeStandardFailoverSupported" : true
} ],
"compatibility" : [ {
"fwVersion" : "string",
"compatible" : true
} ],
"usageHints" : [ {
"usageHint" : "string",
"segmentSize" : 0,
"readAhead" : 0
} ],
"definedPartitionCount" : 0,
"defaultHostPortTypeIndex" : 0,
"remoteAccessID" : "string",
"remoteMirroringActive" : true,
"volXferAlertDelayPeriod" : 0,
"reserved1" : "string",
"reserved2" : "string",
"stagedFirmware" : {
"stagedFwValid" : true,
"fwVersion" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"nvsramVersion" : "string",
"timeStamp" : "string",
"nvsramVersionString" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ]
},
"unreadableSectors" : {
"count" : 0,
"maxLimit" : 0
},
"driveChannels" : [ {
"channel" : 0,
"state" : "string",
"reason" : "string",
"degradingController" : "string",
"statsControllerA" : {
"startTimeStamp" : "string",
"endTimeStamp" : "string",
"totalIoCount" : 0,
"totalIoErrorCount" : 0,
"linkStatus" : "string",
"errorCounts" : {
"nonChannelErrors" : 0,
"timeoutErrors" : 0,
"controllerDetectedErrors" : 0,
"driveDetectedErrors" : 0,
"linkDownErrors" : 0
}
},
"statsControllerB" : {
"startTimeStamp" : "string",
"endTimeStamp" : "string",
"totalIoCount" : 0,
"totalIoErrorCount" : 0,
"linkStatus" : "string",
"errorCounts" : {
"nonChannelErrors" : 0,
"timeoutErrors" : 0,
"controllerDetectedErrors" : 0,
"driveDetectedErrors" : 0,
"linkDownErrors" : 0
}
}
} ],
"portLocations" : [ {
"portRef" : "string",
"channel" : 0,
"portType" : "string",
"parentType" : {
"driveChannelParent" : "string",
"controllerRef" : "string",
"minihubRef" : "string"
}
} ],
"ddcTag" : 0,
"featureBundle" : {
"name" : "string",
"bundledFeatures" : [ {
"featureId" : "string",
"featureAttribute" : [ {
"featureAttrId" : "string",
"keyEnabled" : true,
"keyLimit" : 0,
"shippedEnabled" : true,
"shippedLimit" : 0,
"subjectToGoldKey" : true,
"supportedValues" : [ "string" ],
"evaluationDuration" : 0
} ]
} ],
"bundleSubmodelId" : "string"
},
"featureState" : [ {
"capability" : "string",
"isEnabled" : true,
"isCompliant" : true,
"isWithinLimits" : true,
"featureId" : "string",
"featureRef" : "string",
"limit" : 0,
"duration" : 0,
"enabledTime" : "string",
"supportedFeatureBundleId" : 0,
"permanentLicenseApplied" : true
} ],
"channelPortLocations" : [ {
"portRef" : "string",
"portParent" : {
"type" : "string",
"controllerRef" : "string",
"esmRef" : "string",
"minihubRef" : "string",
"hicRef" : "string"
},
"portNumber" : 0,
"channel" : 0,
"channelType" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkActive" : true,
"id" : "string"
} ],
"iscsiEntityData" : {
"icmpPingResponseEnabled" : true,
"unnamedDiscoverySessionsEnabled" : true,
"isnsServerTcpListenPort" : 0,
"ipv4IsnsServerAddressConfigMethod" : "string",
"ipv4IsnsServerAddress" : "string",
"ipv6IsnsServerAddressConfigMethod" : "string",
"ipv6IsnsServerAddress" : "string",
"isnsRegistrationState" : "string",
"isnsServerRegistrationEnabled" : true,
"hostPortsConfiguredDHCP" : true
},
"hostType" : [ "string" ],
"defaultHostTypeIndex" : 0,
"rvmControllerHostChannel" : 0,
"smartBatteryData" : {
"lastBatteryLearnCycle" : "string",
"nextBatteryLearnCycle" : "string",
"batteryLearnCycleInterval" : 0
},
"invalidSystemConfig" : true,
"securityLockKey" : true,
"lockKeyIDRef" : "string",
"syslogConfiguration" : {
"syslogEnabled" : true,
"syslogServerPortNumber" : 0,
"syslogServerIpAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
},
"securityExternalKmsEnable" : true,
"newKeySequence" : 0,
"securityExternalKmsKeyStatus" : "string",
"lockKeyNeededList" : [ "string" ],
"dplCoreDumpData" : {
"dplCoreDumpTag" : 0,
"dplCoreDumpNeedsRetrieved" : true,
"dplCoreDumpEnabled" : true,
"timeStamp" : "string"
},
"fcRVMState" : "string",
"asupEnabled" : true,
"asupOnDemandEnabled" : true,
"asupRemoteDiagsEnabled" : true,
"iocDumpData" : {
"iocDumpEnabled" : true,
"iocDumpNeedsRetrieved" : true,
"iocDumpTag" : 0,
"timeStamp" : "string"
},
"driveChannelPortDisabled" : true,
"directExpansionPortInUse" : true,
"highResolutionStatisticsEnabled" : true,
"autoLoadBalancingEnabled" : true,
"reserved3" : "string",
"embeddedExternalKMSInformation" : {
"installedKMSCertificateFile" : [ "string" ],
"kmsEndpoint" : {
"kmsAddress" : {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
},
"kmsPort" : 0
}
},
"isLun0RestrictedForDefaultPartition" : true,
"securitySettings" : {
"certificateRevocationSettings" : {
"certificateRevocationCheckEnabled" : true,
"ocspResponderAddress" : "string",
"isOCSPResponderAddressSet" : true
}
},
"parityCheckOnMediaType" : {
"enabledOnHDD" : true,
"enabledOnSSD" : true
},
"hostConnectivityReportingEnabled" : true,
"vaaienabled" : true,
"odxenabled" : true
},
"tray" : [ {
"type" : "string",
"orientation" : "string",
"numControllerSlots" : 0,
"numDriveSlots" : 0,
"trayId" : 0,
"trayRef" : "string",
"nonRedundantAccess" : true,
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufacturerDate" : "string",
"fruType" : "string",
"trayIDMismatch" : true,
"trayIDConflict" : true,
"esmVersionMismatch" : true,
"esmMiswire" : true,
"drvMHSpeedMismatch" : true,
"unsupportedTray" : true,
"workingChannel" : 0,
"maxSpeed" : "string",
"trayTechnologyType" : "string",
"esmGroupError" : true,
"uncertifiedTray" : true,
"locateTray" : true,
"esmHardwareMismatch" : true,
"hasConfigurableTrayId" : true,
"frontEndInterfaceTechnology" : "string",
"driveTechnologies" : [ "string" ],
"numDriveCompartments" : 0,
"numDriveSlotsPerCompartment" : 0,
"trayAttributes" : [ {
"attributeId" : "string",
"attributeValue" : "string"
} ],
"isMisconfigured" : true,
"esmFactoryDefaultsMismatch" : true,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"numDrawers" : 0,
"driveLayout" : {
"driveOrientation" : "string",
"numRows" : 0,
"numColumns" : 0,
"primaryTraversal" : "string",
"secondaryTraversal" : "string"
},
"factoryDefaultsData" : {
"factoryDefaultsVersion" : "string",
"isSupported" : true
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"oemPartNumber" : "string",
"id" : "string"
} ],
"componentBundle" : {
"fan" : [ {
"fanRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"reserved1" : "string",
"reserved2" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"id" : "string"
} ],
"battery" : [ {
"batteryRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"batteryAge" : 0,
"batteryLifeRemaining" : 0,
"batteryTypeData" : {
"batteryType" : "string",
"cruParentController" : "string",
"parentController" : "string"
},
"reserved1" : "string",
"reserved2" : "string",
"manufacturerDate" : "string",
"vendorName" : "string",
"vendorPN" : "string",
"vendorSN" : "string",
"fruType" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"batteryCanExpire" : true,
"automaticAgeReset" : true,
"learnCycleData" : {
"lastBatteryLearnCycle" : "string",
"nextBatteryLearnCycle" : "string",
"batteryLearnCycleInterval" : 0
},
"id" : "string"
} ],
"powerSupply" : [ {
"powerSupplyRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufacturerDate" : "string",
"fruType" : "string",
"reserved1" : "string",
"reserved2" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"firmwareRevision" : "string",
"manufacturingDeviceCode" : 0,
"id" : "string"
} ],
"thermalSensor" : [ {
"thermalSensorRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"reserved1" : "string",
"reserved2" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"id" : "string"
} ],
"esm" : [ {
"esmRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"nonRedundantAccess" : true,
"partNumber" : "string",
"serialNumber" : "string",
"manufacturerDate" : "string",
"manufacturer" : "string",
"fruType" : "string",
"softwareVersion" : "string",
"esmInterfaceData" : {
"ioInterfaceType" : "string",
"portList" : {
"ports" : [ {
"portStatus" : "string",
"portType" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ]
}
},
"productID" : "string",
"workingChannel" : 0,
"currentSpeed" : "string",
"maxSpeed" : "string",
"reserved1" : "string",
"reserved2" : "string",
"fibreEsm" : {
"esmPortRef" : "string",
"loopID" : 0,
"portRef" : "string"
},
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"esmInterfaceAttributes" : {
"ioInterfaceType" : "string",
"fibreEsmAttributes" : {
"isSwitched" : true,
"fibreEsmAddress" : {
"esmPortRef" : "string",
"loopID" : 0,
"portRef" : "string"
}
},
"sasEsmAttributes" : {
"sasExpander" : [ "string" ]
}
},
"boardId" : "string",
"factoryDefaultsData" : {
"isSupported" : true,
"factoryDefaultsVersion" : "string"
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"esmType" : "string",
"id" : "string"
} ],
"ups" : [ {
"upsRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"reserved1" : "string",
"reserved2" : "string"
} ],
"minihub" : [ {
"minihubRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"minihubData" : {
"minihubType" : "string",
"parentController" : "string"
},
"currentSpeed" : "string",
"maxSpeed" : "string",
"channel" : 0,
"portList" : {
"ports" : [ {
"portStatus" : "string",
"portType" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ]
},
"vendorName" : "string",
"partNumber" : "string",
"serialNumber" : "string",
"fruType" : "string",
"manufacturerDate" : "string",
"reserved1" : "string",
"reserved2" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
}
} ],
"gbic" : [ {
"gbicRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"gbicType" : "string",
"gbicPort" : "string",
"parentData" : {
"gbicParentType" : "string",
"controllerGBIC" : {
"controllerGBICType" : "string",
"parentController" : "string",
"channel" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"parentEsm" : "string",
"parentMinihub" : "string"
},
"reserved1" : "string",
"reserved2" : "string"
} ],
"sfp" : [ {
"sfpRef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"sfpType" : {
"sfpIdentType" : "string",
"sfpConnectType" : "string",
"sfpLinkLType" : "string",
"sfpTransmitterType" : "string",
"sfpSpeed" : [ "string" ],
"sfpTransmissionMedia" : [ "string" ],
"manufacturerDate" : "string",
"vendorName" : "string",
"vendorPN" : "string",
"vendorRev" : "string",
"vendorSN" : "string",
"vendorOUI" : "string",
"reserved1" : "string",
"reserved2" : "string"
},
"sfpPort" : "string",
"parentData" : {
"sfpParentType" : "string",
"controllerSFP" : {
"controllerSFPType" : "string",
"parentController" : "string",
"channel" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"parentEsm" : "string",
"parentMinihub" : "string"
},
"reserved1" : "string",
"reserved2" : "string",
"sfpPortRef" : "string",
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"id" : "string"
} ],
"interconnectCRU" : [ {
"interconnectCRURef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturerDate" : "string",
"vendorName" : "string",
"vendorPN" : "string",
"vendorSN" : "string",
"fruType" : "string",
"readyToRemove" : true,
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
}
} ],
"supportCRU" : [ {
"supportCRURef" : "string",
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturerDate" : "string",
"vendorName" : "string",
"vendorPN" : "string",
"vendorSN" : "string",
"fruType" : "string",
"readyToRemove" : true,
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"configuredComponents" : [ "string" ],
"type" : "string",
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"id" : "string"
} ],
"alarm" : [ {
"alarmRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"status" : "string",
"isManageable" : true,
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
}
} ],
"hostBoard" : [ {
"parentController" : "string",
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufacturerDate" : "string",
"fruType" : "string",
"hostBoardId" : "string",
"status" : "string",
"type" : "string",
"hostBoardRef" : "string",
"numberOfPorts" : 0,
"hbTypeData" : {
"type" : "string",
"dualPortIbTypeData" : {
"tcaGuid" : "string",
"queuePairsSupported" : 0,
"completionQueuesSupported" : 0,
"sharedReceiveQueuesSupported" : 0
},
"dualPortDenaliIbTypeData" : {
"tcaGuid" : "string",
"queuePairsSupported" : 0,
"completionQueuesSupported" : 0,
"sharedReceiveQueuesSupported" : 0
}
},
"oemPartNumber" : "string",
"hostBoardControllerSlot" : 0,
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"id" : "string"
} ],
"sasExpander" : [ {
"expanderRef" : "string",
"parent" : {
"expanderParentType" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentDrawer" : "string"
},
"channel" : 0,
"deviceName" : "string",
"vendorId" : "string",
"productId" : "string",
"fwVersion" : "string",
"expanderPorts" : [ {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
} ],
"domainNumber" : 0,
"id" : "string"
} ],
"cacheBackupDevice" : [ {
"backupDeviceRef" : "string",
"backupDeviceControllerSlot" : 0,
"parentController" : "string",
"backupDeviceType" : "string",
"backupDeviceStatus" : "string",
"backupDeviceVpd" : {
"manufacturer" : "string",
"manufactureDate" : "string",
"productId" : "string",
"productRevLevel" : "string",
"partNumber" : "string",
"serialNumber" : "string"
},
"backupDeviceCapacity" : 0,
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"id" : "string"
} ],
"cacheMemoryDimm" : [ {
"cacheMemoryDimmRef" : "string",
"status" : "string",
"capacityInMegabytes" : 0,
"serialNumber" : "string",
"partNumber" : "string",
"oemPartNumber" : "string",
"manufacturerPartNumber" : "string",
"manufacturer" : "string",
"manufactureDate" : "string",
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"shared" : true,
"revisionCode" : "string"
} ],
"processorMemoryDimm" : [ {
"processorMemoryDimmRef" : "string",
"parentController" : "string",
"dimmControllerSlot" : 0,
"status" : "string",
"capacityInMegabytes" : 0,
"serialNumber" : "string",
"partNumber" : "string",
"oemPartNumber" : "string",
"manufacturerPartNumber" : "string",
"manufacturer" : "string",
"manufactureDate" : "string",
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"revisionCode" : "string"
} ],
"drawer" : [ {
"drawerRef" : "string",
"isOpen" : true,
"status" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"softwareVersion" : "string",
"partNumber" : "string",
"serialNumber" : "string",
"vendorName" : "string",
"manufactureDate" : "string",
"fruType" : "string",
"drawerType" : "string",
"id" : "string"
} ]
},
"controller" : [ {
"active" : true,
"quiesced" : true,
"status" : "string",
"controllerRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"productID" : "string",
"productRevLevel" : "string",
"serialNumber" : "string",
"boardID" : "string",
"cacheMemorySize" : 0,
"processorMemorySize" : 0,
"hostInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"driveInterfaces" : [ {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
} ],
"netInterfaces" : [ {
"interfaceType" : "string",
"ethernet" : {
"interfaceName" : "string",
"channel" : 0,
"speed" : 0,
"ip" : 0,
"alias" : "string",
"macAddr" : "string",
"gatewayIp" : 0,
"subnetMask" : 0,
"bootpUsed" : true,
"rloginEnabled" : true,
"reserved1" : "string",
"setupError" : true,
"reserved2" : "string",
"interfaceRef" : "string",
"linkStatus" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortStaticRoutableAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortRoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6AddressConfigMethod" : "string",
"fullDuplex" : true,
"supportedSpeedSettings" : [ "string" ],
"configuredSpeedSetting" : "string",
"currentSpeed" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
} ],
"inventory" : [ {
"itemName" : "string",
"itemVersion" : "string"
} ],
"reserved1" : "string",
"reserved2" : "string",
"hostBoardID" : "string",
"physicalCacheMemorySize" : 0,
"readyToRemove" : true,
"boardSubmodelID" : "string",
"submodelSupported" : true,
"oemPartNumber" : "string",
"partNumber" : "string",
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"bootTime" : "string",
"modelName" : "string",
"networkSettings" : {
"ipv4DefaultRouterAddress" : "string",
"ipv6DefaultRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6CandidateDefaultRouterAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"remoteAccessEnabled" : true,
"dnsProperties" : {
"acquisitionProperties" : {
"dnsAcquisitionType" : "string",
"dnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"dhcpAcquiredDnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"ntpProperties" : {
"acquisitionProperties" : {
"ntpAcquisitionType" : "string",
"ntpServers" : [ {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
} ]
},
"dhcpAcquiredNtpServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
}
},
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"flashCacheMemorySize" : 0,
"ctrlIocDumpData" : {
"iocDumpNeedsRetrieved" : true,
"iocDumpTag" : 0,
"timeStamp" : "string"
},
"locateInProgress" : true,
"hasTrayIdentityIndicator" : true,
"controllerErrorMode" : "string",
"codeVersions" : [ {
"codeModule" : "string",
"versionString" : "string"
} ],
"id" : "string"
} ],
"drive" : [ {
"offline" : true,
"hotSpare" : true,
"invalidDriveData" : true,
"available" : true,
"pfa" : true,
"driveRef" : "string",
"status" : "string",
"cause" : "string",
"interfaceType" : {
"driveType" : "string",
"fibre" : [ {
"channel" : 0,
"loopID" : 0
} ],
"sas" : {
"deviceName" : "string",
"drivePortAddresses" : [ {
"channel" : 0,
"portIdentifier" : "string"
} ]
},
"scsi" : {
"channel" : 0,
"id" : 0
}
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"manufacturer" : "string",
"manufacturerDate" : "string",
"productID" : "string",
"serialNumber" : "string",
"softwareVersion" : "string",
"blkSize" : 0,
"usableCapacity" : "string",
"rawCapacity" : "string",
"worldWideName" : "string",
"currentVolumeGroupRef" : "string",
"sparedForDriveRef" : "string",
"mirrorDrive" : "string",
"nonRedundantAccess" : true,
"workingChannel" : 0,
"volumeGroupIndex" : 0,
"currentSpeed" : "string",
"maxSpeed" : "string",
"uncertified" : true,
"hasDegradedChannel" : true,
"degradedChannels" : [ 0 ],
"phyDriveType" : "string",
"spindleSpeed" : 0,
"rtrAttributes" : {
"cruType" : "string",
"parentCru" : {
"type" : "string",
"parentController" : "string",
"parentEsm" : "string",
"parentFan" : "string",
"parentInterconnectCru" : "string",
"parentSupportCru" : "string",
"parentDrawer" : "string"
},
"rtrAttributeData" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"reserved" : "string",
"phyDriveTypeData" : {
"phyDriveType" : "string",
"sataDriveAttributes" : {
"translatorData" : {
"vendorId" : "string",
"productId" : "string",
"productRevLevel" : "string",
"satType" : "string"
},
"ataDiskModelNumber" : "string",
"ataDiskFwRevision" : "string"
}
},
"pfaReason" : "string",
"bypassSource" : [ {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
} ],
"repairPolicy" : {
"removalData" : {
"removalMethod" : "string",
"rtrAttributes" : {
"hasReadyToRemoveIndicator" : true,
"readyToRemove" : true
}
},
"replacementMethod" : "string"
},
"fdeCapable" : true,
"fdeEnabled" : true,
"fdeLocked" : true,
"lockKeyID" : "string",
"ssdWearLife" : {
"averageEraseCountPercent" : 0,
"spareBlocksRemainingPercent" : 0,
"isWearLifeMonitoringSupported" : true,
"percentEnduranceUsed" : 0
},
"driveMediaType" : "string",
"fpgaVersion" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"protectionInformationCapable" : true,
"protectionType" : "string",
"interposerPresent" : true,
"interposerRef" : "string",
"currentCommandAgingTimeout" : 0,
"defaultCommandAgingTimeout" : 0,
"driveTemperature" : {
"currentTemp" : 0,
"refTemp" : 0
},
"blkSizePhysical" : 0,
"lowestAlignedLBA" : "string",
"removed" : true,
"locateInProgress" : true,
"fipsCapable" : true,
"id" : "string"
} ],
"volumeGroup" : [ {
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"name" : "string",
"id" : "string"
} ],
"volume" : [ {
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"name" : "string",
"id" : "string"
} ],
"freeExtent" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"dveVol" : [ {
"volume" : "string",
"amountOfIncrease" : "string"
} ],
"storagePoolBundle" : {
"saPortGroup" : [ {
"saPortGroupRef" : "string",
"label" : "string"
} ],
"saPort" : [ {
"saPortRef" : "string",
"saPortGroupRef" : "string",
"controllerRef" : "string",
"portId" : 0
} ],
"cluster" : [ {
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"protectionInformationCapableAccessMethod" : true,
"isLun0Restricted" : true,
"name" : "string",
"id" : "string"
} ],
"host" : [ {
"hostRef" : "string",
"clusterRef" : "string",
"label" : "string",
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"hostTypeIndex" : 0,
"protectionInformationCapableAccessMethod" : true,
"isLargeBlockFormatHost" : true,
"isLun0Restricted" : true,
"name" : "string",
"id" : "string"
} ],
"hostPort" : [ {
"hostPortRef" : "string",
"hostPortName" : "string",
"label" : "string",
"hostRef" : "string",
"hostPortTypeIndex" : 0,
"isSAControlled" : true,
"confirmLUNMappingCreation" : true,
"portId" : {
"ioInterfaceType" : "string",
"portName" : "string",
"ibPortName" : "string",
"iscsiPortName" : {
"initiatorNodeName" : "string",
"initiatorSessionId" : "string"
},
"sasPortName" : "string",
"nvmeInitiatorPortId" : {
"name" : "string",
"hostIdentifier" : "string",
"portIdentifier" : {
"ioInterfaceType" : "string",
"fcPortName" : "string",
"ibPortName" : "string",
"sasPortName" : "string"
}
}
},
"portInactive" : true,
"id" : "string"
} ],
"lunMapping" : [ {
"lunMappingRef" : "string",
"lun" : 0,
"ssid" : 0,
"perms" : 0,
"volumeRef" : "string",
"type" : "string",
"mapRef" : "string",
"id" : "string"
} ],
"initiator" : [ {
"initiatorRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"alias" : {
"ioInterfaceType" : "string",
"iscsiAlias" : "string"
},
"label" : "string",
"configuredAuthMethods" : {
"authMethodData" : [ {
"authMethod" : "string",
"chapSecret" : [ {
"type" : "string",
"pkcs5Data" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
},
"pkcs5AesData" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
}
} ]
} ]
},
"hostRef" : "string",
"initiatorInactive" : true,
"initiatorNodeName" : {
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"interfaceType" : "string"
},
"id" : "string"
} ],
"target" : [ {
"targetRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"alias" : {
"ioInterfaceType" : "string",
"iscsiAlias" : "string"
},
"configuredAuthMethods" : {
"authMethodData" : [ {
"authMethod" : "string",
"chapSecret" : [ {
"type" : "string",
"pkcs5Data" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
},
"pkcs5AesData" : {
"iterations" : 0,
"salt" : "string",
"cipherText" : "string"
}
} ]
} ]
},
"portals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
} ],
"remoteTarget" : [ {
"remoteRef" : "string",
"nodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"scsiinitiatorTargetBaseProperties" : {
"ioInterfaceType" : "string",
"iscsiinitiatorTargetBaseParameters" : {
"portals" : [ {
"groupTag" : 0,
"ipAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"tcpListenPort" : 0
} ]
}
}
} ]
},
"highLevelVolBundle" : {
"snapshotVol" : [ {
"worldWideName" : "string",
"snapshotRef" : "string",
"label" : "string",
"status" : "string",
"action" : "string",
"currentManager" : "string",
"baseVolume" : "string",
"repositoryVolume" : "string",
"fullWarnThreshold" : 0,
"overWarnThreshold" : true,
"repositoryFull" : true,
"repFullPolicy" : "string",
"rollbackPriority" : 0,
"extentStart" : "string",
"extentSize" : "string",
"snapshotTime" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"childrenInactive" : true,
"volumeHandle" : 0,
"mgmtClientAttribute" : 0,
"rollbackStatus" : "string",
"id" : "string"
} ],
"mirrorVol" : [ {
"worldWideName" : "string",
"mirrorProxyRef" : "string",
"volumeHandle" : 0,
"localMirrorStatus" : "string",
"remoteMirrorStatus" : "string",
"localRole" : "string",
"remoteRole" : "string",
"localPriority" : "string",
"peerPriority" : "string",
"usableCapacity" : "string",
"currentManager" : "string",
"baseVolume" : "string",
"remoteVolRef" : "string",
"action" : "string",
"reserved1" : "string",
"reserved2" : "string",
"localWriteMode" : "string",
"autoResync" : true,
"consistencyGroupRef" : "string"
} ],
"metadataVol" : [ {
"metadataVolRef" : "string",
"metadataVolType" : "string",
"associatedVolume" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"offline" : true,
"reserved1" : "string"
} ],
"remoteVol" : [ {
"worldWideName" : "string",
"remoteVolRef" : "string",
"manager" : "string",
"remoteArrayId" : {
"worldWideName" : "string"
},
"remoteNodeWWN" : "string",
"remoteVolWWN" : "string",
"remoteVolUserLabel" : "string",
"remoteVolState" : "string",
"remoteVolCapacity" : "string",
"volumeHandle" : 0,
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"reserved1" : "string",
"reserved2" : "string",
"remoteNodeName" : {
"ioInterfaceType" : "string",
"iscsiNodeName" : "string",
"remoteNodeWWN" : "string",
"nvmeNodeName" : "string"
},
"remoteVolSecurityType" : "string"
} ],
"volumeCopy" : [ {
"worldWideName" : "string",
"volcopyHandle" : 0,
"volcopyRef" : "string",
"status" : "string",
"sourceVolume" : "string",
"targetVolume" : "string",
"currentManager" : "string",
"idleTargetWriteProt" : true,
"copyCompleteTime" : "string",
"copyStartTime" : "string",
"copyPriority" : "string",
"reserved1" : "string",
"cloneCopy" : true,
"pgRef" : "string",
"id" : "string"
} ],
"pitGroup" : [ {
"pitGroupRef" : "string",
"label" : "string",
"status" : "string",
"baseVolume" : "string",
"repositoryVolume" : "string",
"clusterSize" : 0,
"maxRepositoryCapacity" : "string",
"maxBaseCapacity" : "string",
"unusableRepositoryCapacity" : "string",
"repFullPolicy" : "string",
"fullWarnThreshold" : 0,
"autoDeleteLimit" : 0,
"action" : "string",
"rollbackStatus" : "string",
"rollbackPriority" : "string",
"consistencyGroup" : true,
"consistencyGroupRef" : "string",
"creationPendingStatus" : "string",
"volumeHandle" : 0,
"name" : "string",
"id" : "string"
} ],
"pit" : [ {
"pitRef" : "string",
"pitGroupRef" : "string",
"creationMethod" : "string",
"pitTimestamp" : "string",
"pitSequenceNumber" : "string",
"status" : "string",
"activeCOW" : true,
"isRollbackSource" : true,
"pitCapacity" : "string",
"repositoryCapacityUtilization" : "string",
"id" : "string"
} ],
"pitView" : [ {
"viewRef" : "string",
"worldWideName" : "string",
"baseVol" : "string",
"basePIT" : "string",
"boundToPIT" : true,
"accessMode" : "string",
"label" : "string",
"status" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"repositoryVolume" : "string",
"fullWarnThreshold" : 0,
"viewTime" : "string",
"viewSequenceNumber" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"volumeHandle" : 0,
"clusterSize" : 0,
"maxRepositoryCapacity" : "string",
"unusableRepositoryCapacity" : "string",
"membership" : {
"viewType" : "string",
"cgViewRef" : "string"
},
"mgmtClientAttribute" : 0,
"offline" : true,
"extendedUniqueIdentifier" : "string",
"name" : "string",
"id" : "string"
} ],
"pitConsistencyGroup" : [ {
"cgRef" : "string",
"label" : "string",
"repFullPolicy" : "string",
"fullWarnThreshold" : 0,
"autoDeleteLimit" : 0,
"rollbackPriority" : "string",
"uniqueSequenceNumber" : [ "string" ],
"creationPendingStatus" : "string",
"name" : "string",
"id" : "string"
} ],
"concatVolume" : [ {
"concatVolRef" : "string",
"status" : "string",
"memberCount" : 0,
"aggregateCapacity" : "string",
"mediaScanParams" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeHandle" : 0,
"allowedOperations" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"id" : "string"
} ],
"concatVolMember" : [ {
"memberRef" : "string",
"concatVolRef" : "string",
"storageVolumeRef" : "string",
"parentIndex" : 0
} ],
"pitConsistencyGroupView" : [ {
"cgViewRef" : "string",
"groupRef" : "string",
"label" : "string",
"viewTime" : "string",
"viewSequenceNumber" : "string",
"name" : "string",
"id" : "string"
} ],
"thinVolume" : [ {
"volumeHandle" : 0,
"worldWideName" : "string",
"label" : "string",
"allocationGranularity" : 0,
"capacity" : "string",
"reconPriority" : 0,
"volumeRef" : "string",
"status" : "string",
"repositoryRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"maxVirtualCapacity" : "string",
"initialProvisionedCapacity" : "string",
"currentProvisionedCapacity" : "string",
"provisionedCapacityQuota" : "string",
"growthAlertThreshold" : 0,
"expansionPolicy" : "string",
"volumeCache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"offline" : true,
"reportingPolicy" : "string",
"extendedUniqueIdentifier" : "string",
"id" : "string"
} ],
"asyncMirrorGroup" : [ {
"groupRef" : "string",
"worldWideName" : "string",
"label" : "string",
"groupState" : "string",
"localRole" : "string",
"remoteRole" : "string",
"roleChangeProgress" : "string",
"syncIntervalMinutes" : 0,
"syncCompletionTimeAlertThresholdMinutes" : 0,
"recoveryPointAgeAlertThresholdMinutes" : 0,
"repositoryUtilizationWarnThreshold" : 0,
"mirrorChannelRemoteTarget" : "string",
"syncActivity" : "string",
"orphanGroup" : true
} ],
"asyncMirrorGroupMember" : [ {
"memberRef" : "string",
"mirrorGroup" : "string",
"localVolume" : "string",
"remoteVolume" : "string",
"memberState" : "string",
"lastRecoveryPointTime" : "string",
"overUtilizationWarnThreshold" : true,
"mirroredLocalCapacity" : "string",
"repositoryVolume" : "string",
"worldWideName" : "string",
"volumeHandle" : 0,
"repositoryFull" : true,
"id" : "string"
} ],
"asyncMirrorGroupIncompleteMember" : [ {
"memberRef" : "string",
"groupRef" : "string",
"primaryVolWWN" : "string",
"primaryVolCapacity" : "string",
"primaryVolRAIDLevel" : "string",
"primaryVolProtectionType" : "string",
"primaryVolSecurityType" : "string",
"primaryVolUserLabel" : "string",
"orphanIncompleteMember" : true,
"primaryVolumeParameters" : {
"volumeType" : "string",
"capacityProvisioningDetails" : {
"capacityQuota" : "string",
"growthAlertThreshold" : 0,
"repositoryExpansionPolicy" : "string"
}
},
"primaryVolSecurityLevel" : "string"
} ]
},
"ghostVolBundle" : {
"ghostVol" : [ {
"worldWideName" : "string",
"volumeRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ]
},
"consistencyGroupBundle" : {
"consistencyGroup" : [ {
"groupRef" : "string"
} ]
},
"ioInterface" : [ {
"interfaceRef" : "string",
"channelType" : "string",
"ioInterfaceTypeData" : {
"interfaceType" : "string",
"fibre" : {
"channel" : 0,
"loopID" : 0,
"speed" : 0,
"hardAddress" : 0,
"nodeName" : "string",
"portName" : "string",
"portId" : "string",
"topology" : "string",
"part" : "string",
"revision" : 0,
"chanMiswire" : true,
"esmMiswire" : true,
"linkStatus" : "string",
"isDegraded" : true,
"speedControl" : "string",
"maxSpeed" : 0,
"speedNegError" : true,
"reserved1" : "string",
"reserved2" : "string",
"ddsChannelState" : 0,
"ddsStateReason" : 0,
"ddsStateWho" : 0,
"isLocal" : true,
"channelPorts" : [ {
"speedDetError" : true,
"manuallyBypassed" : true,
"portNumber" : "string"
} ],
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"isTrunkCapable" : true,
"trunkMiswire" : true,
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"ib" : {
"interfaceRef" : "string",
"channel" : 0,
"channelPortRef" : "string",
"localIdentifier" : 0,
"globalIdentifier" : "string",
"linkState" : "string",
"portState" : "string",
"maximumTransmissionUnit" : 0,
"currentSpeed" : "string",
"supportedSpeed" : [ "string" ],
"currentLinkWidth" : "string",
"supportedLinkWidth" : [ "string" ],
"currentDataVirtualLanes" : 0,
"maximumDataVirtualLanes" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isSRPSupported" : true,
"isISERSupported" : true,
"physPortState" : "string",
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"isNVMeSupported" : true,
"id" : "string"
},
"iscsi" : {
"channel" : 0,
"channelPortRef" : "string",
"tcpListenPort" : 0,
"ipv4Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"interfaceRef" : "string",
"ipv6Enabled" : true,
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"isIPv6Capable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sas" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"part" : "string",
"revision" : 0,
"isDegraded" : true,
"iocPort" : {
"parent" : {
"type" : "string",
"controller" : "string",
"drive" : "string",
"expander" : "string",
"hostBoardRef" : "string"
},
"attachedDevice" : {
"channel" : 0,
"channelType" : "string",
"sasAttachedDeviceData" : {
"type" : "string",
"alternateController" : "string",
"drive" : "string",
"expander" : "string",
"remoteHostPortAddress" : "string",
"localController" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
},
"state" : "string",
"miswireType" : "string",
"channelPortRef" : "string",
"sasPhys" : [ {
"phyIdentifier" : 0,
"isOperational" : true
} ],
"portTypeData" : {
"portType" : "string",
"portIdentifier" : "string",
"routingType" : "string"
},
"portMode" : "string",
"domainNumber" : 0,
"attachedChannelPortRef" : "string",
"discoveryStatus" : 0
},
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
},
"sata" : {
"channel" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"speedControl" : "string",
"part" : "string",
"revision" : 0,
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"id" : "string"
},
"scsi" : {
"channel" : 0,
"scsiID" : 0,
"speed" : 0,
"scsiType" : "string",
"width" : 0,
"part" : "string",
"revision" : 0,
"reserved1" : "string",
"reserved2" : "string"
},
"couplingDriverNvme" : {
"interfaceRef" : "string",
"channel" : 0,
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string"
},
"ethernet" : {
"interfaceRef" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"channel" : 0,
"channelPortRef" : "string",
"interfaceData" : {
"type" : "string",
"ethernetData" : {
"partData" : {
"vendorName" : "string",
"partNumber" : "string",
"revisionNumber" : "string",
"serialNumber" : "string"
},
"macAddress" : "string",
"fullDuplex" : true,
"maximumFramePayloadSize" : 0,
"currentInterfaceSpeed" : "string",
"maximumInterfaceSpeed" : "string",
"linkStatus" : "string",
"supportedInterfaceSpeeds" : [ "string" ],
"autoconfigSupport" : true,
"copperCableDiagnosticsSupport" : true,
"operationalInterfaceSpeed" : "string"
},
"infinibandData" : {
"isIser" : true
}
},
"protectionInformationCapable" : true,
"oneWayMaxRate" : "string",
"bidirectionalMaxRate" : "string",
"id" : "string"
}
},
"controllerRef" : "string",
"commandProtocolPropertiesList" : {
"commandProtocolProperties" : [ {
"commandProtocol" : "string",
"nvmeProperties" : {
"commandSet" : "string",
"nvmeofProperties" : {
"provider" : "string",
"ibProperties" : {
"ipAddressData" : {
"addressType" : "string",
"ipv4Data" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
},
"ipv6Data" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
}
},
"listeningPort" : 0
},
"roceV2Properties" : {
"ipv4Enabled" : true,
"ipv6Enabled" : true,
"ipv4Data" : {
"ipv4Address" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv4OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv4VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv4AddressData" : {
"configState" : "string",
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4GatewayAddress" : "string"
}
},
"ipv6Data" : {
"ipv6LocalAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6RoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6PortRouterAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6AddressConfigMethod" : "string",
"ipv6OutboundPacketPriority" : {
"isEnabled" : true,
"value" : 0
},
"ipv6VlanId" : {
"isEnabled" : true,
"value" : 0
},
"ipv6HopLimit" : 0,
"ipv6NdReachableTime" : 0,
"ipv6NdRetransmitTime" : 0,
"ipv6NdStaleTimeout" : 0,
"ipv6DuplicateAddressDetectionAttempts" : 0
},
"listeningPort" : 0
}
}
}
} ]
}
} ],
"networkInterface" : [ {
"interfaceRef" : "string",
"channelType" : "string",
"netInterfaceTypeData" : {
"interfaceType" : "string",
"ethernet" : {
"interfaceName" : "string",
"channel" : 0,
"speed" : 0,
"ip" : 0,
"alias" : "string",
"macAddr" : "string",
"gatewayIp" : 0,
"subnetMask" : 0,
"bootpUsed" : true,
"rloginEnabled" : true,
"reserved1" : "string",
"setupError" : true,
"reserved2" : "string",
"interfaceRef" : "string",
"linkStatus" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortStaticRoutableAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortRoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6AddressConfigMethod" : "string",
"fullDuplex" : true,
"supportedSpeedSettings" : [ "string" ],
"configuredSpeedSetting" : "string",
"currentSpeed" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
}
}
}
} ],
"lockKeyIDs" : [ {
"lockKeyIDRef" : "string",
"lockKeyID" : "string"
} ],
"interposer" : [ {
"interposerRef" : "string",
"interposerTypeData" : {
"interposerType" : "string",
"fcSasInterposer" : {
"vendorID" : "string",
"productID" : "string",
"revision" : "string",
"deviceWWN" : "string",
"serialNumber" : "string",
"partNumber" : "string",
"driveFwVersion" : "string"
},
"reserved" : "string"
}
} ],
"ioInterfaceHicMap" : [ {
"interfaceRef" : "string",
"hostBoardRef" : "string"
} ],
"schedule" : [ {
"schedRef" : "string",
"scheduleStatus" : "string",
"action" : "string",
"targetObject" : "string",
"schedule" : {
"calendar" : {
"scheduleMethod" : "string",
"daily" : {
"dailySchedule" : {
"timeOfDay" : 0,
"everyNMinutes" : 0,
"timesPerDay" : 0
}
},
"weekly" : {
"daysOfWeek" : [ "string" ],
"dailySchedule" : {
"timeOfDay" : 0,
"everyNMinutes" : 0,
"timesPerDay" : 0
}
},
"monthlyByDate" : {
"daysOfMonth" : [ "string" ],
"monthsOfYear" : [ "string" ],
"dailySchedule" : {
"timeOfDay" : 0,
"everyNMinutes" : 0,
"timesPerDay" : 0
}
},
"monthlyByDay" : {
"dayOfWeek" : "string",
"dailySchedule" : {
"timeOfDay" : 0,
"everyNMinutes" : 0,
"timesPerDay" : 0
},
"weekNumber" : 0,
"monthsOfYear" : [ "string" ]
}
},
"startDate" : "string",
"recurrence" : {
"recurrenceType" : "string",
"recurrenceCount" : 0,
"recurrenceEndDate" : "string"
},
"timezone" : {
"tzLabel" : "string",
"tzOffset" : 0,
"dstStart" : {
"time" : 0,
"clockMode" : "string",
"month" : 0,
"dayOfMonth" : 0,
"dayOfWeek" : 0
},
"dstEnd" : {
"time" : 0,
"clockMode" : "string",
"month" : 0,
"dayOfMonth" : 0,
"dayOfWeek" : 0
},
"dstAdjust" : 0
}
},
"creationTime" : "string",
"lastRunTime" : "string",
"nextRunTime" : "string",
"stopTime" : "string",
"id" : "string"
} ],
"remoteArray" : [ {
"remoteArrayRef" : "string",
"saId" : {
"worldWideName" : "string"
},
"remoteTargets" : [ "string" ]
} ],
"flashCacheBundle" : {
"flashCacheMap" : [ {
"flashCache" : "string",
"cachedVolume" : "string",
"flashCacheMapRef" : "string",
"id" : "string"
} ],
"flashCache" : [ {
"wwn" : "string",
"flashCacheRef" : "string",
"flashCacheBase" : {
"label" : "string",
"status" : "string",
"configType" : "string",
"analyticsStatus" : "string",
"analyticsCause" : "string",
"statusCause" : "string"
},
"fcDriveInfo" : {
"flashCacheType" : "string",
"fcWithDrives" : {
"securityType" : "string",
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"usedCapacity" : "string",
"securityLevel" : "string"
}
},
"id" : "string"
} ]
},
"snmpBundle" : {
"community" : [ {
"communityRef" : "string",
"communityName" : "string",
"communityPermissions" : "string"
} ],
"trapDestination" : [ {
"trapDestinationRef" : "string",
"trapReceiverIpAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
},
"communityRef" : "string",
"sendAuthenticationFailureTraps" : true
} ],
"systemVariables" : {
"sysName" : "string",
"sysContact" : "string",
"sysLocation" : "string"
}
},
"applicationAwarenessBundle" : {
"keyValueTag" : [ {
"keyValueTagRef" : "string",
"key" : "string",
"value" : "string"
} ],
"keyValueTagMapping" : [ {
"keyValueTagRef" : "string",
"associatedObject" : {
"objectType" : "string",
"volume" : "string",
"workload" : "string"
},
"mappingRef" : "string"
} ],
"workload" : [ {
"workloadRef" : "string",
"description" : "string"
} ],
"workloadVolumeMapping" : [ {
"mappingRef" : "string",
"workloadRef" : "string",
"volumeRef" : "string"
} ]
}
}
3.23.12. Retrieve one or more elements from the ObjectGraph using an XPath expression.
GET /devmgr/v2/storage-systems/{system-id}/graph/xpath-filter
Description
This method is used to query the ObjectGraph for one or more elements. <br/> <b>Examples:</b> <br/> <ul><li>Retrieve the list of drives: /drive </li> <li>Locate all instances of an attribute called "id": //id </li> <li>Find a thinVolume with an id of "1": /highLevelVolBundle/thinVolume[id="1"]</li><li>Find all thin volumes and volumes inefficiently: //volume | //thinVolume</li><li>Get the NSVRAM version from saData: /sa/saData/nvsramVersion</li></ul><b>References: </b> http://www.w3schools.com/xml/xpath_intro.asp
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
query |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successful |
< object > array |
203 |
StorageDevice could not be contacted, this is the most recent data we have. |
< object > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice is offline with no cached data |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/graph/xpath-filter
Request query
{
"query" : "string"
}
Example HTTP response
Response 200
[ "object" ]
Response 203
[ "object" ]
3.23.13. Get the password status of the StorageDevice
GET /devmgr/v2/storage-systems/{system-id}/passwords
MetaData
x-mode = both
x-allowedRoles = [ALL_ACCESS, NO_XSRF_PROTECTION]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/passwords
Example HTTP response
Response 200
{
"adminPasswordSet" : true,
"readOnlyPasswordSet" : true
}
3.23.14. Set the password of the StorageDevice
POST /devmgr/v2/storage-systems/{system-id}/passwords
MetaData
x-mode = both
x-allowedRoles = [root.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Body |
body |
|||
Header |
x-netapp-password-validate-method |
enum (none, simple, complex) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/passwords
Request body
{
"currentAdminPassword" : "string",
"adminPassword" : true,
"newPassword" : "string"
}
Request header
"string"
3.23.15. Enable a premium feature.
POST /devmgr/v2/storage-systems/{system-id}/premium-feature
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
FormData |
keyFile |
The premium feature key file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
422 |
An unexpected error occurred applying the premium feature key. |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/premium-feature
Request formData
"file"
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.23.16. Remove a premium feature.
DELETE /devmgr/v2/storage-systems/{system-id}/premium-feature
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Query |
capability |
Capability to remove. |
enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, containerBasedApplication, __UNDEFINED) |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Removal was successful |
|
422 |
An unexpected error occurred removing the feature key. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/premium-feature
Request query
{
"capability" : "string"
}
3.23.17. Enable a feature pack.
POST /devmgr/v2/storage-systems/{system-id}/feature-pack
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
FormData |
keyFile |
The bundle key file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
422 |
An unexpected error occurred applying the bundle key file. |
Consumes
-
multipart/form-data
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/feature-pack
Request formData
"file"
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.23.18. Remove all feature packs.
DELETE /devmgr/v2/storage-systems/{system-id}/feature-pack
Description
Warning
|
Removal of feature packs is an offline operation. Failure to quiesce IO prior to performing this operation may result in loss of access to data or loss of data. |
When used in embedded mode a client may not receive a response from this operation.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Removal was successful |
|
422 |
An unexpected error occurred removing the bundle keys. |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/feature-pack
3.23.19. Set the name of the StorageDevice
POST /devmgr/v2/storage-systems/{system-id}/configuration
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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/configuration
Request body
{
"name" : "string"
}
Example HTTP response
Response 200
{
"name" : "string"
}
3.23.20. Get the list of ethernet interfaces
GET /devmgr/v2/storage-systems/{system-id}/configuration/ethernet-interfaces
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< ManagementInterface > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/configuration/ethernet-interfaces
Example HTTP response
Response 200
{
"interfaceName" : "string",
"channel" : 0,
"speed" : 0,
"ip" : 0,
"alias" : "string",
"macAddr" : "string",
"gatewayIp" : 0,
"subnetMask" : 0,
"bootpUsed" : true,
"rloginEnabled" : true,
"reserved1" : "string",
"setupError" : true,
"reserved2" : "string",
"interfaceRef" : "string",
"linkStatus" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortStaticRoutableAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortRoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6AddressConfigMethod" : "string",
"fullDuplex" : true,
"supportedSpeedSettings" : [ "string" ],
"configuredSpeedSetting" : "string",
"currentSpeed" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"ipv4GatewayAddress" : "string",
"controllerRef" : "string",
"controllerSlot" : 0,
"dnsProperties" : {
"acquisitionProperties" : {
"dnsAcquisitionType" : "string",
"dnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"dhcpAcquiredDnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"ntpProperties" : {
"acquisitionProperties" : {
"ntpAcquisitionType" : "string",
"ntpServers" : [ {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
} ]
},
"dhcpAcquiredNtpServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"id" : "string"
} ]
3.23.21. Configure the ethernet management connections on a controller
POST /devmgr/v2/storage-systems/{system-id}/configuration/ethernet-interfaces
Description
Update the ethernet management connection configuration.
This operation can lead to an inaccessible controller if performed incorrectly or if incorrect ip addresses, gateway addresses, etc, are provided. Configuration is performed by connecting to the alternate controller, so it must be accessible for the operation to succeed.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Request completed successfully |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/configuration/ethernet-interfaces
Request body
{
"controllerRef" : "string",
"enableRemoteAccess" : true,
"ipv4GatewayAddress" : "string",
"ipv6GatewayAddress" : "string",
"ipv6StaticRoutableAddress" : "string",
"interfaceRef" : "string",
"interfaceName" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : "string",
"ipv6AddressConfigMethod" : "string",
"speedSetting" : "string",
"dnsAcquisitionDescriptor" : {
"dnsAcquisitionType" : "string",
"dnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"ntpAcquisitionDescriptor" : {
"ntpAcquisitionType" : "string",
"ntpServers" : [ {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
} ]
}
}
Example HTTP response
Response 200
{
"interfaceName" : "string",
"channel" : 0,
"speed" : 0,
"ip" : 0,
"alias" : "string",
"macAddr" : "string",
"gatewayIp" : 0,
"subnetMask" : 0,
"bootpUsed" : true,
"rloginEnabled" : true,
"reserved1" : "string",
"setupError" : true,
"reserved2" : "string",
"interfaceRef" : "string",
"linkStatus" : "string",
"ipv4Enabled" : true,
"ipv4Address" : "string",
"ipv4SubnetMask" : "string",
"ipv4AddressConfigMethod" : "string",
"ipv6Enabled" : true,
"ipv6LocalAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortStaticRoutableAddress" : {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
},
"ipv6PortRoutableAddresses" : [ {
"address" : "string",
"addressState" : {
"addressType" : "string",
"interfaceAddressState" : "string",
"routerAddressState" : "string"
}
} ],
"ipv6AddressConfigMethod" : "string",
"fullDuplex" : true,
"supportedSpeedSettings" : [ "string" ],
"configuredSpeedSetting" : "string",
"currentSpeed" : "string",
"physicalLocation" : {
"trayRef" : "string",
"slot" : 0,
"locationParent" : {
"refType" : "string",
"controllerRef" : "string",
"symbolRef" : "string",
"typedReference" : {
"componentType" : "string",
"symbolRef" : "string"
}
},
"locationPosition" : 0,
"label" : "string"
},
"ipv4GatewayAddress" : "string",
"controllerRef" : "string",
"controllerSlot" : 0,
"dnsProperties" : {
"acquisitionProperties" : {
"dnsAcquisitionType" : "string",
"dnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"dhcpAcquiredDnsServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"ntpProperties" : {
"acquisitionProperties" : {
"ntpAcquisitionType" : "string",
"ntpServers" : [ {
"addrType" : "string",
"domainName" : "string",
"ipvxAddress" : {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
}
} ]
},
"dhcpAcquiredNtpServers" : [ {
"addressType" : "string",
"ipv4Address" : "string",
"ipv6Address" : "string"
} ]
},
"id" : "string"
}
3.23.22. Get list of storage-systems
GET /devmgr/v2/storage-systems
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< StorageSystemResponse > array |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"wwn" : "string",
"passwordStatus" : "string",
"passwordSet" : true,
"status" : "string",
"certificateStatus" : "string",
"ip1" : "string",
"ip2" : "string",
"managementPaths" : [ "string" ],
"controllers" : [ {
"controllerId" : "string",
"ipAddresses" : [ "string" ],
"certificateStatus" : "string"
} ],
"driveCount" : 0,
"trayCount" : 0,
"traceEnabled" : true,
"types" : "string",
"model" : "string",
"metaTags" : [ {
"key" : "string",
"valueList" : [ "string" ]
} ],
"hotSpareSize" : "string",
"usedPoolSpace" : "string",
"freePoolSpace" : "string",
"unconfiguredSpace" : "string",
"driveTypes" : [ "string" ],
"hostSpareCountInStandby" : 0,
"hotSpareCount" : 0,
"hostSparesUsed" : 0,
"bootTime" : "string",
"fwVersion" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"nvsramVersion" : "string",
"chassisSerialNumber" : "string",
"accessVolume" : {
"enabled" : true,
"volumeHandle" : 0,
"capacity" : "string",
"accessVolumeRef" : "string",
"reserved1" : "string",
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
},
"unconfiguredSpaceByDriveType" : {
"string" : "string"
},
"mediaScanPeriod" : 0,
"driveChannelPortDisabled" : true,
"recoveryModeEnabled" : true,
"autoLoadBalancingEnabled" : true,
"hostConnectivityReportingEnabled" : true,
"remoteMirroringEnabled" : true,
"fcRemoteMirroringState" : "string",
"asupEnabled" : true,
"securityKeyEnabled" : true,
"externalKeyEnabled" : true,
"lastContacted" : "string",
"definedPartitionCount" : 0,
"simplexModeEnabled" : true,
"supportedManagementPorts" : [ "string" ],
"freePoolSpaceAsString" : "string",
"hotSpareSizeAsString" : "string",
"unconfiguredSpaceAsStrings" : "string",
"usedPoolSpaceAsString" : "string"
} ]
3.23.23. Add a storage-system
POST /devmgr/v2/storage-systems
Description
This endpoint allows you to add additional storage-systems under management using their IP address[es].
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
storage-system already exists |
|
201 |
storage-system added successfully |
|
422 |
Could not connect to storage system |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems
Request body
{
"id" : "string",
"controllerAddresses" : [ "string" ],
"acceptCertificate" : true,
"validate" : true,
"password" : "string",
"wwn" : "string",
"enableTrace" : true,
"metaTags" : [ {
"key" : "string",
"valueList" : [ "string" ]
} ]
}
Example HTTP response
Response 200
{
"id" : "string",
"alreadyExists" : true
}
Response 201
{
"id" : "string",
"alreadyExists" : true
}
3.23.24. Get a specific storage-system
GET /devmgr/v2/storage-systems/{system-id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"wwn" : "string",
"passwordStatus" : "string",
"passwordSet" : true,
"status" : "string",
"certificateStatus" : "string",
"ip1" : "string",
"ip2" : "string",
"managementPaths" : [ "string" ],
"controllers" : [ {
"controllerId" : "string",
"ipAddresses" : [ "string" ],
"certificateStatus" : "string"
} ],
"driveCount" : 0,
"trayCount" : 0,
"traceEnabled" : true,
"types" : "string",
"model" : "string",
"metaTags" : [ {
"key" : "string",
"valueList" : [ "string" ]
} ],
"hotSpareSize" : "string",
"usedPoolSpace" : "string",
"freePoolSpace" : "string",
"unconfiguredSpace" : "string",
"driveTypes" : [ "string" ],
"hostSpareCountInStandby" : 0,
"hotSpareCount" : 0,
"hostSparesUsed" : 0,
"bootTime" : "string",
"fwVersion" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"nvsramVersion" : "string",
"chassisSerialNumber" : "string",
"accessVolume" : {
"enabled" : true,
"volumeHandle" : 0,
"capacity" : "string",
"accessVolumeRef" : "string",
"reserved1" : "string",
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
},
"unconfiguredSpaceByDriveType" : {
"string" : "string"
},
"mediaScanPeriod" : 0,
"driveChannelPortDisabled" : true,
"recoveryModeEnabled" : true,
"autoLoadBalancingEnabled" : true,
"hostConnectivityReportingEnabled" : true,
"remoteMirroringEnabled" : true,
"fcRemoteMirroringState" : "string",
"asupEnabled" : true,
"securityKeyEnabled" : true,
"externalKeyEnabled" : true,
"lastContacted" : "string",
"definedPartitionCount" : 0,
"simplexModeEnabled" : true,
"supportedManagementPorts" : [ "string" ],
"freePoolSpaceAsString" : "string",
"hotSpareSizeAsString" : "string",
"unconfiguredSpaceAsStrings" : "string",
"usedPoolSpaceAsString" : "string"
}
3.23.25. Update a storage-system
POST /devmgr/v2/storage-systems/{system-id}
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
updateRequest |
Update request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string
Request body
{
"acceptCertificate" : true,
"storedPassword" : "string",
"metaTags" : [ {
"key" : "string",
"valueList" : [ "string" ]
} ],
"removeAllTags" : true,
"enableTrace" : true,
"controllerAddresses" : [ "string" ]
}
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"wwn" : "string",
"passwordStatus" : "string",
"passwordSet" : true,
"status" : "string",
"certificateStatus" : "string",
"ip1" : "string",
"ip2" : "string",
"managementPaths" : [ "string" ],
"controllers" : [ {
"controllerId" : "string",
"ipAddresses" : [ "string" ],
"certificateStatus" : "string"
} ],
"driveCount" : 0,
"trayCount" : 0,
"traceEnabled" : true,
"types" : "string",
"model" : "string",
"metaTags" : [ {
"key" : "string",
"valueList" : [ "string" ]
} ],
"hotSpareSize" : "string",
"usedPoolSpace" : "string",
"freePoolSpace" : "string",
"unconfiguredSpace" : "string",
"driveTypes" : [ "string" ],
"hostSpareCountInStandby" : 0,
"hotSpareCount" : 0,
"hostSparesUsed" : 0,
"bootTime" : "string",
"fwVersion" : "string",
"appVersion" : "string",
"bootVersion" : "string",
"nvsramVersion" : "string",
"chassisSerialNumber" : "string",
"accessVolume" : {
"enabled" : true,
"volumeHandle" : 0,
"capacity" : "string",
"accessVolumeRef" : "string",
"reserved1" : "string",
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
},
"unconfiguredSpaceByDriveType" : {
"string" : "string"
},
"mediaScanPeriod" : 0,
"driveChannelPortDisabled" : true,
"recoveryModeEnabled" : true,
"autoLoadBalancingEnabled" : true,
"hostConnectivityReportingEnabled" : true,
"remoteMirroringEnabled" : true,
"fcRemoteMirroringState" : "string",
"asupEnabled" : true,
"securityKeyEnabled" : true,
"externalKeyEnabled" : true,
"lastContacted" : "string",
"definedPartitionCount" : 0,
"simplexModeEnabled" : true,
"supportedManagementPorts" : [ "string" ],
"freePoolSpaceAsString" : "string",
"hotSpareSizeAsString" : "string",
"unconfiguredSpaceAsStrings" : "string",
"usedPoolSpaceAsString" : "string"
}
3.23.26. Remove one or more storage-systems
DELETE /devmgr/v2/storage-systems/{system-id}
Description
The path is a comma-separated list of IDs. The identifiers of any storage-systems were failed to remove are provided in the response error response.
MetaData
x-mode = proxy
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
storage-system removed without error |
|
422 |
1 or more storage-system removed failed with an error |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string
Example HTTP response
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.23.27. Validate the stored password for a storage-system
POST /devmgr/v2/storage-systems/{system-id}/validatePassword
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
The password was successfully validated |
|
422 |
The password validation failed because the password was invalid |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/validatePassword
3.23.28. Get StorageDevice capabilities.
GET /devmgr/v2/storage-systems/{system-id}/capabilities
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin, support.admin, security.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/capabilities
Example HTTP response
Response 200
{
"featureBundle" : {
"name" : "string",
"bundledFeatures" : [ {
"featureId" : "string",
"featureAttribute" : [ {
"featureAttrId" : "string",
"keyEnabled" : true,
"keyLimit" : 0,
"shippedEnabled" : true,
"shippedLimit" : 0,
"subjectToGoldKey" : true,
"supportedValues" : [ "string" ],
"evaluationDuration" : 0
} ]
} ],
"bundleSubmodelId" : "string"
},
"capabilities" : [ "string" ],
"productCapabilities" : [ "string" ],
"featureStates" : [ {
"capability" : "string",
"isEnabled" : true,
"isCompliant" : true,
"isWithinLimits" : true,
"featureId" : "string",
"featureRef" : "string",
"limit" : 0,
"duration" : 0,
"enabledTime" : "string",
"supportedFeatureBundleId" : 0,
"permanentLicenseApplied" : true
} ],
"storageSystemAttributes" : {
"isLun0RestrictedForDefaultPartition" : true
},
"featureParameters" : {
"maxHotSpares" : 0,
"cacheBlockSizes" : [ 0 ],
"maxDCEDrives" : 0,
"maxReadAheadMultiplier" : 0,
"minMediaScanPeriod" : 0,
"maxMediaScanPeriod" : 0,
"supportedSegSizes" : [ 0 ],
"numStandardSegSizes" : 0,
"segTransitions" : [ "string" ],
"mappableLUNCount" : 0,
"maxPartitionCount" : 0,
"maxMappingsPerVolume" : 0,
"maxVolumes" : 0,
"maxSnapshots" : 0,
"maxSnapshotsPerBase" : 0,
"minRepositorySize" : 0,
"maxMirrors" : 0,
"maxVolCopys" : 0,
"maxConcurrentBackgroundCopys" : 0,
"maxUtmLunValue" : 0,
"reserved1" : "string",
"reserved2" : "string",
"battery_not_in_configuration" : true,
"supportedDriveTypes" : [ "string" ],
"currentMaxMirrors" : 0,
"maxVolumesPerGroup" : 0,
"maxDriveDownloadFiles" : 0,
"maxMgmtClientRecords" : 0,
"maxMgmtClientRecordSize" : 0,
"redundancyMode" : "string",
"maxExpansionDriveTrays" : 0,
"supportedAuthMethods" : [ "string" ],
"maxIscsiIpv6LocalAddressesPerPort" : 0,
"maxIscsiIpv6RoutableAddressesPerPort" : 0,
"absoluteMaxDssSegmentSize" : 0,
"smartBatteryTechnology" : true,
"writeCachingEnabledDuringLearnCycle" : true,
"maxSSDsSupported" : 0,
"ssdInterfaceTypeMixingSupported" : true,
"maxDriveSlots" : 0,
"supportedProtectionTypes" : [ "string" ],
"supportedEventPriorities" : [ "string" ],
"maxFlashCacheSize" : "string",
"defaultMediaScanPeriod" : 0,
"maxNvmeofRoceV2Ipv6LocalAddressesPerPort" : 0,
"maxNvmeofRoceV2RoutableAddressesPerPort" : 0
}
}
3.24. Upgrade
3.24.1. Initiates a reload of the software.
POST /devmgr/v2/upgrade/reload
Description
Loads any downloaded updates.
This is an asynchronous operation and is used in conjunction with /devmgr/v2/events.
MetaData
x-mode = both
x-allowedRoles = [root.admin, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/upgrade/reload
Example HTTP response
Response 200
{
"correlationId" : "string"
}
3.24.2. Retrieves current and staged version information for the RESTApi software
GET /devmgr/v2/upgrade
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, support.admin]
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved the current and staged version information. |
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/upgrade
Example HTTP response
Response 200
{
"stagedVersions" : [ {
"context" : "string",
"version" : "string"
} ],
"currentVersions" : [ {
"context" : "string",
"version" : "string"
} ]
}
3.24.3. Initiates a software update
POST /devmgr/v2/upgrade/download
Description
This is an asynchronous operation and used in conjunction with REST endpoint /devmgr/v2/events
MetaData
x-mode = both
x-allowedRoles = [root.admin, support.admin]
Parameters
Type | Name | Schema |
---|---|---|
Query |
force |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/upgrade/download
Request query
{
"force" : "string"
}
Example HTTP response
Response 200
{
"correlationId" : "string"
}
3.25. Volumes
3.25.1. Get the access volume
GET /devmgr/v2/storage-systems/{system-id}/access-volume
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
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/access-volume
Example HTTP response
Response 200
{
"enabled" : true,
"volumeHandle" : 0,
"capacity" : "string",
"accessVolumeRef" : "string",
"reserved1" : "string",
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
}
3.25.2. Get a list of all mappable objects
GET /devmgr/v2/storage-systems/{system-id}/mappable-objects
Description
Provides a simplified way to discover the type of mappable object from an id/reference.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< MappableObject > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mappable-objects
Example HTTP response
Response 200
{
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
} ]
3.25.3. Get a specific mappable object
GET /devmgr/v2/storage-systems/{system-id}/mappable-objects/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Mappable object not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/mappable-objects/string
Example HTTP response
Response 200
{
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"name" : "string",
"id" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.4. Get the list of ThinVolumes
GET /devmgr/v2/storage-systems/{system-id}/thin-volumes
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< ThinVolumeEx > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes
Example HTTP response
Response 200
{
"volumeHandle" : 0,
"worldWideName" : "string",
"label" : "string",
"allocationGranularity" : 0,
"capacity" : "string",
"reconPriority" : 0,
"volumeRef" : "string",
"status" : "string",
"repositoryRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"maxVirtualCapacity" : "string",
"initialProvisionedCapacity" : "string",
"currentProvisionedCapacity" : "string",
"provisionedCapacityQuota" : "string",
"growthAlertThreshold" : 0,
"expansionPolicy" : "string",
"volumeCache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"offline" : true,
"reportingPolicy" : "string",
"extendedUniqueIdentifier" : "string",
"volumeFull" : true,
"volumeGroupRef" : "string",
"blkSize" : 0,
"storageVolumeRef" : "string",
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"flashCached" : true,
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"diskPool" : true,
"name" : "string",
"id" : "string"
} ]
3.25.5. Create a ThinVolume
POST /devmgr/v2/storage-systems/{system-id}/thin-volumes
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
ThinVolume was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes
Request body
{
"poolId" : "string",
"name" : "string",
"sizeUnit" : "string",
"virtualSize" : "string",
"repositorySize" : "string",
"maximumRepositorySize" : "string",
"owningControllerId" : "string",
"growthAlertThreshold" : 0,
"createDefaultMapping" : true,
"expansionPolicy" : "string",
"cacheReadAhead" : true,
"dataAssuranceEnabled" : true,
"metaTags" : [ {
"key" : "string",
"value" : "string"
} ]
}
Example HTTP response
Response 200
{
"volumeHandle" : 0,
"worldWideName" : "string",
"label" : "string",
"allocationGranularity" : 0,
"capacity" : "string",
"reconPriority" : 0,
"volumeRef" : "string",
"status" : "string",
"repositoryRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"maxVirtualCapacity" : "string",
"initialProvisionedCapacity" : "string",
"currentProvisionedCapacity" : "string",
"provisionedCapacityQuota" : "string",
"growthAlertThreshold" : 0,
"expansionPolicy" : "string",
"volumeCache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"offline" : true,
"reportingPolicy" : "string",
"extendedUniqueIdentifier" : "string",
"volumeFull" : true,
"volumeGroupRef" : "string",
"blkSize" : 0,
"storageVolumeRef" : "string",
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"flashCached" : true,
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"diskPool" : true,
"name" : "string",
"id" : "string"
}
3.25.6. Get a ThinVolume
GET /devmgr/v2/storage-systems/{system-id}/thin-volumes/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
ThinVolume was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string
Example HTTP response
Response 200
{
"volumeHandle" : 0,
"worldWideName" : "string",
"label" : "string",
"allocationGranularity" : 0,
"capacity" : "string",
"reconPriority" : 0,
"volumeRef" : "string",
"status" : "string",
"repositoryRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"maxVirtualCapacity" : "string",
"initialProvisionedCapacity" : "string",
"currentProvisionedCapacity" : "string",
"provisionedCapacityQuota" : "string",
"growthAlertThreshold" : 0,
"expansionPolicy" : "string",
"volumeCache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"offline" : true,
"reportingPolicy" : "string",
"extendedUniqueIdentifier" : "string",
"volumeFull" : true,
"volumeGroupRef" : "string",
"blkSize" : 0,
"storageVolumeRef" : "string",
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"flashCached" : true,
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"diskPool" : true,
"name" : "string",
"id" : "string"
}
3.25.7. Update a ThinVolume
POST /devmgr/v2/storage-systems/{system-id}/thin-volumes/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
ThinVolume was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string
Request body
{
"name" : "string",
"growthAlertThreshold" : 0,
"flashCache" : true,
"metaTags" : [ {
"key" : "string",
"value" : "string"
} ],
"expansionPolicy" : "string",
"owningControllerId" : "string",
"cacheSettings" : {
"readCacheEnable" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string"
},
"scanSettings" : {
"enable" : true,
"parityValidationEnable" : true
}
}
Example HTTP response
Response 200
{
"volumeHandle" : 0,
"worldWideName" : "string",
"label" : "string",
"allocationGranularity" : 0,
"capacity" : "string",
"reconPriority" : 0,
"volumeRef" : "string",
"status" : "string",
"repositoryRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"maxVirtualCapacity" : "string",
"initialProvisionedCapacity" : "string",
"currentProvisionedCapacity" : "string",
"provisionedCapacityQuota" : "string",
"growthAlertThreshold" : 0,
"expansionPolicy" : "string",
"volumeCache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"offline" : true,
"reportingPolicy" : "string",
"extendedUniqueIdentifier" : "string",
"volumeFull" : true,
"volumeGroupRef" : "string",
"blkSize" : 0,
"storageVolumeRef" : "string",
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"flashCached" : true,
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"diskPool" : true,
"name" : "string",
"id" : "string"
}
3.25.8. Delete a ThinVolume
DELETE /devmgr/v2/storage-systems/{system-id}/thin-volumes/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Delete was successful |
|
404 |
ThinVolume was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string
3.25.9. Initialize a ThinVolume
POST /devmgr/v2/storage-systems/{system-id}/thin-volumes/{thinVolumeId}/initialize
Description
Reinitialize the target thin volume, wiping out all existing data!
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
thinVolumeId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
ThinVolume was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string/initialize
Example HTTP response
Response 200
{
"volumeHandle" : 0,
"worldWideName" : "string",
"label" : "string",
"allocationGranularity" : 0,
"capacity" : "string",
"reconPriority" : 0,
"volumeRef" : "string",
"status" : "string",
"repositoryRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"maxVirtualCapacity" : "string",
"initialProvisionedCapacity" : "string",
"currentProvisionedCapacity" : "string",
"provisionedCapacityQuota" : "string",
"growthAlertThreshold" : 0,
"expansionPolicy" : "string",
"volumeCache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"offline" : true,
"reportingPolicy" : "string",
"extendedUniqueIdentifier" : "string",
"volumeFull" : true,
"volumeGroupRef" : "string",
"blkSize" : 0,
"storageVolumeRef" : "string",
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"flashCached" : true,
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"diskPool" : true,
"name" : "string",
"id" : "string"
}
3.25.10. Expand a ThinVolume
POST /devmgr/v2/storage-systems/{system-id}/thin-volumes/{id}/expand
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
ThinVolume was not found. |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/thin-volumes/string/expand
Request body
{
"sizeUnit" : "string",
"newVirtualSize" : "string",
"newRepositorySize" : "string"
}
Example HTTP response
Response 200
{
"volumeHandle" : 0,
"worldWideName" : "string",
"label" : "string",
"allocationGranularity" : 0,
"capacity" : "string",
"reconPriority" : 0,
"volumeRef" : "string",
"status" : "string",
"repositoryRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"maxVirtualCapacity" : "string",
"initialProvisionedCapacity" : "string",
"currentProvisionedCapacity" : "string",
"provisionedCapacityQuota" : "string",
"growthAlertThreshold" : 0,
"expansionPolicy" : "string",
"volumeCache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"offline" : true,
"reportingPolicy" : "string",
"extendedUniqueIdentifier" : "string",
"volumeFull" : true,
"volumeGroupRef" : "string",
"blkSize" : 0,
"storageVolumeRef" : "string",
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"flashCached" : true,
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"segmentSize" : 0,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"diskPool" : true,
"name" : "string",
"id" : "string"
}
3.25.11. Get maximum number of drives that can be removed from a StoragePool
GET /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}/reduction
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Pool not found |
|
422 |
This operation is only supported on pools of type raidDiskPool |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/reduction
Example HTTP response
Response 200
{
"poolId" : "string",
"removableDriveCount" : 0
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.12. Reduce the number of drives of a StoragePool
POST /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}/reduction
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Pool not found |
|
422 |
The maximum removable drive count (12), for a single operation has been exceeded |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/reduction
Request body
{
"drives" : [ "string" ]
}
Example HTTP response
Response 200
{
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"usedSpace" : "string",
"totalRaidedSpace" : "string",
"extents" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"largestFreeExtentSize" : "string",
"raidStatus" : "string",
"freeSpace" : "string",
"drivePhysicalType" : "string",
"driveMediaType" : "string",
"normalizedSpindleSpeed" : "string",
"diskPool" : true,
"id" : "string",
"name" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.13. Get list of storage pools
GET /devmgr/v2/storage-systems/{system-id}/storage-pools
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< VolumeGroupEx > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools
Example HTTP response
Response 200
{
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"usedSpace" : "string",
"totalRaidedSpace" : "string",
"extents" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"largestFreeExtentSize" : "string",
"raidStatus" : "string",
"freeSpace" : "string",
"drivePhysicalType" : "string",
"driveMediaType" : "string",
"normalizedSpindleSpeed" : "string",
"diskPool" : true,
"id" : "string",
"name" : "string"
} ]
3.25.14. Create a storage pool
POST /devmgr/v2/storage-systems/{system-id}/storage-pools
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
StorageDevice not found |
|
422 |
Created pool not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools
Request body
{
"raidLevel" : "string",
"diskDriveIds" : [ "string" ],
"eraseSecuredDrives" : true,
"name" : "string"
}
Example HTTP response
Response 200
{
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"usedSpace" : "string",
"totalRaidedSpace" : "string",
"extents" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"largestFreeExtentSize" : "string",
"raidStatus" : "string",
"freeSpace" : "string",
"drivePhysicalType" : "string",
"driveMediaType" : "string",
"normalizedSpindleSpeed" : "string",
"diskPool" : true,
"id" : "string",
"name" : "string"
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.15. Get a storage pool
GET /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Pool not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string
Example HTTP response
Response 200
{
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"usedSpace" : "string",
"totalRaidedSpace" : "string",
"extents" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"largestFreeExtentSize" : "string",
"raidStatus" : "string",
"freeSpace" : "string",
"drivePhysicalType" : "string",
"driveMediaType" : "string",
"normalizedSpindleSpeed" : "string",
"diskPool" : true,
"id" : "string",
"name" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.16. Update a storage pool
POST /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Pool not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string
Request body
{
"name" : "string",
"securePool" : true,
"reservedDriveCount" : 0,
"poolPriority" : {
"priority" : "string",
"priorityType" : "string"
},
"poolThreshold" : {
"thresholdType" : "string",
"value" : 0
}
}
Example HTTP response
Response 200
{
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"usedSpace" : "string",
"totalRaidedSpace" : "string",
"extents" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"largestFreeExtentSize" : "string",
"raidStatus" : "string",
"freeSpace" : "string",
"drivePhysicalType" : "string",
"driveMediaType" : "string",
"normalizedSpindleSpeed" : "string",
"diskPool" : true,
"id" : "string",
"name" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.17. Delete a storage pool
DELETE /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
|
Path |
id |
string |
||
Query |
delete-volumes |
Automatically delete all owned volumes when a delete request is received. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Delete was successful |
|
404 |
Pool not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string
Request query
{
"delete-volumes" : true
}
Example HTTP response
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.18. Perform a RAID type migration on a storage pool
POST /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}/raid-type-migration
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Pool not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/raid-type-migration
Request body
{
"raidLevel" : "string"
}
Example HTTP response
Response 200
{
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"usedSpace" : "string",
"totalRaidedSpace" : "string",
"extents" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"largestFreeExtentSize" : "string",
"raidStatus" : "string",
"freeSpace" : "string",
"drivePhysicalType" : "string",
"driveMediaType" : "string",
"normalizedSpindleSpeed" : "string",
"diskPool" : true,
"id" : "string",
"name" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.19. Check the progress of a long-running action on a storage pool
GET /devmgr/v2/storage-systems/{system-id}/storage-pools/{id}/action-progress
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< OperationProgress > array |
404 |
Pool not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/action-progress
Example HTTP response
Response 200
{
"volumeRef" : "string",
"currentAction" : "string",
"progressPercentage" : 0,
"estimatedTimeToCompletion" : 0
} ]
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.20. Retrieve a list of expansion candidates for a StoragePool
GET /devmgr/v2/storage-systems/{system-id}/storage-pools/{poolId}/expand
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
poolId |
Storage pool id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< VolumeGroupExpansionCandidate > array |
404 |
Pool not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/expand
Example HTTP response
Response 200
{
"drives" : [ "string" ],
"trayLossProtection" : true,
"wastedCapacity" : "string",
"spindleSpeedMatch" : true,
"drawerLossProtection" : true,
"usableCapacity" : "string",
"driveBlockFormat" : "string"
} ]
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.21. Expand the capacity of a StoragePool
POST /devmgr/v2/storage-systems/{system-id}/storage-pools/{poolId}/expand
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
poolId |
Storage pool id |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Pool not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/storage-pools/string/expand
Request body
{
"drives" : [ "string" ]
}
Example HTTP response
Response 200
{
"sequenceNum" : 0,
"offline" : true,
"raidLevel" : "string",
"worldWideName" : "string",
"volumeGroupRef" : "string",
"reserved1" : "string",
"reserved2" : "string",
"trayLossProtection" : true,
"label" : "string",
"state" : "string",
"spindleSpeedMatch" : true,
"spindleSpeed" : 0,
"isInaccessible" : true,
"securityType" : "string",
"drawerLossProtection" : true,
"protectionInformationCapable" : true,
"protectionInformationCapabilities" : {
"protectionInformationCapable" : true,
"protectionType" : "string"
},
"volumeGroupData" : {
"type" : "string",
"diskPoolData" : {
"reconstructionReservedDriveCount" : 0,
"reconstructionReservedAmt" : "string",
"reconstructionReservedDriveCountCurrent" : 0,
"poolUtilizationWarningThreshold" : 0,
"poolUtilizationCriticalThreshold" : 0,
"poolUtilizationState" : "string",
"unusableCapacity" : "string",
"degradedReconstructPriority" : "string",
"criticalReconstructPriority" : "string",
"backgroundOperationPriority" : "string",
"allocGranularity" : "string",
"minimumDriveCount" : 0
}
},
"usage" : "string",
"driveBlockFormat" : "string",
"reservedSpaceAllocated" : true,
"securityLevel" : "string",
"usedSpace" : "string",
"totalRaidedSpace" : "string",
"extents" : [ {
"sectorOffset" : "string",
"rawCapacity" : "string",
"raidLevel" : "string",
"volumeGroupRef" : "string",
"freeExtentRef" : "string",
"reserved1" : "string",
"reserved2" : "string"
} ],
"largestFreeExtentSize" : "string",
"raidStatus" : "string",
"freeSpace" : "string",
"drivePhysicalType" : "string",
"driveMediaType" : "string",
"normalizedSpindleSpeed" : "string",
"diskPool" : true,
"id" : "string",
"name" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.22. Get the list of volumes
GET /devmgr/v2/storage-systems/{system-id}/volumes
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< VolumeEx > array |
404 |
Volume not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes
Example HTTP response
Response 200
{
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
} ]
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.23. Create a new volume
POST /devmgr/v2/storage-systems/{system-id}/volumes
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Created volume not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes
Request body
{
"poolId" : "string",
"name" : "string",
"sizeUnit" : "gb",
"size" : "string",
"segSize" : 0,
"dataAssuranceEnabled" : true,
"owningControllerId" : "string",
"metaTags" : [ {
"key" : "string",
"value" : "string"
} ]
}
Example HTTP response
Response 200
{
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.24. Get a specific volume
GET /devmgr/v2/storage-systems/{system-id}/volumes/{id}
Description
Retrieve a specific volume by providing its id, wwn, or name.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Volume not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string
Example HTTP response
Response 200
{
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.25. Update volume parameters
POST /devmgr/v2/storage-systems/{system-id}/volumes/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Volume not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string
Request body
{
"name" : "string",
"owningControllerId" : "string",
"cacheSettings" : {
"readCacheEnable" : true,
"writeCacheEnable" : true,
"readAheadEnable" : true,
"cacheFlushModifier" : "string",
"mirrorEnable" : true,
"cacheWithoutBatteries" : true
},
"flashCache" : true,
"scanSettings" : {
"enable" : true,
"parityValidationEnable" : true
},
"metaTags" : [ {
"key" : "string",
"value" : "string"
} ]
}
Example HTTP response
Response 200
{
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.26. Delete a volume
DELETE /devmgr/v2/storage-systems/{system-id}/volumes/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
404 |
Volume not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string
Example HTTP response
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.27. Get the volume expansion progress
GET /devmgr/v2/storage-systems/{system-id}/volumes/{id}/expand
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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/volumes/string/expand
Example HTTP response
Response 200
{
"percentComplete" : 0,
"timeToCompletion" : 0,
"action" : "string"
}
3.25.28. Start the volume expansion
POST /devmgr/v2/storage-systems/{system-id}/volumes/{id}/expand
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
|
Body |
body |
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/volumes/string/expand
Request body
{
"sizeUnit" : "string",
"expansionSize" : "string"
}
Example HTTP response
Response 200
{
"percentComplete" : 0,
"timeToCompletion" : 0,
"action" : "string"
}
3.25.29. Initialize a volume
POST /devmgr/v2/storage-systems/{system-id}/volumes/{volumeId}/initialize
Description
This procedure causes the specified volume to be re-initialized. All data that is currently present on the volume will be irretrievably lost as a result of this operation. Once a format operation starts, the volume’s action field will be changed to 'initializing'; the getVolumeActionProgress procedure can then be used to monitor the progress of the operation. Volume format operations are typically required only when reviving a volume that has been marked failed for some reason. Newly-created volumes need not be explicitly formatted using this procedure.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
volumeId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Volume not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volumes/string/initialize
Example HTTP response
Response 200
{
"offline" : true,
"extremeProtection" : true,
"volumeHandle" : 0,
"raidLevel" : "string",
"sectorOffset" : "string",
"worldWideName" : "string",
"label" : "string",
"blkSize" : 0,
"capacity" : "string",
"reconPriority" : 0,
"segmentSize" : 0,
"action" : "string",
"cache" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"mediaScan" : {
"enable" : true,
"parityValidationEnable" : true
},
"volumeRef" : "string",
"status" : "string",
"volumeGroupRef" : "string",
"currentManager" : "string",
"preferredManager" : "string",
"perms" : {
"mapToLUN" : true,
"snapShot" : true,
"format" : true,
"reconfigure" : true,
"mirrorPrimary" : true,
"mirrorSecondary" : true,
"copySource" : true,
"copyTarget" : true,
"readable" : true,
"writable" : true,
"rollback" : true,
"mirrorSync" : true,
"newImage" : true,
"allowDVE" : true,
"allowDSS" : true,
"concatVolumeMember" : true,
"flashReadCache" : true,
"asyncMirrorPrimary" : true,
"asyncMirrorSecondary" : true,
"pitGroup" : true,
"cacheParametersChangeable" : true,
"allowThinManualExpansion" : true,
"allowThinGrowthParametersChange" : true
},
"mgmtClientAttribute" : 0,
"dssPreallocEnabled" : true,
"dssMaxSegmentSize" : 0,
"preReadRedundancyCheckEnabled" : true,
"protectionInformationCapable" : true,
"protectionType" : "string",
"applicationTagOwned" : true,
"repairedBlockCount" : 0,
"extendedUniqueIdentifier" : "string",
"cacheMirroringValidateProtectionInformation" : true,
"expectedProtectionInformationAppTag" : 0,
"volumeUse" : "string",
"volumeFull" : true,
"volumeCopyTarget" : true,
"volumeCopySource" : true,
"pitBaseVolume" : true,
"asyncMirrorTarget" : true,
"asyncMirrorSource" : true,
"remoteMirrorSource" : true,
"remoteMirrorTarget" : true,
"diskPool" : true,
"flashCached" : true,
"increasingBy" : "string",
"metadata" : [ {
"key" : "string",
"value" : "string"
} ],
"dataAssurance" : true,
"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,
"totalSizeInBytes" : "string",
"preferredControllerId" : "string",
"onlineVolumeCopy" : true,
"cacheSettings" : {
"cwob" : true,
"enterpriseCacheDump" : true,
"mirrorActive" : true,
"mirrorEnable" : true,
"readCacheActive" : true,
"readCacheEnable" : true,
"writeCacheActive" : true,
"writeCacheEnable" : true,
"cacheFlushModifier" : "string",
"readAheadMultiplier" : 0
},
"thinProvisioned" : true,
"name" : "string",
"id" : "string"
}
Response 404
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.25.30. Retrieve a LunMapping
GET /devmgr/v2/storage-systems/{system-id}/volume-mappings/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
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-mappings/string
Example HTTP response
Response 200
{
"lunMappingRef" : "string",
"lun" : 0,
"ssid" : 0,
"perms" : 0,
"volumeRef" : "string",
"type" : "string",
"mapRef" : "string",
"id" : "string"
}
3.25.31. Remove a LunMapping
DELETE /devmgr/v2/storage-systems/{system-id}/volume-mappings/{id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Removal was successful |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-mappings/string
3.25.32. Retrieve the list of LunMappings
GET /devmgr/v2/storage-systems/{system-id}/volume-mappings
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< LUNMapping > array |
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/volume-mappings
Example HTTP response
Response 200
{
"lunMappingRef" : "string",
"lun" : 0,
"ssid" : 0,
"perms" : 0,
"volumeRef" : "string",
"type" : "string",
"mapRef" : "string",
"id" : "string"
} ]
3.25.33. Define a new LunMapping
POST /devmgr/v2/storage-systems/{system-id}/volume-mappings
Description
A volume must be mapped to a host in order to make it accessible and usable. This endpoint allows you to map a volume to a host or hostGroup.
The Logical Unit Number (LUN), value is optional. If it is not specified, we will choose the next available value for the LUN.
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
body |
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-mappings
Request body
{
"mappableObjectId" : "string",
"targetId" : "string",
"lun" : 0
}
Example HTTP response
Response 200
{
"lunMappingRef" : "string",
"lun" : 0,
"ssid" : 0,
"perms" : 0,
"volumeRef" : "string",
"type" : "string",
"mapRef" : "string",
"id" : "string"
}
3.25.34. Move a LunMapping to a different host or host group
POST /devmgr/v2/storage-systems/{system-id}/volume-mappings/{mappingId}/move
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
mappingId |
string |
|
Body |
body |
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-mappings/string/move
Request body
{
"targetId" : "string",
"lun" : 0
}
Example HTTP response
Response 200
{
"lunMappingRef" : "string",
"lun" : 0,
"ssid" : 0,
"perms" : 0,
"volumeRef" : "string",
"type" : "string",
"mapRef" : "string",
"id" : "string"
}
3.26. Workloads
3.26.1. Get all defined workloads
GET /devmgr/v2/storage-systems/{system-id}/workloads
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< WorkloadModel > array |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"workloadAttributes" : [ {
"key" : "string",
"value" : "string"
} ],
"key" : "string"
} ]
3.26.2. Create a workload
POST /devmgr/v2/storage-systems/{system-id}/workloads
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Body |
data |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
422 |
Error with input data |
Consumes
-
Application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads
Request body
{
"name" : "string",
"workloadAttributes" : [ {
"key" : "string",
"value" : "string"
} ]
}
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"workloadAttributes" : [ {
"key" : "string",
"value" : "string"
} ],
"key" : "string"
}
Response 422
{
"errorMessage" : "string",
"developerMessage" : "string",
"localizedMessage" : "string",
"retcode" : "string",
"codeType" : "string",
"invalidFieldsIfKnown" : [ "string" ]
}
3.26.3. Get a given defined workload
GET /devmgr/v2/storage-systems/{system-id}/workloads/{workload-id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.monitor, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
workload-id |
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/workloads/string
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"workloadAttributes" : [ {
"key" : "string",
"value" : "string"
} ],
"key" : "string"
}
3.26.4. Modify an existing workload
POST /devmgr/v2/storage-systems/{system-id}/workloads/{workload-id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
workload-id |
string |
|
Body |
data |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Consumes
-
Application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads/string
Request body
{
"workloadAttributes" : [ {
"key" : "string",
"value" : "string"
} ]
}
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"workloadAttributes" : [ {
"key" : "string",
"value" : "string"
} ],
"key" : "string"
}
3.26.5. Delete a workload
DELETE /devmgr/v2/storage-systems/{system-id}/workloads/{workload-id}
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
workload-id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Delete was successful |
|
404 |
StorageDevice not found |
|
424 |
StorageDevice offline |
Consumes
-
Application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads/string
3.26.6. Create a copy of an existing workload
POST /devmgr/v2/storage-systems/{system-id}/workloads/{workload-id}/copy
MetaData
x-mode = both
x-allowedRoles = [root.admin, storage.admin]
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
system-id |
The unique identifier of the storage-system. This may be the id or the WWN. |
string |
Path |
workload-id |
string |
|
Body |
data |
Name for the new workload |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
Workload to copy or storage device not found |
|
424 |
StorageDevice offline |
Consumes
-
Application/json
Produces
-
application/json
Example HTTP request
Request path
/devmgr/v2/storage-systems/string/workloads/string/copy
Request body
{
"newWorkloadName" : "string",
"changeVolumeTags" : true
}
Example HTTP response
Response 200
{
"id" : "string",
"name" : "string",
"workloadAttributes" : [ {
"key" : "string",
"value" : "string"
} ],
"key" : "string"
}
4. Definitions
4.1. CallResponse
API response to report errors back to the user.
Name | Description | Schema |
---|---|---|
errorMessage |
The error message. |
string |
developerMessage |
An optional developer message providing further error details. |
string |
localizedMessage |
The localized message. |
string |
retcode |
The value of retcode can vary by the code type. To be unique, it must be combined with code type. It is a string. Even if the returned value looks like a number, don’t assume its a number. It is a short label that will not change based on Internationalization. |
string |
codeType |
The API error code type |
enum (symbol, systemerror, devicemgrerror) |
invalidFieldsIfKnown |
The list of invalid fields. The list will be populated with known invalid fields. In the case no invalid fields are known, the list will be empty. |
< string > array |
4.2. AccessVolumeEx
Name | Description | Schema |
---|---|---|
enabled |
True if the access volume feature (and thus the UTM command transfer capability) is enabled, or false if it is disabled. |
boolean |
volumeHandle |
An identifier value for the AccessVolume object. This will generally correspond to the logical unit number (LUN) that is used to access the volume for UTM protocol command transactions. |
integer (int32) |
capacity |
The (simulated) capacity of the AccessVolume maintained by the controller. Since there is essentially no true data storage capacity present for an AccessVolume, this value is used to determine the block addressing limit of the unit, which is an important aspect of the UTM command transfer protocol. |
string (int64) |
accessVolumeRef |
The identifier value for this AccessVolume. Other objects may use this reference value to refer to the AccessVolume. |
string |
reserved1 |
Example : |
string |
objectType |
Example : |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
currentControllerId |
Example : |
string |
wwn |
Example : |
string |
listOfMappings |
Example : |
< LUNMapping > array |
mapped |
Example : |
boolean |
totalSizeInBytes |
Example : |
string (int64) |
preferredControllerId |
Example : |
string |
name |
Example : |
string |
id |
Example : |
string |
4.3. LUNMapping
Name | Description | Schema |
---|---|---|
lunMappingRef |
The unique identification value for this object. Other objects may use this reference value to refer to the mapping definition. |
string |
lun |
The unique identification value for this object. Other objects may use this reference value to refer to the mapping definition. |
integer (int32) |
ssid |
An internal volume identifier value that is not meaningful outside the firmware environment. |
integer (int32) |
perms |
The permission values associated with this mapping definition. This field is not currently used, but is provided for future extensions. |
integer (int32) |
volumeRef |
The unique identification value of the volume that is accessed via the LUN value associated with this mapping definition. |
string |
type |
The type of the LUN mapping. |
enum (none, hostport, host, cluster, saport, saportgroup, hostsaconnection, all, __UNDEFINED) |
mapRef |
The unique identifier of the entity for which the mapping applies. The type of the entity, and thus of the SYMbol reference, depends on the mapping type. For example, if the LUNMapping object represents a cluster-wide mapping, this field will contain the ClusterRef of the cluster for which the mapping applies. Similarly, if the object represents a host-specific mapping, this field will contain the HostRef of the host for which the mapping applies. Note that if the object represents a default mapping, this field will contain a NULL SYMbolRef. |
string |
id |
Example : |
string |
4.4. AlertSyslogConfiguration
API object that includes data related to syslog configuration.
Name | Description | Schema |
---|---|---|
syslogReceivers |
The list of syslog receivers |
< AlertSyslogServer > array |
defaultFacility |
The syslog default facility |
integer (int32) |
defaultTag |
The syslog default tag |
string |
4.5. AlertSyslogServer
Configures Syslog server and port
Name | Description | Schema |
---|---|---|
serverName |
Fully qualified name or IP address |
string |
portNumber |
Port number for syslog server |
integer (int32) |
4.6. AlertSyslogResponse
Name | Description | Schema |
---|---|---|
response |
Syslog test response |
enum (syslogSentOK, noSyslogReceiversConfigured, syslogSendFailed) |
4.7. AnalysedDiskStatistics
Disk statistics for storage system.
Name | Description | Schema |
---|---|---|
observedTime |
A timestamp representing when the data was collected |
string (date-time) |
observedTimeInMS |
The time in which this data was polled and generated in milliseconds |
string (int64) |
readIOps |
Read operations per second. |
number (double) |
writeIOps |
Write operations per second. |
number (double) |
otherIOps |
SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready. |
number (double) |
combinedIOps |
All operations per second. |
number (double) |
readThroughput |
Read throughput in MB/s. |
number (double) |
writeThroughput |
Write throughput in MB/s. |
number (double) |
combinedThroughput |
Combined read/write throughput in MB/s. |
number (double) |
readResponseTime |
Read response time average in milliseconds. |
number (double) |
readResponseTimeStdDev |
The standard deviation of read response times. |
number (double) |
writeResponseTime |
Write response time average in milliseconds. |
number (double) |
writeResponseTimeStdDev |
The standard deviation of write response times. |
number (double) |
combinedResponseTime |
Combined average response time in milliseconds. |
number (double) |
combinedResponseTimeStdDev |
The standard deviation of combined response times. |
number (double) |
averageReadOpSize |
Average read operation size in bytes. |
number (double) |
averageWriteOpSize |
Average write operation size in bytes. |
number (double) |
readOps |
The amount of read operations in this analysed interval. |
number (double) |
writeOps |
The amount of write operations in this analysed interval. |
number (double) |
diskId |
Id for the disk |
string |
readPhysicalIOps |
Physical read operations per second. For disk drives, the physical IOps will beequal to the total IOps. |
number (double) |
writePhysicalIOps |
Physical write operations per second. For disk drives, the physical IOps will beequal to the total IOps. |
number (double) |
readTimeMax |
The max time servicing read operations. |
number (double) |
writeTimeMax |
The max time servicing write operations. |
number (double) |
queueDepthMax |
Maximum queue depth. |
number (double) |
averageQueueDepth |
Average queue depth over the observation time. |
number (double) |
randomIosPercent |
The percentage of IOs that are classified as random. |
number (double) |
randomBytesPercent |
The percentage of bytes that are classified as random. |
number (double) |
4.8. AnalysedVolumeStatistics
Volume statistics for storage system.
Name | Description | Schema |
---|---|---|
observedTime |
A timestamp representing when the data was collected |
string (date-time) |
observedTimeInMS |
The time in which this data was polled and generated in milliseconds |
string (int64) |
readIOps |
Read operations per second. |
number (double) |
writeIOps |
Write operations per second. |
number (double) |
otherIOps |
SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready. |
number (double) |
combinedIOps |
All operations per second. |
number (double) |
readThroughput |
Read throughput in MB/s. |
number (double) |
writeThroughput |
Write throughput in MB/s. |
number (double) |
combinedThroughput |
Combined read/write throughput in MB/s. |
number (double) |
readResponseTime |
Read response time average in milliseconds. |
number (double) |
readResponseTimeStdDev |
The standard deviation of read response times. |
number (double) |
writeResponseTime |
Write response time average in milliseconds. |
number (double) |
writeResponseTimeStdDev |
The standard deviation of write response times. |
number (double) |
combinedResponseTime |
Combined average response time in milliseconds. |
number (double) |
combinedResponseTimeStdDev |
The standard deviation of combined response times. |
number (double) |
averageReadOpSize |
Average read operation size in bytes. |
number (double) |
averageWriteOpSize |
Average write operation size in bytes. |
number (double) |
readOps |
The amount of read operations in this analysed interval. |
number (double) |
writeOps |
The amount of write operations in this analysed interval. |
number (double) |
volumeId |
Example : |
string |
volumeName |
Example : |
string |
poolId |
Example : |
string |
controllerId |
Example : |
string |
workLoadId |
Example : |
string |
mapped |
True if the volume was mapped to a host at the point of data collection |
boolean |
readHitOps |
Number of read operations that hit cache |
number (double) |
readHitResponseTime |
Average read cache hit response time in milliseconds. |
number (double) |
readHitResponseTimeStdDev |
The standard deviation of read cache hit response times |
number (double) |
readHitBytes |
Number of bytes read from cache |
number (double) |
writeHitBytes |
Number of bytes written to cache |
number (double) |
writeHitOps |
Number of write operations that hit cache |
number (double) |
writeHitResponseTime |
Average write cache hit response time in milliseconds. |
number (double) |
writeHitResponseTimeStdDev |
The standard deviation of write cache hit response times. |
number (double) |
combinedHitResponseTime |
Combined average cache hit response time in milliseconds. |
number (double) |
combinedHitResponseTimeStdDev |
The standard deviation of combined cache hit response times. |
number (double) |
readCacheUtilization |
Percentage of bytes read from cache |
number (double) |
writeCacheUtilization |
Percentage of bytes written to cache |
number (double) |
flashCacheReadHitOps |
Number of read operations that hit flash(SSD) cache |
number (double) |
flashCacheReadHitBytes |
Number of bytes read from flash(SSD) cache |
number (double) |
readPhysicalIOps |
Physical read operations per second. |
number (double) |
writePhysicalIOps |
Physical write operations per second. |
number (double) |
queueDepthTotal |
Total channel queue depth. |
number (double) |
queueDepthMax |
Maximum channel queue depth. |
number (double) |
readTimeMax |
The max time servicing read operations. |
number (double) |
writeTimeMax |
The max time servicing write operations. |
number (double) |
averageQueueDepth |
Average queue depth over the observation time. |
number (double) |
randomIosPercent |
The percentage of IOs that are classified as random. |
number (double) |
randomBytesPercent |
The percentage of bytes that are classified as random. |
number (double) |
cacheWriteWaitOpsPercent |
The percentage of write operations that are delayed, waiting for cache flush. |
number (double) |
cacheWriteWaitBytesPercent |
The percentage of write bytes that are delayed, waiting for cache flush. |
number (double) |
prefetchHitPercent |
The percentage of pre-fetched hits that are ultimately read by the host. |
number (double) |
fullStripeWritesBytesPercent |
The percentage of bytes that are classified as random. This field is only correctly defined in storage-systems running firmware version greater than or equal to 08.40.+ / 11.40.+ |
number (double) |
flashCacheReadThroughput |
Example : |
number (double) |
flashCacheReadResponseTime |
Example : |
number (double) |
flashCacheHitPct |
Example : |
number (double) |
4.9. AnalysedControllerStatistics
Controller statistics for storage system.
Name | Description | Schema |
---|---|---|
observedTime |
A timestamp representing when the data was collected |
string (date-time) |
observedTimeInMS |
The time in which this data was polled and generated in milliseconds |
string (int64) |
readIOps |
Read operations per second. |
number (double) |
writeIOps |
Write operations per second. |
number (double) |
otherIOps |
SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready. |
number (double) |
combinedIOps |
All operations per second. |
number (double) |
readThroughput |
Read throughput in MB/s. |
number (double) |
writeThroughput |
Write throughput in MB/s. |
number (double) |
combinedThroughput |
Combined read/write throughput in MB/s. |
number (double) |
readResponseTime |
Read response time average in milliseconds. |
number (double) |
readResponseTimeStdDev |
The standard deviation of read response times. |
number (double) |
writeResponseTime |
Write response time average in milliseconds. |
number (double) |
writeResponseTimeStdDev |
The standard deviation of write response times. |
number (double) |
combinedResponseTime |
Combined average response time in milliseconds. |
number (double) |
combinedResponseTimeStdDev |
The standard deviation of combined response times. |
number (double) |
averageReadOpSize |
Average read operation size in bytes. |
number (double) |
averageWriteOpSize |
Average write operation size in bytes. |
number (double) |
readOps |
The amount of read operations in this analysed interval. |
number (double) |
writeOps |
The amount of write operations in this analysed interval. |
number (double) |
readPhysicalIOps |
Physical read operations per second. |
number (double) |
writePhysicalIOps |
Physical write operations per second. |
number (double) |
controllerId |
Example : |
string |
cacheHitBytesPercent |
The percentage of bytes that hit cache. |
number (double) |
randomIosPercent |
The percentage of IOs that are classified as random. |
number (double) |
mirrorBytesPercent |
The percentage of bytes serviced by the controller that are characterized as cache mirroring related. |
number (double) |
fullStripeWritesBytesPercent |
The percentage of bytes serviced by the controller that are characterized as full stripe writes. |
number (double) |
maxCpuUtilization |
The max cpu utilization over the observation period. |
number (double) |
maxCpuUtilizationPerCore |
The max cpu utilization over the observation period per core. |
< number (double) > array |
cpuAvgUtilization |
The average CPU utilization. |
number (double) |
cpuAvgUtilizationPerCore |
The average percentage of CPU core utilization. |
< number (double) > array |
cpuAvgUtilizationPerCoreStdDev |
The standard deviation of CPU core utilization. |
< number (double) > array |
raid0BytesPercent |
The percentage of raid 0 bytes serviced. |
number (double) |
raid1BytesPercent |
The percentage of raid 1 bytes serviced. |
number (double) |
raid5BytesPercent |
The percentage of raid 5 bytes serviced. |
number (double) |
raid6BytesPercent |
The percentage of raid 6 bytes serviced. |
number (double) |
ddpBytesPercent |
The percentage of dynamic disk pool(DDP) bytes serviced. |
number (double) |
readHitResponseTime |
Read cache hit response time average in milliseconds. |
number (double) |
readHitResponseTimeStdDev |
The standard deviation of read cache hit response times |
number (double) |
writeHitResponseTime |
Write cache hit response time average in milliseconds. |
number (double) |
writeHitResponseTimeStdDev |
The standard deviation of write cache hit response times |
number (double) |
combinedHitResponseTime |
Combined average cache hit response time in milliseconds. |
number (double) |
combinedHitResponseTimeStdDev |
The standard deviation of combined cache hit response times. |
number (double) |
4.10. AnalyzedInterfaceStatistics
Interface statistics for storage system.
Name | Description | Schema |
---|---|---|
observedTime |
A timestamp representing when the data was collected |
string (date-time) |
observedTimeInMS |
The time in which this data was polled and generated in milliseconds |
string (int64) |
readIOps |
Read operations per second. |
number (double) |
writeIOps |
Write operations per second. |
number (double) |
otherIOps |
SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready. |
number (double) |
combinedIOps |
All operations per second. |
number (double) |
readThroughput |
Read throughput in MB/s. |
number (double) |
writeThroughput |
Write throughput in MB/s. |
number (double) |
combinedThroughput |
Combined read/write throughput in MB/s. |
number (double) |
readResponseTime |
Read response time average in milliseconds. |
number (double) |
readResponseTimeStdDev |
The standard deviation of read response times. |
number (double) |
writeResponseTime |
Write response time average in milliseconds. |
number (double) |
writeResponseTimeStdDev |
The standard deviation of write response times. |
number (double) |
combinedResponseTime |
Combined average response time in milliseconds. |
number (double) |
combinedResponseTimeStdDev |
The standard deviation of combined response times. |
number (double) |
averageReadOpSize |
Average read operation size in bytes. |
number (double) |
averageWriteOpSize |
Average write operation size in bytes. |
number (double) |
readOps |
The amount of read operations in this analysed interval. |
number (double) |
writeOps |
The amount of write operations in this analysed interval. |
number (double) |
interfaceId |
Example : |
string |
channelType |
The channel type for the interface. |
enum (hostside, driveside, management, __UNDEFINED) |
queueDepthTotal |
Total channel queue depth. |
number (double) |
queueDepthMax |
Maximum channel queue depth. |
number (double) |
channelNumber |
Number of channels. |
integer (int32) |
channelErrorCounts |
Maximum channel queue depth. |
number (double) |
4.11. RemoteCandidate
A storage-device candidate for use with ARVM.
Name | Description | Schema |
---|---|---|
wwn |
Example : |
string |
id |
Example : |
string |
name |
Example : |
string |
type |
Example : |
enum (fibre, iscsi, fibreAndIscsi, none) |
fcMirroringState |
Example : |
enum (unknown, disabled, enabledLegacyRvm, enabledArvm, enabledAll, __UNDEFINED) |
4.12. AsupResponse
API response object that includes basic information about asup.
Name | Description | Schema |
---|---|---|
enabled |
AutoSupport is enabled or disabled |
boolean |
scheduleType |
The schedule frequency = ['0' is a daily schedule, '1' is a weekly schedule, '2' is a monthly schedule] |
integer (int32) |
weekdays |
Days of the week |
< integer (int32) > array |
months |
Months |
< integer (int32) > array |
scheduledDays |
Days of the month |
< integer (int32) > array |
deliveryType |
The Delivery method = ['0' is unknown, '1' is https (default), '2' is http, '3' is smtp] |
integer (int32) |
destinationHttpAddr |
Destination HTTP address |
string |
destinationSmtpAddr |
Destination SMTP address |
string |
httpDeliveryType |
Http delivery method = ['0' is a unknown, '1' is direct (default), '2' is proxy server, '3' is proxy configuration script] |
integer (int32) |
proxyHostAddr |
Proxy server address |
string |
proxyHostPort |
Proxy server port |
string |
authRequired |
Authentication required |
boolean |
authUserName |
Authentication username |
string |
authPassword |
Authentication password |
string |
proxyScript |
Proxy configuration script |
string |
mailServer |
SMTP mail server |
string |
mailSenderAddr |
Sender email address |
string |
mailReplyAddr |
Reply email address |
string |
log |
Log entries |
string |
sequence |
Bundle sequence number |
string (int64) |
default |
Example : |
boolean |
4.13. AsupUpdateRequest
Used to update asup settings.
Name | Description | Schema |
---|---|---|
enable |
Enable or disable AutoSupport |
boolean |
scheduleTypeReq |
The schedule type = ['0' is a daily schedule, '1' is a weekly schedule, '2' is a monthly schedule] |
integer (int32) |
weekDaysReq |
Days of the week |
< integer (int32) > array |
monthsReq |
Months |
< integer (int32) > array |
scheduledDaysReq |
Days of the month |
< integer (int32) > array |
deliveryType |
The Delivery method = ['0' is unknown, '1' is https (default), '2' is http, '3' is smtp] |
integer (int32) |
httpDeliveryType |
Http delivery method = ['0' is a unknown, '1' is direct (default), '2' is proxy server, '3' is proxy configuration script] |
integer (int32) |
proxyHostAddr |
Proxy server address |
string |
proxyHostPort |
Proxy server port |
string |
authRequired |
Authentication required |
boolean |
authUserName |
Authentication username |
string |
authPassword |
Authentication password |
string |
proxyScript |
Proxy configuration script |
string |
mailServer |
SMTP mail server |
string |
mailSenderAddr |
Sender email address |
string |
mailReplyAddr |
Reply email address |
string |
4.14. AsupDispatchRequest
Used to dispatch the asup bundle.
Name | Description | Schema |
---|---|---|
id |
Id of the registered bundle to be dispatched |
string |
dispatchType |
The type of dispatch to be executed = ['0' is daily, '1' is weekly, '2' is monthly, '3' is manual (default), '4' is test] |
integer (int32) |
4.15. AsupEntry
Name | Description | Schema |
---|---|---|
fileName |
File name of the entry |
string |
filePath |
File path of the entry |
string |
priority |
Priority of the entry |
integer (int32) |
contentType |
Content type of the entry |
string |
description |
Description of the entry |
string |
schedule |
Scheduled dispatch of the entry |
< integer (int32) > array |
4.16. AsupRegistrationRequest
Name | Description | Schema |
---|---|---|
entries |
The bundle entries |
< AsupEntry > array |
id |
Id of bundle to be registered |
string |
modelName |
Model name of bundle to be registered |
string |
subjectName |
Subject name of bundle to be registered |
string |
4.17. AsyncMirrorGroupMemberSyncProgress
Name | Description | Schema |
---|---|---|
percentComplete |
The completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING. |
integer (int32) |
timeToCompletion |
The estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN. |
integer (int32) |
syncBytes |
The amount of data that remains to be synchronized in the current synchronization step. |
string (int64) |
mirrorRef |
A reference to the async mirror member. |
string |
trackingBytes |
Amount of data (in bytes) marked as unsynchronized in the tracking delta log for this member. |
string (int64) |
4.18. AsyncMirrorGroupSyncProgress
Name | Description | Schema |
---|---|---|
groupPercentComplete |
Completion percentage for the operation across the entire group. If synchronization is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING. |
integer (int32) |
groupTimeToCompletion |
Estimated time to completion in minutes for all members in the group that are undergoing synchronization. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN. |
integer (int32) |
groupSyncBytes |
Amount of data that needs to be synchronized for the entire group. |
string (int64) |
groupRef |
Reference to the async mirror group. |
string |
memberProgress |
List of progress information for each mirror group member. |
< AsyncMirrorGroupMemberSyncProgress > array |
groupTrackingBytes |
The amount of data (in bytes) marked as unsynchronized in the tracking delta logs for the entire group. |
string (int64) |
4.19. Amg
Asynchronous Mirror Group
Name | Description | Schema |
---|---|---|
groupRef |
The reference (key) for the mirror group. |
string |
worldWideName |
The world wide name of the mirror group. This can be used to identify the AMG pair on both arrays. The AsyncMirrorGroupRef is not guaranteed to be unique across multiple arrays. |
string |
label |
The user assigned name for the mirror group. |
string |
groupState |
The Mirror Group State. This is determined primarily by the presence or lack of a recovery point. |
enum (unknown, initialSync, optimal, degraded, rpFailed, __UNDEFINED) |
localRole |
The current role of this (local) array with respect to this mirror group. |
enum (unknown, primary, secondary, __UNDEFINED) |
remoteRole |
The current role of the peer (remote) array with respect to this mirror group. |
enum (unknown, primary, secondary, __UNDEFINED) |
roleChangeProgress |
This field indicates the current state of the role change process. This may be an extended condition due to the data sync needed for an orderly role change or the recovery point rollback needed for a no-sync or forced role change. |
enum (unknown, none, pending, inProgress, __UNDEFINED) |
syncIntervalMinutes |
The time in minutes between starting points of periodic synchronization intervals. A value of ARVM_MANUAL_SYNC_INTERVAL indicates synchronization intervals are manually started by the user. |
integer (int32) |
syncCompletionTimeAlertThresholdMinutes |
The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete. A value of ARVM_SYNC_COMPLETION_TIME_THRESHOLD_NONE indicates no threshold is set. |
integer (int32) |
recoveryPointAgeAlertThresholdMinutes |
The recovery point age objective (in minutes). The user is notified via needs-attention when the age of the last good recovery point exceeds this value. A value of ARVM_RECOVERY_POINT_AGE_THRESHOLD_NONE indicates no threshold is set. |
integer (int32) |
repositoryUtilizationWarnThreshold |
The repository utilization warning threshold (0-100 percent). A needs attention condition will be generated if the percent of the repository capacity currently utilized exceeds this threshold. |
integer (int32) |
mirrorChannelRemoteTarget |
The path to the remote array to be used by this AMG (a reference to the associated RemoteTarget). |
string |
syncActivity |
Current synchronization activity. |
enum (unknown, idle, active, paused, userSuspended, internallySuspended, __UNDEFINED) |
orphanGroup |
If true, the mirror group is an orphan. |
boolean |
connectionType |
The connection type used to create this mirror group. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
remoteTargetWwn |
The WWN of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created. |
string |
remoteTargetName |
The user label of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode. |
string |
remoteTargetId |
The id of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode. |
string |
remoteTarget |
The connection information for the remote StorageSystem. |
|
id |
Example : |
string |
4.20. IpVxAddress
Name | Description | Schema |
---|---|---|
addressType |
This enumeration defines the different types of IP addresses, corresponding to different versions of the Internet protocol. |
enum (ipv4, ipv6, __UNDEFINED) |
ipv4Address |
An IP address formatted according to version 4 of the Internet protocol. This field is only present if addressType is equal to IPV4. |
string |
ipv6Address |
An IP address formatted according to version 6 of the Internet protocol. This field is only present if addressType is equal to IPV6. |
string |
4.21. IscsiInitiatorTargetBaseParameters
Name | Description | Schema |
---|---|---|
portals |
The IP addresses, portal group numbers, and port number for the initiator or target. |
< TargetPortal > array |
4.22. RemoteTarget
Name | Description | Schema |
---|---|---|
remoteRef |
Unique identifier for this initiator/target object. |
string |
nodeName |
Node name associated with the local initiator. |
|
scsiinitiatorTargetBaseProperties |
Example : |
4.23. ScsiInitiatorTargetBaseProperties
Name | Description | Schema |
---|---|---|
ioInterfaceType |
This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
iscsiinitiatorTargetBaseParameters |
Example : |
4.24. ScsiNodeName
Name | Description | Schema |
---|---|---|
ioInterfaceType |
This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
iscsiNodeName |
The SCSI node name as defined under iSCSI. This field is only valid if the I/O interface type is equal to IO_IF_ISCSI. |
string |
remoteNodeWWN |
The FC WWN for the remote node. This field is only valid if the I/O interface type is equal to IO_IF_FC. |
string |
nvmeNodeName |
Host NVMe Qualified Name (NQN) |
string |
4.25. TargetPortal
Name | Description | Schema |
---|---|---|
groupTag |
A value identifying the portal group to which this portal belongs. |
integer (int32) |
ipAddress |
The IP address of the portal. |
|
tcpListenPort |
The number of the TCP port on which the target listens for incoming connections. |
integer (int32) |
4.26. AsyncMirrorGroupUpdateRequest
Name | Description | Schema |
---|---|---|
name |
Example : |
string |
syncIntervalMinutes |
Sync interval (minutes) |
integer (int32) |
recoveryWarnThresholdMinutes |
Recovery point warning threshold (minutes) |
integer (int32) |
repoUtilizationWarnThreshold |
Recovery point warning threshold (percentage) |
integer (int32) |
syncWarnThresholdMinutes |
Example : |
integer (int32) |
4.27. AsyncMirrorGroupCreateRequest
Creates an async mirror group (issued to the array with the primary role).
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the new async mirror group. |
string |
secondaryArrayId |
The id of the secondary array. |
string |
syncIntervalMinutes |
Sync interval in (minutes) |
integer (int32) |
manualSync |
Set the synchronization method to manual, causing other synchronization values to be ignored. |
boolean |
recoveryWarnThresholdMinutes |
Recovery point warning threshold (minutes). The user will be warned when the age of the last good failures point exceeds this value |
integer (int32) |
repoUtilizationWarnThreshold |
Recovery point warning threshold (percentage) |
integer (int32) |
interfaceType |
The intended protocol to use if both Fibre and iSCSI are available. |
enum (fibre, iscsi) |
syncWarnThresholdMinutes |
The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete. |
integer (int32) |
4.28. AsyncMirrorRepositoryUtilization
Name | Description | Schema |
---|---|---|
pitDataBytes |
The total number of bytes used in the repository for copy-on-write data and related metadata. |
string (int64) |
deltaLogBytes |
The total number of bytes used for the delta logs (bitmaps). |
string (int64) |
bytesAvailable |
The total number of bytes available for ongoing copy-on-write operations. |
string (int64) |
mirrorRef |
The mirror group member for which this utilization information applies. |
string |
id |
Example : |
string |
4.29. AsyncMirrorGroupRoleUpdateRequest
Name | Description | Schema |
---|---|---|
role |
new role |
enum (unknown, primary, secondary, __UNDEFINED) |
noSync |
Default : |
boolean |
force |
Default : |
boolean |
4.30. AmgMember
A representation of an asynchronous mirroring relationship between a local and remote volume.
Name | Description | Schema |
---|---|---|
memberRef |
The reference (key) for the group member. |
string |
mirrorGroup |
The AMG with which this member is associated. |
string |
localVolume |
The local volume for this mirror. This is the volume being mirrored if the AMG role is primary, otherwise this is the target of mirror synchronization. |
string |
remoteVolume |
The remote volume. This is the target of mirror synchronization on the remote array if the AMG role is primary, otherwise this is the volume on the remote array that is being mirrored. |
string |
memberState |
The state of this mirror relationship (as known by this array). |
enum (unknown, initialSync, optimal, failed, incomplete, orphan, stopped, __UNDEFINED) |
lastRecoveryPointTime |
The timestamp, represented in seconds since midnight GMT on January 1, 1970, of the last recovery point PiT on secondary. If no recovery point image exists, the value of this field will be ARVM_NO_RECOVERY_POINT_TIMESTAMP. |
string (int64) |
overUtilizationWarnThreshold |
If true, the repository capacity utilized is over the warning threshold. |
boolean |
mirroredLocalCapacity |
The current local volume capacity that is being mirrored. This will be less than the actual local volume capacity if we have not yet reached a point where the next PiT can be taken and delta-logs resized (and until that point the expanded local capacity will not be opened up to host writes). |
string (int64) |
repositoryVolume |
The metadata volume (Copy-on-Write / DeltaLog Repository) for this mirror. |
string |
worldWideName |
The WWN of the async mirror proxy. |
string |
volumeHandle |
The SSID of the async mirror proxy. |
integer (int32) |
repositoryFull |
If true, the repository is full (100% of available capacity utilized). |
boolean |
localVolumeName |
The label of the source volume on the local StorageSystem. |
string |
remoteVolumeName |
The label of the remote target volume. |
string |
remoteVolumeInfo |
Detailed information on the remote volume. |
|
remoteTargetWwn |
The WWN of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created. |
string |
remoteTargetName |
The user label of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode. |
string |
remoteTargetId |
The id of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode. |
string |
totalSizeInBytes |
The capacity of the underlying repository volume in bytes. |
string (int64) |
mediaScan |
The volume-specific media scan settings currently in effect for the repository volume. |
|
id |
Example : |
string |
4.31. RemoteVolume
Name | Description | Schema |
---|---|---|
worldWideName |
The WWN of the remote volume. |
string |
remoteVolRef |
The identifier of the remote volume. |
string |
manager |
The controller that owns the remote volume. |
string |
remoteArrayId |
The identifier of the remote array. |
|
remoteNodeWWN |
This field is deprecated. It will continue to be supported if remoteNodeName is NULL (IOInterfaceType == IO_IF_NOT_IMPLEMENTED). This will allow continued compatibility with clients still using this field. |
string |
remoteVolWWN |
The WWN of the volume on the remote array. |
string |
remoteVolUserLabel |
The user assigned label of the remote volume. |
string |
remoteVolState |
The state of the current remote volume. |
enum (optimal, noLun, noArray, noFabric, initializing, wwnChangeFailed, __UNDEFINED) |
remoteVolCapacity |
The actual capacity of the volume on the remote array. |
string (int64) |
volumeHandle |
The SSID of the remote volume. |
integer (int32) |
perms |
The permissions of the volume. |
|
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
remoteNodeName |
The name of the RemoteVolume. |
|
remoteVolSecurityType |
The security type of the volume on the remote array. Note this may be SECURITY_TYPE_UNKNOWN if connection to remote array is down. |
enum (unknown, none, capable, enabled, __UNDEFINED) |
4.32. SAIdentifier
Name | Description | Schema |
---|---|---|
worldWideName |
A variable-length, opaque byte array whose value is guaranteed to be globally unique, and thus serves as the unique identifier for the storage array. No assumptions may be made outside the controller firmware environment about the meaning of the various bytes within this array. The only operation that a SYMbol client is allowed to perform on this field is a comparison for equality with the same field of a different storage array object. |
string |
4.33. VolumeMediaScanParams
Name | Description | Schema |
---|---|---|
enable |
A true value means that the controller should perform a media scan for this volume as part of its background processing. A false value means that the volume should not participate in media scans. |
boolean |
parityValidationEnable |
A true value means that, in addition to ensuring that the volume’s media blocks are fully accessible, the controller should also compute and validate all parity blocks for the volume during the media scan. A false value means that parity validation should not occur in conjunction with media checking. Note that this field has no significance unless the enable field is set to true. |
boolean |
4.34. VolumePerms
Name | Description | Schema |
---|---|---|
mapToLUN |
Can this volume be mapped to a LUN |
boolean |
snapShot |
This is true if the volume can have a snapshot. |
boolean |
format |
This is true if the volume can be formatted. |
boolean |
reconfigure |
This is true if the volume can be reconfigured (DVE, DCE, DRM, etc.). |
boolean |
mirrorPrimary |
This is true if the volume can be a primary mirror. |
boolean |
mirrorSecondary |
This is true if the volume can be a secondary mirror. |
boolean |
copySource |
This is true if the volume can be the source for a copy. |
boolean |
copyTarget |
This is true if the volume can be the target for a copy. |
boolean |
readable |
This is true if the volume can be read by a host. |
boolean |
writable |
Can this volume be written by a host |
boolean |
rollback |
Set to true if a snapshot rollback can be applied to this volume. |
boolean |
mirrorSync |
Set to true if a remote volume mirror can actively synchronize this volume’s data |
boolean |
newImage |
Set to true when a new point-in-time image can be taken of this volume, either by creating a new snapshot or re-creating an existing snapshot. |
boolean |
allowDVE |
If true, this volume can be expanded via DVE. If false, this will still allow general reconfigures (providing the 'reconfigure' field is true), but disallow DVE specifically. |
boolean |
allowDSS |
If true, this volume can undergo a segment size change (DSS). If false, this will still allow general reconfigures (providing the 'reconfigure' field is true), but disallow DSS specifically. |
boolean |
concatVolumeMember |
If true, this volume can be a member of a ConcatVolume. |
boolean |
flashReadCache |
If true, this volume can have flash read cache enabled. |
boolean |
asyncMirrorPrimary |
If true, this volume can be an Async RVM primary. |
boolean |
asyncMirrorSecondary |
If true, this volume can be an Async RVM primary. |
boolean |
pitGroup |
If true, a PiT group can be created on this volume. |
boolean |
cacheParametersChangeable |
If true, cache parameters may be changed on this volume. |
boolean |
allowThinManualExpansion |
If true, changes to manual mode while the thin volume is in an Asynchronous Mirror Group (AMG) are allowed. |
boolean |
allowThinGrowthParametersChange |
If true, changes to the growth parameters (quota or warning threshold values) while the thin volume is in an Asynchronous Mirror Group (AMG) are allowed. |
boolean |
4.35. AsyncMirrorConnectionsResponse
The connections this Amg has to the remote StorageSystem.
Name | Description | Schema |
---|---|---|
amgRef |
Example : |
string |
connections |
Example : |
< AsyncMirrorRemoteConnection > array |
4.36. AsyncMirrorRemoteConnection
Name | Description | Schema |
---|---|---|
localPortName |
The unique WWN of the local port. Only valid if the interface type is fc. |
string |
remotePortName |
The unique WWN of the remote port. Only valid if the interface type is fc. |
string |
remotePortId |
The switch port identifier for the remote port. Only valid if the interface type is fc. |
string |
localPortId |
The switch port identifier for the local port. Only valid if the interface type is fc. |
string |
localPortNumber |
Example : |
integer (int32) |
remotePortNumber |
Example : |
integer (int32) |
controller |
Example : |
string |
ioInterfaceType |
Example : |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
fibreConnectionDetail |
Example : |
|
remoteTargetConnections |
Example : |
|
localPortRef |
Local initiator port for these connections. |
string |
iscsiConnectionDetail |
Example : |
4.37. FibrePortLogin
Name | Description | Schema |
---|---|---|
switchPortId |
The switch port ID. |
string |
targetPortName |
The target port name. |
string |
4.38. FibreRemoteTargetConnections
Name | Description | Schema |
---|---|---|
remoteNodeWWN |
Remote node name. |
string |
associatedSwitchPorts |
Associated (visible) switch ports. |
< string > array |
connectedRemoteTargetPorts |
Connected remote target ports. |
< FibrePortLogin > array |
4.39. IscsiRemoteTargetConnections
Name | Description | Schema |
---|---|---|
connectedRemoteTargetPortals |
Connected remote target ports. |
< TargetPortal > array |
4.40. ScsiRemoteTargetConnections
Name | Description | Schema |
---|---|---|
ioInterfaceType |
This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
iscsiConnectionDetail |
This field is returned if the value of ioInterfaceType is equal to IO_IF_ISCSI. |
|
fibreConnectionDetail |
This field is returned if the value of ioInterfaceType is equal to IO_IF_FC. |
4.41. AsyncCommunicationData
Name | Description | Schema |
---|---|---|
timeout |
Example : |
integer (int32) |
returnStatus |
Example : |
enum (uninitialized, ok, error, busy, illegalParam, noHeap, driveNotExist, driveNotUnassigned, noSparesAssigned, someSparesAssigned, volumeNotExist, volumeReconfiguring, notDualActive, tryAlternate, background, notImplemented, reservationConflict, volumeDead, internalError, invalidRequest, iconFailure, volumeFormatting, altRemoved, cacheSyncFailure, invalidFile, reconfigSmallDacstore, reconfigFailure, nvramError, flashError, authFailParam, authFailPassword, memParityError, invalidControllerref, invalidVolumegroupref, invalidVolumeref, invalidDriveref, invalidFreeextentref, volumeOffline, volumeNotOptimal, modesenseError, invalidSegmentsize, invalidCacheblksize, invalidFlushThreshold, invalidFlushAmount, invalidLabel, invalidCacheModifier, invalidReadahead, invalidReconpriority, invalidScanperiod, invalidTrayposLength, invalidRegionid, invalidFibreid, invalidEncryption, invalidRaidlevel, invalidExpansionList, noSparesDeassigned, someSparesDeassigned, partDupId, partLabelInvalid, partNodeNonexistent, partPortIdInvalid, partVolumeNonexistent, partLunCollision, maxVolMappingExceeded, partMappingNonexistent, partNoHostports, imageTransferred, fileTooLarge, invalidOffset, overrun, invalidChunksize, invalidTotalsize, downloadNotPermitted, spawnError, voltransferError, invalidDlstate, cacheconfigError, downloadInProgress, driveNotOptimal, driveRemoved, duplicateDrives, numdrivesAdditional, numdrivesGroup, driveTooSmall, capacityConstrained, maxVolumesExceeded, partIsUtmLun, someSparesTooSmall, sparesSmallUnassigned, tooManyPartitions, parityScanInProgress, invalidSafeId, invalidSafeKey, invalidSafeCapability, invalidSafeVersion, partitionsDisabled, driveDownloadFailed, esmDownloadFailed, esmPartialUpdate, utmConflict, noVolumes, authFailReadpassword, partCrteFailTblFull, attemptToSetLocal, invalidHostTypeIndex, failVolumeVisible, noDeleteUtmInUse, invalidLun, utmTooManyMaps, diagReadFailure, diagSrcLinkDown, diagWriteFailure, diagLoopbackError, diagTimeout, diagInProgress, diagNoAlt, diagIconSendErr, diagInitErr, diagModeErr, diagInvalidTestId, diagDriveErr, diagLockErr, diagConfigErr, diagNoCacheMem, diagNotQuiesced, diagUtmNotEnabled, invalidModeSwitch, invalidPortname, duplicateVolMapping, maxSnapsPerBaseExceeded, maxSnapsExceeded, invalidBasevol, snapNotAvailable, notDisabled, snapshotFeatureDisabled, repositoryOffline, repositoryReconfiguring, rollbackInProgress, numVolumesGroup, ghostVolume, repositoryMissing, invalidRepositoryLabel, invalidSnapLabel, invalidRollbackPriority, invalidWarnThreshold, cannotMapVolume, cannotFormatVolume, dstNotFibre, repositoryTooSmall, repositoryFailed, baseVolumeFailed, baseVolumeOffline, baseVolumeFormatting, metadataVolNonexistent, rvmFeatureDisabled, mirrorsPresent, rvmFeatureDeactivated, maxMirrorsExceeded, invalidMirrorCandidateVol, invalidMirrorvol, metadataAlreadyExists, metadataMissing, metadataOffline, metadataReconfiguring, localRoleChangeFailed, remoteRoleChangeFailed, localRoleChangeSuccessful, onlyLocalMirrorDeleted, noValidMirrorCandidate, remoteMaxMirrorsExceeded, remoteRvmFeatureDisabled, remoteMetadataVolNonexistent, notRegistered, remoteInvalidCfgGen, localRoleChangedNotForced, remoteRoleChangedLocalFailed, rvmSpmError, remoteAuthFailPassword, rvmVersionMismatch, rvmRemoteArrayError, rvmCommunicationError, rvmFibreError, mirrorVolNotPrimary, secNotPromoteable, priNotDemoteable, metadataChildDeletion, rmtvolOrphanDeletion, rvmActivateDisallowed, invalidTrayref, partialDeletion, defaultUtmCollision, invalidCopyPriority, invalidVolumecopyref, copyChangeFailed, copyActive, copyInactive, copyIncompatibleSource, copyIncompatibleTarget, copyGhostSource, copyGhostTarget, copyInvalidSourceRef, copyInvalidTargetRef, copyInvalidSourceState, copyInvalidTargetState, copySourceReconfig, copyTargetReconfig, copyTargetTooSmall, copyTargetLimit, maxVolumeCopysExceeded, copySourceReservation, copyTargetReservation, copySourceFormat, copyTargetFormat, copyStartFailed, copyStopFailed, volcopyFeatureDisabled, writeLock, cannotReconfigure, authFailContLockout, prReservationConflict, regDeleteFailed, batteryNotInConfig, batteryMissing, noChannel, rvmOperNotAllowedOnSec, dataRedundancyRequired, copySourceZeroCapacity, invHostlunDefineMapping, invHostlunMoveMapping, invHostlunDefineHosttype, invHostlunMoveHostport, fwIncompatible, mirrorAlreadySuspended, insuffLocalMirRepResources, insuffRemtMirRepResources, ghostHasUnreadableSectors, rvmCommStatRecoveredTimeout, rvmCommStatRecoveredDelay, rvmCommStatNotReady, rvmCommStatTimeout, rvmCommStatChannelFailure, rvmCommStatNetworkFailure, rvmCommStatDeviceMissing, rvmCommStatLoginRejected, rvmCommStatLoginFailure, rvmCommStatInvNumSamplesReqd, rvmQuiescenceInProgress, rvmInvalidRemotevol, sodInProgress, invalidDrives, invalidSetid, invalidSetsize, missingData, quiescenceFailed, validationError, downloadHalted, allFailed, partialOk, obsolete, usmClearFailed, controllerInServiceMode, invalidDrive, databaseError, backgroundAutocfg, autocfgInprogress, unsupportedLhaSataEsm, parityScanFailed, parityRepairFailed, mediaRepairFailed, mirrorDegraded, prohibitedByMdtRestrictions, prohibitedByGoldKeyRestrictions, safeControllerNotSubjectToGoldKey, safeMdtNotPremiumFeature, alarmNotPresent, dltNotCompleted, dependancyError, cdmDatabaseFull, requiredConditionNotPresent, ddcUnavail, ddcIllegalParam, invalidDdcTag, hosttypeConflict, portConflict, invalidHosttypeString, invalidProtocol, portRemoved, disableNotPermitted, prohibitedByDriveTrayLimit, invalidEsmref, invalidBundleMigration, invalidBundleKey, noSparesNeeded, prohibitedByFeatureBundleViolation, invalidAuthMethod, invalidSecret, secretAlreadyInUse, manualConfigModeSet, noIscsiSessions, invalidInterfaceref, initiatorConflict, initiatorRemoved, basevolSizeChanged, volumeGroupNotExist, volumeGroupNotOnline, volumeGroupHasHotspare, volumeGroupReconfiguring, volumeGroupStateNotValid, controllerNotOptimal, insufficientCapacity, volumeGroupExported, volumeNotConfigurable, volumeGroupNotConfigurable, invalidDriveState, volumeGroupReconstructing, volumeGroupUndergoingCopyback, volumeGroupNotComplete, volumeGroupHasFailedDrives, volumeGroupHasNonOptimalVols, volumeGroupHasMirrorRelationship, volumeGroupHasVolcopyRelationship, volumeGroupHasMirroringMetadata, volumeGroupHasMappedVols, volumeGroupHasReservations, volumeGroupHasIncompatibleDacstores, volumeLimitExceeded, volumeGroupHasUnknownRaidLevel, volumeGroupHasUnsupportedRaidLevel, volumeGroupHasCloneOpportunity, volumeGroupHasInsufficientDrives, volumeGroupHasFailedVols, perfTierSafeUpgradeDisabled, raid6FeatureUnsupported, raid6FeatureDisabled, safeControllerNotSubjectToRaid6, volumeGroupNotContingent, channelDiagsRunning, channelDiagsResultsPartial, volumeGroupHasSnapshotRelationship, prohibitedBySafeViolation, legacyVg, vgNotForceable, channelDiagsLockErr, channelDiagsNotQuiesced, channelDiagsAltCommFailed, channelDiagsChanSetupFailed, channelDiagsDeviceBypassFailed, channelDiagsResultsNotAvailable, driveSpinUpError, driveTypeMismatch, localRemoteArrayHasSameWwn, volumeGroupHasIncompatibleDrive, volumeGroupVolumeEncroachesOnDacstore, volumeGroupImportInProgress, drivesNeedToBeSpunUp, noNativeSstor, noSuchDebugChunk, debugInfoConfigChanged, lockdown, drivesDacstoresOverlap, volumeHasAsyncMirror, reconfigLogSpaceError, volumeGroupInaccessible, volumeInitializing, insufficientCache, volumeInaccessible, noDrivesAdopted, someDrivesAdopted, exportingDrivesDatabaseResynchronizing, exportingDrivesDatabaseFailed, exportingDrivesQuiesced, learnActiveTryLater, noLockedDrives, driveSecurityEnabledFailed, lockkeyFailed, invalidSecurity, noFdeDrives, volumeGroupSecure, invalidBlob, unlockFailed, noKeySet, rekeyInProgress, defaultHostGroupMappingNotAllowed, ssdMediaScanNotAllowed, premiumFeatureLimitExceedsMaximum, disableEvaluationFeatureNotPermitted, requestFailedDueToLun0Restrictions, externalKmsEnabled, externalKmsFailed, externalKmsNotEnabled, keyNotNeeded, keyInvalidSequence, diagNotRunning, ctrlNotInServiceMode, invalidFeatureref, cacheBackupDevNotExist, noMatchingLockKeyIdFound, lockKeyValidationFailed, lockKeyValidationDisabled, externalKmsNotCompliant, externalKmsTimeout, cannotDisableNoKey, previouslyEnabledForEval, featureNotKeyable, evalNotSupported, rawdataTransferBadType, rawdataTransferNotStarted, rawdataTransferAlreadyStarted, rawdataTransferPreparing, rawdataTransferReadError, rawdataTransferNoDrives, rawdataTransferInvalidImage, rawdataTransferCrcError, dbmRestoreWriteError, dbmRestoreNoDrives, rawdataBadSeqNum, invalidCapability, externalKeyNotInMemory, invalidLockKeyId, invalidProtection, volumeHasSnapshotRelationship, volumeHasMirrorRelationship, externalKmsDisabledNoKey, dbmRestoreAltCtlNotOffline, copyApptagMismatch, invalidRequestForEnclosure, dqRetrieveNothingToTransfer, invalidIscsiConfiguration, volumeHasVolcopyRelationship, partPiIncapable, requestFailedDueToPiRestrictions, rawdataTransferUserCancelled, duplicateIscsiIpAddress, portSpeedConflict, factoryDefaultDownloadFailed, errorWritingToEeprom, factoryDefaultPartialUpdate, snapshotNotActive, cannotRollback, mirrorSyncNotPossible, psuFirmwareDownloadFailed, psuFirmwareUpdateMfgDeviceCodeMismatch, psuFirmwareUpdateNotAllRedundant, psuFirmwareUpdateNotAllOptimal, insufficientRepositoryCapacity, rollbackStartFailure, csbReserveFailed, csbReleaseFailedNoLock, csbReleaseFailedInvalidKey, flashcacheAlreadyExists, flashcacheFeatureDisabled, flashcacheAlreadySuspended, flashcacheNotSuspended, flashcacheInvalidConfigType, invalidPitGroupLabel, invalidPitConsistencyGroupLabel, invalidPitAutoDeleteLimit, invalidPitRepositoryFullPolicy, invalidConcatVolMemberLabel, concatVolMemberTooSmall, invalidPitGroupRef, invalidPitRef, dveNotAllowed, dssNotAllowed, dplCoreDumpInvalidTag, invalidPitViewLabel, invalidPitViewRef, invalidConcatVolRef, notFlashcacheVol, flashcacheDeleted, flashcacheEnabled, flashcacheNotEnabled, noRepDeletion, maxPitsPerGroupExceeded, maxPitsExceeded, maxPitGroupsPerBaseExceeded, maxPitGroupsExceeded, maxViewsPerPitExceeded, maxViewsExceeded, maxConsistencyGroupsExceeded, maxConsistencyGroupMembersExceeded, maxMappableVolumesExceeded, notOldestPit, viewStopped, concatMemberLimitExceeded, invalidMemberVol, memberVolMapped, invalidMemberVolState, invalidTrimCount, pitGroupInConsistencyGroup, pitInConsistencyGroup, pitViewInConsistencyGroup, incompatibleMemberVol, volumeInUse, rvmOverIscsiNotSupported, arvmGroupUserLabelExists, arvmGroupDoesNotExist, arvmGroupNotEmpty, concatVolumeFailed, invalidPitConsistencyGroupRef, invalidPitConsistencyGroupViewRef, invalidPitConsistencyGroupViewLabel, alternateRequiredForOperation, invalidPitForView, consistencyGroupArvmBindingConflict, attributeFixedByArvm, operationFailedVolumeCopyClone, pitCreatePending, dbmDbSourceUnavailable, dbmRestoreSourceMismatch, invalidCriticalThreshold, volumeGroupHasArvmRelationship, arvmRecoveryPointDeletionRequired, volumeGroupHasPitgroupRelationship, volumeGroupHasPitviewRelationship, volumeGroupHasConcatRelationship, flashcacheSuspended, flashcacheAlreadyEnabled, dbmDbImageCorrupt, illegalVolume, invalidRepositoryCapacity, invalidProvisionedCapacityQuota, invalidExpansionPolicy, invalidVirtualCapacity, cannotExpandConcatMember, thresholdBelowUsedCapacity, invalidExpansionOperation, repositoryFull, insufficientExpansionSpace, invalidExpansionSize, invalidReinitAction, invalidReinitCapacity, invalidIncompleteMemberRef, arvmGroupNotPrimary, arvmGroupNotSecondary, arvmMemberFailed, arvmGroupNotSuspended, arvmInvalidMirrorState, arvmVolumeAlreadyInMirrorRelationship, arvmMemberLimitExceeded, arvmSuspendFailure, arvmResumeFailure, arvmSynchronizeFailure, remoteTargetNotFound, arvmMirrorMemberDoesNotExist, snapConversionTooManySnaps, snapConversionMissingLabel, arvmFeatureDeactivated, incompatibleRepositorySecurity, incompatibleSecondarySecurity, mirrorProtocolMismatch, arvmAsyncMirrorGroupPresent, cacheParametersNotChangeable, flashcacheMaxCapacityExceeded, flashcacheFailed, dplCoreDumpRestoreInProgress, arvmGroupHasIncompleteMember, arvmConnectivityTestAlreadyInProgress, arvmConnectivityTestNetworkError, arvmConnectivityTestRemoteTimeout, arvmConnectivityTestLoginFailure, arvmConnectivityTestNameServiceError, arvmConnectivityTestTurError, arvmConnectivityTestMissingRemoteAmg, arvmConnectivityTestAmgMemberMismatch, invalidSyncPriority, invalidRecoveryPointAlertThreshold, invalidSyncAlertThreshold, mustSpecifyExistingVolumes, arvmConnectivityTestTimeoutExceeded, flashcacheMaxLimitExceeded, volsInVgUsingNonSecureCapableFlashcache, volsInVgUsingSecureDisabledFlashcache, invalidSubmodelId, premiumFeatureLimitMismatch, volumeGroupNotImportable, primaryCacheSizeMismatch, flashcacheUserLabelExists, maxThinVolumesExceeded, arvmInvalidSecondaryCapacity, arvmOnlyPrimaryMemberRemoved, arvmOnlySecondaryMemberRemoved, arvmInvalidAmgRequestWhileSuspended, arvmManualSyncAlreadyInProgress, arvmManualSyncRetryTooSoon, diskPoolNotEmpty, flashCacheInvalidBaseVol, flashCacheFdeEnablementDisallowed, remoteArvmFeatureDeactivated, remoteArvmFeatureDisabled, arvmOrphanGroup, arvmOrphanMember, volumeNotAvailable, volumeHasUnreadableSectors, thinProvisioningFeatureDisabled, pitGroupsFeatureDisabled, exceedDiskPoolLimit, flashcacheDegradedState, flashcacheNonDaCapableDriveDisallowed, arvmMaxAsyncMirrorGroupsExceeded, arvmMaxMirrorsPerArrayExceeded, maxTotalMirrorsPerArrayExceeded, exceedDiskPoolCapacity, exceedMaxVolumeCapacity, arvmRemoteMaxAsyncMirrorGroupsExceeded, arvmRemoteMaxMirrorsPerArrayExceeded, remoteMaxTotalMirrorsPerArrayExceeded, arvmInvalidSyncInterval, remoteNoHeap, remoteInternalError, remoteRvmSpmError, arvmRemoteMirrorMemberDoesNotExist, arvmRemoteGroupUserLabelExists, arvmRemoteGroupNotSecondary, arvmRemoteGroupDoesNotExist, remoteInvalidProtection, remoteDatabaseError, arvmRemoteGroupNotEmpty, arvmRemoteSuspendFailure, arvmRemoteResumeFailure, arvmRemoteSynchronizeFailure, flashcacheInvalidAnalyticsState, arvmExpansionSynchronizationInProgress, arvmRemoteExpansionSynchronizationInProgress, faultConditionStillExists, remoteTryAlternate, arvmOnlyLocalAmgDeleted, arvmRoleChangePending, arvmRoleChangeInProgress, arvmMemberStopped, reconstructionInProgress, copybackInProgress, adminPasswordNotSet, keyDoesNotExist, takeRecoveryActionsFirst, coredumpBackupInProgress, legacyRvmAsyncModeUnsupported, arvmIncorrectVolumeType, thinVolumeParametersCannotBeModified, arvmRemoteThinNotSupported, snmpInvalidCommunityName, snmpInvalidCommunityPermission, snmpInvalidCommunityRef, snmpInvalidTrapDestinationRef, invalidIpAddress, snmpMaxCommunitiesExceeded, snmpMaxTrapDestinationsExceeded, snmpCommunityNameInUse, snmpTrapDestinationAddressInUse, snmpUnknownSystemVariable, snmpInvalidSystemVariableValue, snmpIncompatibleFirmware, snmpAgentDisabled, snmpAgentInitFailed, arvmThinVolInitError, arvmRemoteThinVolInitError, snmpIncompatibleIpv4Address, snmpIncompatibleIpv6Address, drivesNotAvailableForRemoval, snmpCannotDisableIpv4, snmpCannotDisableIpv6, snmpIpv4ConfigError, iocDumpInProgress, iocRestoreInProgress, iocDumpInvalidTag, unsupportedEsmRequest, isnsDhcpNotSupported, dpcVolumeGroupNotRedundant, dpcVolumeNotInitialized, dpcExclusiveOperationActive, dpcUnableToPowerUpDrive, dpcFormatActive, dpcUnreadableSectorsPresent, dpcPowerCycleAlreadyInProgress, dpcEnclosureHardwareUnsupported, dpcEnclosureFwDownlevel, evacInProgress, noEvacFound, noHotspareAvailable, driveServiceInProgress, hdd4kbSegmentsizeNotAllowed, diskPoolNoSpareDrives, diskPoolExceedSpareCapacity, autoLoadBalanceUserDisabled, autoLoadBalanceInsufficientStatistics, invalidLoadBalanceAction, invalidLoadBalanceDelay, reservedAddress, volumeCreationInProgress, keyValueTagInvalidRef, keyValueTagInvalidDuplicate, keyValueTagInUse, workloadInvalidRef, invalidKeyValueTagObjectReference, mappingInvalidDuplicate, downloadCompleteNoReboot, downloadCompleteMswOnlyReboot, workloadInvalidDuplicate, mappingInvalidRef, workloadInUse, embeddedExternalKeyManagementEnabled, embeddedExternalKeyManagementCertificatesNotInstalled, illegalOperationOnAllConfigDrives, databaseResyncInProgress, embeddedEkmsKeyserverInfoMissing, embeddedEkmsClientKeyMissing, embeddedEkmsClientCertMissing, embeddedEkmsClientCertMismatch, embeddedEkmsCertExpired, embeddedEkmsProxyNotResponding, embeddedEkmsAuthenticationFailure, embeddedEkmsKeyOwnerRequired, embeddedEkmsServerError, embeddedEkmsServerCertMissing, embeddedEkmsCertDuplicate, embeddedEkmsCertInvalid, embeddedEkmsConnectionFailure, invalidPasswordLength, certRevoked, missingSignature, sigValidationFailed, unableToConnectToOcspResponder, requestFailedDueToAlbEnabled, __UNDEFINED) |
successful |
Example : |
boolean |
controllerRef |
Example : |
string |
amgRef |
Example : |
string |
testType |
Example : |
enum (connectivityTestUnknown, basicConnectivityTest, linkLatencyTest, linkBandwidthTest, __UNDEFINED) |
bwTestResult |
Example : |
|
latTestResult |
Example : |
4.42. AsyncMirrorGroupLinkBandwidthTestResults
Name | Description | Schema |
---|---|---|
latencyMeasures |
The bandwidth test also returns latency values since latency numbers are measured in order to factor them out of the bandwidth calculations. |
|
minBandwidthBitsPerSecond |
The minimum bandwidth measured in bits per second. |
string (int64) |
maxBandwidthBitsPerSecond |
The maximum bandwidth measured in bits per second. |
string (int64) |
avgBandwidthBitsPerSecond |
The average bandwidth measured in bits per second. |
string (int64) |
negotiatedLinkSpeedBitsPerSecond |
The negotiated link speed measured in bits per second. |
string (int64) |
4.43. AsyncMirrorGroupLinkLatencyTestResults
Name | Description | Schema |
---|---|---|
minLatencyInMicroseconds |
The minimum latency measured in microseconds. |
integer (int32) |
maxLatencyInMicroseconds |
The maximum latency measured in microseconds. |
integer (int32) |
avgLatencyInMicroseconds |
The average latency measured in microseconds. |
integer (int32) |
4.44. AsyncMirrorGroupConnectivityTestRequest
Request that a connectivity test be performed between the local and remote Amg’s.
Name | Description | Schema |
---|---|---|
requestedTestType |
Type of test to perform. |
enum (connectivityTestUnknown, basicConnectivityTest, linkLatencyTest, linkBandwidthTest, __UNDEFINED) |
testIterations |
Number of test iterations to run. |
integer (int32) |
timeout |
Timeout in seconds. For no timeout, this value should be set to -1. |
integer (int32) |
4.45. AsyncMirrorGroupSyncRequest
Creates an async mirror group (issued to the array with the primary role).
Name | Description | Schema |
---|---|---|
deleteRecoveryPointIfNecessary |
Indicates whether the failures point can be deleted on the secondary if necessary to achieve the synchronization. If true, and if the amount of unsynchronized data exceeds the CoW repository capacity on the secondary for any member volume, the last failures point will be deleted and synchronization will continue. If false, the synchronization will be suspended if the amount of unsynchronized data exceeds the CoW Repository capacity on the secondary and the failures point will be preserved. |
boolean |
4.46. AmgIncompleteMember
Name | Description | Schema |
---|---|---|
memberRef |
The reference (key) for the group member. |
string |
groupRef |
The associated Async Mirror Group. |
string |
primaryVolWWN |
The WWN of the primary volume on the remote array. |
string |
primaryVolCapacity |
Capacity of the primary (used to aid in selection of mirror secondary volume). |
string (int64) |
primaryVolRAIDLevel |
RAID level of the primary volume. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
primaryVolProtectionType |
The protection type of the primary volume. |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
primaryVolSecurityType |
Security type of the primary volume. |
enum (unknown, none, capable, enabled, __UNDEFINED) |
primaryVolUserLabel |
User label of the primary volume. |
string |
orphanIncompleteMember |
If true, the incomplete member is an orphan. |
boolean |
primaryVolumeParameters |
The capacity provisioning parameters for the primary volume. |
|
primaryVolSecurityLevel |
Refines the information in the securityType field to describe the set of drives. |
enum (unknown, none, mixed, fde, fips, __UNDEFINED) |
remoteTargetWwn |
The WWN of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created. |
string |
remoteTargetName |
The user label of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode. |
string |
remoteTargetId |
The id of the target array in the mirroring relationship. This field may not be immediately available after an AMG is created, and will not be available in embedded mode. |
string |
id |
Example : |
string |
4.47. ThinVolumeCapacityProvisioningDetails
Name | Description | Schema |
---|---|---|
capacityQuota |
The maximum capacity to which the Expandable Repository Volume can grow (in bytes). |
string (int64) |
growthAlertThreshold |
The alert threshold percent value for the Expandable Repository Volume. |
integer (int32) |
repositoryExpansionPolicy |
The expansion policy for the Expandable Repository Volume. |
enum (unknown, manual, automatic, __UNDEFINED) |
4.48. VolumeTypeParameters
Name | Description | Schema |
---|---|---|
volumeType |
This enumeration is used to identify the capacity provisioning of a volume. |
enum (unknown, thinProvisioned, thickProvisioned, __UNDEFINED) |
capacityProvisioningDetails |
This field is returned if the value of returnCode is equal to RETCODE_OK. |
4.49. AsyncMirrorGroupMemberCompletionRequest
Name | Description | Schema |
---|---|---|
secondaryPoolId |
Storage pool on the target StorageSystem to create the mirrored pair repository volume on. This defaults to the pool that the secondaryVolume belongs to. |
string |
secondaryVolumeRef |
Example : |
string |
scanMedia |
Default : |
boolean |
validateRepositoryParity |
Default : |
boolean |
secondaryPercentCapacity |
Percentage of the capacity of the secondary volume to use for the repository capacity. |
number (double) |
secondaryRepositoryCandidate |
Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected. |
4.50. ConcatVolumeCandidate
Name | Description | Schema |
---|---|---|
candType |
This enumeration is used to specify the Concatenated Volume candidate type. |
enum (unknown, newVol, existingVols, expansion, __UNDEFINED) |
newVolCandidate |
This field is present only if the ConcatVolumeCandidateType value is equal to CONCAT_VOL_CANDIDATE_TYPE_NEW_VOL. |
|
existVolCandidate |
This field is present only if the ConcatVolumeCandidateType value is equal to CONCAT_VOL_CANDIDATE_TYPE_EXISTING_VOLS. |
|
expansionDescriptor |
This field is present only if the ConcatVolumeCandidateType value is equal to CONCAT_VOL_CANDIDATE_TYPE_EXPANSION. |
4.51. ConcatVolumeDirectExpansionDescriptor
Name | Description | Schema |
---|---|---|
additionalCapacity |
Additional capacity to add to the last member of the ConcatVolume. |
string (int64) |
4.52. ConcatVolumeExistingVolumeCandidate
Name | Description | Schema |
---|---|---|
refType |
This enumeration is used to specify the Concatenated Volume Member reference type. |
enum (unknown, volref, label, __UNDEFINED) |
memberVolumeRef |
A list of member volumes specified using volume references. This field is present only if the value of refType is equal to CONCAT_VOL_MEMBER_REF_TYPE_VOLREF. |
< string > array |
memberLabel |
A list of member volumes specified using volume labels. This field is present only if the value of refType is equal to CONCAT_VOL_MEMBER_REF_TYPE_LABEL. |
< string > array |
4.53. ConcatVolumeNewVolumeCandidate
Name | Description | Schema |
---|---|---|
memberVolumeLabel |
The label for the new member volume. |
string |
memberVolumeGroupLabel |
An optional volume group label if creating a new volume group. |
string |
memberCandidate |
The candidate to be used to create the member volume. |
|
memberCapacity |
The capacity of the new volume to create, in bytes. |
string (int64) |
4.54. DiskPoolVolumeCandidateData
Name | Description | Schema |
---|---|---|
reconstructionReservedDriveCount |
The number of drives reserved for reconstruction of failed drives. |
integer (int32) |
reconstructionReservedAmt |
The pool capacity reserved to hold rebuild data (in bytes). This value is calculated from the reconstructionReservedDriveCount. |
string (int64) |
unusableCapacity |
This value identifies how much capacity (in bytes) is being wasted due to a mix of drive sizes. This value will be zero as long as the pool consists of like drive sizes. |
string (int64) |
4.55. DriveRefList
Name | Description | Schema |
---|---|---|
driveRef |
A variable-length array of DriveRef objects. |
< string > array |
4.56. ProtectionInformationCapabilities
Name | Description | Schema |
---|---|---|
protectionInformationCapable |
True when all drive(s) are PI capable. |
boolean |
protectionType |
This field is set to the protection type provided for the drive(s). |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
4.57. VolumeCandidate
Name | Description | Schema |
---|---|---|
raidLevel |
The RAID level of the potential volume. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
trayLossProtection |
This field is set to true if the candidate has tray loss protection. |
boolean |
rawSize |
This value is the maximum allowed user data storage capacity for the volume if the smallest possible segment is used in creating the volume. |
string (int64) |
usableSize |
This value is the maximum allowed user data storage capacity for the volume if the largest possible segment is used in creating the volume. |
string (int64) |
driveCount |
The number of drives in the potential volume’s volume group. |
integer (int32) |
freeExtentRef |
The reference value of the free extent on which the potential volume would be created. This field will be valid only if the volume candidate was obtained using a candidate selection type of CANDIDATE_SEL_FREE_EXTENT. |
string |
driveRefList |
A list of the reference values of the drives on which the volume group for the potential volume would be created. This field will be valid only if the volume candidate was obtained using a candidate selection type of CANDIDATE_SEL_MANUAL. |
|
candidateSelectionType |
The type of candidate selection that was used to obtain this volume candidate. |
enum (freeExtent, manual, count, __UNDEFINED) |
spindleSpeedMatch |
True, if all drives have matching spindle speed. |
boolean |
spindleSpeed |
True, if all drives have matching spindle speed. |
integer (int32) |
phyDriveType |
The physical drive type. |
enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) |
dssPreallocEnabled |
True if dynamic segment sizing pre-allocation will be enabled for the volume created from this candidate, otherwise false. |
boolean |
securityType |
The desired security level of the drive group. |
enum (unknown, none, capable, enabled, __UNDEFINED) |
drawerLossProtection |
This field is set to true when the volume group has drawer loss protection; otherwise it is set to false |
boolean |
driveMediaType |
Drive media type (HDD or SSD) of the volume candidate. |
enum (all, unknown, hdd, ssd, __UNDEFINED) |
protectionInformationCapable |
This field is no longer used. |
boolean |
protectionInformationCapabilities |
This structure contains a protectionInformationCapable field which is set to true if all drives in the volume group where the volume candidate resides are Protection Information (PI) capable. It also contains the protection type for the volume group. |
|
volumeCandidateData |
Information about the Volume Candidate. |
|
driveBlockFormat |
Identifies the drive block format of the volume candidate. |
enum (unknown, allNative, allEmulated, mixed, __UNDEFINED) |
allocateReservedSpace |
Determines whether or not reserved space is allocated on the drives in the volume group. |
boolean |
securityLevel |
Describes the overall security level of the drive set. Values can include: FDE only, FIPS only, mixed, or no security. Used along with the SecurityType field. |
enum (unknown, none, mixed, fde, fips, __UNDEFINED) |
4.58. VolumeCandidateTypeData
Name | Description | Schema |
---|---|---|
type |
This enumeration is used to indicate the type of the volume group. |
enum (unknown, traditional, diskPool, __UNDEFINED) |
diskPoolVolumeCandidateData |
This field is present only if the value of type is equal to VG_TYPE_DISK_POOL. |
4.59. AsyncMirrorGroupMemberCreateRequest
Name | Description | Schema |
---|---|---|
primaryPoolId |
Storage pool on the source StorageSystem to create the mirrored pair repository volume on. This defaults to the pool that the primaryVolume belongs to. |
string |
secondaryPoolId |
Storage pool on the target StorageSystem to create the mirrored pair repository volume on. This defaults to the pool that the secondaryVolume belongs to. |
string |
primaryVolumeRef |
Example : |
string |
secondaryVolumeRef |
Example : |
string |
primaryRepositoryCandidate |
Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected. |
|
secondaryRepositoryCandidate |
Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected. |
|
scanMedia |
Default : |
boolean |
validateRepositoryParity |
Default : |
boolean |
percentCapacity |
Percentage of the capacity of the primary volume to use for the repository capacity. |
number (double) |
secondaryPercentCapacity |
Percentage of the capacity of the secondary volume to use for the repository capacity. Defaults to percentCapacity. |
number (double) |
4.60. RelativeDistinguishedName
Name | Description | Schema |
---|---|---|
attributes |
The attributes for the relative distinguished name. |
< RelativeDistinguishedNameAttribute > array |
4.61. RelativeDistinguishedNameAttribute
Name | Description | Schema |
---|---|---|
name |
The attribute name. |
string |
value |
The attribute value. |
string |
4.62. SSLCertConfiguration
Configuration information to setup certificates.
Name | Description | Schema |
---|---|---|
dn |
The distinguished name for the certificate. This is used by the LDAP API to reference the LDAP object. An example value would be "uid=john.doe,ou=People,dc=example,dc=com". If this value is provided then any values provided for the rdns will be ignored. |
string |
rdns |
List of relative distinguished names that can be combined to create the distinguished name (dn). These values will be ignored if a domain name (dn) is provided. |
< RelativeDistinguishedName > array |
subjectAlternateNames |
If provided, this will attach a Subject Alternate Name extension to the certificate to allow the user to bind additional properties (email address, DNS name, etc) to the subject of the certificate. |
< SubjectAlternateName > array |
4.63. SubjectAlternateName
A Subject Alternate entry for the x509 Certificate
Name | Description | Schema |
---|---|---|
sanType |
Type of Subject Alternate |
enum (ip, dns) |
sanValue |
The value for the alternate |
string |
4.64. ManagementCertificates
Provides information for the discovered certificates
Name | Description | Schema |
---|---|---|
storageArrayAssociation |
Indicates if the certificate is associated with an already added array. |
boolean |
associatedIP |
The IP associated with the certificate |
string |
controller |
Example : |
|
certificate |
Example : |
4.65. StorageSystemController
Provides information for the storage array associated with a given certificate
Name | Description | Schema |
---|---|---|
controllerId |
The identifier for the controller |
string |
controllerSerialNumber |
The serial number for the controller |
string |
arrayID |
The storage system ID |
string |
arrayLabel |
The storage system label |
string |
arrayWWN |
The storage system world wide name |
string |
4.66. X509CertInfo
Basic information for X509 Certs stored in the system.
Name | Description | Schema |
---|---|---|
alias |
The alias for the certificate. This value will only be present if the certificate is in the proxy server truststore. |
string |
shaFingerprint |
The SHA fingerprint for the certificate |
string |
sha256Fingerprint |
The SHA256 fingerprint for the certificate |
string |
subjectDN |
The subject distinguished name for the certificate |
string |
subjectRdns |
The list of values that make up the subjectDN for the certificate |
< RelativeDistinguishedName > array |
issuerDN |
The issuer distinguished name for the certificate |
string |
issuerRdns |
The list of values that make up the issuerDN for the certificate |
< RelativeDistinguishedName > array |
start |
The date that the certificate was issued |
string (date-time) |
expire |
The date that the certificate expires |
string (date-time) |
status |
The certificate status |
enum (trusted, selfSigned, expired, incompleteTrustChain, commonNameMismatch, unknown) |
truststore |
Indicates if the certificate is in the truststore |
boolean |
isUserInstalled |
Indicates if the certificate was installed by the user |
boolean |
isKeyEntry |
Returns true if the entry identified by the given alias was created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry or a SecretKeyEntry. |
boolean |
type |
Indicates if the certificate is self-signed, CA-signed or a root or intermediate certificate. Root or intermediate certificates that were created without the basic constraints extension may show a value of 'selfSigned' instead of 'certificateAuthority' |
enum (selfSigned, caSigned, certificateAuthority) |
4.67. PrivateFileInfo
Name | Description | Schema |
---|---|---|
fileSize |
The size of the file |
string (int64) |
fileID |
The GUID for the file |
string |
fileURL |
The URL for the file |
string (uri) |
4.68. FileRequest
Information for requesting a file
Name | Description | Schema |
---|---|---|
filename |
Optionally used to specify the filename |
string |
4.69. CertRevocatSettings
Server certificate revocation settings.
Name | Description | Schema |
---|---|---|
revocationChecking |
Set to true to enable certificate revocation checking; by default this is not enabled. |
boolean |
ocspResponderAddress |
The URL of the OCSP responder to be used by default; if left blank the OCSP responder address specified in the certificate will be used. |
string |
strictCertVerificationEnabled |
Set to true to enable strict certificate verification checking; by default this is not enabled. |
boolean |
4.70. ConfigurationResult
The results of the last configuration operation
Name | Description | Schema |
---|---|---|
startDate |
The time the configuration operation started |
string (date-time) |
endDate |
The time the operation finished. Null if an operation is in progress |
string (date-time) |
currentResults |
The list of results for each system being configured. The size of this list will be < total until the operation is finished |
< ConfigurationResultItem > array |
totalSystems |
the total number of systems requested to be configured |
integer (int32) |
numberDone |
the number of system currently attempted |
integer (int32) |
operationDone |
true when the configuration operation is finished |
boolean |
4.71. ConfigurationResultItem
Holds the result of the configuration actiopn for a single storage system
Name | Description | Schema |
---|---|---|
systemKey |
The key from the csv file for the storage system |
string |
success |
True if the configuration did not have any reported errors |
boolean |
response |
If the operation did not succeed, this properties has the error information |
4.72. FileBasedConfigurationRequest
Defines the parameters for a file based bulk configuration request
Name | Description | Schema |
---|---|---|
skipHeader |
Indicates the first line of the file is a header line and should be skipped |
boolean |
fileName |
The name of a previously uploaded CSV file from which to pull configuration data |
string |
configItems |
A list of column to configuration items pairs |
< FileConfigItem > array |
4.73. FileConfigItem
An element describing what column in a CSV file maps to what configuration item
Name | Description | Schema |
---|---|---|
column |
The column in the CSV File. 0 based value |
integer (int32) |
type |
Example : |
enum (systemSerialNumber, controllerAPort1IP4, controllerAPort2IP4, controllerBPort1IP4, controllerBPort2IP4, controllerAPort1IP6, controllerAPort2IP6, controllerBPort1IP6, controllerBPort2IP6, controllerAPort1Netmask4, controllerAPort2Netmask4, controllerBPort1Netmask4, controllerBPort2Netmask4, controllerAPort1Netmask6, controllerAPort2Netmask6, controllerBPort1Netmask6, controllerBPort2Netmask6, controllerAIPv4GW, controllerAIPv6GW, controllerBIPv4GW, controllerBIPv6GW, systemLabel, saPassword, systemKey, metaData) |
4.74. ValidateConfigurationFileResponseItem
This object contains the results of a spread sheet parse to allow the user to test without configuring systems
Name | Description | Schema |
---|---|---|
row |
The 1 based row identifier. Row 0 is the header row and is not returned |
integer (int32) |
type |
The configuration item type |
enum (systemSerialNumber, controllerAPort1IP4, controllerAPort2IP4, controllerBPort1IP4, controllerBPort2IP4, controllerAPort1IP6, controllerAPort2IP6, controllerBPort1IP6, controllerBPort2IP6, controllerAPort1Netmask4, controllerAPort2Netmask4, controllerBPort1Netmask4, controllerBPort2Netmask4, controllerAPort1Netmask6, controllerAPort2Netmask6, controllerBPort1Netmask6, controllerBPort2Netmask6, controllerAIPv4GW, controllerAIPv6GW, controllerBIPv4GW, controllerBIPv6GW, systemLabel, saPassword, systemKey, metaData) |
value |
The data found for the row |
string |
4.75. ValidateConfiurationFileResponse
The respoinse from a validate configuration file request
Name | Description | Schema |
---|---|---|
fileFound |
Example : |
boolean |
items |
Example : |
< ValidateConfigurationFileResponseItem > array |
4.76. PITConsistencyGroup
Name | Description | Schema |
---|---|---|
cgRef |
The reference (key) for this PITConsistencyGroup. |
string |
label |
The name of the Consistency Group. |
string |
repFullPolicy |
The behavior on repository full condition. |
enum (unknown, failbasewrites, purgepit, __UNDEFINED) |
fullWarnThreshold |
The repository utilization warning threshold percentage. |
integer (int32) |
autoDeleteLimit |
The auto-delete indicator. If non-zero, the oldest PiT will be automatically deleted when creating a new one to keep the total number of PiTs limited to the number specified. |
integer (int32) |
rollbackPriority |
The importance of the rollback operation. |
enum (highest, high, medium, low, lowest, __UNDEFINED) |
uniqueSequenceNumber |
A list of all unique sequence numbers for all existing PiTs of members in this consistency group. |
< string (int64) > array |
creationPendingStatus |
The status of Pending PiT Creation. |
enum (unknown, none, waiting, failed, __UNDEFINED) |
name |
Example : |
string |
id |
Example : |
string |
4.77. ConsistencyGroupUpdateRequest
Updates a consistency group
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the new consistency group |
string |
fullWarnThresholdPercent |
The full warning threshold percent |
integer (int32) |
autoDeleteThreshold |
The auto-delete threshold. Automatically delete snapshots after this many. |
integer (int32) |
repositoryFullPolicy |
The repository full policy. |
enum (unknown, failbasewrites, purgepit, __UNDEFINED) |
rollbackPriority |
Roll-back priority |
enum (highest, high, medium, low, lowest, __UNDEFINED) |
4.78. ConsistencyGroupCreateRequest
Used to create a consistency group
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the new consistency group |
string |
fullWarnThresholdPercent |
The full warning threshold percent |
integer (int32) |
autoDeleteThreshold |
The auto-delete threshold. Automatically delete snapshots after this many. |
integer (int32) |
repositoryFullPolicy |
The repository full policy. |
enum (unknown, failbasewrites, purgepit, __UNDEFINED) |
rollbackPriority |
Roll-back priority |
enum (highest, high, medium, low, lowest, __UNDEFINED) |
4.79. PITCGMember
Name | Description | Schema |
---|---|---|
consistencyGroupId |
Example : |
string |
volumeId |
Example : |
string |
volumeWwn |
Example : |
string |
baseVolumeName |
Example : |
string |
clusterSize |
The cluster size (in bytes). |
integer (int32) |
totalRepositoryVolumes |
Total number of repository volumes in use by the underlying snapshotGroup |
integer (int32) |
totalRepositoryCapacity |
Total repository capacity |
string (int64) |
usedRepositoryCapacity |
The amount of repository capacity that is being utilized |
string (int64) |
fullWarnThreshold |
The capacity threshold at which the user will be warned about running out of capacity for the repository |
integer (int32) |
totalSnapshotImages |
The total number of snapshot images defined for this member |
integer (int32) |
totalSnapshotVolumes |
The total number of snapshot volumes defined for this member |
integer (int32) |
autoDeleteSnapshots |
Automatically purge all snapshots over this value |
boolean |
autoDeleteLimit |
If autoDeleteSnapshots is enabled, the maximum number allowed before autoDeletion occurs |
integer (int32) |
pitGroupId |
Reference to the snapshotGroup |
string |
repositoryVolume |
Reference to the repository volume of the pitGroup/snapshotGroup |
string |
4.80. PITConsistencyGroupView
Name | Description | Schema |
---|---|---|
cgViewRef |
The reference (key) for this PITConsistencyGroupView. |
string |
groupRef |
The PiT Consistency Group to which the Consistency Group View belongs. |
string |
label |
The name of the Consistency Group View. |
string |
viewTime |
The controller-time (measured in seconds since January 1, 1970) when the Consistency Group View was created or re-attached to another PiT. All member Views that are part of this Consistency Group View have this value in their corresponding fields. |
string (int64) |
viewSequenceNumber |
The view sequence number. This is a monotonically increasing sequence value that is common across all member Views that are part of this Consistency Group View. |
string (int64) |
name |
Example : |
string |
id |
Example : |
string |
4.81. AddConsistencyGroupMemberRequest
Add consistency group member volume
Name | Description | Schema |
---|---|---|
volumeId |
The member volume ref |
string |
repositoryPoolId |
The repository volume pool |
string |
scanMedia |
Default : |
boolean |
validateParity |
Default : |
boolean |
repositoryPercent |
Default : |
number (double) |
repositoryCandidate |
Example : |
4.82. AddBatchCGMembersRequest
Name | Description | Schema |
---|---|---|
volumeToCandidates |
A map of volume refs to ConcatVolumeCandidates that will be used for creating the repository volumes. |
< string, ConcatVolumeCandidate > map |
scanMedia |
Default : |
boolean |
validateParity |
Default : |
boolean |
4.83. Snapshot
Name | Description | Schema |
---|---|---|
pitRef |
The reference (key) for this PiT. |
string |
pitGroupRef |
A reference to the associated PiT Group. |
string |
creationMethod |
The PiT creation method. |
enum (unknown, user, schedule, __UNDEFINED) |
pitTimestamp |
The controller-time (measured in seconds since January 1, 1970) when the PiT was created. |
string (int64) |
pitSequenceNumber |
The sequence number within PITGroup. This is a monotonically increasing sequence value that can be used to determine the absolute order of the PiTs within a PiT group. Using this sequence number avoids issues with timestamps when real-time clocks are changed. Note that this sequence number will be the same on all PiTs taken in multiple PITGroups at the same time under a single IO suspension, either as part of a consistency group operation (createCGPIT) or when a list of PITGroups is passed to createPIT. |
string (int64) |
status |
The state of this PiT. |
enum (unknown, optimal, failed, purged, __UNDEFINED) |
activeCOW |
If true, the PiT is actively recording copy-on-write data. |
boolean |
isRollbackSource |
If true, the PiT is a rollback source. |
boolean |
pitCapacity |
The capacity in bytes of this PiT (capacity of the base at the time the PiT was created). |
string (int64) |
repositoryCapacityUtilization |
Repository utilization in bytes (only reported if activeCOW = false). |
string (int64) |
baseVol |
Example : |
string |
consistencyGroupId |
Example : |
string |
id |
Example : |
string |
4.84. CreateConsistencyGroupSnapshotRequest
Type : object
4.85. PITViewMembership
Name | Description | Schema |
---|---|---|
viewType |
This enumeration identifies the possible types for a PITView. |
enum (unknown, individual, member, __UNDEFINED) |
cgViewRef |
A reference to the PITConsistencyGroupView is returned if the value of viewType is equal to PIT_VIEW_TYPE_MEMBER. |
string |
4.86. PitViewEx
Name | Description | Schema |
---|---|---|
viewRef |
The reference (key) for this view. |
string |
worldWideName |
The WWN of the view. |
string |
baseVol |
A reference to the base volume with which this view is associated. |
string |
basePIT |
A reference to the particular PiT of the base for which this view applies. This field is only valid if the boundToPIT field is true. |
string |
boundToPIT |
If true, this flag indicates that the basePIT field is a valid reference to an associated PIT. If false, the view is disassociated from the PiT so the basePIT reference is invalid. |
boolean |
accessMode |
The view access mode. |
enum (modeUnknown, readWrite, readOnly, __UNDEFINED) |
label |
The name of the view. |
string |
status |
The view status. |
enum (unknown, optimal, stopped, failed, overThreshold, full, __UNDEFINED) |
currentManager |
The current owner of the view. |
string |
preferredManager |
The preferred owner of the view. |
string |
repositoryVolume |
The copy-on-write repository for this view. |
string |
fullWarnThreshold |
The repository utilization warning threshold percentage. |
integer (int32) |
viewTime |
The controller-time (measured in seconds since January 1, 1970) when view was created or re-attached to another PiT. |
string (int64) |
viewSequenceNumber |
Sequence number. This is a monotonically increasing sequence value that can be used to determine related views when the view was created as part of a consistency group operation. |
string (int64) |
perms |
The permissions for the view. |
|
volumeHandle |
The volume ssid. This is provided primarily for debug purposes. |
integer (int32) |
clusterSize |
The cluster size in bytes. |
integer (int32) |
maxRepositoryCapacity |
The maximum allowable repository size in bytes based on current cluster size. |
string (int64) |
unusableRepositoryCapacity |
The amount of repository capacity in bytes that is unusable due to limited addressability of the current cluster size. |
string (int64) |
membership |
This view’s relationship (if any) to a Consistency Group View. |
|
mgmtClientAttribute |
The management client attribute. |
integer (int32) |
offline |
The view is offline due to the associated repository volume state. |
boolean |
extendedUniqueIdentifier |
A variable-length opaque field that provides the volume’s extended unique identification value. |
string |
volumeFull |
Example : |
boolean |
repositoryCapacity |
Example : |
string (int64) |
baseVolumeCapacity |
Example : |
string (int64) |
totalSizeInBytes |
Example : |
string (int64) |
consistencyGroupId |
Example : |
string |
volumeCopyTarget |
Example : |
boolean |
cloneCopy |
Example : |
boolean |
volumeCopySource |
Example : |
boolean |
pitBaseVolume |
Example : |
boolean |
asyncMirrorTarget |
True if the volume is a target in an Asynchronous Mirror relationship. |
boolean |
asyncMirrorSource |
True if the volume is a source in an Asynchronous Mirror relationship. |
boolean |
protectionType |
Example : |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
remoteMirrorSource |
True if the volume is a source (primary), in an Remote Volume Mirror relationship. |
boolean |
remoteMirrorTarget |
True if the volume is a target (secondary), in an Remote Volume Mirror relationship. |
boolean |
objectType |
Example : |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
currentControllerId |
Example : |
string |
wwn |
Example : |
string |
listOfMappings |
Example : |
< LUNMapping > array |
mapped |
Example : |
boolean |
preferredControllerId |
Example : |
string |
onlineVolumeCopy |
Example : |
boolean |
name |
Example : |
string |
id |
Example : |
string |
4.87. CreateConsistencyGroupSnapshotViewRequest
Name | Description | Schema |
---|---|---|
name |
Example : |
string |
repositoryPoolId |
The reference to the pool that will be used for the repository creation. |
string |
pitId |
The id of the PIT to create a View for. Either the pitSequenceNumber or a pitId is required. |
string |
pitSequenceNumber |
The sequence number of the PITs to create Views for. Either the pitSequenceNumber or a pitId is required. |
string (int64) |
accessMode |
The access mode determines whether or not a repository volume should be created. |
enum (modeUnknown, readWrite, readOnly, __UNDEFINED) |
repositoryPercent |
Default : |
number (double) |
scanMedia |
Default : |
boolean |
validateParity |
Default : |
boolean |
4.88. CGSnapshotViewRequest
Name | Description | Schema |
---|---|---|
pitId |
The id of the PIT to create a View for. |
string |
candidate |
A manually specified ConcatVolumeCandidate of type newVol or existingVols. Required if accessMode == readWrite. |
|
accessMode |
The access mode determines whether or not a repository volume should be created. |
enum (modeUnknown, readWrite, readOnly, __UNDEFINED) |
scanMedia |
Default : |
boolean |
validateParity |
Default : |
boolean |
4.89. CreateCGSnapshotViewManualRequest
Name | Description | Schema |
---|---|---|
name |
Example : |
string |
pitSequenceNumber |
The sequence number of the PITs to create Views for. All provided PITs/Snapshots must have a matching sequenceNumber |
string (int64) |
requests |
A list of Snapshots to include in the view. |
< CGSnapshotViewRequest > array |
4.90. CFWPackageMetadata
Name | Description | Schema |
---|---|---|
filename |
Example : |
string |
version |
Example : |
string |
4.91. InitialAsyncResponse
Provides a unique identifier for requesting status of an asynchronous call.
Name | Description | Schema |
---|---|---|
requestId |
A unique value that identifies the request for later retrieval. |
string (int64) |
4.92. CfwUpgradeResponse
Name | Description | Schema |
---|---|---|
requestId |
A unique value that identifies the request for later retrieval. |
string (int64) |
healthCheck |
Example : |
|
startTime |
Example : |
string (date-time) |
uploadStartTime |
Example : |
string (date-time) |
activationStartTime |
Example : |
string (date-time) |
uploadCompletionTime |
Example : |
string (date-time) |
uploadCompletionPercentage |
Example : |
integer (int32) |
activationCompletionTime |
Example : |
string (date-time) |
running |
Example : |
boolean |
4.93. ConfigurationDbValidationCheck
Name | Description | Schema |
---|---|---|
result |
Example : |
enum (ok, notCompleted, failedDataRetrieval, failed) |
type |
Example : |
enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, dbSubRecordsValidation, integratedHealthCheck) |
severityLevel |
Example : |
enum (unknown, low, medium, high, fatal) |
resultsData |
Results data to diagnose failures |
string |
status |
Status of the database validation check |
enum (ok, noHeap, ioError, earlyExecution, fatalFsInvalid, fatalRootOutOfBounds, fatalDupBlockPointers, fatalDirOutOfBounds, fatalCorruptMetadata, fatalMissingMetadata, fatalRecOutOfBounds, fatalDupRecPointers, fatalRecordUnallocated, fatalOrphanBlock, fatalFsOffline, noDrives, lockError, fatalMirrorMismatch, mirrorNotReady, __UNDEFINED) |
successful |
Example : |
boolean |
4.94. ExclusiveOperationCheck
Name | Description | Schema |
---|---|---|
result |
Example : |
enum (ok, notCompleted, failedDataRetrieval, failed) |
type |
Example : |
enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, dbSubRecordsValidation, integratedHealthCheck) |
severityLevel |
Example : |
enum (unknown, low, medium, high, fatal) |
resultsData |
Results data to diagnose failures |
string |
volumeRefToAction |
Example : |
< string, enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED) > map |
successful |
Example : |
boolean |
4.95. FirmwareUpgradeHealthCheckResult
Name | Description | Schema |
---|---|---|
storageDeviceId |
Example : |
string |
storageDeviceName |
Example : |
string |
storageDeviceWWN |
Example : |
string |
processingTimeMS |
Example : |
string (int64) |
rerun |
Info about test run for internal use |
boolean |
recommendedRecovery |
Recommended recovery action for failures |
enum (noRecommendation, noAction, callSupport, recoveryGuru, waitLongLivedOps) |
successful |
Example : |
boolean |
storageDeviceAccessible |
Verify the storage-system is contactable. |
|
spmDatabaseVerification |
Validate a database internal to the controller. |
|
configurationDatabaseCheck |
Validate a database internal to the controller. |
|
objectGraphSyncCheck |
Verify that ObjectGraph data is synchronized between the two controllers. |
|
volumeGroupsComplete |
Verify there are no volume groups that are not in a full state of redundancy. |
|
controllerStatusOptimal |
Verify the state of both controllers is optimal. |
|
hotSparesInUse |
Verify that hot spares are not in use (due to drives in a non-optimal state). |
|
missingVolumes |
Verify that there are no missing drives/volume-groups. |
|
driveCheck |
Verify that at least one optimal drive is present |
|
exclusiveOperations |
An upgrade operation cannot proceed if an exclusive operation is in progress on a volume. Examples: volume expansion, RAID type migration. |
|
failedDrivesPresent |
Example : |
|
validPasswordSet |
Example : |
|
melCheck |
Example : |
|
dbSubRecordsValidation |
Validation of the database sub-records |
|
integratedHealthCheck |
Integrated tests not included in other health checks |
4.96. HealthCheckFailureResponse
Provided as a response when the operation failed because of a failure in the health check.
Name | Description | Schema |
---|---|---|
errorMessage |
The error message. |
string |
developerMessage |
An optional developer message providing further error details. |
string |
localizedMessage |
The localized message. |
string |
retcode |
The value of retcode can vary by the code type. To be unique, it must be combined with code type. It is a string. Even if the returned value looks like a number, don’t assume its a number. It is a short label that will not change based on Internationalization. |
string |
codeType |
The API error code type |
enum (symbol, systemerror, devicemgrerror) |
invalidFieldsIfKnown |
The list of invalid fields. The list will be populated with known invalid fields. In the case no invalid fields are known, the list will be empty. |
< string > array |
requestId |
Example : |
string (int64) |
result |
Example : |
4.97. IntegratedHealthCheck
Name | Description | Schema |
---|---|---|
result |
Example : |
enum (ok, notCompleted, failedDataRetrieval, failed) |
type |
Example : |
enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, dbSubRecordsValidation, integratedHealthCheck) |
severityLevel |
Example : |
enum (unknown, low, medium, high, fatal) |
resultsData |
Results data to diagnose failures |
string |
healthCheckTests |
List of tests from the integrated health check. |
< IntegratedHealthCheckTest > array |
successful |
Example : |
boolean |
4.98. IntegratedHealthCheckTest
Name | Description | Schema |
---|---|---|
testPassed |
Test passed indicator. |
boolean |
testName |
Health check test name that was executed. |
string |
resultsData |
Results data from the test. |
string |
4.99. MelEventHealthCheck
Name | Description | Schema |
---|---|---|
result |
Example : |
enum (ok, notCompleted, failedDataRetrieval, failed) |
type |
Example : |
enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, dbSubRecordsValidation, integratedHealthCheck) |
severityLevel |
Example : |
enum (unknown, low, medium, high, fatal) |
resultsData |
Results data to diagnose failures |
string |
warningMessages |
Example : |
< string > array |
successful |
Example : |
boolean |
4.100. ObjectGraphSyncCheck
Name | Description | Schema |
---|---|---|
result |
Example : |
enum (ok, notCompleted, failedDataRetrieval, failed) |
type |
Example : |
enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, dbSubRecordsValidation, integratedHealthCheck) |
severityLevel |
Example : |
enum (unknown, low, medium, high, fatal) |
resultsData |
Results data to diagnose failures |
string |
cfwMatch |
Example : |
boolean |
nvsramMatch |
Example : |
boolean |
successful |
Example : |
boolean |
4.101. SpmDatabaseHealthCheck
Name | Description | Schema |
---|---|---|
result |
Example : |
enum (ok, notCompleted, failedDataRetrieval, failed) |
type |
Example : |
enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, dbSubRecordsValidation, integratedHealthCheck) |
severityLevel |
Example : |
enum (unknown, low, medium, high, fatal) |
resultsData |
Results data to diagnose failures |
string |
failureMessages |
A description of the failure |
< string > array |
successful |
Example : |
boolean |
4.102. StorageDeviceHealthCheck
Name | Description | Schema |
---|---|---|
result |
Example : |
enum (ok, notCompleted, failedDataRetrieval, failed) |
type |
Example : |
enum (melEventCheck, cntrlSyncCheck, storageDeviceAccessible, spmDatabaseVerification, validPassword, configurationDatabaseCheck, objectGraphSyncCheck, nvsramMatches, volumeGroupsComplete, controllerStatusOptimal, hotSparesInUse, failedDrivesPresent, driveCheck, missingVolumes, exclusiveOperations, dbSubRecordsValidation, integratedHealthCheck) |
severityLevel |
Example : |
enum (unknown, low, medium, high, fatal) |
resultsData |
Results data to diagnose failures |
string |
successful |
Example : |
boolean |
4.103. CfwUpgradeRequest
Run a controller firmware upgrade operation
Name | Description | Schema |
---|---|---|
cfwFile |
Example : |
string |
nvsramFile |
Example : |
string |
stageFirmware |
Default : |
boolean |
skipMelCheck |
Skip check of the MEL events for issues with the storage-system. |
boolean |
4.104. CfwActivationRequest
Name | Description | Schema |
---|---|---|
skipMelCheck |
Default : |
boolean |
4.105. StagedFirmwareResponse
Class that holds details on the Firmware staged on the array.
Name | Description | Schema |
---|---|---|
timeStamp |
Timestamp when the staged FW was downloaded |
string (int64) |
codeVersions |
Version descriptors for staged code modules |
< VersionDescriptor > array |
4.106. VersionDescriptor
Name | Description | Schema |
---|---|---|
codeModule |
The code module described |
enum (unspecified, raid, hypervisor, management, iom, nvsram, bundle, bundleDisplay, __UNDEFINED) |
versionString |
Textual representation of version |
string |
4.107. ChannelPorts
Name | Description | Schema |
---|---|---|
speedDetError |
This is set to true only if speed detection has failed. |
boolean |
manuallyBypassed |
This is set to true if the port is bypassed. |
boolean |
portNumber |
This is the ChannelPort port number, 1 based. |
enum (portUnknown, port1, port2, port3, port4, __UNDEFINED) |
4.108. ComponentRemovalData
Name | Description | Schema |
---|---|---|
removalMethod |
This enumeration defines the removal methods that apply to any component. |
enum (parent, self, __UNDEFINED) |
rtrAttributes |
This field holds the component’s ready-to-remove attributes. It is only present when the removalMethod is equal to COMP_RMV_METHOD_REMOVE_SELF. |
4.109. Controller
Name | Description | Schema |
---|---|---|
active |
True if the controller is in active mode; false otherwise. |
boolean |
quiesced |
True if the controller is quiesced. |
boolean |
status |
An indication of the current status of the controller. |
enum (unknown, optimal, failed, removed, rpaParErr, serviceMode, suspended, degraded, __UNDEFINED) |
controllerRef |
The identifier value for this controller. Other objects may use this reference value to refer to the controller. |
string |
physicalLocation |
The physical location of the controller. The parent reference in Location identifies the tray that physically houses the controller, and the position field is the parent-relative/like-component relative slot number of the controller, starting at one. |
|
manufacturer |
The variable-length ASCII text string that identifies the controller manufacturer. |
string |
manufacturerDate |
The date of manufacture of the controller, represented in seconds since midnight GMT on January 1, 1970. |
string (int64) |
appVersion |
The version identification string for the application code that is running on the controller. |
string |
bootVersion |
The version identification string for the boot code that is running on the controller. |
string |
productID |
The variable-length ASCII text string that identifies the product by name, as assigned by the manufacturer. |
string |
productRevLevel |
The product revision level. |
string |
serialNumber |
The variable-length ASCII text string for the serial number of the controller. |
string |
boardID |
The variable-length ASCII text string that represents the board identifier (i.e. board type) of the controller. |
string |
cacheMemorySize |
The memory size, in MB, that will be used by the controller as cache memory. |
integer (int32) |
processorMemorySize |
The size of the controller’s CPU memory, in MB. |
integer (int32) |
hostInterfaces |
An array containing one entry for each host-side I/O interface that is present on the controller. A "host interface" is the controller’s means of accessing the host I/O channel; each host interface has a one-to-one relationship to a host channel. Although this array is indexed starting at zero, host channels in SYMbol are numbered starting at one. Host channels are numbered one through n per controller, without regard to different channel I/O protocols. Note that an interface may be physically present, but disabled for the particular controller model - in such a case, the corresponding channel is skipped over in the channel numbering. |
< IOInterfaceTypeData > array |
driveInterfaces |
An array containing one entry for each drive-side I/O interface that is present on the controller. A "drive interface" is the controller’s means of accessing the drive I/O channel. On the drive side, each channel is associated with two interfaces, one on each controller, giving each controller access to the same set of drive channels. Although this array is indexed starting at zero, drive channels can be numbered one through n, per storage array (not per controller). |
< IOInterfaceTypeData > array |
netInterfaces |
An array containing one entry for each network interface that is present on the controller. |
< NetInterfaceTypeData > array |
inventory |
This array of structures is deprecated. |
< InventoryItem > array |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
hostBoardID |
The board ID of the controller’s host card. This field is deprecated. The hostBoardId field in the HostBoard structure should be used instead. |
string |
physicalCacheMemorySize |
The physical cache memory size in MB |
integer (int32) |
readyToRemove |
This is set to True if the component is ready to remove (and the Ready To Remove LED is on). This field is deprecated. The rtrAttributes field should be used instead. |
boolean |
boardSubmodelID |
The board sub-model ID of the controller card |
string |
submodelSupported |
Set to true if the sub-model feature is supported |
boolean |
oemPartNumber |
The OEM-specified part number of the controller canister |
string |
partNumber |
The part number of the controller board itself. |
string |
rtrAttributes |
The CRU type of the controller plus its ready-to-remove attributes, which are based on the CRU type. |
|
bootTime |
The timestamp value for the time at which the controller last booted. Note that this value may be different for the other controller in the storage array. This value is defined as the number of seconds since midnight GMT on January 1, 1970. |
string (int64) |
modelName |
The model name associated with the controller. A model name is an identifier that is associated with each unique combination of base controller board and host interface card(s). |
string |
networkSettings |
A collection of network-related settings that apply to this controller. |
|
repairPolicy |
The repair policy for the controller. |
|
flashCacheMemorySize |
The total flash cache memory size (in GB) currently in use on the controller. |
integer (int32) |
ctrlIocDumpData |
This structure contains information regarding the state of an IOC data dump – if it needs to be retrieved, and the tag and timestamp of the dump. |
|
locateInProgress |
Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the tray. |
boolean |
hasTrayIdentityIndicator |
The device contains 7-segment indicators used to display the Tray Identity. |
boolean |
controllerErrorMode |
Indicates the error mode in which the controller is operating. A value of 0 indicates the controller is not operating in an error mode. |
enum (notInErrorMode, unknown, t10PiServiceMode, t10PiLockdown, __UNDEFINED) |
codeVersions |
Version descriptors for loaded code modules |
< VersionDescriptor > array |
id |
Example : |
string |
4.110. ControllerDNSProperties
Name | Description | Schema |
---|---|---|
acquisitionProperties |
DNS server acquisition properties |
|
dhcpAcquiredDnsServers |
DNS servers provided by the DHCP responses. Will be non-empty only if at least one of the Controller’s network ports is set to acquire its address via DHCP and the DHCP response included one or more DNS servers to use. The presence of these servers does not imply their use. These DNS servers will only be used if the acquisition type is set to DHCP. |
< IpVxAddress > array |
4.111. ControllerNTPProperties
Name | Description | Schema |
---|---|---|
acquisitionProperties |
NTP server acquisition properties |
|
dhcpAcquiredNtpServers |
NTP servers provided by the DHCP responses. Will be non-empty only if at least one of the Controller’s network ports is set to acquire its address via DHCP and the DHCP response included one or more NTP servers. The presence of these servers does not imply their use. These NTP servers will only be used if the NTP acquisition type is set to DHCP. |
< IpVxAddress > array |
4.112. ControllerNetworkSettings
Name | Description | Schema |
---|---|---|
ipv4DefaultRouterAddress |
The IPV4 static default router address for the controller (sometimes referred to as the "gateway address"). |
string |
ipv6DefaultRouterAddress |
The IPV6 static default router address and associated data for the controller. |
|
ipv6CandidateDefaultRouterAddresses |
The set of IPV6 candidate default router addresses for the controller. |
< IpV6AddressData > array |
remoteAccessEnabled |
True if enabled for remote access |
boolean |
dnsProperties |
DNS configuration information. |
|
ntpProperties |
NTP configuration information. |
4.113. CouplingDriverNVMeInterface
Name | Description | Schema |
---|---|---|
interfaceRef |
Interface ref |
string |
channel |
Interface channel |
integer (int32) |
physicalLocation |
Physical location, in this case internal. |
|
protectionInformationCapable |
Is PI capable. |
boolean |
oneWayMaxRate |
One way max transfer rate |
string (int64) |
bidirectionalMaxRate |
bi-directional max tranfer rate |
string (int64) |
4.114. CtrlIOCDumpData
Name | Description | Schema |
---|---|---|
iocDumpNeedsRetrieved |
If true, an IOC Dump currently exists in controller memory and has not been retrieved. |
boolean |
iocDumpTag |
The tag value of the IOC Dump currently in controller memory. Each dump has a unique tag value. A value of IOC_DUMP_NULL_TAG indicates there is no IOC Dump to retrieve. |
integer (int32) |
timeStamp |
The time that the dump was collected measured in seconds since midnight GMT on January 1, 1970. |
string (int64) |
4.115. DnsAcquisitionDescriptor
Name | Description | Schema |
---|---|---|
dnsAcquisitionType |
How the DNS addresses were acquired. |
enum (unknown, stat, dhcp, __UNDEFINED) |
dnsServers |
This field is used if the method is set to DNS_ACQUISITION_METHOD_STATIC. If more than one address is specified, the first (lowest index) item is given highest precedence and the last item (highest index) is given the lowest precedence. |
< IpVxAddress > array |
4.116. EthernetInterface
Name | Description | Schema |
---|---|---|
interfaceName |
Name of the Ethernet port, as reported by the controller. |
string |
channel |
The channel number of this Ethernet interface. |
integer (int32) |
speed |
The speed of the interface, as currently configured, in Mbit/sec. |
integer (int32) |
ip |
The 32-bit IP protocol address assigned to the interface. |
integer (int32) |
alias |
An ASCII string that identifies the alias name for the interface; this name is presumed to be associated with the IP protocol address. |
string |
macAddr |
An ASCII string representation of the globally-unique 48-bit MAC address assigned to the Ethernet interface. |
string |
gatewayIp |
IP address of the gateway. |
integer (int32) |
subnetMask |
Network subnet mask. |
integer (int32) |
bootpUsed |
Bootpserver used to get network parameters. |
boolean |
rloginEnabled |
True if rlogin sessions are allowed. |
boolean |
reserved1 |
Example : |
string |
setupError |
Set to true if there is a configuration error. |
boolean |
reserved2 |
Example : |
string |
interfaceRef |
The unique identifier for a given instance of this structure. |
string |
linkStatus |
The status of the network link for this interface. |
enum (none, up, down, failed, __UNDEFINED) |
ipv4Enabled |
True if IPV4 is enabled for this interface; otherwise false. |
boolean |
ipv4Address |
The IPV4 address for the interface. |
string |
ipv4SubnetMask |
The IPV4 subnet mask for the interface. |
string |
ipv4AddressConfigMethod |
The method by which the IPV4 address information is configured. |
enum (configDhcp, configStatic, __UNDEFINED) |
ipv6Enabled |
True if IPV6 is enabled for this interface; otherwise false. |
boolean |
ipv6LocalAddress |
The IPV6 local address for the interface and associated data. |
|
ipv6PortStaticRoutableAddress |
The IPV6 static routable address for the interface and associated data. |
|
ipv6PortRoutableAddresses |
The set of IPV6 port routable addresses for the interface. |
< IpV6AddressData > array |
ipv6AddressConfigMethod |
The method by which the IPV6 address information is configured for the interface. |
enum (configStatic, configStateless, __UNDEFINED) |
fullDuplex |
If set to true, the interface is operating in full duplex mode; otherwise, it is operating in half-duplex mode. |
boolean |
supportedSpeedSettings |
Support speed setting for interface |
< enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED) > array |
configuredSpeedSetting |
Configured setting for the interface. |
enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED) |
currentSpeed |
Current speed of the interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
physicalLocation |
The physical location of the Ethernet interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st ethernet interface relative to the parent," "2nd ethernet interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
4.117. EthernetInterfaceData
Name | Description | Schema |
---|---|---|
partData |
Vendor-supplied about the physical part. |
|
macAddress |
The Ethernet MAC address associated with the interface. |
string |
fullDuplex |
If set to true, the interface is operating in full duplex mode; otherwise, it is operating in half-duplex mode. |
boolean |
maximumFramePayloadSize |
The currently configured MTU for this interface |
integer (int32) |
currentInterfaceSpeed |
The speed of the interface, as currently configured by the user. This differs from the operational speed only when the speed is set to SPEED_AUTO |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maximumInterfaceSpeed |
The maximum speed supported by the interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
linkStatus |
The status of the network link for this interface. |
enum (none, up, down, failed, __UNDEFINED) |
supportedInterfaceSpeeds |
A list of speeds supported by the Ethernet interface. |
< enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) > array |
autoconfigSupport |
If set to true, autoconfiguration is supported. |
boolean |
copperCableDiagnosticsSupport |
If true, support is provided for copper cable diagnostics. |
boolean |
operationalInterfaceSpeed |
Indicates the speed that the interface is currently operating |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
4.118. EthernetIoInterface
Name | Description | Schema |
---|---|---|
interfaceRef |
The opaque data by which an instance of EthernetIoInterface is uniquely identified. |
string |
physicalLocation |
The physical location of the Ethernet interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Ethernet interface relative to the parent," "2nd Ethernet interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
channel |
The number of the channel controlled by this interface. |
integer (int32) |
channelPortRef |
A reference to the channel port object associated with the channel controlled by this interface. |
string |
interfaceData |
Information about the physical interface (e.g., Ethernet). |
|
protectionInformationCapable |
This field indicates whether or not the I/O interface is PI capable. |
boolean |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
id |
Example : |
string |
4.119. FibreInterface
Name | Description | Schema |
---|---|---|
channel |
The channel number of this interface. |
integer (int32) |
loopID |
The FC loop ID value used by the controller on this channel. |
integer (int32) |
speed |
The speed of the interface in MB/sec. This field is deprecated. The field currentInterfaceSpeed should be used instead. |
integer (int32) |
hardAddress |
The hard (preferred) address of the interface, in loop ID format. |
integer (int32) |
nodeName |
The unique identifier of the storage array node associated with this interface. |
string |
portName |
The unique identifier of the Fibre Channel port associated with this interface. |
string |
portId |
The NL_Port identifier assigned to this interface. |
string |
topology |
The Fibre Channel topology type being used. |
enum (unknown, ptp, fabric, arbLoop, fabLoop, __UNDEFINED) |
part |
An ASCII text string that describes the Fibre Channel controller chip type. |
string |
revision |
The revision level of the Fibre Channel controller chip. |
integer (int32) |
chanMiswire |
True, if this channel is joined with another one. |
boolean |
esmMiswire |
True, if an ESM miswire condition exists somewhere on this channel. |
boolean |
linkStatus |
The status of the fibre channel link for this interface. |
enum (none, up, down, failed, __UNDEFINED) |
isDegraded |
True if the channel associated with this interface is degraded. |
boolean |
speedControl |
The speed of the interface in MB per sec. This field is deprecated. The fieldcurrentInterfaceSpeed should be used instead. |
enum (unknown, fixed, switched, auto, __UNDEFINED) |
maxSpeed |
The maximum speed in MB/s the interface can run. This field is deprecated. The field maximumInterfaceSpeed should be used instead. |
integer (int32) |
speedNegError |
True if speed negotiation could not complete. |
boolean |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
ddsChannelState |
The DDS state of this drive side channel: optimal, degraded, or failed. |
integer (int32) |
ddsStateReason |
DDS state reason. |
integer (int32) |
ddsStateWho |
Which controller placed the drive side channel in this DDS state. |
integer (int32) |
isLocal |
Set to True if there are channel ports physically attached to this controller. |
boolean |
channelPorts |
Channel port speed information. This field is deprecated. The same information is available in the LinkSpeedDetectionError structure. |
< ChannelPorts > array |
currentInterfaceSpeed |
The current interface speed of the Fibre Channel interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maximumInterfaceSpeed |
The maximum interface speed of the Fibre Channel interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
interfaceRef |
The unique identifier for a given instance of this structure. |
string |
physicalLocation |
The physical location of the Fibre Channel interface. The parent reference in location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Fibre Channel interface relative to the parent," "2nd Fibre Channel interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
isTrunkCapable |
This field is true if the Fibre interface on the controller board is trunk capable. This field is always false for host-side interfaces. |
boolean |
trunkMiswire |
True only when ESM is trunk capable and cabled incorrectly, or not trunk capable but connected in trunk mode. |
boolean |
protectionInformationCapable |
Example : |
boolean |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
id |
Example : |
string |
4.120. IOInterfaceTypeData
Name | Description | Schema |
---|---|---|
interfaceType |
This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
fibre |
This field is present only if the interfaceType value is equal to IO_IF_FC. It contains the detailed interface information for a Fibre Channel I/O interface. |
|
ib |
This field is present only if the interfaceType value is equal to IO_IF_IB. It contains the detailed interface information for an Infiniband interface. |
|
iscsi |
This field is present only if the interface type value is equal to IO_IF_ISCSI. It contains the detailed interface information for an iSCSI I/O interface. |
|
sas |
This field is present only if the interfaceType value is equal to IO_IF_SAS. It contains the detailed interface information for a serial-attached SCSI I/O interface. |
|
sata |
This field is present only if the interfaceType value is equal to IO_IF_SATA. It contains the detailed interface information for a SATA I/O interface. |
|
scsi |
This field is present only if the interfaceType value is equal to IO_IF_SCSI. It contains the detailed interface information for a SCSI I/O interface. |
|
couplingDriverNvme |
InterfaceTypeData for the NVMe based coupling driver used for our containerized product. |
|
ethernet |
This field is present only if the interfaceType value is equal to IO_IF_ETHERNET. It contains the detailed interface information for an Ethernet I/O interface. |
4.121. IbInterface
Name | Description | Schema |
---|---|---|
interfaceRef |
The opaque data by which an instance of IbInterface is uniquely identified. |
string |
channel |
The number of the host channel associated with this interface. |
integer (int32) |
channelPortRef |
A reference to the channel port for the channel associated with this interface. |
string |
localIdentifier |
The InfiniBand local identifier associated with this interface. |
integer (int32) |
globalIdentifier |
The InfiniBand global identifier associated with this interface. |
string |
linkState |
The state of the InfiniBand link. |
enum (initialize, linkArm, active, defer, down, __UNDEFINED) |
portState |
The state of the InfiniBand port. |
enum (unknown, initialize, arm, active, defer, down, __UNDEFINED) |
maximumTransmissionUnit |
The size in bytes of the largest packet that the interface can transmit. |
integer (int32) |
currentSpeed |
The speed at which the interface is currently operating. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
supportedSpeed |
An array containing the different speeds at which the interface is capable of operating. |
< enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) > array |
currentLinkWidth |
The width at which the link is currently operating, e.g., 1 means "1X," 4 means "4X,".etc. |
enum (width1x, width4x, width8x, width12x, __UNDEFINED) |
supportedLinkWidth |
An array containing the different link widths at which the link is capable of operating. |
< enum (width1x, width4x, width8x, width12x, __UNDEFINED) > array |
currentDataVirtualLanes |
The number of data virtual lanes that are currently active for this interface. |
integer (int32) |
maximumDataVirtualLanes |
The maximum number of data virtual lanes supported by the interface. |
integer (int32) |
physicalLocation |
The physical location of the Infiniband interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Infiniband interface relative to the parent," "2nd Infiniband interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
protectionInformationCapable |
This field indicates whether or not the I/O interface is PI capable. |
boolean |
isSRPSupported |
This flag is true if SRP (SCSI RDMA Protocol) is currently supported. |
boolean |
isISERSupported |
This flag is true if iSER (iSCSI Extensions for RDMA) is currently supported. |
boolean |
physPortState |
This element contains the current state of the physical Infiniband port. |
enum (unknown, sleep, polling, disabled, cfgTrain, linkUp, linkErrRec, phyTest, __UNDEFINED) |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
isNVMeSupported |
Indicates if the interface is configured to support NVMe over Fabrics protocol |
boolean |
id |
Example : |
string |
4.122. InfinibandInterfaceData
Name | Description | Schema |
---|---|---|
isIser |
If true, iSER (iSCSI Extensions for RDMA) is active and a corresponding IBInterface object exists |
boolean |
4.123. InternetProtocolV4Data
Name | Description | Schema |
---|---|---|
ipv4Address |
The various IPV4 address-related elements (IP address, gateway IP address, and subnet mask), along with the state of their configuration. |
string |
ipv4AddressConfigMethod |
IPV4 configuration method for the endpoint; always STATIC for iSER interfaces. |
enum (configDhcp, configStatic, __UNDEFINED) |
ipv4OutboundPacketPriority |
Priority associate with outbound IPV4 packets; always disabled for iSER interfaces. |
|
ipv4VlanId |
Value of IPV4 VLAN id for the interface; always disabled for iSER interfaces. |
|
ipv4AddressData |
The various IPV4 address-related elements (IP address, gateway IP address, and subnet mask), along with the state of their configuration. |
4.124. InternetProtocolV6Data
Name | Description | Schema |
---|---|---|
ipv6LocalAddresses |
The set of IPV6 local addresses that have been assigned to the iSCSI Ethernet port. |
< IpV6AddressData > array |
ipv6RoutableAddresses |
The set of IPV6 routable addresses that have been assigned to the iSCSI Ethernet port |
< IpV6AddressData > array |
ipv6PortRouterAddress |
The IPV6 address of the port router. |
|
ipv6AddressConfigMethod |
The method by which the IPV6 address information is configured for the endpoint. |
enum (configStatic, configStateless, __UNDEFINED) |
ipv6OutboundPacketPriority |
Settings that govern the priority to associate with outbound IPV6 packets sent over the interface |
|
ipv6VlanId |
Settings that govern the value of the IPV6 VLAN identifier for the interface. VLAN identifiers are in the range 1 through 4094. |
|
ipv6HopLimit |
The hop limit to use in IPV6 packets sent over the interface. |
integer (int32) |
ipv6NdReachableTime |
A "neighbor discovery" parameter - the amount of time in milliseconds, within which a neighbor is assumed to be reachable. |
integer (int32) |
ipv6NdRetransmitTime |
A "neighbor discovery" parameter - the number of milliseconds between neighbor solicitation probes. |
integer (int32) |
ipv6NdStaleTimeout |
A "neighbor discovery" parameter - the time in milliseconds after which information for a neighbor that cannot be verified as reachable will be considered "stale." |
integer (int32) |
ipv6DuplicateAddressDetectionAttempts |
The number of neighbor-solicitation messages to send in trying to determine IP address uniqueness. |
integer (int32) |
4.125. InventoryItem
Name | Description | Schema |
---|---|---|
itemName |
An ASCII string that provides the symbolic name of the item. |
string |
itemVersion |
An ASCII string that represents the current version, or revision level, of the item. |
string |
4.126. IpV4AddressData
Name | Description | Schema |
---|---|---|
configState |
Configuration state for the various address elements; always IP_CONFIG_STATE_CONFIGURED for iSER interfaces. |
enum (unconfigured, acquiring, configured, invalid, __UNDEFINED) |
ipv4Address |
The IPV4 address associated with the endpoint. |
string |
ipv4SubnetMask |
IPV4 subnet mask associated w/ the endpoint; used for iSER interfaces. |
string |
ipv4GatewayAddress |
IPV4 gateway address associated w/ the endpoint; used for iSER interfaces. |
string |
4.127. IpV6AddressData
Name | Description | Schema |
---|---|---|
address |
The IPV6 address. |
string |
addressState |
The state of the IPV6 address. |
4.128. IpV6AddressState
Name | Description | Schema |
---|---|---|
addressType |
This enumeration defines the two different types of IPV6 addresses - interface or router. |
enum (typeInterface, typeRouter, __UNDEFINED) |
interfaceAddressState |
The interface address state. This field is only valid if addressType is equal to IPV6_ADDR_TYPE_INTERFACE. |
enum (unconfigured, acquiring, configured, invalid, __UNDEFINED) |
routerAddressState |
The router address state. This field is only valid if addressType is equal to IPV6_ADDR_TYPE_ROUTER. |
enum (unknown, configured, advertised, stale, __UNDEFINED) |
4.129. IscsiInterface
Name | Description | Schema |
---|---|---|
channel |
The number of the channel controlled by this interface. |
integer (int32) |
channelPortRef |
A reference to the channel port object associated with the channel controlled by this interface. |
string |
tcpListenPort |
The number of the TCP port on which the target listens for incoming connections. |
integer (int32) |
ipv4Enabled |
True if IPV4 is enabled for this interface; always true for iSER interface. |
boolean |
ipv4Data |
IPV4-related information for the interface. |
|
interfaceData |
Information about the physical interface (e.g., Ethernet). |
|
interfaceRef |
The unique identifier for a given instance of this structure. |
string |
ipv6Enabled |
True if IPV6 is enabled for this interface; otherwise false. |
boolean |
ipv6Data |
IPV6-related information for the interface. |
|
physicalLocation |
The physical location of the iSCSI interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st iSCSI interface relative to the parent," "2nd iSCSI interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
protectionInformationCapable |
This field indicates whether or not the I/O interface is PI capable. |
boolean |
isIPv6Capable |
This flag is true if the interface is capable of IPv6 functionality. |
boolean |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
id |
Example : |
string |
4.130. Location
Name | Description | Schema |
---|---|---|
trayRef |
The TrayRef reference value of the tray object in which the component resides. |
string |
slot |
The slot identifier, or ordinal identifier, of the component within its physical tray. |
integer (int32) |
locationParent |
An object reference that identifies the parent physical component (e.g., Tray, CRU, etc.) of the object containing the Location attribute. |
|
locationPosition |
The parent-relative/like-component relative position of the object containing the Location attribute. |
integer (int32) |
label |
Label associated with the location (i.e., label printed on the canister or the enclosure). |
string |
4.131. NetInterfaceTypeData
Name | Description | Schema |
---|---|---|
interfaceType |
This enumeration defines the different network interface types that may be reported as part of the interface information associated with a controller. |
enum (ethernet, __UNDEFINED) |
ethernet |
This field is present only if the interfaceType value is equal to NET_IF_ETHERNET. It contains the detailed interface information for an Ethernet network interface. |
4.132. NetworkAddress
Name | Description | Schema |
---|---|---|
addrType |
This enum defines the possible network address types. |
enum (none, domainName, ipvx, __UNDEFINED) |
domainName |
Fully qualified domain name. This should be considered an IDN-unaware domain name slot as per RFC3490. |
string |
ipvxAddress |
IPv4 or IPv6 address |
4.133. NtpAcquisitionDescriptor
Name | Description | Schema |
---|---|---|
ntpAcquisitionType |
How the NTP server addresses are acquired. |
enum (unknown, stat, dhcp, disabled, __UNDEFINED) |
ntpServers |
This field is used if the method is set to NTP_ACQUISITION_METHOD_STATIC. If more than one address is specified, the first (lowest index) item is given highest precedence and the last item (highest index) is given the lowest precedence. |
< NetworkAddress > array |
4.134. ObjectReference
Name | Description | Schema |
---|---|---|
refType |
This enumeration identifies the different types of object references. |
enum (generic, controller, genericTyped, __UNDEFINED) |
controllerRef |
A ControllerRef that refers to the object. Controllers are identified separately from other SYMbol objects because their refs require special handling by the firmware. This field is only valid if refType is equal to OBJ_REF_CONTROLLER. |
string |
symbolRef |
A SYMbolRef that refers to the object. All non-controller objects can be identified by an untyped SYMbol reference. This field is only present if refType is equal to OBJ_REF_GENERIC. |
string |
typedReference |
A reference to a SYMbol object that includes object type information. This value is only present if the discriminator refType is set to OBJ_REF_GENERIC_TYPED. |
4.135. ParentCru
Name | Description | Schema |
---|---|---|
type |
This enumeration object is used to specify the type of reference that is contained in a ParentCru union. |
enum (controller, esm, fan, iccCru, supportCru, drawer, __UNDEFINED) |
parentController |
This field contains a reference to the parent controller. It is only valid if the type field is equal to PARENT_CRU_TYPE_CONTROLLER. |
string |
parentEsm |
This field contains a reference to the parent ESM. It is only valid if the type field is equal to PARENT_CRU_TYPE_ESM. |
string |
parentFan |
This field contains a reference to the parent Fan. It is only valid if the type field is equal to PARENT_CRU_TYPE_FAN. |
string |
parentInterconnectCru |
This field contains a reference to the parent interconnect CRU. It is only valid if the type field is equal to PARENT_CRU_TYPE_ICC_CRU. |
string |
parentSupportCru |
This field contains a reference to the parent support CRU. It is only valid if the type field is equal to PARENT_CRU_TYPE_SUPPORT_CRU. |
string |
parentDrawer |
This field contains a reference to the parent drawer. It is only valid if the type field is equal to PARENT_CRU_TYPE_DRAWER. |
string |
4.136. PhysicalInterfaceTypeData
Name | Description | Schema |
---|---|---|
type |
This enumeration object is used to indicate the physical type of an I/O interface, in contrast to the logical protocol used by the interface (iSCSI is a logical protocol; Ethernet is a physical interface). |
enum (unknown, ethernet, infiniband, __UNDEFINED) |
ethernetData |
This field contains information about an Ethernet physical interface It is only present if the type field is equal to PHYSICAL_INTERFACE_ETHERNET. |
|
infinibandData |
This field indicates iSCSI/iSER interface. |
4.137. RTRAttributeData
Name | Description | Schema |
---|---|---|
hasReadyToRemoveIndicator |
True if the component has a ready-to-remove LED. |
boolean |
readyToRemove |
True if the component is ready to remove. |
boolean |
4.138. RTRAttributes
Name | Description | Schema |
---|---|---|
cruType |
This enumeration identifies the type of CRU a component has. |
enum (unknown, dedicated, shared, aggregate, __UNDEFINED) |
parentCru |
This field identifies the CRU that is the parent of this component, i.e., the CRU that it is sharing with other components. It is only present when the cruType field is set to CRU_TYPE_AGGREGATE. |
|
rtrAttributeData |
This field contains the actual settings for the ready-to-remove data. It is only present when the cruType field is set to CRU_TYPE_DEDICATED. |
4.139. RepairPolicy
Name | Description | Schema |
---|---|---|
removalData |
This field contains the removal data for the component. This primary piece of data is a removal method. Additional "ready-to-remove" attributes may be defined, depending on the removal method. |
|
replacementMethod |
This field defines the "replacement method" for the component. |
enum (parent, self, __UNDEFINED) |
4.140. SATAInterface
Name | Description | Schema |
---|---|---|
channel |
The channel number of this channel |
integer (int32) |
currentInterfaceSpeed |
The current interface speed of the SATA interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maximumInterfaceSpeed |
The maximum interface speed of the SATA interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
speedControl |
An indicator of how the device speed is controlled. |
enum (unknown, fixed, switched, auto, __UNDEFINED) |
part |
A string indicating the chip type. |
string |
revision |
The revision level of the SATA part. |
integer (int32) |
interfaceRef |
The unique identifier for a given instance of this structure. |
string |
physicalLocation |
The physical location of the SATA interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st SATA interface relative to the parent," "2nd SATA interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
protectionInformationCapable |
This field indicates whether or not the I/O interface is PI capable. |
boolean |
id |
Example : |
string |
4.141. SCSIInterface
Name | Description | Schema |
---|---|---|
channel |
The channel number of this interface. |
integer (int32) |
scsiID |
The SCSI ID value used by the controller on this interface. |
integer (int32) |
speed |
The speed of the interface in MB/sec. |
integer (int32) |
scsiType |
The type of SCSI line driver (e.g. SE, LVD, etc.) being used. |
enum (se, hvd, lvd, __UNDEFINED) |
width |
The transfer width of the SCSI bus, in bits. |
integer (int32) |
part |
An ASCII text string that describes the SCSI controller chip type. |
string |
revision |
The revision level of the SCSI controller chip. |
integer (int32) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
4.142. SasAttachedDevice
Name | Description | Schema |
---|---|---|
channel |
The number of the channel where the SAS-attached device is located. |
integer (int32) |
channelType |
An indication of which "side" the channel is on - host or drive. |
enum (hostside, driveside, management, __UNDEFINED) |
sasAttachedDeviceData |
This field contains information that explicitly identifies the SAS-attached device. |
4.143. SasAttachedDeviceTypeData
Name | Description | Schema |
---|---|---|
type |
This enumeration specifies the different kinds of devices that may be attached to a SAS port. |
enum (unknown, drive, expander, localController, alternateController, host, __UNDEFINED) |
alternateController |
A reference to the alternate controller that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_ALTERNATE_CONTROLLER. |
string |
drive |
A reference to a drive that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_DRIVE. |
string |
expander |
A reference to the SAS expander that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_EXPANDER. |
string |
remoteHostPortAddress |
The SAS address of the port in the host computer that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_HOST. |
string |
localController |
A reference to the local controller that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_LOCAL_CONTROLLER. |
string |
physicalLocation |
The tray-slot location of a device of unknown type. This field is only present if type equals SAS_ATTACHED_DEV_UNKNOWN. |
4.144. SasInterface
Name | Description | Schema |
---|---|---|
channel |
The number of the channel corresponding to this interface. |
integer (int32) |
currentInterfaceSpeed |
The current interface speed of the SAS interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maximumInterfaceSpeed |
The maximum interface speed of the SAS interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
part |
A string indicating the chip type. |
string |
revision |
The revision level of the firmware on the SAS I/O controller. |
integer (int32) |
isDegraded |
True if the channel corresponding to this interface is degraded. |
boolean |
iocPort |
Information about the SAS I/O controller port corresponding to this interface. |
|
interfaceRef |
The unique identifier for a given instance of this structure. |
string |
physicalLocation |
The physical location of the SAS interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st SAS interface relative to the parent," "2nd SAS interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
protectionInformationCapable |
This field indicates whether or not the I/O interface is PI capable. |
boolean |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
id |
Example : |
string |
4.145. SasPhy
Name | Description | Schema |
---|---|---|
phyIdentifier |
A number in the range 0-127 that is the PHY identifier. |
integer (int32) |
isOperational |
True if the PHY is capable of normal operation. |
boolean |
4.146. SasPort
Name | Description | Schema |
---|---|---|
parent |
The device on which the port resides. |
|
attachedDevice |
An indication of what device is attached to this port. |
|
state |
The state of the SAS port. |
enum (unknown, optimal, degraded, failed, __UNDEFINED) |
miswireType |
The type of miswire involving this port (or "none"). |
enum (none, topology, ctlrHostPort, ctlrDrivePortToHost, esm, ctlrDrivePortToEndDevice, __UNDEFINED) |
channelPortRef |
A reference to the channel port object identifying the external connector associated with this port. If the port is not associated with an external connector, then this field is set to a null SYMbol ref. |
string |
sasPhys |
A list of PHYs associated with this port. |
< SasPhy > array |
portTypeData |
Information about a SAS port that is type-dependent. |
|
portMode |
The SAS port connection mode. |
enum (unknown, internal, externalIn, externalOut, endDevice, open, __UNDEFINED) |
domainNumber |
The domain number identifies which SAS domain this element is a part of. Domain numbers are arbitrarily assigned by the firmware and are consistent on a per controller basis – but not across controllers. So, the contents of domains will be consistent across controllers but the number identifying a particular domain may not be. |
integer (int32) |
attachedChannelPortRef |
This ref identifies the connector on the attached device for a drive channel who’s external port is connected to another device. |
string |
discoveryStatus |
This element contains the status of the SAS discovery - the status is a bit field and could indicate a successful discovery or could indicate one or more failure conditions (indicated by one or more error flags being set). |
integer (int32) |
4.147. SasPortProviderDevice
Name | Description | Schema |
---|---|---|
type |
This enumeration object is used to identify the specific type of "port provider" device. |
enum (controller, drive, expander, hostboard, __UNDEFINED) |
controller |
A reference to a controller that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_CONTROLLER. |
string |
drive |
A reference to a drive that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_DRIVE. |
string |
expander |
A reference to a SAS expander that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_EXPANDER. |
string |
hostBoardRef |
A reference to a SAS host board that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_HOSTBOARD. |
string |
4.148. SasPortTypeData
Name | Description | Schema |
---|---|---|
portType |
This enumeration specifies the different types of SAS ports. |
enum (endDevice, expander, __UNDEFINED) |
portIdentifier |
This field is the SAS address that is the port identifier. It is present only if the portType value is equal to SAS_PORT_TYPE_END_DEVICE. |
string |
routingType |
This field indicates the routing method used on this port. It is present only if the portType value is equal to SAS_PORT_TYPE_EXPANDER. |
enum (direct, table, subtractive, __UNDEFINED) |
4.149. SettingControl
Name | Description | Schema |
---|---|---|
isEnabled |
True when the property is enabled. |
boolean |
value |
The value of the property |
integer (int32) |
4.150. TypedSYMbolReference
Name | Description | Schema |
---|---|---|
componentType |
An enumeration value indicating the type of component that the reference refers to. |
enum (unknown, fan, battery, powerSupply, thermalSensor, esm, ups, minihub, gbic, sfp, interconnectCru, supportCru, alarm, hostboard, icSasExpander, hostIoCard, cacheBackupDevice, cacheMemDimm, procMemDimm, channelPort, drive, controller, ethernetInterface, fibreInterface, ibInterface, iscsiInterface, sasInterface, tray, storageArray, drawer, __UNDEFINED) |
symbolRef |
A SYMbol reference that refers to an instance of an object of the type identified by componentType. If the component type is "storage array," this field is a null reference. This is because an object graph describes a single instance of a storage array, so there is no need to uniquely identify instances. |
string |
4.151. VendorPartData
Name | Description | Schema |
---|---|---|
vendorName |
The name of the vendor. |
string |
partNumber |
The part number. |
string |
revisionNumber |
The part revision number. |
string |
serialNumber |
The part serial number. |
string |
4.152. ControllerStats
Controller I/O performance statistics.
Name | Description | Schema |
---|---|---|
observedTime |
End time for this collection as measured by the number of seconds since baseTime. |
string (date-time) |
observedTimeInMS |
Example : |
string (int64) |
lastResetTime |
Example : |
string (date-time) |
lastResetTimeInMS |
Example : |
string (int64) |
controllerId |
Controller that generated this group. |
string |
arrayId |
Example : |
string |
arrayWwn |
Example : |
string |
cpuUtilizationStats |
CPU utilization statistics structure. |
< CpuUtilizationStats > array |
totalIopsServiced |
Total number of IO operations serviced by the controller. |
number (double) |
totalBytesServiced |
Total number of Bytes serviced by the controller. |
number (double) |
cacheHitsIopsTotal |
Total number of IO operations that hit cache. |
number (double) |
cacheHitsBytesTotal |
Total number of bytes that hit cache. |
number (double) |
randomIosTotal |
Total number of IOs that are categorized as random. |
number (double) |
randomBytesTotal |
Total number of Bytes that are categorized as random. |
number (double) |
readIopsTotal |
Total number of Read IO operations. |
number (double) |
readBytesTotal |
Total number of Bytes read. |
number (double) |
writeIopsTotal |
Total number of Write IO operations. |
number (double) |
writeBytesTotal |
Total number of Bytes written. |
number (double) |
mirrorIopsTotal |
Total number of IO operations serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value. |
number (double) |
mirrorBytesTotal |
Total number of Bytes serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value. |
number (double) |
fullStripeWritesBytes |
Bytes written that are categorized as Full stripe writes. |
number (double) |
raid0BytesTransferred |
Bytes transferred that are categorized as RAID 0 transfers. |
number (double) |
raid1BytesTransferred |
Bytes transferred that are categorized as RAID 1 transfers. |
number (double) |
raid5BytesTransferred |
Bytes transferred that are categorized as RAID 5 transfers. |
number (double) |
raid6BytesTransferred |
Bytes transferred that are categorized as RAID 6 transfers. |
number (double) |
ddpBytesTransferred |
Bytes transferred that are categorized as DDP transfers. |
number (double) |
maxPossibleBpsUnderCurrentLoad |
Theoretical maximum possible Bytes per second under current load. |
number (double) |
maxPossibleIopsUnderCurrentLoad |
Theoretical maximum possible IO per second under current load. |
number (double) |
4.153. CpuUtilizationStats
Name | Description | Schema |
---|---|---|
maxCpuUtilization |
Max utilization stats value from CPU. |
integer (int32) |
sumCpuUtilization |
Sum of utilization stats values from CPU. |
integer (int32) |
ssqCpuUtilization |
Sum of squares of utilization stats values from CPU. |
integer (int32) |
4.154. DPLCoreDumpData
Name | Description | Schema |
---|---|---|
dplCoreDumpTag |
The tag value of the DPL core dump currently in controller memory. Each core dump has a unique tag value. A value of DPL_CORE_DUMP_NULL_TAG indicates there is no DPL core dump to retrieve. |
integer (int32) |
dplCoreDumpNeedsRetrieved |
If true, a DPL core dump currently exists in controller memory and has not been retrieved. |
boolean |
dplCoreDumpEnabled |
If true, DPL Core Dump is enabled in the controller. |
boolean |
timeStamp |
The time that the core dump was collected measured in seconds since midnight GMT on January 1, 1970. |
string (int64) |
4.155. KeyValuePair
Simple structure to hold key value pairs
Name | Description | Schema |
---|---|---|
key |
Example : |
string |
value |
Example : |
string |
4.156. DeviceAlertTestResponse
Name | Description | Schema |
---|---|---|
response |
Alert email test result code |
enum (emailSentOK, invalidEmailServerConfigured, invalidEmailSenderAddressConfigured, invalidRecipientAddressConfigured, smtpConnectionError, smtpTransportError, smtpUnknownError) |
emailSendErrorString |
Alert email error string |
string |
4.157. DeviceAlertConfiguration
API object that shows the e-mail alert configuration for the storage system.
Name | Description | Schema |
---|---|---|
alertingEnabled |
If set to true and a recipient e-mail address has been specified, then e-mails will be sent to the recipient any time an 'alertable' event occurs on the storage system. |
boolean |
emailServerAddress |
The address for the server that will send the alert e-mails. The address can be specified as a DNS name, an IPv4 address or an IPv6 address. If a DNS name is provided, then the DNS confirmation must be properly configured on both controllers in the storage system. |
string |
emailSenderAddress |
The e-mail address that the alert e-mails will come from. This doesn’t need to be a real e-mail address but it does have to be formatted as a valid e-mail address. |
string |
sendAdditionalContactInformation |
If set to true, the additional contact information provided will be included in all alert e-mails that get sent out. |
boolean |
additionalContactInformation |
Any additional contact information that should be included in all alert e-mails that get sent out. If sendAdditionalContactInformation is set to false, this value is ignored. |
string |
recipientEmailAddresses |
An array of e-mail addresses that the alert e-mails should be sent to. |
< string > array |
4.158. DeviceAsupDevice
API response object that includes ASUP information for a storage device.
Name | Description | Schema |
---|---|---|
wwn |
Device’s world-wide-name |
string |
name |
Device’s name |
string |
asupCapable |
ASUP capable |
boolean |
asupEnabled |
ASUP enabled |
boolean |
onDemandCapable |
ASUP OnDemand capable |
boolean |
scheduled |
Device has ASUP daily/weekly schedule |
boolean |
dailyScheduleTime |
ASUP daily scheduled time |
integer (int32) |
weeklyScheduleTime |
ASUP weekly scheduled time |
integer (int32) |
weeklyDayOfWeek |
ASUP weekly scheduled day of week |
enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED) |
4.159. DeviceAsupVerifyResponse
Used to return resuls of ASUP settings verification.
Name | Description | Schema |
---|---|---|
successful |
Indicates if verification was successful |
boolean |
errorMessage |
Error message if verification failed |
string |
aodAttempted |
Indicates if AOD verification was attempted |
boolean |
aodSuccessful |
Indicates if AOD verification was successful |
boolean |
aodErrorMessage |
Error message if AOD verification failed |
string |
4.160. DeviceAsupDelivery
Name | Description | Schema |
---|---|---|
method |
ASUP delivery method |
enum (https, http, smtp) |
routingType |
ASUP routing type |
enum (none, direct, proxyServer, proxyScript) |
proxyHost |
ASUP proxy host |
string |
proxyPort |
ASUP proxy port |
integer (int32) |
proxyUserName |
ASUP proxy user name |
string |
proxyPassword |
ASUP proxy password |
string |
proxyScript |
ASUP proxy PAC script |
string |
mailRelayServer |
ASUP e-mail relay server |
string |
mailSenderAddress |
ASUP e-mail sender address |
string |
4.161. DeviceAsupVerifyRequest
Used to verify ASUP settings.
Name | Description | Schema |
---|---|---|
delivery |
ASUP delivery configuration |
|
mailReplyAddress |
E-Mail reply address for SMTP |
string |
4.162. FileInfo
Name | Description | Schema |
---|---|---|
fileSize |
Example : |
string (int64) |
fileName |
Example : |
string |
4.163. AsupMaintenanceWindowResponse
Name | Description | Schema |
---|---|---|
emailAddresses |
The list of email addresses to send confirmation the AutoSupport backend processed the configuration request |
< string > array |
duration |
The duration in hours to enable AutoSupport the maintenance window (if not provided, the maximum supported duration will be used) |
integer (int32) |
maintenanceWindowEnabled |
Example : |
boolean |
4.164. AsupMaintenanceWindowRequest
Name | Description | Schema |
---|---|---|
emailAddresses |
The list of email addresses to send confirmation the AutoSupport backend processed the configuration request. The maximum number of email addresses allowed is limited to 5. |
< string > array |
duration |
The duration in hours to enable AutoSupport maintenance mode (if not provided, the maximum supported duration will be used) |
integer (int32) |
maintenanceWindowEnabled |
Example : |
boolean |
4.165. DeviceAsupResponse
API response object that includes basic information about storage system ASUP.
Name | Description | Schema |
---|---|---|
asupCapable |
AutoSupport is supported |
boolean |
onDemandCapable |
AutoSupport OnDemand is supported |
boolean |
asupEnabled |
AutoSupport is enabled or disabled |
boolean |
onDemandEnabled |
ASUP OnDemand is enabled or disabled |
boolean |
remoteDiagsEnabled |
ASUP RemoteDiags is enabled or disabled |
boolean |
delivery |
ASUP delivery configuration |
|
destinationAddress |
ASUP destination address |
string |
schedule |
ASUP schedule configuration |
4.166. DeviceAsupSchedule
Name | Description | Schema |
---|---|---|
dailyMinTime |
ASUP daily minimum time |
integer (int32) |
dailyMaxTime |
ASUP daily maximum time |
integer (int32) |
weeklyMinTime |
ASUP weekly minimum time |
integer (int32) |
weeklyMaxTime |
ASUP weekly maximum time |
integer (int32) |
daysOfWeek |
ASUP days of week |
< enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED) > array |
4.167. DeviceAsupUpdateRequest
Used to update asup settings.
Name | Description | Schema |
---|---|---|
asupEnabled |
AutoSupoprt enabled or disabled |
boolean |
onDemandEnabled |
ASUP OnDemand is enabled or disabled |
boolean |
remoteDiagsEnabled |
ASUP RemoteDiags is enabled or disabled |
boolean |
delivery |
ASUP delivery configuration |
|
schedule |
ASUP schedule configuration |
4.168. DeviceDataResponse
Name | Description | Schema |
---|---|---|
responseData |
The string representation of the data requested. |
string |
4.169. DiagnosticDataRequest
Name | Description | Schema |
---|---|---|
requestType |
Data to request |
enum (deviceProfile, firmwareInventory) |
4.170. DiscoverResponse
API response object that includes data for the current discover process
Name | Description | Schema |
---|---|---|
requestId |
Unique request id |
string (int64) |
currentCount |
The number of addresses checked |
integer (int32) |
total |
total number of addresses to check |
integer (int32) |
lastStart |
Time when the last discovery was started null if a process has never been started |
string (date-time) |
discoverProcessRunning |
Indicates if a discovery process is running |
boolean |
storageSystems |
List of storage systems discovered so far |
< DiscoveredStorageSystem > array |
4.171. DiscoveredController
Information discovered for a storage system controller during a discover process
Name | Description | Schema |
---|---|---|
controllerId |
A unique identifier for this controller |
string |
ipAddresses |
The IP addresses that can be used to access this controller |
< string > array |
certificateStatus |
SSL certificate status (applicable if this controller supports management via HTTP |
enum (trusted, selfSigned, expired, incompleteTrustChain, commonNameMismatch, unknown) |
4.172. DiscoveredStorageSystem
Information discovered for a storage system during a discover process
Name | Description | Schema |
---|---|---|
serialNumber |
Serial number for the chassis |
string |
wwn |
WWN for the storage system |
string |
label |
Label for the storage system |
string |
firmware |
Firmware version for the storage system |
string |
nvsram |
NVSRAM version for the storage system |
string |
ipAddresses |
Discovered controller IP addresses for the storage system |
< string > array |
needsAttention |
Needs attention alert for the storage system |
boolean |
controllers |
Discovered controllers for the storage system |
< DiscoveredController > array |
supportedManagementPorts |
Management port types that are supported on this storage system |
< enum (symbol, https) > array |
4.173. DiscoveryStartRequest
Used to to start a storage system discover cycle
Name | Description | Schema |
---|---|---|
startIP |
Starting IP address |
string |
endIP |
Ending IP Address |
string |
useAgents |
In-band management agents will be queried if this value is true. If you are not sure, its best to leave this as default |
boolean |
connectionTimeout |
Optional parameter. This defaults to 30 seconds. Longer times may be needed for WAN discoveries, but will slow down the whole process. Shorter times speed up the process. This is only the timeout value for the initial TCP connection |
integer (int32) |
maxPortsToUse |
Set an explicit limit on the number of ports to use for discovery. A port is a file handle in most operating systems. It may be necessary to increase your ulimit values for open file handles. More ports available will significantly speed up the process, however, if available file handles are exceeded, then this operation will handle it gracefully, but other processes on the server may be affected as well as client connections. |
integer (int32) |
4.174. DriveEx
Name | Description | Schema |
---|---|---|
offline |
True if the drive is in the offline state, false otherwise. This field is valid for missing drives. |
boolean |
hotSpare |
True if the drive has been designated as a hot spare; false otherwise. This field is valid for missing drives. |
boolean |
invalidDriveData |
True if no drive information (serial #, capacity, etc.) can be obtained. This field is always true for missing drives. |
boolean |
available |
True if the drive is available for use in creating a new volume group; false otherwise. This field is valid for missing drives. |
boolean |
pfa |
True if the drive is drive Predicted Failure analysis predicts a drive failure. This field is valid for missing drives. |
boolean |
driveRef |
The identifier value for this drive. Other objects may use this reference value to refer to the drive. This field is valid for missing drives. |
string |
status |
An indication of the current status of the drive. This field is valid for missing drives. |
enum (optimal, failed, replaced, bypassed, unresponsive, removed, incompatible, dataRelocation, preFailCopy, preFailCopyPending, __UNDEFINED) |
cause |
An indication of the reason for the current status of the drive. This field is most useful when the current status is something other than optimal; it identifies the event that caused the status to change to its current value. This field is valid for missing drives. |
enum (none, userOp, writeOp, uncertified, speedMismatch, bypassUnknown, wrongDriveType, incompatibleUprevDacstore, incompatibleDownrevDacstore, incompatibleInternalError, incompatibleSectorSizeMismatch, incompatibleNativeVgRefersToForeignDrive, incompatibleForeignVgRefersToNativeDrive, incompatibleNativeVgForeignDriveMutualRef, incompatibleVgCloned, incompatibleForeignDriveInconsistent, incompatibleVgHasDrivePartOfMultipleVgs, incompatibleForeignDriveHasInconsistentRole, incompatibleVgDrivePartOfMultipleVgs, incompatibleFailedLegacyDrive, incompatibleDdfOtherVendor, incompatibleDbAdoptionFailure, locked, insufficientDriveCapacity, supercapacitorFailure, unsupportedProtocolConnection, unsupportedCapacity, invalidLockKeyPresented, incompatiblePiType, incompatibleDatabaseValidationFailure, incompatibleUnsupportedInterposerFwVersion, incompatibleSataDriveSctUnsupported, incompatibleModelNumberUnsupported, incompatibleAlignmentForEmulationDrive, srcRelocation, dstRelocation, incompatibleDriveMetadataUnusable, pfa, spfa, __UNDEFINED) |
interfaceType |
Information about the I/O interface between the controller and the drive. For example, for a SCSI-attached drive, this field will contain information about the drive’s channel and SCSI ID values. For other interface types, different data will be available in this field. |
|
physicalLocation |
The physical location of the drive. Beginning with the Allegheny release, the parent reference in Location identifies the tray or drawer containing the drive, and the position field is the parent-relative/like-component relative slot number of the drive, starting at 1. For missing drives this field contains the last known location. |
|
manufacturer |
The variable-length ASCII text string that identifies the drive manufacturer. Note that this information is not returned for most Serial ATA (SATA) drives. |
string |
manufacturerDate |
The date of manufacture of the drive, represented in seconds since midnight GMT on January 1, 1970. Note that this information is not returned for most Serial ATA (SATA) drives. |
string (int64) |
productID |
The variable-length ASCII text string that identifies the product by name, as assigned by the manufacturer. |
string |
serialNumber |
The variable-length ASCII text string for the serial number of the drive. |
string |
softwareVersion |
This data is a variable-length ASCII text string. If an interposer is present in front of SATA drives, the string identifies the version of the interposer package. In this case, the SATA drive firmware version can be found in the physicalDriveTypeData field. If an interposer is not present (always the case for Fibre Channel drives) this field describes the drive firmware version. |
string |
blkSize |
The block (i.e. sector) size used by the drive, represented in bytes. This field is valid for missing drives. |
integer (int32) |
usableCapacity |
The usable capacity of the drive, in bytes, after accounting for any space that is reserved for use by the array controller for overhead information. This field is valid for missing drives. |
string (int64) |
rawCapacity |
The raw capacity of the drive, in bytes. This field is valid for missing drives. |
string (int64) |
worldWideName |
A variable-length, opaque field that contains the drive’s world-wide name, or globally unique identifier value. This field is valid for missing drives. |
string |
currentVolumeGroupRef |
The reference value of the volume group, disk pool, or flash cache to which this drive is currently assigned. If a hot spare drive is actively sparing for a failed drive, this field will identify the volume group, disk pool, or flash cache that is using the hot spare drive. If the drive is not currently assigned, or is an idle hot spare, the reference value will be null. This field is valid for missing drives. |
string |
sparedForDriveRef |
The reference value of the drive for which this drive is acting as a hot spare. This field is only used if the Drive object represents a global hot spare that is actively sparing for a failed drive. This field is valid for missing drives. |
string |
mirrorDrive |
This field is only used if the Drive object represents a drive that is part of a RAID-1 volume group. It identifies the drive that is tied to this one for RAID-1 mirroring operations. This field is valid for missing drives. |
string |
nonRedundantAccess |
True if the drive does not have redundant access. |
boolean |
workingChannel |
The channel to the tray that is still operational (if nonRedundantAccess is True). |
integer (int32) |
volumeGroupIndex |
The volume group index. This is the zero-relative position of the drive with respect to the stripe-ordering for the volume group. A value of -1 indicates that the drive does not belong to any group. This field is valid for missing drives. |
integer (int32) |
currentSpeed |
The speed of the drive. Will be unknown for a SCSI drive. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maxSpeed |
The maximum speed of the drive. Currently not used. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
uncertified |
True, if the drive has the DR_UNCERTIFIED flag set. This field is valid for missing drives. |
boolean |
hasDegradedChannel |
True, if a path to this drive is degraded. |
boolean |
degradedChannels |
The IDs of degraded channels. |
< integer (int32) > array |
phyDriveType |
The physical drive type. |
enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) |
spindleSpeed |
The drive reported spindle speed. Solid State Disk (SSD) drives report zero. |
integer (int32) |
rtrAttributes |
The CRU type of the drive plus its ready-to-remove attributes, which are based on the CRU type. |
|
reserved |
reserved. |
string |
phyDriveTypeData |
Information specific to a physical drive type. |
|
pfaReason |
The reason a PFA condition has been raised for this drive. |
enum (unknown, none, driveReported, synthesized, ssdEndOfLife, dataLoss, __UNDEFINED) |
bypassSource |
A list of object references where each reference identifies the source of a drive bypass condition. Possible referenced objects include the drive itself, a controller, or the ESM(s). When the bypass source is a controller or the drive, the list will typically hold just one reference; when the bypass source is the ESM(s), the list can hold up to two references, indicating either one or both ESMs. The list normally holds valid data whenever the drive is in the bypassed state (DRIVE_STAT_BYPASSED) , however it may be empty if the source of the bypass is unknown. It is also possible for the list to hold valid data when the drive is optimal, if only one ESM has bypassed the drive. |
< ObjectReference > array |
repairPolicy |
This field contains the repair policy for the Drive. |
|
fdeCapable |
True if the drive supports FDE, false otherwise |
boolean |
fdeEnabled |
true if drive security is enabled; false if disabled |
boolean |
fdeLocked |
True if the drive is locked, false if the drive is unlocked |
boolean |
lockKeyID |
The lock key ID as read from the drive. |
string |
ssdWearLife |
Contains wear life data for the SSD drive. |
|
driveMediaType |
This field is set to the drive media type of the drive. |
enum (all, unknown, hdd, ssd, __UNDEFINED) |
fpgaVersion |
This data is a variable-length ASCII text string that identifies the version of the FPGA package. |
string |
protectionInformationCapabilities |
This structure contains a protectionInformationCapable field which is set to true when the drive is formatted to support type 2 protection with a 512-byte logical block size, or if the drive is a type 0 drive formatted with a 520-byte logical block size. It also contains a field that is set to the protection type provided for the drive. |
|
protectionInformationCapable |
Field is no longer used. |
boolean |
protectionType |
Field is no longer used. |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
interposerPresent |
A value of true for this property means the drive is behind an interposer. |
boolean |
interposerRef |
The drive interposer identifier. This field is valid only if the interposerPresent field is set to True. |
string |
currentCommandAgingTimeout |
The current command aging timeout value in hundreds of milliseconds. If this value is 0 the default command aging timeout value will be used, otherwise this value overrides the default value. |
integer (int32) |
defaultCommandAgingTimeout |
The default command aging timeout value in hundreds of milliseconds as specified by the drive. If this value is 0, the drive command aging timeout cannot be changed. |
integer (int32) |
driveTemperature |
Drive temperature data. |
|
blkSizePhysical |
The physical block (i.e., sector) size for the drive, represented in bytes. This field is valid for missing drives. |
integer (int32) |
lowestAlignedLBA |
The lowest aligned LBA for the physical sector. Typically this will be 0, but could be non-zero for emulation drives where LBA 0 starts at some logical sector offset within the physical sector. |
string (int64) |
removed |
True if the drive is in the process of being removed from the volume group. Only applies to Disk Pools |
boolean |
locateInProgress |
Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the drive. |
boolean |
fipsCapable |
This flag is true if the drive supports FIPS (Federal Information Processing Standard). FIPS 140-2 specification. |
boolean |
firmwareVersion |
Example : |
string |
lockKeyIDValue |
Example : |
string |
id |
Example : |
string |
4.175. DriveTemperature
Name | Description | Schema |
---|---|---|
currentTemp |
The current drive temperature (in degrees Celsius). |
integer (int32) |
refTemp |
Reference temperature (maximum safe operating temperature in degrees Celsius). |
integer (int32) |
4.176. DriveTypeData
Name | Description | Schema |
---|---|---|
driveType |
This enumeration type is used to distinguish between the different I/O protocols used by the controller to communicate with drives. This is not necessarily the same as the physical drive interface type (PhysicalDriveType). |
enum (scsi, fibre, unknown, sas, sata, __UNDEFINED) |
fibre |
This field is present only if the driveType value is DRIVE_TYPE_FIBRE. It contains the address information for a Fibre Channel drive. Such drives are typically multi-ported, so there will be one element in this variable-length array for each I/O port on the drive. The first element in the array is the drive address on the preferred channel, and the second element is the drive address on the redundant channel. |
< FibreDriveAddress > array |
sas |
This field is present only if the driveType value is DRIVE_TYPE_SAS. It contains the address information for a serial-attached SCSI drive. |
|
scsi |
This field is present only if the driveType value is DRIVE_TYPE_SCSI. It contains the address information for a SCSI drive. |
4.177. FibreDriveAddress
Name | Description | Schema |
---|---|---|
channel |
The controller drive-side channel number used to access the drive via this interface. |
integer (int32) |
loopID |
The drive’s Fibre Channel loop ID value on the given channel. |
integer (int32) |
4.178. PhysicalDriveTypeData
Name | Description | Schema |
---|---|---|
phyDriveType |
This enumeration object is used to describe the physical interface of the drive. This is not necessarily the same as the I/O protocol interface used by the controller to communicate with the drive (DriveType). In addition, the supportedDriveTypes array in the FeatureParams structure will contain values from this enumeration identifying which drive types are supported on the storage array. |
enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) |
sataDriveAttributes |
This field identifies the attributes of SATA drives It is only present if the phyDriveType field is equal to PHY_DRIVE_TYPE_SATA. |
4.179. SCSIDriveAddress
Name | Description | Schema |
---|---|---|
channel |
The controller drive-side SCSI channel on which the drive resides. |
integer (int32) |
id |
The drive’s SCSI ID value. |
integer (int32) |
4.180. SSDWearLife
Name | Description | Schema |
---|---|---|
averageEraseCountPercent |
The percentage of average erase count. |
integer (int32) |
spareBlocksRemainingPercent |
The percentage of spare blocks remaining in the solid state drive. Controller firmware checks and updates this percentage approximately once per hour. |
integer (int32) |
isWearLifeMonitoringSupported |
This field is set to true if wear life monitoring is supported on the drive. If true then the values in the other fields in this structure are valid, otherwise they are not valid. |
boolean |
percentEnduranceUsed |
The percentage of endurance used for this drive. The value is obtained from the Solid State Media log page. A value of PERCENTAGE_ENDURANCE_USED_UNKNOWN indicates that the information is inaccessible or not populated in this release. |
integer (int32) |
4.181. SasDriveAddress
Name | Description | Schema |
---|---|---|
deviceName |
The SAS address representing the device itself. |
string |
drivePortAddresses |
The SAS addresses of drive ports 0 and 1. The first element in the array is the drive address on the preferred channel, and the second element is the drive address on the redundant channel. |
< SasDrivePortAddress > array |
4.182. SasDrivePortAddress
Name | Description | Schema |
---|---|---|
channel |
The number of the channel where the drive port is located. |
integer (int32) |
portIdentifier |
The SAS address of the drive port. |
string |
4.183. SataDriveAttributes
Name | Description | Schema |
---|---|---|
translatorData |
This field provides information about the SCSI-to-ATA translator hardware. |
|
ataDiskModelNumber |
This field is the disk model number as reported in the ATA protocol. |
string |
ataDiskFwRevision |
This field is the disk firmware revision number as reported in the ATA protocol. |
string |
4.184. ScsiToAtaTranslatorData
Name | Description | Schema |
---|---|---|
vendorId |
The vendor identification string. |
string |
productId |
The product identification string. |
string |
productRevLevel |
The product revision level string. When no interposer card is available, this string is set to "—-" (four dashes). |
string |
satType |
This field identifies the type of the SCSI-to-ATA translation hardware. Note that if this field is set to SAT_TYPE_UNKNOWN, the string in the productId field will have zero length, and the string in the productRevLevel field will be set to "—-" (four dashes). |
enum (unknown, driveCruResident, controllerResident, enclosureSlotResident, __UNDEFINED) |
4.185. UnreadableSectorEntryResult
Identifies the location of an unreable sector.
Name | Description | Schema |
---|---|---|
driveRef |
Example : |
string |
timeStamp |
Example : |
string (int64) |
recordType |
Example : |
enum (physical, logical, injected, edcError, inconsistent, piError, __UNDEFINED) |
volumeRef |
Example : |
string |
driveLBA |
Example : |
string (int64) |
trayNo |
Example : |
integer (int32) |
volumeLBA |
Example : |
string (int64) |
slotNo |
Example : |
integer (int32) |
4.186. UnreadableSectorResponse
The list of unreadable drive sectors
Name | Description | Schema |
---|---|---|
maxLimit |
Example : |
integer (int32) |
database |
Example : |
< UnreadableSectorEntryResult > array |
4.187. DriveSelectionRequest
Name | Description | Schema |
---|---|---|
driveCount |
Minimum value : |
integer (int32) |
selectedSpindleSpeeds |
Only select drives with these spindle speeds |
< integer (int32) > array |
fdeCapableOnly |
Only select FDE capable drives |
boolean |
driveCapacityMin |
Only consider drives with at least this minimum raw capacity in SizeUnits |
string (int64) |
driveType |
Only consider drives of this media type |
enum (ssd, hdd) |
interfaceType |
Only consider drives of this interface type |
enum (fibre, sas, sata) |
protectionInformationCapable |
Only consider drives that have Data Assurance capability. |
boolean |
sizeUnit |
Use this unit for any capacity based parameters |
enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb) |
raidLevel |
The intended RAID level for the storage-pool. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
targetUsableCapacity |
The aggregate capacity of the selected drives must be at least this many SizeUnits |
integer (int32) |
4.188. DiskIOStats
Drive I/O performance statistics. Note: the DELETE method clears all statistics for all drives.
Name | Description | Schema |
---|---|---|
observedTime |
End time for this collection as measured by the number of seconds since baseTime. |
string (date-time) |
observedTimeInMS |
Example : |
string (int64) |
lastResetTime |
Example : |
string (date-time) |
lastResetTimeInMS |
Example : |
string (int64) |
diskId |
Example : |
string |
serialNumber |
Example : |
string |
arrayId |
Example : |
string |
arrayWWN |
Example : |
string |
driveWWN |
Example : |
string |
volGroupId |
Example : |
string |
volGroupName |
Example : |
string |
volGroupWWN |
Example : |
string |
trayId |
Example : |
string |
slot |
Example : |
integer (int32) |
diskManufacture |
Example : |
string |
diskSoftwareVersion |
Example : |
string |
idleTime |
Example : |
number (double) |
otherOps |
Example : |
number (double) |
otherTimeMax |
Example : |
number (double) |
otherTimeTotal |
Example : |
number (double) |
otherTimeTotalSq |
Example : |
number (double) |
readBytes |
Example : |
number (double) |
readOps |
Example : |
number (double) |
readTimeMax |
Example : |
number (double) |
readTimeTotal |
Example : |
number (double) |
readTimeTotalSq |
Example : |
number (double) |
recoveredErrors |
Example : |
number (double) |
retriedIos |
Example : |
number (double) |
timeouts |
Example : |
number (double) |
unrecoveredErrors |
Example : |
number (double) |
writeBytes |
Example : |
number (double) |
writeOps |
Example : |
number (double) |
writeTimeMax |
Example : |
number (double) |
writeTimeTotal |
Example : |
number (double) |
writeTimeTotalSq |
Example : |
number (double) |
queueDepthTotal |
Example : |
number (double) |
queueDepthMax |
Example : |
number (double) |
randomIosTotal |
Example : |
number (double) |
randomBytesTotal |
Example : |
number (double) |
cumulativeLBA |
Example : |
number (double) |
cumulativeDeltaLBA |
Example : |
number (double) |
4.189. DriveFirmwareCompatabilityEntry
Drive compatibilty entry
Name | Description | Schema |
---|---|---|
driveRef |
Example : |
string |
onlineUpgradeCapable |
Example : |
boolean |
4.190. DriveFirmwareCompatibilityResponse
The list of drives compatible with the downloaded firmware files
Name | Description | Schema |
---|---|---|
contollerOffline |
Controller status |
boolean |
controllerMissing |
Controller missing |
boolean |
controllerServiceMode |
Indicates if a Controller is in service mode |
boolean |
simplexMode |
Indicates if in simplex mode |
boolean |
compatibilities |
The list of drive to firmware compatibility compatibilities |
< DriveFirmwareCompatiblitySet > array |
4.191. DriveFirmwareCompatiblitySet
Drive firmware file to drive compatibility
Name | Description | Schema |
---|---|---|
filename |
Example : |
string |
firmwareVersion |
The version of firmware in file |
string |
supportedFirmwareVersions |
Drive firmware versions supported by firmware file |
< string > array |
compatibleDrives |
List of drives that are compatible with firmware file |
< DriveFirmwareCompatabilityEntry > array |
4.192. DriveDownloadDriveStatus
Name | Description | Schema |
---|---|---|
driveRef |
The drive reference. |
string |
status |
The drive download status. |
enum (okay, invalidDriveref, duplicateDrive, notAttempted, invalidState, inProgress, partialUpdate, failedUpdate, inProgressRecon, pending, __UNDEFINED) |
percentComplete |
Will be set to zero unless the DriveDownloadStatus is equal to DRIVE_DL_STAT_IN_PROGRESS_RECON (meaning a reconstruction is in progress). |
integer (int32) |
4.193. DriveFirmwareStatus
Name | Description | Schema |
---|---|---|
overallStatus |
The overall status. |
enum (uninitialized, ok, error, busy, illegalParam, noHeap, driveNotExist, driveNotUnassigned, noSparesAssigned, someSparesAssigned, volumeNotExist, volumeReconfiguring, notDualActive, tryAlternate, background, notImplemented, reservationConflict, volumeDead, internalError, invalidRequest, iconFailure, volumeFormatting, altRemoved, cacheSyncFailure, invalidFile, reconfigSmallDacstore, reconfigFailure, nvramError, flashError, authFailParam, authFailPassword, memParityError, invalidControllerref, invalidVolumegroupref, invalidVolumeref, invalidDriveref, invalidFreeextentref, volumeOffline, volumeNotOptimal, modesenseError, invalidSegmentsize, invalidCacheblksize, invalidFlushThreshold, invalidFlushAmount, invalidLabel, invalidCacheModifier, invalidReadahead, invalidReconpriority, invalidScanperiod, invalidTrayposLength, invalidRegionid, invalidFibreid, invalidEncryption, invalidRaidlevel, invalidExpansionList, noSparesDeassigned, someSparesDeassigned, partDupId, partLabelInvalid, partNodeNonexistent, partPortIdInvalid, partVolumeNonexistent, partLunCollision, maxVolMappingExceeded, partMappingNonexistent, partNoHostports, imageTransferred, fileTooLarge, invalidOffset, overrun, invalidChunksize, invalidTotalsize, downloadNotPermitted, spawnError, voltransferError, invalidDlstate, cacheconfigError, downloadInProgress, driveNotOptimal, driveRemoved, duplicateDrives, numdrivesAdditional, numdrivesGroup, driveTooSmall, capacityConstrained, maxVolumesExceeded, partIsUtmLun, someSparesTooSmall, sparesSmallUnassigned, tooManyPartitions, parityScanInProgress, invalidSafeId, invalidSafeKey, invalidSafeCapability, invalidSafeVersion, partitionsDisabled, driveDownloadFailed, esmDownloadFailed, esmPartialUpdate, utmConflict, noVolumes, authFailReadpassword, partCrteFailTblFull, attemptToSetLocal, invalidHostTypeIndex, failVolumeVisible, noDeleteUtmInUse, invalidLun, utmTooManyMaps, diagReadFailure, diagSrcLinkDown, diagWriteFailure, diagLoopbackError, diagTimeout, diagInProgress, diagNoAlt, diagIconSendErr, diagInitErr, diagModeErr, diagInvalidTestId, diagDriveErr, diagLockErr, diagConfigErr, diagNoCacheMem, diagNotQuiesced, diagUtmNotEnabled, invalidModeSwitch, invalidPortname, duplicateVolMapping, maxSnapsPerBaseExceeded, maxSnapsExceeded, invalidBasevol, snapNotAvailable, notDisabled, snapshotFeatureDisabled, repositoryOffline, repositoryReconfiguring, rollbackInProgress, numVolumesGroup, ghostVolume, repositoryMissing, invalidRepositoryLabel, invalidSnapLabel, invalidRollbackPriority, invalidWarnThreshold, cannotMapVolume, cannotFormatVolume, dstNotFibre, repositoryTooSmall, repositoryFailed, baseVolumeFailed, baseVolumeOffline, baseVolumeFormatting, metadataVolNonexistent, rvmFeatureDisabled, mirrorsPresent, rvmFeatureDeactivated, maxMirrorsExceeded, invalidMirrorCandidateVol, invalidMirrorvol, metadataAlreadyExists, metadataMissing, metadataOffline, metadataReconfiguring, localRoleChangeFailed, remoteRoleChangeFailed, localRoleChangeSuccessful, onlyLocalMirrorDeleted, noValidMirrorCandidate, remoteMaxMirrorsExceeded, remoteRvmFeatureDisabled, remoteMetadataVolNonexistent, notRegistered, remoteInvalidCfgGen, localRoleChangedNotForced, remoteRoleChangedLocalFailed, rvmSpmError, remoteAuthFailPassword, rvmVersionMismatch, rvmRemoteArrayError, rvmCommunicationError, rvmFibreError, mirrorVolNotPrimary, secNotPromoteable, priNotDemoteable, metadataChildDeletion, rmtvolOrphanDeletion, rvmActivateDisallowed, invalidTrayref, partialDeletion, defaultUtmCollision, invalidCopyPriority, invalidVolumecopyref, copyChangeFailed, copyActive, copyInactive, copyIncompatibleSource, copyIncompatibleTarget, copyGhostSource, copyGhostTarget, copyInvalidSourceRef, copyInvalidTargetRef, copyInvalidSourceState, copyInvalidTargetState, copySourceReconfig, copyTargetReconfig, copyTargetTooSmall, copyTargetLimit, maxVolumeCopysExceeded, copySourceReservation, copyTargetReservation, copySourceFormat, copyTargetFormat, copyStartFailed, copyStopFailed, volcopyFeatureDisabled, writeLock, cannotReconfigure, authFailContLockout, prReservationConflict, regDeleteFailed, batteryNotInConfig, batteryMissing, noChannel, rvmOperNotAllowedOnSec, dataRedundancyRequired, copySourceZeroCapacity, invHostlunDefineMapping, invHostlunMoveMapping, invHostlunDefineHosttype, invHostlunMoveHostport, fwIncompatible, mirrorAlreadySuspended, insuffLocalMirRepResources, insuffRemtMirRepResources, ghostHasUnreadableSectors, rvmCommStatRecoveredTimeout, rvmCommStatRecoveredDelay, rvmCommStatNotReady, rvmCommStatTimeout, rvmCommStatChannelFailure, rvmCommStatNetworkFailure, rvmCommStatDeviceMissing, rvmCommStatLoginRejected, rvmCommStatLoginFailure, rvmCommStatInvNumSamplesReqd, rvmQuiescenceInProgress, rvmInvalidRemotevol, sodInProgress, invalidDrives, invalidSetid, invalidSetsize, missingData, quiescenceFailed, validationError, downloadHalted, allFailed, partialOk, obsolete, usmClearFailed, controllerInServiceMode, invalidDrive, databaseError, backgroundAutocfg, autocfgInprogress, unsupportedLhaSataEsm, parityScanFailed, parityRepairFailed, mediaRepairFailed, mirrorDegraded, prohibitedByMdtRestrictions, prohibitedByGoldKeyRestrictions, safeControllerNotSubjectToGoldKey, safeMdtNotPremiumFeature, alarmNotPresent, dltNotCompleted, dependancyError, cdmDatabaseFull, requiredConditionNotPresent, ddcUnavail, ddcIllegalParam, invalidDdcTag, hosttypeConflict, portConflict, invalidHosttypeString, invalidProtocol, portRemoved, disableNotPermitted, prohibitedByDriveTrayLimit, invalidEsmref, invalidBundleMigration, invalidBundleKey, noSparesNeeded, prohibitedByFeatureBundleViolation, invalidAuthMethod, invalidSecret, secretAlreadyInUse, manualConfigModeSet, noIscsiSessions, invalidInterfaceref, initiatorConflict, initiatorRemoved, basevolSizeChanged, volumeGroupNotExist, volumeGroupNotOnline, volumeGroupHasHotspare, volumeGroupReconfiguring, volumeGroupStateNotValid, controllerNotOptimal, insufficientCapacity, volumeGroupExported, volumeNotConfigurable, volumeGroupNotConfigurable, invalidDriveState, volumeGroupReconstructing, volumeGroupUndergoingCopyback, volumeGroupNotComplete, volumeGroupHasFailedDrives, volumeGroupHasNonOptimalVols, volumeGroupHasMirrorRelationship, volumeGroupHasVolcopyRelationship, volumeGroupHasMirroringMetadata, volumeGroupHasMappedVols, volumeGroupHasReservations, volumeGroupHasIncompatibleDacstores, volumeLimitExceeded, volumeGroupHasUnknownRaidLevel, volumeGroupHasUnsupportedRaidLevel, volumeGroupHasCloneOpportunity, volumeGroupHasInsufficientDrives, volumeGroupHasFailedVols, perfTierSafeUpgradeDisabled, raid6FeatureUnsupported, raid6FeatureDisabled, safeControllerNotSubjectToRaid6, volumeGroupNotContingent, channelDiagsRunning, channelDiagsResultsPartial, volumeGroupHasSnapshotRelationship, prohibitedBySafeViolation, legacyVg, vgNotForceable, channelDiagsLockErr, channelDiagsNotQuiesced, channelDiagsAltCommFailed, channelDiagsChanSetupFailed, channelDiagsDeviceBypassFailed, channelDiagsResultsNotAvailable, driveSpinUpError, driveTypeMismatch, localRemoteArrayHasSameWwn, volumeGroupHasIncompatibleDrive, volumeGroupVolumeEncroachesOnDacstore, volumeGroupImportInProgress, drivesNeedToBeSpunUp, noNativeSstor, noSuchDebugChunk, debugInfoConfigChanged, lockdown, drivesDacstoresOverlap, volumeHasAsyncMirror, reconfigLogSpaceError, volumeGroupInaccessible, volumeInitializing, insufficientCache, volumeInaccessible, noDrivesAdopted, someDrivesAdopted, exportingDrivesDatabaseResynchronizing, exportingDrivesDatabaseFailed, exportingDrivesQuiesced, learnActiveTryLater, noLockedDrives, driveSecurityEnabledFailed, lockkeyFailed, invalidSecurity, noFdeDrives, volumeGroupSecure, invalidBlob, unlockFailed, noKeySet, rekeyInProgress, defaultHostGroupMappingNotAllowed, ssdMediaScanNotAllowed, premiumFeatureLimitExceedsMaximum, disableEvaluationFeatureNotPermitted, requestFailedDueToLun0Restrictions, externalKmsEnabled, externalKmsFailed, externalKmsNotEnabled, keyNotNeeded, keyInvalidSequence, diagNotRunning, ctrlNotInServiceMode, invalidFeatureref, cacheBackupDevNotExist, noMatchingLockKeyIdFound, lockKeyValidationFailed, lockKeyValidationDisabled, externalKmsNotCompliant, externalKmsTimeout, cannotDisableNoKey, previouslyEnabledForEval, featureNotKeyable, evalNotSupported, rawdataTransferBadType, rawdataTransferNotStarted, rawdataTransferAlreadyStarted, rawdataTransferPreparing, rawdataTransferReadError, rawdataTransferNoDrives, rawdataTransferInvalidImage, rawdataTransferCrcError, dbmRestoreWriteError, dbmRestoreNoDrives, rawdataBadSeqNum, invalidCapability, externalKeyNotInMemory, invalidLockKeyId, invalidProtection, volumeHasSnapshotRelationship, volumeHasMirrorRelationship, externalKmsDisabledNoKey, dbmRestoreAltCtlNotOffline, copyApptagMismatch, invalidRequestForEnclosure, dqRetrieveNothingToTransfer, invalidIscsiConfiguration, volumeHasVolcopyRelationship, partPiIncapable, requestFailedDueToPiRestrictions, rawdataTransferUserCancelled, duplicateIscsiIpAddress, portSpeedConflict, factoryDefaultDownloadFailed, errorWritingToEeprom, factoryDefaultPartialUpdate, snapshotNotActive, cannotRollback, mirrorSyncNotPossible, psuFirmwareDownloadFailed, psuFirmwareUpdateMfgDeviceCodeMismatch, psuFirmwareUpdateNotAllRedundant, psuFirmwareUpdateNotAllOptimal, insufficientRepositoryCapacity, rollbackStartFailure, csbReserveFailed, csbReleaseFailedNoLock, csbReleaseFailedInvalidKey, flashcacheAlreadyExists, flashcacheFeatureDisabled, flashcacheAlreadySuspended, flashcacheNotSuspended, flashcacheInvalidConfigType, invalidPitGroupLabel, invalidPitConsistencyGroupLabel, invalidPitAutoDeleteLimit, invalidPitRepositoryFullPolicy, invalidConcatVolMemberLabel, concatVolMemberTooSmall, invalidPitGroupRef, invalidPitRef, dveNotAllowed, dssNotAllowed, dplCoreDumpInvalidTag, invalidPitViewLabel, invalidPitViewRef, invalidConcatVolRef, notFlashcacheVol, flashcacheDeleted, flashcacheEnabled, flashcacheNotEnabled, noRepDeletion, maxPitsPerGroupExceeded, maxPitsExceeded, maxPitGroupsPerBaseExceeded, maxPitGroupsExceeded, maxViewsPerPitExceeded, maxViewsExceeded, maxConsistencyGroupsExceeded, maxConsistencyGroupMembersExceeded, maxMappableVolumesExceeded, notOldestPit, viewStopped, concatMemberLimitExceeded, invalidMemberVol, memberVolMapped, invalidMemberVolState, invalidTrimCount, pitGroupInConsistencyGroup, pitInConsistencyGroup, pitViewInConsistencyGroup, incompatibleMemberVol, volumeInUse, rvmOverIscsiNotSupported, arvmGroupUserLabelExists, arvmGroupDoesNotExist, arvmGroupNotEmpty, concatVolumeFailed, invalidPitConsistencyGroupRef, invalidPitConsistencyGroupViewRef, invalidPitConsistencyGroupViewLabel, alternateRequiredForOperation, invalidPitForView, consistencyGroupArvmBindingConflict, attributeFixedByArvm, operationFailedVolumeCopyClone, pitCreatePending, dbmDbSourceUnavailable, dbmRestoreSourceMismatch, invalidCriticalThreshold, volumeGroupHasArvmRelationship, arvmRecoveryPointDeletionRequired, volumeGroupHasPitgroupRelationship, volumeGroupHasPitviewRelationship, volumeGroupHasConcatRelationship, flashcacheSuspended, flashcacheAlreadyEnabled, dbmDbImageCorrupt, illegalVolume, invalidRepositoryCapacity, invalidProvisionedCapacityQuota, invalidExpansionPolicy, invalidVirtualCapacity, cannotExpandConcatMember, thresholdBelowUsedCapacity, invalidExpansionOperation, repositoryFull, insufficientExpansionSpace, invalidExpansionSize, invalidReinitAction, invalidReinitCapacity, invalidIncompleteMemberRef, arvmGroupNotPrimary, arvmGroupNotSecondary, arvmMemberFailed, arvmGroupNotSuspended, arvmInvalidMirrorState, arvmVolumeAlreadyInMirrorRelationship, arvmMemberLimitExceeded, arvmSuspendFailure, arvmResumeFailure, arvmSynchronizeFailure, remoteTargetNotFound, arvmMirrorMemberDoesNotExist, snapConversionTooManySnaps, snapConversionMissingLabel, arvmFeatureDeactivated, incompatibleRepositorySecurity, incompatibleSecondarySecurity, mirrorProtocolMismatch, arvmAsyncMirrorGroupPresent, cacheParametersNotChangeable, flashcacheMaxCapacityExceeded, flashcacheFailed, dplCoreDumpRestoreInProgress, arvmGroupHasIncompleteMember, arvmConnectivityTestAlreadyInProgress, arvmConnectivityTestNetworkError, arvmConnectivityTestRemoteTimeout, arvmConnectivityTestLoginFailure, arvmConnectivityTestNameServiceError, arvmConnectivityTestTurError, arvmConnectivityTestMissingRemoteAmg, arvmConnectivityTestAmgMemberMismatch, invalidSyncPriority, invalidRecoveryPointAlertThreshold, invalidSyncAlertThreshold, mustSpecifyExistingVolumes, arvmConnectivityTestTimeoutExceeded, flashcacheMaxLimitExceeded, volsInVgUsingNonSecureCapableFlashcache, volsInVgUsingSecureDisabledFlashcache, invalidSubmodelId, premiumFeatureLimitMismatch, volumeGroupNotImportable, primaryCacheSizeMismatch, flashcacheUserLabelExists, maxThinVolumesExceeded, arvmInvalidSecondaryCapacity, arvmOnlyPrimaryMemberRemoved, arvmOnlySecondaryMemberRemoved, arvmInvalidAmgRequestWhileSuspended, arvmManualSyncAlreadyInProgress, arvmManualSyncRetryTooSoon, diskPoolNotEmpty, flashCacheInvalidBaseVol, flashCacheFdeEnablementDisallowed, remoteArvmFeatureDeactivated, remoteArvmFeatureDisabled, arvmOrphanGroup, arvmOrphanMember, volumeNotAvailable, volumeHasUnreadableSectors, thinProvisioningFeatureDisabled, pitGroupsFeatureDisabled, exceedDiskPoolLimit, flashcacheDegradedState, flashcacheNonDaCapableDriveDisallowed, arvmMaxAsyncMirrorGroupsExceeded, arvmMaxMirrorsPerArrayExceeded, maxTotalMirrorsPerArrayExceeded, exceedDiskPoolCapacity, exceedMaxVolumeCapacity, arvmRemoteMaxAsyncMirrorGroupsExceeded, arvmRemoteMaxMirrorsPerArrayExceeded, remoteMaxTotalMirrorsPerArrayExceeded, arvmInvalidSyncInterval, remoteNoHeap, remoteInternalError, remoteRvmSpmError, arvmRemoteMirrorMemberDoesNotExist, arvmRemoteGroupUserLabelExists, arvmRemoteGroupNotSecondary, arvmRemoteGroupDoesNotExist, remoteInvalidProtection, remoteDatabaseError, arvmRemoteGroupNotEmpty, arvmRemoteSuspendFailure, arvmRemoteResumeFailure, arvmRemoteSynchronizeFailure, flashcacheInvalidAnalyticsState, arvmExpansionSynchronizationInProgress, arvmRemoteExpansionSynchronizationInProgress, faultConditionStillExists, remoteTryAlternate, arvmOnlyLocalAmgDeleted, arvmRoleChangePending, arvmRoleChangeInProgress, arvmMemberStopped, reconstructionInProgress, copybackInProgress, adminPasswordNotSet, keyDoesNotExist, takeRecoveryActionsFirst, coredumpBackupInProgress, legacyRvmAsyncModeUnsupported, arvmIncorrectVolumeType, thinVolumeParametersCannotBeModified, arvmRemoteThinNotSupported, snmpInvalidCommunityName, snmpInvalidCommunityPermission, snmpInvalidCommunityRef, snmpInvalidTrapDestinationRef, invalidIpAddress, snmpMaxCommunitiesExceeded, snmpMaxTrapDestinationsExceeded, snmpCommunityNameInUse, snmpTrapDestinationAddressInUse, snmpUnknownSystemVariable, snmpInvalidSystemVariableValue, snmpIncompatibleFirmware, snmpAgentDisabled, snmpAgentInitFailed, arvmThinVolInitError, arvmRemoteThinVolInitError, snmpIncompatibleIpv4Address, snmpIncompatibleIpv6Address, drivesNotAvailableForRemoval, snmpCannotDisableIpv4, snmpCannotDisableIpv6, snmpIpv4ConfigError, iocDumpInProgress, iocRestoreInProgress, iocDumpInvalidTag, unsupportedEsmRequest, isnsDhcpNotSupported, dpcVolumeGroupNotRedundant, dpcVolumeNotInitialized, dpcExclusiveOperationActive, dpcUnableToPowerUpDrive, dpcFormatActive, dpcUnreadableSectorsPresent, dpcPowerCycleAlreadyInProgress, dpcEnclosureHardwareUnsupported, dpcEnclosureFwDownlevel, evacInProgress, noEvacFound, noHotspareAvailable, driveServiceInProgress, hdd4kbSegmentsizeNotAllowed, diskPoolNoSpareDrives, diskPoolExceedSpareCapacity, autoLoadBalanceUserDisabled, autoLoadBalanceInsufficientStatistics, invalidLoadBalanceAction, invalidLoadBalanceDelay, reservedAddress, volumeCreationInProgress, keyValueTagInvalidRef, keyValueTagInvalidDuplicate, keyValueTagInUse, workloadInvalidRef, invalidKeyValueTagObjectReference, mappingInvalidDuplicate, downloadCompleteNoReboot, downloadCompleteMswOnlyReboot, workloadInvalidDuplicate, mappingInvalidRef, workloadInUse, embeddedExternalKeyManagementEnabled, embeddedExternalKeyManagementCertificatesNotInstalled, illegalOperationOnAllConfigDrives, databaseResyncInProgress, embeddedEkmsKeyserverInfoMissing, embeddedEkmsClientKeyMissing, embeddedEkmsClientCertMissing, embeddedEkmsClientCertMismatch, embeddedEkmsCertExpired, embeddedEkmsProxyNotResponding, embeddedEkmsAuthenticationFailure, embeddedEkmsKeyOwnerRequired, embeddedEkmsServerError, embeddedEkmsServerCertMissing, embeddedEkmsCertDuplicate, embeddedEkmsCertInvalid, embeddedEkmsConnectionFailure, invalidPasswordLength, certRevoked, missingSignature, sigValidationFailed, unableToConnectToOcspResponder, requestFailedDueToAlbEnabled, __UNDEFINED) |
driveStatus |
The drive status. |
< DriveDownloadDriveStatus > array |
4.194. DriveFirmwareUpdateEntry
Name | Description | Schema |
---|---|---|
filename |
Example : |
string |
driveRefList |
Example : |
< string > array |
4.195. AuditLogConfiguration
Name | Description | Schema |
---|---|---|
auditLogMaxRecords |
The maximum number of audit log records to be retained. This value must be set to 50000 or less. |
integer (int32) |
auditLogLevel |
If set to 'all', records for all GET, POST, DELETE and PUT executed endpoints will be logged. If set to 'writeOnly', only records for PUT, DELETE and POST executed endpoints will be logged. |
enum (all, writeOnly) |
auditLogFullPolicy |
If set to 'overWrite' and the maximum number of log records has been reached, older records will be automatically deleted so that new log records can be added. If set to 'preventSystemAccess' and the maximum number of audit log records has been reached, log records will have to be deleted manually before new log records can be added. |
enum (overWrite, preventSystemAccess) |
auditLogWarningThresholdPct |
Indicates how full the audit log can get before a MEL event is generated. This value must be between 60 and 90. |
integer (int32) |
4.196. AuditLogInfoResponse
Name | Description | Schema |
---|---|---|
totalLogRecords |
Total audit log records. |
integer (int32) |
firstRecordTimestamp |
First record timestamp. |
string (int64) |
firstRecordDate |
First record date in the form of 'yyyy-mm-ddThh:mm:ssZ' |
string |
lastRecordTimestamp |
Last record timestamp. |
string (int64) |
lastRecordDate |
Last record date in the form of 'yyyy-mm-ddThh:mm:ssZ' |
string |
4.197. AuditLogDeleteResponse
Name | Description | Schema |
---|---|---|
totalDeletedRecords |
Total number of audit log records deleted |
integer (int32) |
4.198. AuditLogGetResponse
Name | Description | Schema |
---|---|---|
totalLogRecords |
Total audit log records available in the database |
integer (int32) |
logRecords |
The log records requested |
< AuditLogRecord > array |
firstRecordOrdinal |
First record ordinalDeprecated: This field isn’t overly useful since the ordinal values are currently unstable and are relative based on the records returned. |
integer (int32) |
lastRecordOrdinal |
Last record ordinal. Deprecated: This field isn’t overly useful since the ordinal values are currently unstable and are relative based on the records returned. |
integer (int32) |
4.199. AuditLogRecord
Audit log record.
Name | Description | Schema |
---|---|---|
method |
HTTP method, for example GET and POST. |
string |
accessedUrl |
Accessed URL. |
string |
clientIp |
IP address of client. |
string |
userId |
Username of the user accessing the URL. |
string |
httpStatus |
HTTP status code of the operation. |
integer (int32) |
httpReasonPhrase |
HTTP reason phrase. |
string |
isFederated |
Indicates if the user was authenticated by WSP in a federated security environment. |
boolean |
loggingAgent |
Logging agent. |
string |
cliCommandExecuted |
CLI command executed. |
string |
cliReturnStatus |
CLI status code or request for input files. |
string |
symbolProcedure |
Symbol procedure. |
string |
sshEventType |
SSH login event type. |
enum (login, logout, login_fail, signature_validation_failure, ntp_time_change, cfw_integrity_check, firmware_download_start, activation_complete, audit_log_shutdown, audit_log_start, session_timeout) |
sshSessionPid |
SSH session process ID. |
integer (int32) |
sshSessionDuration |
SSH session duration (in seconds). |
integer (int32) |
timestamp |
Date and time of accessed URL in seconds since midnight GMT on January 1, 1970. |
string (int64) |
dateTime |
Date and time of accessed URL in the form of 'yyyy-mm-ddThh:mm:ssZ' |
string |
recordOrdinal |
Record ordinal. |
integer (int32) |
optionalText |
Optional Text. |
string |
4.200. AuditLogMessagesRequest
Object used when requesting messages from the Audit Log
Name | Description | Schema |
---|---|---|
startRecordOrdinal |
Starting record ordinal |
integer (int32) |
endingRecordOrdinal |
Ending record ordinal |
integer (int32) |
beginTime |
Beginning timestamp(UTC) in the forms of:<br>yyyy-mm-ddThh:mm:ssZ',<br>'yyyy-mm-ddThh:mm:ss.sssZ',<br>'yyyy-mm-ddThh:mm:ss+|-hh:mm <br><br>EXAMPLES:<br>'2018-01-15T05:06:08Z',<br>'2018-07-12T17:57:14.922Z',<br>'2018-07-13T14:59:52+00:00' |
string |
endTime |
Ending timestamp(UTC) in the forms of:<br>yyyy-mm-ddThh:mm:ssZ',<br>'yyyy-mm-ddThh:mm:ss.sssZ',<br>'yyyy-mm-ddThh:mm:ss+|-hh:mm <br><br>EXAMPLES:<br>'2018-01-15T05:06:08Z',<br>'2018-07-12T17:57:14.922Z',<br>'2018-07-13T14:59:52+00:00' |
string |
4.201. EmbeddedCompatibilityCheckResponse
Reports the compatibility of the firmware/nvsram file and whether a signature is present on the file
Name | Description | Schema |
---|---|---|
signatureTestingPassed |
Indicates if the initial signature validation test passed or not. Full validation will still be performed by the controller before the download can complete. |
boolean |
fileCompatible |
If the file is compatible |
boolean |
versionContents |
Enumerates all the versions on the bundle/nvsram file and what is on the controller |
< VersionContent > array |
4.202. VersionContent
Object that contains definitions for on board and bundled code module versions
Name | Description | Schema |
---|---|---|
module |
The code module described |
enum (unspecified, raid, hypervisor, management, iom, nvsram, bundle, bundleDisplay, __UNDEFINED) |
bundledVersion |
Code bundled with firmware file |
string |
onboardVersion |
Code active on storage system |
string |
4.203. CurrentFirmwareResponse
Class that holds details on the Firmware on the array.
Name | Description | Schema |
---|---|---|
codeVersions |
Version descriptors for code modules |
< VersionDescriptor > array |
4.204. EmbeddedFirmwareResponse
Class that holds details on the Firmware upgrade timestamps and logs.
Name | Description | Schema |
---|---|---|
cfwUpgradeTS |
Timestamp of the last successful controller firmware upgrade |
string (date-time) |
iomUpgradeTS |
Timestamp of the last successful iom firmware upgrade |
string (date-time) |
driveUpgradeTS |
Timestamp of the last successful drive firmware upgrade |
string (date-time) |
nvsramUpgradeTS |
Timestamp of the last successful NVSRAM upgrade |
string (date-time) |
cfwLog |
Array of log records of controller firmware upgrades |
< LogRecord > array |
iomLog |
Array of log records of iom firmware upgrades |
< LogRecord > array |
driveLog |
Array of log records drive firmware upgrades |
< LogRecord > array |
nvsramLog |
Array of log records NVSRAM upgrades |
< LogRecord > array |
4.205. Enumeration
Type : object
4.206. EnumerationString
Type : object
4.207. Level
Name | Description | Schema |
---|---|---|
name |
Example : |
string |
resourceBundleName |
Example : |
string |
localizedName |
Example : |
string |
4.208. Locale
Name | Description | Schema |
---|---|---|
language |
Example : |
string |
country |
Example : |
string |
displayCountry |
Example : |
string |
displayLanguage |
Example : |
string |
displayName |
Example : |
string |
displayScript |
Example : |
string |
displayVariant |
Example : |
string |
extensionKeys |
Example : |
< string > array |
iso3Country |
Example : |
string |
iso3Language |
Example : |
string |
script |
Example : |
string |
unicodeLocaleAttributes |
Example : |
< string > array |
unicodeLocaleKeys |
Example : |
< string > array |
variant |
Example : |
string |
4.209. LogRecord
Name | Description | Schema |
---|---|---|
level |
Example : |
|
sequenceNumber |
Example : |
string (int64) |
sourceClassName |
Example : |
string |
sourceMethodName |
Example : |
string |
message |
Example : |
string |
threadID |
Example : |
integer (int32) |
millis |
Example : |
string (int64) |
thrown |
Example : |
|
loggerName |
Example : |
string |
resourceBundleName |
Example : |
string |
parameters |
Example : |
< object > array |
resourceBundle |
Example : |
4.210. ResourceBundle
Name | Description | Schema |
---|---|---|
locale |
Example : |
|
baseBundleName |
Example : |
string |
keys |
Example : |
4.211. StackTraceElement
Name | Description | Schema |
---|---|---|
methodName |
Example : |
string |
fileName |
Example : |
string |
lineNumber |
Example : |
integer (int32) |
className |
Example : |
string |
nativeMethod |
Example : |
boolean |
4.212. Throwable
Name | Description | Schema |
---|---|---|
cause |
Example : |
|
stackTrace |
Example : |
< StackTraceElement > array |
localizedMessage |
Example : |
string |
message |
Example : |
string |
suppressed |
Example : |
< Throwable > array |
4.213. UpgradeLogRecord
Class that holds details on the upgrade log messages
Name | Description | Schema |
---|---|---|
message |
The upgrade message |
string |
timestamp |
The upgrade message timestamp |
string (date-time) |
4.214. UpgradeLogsResponse
Class that holds details on the firmware upgrade timestamps and log messages.
Name | Description | Schema |
---|---|---|
cfwUpgradeTS |
Timestamp of the last successful controller firmware upgrade |
string (date-time) |
iomUpgradeTS |
Timestamp of the last successful iom firmware upgrade |
string (date-time) |
driveUpgradeTS |
Timestamp of the last successful drive firmware upgrade |
string (date-time) |
nvsramUpgradeTS |
Timestamp of the last successful NVSRAM upgrade |
string (date-time) |
cfwLog |
Array of log records for controller firmware upgrades |
< UpgradeLogRecord > array |
iomLog |
Array of log records for iom firmware upgrades |
< UpgradeLogRecord > array |
driveLog |
Array of log records for drive firmware upgrades |
< UpgradeLogRecord > array |
nvsramLog |
Array of log records for NVSRAM upgrades |
< UpgradeLogRecord > array |
4.215. IomServiceInfoResponse
API object that includes information about the IOM service.
Name | Description | Schema |
---|---|---|
iomServiceEnabled |
Reports whether the IOM service is enabled. |
boolean |
disruptiveIomFirmwareUpdate |
Reports whether there are any trays for which an IOM firmware update would be disruptive. |
boolean |
4.216. IomServiceUpdateRequest
API object for an IOM service change request.
Name | Description | Schema |
---|---|---|
enabled |
true to enable the service, false to disable. |
boolean |
4.217. LocalUserInfoResponse
Local admin password
Name | Description | Schema |
---|---|---|
adminPasswordSet |
True if the admin password is set |
boolean |
minimumPasswordLength |
The minimum required length |
integer (int32) |
4.218. LocalUsersMinPasswordRequest
Set the minimum password length
Name | Description | Schema |
---|---|---|
minimumPasswordLength |
The minimum password length required |
integer (int32) |
4.219. LocalUserResponse
Information about a local user account
Name | Description | Schema |
---|---|---|
userName |
The username for this local account |
string |
roles |
The list of roles assigned to this user |
< string > array |
passwordSet |
True if the password is not the default |
boolean |
4.220. LocalUserPasswordRequest
Request to change the local user account password
Name | Description | Schema |
---|---|---|
userName |
The local account user to update |
string |
newPassword |
The new password to use for local account. |
string |
4.221. LocalUserRequest
Request to change one or more local user account password
Name | Description | Schema |
---|---|---|
currentAdminPassword |
Password for the admin user |
string |
updates |
List of updates to perform to local users |
< LocalUserPasswordRequest > array |
4.222. SessionSettingsResponse
Server session settings response.
Name | Description | Schema |
---|---|---|
minimumSessionInactivePeriod |
Minimum session inactivity period, in seconds. |
integer (int32) |
sessionInactivePeriod |
Session inactivity period, in seconds, before the session times out. A value of zero indicates the session should never timeout. |
integer (int32) |
4.223. SessionSettings
Server session settings.
Name | Description | Schema |
---|---|---|
sessionInactivePeriod |
Session inactivity period, in seconds, before the session times out. A value of zero indicates the session should never timeout. |
integer (int32) |
4.224. AuthenticationSettings
Server authentication settings.
Name | Description | Schema |
---|---|---|
disableBasicAuthentication |
Disable Basic Authentication, a value of false will allow Basic Authentication, a value of true will prevent Basic Authentication. |
boolean |
4.225. LockoutSettings
Lockout settings.
Name | Description | Schema |
---|---|---|
lockoutMode |
Example : |
enum (ip, user) |
lockoutTime |
Example : |
integer (int32) |
maximumLoginAttempts |
Example : |
integer (int32) |
4.226. Event
Base event object
Name | Description | Schema |
---|---|---|
timestamp |
Example : |
string (date-time) |
eventNumber |
Example : |
string (int64) |
eventType |
Example : |
enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, untrustedCertificateChangeEvent, trustedCertificateChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent, batchSystemChangeEvent, sysReplicationChangeEvent) |
4.227. EventObjectIdentifier
This class identifies an object in the system. It is an Object Type and an Object Key. The get is usually the fields named "id" or xxxRef in the object. The type field indicates the type of object
Name | Description | Schema |
---|---|---|
type |
Example : |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
id |
Example : |
string |
userFriendlyId |
Example : |
string |
modifiedFields |
Example : |
< string > array |
4.228. FolderEvent
Polymorphism : Inheritance
Discriminator : eventType
Name | Description | Schema |
---|---|---|
timestamp |
Example : |
string (date-time) |
eventNumber |
Example : |
string (int64) |
eventType |
Example : |
enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, untrustedCertificateChangeEvent, trustedCertificateChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent, batchSystemChangeEvent, sysReplicationChangeEvent) |
addedObjects |
List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
modifiedObjects |
List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
deletedObjects |
List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
4.229. MetadataChangeEvent
Polymorphism : Inheritance
Discriminator : eventType
Name | Description | Schema |
---|---|---|
timestamp |
Example : |
string (date-time) |
eventNumber |
Example : |
string (int64) |
eventType |
Example : |
enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, untrustedCertificateChangeEvent, trustedCertificateChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent, batchSystemChangeEvent, sysReplicationChangeEvent) |
addedObjects |
List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
modifiedObjects |
List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
deletedObjects |
List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
storageSystemId |
Example : |
string |
4.230. ObjectChangeEvent
Polymorphism : Inheritance
Discriminator : eventType
Name | Description | Schema |
---|---|---|
timestamp |
Example : |
string (date-time) |
eventNumber |
Example : |
string (int64) |
eventType |
Example : |
enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, untrustedCertificateChangeEvent, trustedCertificateChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent, batchSystemChangeEvent, sysReplicationChangeEvent) |
addedObjects |
List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
modifiedObjects |
List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
deletedObjects |
List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
4.231. ObjectGraphChangeEvent
Polymorphism : Inheritance
Discriminator : eventType
Name | Description | Schema |
---|---|---|
timestamp |
Example : |
string (date-time) |
eventNumber |
Example : |
string (int64) |
eventType |
Example : |
enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, untrustedCertificateChangeEvent, trustedCertificateChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent, batchSystemChangeEvent, sysReplicationChangeEvent) |
addedObjects |
List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
modifiedObjects |
List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
deletedObjects |
List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
storageSystemId |
Example : |
string |
currentConfigGen |
The config gen number associated to the with these events. |
string (int64) |
previousConfigGen |
The config gen number that was currently known. It is possible for there to be a gap between currentConfig and previous Don’t expect them to be sequential |
string (int64) |
systemWWN |
The storage systems World Wide Name |
string |
4.232. PasswordStatusEvent
Polymorphism : Inheritance
Discriminator : eventType
Name | Description | Schema |
---|---|---|
timestamp |
Example : |
string (date-time) |
eventNumber |
Example : |
string (int64) |
eventType |
Example : |
enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, untrustedCertificateChangeEvent, trustedCertificateChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent, batchSystemChangeEvent, sysReplicationChangeEvent) |
previousStatus |
Example : |
enum (unknown, invalid, valid, securityLockout) |
currentStatus |
Example : |
enum (unknown, invalid, valid, securityLockout) |
storageSystemId |
Example : |
string |
4.233. StorageDeviceStatusEvent
Polymorphism : Inheritance
Discriminator : eventType
Name | Description | Schema |
---|---|---|
timestamp |
Example : |
string (date-time) |
eventNumber |
Example : |
string (int64) |
eventType |
Example : |
enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, untrustedCertificateChangeEvent, trustedCertificateChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent, batchSystemChangeEvent, sysReplicationChangeEvent) |
previousStatus |
Example : |
enum (neverContacted, offline, optimal, needsAttn, removed, newDevice, lockDown) |
currentStatus |
Example : |
enum (neverContacted, offline, optimal, needsAttn, removed, newDevice, lockDown) |
storageSystemId |
Example : |
string |
systemWWN |
Example : |
string |
4.234. TagEvent
Polymorphism : Inheritance
Discriminator : eventType
Name | Description | Schema |
---|---|---|
timestamp |
Example : |
string (date-time) |
eventNumber |
Example : |
string (int64) |
eventType |
Example : |
enum (objectGraphChangeEvent, passwordStatusEvent, storageSystemStatusEvent, storageSystemMDChangeEvent, folderEvent, metadataTagEvent, softwareDownloadEvent, softwareReloadEvent, asupConfigChangeEvent, iomConfigChangeEvent, alertConfigChangeEvent, firmwareDownloadEvent, criticalMelChangeEvent, statisticsCollectionEvent, melClearEvent, workload, ldapConfigChangeEvent, symbolPortChangeEvent, keyStoreChangeEvent, trustStoreChangeEvent, untrustedCertificateChangeEvent, trustedCertificateChangeEvent, externalCertChangeEvent, sslReloadCompleteEvent, sessionTimeoutChangeEvent, samlConfigChangeEvent, batchSystemChangeEvent, sysReplicationChangeEvent) |
addedObjects |
List of objects added. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
modifiedObjects |
List of objects updated. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
deletedObjects |
List of objects deleted. Only certain objects that have rest endpoints will be represented in this list. See Event ObjectTypes for types of objects that have events |
< EventObjectIdentifier > array |
4.235. ExternalKeyManagerCSR
This class describes the input for a Certificate Signing Request needed to create a client side certificate for External Key Manager integration
Name | Description | Schema |
---|---|---|
commonName |
Typically pre-populated with the storage array name |
string |
organizationName |
The full legal name of the organization |
string |
organizationalUnitName |
The division of the organization handling the certificate |
string |
localityName |
City or Locality for the organization |
string |
stateProvinceName |
The full name of the state or province for the organization |
string |
countryName |
The two letter country ISO code for the organization |
string |
4.236. EnableExternalKeyServerRequest
Used to set the parameters necessary to communicate with an external key management server.
Name | Description | Schema |
---|---|---|
keyServerAddress |
IP or DNS address of the KMS server |
|
port |
Port for the KMS server |
integer (int32) |
4.237. EKMSCommunicationResponse
Indicates whether the symbol command executed successfully along with the return code from the symbol command.
Name | Description | Schema |
---|---|---|
successful |
Indicates if the symbol command executed successfully. |
boolean |
returnCode |
The return code returned by the symbol command. |
enum (uninitialized, ok, error, busy, illegalParam, noHeap, driveNotExist, driveNotUnassigned, noSparesAssigned, someSparesAssigned, volumeNotExist, volumeReconfiguring, notDualActive, tryAlternate, background, notImplemented, reservationConflict, volumeDead, internalError, invalidRequest, iconFailure, volumeFormatting, altRemoved, cacheSyncFailure, invalidFile, reconfigSmallDacstore, reconfigFailure, nvramError, flashError, authFailParam, authFailPassword, memParityError, invalidControllerref, invalidVolumegroupref, invalidVolumeref, invalidDriveref, invalidFreeextentref, volumeOffline, volumeNotOptimal, modesenseError, invalidSegmentsize, invalidCacheblksize, invalidFlushThreshold, invalidFlushAmount, invalidLabel, invalidCacheModifier, invalidReadahead, invalidReconpriority, invalidScanperiod, invalidTrayposLength, invalidRegionid, invalidFibreid, invalidEncryption, invalidRaidlevel, invalidExpansionList, noSparesDeassigned, someSparesDeassigned, partDupId, partLabelInvalid, partNodeNonexistent, partPortIdInvalid, partVolumeNonexistent, partLunCollision, maxVolMappingExceeded, partMappingNonexistent, partNoHostports, imageTransferred, fileTooLarge, invalidOffset, overrun, invalidChunksize, invalidTotalsize, downloadNotPermitted, spawnError, voltransferError, invalidDlstate, cacheconfigError, downloadInProgress, driveNotOptimal, driveRemoved, duplicateDrives, numdrivesAdditional, numdrivesGroup, driveTooSmall, capacityConstrained, maxVolumesExceeded, partIsUtmLun, someSparesTooSmall, sparesSmallUnassigned, tooManyPartitions, parityScanInProgress, invalidSafeId, invalidSafeKey, invalidSafeCapability, invalidSafeVersion, partitionsDisabled, driveDownloadFailed, esmDownloadFailed, esmPartialUpdate, utmConflict, noVolumes, authFailReadpassword, partCrteFailTblFull, attemptToSetLocal, invalidHostTypeIndex, failVolumeVisible, noDeleteUtmInUse, invalidLun, utmTooManyMaps, diagReadFailure, diagSrcLinkDown, diagWriteFailure, diagLoopbackError, diagTimeout, diagInProgress, diagNoAlt, diagIconSendErr, diagInitErr, diagModeErr, diagInvalidTestId, diagDriveErr, diagLockErr, diagConfigErr, diagNoCacheMem, diagNotQuiesced, diagUtmNotEnabled, invalidModeSwitch, invalidPortname, duplicateVolMapping, maxSnapsPerBaseExceeded, maxSnapsExceeded, invalidBasevol, snapNotAvailable, notDisabled, snapshotFeatureDisabled, repositoryOffline, repositoryReconfiguring, rollbackInProgress, numVolumesGroup, ghostVolume, repositoryMissing, invalidRepositoryLabel, invalidSnapLabel, invalidRollbackPriority, invalidWarnThreshold, cannotMapVolume, cannotFormatVolume, dstNotFibre, repositoryTooSmall, repositoryFailed, baseVolumeFailed, baseVolumeOffline, baseVolumeFormatting, metadataVolNonexistent, rvmFeatureDisabled, mirrorsPresent, rvmFeatureDeactivated, maxMirrorsExceeded, invalidMirrorCandidateVol, invalidMirrorvol, metadataAlreadyExists, metadataMissing, metadataOffline, metadataReconfiguring, localRoleChangeFailed, remoteRoleChangeFailed, localRoleChangeSuccessful, onlyLocalMirrorDeleted, noValidMirrorCandidate, remoteMaxMirrorsExceeded, remoteRvmFeatureDisabled, remoteMetadataVolNonexistent, notRegistered, remoteInvalidCfgGen, localRoleChangedNotForced, remoteRoleChangedLocalFailed, rvmSpmError, remoteAuthFailPassword, rvmVersionMismatch, rvmRemoteArrayError, rvmCommunicationError, rvmFibreError, mirrorVolNotPrimary, secNotPromoteable, priNotDemoteable, metadataChildDeletion, rmtvolOrphanDeletion, rvmActivateDisallowed, invalidTrayref, partialDeletion, defaultUtmCollision, invalidCopyPriority, invalidVolumecopyref, copyChangeFailed, copyActive, copyInactive, copyIncompatibleSource, copyIncompatibleTarget, copyGhostSource, copyGhostTarget, copyInvalidSourceRef, copyInvalidTargetRef, copyInvalidSourceState, copyInvalidTargetState, copySourceReconfig, copyTargetReconfig, copyTargetTooSmall, copyTargetLimit, maxVolumeCopysExceeded, copySourceReservation, copyTargetReservation, copySourceFormat, copyTargetFormat, copyStartFailed, copyStopFailed, volcopyFeatureDisabled, writeLock, cannotReconfigure, authFailContLockout, prReservationConflict, regDeleteFailed, batteryNotInConfig, batteryMissing, noChannel, rvmOperNotAllowedOnSec, dataRedundancyRequired, copySourceZeroCapacity, invHostlunDefineMapping, invHostlunMoveMapping, invHostlunDefineHosttype, invHostlunMoveHostport, fwIncompatible, mirrorAlreadySuspended, insuffLocalMirRepResources, insuffRemtMirRepResources, ghostHasUnreadableSectors, rvmCommStatRecoveredTimeout, rvmCommStatRecoveredDelay, rvmCommStatNotReady, rvmCommStatTimeout, rvmCommStatChannelFailure, rvmCommStatNetworkFailure, rvmCommStatDeviceMissing, rvmCommStatLoginRejected, rvmCommStatLoginFailure, rvmCommStatInvNumSamplesReqd, rvmQuiescenceInProgress, rvmInvalidRemotevol, sodInProgress, invalidDrives, invalidSetid, invalidSetsize, missingData, quiescenceFailed, validationError, downloadHalted, allFailed, partialOk, obsolete, usmClearFailed, controllerInServiceMode, invalidDrive, databaseError, backgroundAutocfg, autocfgInprogress, unsupportedLhaSataEsm, parityScanFailed, parityRepairFailed, mediaRepairFailed, mirrorDegraded, prohibitedByMdtRestrictions, prohibitedByGoldKeyRestrictions, safeControllerNotSubjectToGoldKey, safeMdtNotPremiumFeature, alarmNotPresent, dltNotCompleted, dependancyError, cdmDatabaseFull, requiredConditionNotPresent, ddcUnavail, ddcIllegalParam, invalidDdcTag, hosttypeConflict, portConflict, invalidHosttypeString, invalidProtocol, portRemoved, disableNotPermitted, prohibitedByDriveTrayLimit, invalidEsmref, invalidBundleMigration, invalidBundleKey, noSparesNeeded, prohibitedByFeatureBundleViolation, invalidAuthMethod, invalidSecret, secretAlreadyInUse, manualConfigModeSet, noIscsiSessions, invalidInterfaceref, initiatorConflict, initiatorRemoved, basevolSizeChanged, volumeGroupNotExist, volumeGroupNotOnline, volumeGroupHasHotspare, volumeGroupReconfiguring, volumeGroupStateNotValid, controllerNotOptimal, insufficientCapacity, volumeGroupExported, volumeNotConfigurable, volumeGroupNotConfigurable, invalidDriveState, volumeGroupReconstructing, volumeGroupUndergoingCopyback, volumeGroupNotComplete, volumeGroupHasFailedDrives, volumeGroupHasNonOptimalVols, volumeGroupHasMirrorRelationship, volumeGroupHasVolcopyRelationship, volumeGroupHasMirroringMetadata, volumeGroupHasMappedVols, volumeGroupHasReservations, volumeGroupHasIncompatibleDacstores, volumeLimitExceeded, volumeGroupHasUnknownRaidLevel, volumeGroupHasUnsupportedRaidLevel, volumeGroupHasCloneOpportunity, volumeGroupHasInsufficientDrives, volumeGroupHasFailedVols, perfTierSafeUpgradeDisabled, raid6FeatureUnsupported, raid6FeatureDisabled, safeControllerNotSubjectToRaid6, volumeGroupNotContingent, channelDiagsRunning, channelDiagsResultsPartial, volumeGroupHasSnapshotRelationship, prohibitedBySafeViolation, legacyVg, vgNotForceable, channelDiagsLockErr, channelDiagsNotQuiesced, channelDiagsAltCommFailed, channelDiagsChanSetupFailed, channelDiagsDeviceBypassFailed, channelDiagsResultsNotAvailable, driveSpinUpError, driveTypeMismatch, localRemoteArrayHasSameWwn, volumeGroupHasIncompatibleDrive, volumeGroupVolumeEncroachesOnDacstore, volumeGroupImportInProgress, drivesNeedToBeSpunUp, noNativeSstor, noSuchDebugChunk, debugInfoConfigChanged, lockdown, drivesDacstoresOverlap, volumeHasAsyncMirror, reconfigLogSpaceError, volumeGroupInaccessible, volumeInitializing, insufficientCache, volumeInaccessible, noDrivesAdopted, someDrivesAdopted, exportingDrivesDatabaseResynchronizing, exportingDrivesDatabaseFailed, exportingDrivesQuiesced, learnActiveTryLater, noLockedDrives, driveSecurityEnabledFailed, lockkeyFailed, invalidSecurity, noFdeDrives, volumeGroupSecure, invalidBlob, unlockFailed, noKeySet, rekeyInProgress, defaultHostGroupMappingNotAllowed, ssdMediaScanNotAllowed, premiumFeatureLimitExceedsMaximum, disableEvaluationFeatureNotPermitted, requestFailedDueToLun0Restrictions, externalKmsEnabled, externalKmsFailed, externalKmsNotEnabled, keyNotNeeded, keyInvalidSequence, diagNotRunning, ctrlNotInServiceMode, invalidFeatureref, cacheBackupDevNotExist, noMatchingLockKeyIdFound, lockKeyValidationFailed, lockKeyValidationDisabled, externalKmsNotCompliant, externalKmsTimeout, cannotDisableNoKey, previouslyEnabledForEval, featureNotKeyable, evalNotSupported, rawdataTransferBadType, rawdataTransferNotStarted, rawdataTransferAlreadyStarted, rawdataTransferPreparing, rawdataTransferReadError, rawdataTransferNoDrives, rawdataTransferInvalidImage, rawdataTransferCrcError, dbmRestoreWriteError, dbmRestoreNoDrives, rawdataBadSeqNum, invalidCapability, externalKeyNotInMemory, invalidLockKeyId, invalidProtection, volumeHasSnapshotRelationship, volumeHasMirrorRelationship, externalKmsDisabledNoKey, dbmRestoreAltCtlNotOffline, copyApptagMismatch, invalidRequestForEnclosure, dqRetrieveNothingToTransfer, invalidIscsiConfiguration, volumeHasVolcopyRelationship, partPiIncapable, requestFailedDueToPiRestrictions, rawdataTransferUserCancelled, duplicateIscsiIpAddress, portSpeedConflict, factoryDefaultDownloadFailed, errorWritingToEeprom, factoryDefaultPartialUpdate, snapshotNotActive, cannotRollback, mirrorSyncNotPossible, psuFirmwareDownloadFailed, psuFirmwareUpdateMfgDeviceCodeMismatch, psuFirmwareUpdateNotAllRedundant, psuFirmwareUpdateNotAllOptimal, insufficientRepositoryCapacity, rollbackStartFailure, csbReserveFailed, csbReleaseFailedNoLock, csbReleaseFailedInvalidKey, flashcacheAlreadyExists, flashcacheFeatureDisabled, flashcacheAlreadySuspended, flashcacheNotSuspended, flashcacheInvalidConfigType, invalidPitGroupLabel, invalidPitConsistencyGroupLabel, invalidPitAutoDeleteLimit, invalidPitRepositoryFullPolicy, invalidConcatVolMemberLabel, concatVolMemberTooSmall, invalidPitGroupRef, invalidPitRef, dveNotAllowed, dssNotAllowed, dplCoreDumpInvalidTag, invalidPitViewLabel, invalidPitViewRef, invalidConcatVolRef, notFlashcacheVol, flashcacheDeleted, flashcacheEnabled, flashcacheNotEnabled, noRepDeletion, maxPitsPerGroupExceeded, maxPitsExceeded, maxPitGroupsPerBaseExceeded, maxPitGroupsExceeded, maxViewsPerPitExceeded, maxViewsExceeded, maxConsistencyGroupsExceeded, maxConsistencyGroupMembersExceeded, maxMappableVolumesExceeded, notOldestPit, viewStopped, concatMemberLimitExceeded, invalidMemberVol, memberVolMapped, invalidMemberVolState, invalidTrimCount, pitGroupInConsistencyGroup, pitInConsistencyGroup, pitViewInConsistencyGroup, incompatibleMemberVol, volumeInUse, rvmOverIscsiNotSupported, arvmGroupUserLabelExists, arvmGroupDoesNotExist, arvmGroupNotEmpty, concatVolumeFailed, invalidPitConsistencyGroupRef, invalidPitConsistencyGroupViewRef, invalidPitConsistencyGroupViewLabel, alternateRequiredForOperation, invalidPitForView, consistencyGroupArvmBindingConflict, attributeFixedByArvm, operationFailedVolumeCopyClone, pitCreatePending, dbmDbSourceUnavailable, dbmRestoreSourceMismatch, invalidCriticalThreshold, volumeGroupHasArvmRelationship, arvmRecoveryPointDeletionRequired, volumeGroupHasPitgroupRelationship, volumeGroupHasPitviewRelationship, volumeGroupHasConcatRelationship, flashcacheSuspended, flashcacheAlreadyEnabled, dbmDbImageCorrupt, illegalVolume, invalidRepositoryCapacity, invalidProvisionedCapacityQuota, invalidExpansionPolicy, invalidVirtualCapacity, cannotExpandConcatMember, thresholdBelowUsedCapacity, invalidExpansionOperation, repositoryFull, insufficientExpansionSpace, invalidExpansionSize, invalidReinitAction, invalidReinitCapacity, invalidIncompleteMemberRef, arvmGroupNotPrimary, arvmGroupNotSecondary, arvmMemberFailed, arvmGroupNotSuspended, arvmInvalidMirrorState, arvmVolumeAlreadyInMirrorRelationship, arvmMemberLimitExceeded, arvmSuspendFailure, arvmResumeFailure, arvmSynchronizeFailure, remoteTargetNotFound, arvmMirrorMemberDoesNotExist, snapConversionTooManySnaps, snapConversionMissingLabel, arvmFeatureDeactivated, incompatibleRepositorySecurity, incompatibleSecondarySecurity, mirrorProtocolMismatch, arvmAsyncMirrorGroupPresent, cacheParametersNotChangeable, flashcacheMaxCapacityExceeded, flashcacheFailed, dplCoreDumpRestoreInProgress, arvmGroupHasIncompleteMember, arvmConnectivityTestAlreadyInProgress, arvmConnectivityTestNetworkError, arvmConnectivityTestRemoteTimeout, arvmConnectivityTestLoginFailure, arvmConnectivityTestNameServiceError, arvmConnectivityTestTurError, arvmConnectivityTestMissingRemoteAmg, arvmConnectivityTestAmgMemberMismatch, invalidSyncPriority, invalidRecoveryPointAlertThreshold, invalidSyncAlertThreshold, mustSpecifyExistingVolumes, arvmConnectivityTestTimeoutExceeded, flashcacheMaxLimitExceeded, volsInVgUsingNonSecureCapableFlashcache, volsInVgUsingSecureDisabledFlashcache, invalidSubmodelId, premiumFeatureLimitMismatch, volumeGroupNotImportable, primaryCacheSizeMismatch, flashcacheUserLabelExists, maxThinVolumesExceeded, arvmInvalidSecondaryCapacity, arvmOnlyPrimaryMemberRemoved, arvmOnlySecondaryMemberRemoved, arvmInvalidAmgRequestWhileSuspended, arvmManualSyncAlreadyInProgress, arvmManualSyncRetryTooSoon, diskPoolNotEmpty, flashCacheInvalidBaseVol, flashCacheFdeEnablementDisallowed, remoteArvmFeatureDeactivated, remoteArvmFeatureDisabled, arvmOrphanGroup, arvmOrphanMember, volumeNotAvailable, volumeHasUnreadableSectors, thinProvisioningFeatureDisabled, pitGroupsFeatureDisabled, exceedDiskPoolLimit, flashcacheDegradedState, flashcacheNonDaCapableDriveDisallowed, arvmMaxAsyncMirrorGroupsExceeded, arvmMaxMirrorsPerArrayExceeded, maxTotalMirrorsPerArrayExceeded, exceedDiskPoolCapacity, exceedMaxVolumeCapacity, arvmRemoteMaxAsyncMirrorGroupsExceeded, arvmRemoteMaxMirrorsPerArrayExceeded, remoteMaxTotalMirrorsPerArrayExceeded, arvmInvalidSyncInterval, remoteNoHeap, remoteInternalError, remoteRvmSpmError, arvmRemoteMirrorMemberDoesNotExist, arvmRemoteGroupUserLabelExists, arvmRemoteGroupNotSecondary, arvmRemoteGroupDoesNotExist, remoteInvalidProtection, remoteDatabaseError, arvmRemoteGroupNotEmpty, arvmRemoteSuspendFailure, arvmRemoteResumeFailure, arvmRemoteSynchronizeFailure, flashcacheInvalidAnalyticsState, arvmExpansionSynchronizationInProgress, arvmRemoteExpansionSynchronizationInProgress, faultConditionStillExists, remoteTryAlternate, arvmOnlyLocalAmgDeleted, arvmRoleChangePending, arvmRoleChangeInProgress, arvmMemberStopped, reconstructionInProgress, copybackInProgress, adminPasswordNotSet, keyDoesNotExist, takeRecoveryActionsFirst, coredumpBackupInProgress, legacyRvmAsyncModeUnsupported, arvmIncorrectVolumeType, thinVolumeParametersCannotBeModified, arvmRemoteThinNotSupported, snmpInvalidCommunityName, snmpInvalidCommunityPermission, snmpInvalidCommunityRef, snmpInvalidTrapDestinationRef, invalidIpAddress, snmpMaxCommunitiesExceeded, snmpMaxTrapDestinationsExceeded, snmpCommunityNameInUse, snmpTrapDestinationAddressInUse, snmpUnknownSystemVariable, snmpInvalidSystemVariableValue, snmpIncompatibleFirmware, snmpAgentDisabled, snmpAgentInitFailed, arvmThinVolInitError, arvmRemoteThinVolInitError, snmpIncompatibleIpv4Address, snmpIncompatibleIpv6Address, drivesNotAvailableForRemoval, snmpCannotDisableIpv4, snmpCannotDisableIpv6, snmpIpv4ConfigError, iocDumpInProgress, iocRestoreInProgress, iocDumpInvalidTag, unsupportedEsmRequest, isnsDhcpNotSupported, dpcVolumeGroupNotRedundant, dpcVolumeNotInitialized, dpcExclusiveOperationActive, dpcUnableToPowerUpDrive, dpcFormatActive, dpcUnreadableSectorsPresent, dpcPowerCycleAlreadyInProgress, dpcEnclosureHardwareUnsupported, dpcEnclosureFwDownlevel, evacInProgress, noEvacFound, noHotspareAvailable, driveServiceInProgress, hdd4kbSegmentsizeNotAllowed, diskPoolNoSpareDrives, diskPoolExceedSpareCapacity, autoLoadBalanceUserDisabled, autoLoadBalanceInsufficientStatistics, invalidLoadBalanceAction, invalidLoadBalanceDelay, reservedAddress, volumeCreationInProgress, keyValueTagInvalidRef, keyValueTagInvalidDuplicate, keyValueTagInUse, workloadInvalidRef, invalidKeyValueTagObjectReference, mappingInvalidDuplicate, downloadCompleteNoReboot, downloadCompleteMswOnlyReboot, workloadInvalidDuplicate, mappingInvalidRef, workloadInUse, embeddedExternalKeyManagementEnabled, embeddedExternalKeyManagementCertificatesNotInstalled, illegalOperationOnAllConfigDrives, databaseResyncInProgress, embeddedEkmsKeyserverInfoMissing, embeddedEkmsClientKeyMissing, embeddedEkmsClientCertMissing, embeddedEkmsClientCertMismatch, embeddedEkmsCertExpired, embeddedEkmsProxyNotResponding, embeddedEkmsAuthenticationFailure, embeddedEkmsKeyOwnerRequired, embeddedEkmsServerError, embeddedEkmsServerCertMissing, embeddedEkmsCertDuplicate, embeddedEkmsCertInvalid, embeddedEkmsConnectionFailure, invalidPasswordLength, certRevoked, missingSignature, sigValidationFailed, unableToConnectToOcspResponder, requestFailedDueToAlbEnabled, __UNDEFINED) |
4.238. X509ExternalCertInfo
Basic information for X509 External certificates stored in the system.
Name | Description | Schema |
---|---|---|
kmsAddress |
Example : |
|
kmsPort |
Example : |
integer (int32) |
clientKmsType |
Example : |
enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED) |
clientSubjectDN |
Example : |
string |
clientIssuerDN |
Example : |
string |
clientStart |
Example : |
string (date-time) |
clientExpire |
Example : |
string (date-time) |
serverKmsType |
Example : |
enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED) |
serverSubjectDN |
Example : |
string |
serverIssuerDN |
Example : |
string |
serverStart |
Example : |
string (date-time) |
serverExpire |
Example : |
string (date-time) |
4.239. SecureVolumeExternalKeyResponse
Name | Description | Schema |
---|---|---|
fileSize |
The size of the file |
string (int64) |
fileID |
The GUID for the file |
string |
fileURL |
The URL for the file |
string (uri) |
lockKeyId |
The id of the lock key. |
string |
4.240. EnableDisableEkmsRequest
This class describes the input for a Certificate Signing Request needed to create a client side certificate for External Key Manager integration
Name | Description | Schema |
---|---|---|
passPhrase |
The passPhrase for the security key that will be created |
string |
ekmsOption |
Indicates if EKMS should be enabled, disabled or the key should be changed |
enum (enable, disable, changeKey) |
4.241. FailureData
A failure currently active on the storage system
Name | Description | Schema |
---|---|---|
failureType |
The type of failure |
enum (unknownFailure, failedFan, failedPowerSupply, failedMinihub, failedEsm, batteryNearExpiration, failedBattery, nominalTempExceeded, maxTempExceeded, upsOnBattery, nonPreferredPath, memParityError, failedDriveScsiChannel, degradedVolume, failedVolumeInterruptedWrite, failedModifyingVolume, failedModifyingMultiRaid, failedVolume, failedVolumeMultiRaid, impairedVolume, failedVolumeAwaitingInit, volumeHotSpareInUse, offlineVolumeGroup, failedDrive, impendingDriveFailureRiskHigh, impendingDriveFailureRiskMed, impendingDriveFailureRiskLow, uncertifiedDrive, offlineCtl, passiveCtl, partitionsNotCompliant, esmCodeVersionMismatch, lostRedundancyDrive, lostRedundancyTray, lostRedundancyEsm, trayidMismatch, trayidConflict, failedTransceiverModule, channelMiswire, nonFruBatteryNearExpiration, nonFruFailedBattery, rpaErrCtl, repositoryOverThreshold, repositoryFull, snapshotFailed, unsupportedMinihub, esmMiswire, ghostVolume, snapshotNotCompliant, rvmNotCompliant, metadataOffline, mirrorDualPrimary, mirrorDualSecondary, mirrorUnsynchronized, remoteNoLun, remoteNoArray, remoteNoFabric, remoteWwnChangeFailed, fanUnknownStat, powerSupplyUnknownStat, esmUnknownStat, tempSensorUnknownStat, transModUnknownStat, driveBypassedSpeedMismatch, driveBypassedCauseUnknown, minihubSpeedMismatch, removedEsm, removedBattery, nonFruRemovedBattery, volcopyFailed, volcopyNotCompliant, channelDegraded, unsupportedTray, speedNegError, usmDatabaseFull, usmUnreadableSectorsExist, pathDegraded, netSetupError, mismatchedDriveType, ctlMismatch, failedDiscreteLine, channelFailed, linkSpeedDetectionMismatch, uncertifiedEsm, removedFan, removedPowerSupply, removedTempSensor, removedIccCru, removedSupportCru, failedIccCru, failedSupportCru, batteryUnknownStat, driveTraysNotGroupedTogether, goldKeyNotCompliant, mismatchedMdtSettings, mismatchedGoldKeySettings, ctlMiswire, supportCruNoinput, submodelNotSupported, submodelNotSet, submodelMismatch, failedBatterySystem, removedBatteryPack, batteryConfigMismatch, esmHardwareMismatch, hostBoardFault, ddcAvailable, replacedDriveWrongType, redundantPsRequired, driveTraysNotCompliant, sasDeviceLimitExceeded, sasPortMiswired, sasPortDegraded, sasPortFailed, corruptVpdEeprom, failedI2cBus, enclosureMisconfigured, featureBundleNotCompliant, driveBypassedSinglePort, esmFactoryDefaultsMismatch, hostBoardUnknownStat, failedHostIoCard, batteryWarn, volumeGroupPartiallyComplete, volumeGroupIncomplete, volumeGroupMissing, hotspareDriveMissing, driveIncompatibleUprevDacstore, driveIncompatibleDownrevDacstore, iccCruUnknownStat, removedAlarm, supportCruUnknownStat, performanceTierNotCompliant, raid6NotCompliant, driveIncompatibleSectorSize, foreignDriveInconsistent, foreignDriveRefersToNativeDrive, nativeVgRefersToForeignDrive, nativeVgForeignDriveMutualRef, vgCloned, foreignDriveHasInconsistentRole, vgDrivePartOfMultipleVgs, incompatibleFailedLegacyDrive, unsupportedCacheMemorySize, dedicatedMirrorChannelFailed, vgHasDrivePartOfMultipleVgs, ddfDriveOtherVendor, multipleConfigDatabasesDetected, adoptionFailedRaidLevelUnsupported, dbAdoptionHardLimitExceeded, legacyVgNotOptimal, cacheMemSizeMismatch, altCtlrBoardIdUnreadable, cacheBackupDeviceFailed, cacheBackupDeviceWriteProtected, cacheBackupDeviceInsufficientCapacity, expiredBattery, expiredIntegratedBattery, procMemTooSmallForCache, batteryOvertemp, invalidHostTypeIndex, insufficientProcMemory, ctlFailedCacheBackupDev, removedController, degradedHostIoCard, ldFwVersionMismatch, ldIncompatibleDatabase, hostBoardIdMismatch, iccMissing, linkSpeedMismatch, unsupportedHostBoard, writebackCachingDisabled, securityGetKey, securityKeyInconsistent, securityNotCompliant, mixedDriveEnclosureMiswire, unsuccessIsolationRedunMismatch, thresExcdedMismatchCorrected, inactiveHostPort, inactiveInitiator, protectionInformationNotCompliant, protectionInformationNotSupported, replacedInsufficientDriveCapacity, drawerFailed, drawerOpened, ssdNotCompliant, ssdAtEndOfLife, fibreTrunkMiswire, fibreTrunkIncompatibleEsm, driveSlotLimitNotCompliant, securityGetNewKey, externalKmsNotCompliant, sbbValidationFailure, invalidPowerSupply, enclosureThermalShutdown, wbCachingForciblyDisabled, driveUnsupportedProtocolConnection, failedTwiBus, mismatchedMidplaneEeproms, driveUnsupportedCapacity, evaluationLicenseExpirationImminent, externalKmsKeyInvalid, multipleMismatchedKeyIdsFound, securityKeyValidationLock, cacheDataLoss, baseControllerDiagFailed, featureNotCompliant, driveIncompatiblePiType, drawerDegraded, offlineCtlIocFail, invalidSataFlashConfiguration, iocDiagFail, sasPhyDisabledLocalWidePortDegraded, sasPhyDisabledSharedWidePortDegraded, drawerInvalid, drawerRemoved, driveUnsupportedInterposerFwVersion, redundancyGroupNotConsistentDuringReconfig, snapshotRollbackPaused, pitRollbackPaused, pitGroupRepositoryOverThreshold, pitViewRepositoryOverThreshold, pitGroupRepositoryFull, pitViewRepositoryFull, pitGroupFailed, pitViewFailed, pitPurged, arvmDegradedMirrorGroup, arvmFailedMirror, arvmSyncIntervalTimeOverThreshold, arvmRepositoryOverWarnThreshold, arvmMirrorGroupRoleConflict, incompatibleVolumeGroupSecurity, arvmOrphanGroup, arvmOrphanMember, arvmMirrorGroupRecoveryPointLost, diskPoolPartiallyPresent, diskPoolIncomplete, diskPoolMissing, diskPoolReconstructionDriveCountBelowThreshold, diskPoolUtilizationWarning, diskPoolUtilizationCritical, pendingPitCreationFailed, pendingCgpitCreationFailed, tpvRepositoryOverThreshold, tpvRepositoryFull, tpvFailed, arvmSecondaryRepositoryFull, arvmSyncInternallySuspended, databaseRecoveryMode, arvmPrimaryRepositoryFull, incompatibleSataDrive, diskPoolCapacityDepleted, driveIncompatibleModelNumberUnsupported, flashCacheNonOptimalDrives, flashCacheHotSpareInUse, allDrivesBypassedIncompatibleNvsram, diskPoolDriveFailure, diskPoolInsufficientMemory, arvmOrphanIncompleteMember, arvmSyncPausedAltState, arvmRoleChangePaused, driveIncompatibleAlignmentForEmulationDrive, lossOfExternalRedundancy, rvmWriteModeInconsistent, sasHostMiswire, sasCrossMiswire, sasLoopMiswire, copyThenFailWaitingOnHotSpare, missingDriveLockdown, hicConfigurationOoc, copyThenFailWaitingOnDdpCapacity, piErrorServiceMode, piErrorLockdown, sasPortDiscoveryError, netNtpResolutionFail, netNtpQueryFail, netNtpServiceUnavailable, multipathConfigurationError, hostRedundancyLost, excessiveRebootsDetected, cacheNotFlushedOnOnlyCtlr, securityAuditLogFull, securityAuditLogWarnThresh, directoryServicesConfigError, kmipServerCertificateNearingExpiration, kmipServerCertificateExpired, kmipServerDnsError, kmipServerCertificateError, kmipServerAuthenticationFailure, kmipServerConnectionFailure, kmipServerError, kmipServerKeyRequirementNotMet, ocspResponderUnreachable, certificateRevoked, ssdDataLoss, __UNDEFINED) |
objectRef |
The object that has the failure |
string |
objectType |
The type of object described in objectData |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
objectData |
The data for the object, equivalent to fetching the object via its URL |
|
extraData |
Supporting data used to debug the failure. This will vary by failureType |
4.242. Serializable
Type : object
4.243. FirmwareCompatibilityResponse
Name | Description | Schema |
---|---|---|
checkRunning |
True if the compatibility check is currently running |
boolean |
cancelled |
True if the check was cancelled by a user |
boolean |
lastStart |
The last time that a compatibility check was started, null if it has not been initiated yet |
string (date-time) |
inaccessibleStorageDevices |
The list of devices that could not be contacted |
< string > array |
results |
The list of results |
< FirmwareCompatibilitySet > array |
requestId |
The unique identifier for this request |
string (int64) |
failedStorageDevices |
The list of devices that the call failed on |
< string > array |
4.244. FirmwareCompatibilitySet
Name | Description | Schema |
---|---|---|
storageDeviceId |
Example : |
string |
storageDeviceWwn |
Example : |
string |
cfwFiles |
The list of compatible controller firmware files |
< CFWPackageMetadata > array |
nvsramFiles |
The list of compatible nvsram files |
< NvsramPackageMetadata > array |
4.245. NvsramPackageMetadata
Name | Description | Schema |
---|---|---|
version |
Example : |
string |
filename |
Example : |
string |
4.246. FirmwareCompatibilityRequest
Name | Description | Schema |
---|---|---|
storageDeviceIds |
List of storage devices to find compatible firmware for. |
< string > array |
releasedBuildsOnly |
Only consider released firmware builds as valid firmware files |
boolean |
4.247. FlashCacheBase
Name | Description | Schema |
---|---|---|
label |
The user-assigned label of the flash cache. |
string |
status |
The status of the flash cache. |
enum (unknown, optimal, degraded, failed, suspended, __UNDEFINED) |
configType |
The flash cache configuration type. |
enum (unknown, filesystem, database, multimedia, __UNDEFINED) |
analyticsStatus |
The flash cache analytics status. |
enum (unknown, stopped, started, __UNDEFINED) |
analyticsCause |
The flash cache analytics status cause. |
enum (none, userStopped, userFcChanges, internalCtlrRebooted, internalCfgChanges, __UNDEFINED) |
statusCause |
The flash cache status cause. |
enum (none, hotspareInuse, drivesInaccessible, cacheSizeMismatch, missingDrives, __UNDEFINED) |
4.248. FlashCacheDriveInfo
Name | Description | Schema |
---|---|---|
flashCacheType |
This enumeration identifies the type of flash cache. |
enum (unknown, readOnlyCache, writeCache, virtual, __UNDEFINED) |
fcWithDrives |
Test results are returned if the flashCacheType does not equal FC_TYPE_VIRTUAL. |
4.249. FlashCacheEx
Name | Description | Schema |
---|---|---|
wwn |
The WWN of the high level flash cache volume. |
string |
flashCacheRef |
A reference to the high level flash cache volume. |
string |
flashCacheBase |
Contains the base-level Flash Cache attributes pertaining to all types of Flash Caches. |
|
fcDriveInfo |
Drive information for the flash cache. |
|
cachedVolumes |
A list of references of volumes and thin volumes that are associated with this FlashCache |
< string > array |
driveRefs |
The list of drives associated with this FlashCache |
< string > array |
name |
Example : |
string |
id |
Example : |
string |
4.250. FlashCacheWithDrives
Name | Description | Schema |
---|---|---|
securityType |
The security type of the drives. |
enum (unknown, none, capable, enabled, __UNDEFINED) |
protectionInformationCapabilities |
The protection information capabilities of the drives. |
|
usedCapacity |
The used capacity of the drives (in bytes). |
string (int64) |
securityLevel |
Refines the information in the securityType field to describe the set of drives. |
enum (unknown, none, mixed, fde, fips, __UNDEFINED) |
4.251. FlashCacheCreateRequest
Name | Description | Schema |
---|---|---|
driveRefs |
A list of one or more drive refs belonging to SSD drives that will be utilized in the FlashCache |
< string > array |
name |
The user label for the FlashCache |
string |
enableExistingVolumes |
If true, all existing volumes that are mapped will have flash cache enabled |
boolean |
4.252. FlashCacheUpdateRequest
Name | Description | Schema |
---|---|---|
name |
The new name for the FlashCache |
string |
configType |
The usage configuration for the flashCache |
enum (unknown, filesystem, database, multimedia, __UNDEFINED) |
4.253. Folder
Folder used to represent storage system hierarchy.
Name | Description | Schema |
---|---|---|
folderId |
Example : |
string |
parentFolderId |
Example : |
string |
name |
Example : |
string |
reserved |
Example : |
boolean |
rules |
Rules for dynamic folders |
< Rule > array |
storageSystemIds |
List of arrays for non-dynamic folders |
< string > array |
4.254. Rule
Object containing a Key/Value pair along with a Type to be used to store data for a storage system.
Name | Description | Schema |
---|---|---|
ruleType |
Example : |
string |
key |
Example : |
string |
value |
Example : |
string |
4.255. FolderUpdateRequest
Used to update a folder
Name | Description | Schema |
---|---|---|
parentId |
Optional Parent folder Id for nested folders. |
string |
name |
Name of the folder |
string |
rules |
Optional List of rules used to define the folder. These rules are ANDed together Usually either rules OR a list of Ids are supplied. <br>This must be a complete list |
< Rule > array |
storageSystemIds |
Option list of storage system to include in the folder. Usually either rules OR a list of Ids are supplied. <br>This must be a complete list |
< string > array |
4.256. FolderCreateRequest
Used to create a folder
Name | Description | Schema |
---|---|---|
parentId |
Optional Parent folder Id for nested folders. |
string |
name |
Name of the folder |
string |
rules |
Optional List of rules used to define the folder. These rules are ANDed together Usually either rules OR a list of Ids are supplied. |
< Rule > array |
storageSystemIds |
Optional list of storage system to include in the folder. Usually either rules OR a list of Ids are supplied. |
< string > array |
4.257. BatteryEx
Name | Description | Schema |
---|---|---|
batteryRef |
The reference for this battery. |
string |
status |
The operational status of the battery. |
enum (optimal, fullCharging, nearExpiration, failed, removed, unknown, notInConfig, configMismatch, learning, overtemp, expired, maintenanceCharging, replacementRequired, __UNDEFINED) |
physicalLocation |
The physical location of the battery. The parent reference in Location identifies the CRU that physically houses the battery, and the position field is the parent-relative/like-component relative slot number of the battery, starting at one. |
|
batteryAge |
Current battery age, in days. |
integer (int32) |
batteryLifeRemaining |
Days of battery life remaining. A value of -1 indicates that the battery life expiration age has been set to 0xFF in NVSRAM, disabling cache battery expiration event notification. |
integer (int32) |
batteryTypeData |
Used to determine the scope of the battery. |
|
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
manufacturerDate |
VPD manufacture date. |
string (int64) |
vendorName |
VPD vendor name. |
string |
vendorPN |
VPD part number. |
string |
vendorSN |
VPD serial number. |
string |
fruType |
VPD field replaceable unit type. |
string |
rtrAttributes |
The CRU type of the battery plus its ready-to-remove attributes, which are based on the CRU type. |
|
repairPolicy |
The repair policy for the battery component. |
|
batteryCanExpire |
This boolean field is set to true when cache battery expired event notification is enabled. |
boolean |
automaticAgeReset |
This boolean field is set to true when the batteryCanExpire field in this structure is set to false and when the controller tracks the battery serial number. |
boolean |
learnCycleData |
Contains details about the learn cycle for this battery |
|
smartBatteryData |
Example : |
|
id |
Example : |
string |
4.258. BatteryTypeData
Name | Description | Schema |
---|---|---|
batteryType |
This enumeration object is used to specify the battery configurations present on a controller. |
enum (singleSharedCru, dualIndividualFrus, dualSharedCrus, dualIndividualCrus, __UNDEFINED) |
cruParentController |
This field is present only if the batteryType value is equal to BATTERY_TYPE_DUAL_INDIVIDUAL_CRUS. It is a reference to the controller that the battery CRU is associated with. |
string |
parentController |
This field is present only if the batteryType value is equal to BATTERY_TYPE_DUAL_INDIVIDUAL_FRUS. It is a reference to the the controller that the battery FRU is associated with. |
string |
4.259. CacheBackupDevice
Name | Description | Schema |
---|---|---|
backupDeviceRef |
The SYMbol reference that identifies the instance of the device |
string |
backupDeviceControllerSlot |
The number of the slot on the controller where the backup device resides. Cache backup device slots are numbered starting at one, independent of other types of slots (e.g., host board slots) on the controller. Note that this field is targeted for deletion in SYMbol rev. 85b. |
integer (int32) |
parentController |
A reference to the controller where the backup device resides. Note that this field is targeted for deletion in SYMbol rev. 85b. |
string |
backupDeviceType |
The type of the backup device ( e.g., USB flash drive). |
enum (unknown, usbFlash, sdFlash, sataFlash, __UNDEFINED) |
backupDeviceStatus |
The status of the backup device |
enum (unknown, optimal, failed, removed, writeProtected, incompatible, __UNDEFINED) |
backupDeviceVpd |
Vital product data for the backup device. |
|
backupDeviceCapacity |
The capacity of backup device, expressed in megabytes. |
integer (int32) |
repairPolicy |
The repair policy for the cache backup device component. |
|
physicalLocation |
The physical location of the cache backup device. The parent field of Location is set to the controller where the device physically resides, and the position field is the parent-relative/like-component-relative slot number of the device, starting at one. |
|
id |
Example : |
string |
4.260. CacheBackupDeviceVpd
Name | Description | Schema |
---|---|---|
manufacturer |
The variable-length ASCII text string that identifies the device manufacturer.. |
string |
manufactureDate |
The date of manufacture of the device, represented in seconds since midnight GMT on January 1, 1970. |
string (int64) |
productId |
The variable-length ASCII text string that identifies the device by name. |
string |
productRevLevel |
The variable-length ASCII text string that identifies the device revision level. |
string |
partNumber |
The variable-length ASCII text string that identifies the device part number. |
string |
serialNumber |
The variable-length ASCII text string that identifies the device serial number. |
string |
4.261. CacheMemoryDimm
Name | Description | Schema |
---|---|---|
cacheMemoryDimmRef |
The SYMbol reference value that uniquely identifies an instance of a cache memory DIMM object. |
string |
status |
The operational status of the DIMM. |
enum (unknown, optimal, empty, failed, __UNDEFINED) |
capacityInMegabytes |
The capacity of the DIMM expressed in megabytes. |
integer (int32) |
serialNumber |
The serial number of the DIMM. |
string |
partNumber |
The LSI Logic part number of the DIMM. |
string |
oemPartNumber |
The OEM part number of the DIMM. |
string |
manufacturerPartNumber |
The manufacturer part number of the DIMM. |
string |
manufacturer |
The manufacturer part number of the DIMM. |
string |
manufactureDate |
The manufacture date of the DIMM |
string (int64) |
repairPolicy |
The repair policy for the cache memory DIMM component. |
|
physicalLocation |
The physical location of the cache memory DIMM. The parent reference in Location identifies the controller where the DIMM physically resides, and the position field is the parent-relative/like-component relative slot number of the DIMM, starting at 1. |
|
shared |
This field is set to true if the DIMM is shared between processor and cache. It is set to false if the DIMM is dedicated to the cache. |
boolean |
revisionCode |
The module revision code of the DIMM. |
string |
4.262. ChannelPort
Name | Description | Schema |
---|---|---|
portRef |
A reference to this channel port. |
string |
portParent |
The parent of the channel port object (minihub, controller, or ESM). |
|
portNumber |
The identifying number assigned to this channel port. The range for port numbers is 1..n. If the port number cannot be determined, this field is set to zero. |
integer (int32) |
channel |
The number of the associated channel. |
integer (int32) |
channelType |
The type of the associated channel - either host-side or drive-side. |
enum (hostside, driveside, management, __UNDEFINED) |
physicalLocation |
The physical location of the channel port. The parent reference in Location identifies the physical CRU where the port is located, and the position field is the parent-relative/like-port relative number of the port, starting at 1. |
|
isTrunkActive |
This field is true if a trunk connection has been established and is being maintained on this controller or ESM channel port. This field is always false if the channel port is on a controller or ESM that does not have a Fibre Channel I/O interface type, or if the channel port is associated with a host-side channel. |
boolean |
id |
Example : |
string |
4.263. ChannelPortParent
Name | Description | Schema |
---|---|---|
type |
This enumeration object is used to specify the type of channel port parent. |
enum (unknown, esm, minihub, controller, hic, __UNDEFINED) |
controllerRef |
This field is present only if the type field is equal to CHANNEL_PORT_PARENT_CONTROLLER. |
string |
esmRef |
This field is present only if the type field is equal to CHANNEL_PORT_PARENT_ESM. |
string |
minihubRef |
This field is present only if the type field is equal to CHANNEL_PORT_PARENT_MINIHUB. |
string |
hicRef |
This field is present only if the type field is equal to CHANNEL_PORT_PARENT_HIC. |
string |
4.264. CommandProtocolProperties
Name | Description | Schema |
---|---|---|
commandProtocol |
This enumeration describes the command protocol (e.g. SCSI vs. NVMe). |
enum (unknown, scsi, nvme, __UNDEFINED) |
nvmeProperties |
This field describes the NVMe command protocol properties. |
4.265. ControllerSFP
Name | Description | Schema |
---|---|---|
controllerSFPType |
The interface (host/drive) to which the SFP belongs. |
enum (hostside, driveside, __UNDEFINED) |
parentController |
The controller to which the SFP belongs. |
string |
channel |
The channel the SFP is associated with. |
integer (int32) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
4.266. Drawer
Name | Description | Schema |
---|---|---|
drawerRef |
The component reference associated with the drawer. |
string |
isOpen |
This value is set to true when the drawer is open; otherwise it is set to false. |
boolean |
status |
This field contains the drawer status. |
enum (unknown, optimal, failed, opened, removed, degraded, invalid, __UNDEFINED) |
physicalLocation |
This field contains the drawer location. This will be a tray reference to the tray containing the drawer. |
|
repairPolicy |
This field contains the repair policy for the drawer component. |
|
softwareVersion |
This data is a variable length ASCII text string. It contains the firmware version for the DCM (Drawer Control and Monitor) chip on the drawer component. |
string |
partNumber |
This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) chip part number on the drawer component. This part number is from VPD data. |
string |
serialNumber |
This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) chip serial number on the drawer component. This serial number is from VPD data. |
string |
vendorName |
This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) chip manufacturer name, obtained from VPD data. |
string |
manufactureDate |
This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) manufacture date, obtained from VPD data. |
string (int64) |
fruType |
This data is a variable length ASCII text string. It contains the Field Replaceable Unit (FRU) type, obtained from VPD data. |
string |
drawerType |
This data is a variable length ASCII text string describing the type of drawer. |
string |
id |
Example : |
string |
4.267. DriveLayout
Name | Description | Schema |
---|---|---|
driveOrientation |
The drive orientation in the drawer or tray. |
enum (none, horizontal, vertical, __UNDEFINED) |
numRows |
The number of rows in the drive layout. If driveOrientation field is set to "None", the value of this field should be zero. |
integer (int32) |
numColumns |
The number of columns in the drive layout. If driveOrientation field is set to "None", the value of this field should be zero. |
integer (int32) |
primaryTraversal |
The primary traversal method for the drawer or tray. If driveOrientation field is set to "None", the value of this field should be TRAVERSAL_NONE |
enum (none, leftToRight, rightToLeft, topToBottom, frontToBack, __UNDEFINED) |
secondaryTraversal |
The secondary traversal method for the drawer or tray. If driveOrientation field is set to "None", the value of this field should be TRAVERSAL_NONE |
enum (none, leftToRight, rightToLeft, topToBottom, frontToBack, __UNDEFINED) |
4.268. ESMInterfaceTypeData
Name | Description | Schema |
---|---|---|
ioInterfaceType |
This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
portList |
A list of detailed information for each port. |
4.269. Esm
Name | Description | Schema |
---|---|---|
esmRef |
The reference for this physical ESM. |
string |
status |
The operational status for this ESM. |
enum (optimal, failed, removed, unknown, unsupported, uncertified, __UNDEFINED) |
physicalLocation |
The physical location of the ESM. The parent reference in Location identifies the tray containing the ESM, and the position field is the parent-relative/like-component relative slot number of the ESM, starting at 1. |
|
nonRedundantAccess |
True if the ESM does not have redundant access. |
boolean |
partNumber |
The part number of the ESM. |
string |
serialNumber |
The serial number of the ESM. |
string |
manufacturerDate |
The date the ESM was manufactured. |
string (int64) |
manufacturer |
The date the ESM was manufactured. |
string |
fruType |
The field replaceable unit type of the ESM. |
string |
softwareVersion |
The firmware version of the ESM. |
string |
esmInterfaceData |
The interface type information for the ESM. This field is now deprecated. The field esmInterfaceAttributes should be used instead. |
|
productID |
The product identifier of the ESM. |
string |
workingChannel |
The channel to the tray that is still operational (if nonRedundantAccess is True). |
integer (int32) |
currentSpeed |
The current speed of the ESM. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maxSpeed |
The maximum speed of the ESM. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
fibreEsm |
The Fibre Channel information for the ESM. This field is deprecated. The field fibreEsmAddress located within esmInterfaceAttributes should be used instead. |
|
rtrAttributes |
The CRU type of the ESM plus its ready-to-remove attributes, which are based on the CRU type. |
|
esmInterfaceAttributes |
Attributes that are specific to the ESM’s I/O interface type. |
|
boardId |
The board ID of the ESM card. |
string |
factoryDefaultsData |
This field contains information about the version of the ESM’s factory default settings. |
|
repairPolicy |
The repair policy for the ESM component. |
|
isTrunkCapable |
True when ESM is trunk capable. |
boolean |
trunkMiswire |
True only when ESM is trunk capable and cabled incorrectly, or not trunk capable but connected in trunk mode. |
boolean |
locateInProgress |
Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the device. |
boolean |
hasTrayIdentityIndicator |
The device contains 7-segment indicators used to display the Tray Identity. |
boolean |
esmType |
Type of ESM or IOM. |
enum (unidentified, badger, devil, cyclone, polecat, otter, __UNDEFINED) |
id |
Example : |
string |
4.270. EsmFactoryDefaultsVersionData
Name | Description | Schema |
---|---|---|
isSupported |
This field is set to true if the ESM supports version reporting and downloading of factory default settings, and false otherwise. A setting of false in this field can mean either (1) the ESM is a legacy ESM for which the version-reporting feature is unavailable or (2) the ESM is capable of supporting version-reporting, but is not running the correct firmware version to do so. |
boolean |
factoryDefaultsVersion |
The factory default version string. The format of the string is: |
string |
4.271. EsmInterfaceAttributes
Name | Description | Schema |
---|---|---|
ioInterfaceType |
This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
fibreEsmAttributes |
This field is only present if the ioInterfaceType value is IO_IF_FC. It contains attributes that are specific to fibre channel ESMs. |
|
sasEsmAttributes |
This field is only present if the ioInterfaceType value is IO_IF_SAS. It contains attributes that are specific serial-attached SCSI ESMs. |
4.272. EthernetInterfacePort
Name | Description | Schema |
---|---|---|
interfaceRef |
The opaque data by which an instance of EthernetIoInterface is uniquely identified. |
string |
physicalLocation |
The physical location of the Ethernet interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Ethernet interface relative to the parent," "2nd Ethernet interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
channel |
The number of the channel controlled by this interface. |
integer (int32) |
channelPortRef |
A reference to the channel port object associated with the channel controlled by this interface. |
string |
interfaceData |
Information about the physical interface (e.g., Ethernet). |
|
protectionInformationCapable |
This field indicates whether or not the I/O interface is PI capable. |
boolean |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
controllerId |
The controller id. |
string |
commandProtocolProperties |
List of properties that describe the command protocol. |
< CommandProtocolProperties > array |
interfaceId |
Example : |
string |
niceAddressId |
Example : |
string |
addressId |
Example : |
string |
id |
Example : |
string |
4.273. FactoryDefaultsVersionData
Name | Description | Schema |
---|---|---|
factoryDefaultsVersion |
The factory default version string |
string |
isSupported |
This field is set to true when version reporting is supported and factory default settings may be downloaded; otherwise it is set to false. |
boolean |
4.274. Fan
Name | Description | Schema |
---|---|---|
fanRef |
The reference for this physical fan. |
string |
status |
The operational status of the fan |
enum (optimal, failed, removed, unknown, __UNDEFINED) |
physicalLocation |
The physical location of the fan. The parent reference in Location identifies the CRU that houses the fan, and the position field is a firmware-assigned 1-relative number signifying "1st fan relative to parent CRU," 2nd fan relative to parent CRU." etc. |
|
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
rtrAttributes |
The CRU type of the fan plus its ready-to-remove attributes, which are based on the CRU type. |
|
repairPolicy |
The repair policy for the fan component. |
|
id |
Example : |
string |
4.275. FibreESMAddress
Name | Description | Schema |
---|---|---|
esmPortRef |
The esmPortRef identifies the drive port. |
string |
loopID |
The loop ID of the ESM. |
integer (int32) |
portRef |
A reference to the controller drive side channel port associated with this ESM. |
string |
4.276. FibreEsmAttributes
Name | Description | Schema |
---|---|---|
isSwitched |
True if the fibre channel components use switched technology. |
boolean |
fibreEsmAddress |
Addressing information for the fibre channel ESM. |
4.277. FibreInterfacePort
Name | Description | Schema |
---|---|---|
channel |
The channel number of this interface. |
integer (int32) |
loopID |
The FC loop ID value used by the controller on this channel. |
integer (int32) |
speed |
The speed of the interface in MB/sec. This field is deprecated. The field currentInterfaceSpeed should be used instead. |
integer (int32) |
hardAddress |
The hard (preferred) address of the interface, in loop ID format. |
integer (int32) |
nodeName |
The unique identifier of the storage array node associated with this interface. |
string |
portName |
The unique identifier of the Fibre Channel port associated with this interface. |
string |
portId |
The NL_Port identifier assigned to this interface. |
string |
topology |
The Fibre Channel topology type being used. |
enum (unknown, ptp, fabric, arbLoop, fabLoop, __UNDEFINED) |
part |
An ASCII text string that describes the Fibre Channel controller chip type. |
string |
revision |
The revision level of the Fibre Channel controller chip. |
integer (int32) |
chanMiswire |
True, if this channel is joined with another one. |
boolean |
esmMiswire |
True, if an ESM miswire condition exists somewhere on this channel. |
boolean |
linkStatus |
The status of the fibre channel link for this interface. |
enum (none, up, down, failed, __UNDEFINED) |
isDegraded |
True if the channel associated with this interface is degraded. |
boolean |
speedControl |
The speed of the interface in MB per sec. This field is deprecated. The fieldcurrentInterfaceSpeed should be used instead. |
enum (unknown, fixed, switched, auto, __UNDEFINED) |
maxSpeed |
The maximum speed in MB/s the interface can run. This field is deprecated. The field maximumInterfaceSpeed should be used instead. |
integer (int32) |
speedNegError |
True if speed negotiation could not complete. |
boolean |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
ddsChannelState |
The DDS state of this drive side channel: optimal, degraded, or failed. |
integer (int32) |
ddsStateReason |
DDS state reason. |
integer (int32) |
ddsStateWho |
Which controller placed the drive side channel in this DDS state. |
integer (int32) |
isLocal |
Set to True if there are channel ports physically attached to this controller. |
boolean |
channelPorts |
Channel port speed information. This field is deprecated. The same information is available in the LinkSpeedDetectionError structure. |
< ChannelPorts > array |
currentInterfaceSpeed |
The current interface speed of the Fibre Channel interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maximumInterfaceSpeed |
The maximum interface speed of the Fibre Channel interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
interfaceRef |
The unique identifier for a given instance of this structure. |
string |
physicalLocation |
The physical location of the Fibre Channel interface. The parent reference in location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Fibre Channel interface relative to the parent," "2nd Fibre Channel interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
isTrunkCapable |
This field is true if the Fibre interface on the controller board is trunk capable. This field is always false for host-side interfaces. |
boolean |
trunkMiswire |
True only when ESM is trunk capable and cabled incorrectly, or not trunk capable but connected in trunk mode. |
boolean |
protectionInformationCapable |
Example : |
boolean |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
controllerId |
Example : |
string |
interfaceId |
Example : |
string |
niceAddressId |
Example : |
string |
addressId |
Example : |
string |
id |
Example : |
string |
4.278. HardwareInventoryResponse
Provides summary information for the physical components of the storage system.
Name | Description | Schema |
---|---|---|
drives |
A list of the disk drives in the storage system. |
< DriveEx > array |
ibPorts |
IB Ports |
< IBInterfacePort > array |
iscsiPorts |
ISCSI Port |
< IScsiInterfacePort > array |
fibrePorts |
Fibre Ports |
< FibreInterfacePort > array |
sasPorts |
SAS Ports |
< SasInterfacePort > array |
ethernetPorts |
The Ethernet ports |
< EthernetInterfacePort > array |
sasExpanders |
SAS Expanders |
< SasExpander > array |
channelPorts |
Channel Ports |
< ChannelPort > array |
trays |
A list of the disk trays in the storage system. |
< TrayEx > array |
drawers |
A list of the disk drawers |
< Drawer > array |
controllers |
A list of the controllers in the storage system. |
< Controller > array |
batteries |
A list of the batteries in the storage system. |
< BatteryEx > array |
fans |
A list of the fans in the storage system. |
< Fan > array |
hostBoards |
A list of the host interface cards in the storage system. |
< HostBoard > array |
powerSupplies |
A list of the power supplies in the storage system. |
< PowerSupply > array |
nvsramVersion |
The version of NVSRAM settings installed on the storage system. |
string |
cacheMemoryDimms |
The list of processor memory DIMMs installed on the storage system. |
< CacheMemoryDimm > array |
cacheBackupDevices |
The list of cache backup modules installed on the storage system. |
< CacheBackupDevice > array |
supportCRUs |
A list of the support CRUs in the storage system. |
< SupportCRU > array |
esms |
A list of the ESMs in the storage system. |
< Esm > array |
sfps |
A list of the SFPs in the storage system. |
< Sfp > array |
thermalSensors |
A list of the thermal sensors in the storage system. |
< ThermalSensor > array |
4.279. HostBoard
Name | Description | Schema |
---|---|---|
parentController |
The controller associated with the host board. |
string |
partNumber |
The host board’s part number, from VPD. |
string |
serialNumber |
The host board’s serial number, from VPD. |
string |
vendorName |
The host board’s vendor name, from VPD. |
string |
manufacturerDate |
The host board’s date of manufacture, from VPD. |
string (int64) |
fruType |
The field replaceable unit type string, from VPD. |
string |
hostBoardId |
The board ID of the controller’s host card. |
string |
status |
The host board’s status. |
enum (unknown, optimal, needsAttention, notPresent, degraded, failed, diagInProgress, __UNDEFINED) |
type |
The host board’s type. |
enum (typeUnknown, type4portFc, type20portSwitchedFc, type1portSas, type2portFc, type2portIscsi, type2portSas, type2portIb, type8portFc, type4portIscsi, type4portSas, type4portSasGlacier, type2portFcIscsiSamoa, type4portFcIscsiSamoa, type2portIscsiZion, type2portSasAcadia, type4portSasAcadia, type2portIbDenali, type2portFcSamoa, type4portFcSamoa, type2portIscsiSamoa, type4portIscsiSamoa, type4portSas3, type2portIb100gb, type4portEthernet25gb, type4portFc32gb, type2portEth100gb, __UNDEFINED) |
hostBoardRef |
The reference for this physical host board. |
string |
numberOfPorts |
The number of ports provided by the host board. |
integer (int32) |
hbTypeData |
Data that is specific to the type of host board. |
|
oemPartNumber |
The OEM part number of the host board. |
string |
hostBoardControllerSlot |
The number of the slot on the controller where the host board resides. Host board slots are numbered starting at one, independent of other types of slots (e.g., cache backup device slots) on the controller. |
integer (int32) |
repairPolicy |
The repair policy for the host board component. |
|
physicalLocation |
The physical location of the host board. The parent reference in Location identifies the controller where the host board is physically located, and the position field is the parent-relative/like-component relative slot number of the host card, starting at 1. |
|
id |
Example : |
string |
4.280. HostBoard2PortIbTypeData
Name | Description | Schema |
---|---|---|
tcaGuid |
The globally unique identifier (GUID) assigned to the host board. |
string |
queuePairsSupported |
The number of queue pairs supported by the host board. |
integer (int32) |
completionQueuesSupported |
The number of completion queues supported by the host board. |
integer (int32) |
sharedReceiveQueuesSupported |
The number of shared receive queues supported by the host board. |
integer (int32) |
4.281. HostBoardTypeData
Name | Description | Schema |
---|---|---|
type |
This enumeration object is used to indicate the type of a controller’s host board. |
enum (typeUnknown, type4portFc, type20portSwitchedFc, type1portSas, type2portFc, type2portIscsi, type2portSas, type2portIb, type8portFc, type4portIscsi, type4portSas, type4portSasGlacier, type2portFcIscsiSamoa, type4portFcIscsiSamoa, type2portIscsiZion, type2portSasAcadia, type4portSasAcadia, type2portIbDenali, type2portFcSamoa, type4portFcSamoa, type2portIscsiSamoa, type4portIscsiSamoa, type4portSas3, type2portIb100gb, type4portEthernet25gb, type4portFc32gb, type2portEth100gb, __UNDEFINED) |
dualPortIbTypeData |
Host board data for two-port InfiniBand host board. This field is only present if type is equal to HB_TYPE_2PORT_IB. |
|
dualPortDenaliIbTypeData |
If the host board type is denali with two port infiniband, return the two port ib type data struct. |
4.282. IBInterfacePort
Name | Description | Schema |
---|---|---|
interfaceRef |
The opaque data by which an instance of IbInterface is uniquely identified. |
string |
channel |
The number of the host channel associated with this interface. |
integer (int32) |
channelPortRef |
A reference to the channel port for the channel associated with this interface. |
string |
localIdentifier |
The InfiniBand local identifier associated with this interface. |
integer (int32) |
globalIdentifier |
The InfiniBand global identifier associated with this interface. |
string |
linkState |
The state of the InfiniBand link. |
enum (initialize, linkArm, active, defer, down, __UNDEFINED) |
portState |
The state of the InfiniBand port. |
enum (unknown, initialize, arm, active, defer, down, __UNDEFINED) |
maximumTransmissionUnit |
The size in bytes of the largest packet that the interface can transmit. |
integer (int32) |
currentSpeed |
The speed at which the interface is currently operating. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
supportedSpeed |
An array containing the different speeds at which the interface is capable of operating. |
< enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) > array |
currentLinkWidth |
The width at which the link is currently operating, e.g., 1 means "1X," 4 means "4X,".etc. |
enum (width1x, width4x, width8x, width12x, __UNDEFINED) |
supportedLinkWidth |
An array containing the different link widths at which the link is capable of operating. |
< enum (width1x, width4x, width8x, width12x, __UNDEFINED) > array |
currentDataVirtualLanes |
The number of data virtual lanes that are currently active for this interface. |
integer (int32) |
maximumDataVirtualLanes |
The maximum number of data virtual lanes supported by the interface. |
integer (int32) |
physicalLocation |
The physical location of the Infiniband interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st Infiniband interface relative to the parent," "2nd Infiniband interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
protectionInformationCapable |
This field indicates whether or not the I/O interface is PI capable. |
boolean |
isSRPSupported |
This flag is true if SRP (SCSI RDMA Protocol) is currently supported. |
boolean |
isISERSupported |
This flag is true if iSER (iSCSI Extensions for RDMA) is currently supported. |
boolean |
physPortState |
This element contains the current state of the physical Infiniband port. |
enum (unknown, sleep, polling, disabled, cfgTrain, linkUp, linkErrRec, phyTest, __UNDEFINED) |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
isNVMeSupported |
Indicates if the interface is configured to support NVMe over Fabrics protocol |
boolean |
controllerId |
Example : |
string |
commandProtocolProperties |
List of properties that describe the command protocol. |
< CommandProtocolProperties > array |
interfaceId |
Example : |
string |
niceAddressId |
Example : |
string |
addressId |
Example : |
string |
id |
Example : |
string |
4.283. IScsiInterfacePort
Name | Description | Schema |
---|---|---|
channel |
The number of the channel controlled by this interface. |
integer (int32) |
channelPortRef |
A reference to the channel port object associated with the channel controlled by this interface. |
string |
tcpListenPort |
The number of the TCP port on which the target listens for incoming connections. |
integer (int32) |
ipv4Enabled |
True if IPV4 is enabled for this interface; always true for iSER interface. |
boolean |
ipv4Data |
IPV4-related information for the interface. |
|
interfaceData |
Information about the physical interface (e.g., Ethernet). |
|
interfaceRef |
The unique identifier for a given instance of this structure. |
string |
ipv6Enabled |
True if IPV6 is enabled for this interface; otherwise false. |
boolean |
ipv6Data |
IPV6-related information for the interface. |
|
physicalLocation |
The physical location of the iSCSI interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st iSCSI interface relative to the parent," "2nd iSCSI interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
protectionInformationCapable |
This field indicates whether or not the I/O interface is PI capable. |
boolean |
isIPv6Capable |
This flag is true if the interface is capable of IPv6 functionality. |
boolean |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
iqn |
Example : |
string |
controllerId |
Example : |
string |
interfaceId |
Example : |
string |
niceAddressId |
Example : |
string |
addressId |
Example : |
string |
id |
Example : |
string |
4.284. IpVxAddressData
Name | Description | Schema |
---|---|---|
addressType |
This enumeration defines the different types of IP addresses, corresponding to different versions of the Internet protocol. |
enum (ipv4, ipv6, __UNDEFINED) |
ipv4Data |
Contains the various IPV4 address elements. |
|
ipv6Data |
contains the various IPV6 address elements. |
4.285. NVMeCommandProtocolProperties
Name | Description | Schema |
---|---|---|
commandSet |
This enumeration describes the command set type (e.g. to descriminate between the NVMe and NVMe over Fabrics command sets). |
enum (unknown, nvme, nvmeof, __UNDEFINED) |
nvmeofProperties |
This describes the NVMe over Fabrics protocol properties. |
4.286. NVMeoFInfinibandProperties
Name | Description | Schema |
---|---|---|
ipAddressData |
The IP address data associated with the NVMe over Fabrics over Infiniband transport. |
|
listeningPort |
The listening port associated with the NVMe over Fabrics over Infiniband transport. |
integer (int32) |
4.287. NVMeoFProtocolProperties
Name | Description | Schema |
---|---|---|
provider |
This enumeration is used to identify the provider (i.e. intermediate transport protocol) of the RDMA transport. |
enum (providerUnknown, providerUnspecified, providerInfiniband, providerRoce, providerRocev2, providerIwarp, noneFc, providerCouplingDriver, __UNDEFINED) |
ibProperties |
This defines the protocol properties for NVMe over IB. |
|
roceV2Properties |
This defines the the protocol properties for ROCEv2 NVMe-oF Interfaces |
4.288. NVMeoFRoceV2Properties
Name | Description | Schema |
---|---|---|
ipv4Enabled |
Indicates whether IPV4 addressing should be enabled for this interface. |
boolean |
ipv6Enabled |
Indicates whether IPV6 addressing should be enabled for this interface. |
boolean |
ipv4Data |
IPV4-related information for the interface |
|
ipv6Data |
IPV6-related information for the interface. |
|
listeningPort |
The port on which the target listens for incoming connections. |
integer (int32) |
4.289. Port
Name | Description | Schema |
---|---|---|
portStatus |
An indication of the status of the fibre channel port. |
enum (bypassed, notBypassed, __UNDEFINED) |
portType |
An indication of the type of fibre channel port. |
enum (gbic, db9, sfp, __UNDEFINED) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
4.290. PortList
Name | Description | Schema |
---|---|---|
ports |
A variable-length array of Port objects. |
< Port > array |
4.291. PowerSupply
Name | Description | Schema |
---|---|---|
powerSupplyRef |
The physical location of the power supply. The parent reference in Location identifies the tray or CRU that physically houses the power supply, and the position field is the parent-relative/like-component relative number of the power supply, starting at one. |
string |
status |
The operation status of the power supply. |
enum (optimal, failed, removed, unknown, noinput, __UNDEFINED) |
physicalLocation |
The physical location of the power supply. Note that the tray reference identifies the enclosure containing the power supply. For non-XBB controller enclosures, the slot information does not apply. For XBB controller enclosures, the slot information is an ordinal identifier (a value of 1 means the first (left) power supply and a value of 2 means the second (right) power supply). |
|
partNumber |
The part number of the power supply from VPD data. |
string |
serialNumber |
The serial number of the power supply. |
string |
vendorName |
The name of the manufacturer of the power supply. |
string |
manufacturerDate |
The date the power supply was manufactured. |
string (int64) |
fruType |
The field replaceable unit type of the power supply. |
string |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
rtrAttributes |
The CRU type of the power supply plus its ready-to-remove attributes, which are based on the CRU type |
|
repairPolicy |
The repair policy for the power supply component. |
|
firmwareRevision |
An ASCII character string that identifies the version of the firmware. |
string |
manufacturingDeviceCode |
An integer value that specifies the Manufacturing Device Code. |
integer (int32) |
id |
Example : |
string |
4.292. SFPParentTypeData
Name | Description | Schema |
---|---|---|
sfpParentType |
This enumeration object is used to describe the parent type of a SFP. |
enum (unknown, esm, minihub, controller, __UNDEFINED) |
controllerSFP |
This field is present only if the sfpParentType is equal to SFP_PARENT_TYPE_CONTROLLER. It contains the parent type of a SFP. |
|
parentEsm |
No information is returned |
string |
parentMinihub |
This field is present only if the sfpParentType is equal to SFP_PARENT_TYPE_MINIHUB. It contains the parent type of a SFP. |
string |
4.293. SFPType
Name | Description | Schema |
---|---|---|
sfpIdentType |
Information about the SFP type. |
enum (unknown, gbic, soldered, sfp, __UNDEFINED) |
sfpConnectType |
Information about the SFP connector type. |
enum (unknown, sc, fcs1cc, fcs2cc, bncortnc, fcCoax, fJack, lc, mtRj, mu, sg, optPigtail, hssdcii, copPigtail, rj45, noSeparableConnector, __UNDEFINED) |
sfpLinkLType |
Information about the SFP link length. |
enum (typeUnknown, typeVlong, typeShort, typeIntermediate, typeLong, typeMedium, typeNa, __UNDEFINED) |
sfpTransmitterType |
Information about the SFP transmitter type. |
enum (unknown, lwlLc, eiee, eiae, swlwoofc, swlwofc, lwlLl, na, __UNDEFINED) |
sfpSpeed |
Information about the SFP speed. |
< enum (typeUnknown, type1gig, type2gig, type4gig, type8gig, type16gig, type10gig, type40gig, type56gig, type20gig, type25gig, type32gig, type100gig, type50gig, __UNDEFINED) > array |
sfpTransmissionMedia |
Information about the SFP transmission media. |
< enum (unknown, twinAxialPair, tmShieldedTwistedPair, tmMiniatureCoax, tmVideoCoax, tmMultiModeM6, tmMultiModeM5, tmSingleMode, na, __UNDEFINED) > array |
manufacturerDate |
The date when the SFP was manufactured. |
string (int64) |
vendorName |
The vendor name of the SFP. |
string |
vendorPN |
The vendor part name of the SFP. |
string |
vendorRev |
The vendor revision of the SFP |
string |
vendorSN |
The vendor serial number of the SFP. |
string |
vendorOUI |
The vendor unique OUI field of the SFP. |
string |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
4.294. SasEsmAttributes
Name | Description | Schema |
---|---|---|
sasExpander |
This field is a collection of references to objects representing the SAS expanders that physically reside on the ESM. |
< string > array |
4.295. SasExpander
Name | Description | Schema |
---|---|---|
expanderRef |
The reference value that uniquely identifies the SAS expander. |
string |
parent |
The reference value that uniquely identifies the parent (controller or ESM) of the SAS expander. |
|
channel |
The drive channel location of the expander |
integer (int32) |
deviceName |
The SAS address that is the expander device name |
string |
vendorId |
The Inquiry vendor identification string for the SAS expander. |
string |
productId |
The Inquiry product identification string for the SAS expander. |
string |
fwVersion |
The version of the firmware on the SAS expander. |
string |
expanderPorts |
List of ports that are part of this expander. |
< SasPort > array |
domainNumber |
The domain number identifies which SAS domain this element is a part of. Domain numbers are arbitrarily assigned by the firmware and are consistent on a per controller basis – but not across controllers. So, the contents of domains will be consistent across controllers but the number identifying a particular domain may not be. |
integer (int32) |
id |
Example : |
string |
4.296. SasExpanderParent
Name | Description | Schema |
---|---|---|
expanderParentType |
This enumeration specifies the different types of parent elements a SAS expander may have. |
enum (unknown, controller, esm, drawer, __UNDEFINED) |
parentController |
A reference to the parent controller of the SAS expander. This field is present only if the expanderParentType value is SAS_EXPANDER_PARENT_CONTROLLER. |
string |
parentEsm |
A reference to the parent ESM of the SAS expander. This field is present only if the expanderParentType value is SAS_EXPANDER_PARENT_ESM. |
string |
parentDrawer |
A reference to the parent drawer of the SAS expander. This field is present only if the expanderParentType value is SAS_EXPANDER_PARENT_DRAWER. |
string |
4.297. SasInterfacePort
Name | Description | Schema |
---|---|---|
channel |
The number of the channel corresponding to this interface. |
integer (int32) |
currentInterfaceSpeed |
The current interface speed of the SAS interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maximumInterfaceSpeed |
The maximum interface speed of the SAS interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
part |
A string indicating the chip type. |
string |
revision |
The revision level of the firmware on the SAS I/O controller. |
integer (int32) |
isDegraded |
True if the channel corresponding to this interface is degraded. |
boolean |
iocPort |
Information about the SAS I/O controller port corresponding to this interface. |
|
interfaceRef |
The unique identifier for a given instance of this structure. |
string |
physicalLocation |
The physical location of the SAS interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st SAS interface relative to the parent," "2nd SAS interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
protectionInformationCapable |
This field indicates whether or not the I/O interface is PI capable. |
boolean |
oneWayMaxRate |
Maximum one way data rate in B/s |
string (int64) |
bidirectionalMaxRate |
Maximum bi-directional data rate in B/s |
string (int64) |
controllerId |
Example : |
string |
interfaceId |
Example : |
string |
niceAddressId |
Example : |
string |
addressId |
Example : |
string |
basePortAddress |
Example : |
string |
id |
Example : |
string |
4.298. Sfp
Name | Description | Schema |
---|---|---|
sfpRef |
The reference for this physical SFP. |
string |
status |
The operational status of the SFP. |
enum (optimal, failed, removed, unknown, __UNDEFINED) |
physicalLocation |
The physical location of the SFP. |
|
sfpType |
The type of the SFP. |
|
sfpPort |
The port that the SFP is associated with. |
enum (portUnknown, port1, port2, port3, port4, __UNDEFINED) |
parentData |
Data specific to SFP parent type. |
|
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
sfpPortRef |
A reference identifying the channel port that the SFP is plugged into. |
string |
repairPolicy |
The repair policy for the SFP component. |
|
id |
Example : |
string |
4.299. SmartBatteryData
Name | Description | Schema |
---|---|---|
lastBatteryLearnCycle |
The time of the last completed learn cycle, expressed in seconds since midnight GMT, January 1, 1970. |
string (int64) |
nextBatteryLearnCycle |
The time of the next scheduled learn cycle, expressed in seconds since midnight GMT, January 1, 1970. |
string (int64) |
batteryLearnCycleInterval |
The time between automatic learn cycles, expressed in weeks. |
integer (int32) |
4.300. SupportCRU
Name | Description | Schema |
---|---|---|
supportCRURef |
The reference for this physical support CRU. |
string |
status |
The operational status of the support CRU. |
enum (unknown, optimal, failed, removed, noinput, incorrectConfig, __UNDEFINED) |
physicalLocation |
The physical location of the support CRU. The parent reference in Location identifies the tray containing the CRU, and the position field is the parent-relative/like-component relative slot number of the CRU, starting at one. |
|
manufacturerDate |
VPD manufacture date. |
string (int64) |
vendorName |
VPD vendor name. |
string |
vendorPN |
VPD part number. |
string |
vendorSN |
VPD serial number. |
string |
fruType |
VPD field replaceable unit type. |
string |
readyToRemove |
When set to True, the component is ready to remove (and the Ready to Remove indicator light is turned on). This field is deprecated. The rtrAttributes field should be used instead. |
boolean |
rtrAttributes |
The CRU type of the support CRU plus its ready-to-remove attributes, which are based on the CRU type. |
|
configuredComponents |
A variable-length list of the types of components that occupy the support CRU. |
< enum (unknown, fan, battery, powerSupply, thermalSensor, esm, ups, minihub, gbic, sfp, interconnectCru, supportCru, alarm, hostboard, icSasExpander, hostIoCard, cacheBackupDevice, cacheMemDimm, procMemDimm, channelPort, drive, controller, ethernetInterface, fibreInterface, ibInterface, iscsiInterface, sasInterface, tray, storageArray, drawer, __UNDEFINED) > array |
type |
The type of this support CRU (e.g., "power-fan" or "battery") |
enum (unknown, powerFan, battery, fan, powerSupply, __UNDEFINED) |
repairPolicy |
The repair policy for the support CRU component. |
|
id |
Example : |
string |
4.301. ThermalSensor
Name | Description | Schema |
---|---|---|
thermalSensorRef |
The reference for this physical thermal sensor. |
string |
status |
The operational status of the thermal sensor. |
enum (optimal, nominalTempExceed, maxTempExceed, removed, unknown, __UNDEFINED) |
physicalLocation |
The physical location of the thermal sensor. The parent reference in Location identifies the CRU that physically houses the thermal sensor, and the position field is the parent-relative/like-component relative number of the thermal sensor, starting at one. |
|
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
rtrAttributes |
The CRU type of the thermal sensor plus its ready-to-remove attributes, which are based on the CRU type |
|
repairPolicy |
The repair policy for the thermal sensor component. |
|
id |
Example : |
string |
4.302. TrayAttribute
Name | Description | Schema |
---|---|---|
attributeId |
An indication of which attribute this is. |
enum (assetTag, chassisName, serviceTag, spinUpDelay, spinUpCount, __UNDEFINED) |
attributeValue |
The value of the tray attribute. |
string |
4.303. TrayEx
Name | Description | Schema |
---|---|---|
type |
An indication of the type of the tray. |
enum (sym1000, sym2000, sym2772, pciraid, generic, sym2200, sym1200, sym2882, sym1500, fc4600, ss3600, md1000, md3000, xbb2, fc6900, md1200, md1220, de1600, de5600, de6600, de7600, de6650, sc12, sc24, de212c, de224c, de460c, __UNDEFINED) |
orientation |
An indication of the physical orientation (horizontal or vertical) of the tray. |
enum (horizontal, vertical, __UNDEFINED) |
numControllerSlots |
The number of slots available for holding RAID controller boards (i.e., set to zero for a drive-only tray). |
integer (int32) |
numDriveSlots |
The total number of slots available for holding disk drives. |
integer (int32) |
trayId |
The tray identifier value, which is typically set using physical switches on the tray itself. |
integer (int32) |
trayRef |
The identifier value for this tray. Other objects may use this reference value to refer to the tray. |
string |
nonRedundantAccess |
True, if the tray does not have redundant access. |
boolean |
partNumber |
The part number of the tray from VPD data. |
string |
serialNumber |
The serial number of the tray. |
string |
vendorName |
The name of the manufacturer of the tray. |
string |
manufacturerDate |
The date the tray was manufactured. |
string (int64) |
fruType |
The field replaceable unit type of the tray. |
string |
trayIDMismatch |
True if the IDs on the ESMs do not match. |
boolean |
trayIDConflict |
True if this tray ID conflicts with that of another tray. |
boolean |
esmVersionMismatch |
True if the ESM firmware versions do not match. |
boolean |
esmMiswire |
True if this tray has an ESM join miswire. |
boolean |
drvMHSpeedMismatch |
True if this tray has a drive-side minihub speed mismatch. |
boolean |
unsupportedTray |
True if this tray is an unrecognized/unsupported hardware type. |
boolean |
workingChannel |
The channel to the tray that is still operational (if nonRedundantAccess is True). |
integer (int32) |
maxSpeed |
The maximum speed of the drive channels, |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
trayTechnologyType |
The interface technology. This field is deprecated. Equivalent information is available in the driveTechnologies and frontEndInterfaceTechnology fields. |
enum (unknown, scsiScsi, fibreFibre, fibreSata, fibrePata, __UNDEFINED) |
esmGroupError |
True if SBOD ESM trays are not properly clustered. |
boolean |
uncertifiedTray |
True if this tray is an uncertified hardware type. |
boolean |
locateTray |
True if this tray supports a locate operation. |
boolean |
esmHardwareMismatch |
True if the ESM hardware components in the tray are mismatched. |
boolean |
hasConfigurableTrayId |
True if the tray ID can be set using the updateTray procedure. |
boolean |
frontEndInterfaceTechnology |
The front-end I/O interface technology of the tray. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
driveTechnologies |
A list of drive technologies that are present in the tray. |
< enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) > array |
numDriveCompartments |
The number of drive compartments in the tray. Some drive trays are subdivided into "compartments," each having the same number of drive slots. Looking at the front of such an enclosure, multiple compartments are arranged side by side along one dimension, while drives within a compartment are arranged side by side along the other dimension, allowing for greater overall drive density within the constraints of a given enclosure form factor. (Even when arranged as a series of compartments, drive slot numbering is still relative to the entire tray.) |
integer (int32) |
numDriveSlotsPerCompartment |
The number of drive slots within an individual drive compartment. |
integer (int32) |
trayAttributes |
The tray attribute data (see setTrayAttributes procedure). |
< TrayAttribute > array |
isMisconfigured |
True, if the tray has invalid configuration settings. |
boolean |
esmFactoryDefaultsMismatch |
True, if the two ESMs in the tray are reporting different version information for their factory default settings. |
boolean |
physicalLocation |
The physical location of the tray. The parent reference in Location identifies the storage array itself, and the position field is the tray position number as identified in setSATrayPositions procedure call, or the constant TRAY_POSITION_UNKNOWN. |
|
numDrawers |
The total number of drawers available in the tray. |
integer (int32) |
driveLayout |
If the tray contains drawers, this field specifies the layout within the drawer. Otherwise, this field specifies the layout for the tray. |
|
factoryDefaultsData |
This field contains information about the version of the tray’s factory default settings. |
|
locateInProgress |
Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the tray. |
boolean |
hasTrayIdentityIndicator |
The device contains 7-segment indicators used to display the Tray Identity. |
boolean |
oemPartNumber |
The OEM part number of the tray or chassis. |
string |
trayPositionIndex |
Example : |
integer (int32) |
id |
Example : |
string |
4.304. EsmFibrePortConnection
Represents a Fibre connection between a Tray/Esm and another storageDevice component
Name | Description | Schema |
---|---|---|
tray |
The tray that the connection originates from |
|
esm |
The esm that the connection originates from |
|
channelPort |
The port that the Esm is connected to. |
|
attachedController |
The controller (if applicable) that the Esm is connected to |
|
type |
Example : |
enum (sas, fibre) |
4.305. EsmPortConnectionResponse
Provides information on the connections between ESMs/Trays and other components
Name | Description | Schema |
---|---|---|
sasConnections |
Example : |
< EsmSasPortConnection > array |
fibreConnections |
Example : |
< EsmFibrePortConnection > array |
4.306. EsmSasPortConnection
Represents a SAS connection between a Tray/Esm and another storageDevice component
Name | Description | Schema |
---|---|---|
tray |
The tray that the connection originates from |
|
esm |
The esm that the connection originates from |
|
sasExpander |
The SAS Expander on the Esm |
|
sasPort |
The SAS Port associated with the sasExpander on the ESM |
|
channelPort |
The Channel Port associated with the SAS Port and Expander on the ESM |
|
attachedSasExpander |
The SAS Expander that that SAS Connection on the ESM connects to |
|
attachedChannelPort |
The ChannelPort that that SAS Connection on the ESM connects to |
|
attachedController |
The Controller (if applicable) that that SAS Connection on the ESM connects to |
|
type |
Example : |
enum (sas, fibre) |
4.307. Tray
Name | Description | Schema |
---|---|---|
type |
An indication of the type of the tray. |
enum (sym1000, sym2000, sym2772, pciraid, generic, sym2200, sym1200, sym2882, sym1500, fc4600, ss3600, md1000, md3000, xbb2, fc6900, md1200, md1220, de1600, de5600, de6600, de7600, de6650, sc12, sc24, de212c, de224c, de460c, __UNDEFINED) |
orientation |
An indication of the physical orientation (horizontal or vertical) of the tray. |
enum (horizontal, vertical, __UNDEFINED) |
numControllerSlots |
The number of slots available for holding RAID controller boards (i.e., set to zero for a drive-only tray). |
integer (int32) |
numDriveSlots |
The total number of slots available for holding disk drives. |
integer (int32) |
trayId |
The tray identifier value, which is typically set using physical switches on the tray itself. |
integer (int32) |
trayRef |
The identifier value for this tray. Other objects may use this reference value to refer to the tray. |
string |
nonRedundantAccess |
True, if the tray does not have redundant access. |
boolean |
partNumber |
The part number of the tray from VPD data. |
string |
serialNumber |
The serial number of the tray. |
string |
vendorName |
The name of the manufacturer of the tray. |
string |
manufacturerDate |
The date the tray was manufactured. |
string (int64) |
fruType |
The field replaceable unit type of the tray. |
string |
trayIDMismatch |
True if the IDs on the ESMs do not match. |
boolean |
trayIDConflict |
True if this tray ID conflicts with that of another tray. |
boolean |
esmVersionMismatch |
True if the ESM firmware versions do not match. |
boolean |
esmMiswire |
True if this tray has an ESM join miswire. |
boolean |
drvMHSpeedMismatch |
True if this tray has a drive-side minihub speed mismatch. |
boolean |
unsupportedTray |
True if this tray is an unrecognized/unsupported hardware type. |
boolean |
workingChannel |
The channel to the tray that is still operational (if nonRedundantAccess is True). |
integer (int32) |
maxSpeed |
The maximum speed of the drive channels, |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
trayTechnologyType |
The interface technology. This field is deprecated. Equivalent information is available in the driveTechnologies and frontEndInterfaceTechnology fields. |
enum (unknown, scsiScsi, fibreFibre, fibreSata, fibrePata, __UNDEFINED) |
esmGroupError |
True if SBOD ESM trays are not properly clustered. |
boolean |
uncertifiedTray |
True if this tray is an uncertified hardware type. |
boolean |
locateTray |
True if this tray supports a locate operation. |
boolean |
esmHardwareMismatch |
True if the ESM hardware components in the tray are mismatched. |
boolean |
hasConfigurableTrayId |
True if the tray ID can be set using the updateTray procedure. |
boolean |
frontEndInterfaceTechnology |
The front-end I/O interface technology of the tray. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
driveTechnologies |
A list of drive technologies that are present in the tray. |
< enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) > array |
numDriveCompartments |
The number of drive compartments in the tray. Some drive trays are subdivided into "compartments," each having the same number of drive slots. Looking at the front of such an enclosure, multiple compartments are arranged side by side along one dimension, while drives within a compartment are arranged side by side along the other dimension, allowing for greater overall drive density within the constraints of a given enclosure form factor. (Even when arranged as a series of compartments, drive slot numbering is still relative to the entire tray.) |
integer (int32) |
numDriveSlotsPerCompartment |
The number of drive slots within an individual drive compartment. |
integer (int32) |
trayAttributes |
The tray attribute data (see setTrayAttributes procedure). |
< TrayAttribute > array |
isMisconfigured |
True, if the tray has invalid configuration settings. |
boolean |
esmFactoryDefaultsMismatch |
True, if the two ESMs in the tray are reporting different version information for their factory default settings. |
boolean |
physicalLocation |
The physical location of the tray. The parent reference in Location identifies the storage array itself, and the position field is the tray position number as identified in setSATrayPositions procedure call, or the constant TRAY_POSITION_UNKNOWN. |
|
numDrawers |
The total number of drawers available in the tray. |
integer (int32) |
driveLayout |
If the tray contains drawers, this field specifies the layout within the drawer. Otherwise, this field specifies the layout for the tray. |
|
factoryDefaultsData |
This field contains information about the version of the tray’s factory default settings. |
|
locateInProgress |
Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the tray. |
boolean |
hasTrayIdentityIndicator |
The device contains 7-segment indicators used to display the Tray Identity. |
boolean |
oemPartNumber |
The OEM part number of the tray or chassis. |
string |
id |
Example : |
string |
4.308. HealthCheckRequest
Name | Description | Schema |
---|---|---|
onlineOnly |
Only run health checks on online storage-systems |
boolean |
storageDeviceIds |
An optional list of device ids (if not provided, all available devices will be used) |
< string > array |
4.309. HealthCheckResponse
A list of requested health check results
Name | Description | Schema |
---|---|---|
requestId |
The unique request id |
string (int64) |
healthCheckRunning |
Indicates if a health check is currently running |
boolean |
cancelled |
The operation was cancelled while performing the pre-flight checks. |
boolean |
remaining |
Approximate number of devices that are still processing the health checks. |
integer (int32) |
results |
Example : |
< FirmwareUpgradeHealthCheckResult > array |
start |
The time that this operation was started. |
string (date-time) |
4.310. HostGroup
Name | Description | Schema |
---|---|---|
clusterRef |
The unique identification value for this object. Other objects may use this reference value to refer to the cluster. |
string |
label |
The user-assigned, descriptive label string for the cluster. |
string |
isSAControlled |
If true, indicates that I/O accesses from this cluster are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the cluster are subject to cluster-specific LUN-to-volume mappings. |
boolean |
confirmLUNMappingCreation |
If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other clusters, in addition to this one. |
boolean |
protectionInformationCapableAccessMethod |
This field is true if the host has a PI capable access method. |
boolean |
isLun0Restricted |
Provides an indication as to whether LUN 0 is restricted (i.e., disallowed) for the associated cluster. |
boolean |
id |
Example : |
string |
name |
Example : |
string |
4.311. HostGroupCreateRequest
Creates a Host Group in the Storage System
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the new host group. |
string |
hosts |
List of hostRefs to assign to the HostGroup |
< string > array |
4.312. HostGroupUpdateRequest
Creates a Host Group in the Storage System
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the new host group. |
string |
hosts |
List of hostRefs to add to the HostGroup |
< string > array |
4.313. AuthMethodTypeData
Name | Description | Schema |
---|---|---|
authMethod |
This enumeration type identifies the available iSCSIauthentication methods. The supportedAuthMethods array in the FeatureParams structure will contain values from this enumeration identifying which iSCSI authentication methods are supported on the storage array. |
enum (none, chap, __UNDEFINED) |
chapSecret |
This field is present only if the authentication method is AUTH_METHOD_CHAP. If the field length indicator is zero, there is no associated secret; otherwise there is a secret and it may or may not be specified, depending on the usage context for this data type. If the client is using this structure to set a secret, the length indicator should be one and the secret should be filled in; if the client is using this structure to set an authentication method with no secret, the length indicator should be zero. If the array is reporting this data, it sets the length indicator according to whether or not there is a secret. (The actual secret is never reported by the array; instead it uses the ENCRYPT_UNSPECIFIED case of EncryptedPassword.) Finally, because CHAP secrets are, by definition, limited to the ASCII character set, the clear text submitted for encryption must be ASCII, not Unicode. |
< EncryptedPassword > array |
4.314. AuthenticationBundle
Name | Description | Schema |
---|---|---|
authMethodData |
A variable-length array containing authentication methods and any associated data. |
< AuthMethodTypeData > array |
4.315. EncryptedPassword
Name | Description | Schema |
---|---|---|
type |
This enumeration object is used to identify the type of encryption used for a particular operation or object. |
enum (pkcs5Sha1Des, unspecified, pkcs5Sha2Aes, __UNDEFINED) |
pkcs5Data |
The PKCS #5 data associated with the encrypted password. This field is valid only if the encryption type is ENCRYPT_PKCS5_SHA1_DES. |
|
pkcs5AesData |
The PKCS#5 data associated with an AES encrypted password. This field is valid only if the encryption type is ENCRYPT_PKCS5_SHA2_AES. |
4.316. HostEx
Name | Description | Schema |
---|---|---|
hostRef |
The unique identification value for this object. Other objects may use this reference value to refer to the host. |
string |
clusterRef |
The cluster reference value of the cluster in which this host resides. A NULL reference value indicates that the host has not been assigned to a cluster. |
string |
label |
The user-assigned, descriptive label string for the host. |
string |
isSAControlled |
If true, indicates that I/O accesses from this host are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the host are subject to host-specific or cluster-specific LUN-to-volume mappings. |
boolean |
confirmLUNMappingCreation |
If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other hosts, in addition to this one. |
boolean |
hostTypeIndex |
An integer index indicating the type of host. |
integer (int32) |
protectionInformationCapableAccessMethod |
This field is true if the host has a PI capable access method. |
boolean |
isLargeBlockFormatHost |
If true, the host is capable of supporting large block formats. |
boolean |
isLun0Restricted |
Provides an indication as to whether LUN 0 is restricted (i.e., disallowed) for the associated host. |
boolean |
ports |
Example : |
< HostPort > array |
initiators |
Example : |
< Initiator > array |
hostSidePorts |
Example : |
< HostSidePort > array |
id |
Example : |
string |
name |
Example : |
string |
4.317. HostPort
Name | Description | Schema |
---|---|---|
hostPortRef |
The unique identification value for this object. Other objects may use this reference value to refer to the host port. |
string |
hostPortName |
The unique, externally-defined identifier for this object. For example, for a Fibre Channel host port, this field contains the value of the Fibre Channel world-wide name for the port. |
string |
label |
The user-assigned, descriptive label string for the host port. |
string |
hostRef |
The host reference value of the host in which this port resides. |
string |
hostPortTypeIndex |
An index value that indicates the type of host port. This value is used to reference the appropriate entry in the hostPortType field of the associated StorageArray object. |
integer (int32) |
isSAControlled |
If true, indicates that I/O accesses from this host port are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the host port are subject to host-specific or cluster-specific LUN-to-volume mappings. |
boolean |
confirmLUNMappingCreation |
If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other host ports, in addition to this one. |
boolean |
portId |
The I/O-protocol-based unique port identifier. This field replaces the deprecated hostPortName field. |
|
portInactive |
The host port has been marked inactive |
boolean |
id |
Example : |
string |
4.318. HostPortLocation
Name | Description | Schema |
---|---|---|
ioInterfaceType |
This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
fcPortName |
This field is present only if the type value is equal to IO_IF_FC. |
string |
ibPortName |
This field is present only if the type value is equal to IO_IF_IB. |
string |
sasPortName |
This field is present only if the type value is equal to IO_IF_SAS. |
string |
4.319. HostSidePort
Name | Description | Schema |
---|---|---|
id |
The host side port id. |
string |
type |
The host side port’s SCSI transport protocol. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
address |
The host side port’s address. |
string |
label |
The host side port’s label. |
string |
mtpIoInterfaceType |
The host side port’s media transport protocol. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
name |
Example : |
string |
4.320. Initiator
Name | Description | Schema |
---|---|---|
initiatorRef |
The reference that uniquely identifies an instance of this object. |
string |
nodeName |
The unique node name associated with the initiator. Use of this object is not supported in the current version of the storage array firmware or SYMbol interface. Use initiatorNodeName in its place. |
|
alias |
An additional name that can be assigned to an initiator, which is usually "friendlier" than the node name. |
|
label |
An additional "friendly" name that can be assigned to an initiator through the Storage Manager application. |
string |
configuredAuthMethods |
The authentication methods that have been configured for the initiator. Associated secrets are not exposed. instead the type field of the EncryptedPassword is set to ENCRYPT_UNSPECIFIED. |
|
hostRef |
A reference to the Host object to which the initiator belongs. |
string |
initiatorInactive |
The initiator is marked inactive. |
boolean |
initiatorNodeName |
The unique identifier for this initiator and its properties. |
|
id |
Example : |
string |
4.321. InitiatorNodeName
Name | Description | Schema |
---|---|---|
nodeName |
The unique node name associated with the initiator |
|
interfaceType |
The Media Transport Protocol in use by the initiator. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
4.322. IscsiInitiatorPortId
Name | Description | Schema |
---|---|---|
initiatorNodeName |
The iSCSI node name of the initiator. |
string |
initiatorSessionId |
The initiator session ID associated with the initiator port. |
string |
4.323. NVMeInitiatorPortId
Name | Description | Schema |
---|---|---|
name |
NVMe Qualified Name (NQN) of the host |
string |
hostIdentifier |
128-bit Host Identifier value |
string |
portIdentifier |
The unique identifier for the host port. |
4.324. PKCS5EncryptionData
Name | Description | Schema |
---|---|---|
iterations |
The number of message digest iterations to be performed when generating the encryption key and initialization vector from the passphrase and salt values. |
integer (int32) |
salt |
A byte array containing the salt, or random data, selected by the encryption code for this particular encryption operation. |
string |
cipherText |
A variable-length array containing the encrypted data, or cipher text. The length of this array must be a multiple of 8 in order to conform to the PKCS #5 standard. The standard specifies the appropriate technique for adding pad bytes to ensure that this constraint is met. |
string |
4.325. SCSIInitiatorPortId
Name | Description | Schema |
---|---|---|
ioInterfaceType |
This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
portName |
This field is present only if the type value is equal to IO_IF_FC. |
string |
ibPortName |
This field is present only if the type value is equal to IO_IF_IB. |
string |
iscsiPortName |
This field is present only if the type value is equal to IO_IF_ISCSI. |
|
sasPortName |
This field is present only if the type value is equal to IO_IF_SAS. |
string |
nvmeInitiatorPortId |
Initiator Port ID for an NVMe over Fabrics host |
4.326. ScsiAlias
Name | Description | Schema |
---|---|---|
ioInterfaceType |
This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
iscsiAlias |
The SCSI alias name as defined under iSCSI. This field is only valid if the I/O interface type is equal to IO_IF_ISCSI. |
string |
4.327. HostMoveRequest
Name | Description | Schema |
---|---|---|
groupId |
The identifier of the host group to move the host under. If null, move the host to the default group.. |
string |
4.328. HostPortCreateRequest
Creates a Host Port in the Storage System
Name | Description | Schema |
---|---|---|
type |
The type of host port to create. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
port |
The host port identifier such as the iSCSI IQN or fibre channel WWN |
string |
label |
The user-label for the host port |
string |
iscsiChapSecret |
Required password if host-side CHAP is enabled |
string |
4.329. HostPortUpdateRequest
Update a HostPort
Name | Description | Schema |
---|---|---|
portRef |
The ref/id of the HostPort or Initiator |
string |
hostRef |
The new owning host. |
string |
port |
The host port identifier such as the iSCSI IQN or fibre channel WWN |
string |
label |
The user-label for the host port |
string |
iscsiChapSecret |
Required password if host-side CHAP is enabled |
string |
4.330. HostType
A Host Type is a definition of the operating system of the Host computer that accesses the storage system, for example VmWare, Windows, Solaris, Linux, etc. The Host Type is used by the storage system to customize the I/O protocol based on the implementation of the host I/O drivers.
Name | Description | Schema |
---|---|---|
name |
Example : |
string |
index |
Example : |
integer (int32) |
code |
Example : |
string |
used |
Example : |
boolean |
default |
Example : |
boolean |
4.331. HostUpdateRequest
Updates the Host data.
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the host (optional). |
string |
groupId |
The host group identifier. |
string |
ports |
A list of host ports to create. |
< HostPortCreateRequest > array |
portsToUpdate |
A list of host ports to update. |
< HostPortUpdateRequest > array |
portsToRemove |
A list of HostPorts to delete. |
< string > array |
hostType |
The host type string as returned from /host-types. |
4.332. Host
Name | Description | Schema |
---|---|---|
hostRef |
The unique identification value for this object. Other objects may use this reference value to refer to the host. |
string |
clusterRef |
The cluster reference value of the cluster in which this host resides. A NULL reference value indicates that the host has not been assigned to a cluster. |
string |
label |
The user-assigned, descriptive label string for the host. |
string |
isSAControlled |
If true, indicates that I/O accesses from this host are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the host are subject to host-specific or cluster-specific LUN-to-volume mappings. |
boolean |
confirmLUNMappingCreation |
If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other hosts, in addition to this one. |
boolean |
hostTypeIndex |
An integer index indicating the type of host. |
integer (int32) |
protectionInformationCapableAccessMethod |
This field is true if the host has a PI capable access method. |
boolean |
isLargeBlockFormatHost |
If true, the host is capable of supporting large block formats. |
boolean |
isLun0Restricted |
Provides an indication as to whether LUN 0 is restricted (i.e., disallowed) for the associated host. |
boolean |
name |
Example : |
string |
id |
Example : |
string |
4.333. HostCreateRequest
Creates a Host in the Storage System
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the new host. |
string |
hostType |
The host type string as returned from /host-types. |
|
groupId |
The host group identifier (optional). |
string |
ports |
A list of host ports (optional). |
< HostPortCreateRequest > array |
4.334. SingleNumberValue
Object to represent a single number (int).
Name | Description | Schema |
---|---|---|
value |
A numeric value |
integer (int32) |
4.335. HostTypeValues
Name | Description | Schema |
---|---|---|
waitForDownload |
The download microcode status control. |
boolean |
notReadySenseForQuiescenceInProgress |
This value determines the response of the controller to commands received during the 'controller quiesced' state. |
boolean |
notReadySenseForQuiescenceInProgress2 |
This value determines the response of the controller to commands received during the 'controller quiesced' state. |
boolean |
checkConditionForVendorUniqueUAConditions |
This value determines if the controller will report a vendor unique Unit Attention condition as a Check Condition status. |
boolean |
reportDeferredErrors |
This value is used to determine how deferred errors are reported to the host. |
boolean |
ignoreForceUnitAccess |
This value determines controller treatment of the Force Unit Access Option in the SCSI Read(10) and Write(10) commands. |
boolean |
ignoreWriteCacheDisable |
This value determines if the controller will allow the resetting of the WCE bit in the Mode Select Caching Page to disable write caching. |
boolean |
allowReservationOnUnownedLUNs |
This value determines the controller response to Reservation/Release commands that are received for LUNs that are not owned by the controller. |
boolean |
worldWideNameInStandardInquiry |
Set to true if the WWN is in the standard inquiry data. |
boolean |
propagateHostBusResets |
This value determines whether the controller will propagate a Host Bus Reset/Target Reset/Logical Unit Reset to the other controller in a dual controller subsystem to support Microsoft Clustering Services. |
boolean |
reportSCCDeviceEnable |
Report SCC Device Enable. |
boolean |
conditionalFCLogout |
Conditional Fibre Channel Logout. |
boolean |
forceSCSI2 |
Report SCSI-2 Through Fibre Channel Host Interface. |
boolean |
reportUnconfiguredLUNs |
This value determines the LUN data returned by the Report LUNs command. |
boolean |
ignoreSyncCache |
Ignore Cache Sync Command. |
boolean |
ignoreUTMLunOwnership |
Ignore UTM LUN Ownership. |
boolean |
reportLUNPreferredPathInStandardInquiry |
Report LUN Preferred Path in Standard Inquiry Data. |
boolean |
autoLUNTransfer |
Auto Volume Transfer. |
boolean |
inquiryUnconfiguredDeviceType |
The value returned in the Inquiry Device Type Field when an unconfigured LUN is accessed. |
string |
inquiryUnownedDeviceType |
This value is used to define the device type the controller should return in the first byte of the Inquiry data, if the addressed logical unit is not owned by the addressed controller. |
string |
unownedBlock0Read |
This value is used to define how the controller handles a read request to Block 0 of an unowned volume. When this is enabled, the non-owning controller sends a request for the block 0 data to the owning controller and the owning controller sends the requested block 0 data back to the non-owning controller. If disabled, the controller will do a volume transfer (if AVT is enabled) and then a read of the now owned volume. |
string |
retainLogins |
This field is deprecated. |
boolean |
hostPortType |
The host type. |
string |
maxRestrictedLUNs |
Maximum number of LUNs allowed for host type. |
integer (int32) |
reserved1 |
Example : |
string |
avtExclusionExtentsEnabled |
Enable the AVT exclusion extents for this heterogeneous host region. |
boolean |
suppressVolOffPreferredPathAlert |
If true, then volume-off-preferred events are not considered critical. |
boolean |
hostType |
The host type string. A zero-length string is allowed and indicates that the associated host-specific NVSRAM region has been cleared. This field should be used in place of the deprecated hostPortType field. |
string |
tpgsSupported |
This field is set to true if Target Port Group Support is provided; otherwise it is false. |
boolean |
volumeFormatOptions |
If true, a format unit request will interrupt any in-progress IAF and start a write-zeros initialization. If false, the format unit will be returned with no action. |
boolean |
restrictedLun0 |
If true, LUN 0 is restricted and volume mapping to LUN 0 will not be allowed or be reported in the REPORT LUNS data. If false, a volume-to-LUN mapping can be created to LUN 0 and will be reported in a REPORT LUNS response. |
boolean |
usePage2CQuiescenceTimeout |
The quiescence timeout is the amount of time the controller should wait to achieve a "no I/Os active" state before invoking a forced transfer of LUN ownership. When this field is set to true, the timeout parameter provided by the host initiator in a mode select Page 2C will be used. When this field is set to false, the timeout value applied will be calculated by the controller. |
boolean |
asymmetricLUAccess |
If true, Asymmetric Logical Unit Access is enabled. |
boolean |
ignoreISCSISessionIDInITN |
If true, the array iSCSI target driver will not use the session identifier as part of its internal I_T Nexus identifiers. This reduces churn in I_T Nexus identifiers if the initiator does not re-use iSCSI session identifiers when re-opening a session. |
boolean |
enableLUCheckConditionParallelResponses |
If true, array may return multiple CHECK CONDITION responses simultaneously on a given logical unit. |
boolean |
disableExplicitTPGS |
If true, the standard INQUIRY data reporting TPGS support to the initiator will only indicate support for implicit mode (providing TPGS support is enabled, see tpgsSupported field). |
boolean |
unownedCheckConditionDuringFWActivation |
If true, controller will return a LUN NOT OWNED (05h/94h/01h) CHECK CONDITION when unable to handle I/O during firmware activation. |
boolean |
allowPreferredOwnerReportingSuppression |
If true, the controller will suppress reporting the preferred owner in REPORT TARGET PORT GROUPS or INQUIRY VPD data in conditions when the preferred controller cannot process I/O. |
boolean |
enableTargetFailback |
If true, controller initiates fail-back of volumes to the preferred owner . |
boolean |
enableAutoLoadBalance |
If true, the controller may issue volume ownership changes to balance IO load between controllers. |
boolean |
quiescenceInProgressSenseKey |
Sense Key returned to host for Quiescence In Progress Check Conditions. |
integer (int32) |
quiescenceInProgressASC |
Additional Sense Code returned to host for Quiescence In Progress Check Conditions. |
integer (int32) |
quiescenceInProgressASCQ |
Additional Sense Code Qualifier returned to host for Quiscence In Progress Check Conditions. |
integer (int32) |
persistentID |
Unique identifier for this specific host type. This value is stored in the controller configuration database when persisting Host objects in order to uniquely identify this specific host type across all NVSRAM builds. |
integer (int32) |
nvmeVUFailoverSupported |
If true, a vendor unique (VU) NVMe failover solution is supported on the host. |
boolean |
nvmeStandardFailoverSupported |
If true, the NVMe Asymmetric Namespace Access (ANA) failover solution is supported on the host. |
boolean |
index |
Example : |
integer (int32) |
default |
Example : |
boolean |
4.336. AnalysedStorageSystemStatistics
Statistics for storage system.
Name | Description | Schema |
---|---|---|
observedTime |
A timestamp representing when the data was collected |
string (date-time) |
observedTimeInMS |
The time in which this data was polled and generated in milliseconds |
string (int64) |
readIOps |
Read operations per second. |
number (double) |
writeIOps |
Write operations per second. |
number (double) |
otherIOps |
SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready. |
number (double) |
combinedIOps |
All operations per second. |
number (double) |
readThroughput |
Read throughput in MB/s. |
number (double) |
writeThroughput |
Write throughput in MB/s. |
number (double) |
combinedThroughput |
Combined read/write throughput in MB/s. |
number (double) |
readResponseTime |
Read response time average in milliseconds. |
number (double) |
readResponseTimeStdDev |
The standard deviation of read response times. |
number (double) |
writeResponseTime |
Write response time average in milliseconds. |
number (double) |
writeResponseTimeStdDev |
The standard deviation of write response times. |
number (double) |
combinedResponseTime |
Combined average response time in milliseconds. |
number (double) |
combinedResponseTimeStdDev |
The standard deviation of combined response times. |
number (double) |
averageReadOpSize |
Average read operation size in bytes. |
number (double) |
averageWriteOpSize |
Average write operation size in bytes. |
number (double) |
readOps |
The amount of read operations in this analysed interval. |
number (double) |
writeOps |
The amount of write operations in this analysed interval. |
number (double) |
readPhysicalIOps |
Physical read operations per second. |
number (double) |
writePhysicalIOps |
Physical write operations per second. |
number (double) |
storageSystemId |
Example : |
string |
storageSystemWWN |
Example : |
string |
storageSystemName |
Example : |
string |
4.337. AnalyzedApplicationStatistics
Aggregation of volume statistics for application.
Name | Description | Schema |
---|---|---|
observedTime |
A timestamp representing when the data was collected |
string (date-time) |
observedTimeInMS |
The time in which this data was polled and generated in milliseconds |
string (int64) |
readIOps |
Read operations per second. |
number (double) |
writeIOps |
Write operations per second. |
number (double) |
otherIOps |
SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready. |
number (double) |
combinedIOps |
All operations per second. |
number (double) |
readThroughput |
Read throughput in MB/s. |
number (double) |
writeThroughput |
Write throughput in MB/s. |
number (double) |
combinedThroughput |
Combined read/write throughput in MB/s. |
number (double) |
readResponseTime |
Read response time average in milliseconds. |
number (double) |
readResponseTimeStdDev |
The standard deviation of read response times. |
number (double) |
writeResponseTime |
Write response time average in milliseconds. |
number (double) |
writeResponseTimeStdDev |
The standard deviation of write response times. |
number (double) |
combinedResponseTime |
Combined average response time in milliseconds. |
number (double) |
combinedResponseTimeStdDev |
The standard deviation of combined response times. |
number (double) |
averageReadOpSize |
Average read operation size in bytes. |
number (double) |
averageWriteOpSize |
Average write operation size in bytes. |
number (double) |
readOps |
The amount of read operations in this analysed interval. |
number (double) |
writeOps |
The amount of write operations in this analysed interval. |
number (double) |
readPhysicalIOps |
Physical read operations per second. |
number (double) |
writePhysicalIOps |
Physical write operations per second. |
number (double) |
applicationId |
The application id of the collection |
string |
4.338. AnalyzedPoolStatistics
Volume statistics for storage pools.
Name | Description | Schema |
---|---|---|
observedTime |
A timestamp representing when the data was collected |
string (date-time) |
observedTimeInMS |
The time in which this data was polled and generated in milliseconds |
string (int64) |
readIOps |
Read operations per second. |
number (double) |
writeIOps |
Write operations per second. |
number (double) |
otherIOps |
SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready. |
number (double) |
combinedIOps |
All operations per second. |
number (double) |
readThroughput |
Read throughput in MB/s. |
number (double) |
writeThroughput |
Write throughput in MB/s. |
number (double) |
combinedThroughput |
Combined read/write throughput in MB/s. |
number (double) |
readResponseTime |
Read response time average in milliseconds. |
number (double) |
readResponseTimeStdDev |
The standard deviation of read response times. |
number (double) |
writeResponseTime |
Write response time average in milliseconds. |
number (double) |
writeResponseTimeStdDev |
The standard deviation of write response times. |
number (double) |
combinedResponseTime |
Combined average response time in milliseconds. |
number (double) |
combinedResponseTimeStdDev |
The standard deviation of combined response times. |
number (double) |
averageReadOpSize |
Average read operation size in bytes. |
number (double) |
averageWriteOpSize |
Average write operation size in bytes. |
number (double) |
readOps |
The amount of read operations in this analysed interval. |
number (double) |
writeOps |
The amount of write operations in this analysed interval. |
number (double) |
readPhysicalIOps |
Physical read operations per second. |
number (double) |
writePhysicalIOps |
Physical write operations per second. |
number (double) |
poolId |
The storage pool or volume group the volume is a member of |
string |
4.339. AnalyzedWorkloadStatistics
Aggregation of volume statistics for a workload.
Name | Description | Schema |
---|---|---|
observedTime |
A timestamp representing when the data was collected |
string (date-time) |
observedTimeInMS |
The time in which this data was polled and generated in milliseconds |
string (int64) |
readIOps |
Read operations per second. |
number (double) |
writeIOps |
Write operations per second. |
number (double) |
otherIOps |
SCSI Operations to the disk that are not read/write operations. Example: Test Unit Ready. |
number (double) |
combinedIOps |
All operations per second. |
number (double) |
readThroughput |
Read throughput in MB/s. |
number (double) |
writeThroughput |
Write throughput in MB/s. |
number (double) |
combinedThroughput |
Combined read/write throughput in MB/s. |
number (double) |
readResponseTime |
Read response time average in milliseconds. |
number (double) |
readResponseTimeStdDev |
The standard deviation of read response times. |
number (double) |
writeResponseTime |
Write response time average in milliseconds. |
number (double) |
writeResponseTimeStdDev |
The standard deviation of write response times. |
number (double) |
combinedResponseTime |
Combined average response time in milliseconds. |
number (double) |
combinedResponseTimeStdDev |
The standard deviation of combined response times. |
number (double) |
averageReadOpSize |
Average read operation size in bytes. |
number (double) |
averageWriteOpSize |
Average write operation size in bytes. |
number (double) |
readOps |
The amount of read operations in this analysed interval. |
number (double) |
writeOps |
The amount of write operations in this analysed interval. |
number (double) |
readPhysicalIOps |
Physical read operations per second. |
number (double) |
writePhysicalIOps |
Physical write operations per second. |
number (double) |
workloadId |
The workload id of the collection |
string |
4.340. HistoricalStatsResponse
The collection of stats that are returned from a call to get historical statistics Each list is sorted by capture timetsamp (earlier to later).
Name | Description | Schema |
---|---|---|
volumeStats |
Example : |
< AnalysedVolumeStatistics > array |
controllerStats |
Example : |
< AnalysedControllerStatistics > array |
systemStats |
Example : |
< AnalysedStorageSystemStatistics > array |
interfaceStats |
Example : |
< AnalyzedInterfaceStatistics > array |
diskStats |
Example : |
< AnalysedDiskStatistics > array |
poolStats |
Example : |
< AnalyzedPoolStatistics > array |
workloadStats |
Example : |
< AnalyzedWorkloadStatistics > array |
applicationStats |
Example : |
< AnalyzedApplicationStatistics > array |
volumes |
Example : |
< AnalysedVolumeStatistics > array |
4.341. ApplicationStatistics
Aggregation of volume statistics for application.
Name | Description | Schema |
---|---|---|
observedTime |
End time for this collection as measured by the number of seconds since baseTime. |
string (date-time) |
observedTimeInMS |
Example : |
string (int64) |
lastResetTime |
Example : |
string (date-time) |
lastResetTimeInMS |
Example : |
string (int64) |
arrayId |
Example : |
string |
arrayWwn |
Example : |
string |
memberIdsHash |
Hash of member volume ids. |
string |
readOps |
Number of read operations |
number (double) |
readHitOps |
Number of read operations that hit cache |
number (double) |
readHitBytes |
Number of bytes read from cache |
number (double) |
readTimeTotal |
Example : |
number (double) |
readHitTimeTotal |
Example : |
number (double) |
writeOps |
Number of write operations |
number (double) |
writeTimeTotal |
Example : |
number (double) |
writeHitTimeTotal |
Example : |
number (double) |
errRedundancyChkIndeterminateReads |
Example : |
number (double) |
errRedundancyChkRecoveredReads |
Example : |
number (double) |
errRedundancyChkUnrecoveredReads |
Example : |
number (double) |
idleTime |
Example : |
number (double) |
otherOps |
Example : |
number (double) |
otherTimeMax |
Example : |
number (double) |
otherTimeTotal |
Example : |
number (double) |
readBytes |
Example : |
number (double) |
readHitTimeMax |
Example : |
number (double) |
readTimeMax |
Example : |
number (double) |
writeBytes |
Example : |
number (double) |
writeHitBytes |
Number of bytes written to cache |
number (double) |
writeHitOps |
Number of write operations that hit cache |
number (double) |
writeHitTimeMax |
Example : |
number (double) |
writeTimeMax |
Example : |
number (double) |
queueDepthTotal |
Total channel queue depth. |
number (double) |
queueDepthMax |
Maximum channel queue depth. |
number (double) |
flashCacheReadHitOps |
The number of flash cache read hit operations. |
number (double) |
flashCacheReadHitBytes |
The number of flash cache read hit bytes. |
number (double) |
flashCacheReadHitTimeTotal |
The sum of all response times for all reads that have cache hits, in microseconds |
number (double) |
flashCacheReadHitTimeMax |
Maximum I/O time in microseconds for any one read I/O that has a cache hit |
number (double) |
applicationId |
The application id of the collection |
string |
4.342. InterfaceStats
Interface I/O performance statistics.
Name | Description | Schema |
---|---|---|
observedTime |
End time for this collection as measured by the number of seconds since baseTime. |
string (date-time) |
observedTimeInMS |
Example : |
string (int64) |
lastResetTime |
Example : |
string (date-time) |
lastResetTimeInMS |
Example : |
string (int64) |
interfaceId |
Interface that generated this group. |
string |
arrayId |
Example : |
string |
arrayWwn |
Example : |
string |
channelType |
Channel Type enumeration Drive side, host side, or management. |
enum (hostside, driveside, management, __UNDEFINED) |
channelNumber |
Channel numerical ID. |
integer (int32) |
readOps |
Number of read operations. |
number (double) |
readBytes |
Number of bytes read. |
number (double) |
readTimeTotal |
Total time in microseconds spent in read operations. |
number (double) |
readTimeMax |
Max time in microseconds spent processing one read operation. |
number (double) |
writeOps |
Number of write operations. |
number (double) |
writeBytes |
Number of bytes write. |
number (double) |
writeTimeTotal |
Total time in microseconds spent in write operations. |
number (double) |
writeTimeMax |
Max time in microseconds spent processing one write operation. |
number (double) |
otherOps |
Number of non-read-write operations. |
number (double) |
otherTimeTotal |
Total time in microseconds spent in non-read-write ops. |
number (double) |
otherTimeMax |
Max time in microseconds spent processing one non-read-write op. |
number (double) |
readTimeTotalSq |
Sum of the squares of microseconds spent in read operations. |
number (double) |
writeTimeTotalSq |
Sum of the squares of microseconds spent in write operations. |
number (double) |
otherTimeTotalSq |
Sum of the squares of microseconds spent in non-read-write operations. |
number (double) |
queueDepthTotal |
Total channel queue depth. |
number (double) |
queueDepthMax |
Maximum channel queue depth. |
number (double) |
channelErrorCount |
The total number of errors detected on this channel. |
number (double) |
4.343. PoolStatistics
Raw volume statistics for storage pools.
Name | Description | Schema |
---|---|---|
observedTime |
End time for this collection as measured by the number of seconds since baseTime. |
string (date-time) |
observedTimeInMS |
Example : |
string (int64) |
lastResetTime |
Example : |
string (date-time) |
lastResetTimeInMS |
Example : |
string (int64) |
arrayId |
Example : |
string |
arrayWwn |
Example : |
string |
memberIdsHash |
Hash of member volume ids. |
string |
readOps |
Number of read operations |
number (double) |
readHitOps |
Number of read operations that hit cache |
number (double) |
readHitBytes |
Number of bytes read from cache |
number (double) |
readTimeTotal |
Example : |
number (double) |
readHitTimeTotal |
Example : |
number (double) |
writeOps |
Number of write operations |
number (double) |
writeTimeTotal |
Example : |
number (double) |
writeHitTimeTotal |
Example : |
number (double) |
errRedundancyChkIndeterminateReads |
Example : |
number (double) |
errRedundancyChkRecoveredReads |
Example : |
number (double) |
errRedundancyChkUnrecoveredReads |
Example : |
number (double) |
idleTime |
Example : |
number (double) |
otherOps |
Example : |
number (double) |
otherTimeMax |
Example : |
number (double) |
otherTimeTotal |
Example : |
number (double) |
readBytes |
Example : |
number (double) |
readHitTimeMax |
Example : |
number (double) |
readTimeMax |
Example : |
number (double) |
writeBytes |
Example : |
number (double) |
writeHitBytes |
Number of bytes written to cache |
number (double) |
writeHitOps |
Number of write operations that hit cache |
number (double) |
writeHitTimeMax |
Example : |
number (double) |
writeTimeMax |
Example : |
number (double) |
queueDepthTotal |
Total channel queue depth. |
number (double) |
queueDepthMax |
Maximum channel queue depth. |
number (double) |
flashCacheReadHitOps |
The number of flash cache read hit operations. |
number (double) |
flashCacheReadHitBytes |
The number of flash cache read hit bytes. |
number (double) |
flashCacheReadHitTimeTotal |
The sum of all response times for all reads that have cache hits, in microseconds |
number (double) |
flashCacheReadHitTimeMax |
Maximum I/O time in microseconds for any one read I/O that has a cache hit |
number (double) |
poolId |
The storage pool or volume group the volume is a member |
string |
4.344. RawStatsResponse
The collection of stats that are returned from a call to get live statistics.
Name | Description | Schema |
---|---|---|
volumeStats |
Example : |
< VolumeIOStats > array |
controllerStats |
Example : |
< ControllerStats > array |
systemStats |
Example : |
< StorageSystemStats > array |
interfaceStats |
Example : |
< InterfaceStats > array |
diskStats |
Example : |
< DiskIOStats > array |
poolStats |
Example : |
< PoolStatistics > array |
applicationStats |
Example : |
< ApplicationStatistics > array |
workloadStats |
Example : |
< WorkloadStatistics > array |
4.345. StorageSystemControllerStats
Controller statistics.
Name | Description | Schema |
---|---|---|
controllerId |
Controller id. |
string |
cpuUtilizationStats |
CPU utilization statistics. |
< CpuUtilizationStats > array |
4.346. StorageSystemStats
Storage system performance statistics.
Name | Description | Schema |
---|---|---|
observedTime |
End time for this collection as measured by the number of seconds since baseTime. |
string (date-time) |
observedTimeInMS |
Example : |
string (int64) |
lastResetTime |
Example : |
string (date-time) |
lastResetTimeInMS |
Example : |
string (int64) |
arrayId |
Example : |
string |
arrayWwn |
Example : |
string |
memberIdsHash |
Hash of member controller ids. |
string |
controllerStats |
Statistics for each controller. |
< StorageSystemControllerStats > array |
totalIopsServiced |
Total number of IO operations serviced by the controller. |
number (double) |
totalBytesServiced |
Total number of Bytes serviced by the controller. |
number (double) |
cacheHitsIopsTotal |
Total number of IO operations that hit cache. |
number (double) |
cacheHitsBytesTotal |
Total number of bytes that hit cache. |
number (double) |
randomIosTotal |
Total number of IOs that are categorized as random. |
number (double) |
randomBytesTotal |
Total number of Bytes that are categorized as random. |
number (double) |
readIopsTotal |
Total number of Read IO operations. |
number (double) |
readBytesTotal |
Total number of Bytes read. |
number (double) |
writeIopsTotal |
Total number of Write IO operations. |
number (double) |
writeBytesTotal |
Total number of Bytes written. |
number (double) |
mirrorIopsTotal |
Total number of IO operations serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value. |
number (double) |
mirrorBytesTotal |
Total number of Bytes serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value. |
number (double) |
fullStripeWritesBytes |
Bytes written that are categorized as Full stripe writes. |
number (double) |
raid0BytesTransferred |
Bytes transferred that are categorized as RAID 0 transfers. |
number (double) |
raid1BytesTransferred |
Bytes transferred that are categorized as RAID 1 transfers. |
number (double) |
raid5BytesTransferred |
Bytes transferred that are categorized as RAID 5 transfers. |
number (double) |
raid6BytesTransferred |
Bytes transferred that are categorized as RAID 6 transfers. |
number (double) |
ddpBytesTransferred |
Bytes transferred that are categorized as DDP transfers. |
number (double) |
maxPossibleBpsUnderCurrentLoad |
Theoretical maximum possible Bytes per second under current load. |
number (double) |
maxPossibleIopsUnderCurrentLoad |
Theoretical maximum possible IO per second under current load. |
number (double) |
4.347. VolumeIOStats
A single Volume I/O performance statistics. Note: the DELETE method clears all statistics for all volumes.
Name | Description | Schema |
---|---|---|
observedTime |
End time for this collection as measured by the number of seconds since baseTime. |
string (date-time) |
observedTimeInMS |
Example : |
string (int64) |
lastResetTime |
Example : |
string (date-time) |
lastResetTimeInMS |
Example : |
string (int64) |
volumeGroupId |
Example : |
string |
controllerId |
Example : |
string |
volumeId |
Example : |
string |
arrayId |
Example : |
string |
arrayWwn |
Example : |
string |
volumeGroupWwn |
Example : |
string |
volumeName |
Example : |
string |
volumeWwn |
Example : |
string |
workloadId |
The associated workload id |
string |
readOps |
Example : |
number (double) |
readHitOps |
Number of read operations that hit cache |
number (double) |
readHitBytes |
Number of bytes read from cache |
number (double) |
readTimeTotal |
Example : |
number (double) |
readHitTimeTotal |
Example : |
number (double) |
writeOps |
Example : |
number (double) |
writeCacheHitOps |
A redundant field to write Hit Ops |
number (double) |
writeTimeTotal |
Example : |
number (double) |
writeHitTimeTotal |
Example : |
number (double) |
errRedundancyChkIndeterminateReads |
Example : |
number (double) |
errRedundancyChkRecoveredReads |
Example : |
number (double) |
errRedundancyChkUnrecoveredReads |
Example : |
number (double) |
idleTime |
Example : |
number (double) |
otherOps |
Example : |
number (double) |
otherTimeMax |
Example : |
number (double) |
otherTimeTotal |
Example : |
number (double) |
otherTimeTotalSq |
Example : |
number (double) |
readBytes |
Example : |
number (double) |
readHitTimeMax |
Example : |
number (double) |
readHitTimeTotalSq |
Example : |
number (double) |
readTimeMax |
Example : |
number (double) |
readTimeTotalSq |
Example : |
number (double) |
writeBytes |
Example : |
number (double) |
writeHitBytes |
Number of bytes written to cache |
number (double) |
writeHitOps |
Number of write operations that hit cache |
number (double) |
writeHitTimeMax |
Example : |
number (double) |
writeHitTimeTotalSq |
Example : |
number (double) |
writeTimeMax |
Example : |
number (double) |
writeTimeTotalSq |
Example : |
number (double) |
queueDepthTotal |
Total channel queue depth. |
number (double) |
queueDepthMax |
Maximum channel queue depth. |
number (double) |
randomIosTotal |
Example : |
number (double) |
randomBytesTotal |
Example : |
number (double) |
cacheWriteWaitHitIops |
Example : |
number (double) |
cacheWriteWaitHitBytes |
Example : |
number (double) |
fullStripeWriteBytes |
Storage-systems running a firmware version prior to 08.40.+ / 11.40.+ will have this field represent the number of stripes that use a full stripe write algorithm. storage-systems running a firmware version greater than or equal to 08.40.+ / 11.40.+ will have this field represent the number bytes that are written in a full stripe write algorithm. |
number (double) |
totalIosShipped |
Example : |
number (double) |
totalBlksEvicted |
Example : |
number (double) |
cacheBlksInUse |
Example : |
number (double) |
prefetchHitBytes |
The number of pre-fetched bytes that are ultimately read by the host |
number (double) |
prefetchMissBytes |
The number of pre-fetched bytes that are evicted from cache without being read by the host. |
string (int64) |
flashCacheReadHitOps |
The number of flash cache read hit operations. |
number (double) |
flashCacheReadHitBytes |
The number of flash cache read hit bytes. |
number (double) |
flashCacheReadHitTimeTotal |
The sum of all response times for all reads that have cache hits, in microseconds |
number (double) |
flashCacheReadHitTimeMax |
Maximum I/O time in microseconds for any one read I/O that has a cache hit |
number (double) |
flashCacheReadHitTimeTotalSq |
The sum of the squares of the response times for all reads that have cache hits, in microseconds (used for standard deviation). |
number (double) |
4.348. WorkloadStatistics
Aggregation of volume statistics for a workload.
Name | Description | Schema |
---|---|---|
observedTime |
End time for this collection as measured by the number of seconds since baseTime. |
string (date-time) |
observedTimeInMS |
Example : |
string (int64) |
lastResetTime |
Example : |
string (date-time) |
lastResetTimeInMS |
Example : |
string (int64) |
arrayId |
Example : |
string |
arrayWwn |
Example : |
string |
memberIdsHash |
Hash of member volume ids. |
string |
readOps |
Number of read operations |
number (double) |
readHitOps |
Number of read operations that hit cache |
number (double) |
readHitBytes |
Number of bytes read from cache |
number (double) |
readTimeTotal |
Example : |
number (double) |
readHitTimeTotal |
Example : |
number (double) |
writeOps |
Number of write operations |
number (double) |
writeTimeTotal |
Example : |
number (double) |
writeHitTimeTotal |
Example : |
number (double) |
errRedundancyChkIndeterminateReads |
Example : |
number (double) |
errRedundancyChkRecoveredReads |
Example : |
number (double) |
errRedundancyChkUnrecoveredReads |
Example : |
number (double) |
idleTime |
Example : |
number (double) |
otherOps |
Example : |
number (double) |
otherTimeMax |
Example : |
number (double) |
otherTimeTotal |
Example : |
number (double) |
readBytes |
Example : |
number (double) |
readHitTimeMax |
Example : |
number (double) |
readTimeMax |
Example : |
number (double) |
writeBytes |
Example : |
number (double) |
writeHitBytes |
Number of bytes written to cache |
number (double) |
writeHitOps |
Number of write operations that hit cache |
number (double) |
writeHitTimeMax |
Example : |
number (double) |
writeTimeMax |
Example : |
number (double) |
queueDepthTotal |
Total channel queue depth. |
number (double) |
queueDepthMax |
Maximum channel queue depth. |
number (double) |
flashCacheReadHitOps |
The number of flash cache read hit operations. |
number (double) |
flashCacheReadHitBytes |
The number of flash cache read hit bytes. |
number (double) |
flashCacheReadHitTimeTotal |
The sum of all response times for all reads that have cache hits, in microseconds |
number (double) |
flashCacheReadHitTimeMax |
Maximum I/O time in microseconds for any one read I/O that has a cache hit |
number (double) |
workloadId |
he workload id of the collection |
string |
4.349. AverageAnalysedApplicationStats
The statistics for a volume averaged over a time range.
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
latencyRead |
Lantency in milliseconds |
|
latencyWrite |
Latency in milliseconds |
|
iopsRead |
Example : |
|
iopsWrite |
Example : |
|
throughputRead |
Read throughput in B/s |
|
throughputWrite |
Write throughput in B/s |
|
primaryCacheReadHitPct |
Example : |
|
primaryCacheWriteHitPct |
Example : |
|
ssdCacheReadHitPct |
Example : |
4.350. AverageAnalysedControllerStats
Controller statistics averaged over a time range.
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
iopsRead |
Example : |
|
iopsWrite |
Example : |
|
throughputRead |
Read throughput in B/s |
|
throughputWrite |
Write throughput in B/s |
|
cpuUtilization |
Example : |
|
headroomPct |
Performance headroom percentage |
4.351. AverageAnalysedDriveStats
The statistics for a drive averaged over a time range.
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
latencyRead |
Latency in milliseconds |
|
latencyWrite |
Latency in milliseconds |
|
iopsRead |
Example : |
|
iopsWrite |
Example : |
|
throughputRead |
Read throughput in B/s |
|
throughputWrite |
Write throughput in B/s |
4.352. AverageAnalysedInterfaceStats
The statistics for an interface averaged over a time range.
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
latencyRead |
Latency in milliseconds |
|
latencyWrite |
Latency in milliseconds |
|
iopsRead |
Example : |
|
iopsWrite |
Example : |
|
throughputRead |
Read throughput in B/s |
|
throughputWrite |
Write throughput in B/s |
|
headroomPct |
Performance headroom percentage |
4.353. AverageAnalysedPoolStats
The statistics for a volume averaged over a time range.
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
latencyRead |
Lantency in milliseconds |
|
latencyWrite |
Latency in milliseconds |
|
iopsRead |
Example : |
|
iopsWrite |
Example : |
|
throughputRead |
Read throughput in B/s |
|
throughputWrite |
Write throughput in B/s |
|
primaryCacheReadHitPct |
Example : |
|
primaryCacheWriteHitPct |
Example : |
|
ssdCacheReadHitPct |
Example : |
4.354. AverageAnalysedStatsResponse
The collection of statistics averaged over a time range.
Name | Description | Schema |
---|---|---|
volumeStats |
Example : |
< AverageAnalysedVolumeStats > array |
diskStats |
Example : |
< AverageAnalysedDriveStats > array |
controllerStats |
Example : |
< AverageAnalysedControllerStats > array |
interfaceStats |
Example : |
< AverageAnalysedInterfaceStats > array |
systemStats |
Example : |
< AverageAnalysedSystemStats > array |
poolStats |
Example : |
< AverageAnalysedPoolStats > array |
workloadStats |
Example : |
< AverageAnalysedWorkloadStats > array |
applicationStats |
Example : |
< AverageAnalysedApplicationStats > array |
4.355. AverageAnalysedSystemControllerStats
The statistics for a controller averaged over a time range.
Name | Description | Schema |
---|---|---|
controllerId |
Example : |
string |
cpuUtilization |
Example : |
4.356. AverageAnalysedSystemStats
The statistics for a storage system averaged over a time range.
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
iopsRead |
Example : |
|
iopsWrite |
Example : |
|
throughputRead |
Read throughput in B/s |
|
throughputWrite |
Write throughput in B/s |
|
controllerStats |
Example : |
< AverageAnalysedSystemControllerStats > array |
4.357. AverageAnalysedValue
Statistics data averaged over a time range.
Name | Description | Schema |
---|---|---|
min |
Example : |
number (double) |
max |
Example : |
number (double) |
std |
Example : |
number (double) |
value |
Example : |
number (double) |
4.358. AverageAnalysedVolumeStats
The statistics for a volume averaged over a time range.
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
latencyRead |
Lantency in milliseconds |
|
latencyWrite |
Latency in milliseconds |
|
iopsRead |
Example : |
|
iopsWrite |
Example : |
|
throughputRead |
Read throughput in B/s |
|
throughputWrite |
Write throughput in B/s |
|
primaryCacheReadHitPct |
Example : |
|
primaryCacheWriteHitPct |
Example : |
|
ssdCacheReadHitPct |
Example : |
4.359. AverageAnalysedWorkloadStats
The statistics for a volume averaged over a time range.
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
latencyRead |
Lantency in milliseconds |
|
latencyWrite |
Latency in milliseconds |
|
iopsRead |
Example : |
|
iopsWrite |
Example : |
|
throughputRead |
Read throughput in B/s |
|
throughputWrite |
Write throughput in B/s |
|
primaryCacheReadHitPct |
Example : |
|
primaryCacheWriteHitPct |
Example : |
|
ssdCacheReadHitPct |
Example : |
4.360. IdentificationRequest
Name | Description | Schema |
---|---|---|
channels |
A list of channel ids. There must be an expansion drive tray attached to identify a channel. |
< integer (int32) > array |
trays |
A list of tray ids. |
< string > array |
drives |
A list of drive ids. |
< string > array |
pools |
A list of storage pool ids. Associated, optimal drives will be identified. |
< string > array |
volumes |
A list of volume ids. Associated, optimal drives will be identified. |
< string > array |
storageSystem |
Set to "true" to identify the StorageSystem. |
boolean |
4.361. CommandProtocolPropertiesList
Name | Description | Schema |
---|---|---|
commandProtocolProperties |
This describes a list of command protocol properties. |
< CommandProtocolProperties > array |
4.362. IoInterface
Name | Description | Schema |
---|---|---|
interfaceRef |
The SYMbol array-wide unique name for the interface object. |
string |
channelType |
The type of channel (e.g., host-side, drive-side) that the interface is associated with. |
enum (hostside, driveside, management, __UNDEFINED) |
ioInterfaceTypeData |
A field whose contents vary depending on the I/O protocol type of the interface. |
|
controllerRef |
Uniquely identifies a particular physical RAID controller within the storage array. |
string |
commandProtocolPropertiesList |
The list of properties that describe the command protocol. |
4.363. IscsiEntityResponse
Provides information about the storage array in its role as "iSCSI entity."
Name | Description | Schema |
---|---|---|
icmpPingResponseEnabled |
Example : |
boolean |
unnamedDiscoverySessionsEnabled |
Example : |
boolean |
isnsServerTcpListenPort |
Example : |
integer (int32) |
ipv4IsnsServerAddress |
Example : |
string |
ipv6IsnsServerAddress |
Example : |
string |
isnsServerRegistrationEnabled |
Example : |
boolean |
hostPortsConfiguredDHCP |
Example : |
boolean |
ipv4IsnsServerAddressConfigMethod |
Example : |
enum (configDhcp, configStatic, __UNDEFINED) |
ipv6IsnsServerAddressConfigMethod |
Example : |
enum (configStatic, configStateless, __UNDEFINED) |
isnsRegistrationState |
Example : |
enum (disabled, locatingServer, connectingToServer, completed, __UNDEFINED) |
4.364. IscsiEntityUpdateRequest
Updates the iSCSI entity data.
Name | Description | Schema |
---|---|---|
icmpPingResponseEnabled |
The setting for enabling or disabling the ICMP (Internet Control Message Protocol) ping messages. |
boolean |
unnamedDiscoverySessionsEnabled |
The setting for enabling or disabling unnamed discovery sessions. |
boolean |
isnsServerTcpListenPort |
The number of the TCP port on which the iSNS server listens for incoming connections. |
integer (int32) |
ipv4IsnsServerAddressConfigMethod |
The IPV4 configuration method to use for determining the IP address of the iSNS server. Whenever there is a transition of the configuration method from IPV4_CONFIG_STATIC to IPV4_CONFIG_DHCP, the storage array performs the equivalent of a refreshIsnsServerLocation operation. |
enum (configDhcp, configStatic, __UNDEFINED) |
ipv4IsnsServerAddress |
The IPV4 configuration method to use for determining the IP address of the iSNS server. Whenever there is a transition of the configuration method from IPV4_CONFIG_STATIC to IPV4_CONFIG_DHCP, the storage array performs the equivalent of a refreshIsnsServerLocation operation. |
string |
ipv6IsnsServerAddress |
The IPV6 address of the iSNS server. |
string |
isnsServerRegistrationEnabled |
The setting is for enabling or disabling storage array registration with the iSNS server. |
boolean |
4.365. Target
Name | Description | Schema |
---|---|---|
targetRef |
The reference that uniquely identifies an instance of this object. |
string |
nodeName |
The unique node name associated with the target. |
|
alias |
An additional name that can be assigned to a target, which is usually "friendlier" than the node name. |
|
configuredAuthMethods |
The authentication methods that have been configured for the target. Associated secrets are not exposed. instead the type field of the EncryptedPassword is set to ENCRYPT_UNSPECIFIED. |
|
portals |
The set of configured (i.e., either in-use or listening for connections) portals associated with this target. |
< TargetPortal > array |
4.366. IscsiTargetResponse
Provides information for the iSCSI target.
Name | Description | Schema |
---|---|---|
authMethod |
Authentication type (None or CHAP) |
enum (none, chap, __UNDEFINED) |
chapSecret |
CHAP secret/password. |
string |
iqn |
iSCSI Qualified Name (iqn) |
string |
alias |
The iSCSI target alias. |
string |
4.367. IscsiTargetUpdateRequest
Updates the iSCSI target data.
Name | Description | Schema |
---|---|---|
alias |
The iSCSI target alias. |
string |
enableChapAuthentication |
Enable Challenge-Handshake Authentication Protocol (CHAP), defaults to false. |
boolean |
chapSecret |
Enable Challenge-Handshake Authentication Protocol (CHAP) using the provided password. A secure password will be generated and returned if CHAP is enabled and this field is not provided. |
string |
4.368. RolePermissionData
Role permissions for an endpoint.
Name | Description | Schema |
---|---|---|
httpMethod |
HTTP method |
string |
endpoint |
Endpoint path |
string |
roles |
List of roles allowed to access this endpoint |
< string > array |
4.369. RolesResponse
API response object that includes current user roles and list of role permissions.
Name | Description | Schema |
---|---|---|
userRoles |
Current user roles |
< string > array |
endpoints |
List of endpoints and their role permissions |
< RolePermissionData > array |
4.370. BindLookupUser
Name | Description | Schema |
---|---|---|
password |
The password for the bind user |
string |
user |
The full DN for the bind user account |
string |
4.371. GroupMapping
Name | Description | Schema |
---|---|---|
groupRegex |
specifies the DN of the group. The wildcard .* can optionally be used to allow specifying only a partial DN. |
string |
ignorecase |
Whether or not to ignore case for the group mappings |
boolean |
name |
Specifies the role of the group |
enum (security_admin, storage_none, support_admin, storage_monitor, storage_admin) |
4.372. LdapDomain
Structure that contains information about an LDAP Domain
Name | Description | Schema |
---|---|---|
id |
Unique ID linked to this domain |
string |
bindLookupUser |
If needed, you can configure a specific user to use when looking up the group membership for users. Typically, you would configure this whenever regular users might lack reader permissions to view their own group membership. The bind user information must be specified as a full DN. |
|
groupAttributes |
A list of group attributes on the user that will be searched to for group to role mapping |
< string > array |
ldapUrl |
The LDAP URL entry must be specified as either ldap or ldaps protocol and contain the IP address. In addition, the port for the LDAP URL must be specified (typically 389 for ldap and 636 for ldaps). |
string |
names |
Each domain will have one or multiple names and it is presumed the name will match the DNS domain for the LDAP server but it is not required. Domains can be named anything as long as they are valid DNS names. |
< string > array |
roleMapCollection |
A list of regular expression patterns to match to the user’s group attributes to match to roles. |
< GroupMapping > array |
searchBase |
The search base is used to find group memberships of the user. The search base is the DN in the directory of a container object of users. The filter base is used to find the user object within this container. After the user object is located, any associated group membership is identified. |
string |
userAttribute |
The user attribute is used match the username supplied to an object on the server |
string |
4.373. LdapConfiguration
Structure that contains information about an LDAP Configuration
Name | Description | Schema |
---|---|---|
ldapDomains |
The defined LDAP domains |
< LdapDomain > array |
4.374. LdapRequest
Request to update the LDAP configuration.
Name | Description | Schema |
---|---|---|
ldapDomains |
The LDAP domain configurations. |
< LdapDomain > array |
4.375. LdapDomainTestResponse
Result of a test against an LDAP domain
Name | Description | Schema |
---|---|---|
id |
ID of the configured domain |
string |
result |
Example : |
4.376. LdapDomainTestResponseResults
Result of a test against an LDAP domain
Name | Description | Schema |
---|---|---|
connectionTestResult |
Results of the connection test |
enum (ok, failed, notRun) |
authenticationTestResult |
Results of the authentication test |
enum (ok, failed, notRun) |
searchTestResult |
Results of the search test |
enum (ok, failed, notRun) |
4.377. RepositoryUtilization
Name | Description | Schema |
---|---|---|
repositoryUsage |
This field contains the number of bytes used in the repository. |
string (int64) |
snapRef |
The snapshot volume to which this utilization refers. |
string |
4.378. LegacySnapshotEx
Name | Description | Schema |
---|---|---|
worldWideName |
The World Wide Name of the snapshot. |
string |
snapshotRef |
Reference (key) for the snapshot volume. |
string |
label |
Name of the snapshot. |
string |
status |
Indicates status of the snapshot. |
enum (active, failed, disabled, offline, __UNDEFINED) |
action |
Long running action. |
enum (none, rollback, __UNDEFINED) |
currentManager |
Current owner of the snapshot. |
string |
baseVolume |
Base volume for this snapshot. |
string |
repositoryVolume |
Repository volume for this snapshot. |
string |
fullWarnThreshold |
Repository utilization warning threshold. |
integer (int32) |
overWarnThreshold |
True if the repository utilization is over the warning threshold. |
boolean |
repositoryFull |
True, if the repository is full. |
boolean |
repFullPolicy |
Indication of the volume behavior when the repository is full. |
enum (failwrites, failsnap, __UNDEFINED) |
rollbackPriority |
The importance of the rollback operation (0-4). Not used in this release of software. |
integer (int32) |
extentStart |
The start position of the extent in the base volume (bytes). Not used in this release of software. |
string (int64) |
extentSize |
The size of the extent in bytes. Not used in this release of software. |
string (int64) |
snapshotTime |
The controller time when the snapshot was created. |
string (int64) |
perms |
Permissions allowed on volume. |
|
childrenInactive |
True if all child volumes are offline or failed. Child volumes are the base volume and the REPOSITORY volume. |
boolean |
volumeHandle |
Volume SSID. |
integer (int32) |
mgmtClientAttribute |
For use by management client. |
integer (int32) |
rollbackStatus |
Status of current action being performed on snapshot. |
enum (none, inProgress, pending, paused, __UNDEFINED) |
baseVolumeSizeInBytes |
Example : |
string (int64) |
totalSizeInBytes |
Example : |
string (int64) |
preferredControllerId |
Example : |
string |
repositoryCapacity |
Example : |
string (int64) |
volumeCopyTarget |
Example : |
boolean |
volumeCopySource |
Example : |
boolean |
pitBaseVolume |
Example : |
boolean |
asyncMirrorTarget |
True if the volume is a target in an Asynchronous Mirror relationship. |
boolean |
asyncMirrorSource |
True if the volume is a source in an Asynchronous Mirror relationship. |
boolean |
protectionType |
Example : |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
remoteMirrorSource |
True if the volume is a source (primary), in an Remote Volume Mirror relationship. |
boolean |
remoteMirrorTarget |
True if the volume is a target (secondary), in an Remote Volume Mirror relationship. |
boolean |
objectType |
Example : |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
currentControllerId |
Example : |
string |
wwn |
Example : |
string |
listOfMappings |
Example : |
< LUNMapping > array |
mapped |
Example : |
boolean |
onlineVolumeCopy |
Example : |
boolean |
name |
Example : |
string |
id |
Example : |
string |
4.379. LegacySnapshotCreateRequest
Creates a legacy Snapshot (non-PiT).
Name | Description | Schema |
---|---|---|
baseVolumeId |
The identifier of the volume or thin volume for the new snapshot group. |
string |
name |
The name of the new snapshot. |
string |
repositoryPercentage |
Size of the snapshot repository in relation to the base volume capacity |
number (double) |
warningThreshold |
Warn the user when the repository is % full. |
integer (int32) |
fullPolicy |
The behavior on when the data repository becomes full. |
enum (failwrites, failsnap, __UNDEFINED) |
storagePoolId |
The identifier of the storage pool to allocate the repository volume. |
string |
4.380. LegacySnapshotUpdateRequest
Updates the legacy Snapshot (non-PiT) data.
Name | Description | Schema |
---|---|---|
warningThreshold |
Warn the user when the repository is % full. |
integer (int32) |
fullPolicy |
The behavior on when the data repository becomes full. |
enum (failwrites, failsnap, __UNDEFINED) |
newName |
New name for the snapshot. |
string |
recreateSnapshot |
Recreate the snapshot. |
boolean |
4.381. LocalizedLogMessage
Name | Description | Schema |
---|---|---|
loggerType |
Logger type of this message |
enum (cfwUpgradeLogger, driveUpgradeLogger, iomServiceLogger, nvsramUpgradeLogger, cfwUpgradeTimestamp, driveUpgradeTimestamp, iomServiceTimestamp, nvsramUpgradeTimestamp, batchLogger, systemReplLogger, systemConfigLogger, auditLogLogger) |
timestamp |
Timestamp for this log message |
string (date-time) |
messageText |
Localized message text |
string |
context |
Log message context |
string |
recordId |
ReplicatedRecord ID for this message |
string (int64) |
4.382. LoggerRecordResponse
Name | Description | Schema |
---|---|---|
recordType |
Type of log records returned |
enum (cfwUpgradeLogger, driveUpgradeLogger, iomServiceLogger, nvsramUpgradeLogger, cfwUpgradeTimestamp, driveUpgradeTimestamp, iomServiceTimestamp, nvsramUpgradeTimestamp, batchLogger, systemReplLogger, systemConfigLogger, auditLogLogger) |
logRecords |
A Map of log records requested |
< LocalizedLogMessage > array |
timeStamps |
A Map of timestamps for each logger type |
< string, string (date-time) > map |
4.383. LockdownStatusResponse
API response object that includes lockdown status of the system.
Name | Description | Schema |
---|---|---|
isLockdown |
True if the storage system is in lockdown mode |
boolean |
storageSystemLabel |
Storage system label provided by the user |
string |
lockdownType |
Type of the storage systemLockdown |
string |
4.384. MappableObject
Name | Description | Schema |
---|---|---|
objectType |
Example : |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
currentControllerId |
Example : |
string |
wwn |
Example : |
string |
listOfMappings |
Example : |
< LUNMapping > array |
mapped |
Example : |
boolean |
totalSizeInBytes |
Example : |
string (int64) |
preferredControllerId |
Example : |
string |
name |
Example : |
string |
id |
Example : |
string |
4.385. CacheBackupDeviceLocation
Name | Description | Schema |
---|---|---|
controllerTray |
The tray ID of the controller that houses the cache backup device. |
integer (int32) |
controllerSlot |
The slot number of the controller that houses the cache backup device. |
integer (int32) |
cacheBackupDeviceSlot |
The number of the slot on the controller in which the cache backup device resides. |
integer (int32) |
4.386. CacheMemoryDimmLocation
Name | Description | Schema |
---|---|---|
controllerTray |
The tray ID of the controller where the DIMM is installed. |
integer (int32) |
controllerSlot |
The slot number of the controller where the DIMM is installed. |
integer (int32) |
cacheMemoryDimmControllerSlot |
The number of the slot on the controller where the cache memory DIMM is installed. Cache memory DIMM slots are numbered starting at one, independent of other types of slots (e.g., cache backup device slots) on the controller. |
integer (int32) |
4.387. ChannelLocation
Name | Description | Schema |
---|---|---|
channelType |
The channel type. |
enum (hostside, driveside, management, __UNDEFINED) |
index |
The channel location. |
integer (int32) |
controllerSlot |
Controller number 1 if in top slot. Controller number 2 if in bottom slot. |
integer (int32) |
4.388. ComponentLocation
Name | Description | Schema |
---|---|---|
eventComponentType |
This enumeration object is used to specify the different component types that can be associated with entries in the Major Event Log. |
enum (unknown, drive, powerSply, fan, minihub, tempSensor, channel, esm, controller, battery, enclosure, ups, chip, volume, volumeGrp, portCru, interconnectCru, supportCru, alarm, channelPort, sfpPort, hostBoard, newFormat, ctlrSfp, ctlrSoc, initiator, target, isnsServer, hostIoCard, cacheBackupDevice, cacheMemDimm, host, hostPort, drawer, relative, schedule, asyncMirrorGroup, diskPool, pit, pitConsistencyGroup, cgpit, cgview, flashCache, snmpCommunity, snmpTrapDestination, fcTarget, blankOne, blankTwo, fanOnlyCru, psuCru, nvmeInitiator, __UNDEFINED) |
alarmLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_ALARM. |
|
batteryTray |
The tray ID of the tray containing the battery for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_BATTERY. |
integer (int32) |
cacheBackupDeviceLocation |
This field is valid only when the eventComponentType value is equal toEVENT_COMP_TYPE_CACHE_BACKUP_DEVICE. It identifies the location of the cache backup device to which the event applies. |
|
cacheMemoryDimmLocation |
This field is only valid when the eventComponentType value is equal to EVENT_COMP_TYPE_CACHE_MEM_DIMM. It identifies the location of the cache memory DIMM to which the event applies. |
|
channelLoc |
The location of the channel. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CHANNEL. |
|
channelPort |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CHANNEL_PORT. |
integer (int32) |
chipLoc |
The physical location of the controller that owns the chip for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CHIP. |
|
controllerLoc |
The physical location of the controller for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CONTROLLER. |
|
ctlrSfpLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CTLR_SFP. |
|
socLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CTLR_SOC. |
|
driveLoc |
The physical location of the drive for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_DRIVE. |
|
enclosureTray |
The tray ID of the tray for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_ENCLOSURE. |
integer (int32) |
esmTray |
The tray ID of the tray containing the ESM card for which the MEL entry was generated. This field is not used and is considered deprecated. Instead the ESM tray/slot location is given by the ExtendedComponentLocation field. |
integer (int32) |
fanTray |
The tray ID of the tray containing the fan for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_FAN. |
integer (int32) |
hostIoCardLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_HOST_IO_CARD. It identifies the location of the host I/O card to which the event applies. |
|
initiatorLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_INITIATOR. It identifies the iSCSI initiator to which the event applies. |
|
interconnectCruLocation |
No information is returned |
|
isnsServerLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_ISNS_SERVER. It identifies the iSNS server to which the event applies. |
|
minihubLoc |
The location of the minihub. This filed is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_MINIHUB. |
|
portCruTray |
The tray ID of the tray containing the Fibre Channel port CRU for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_PORT_CRU. This field is deprecated. |
integer (int32) |
powerSupplyTray |
The tray ID of the tray containing the power supply for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_POWER_SPLY. |
integer (int32) |
sfpLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_SFP_PORT. |
|
supportCruLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_SUPPORT_CRU. |
|
targetLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_TARGET. It identifies the iSCSI target to which the event applies. |
|
tempSensorTray |
The tray ID of the tray containing the temperature sensor for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_TEMP_SENSOR. |
integer (int32) |
label |
The user-assigned label of the volume for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_VOLUME |
string |
groupNumber |
The volume group sequence number of the volume group for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_VOLUME_GRP. |
integer (int32) |
hostLocation |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_HOST. It is the user-assigned label of the host for which the MEL entry is reporting a problem. |
string |
hostPortLocation |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_HOST_PORT. It identifies the host port to which the event applies. |
|
drawerLocation |
The physical location of the drawer for which the MEL event was generated. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_DRAWER. |
|
componentRelativeLocation |
The component type and location are described in this field. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_RELATIVE. |
|
schedule |
The user-assigned label of the schedule. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_SCHEDULE. |
string |
diskPool |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_DISK_POOL. |
integer (int32) |
asyncMirrorGroup |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_ASYNC_MIRROR_GROUP. |
string |
pitLabel |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_PIT. Note that events for PITs also include extended component location information beyond just the associated PiT Group label (PITs themselves are identified by a combination of the label of the associated PiT Group plus a sequence number). |
string |
cgLabel |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_PIT_CONSISTENCY_GROUP. |
string |
cgPitLabel |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_CGPIT. Note that events for CGPITs also include extended component location information beyond just the associated CG label (CGPITs themselves are identified by a combination of the label of the associated Consistency Group plus a sequence number). |
string |
cgViewLabel |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_CGVIEW. |
string |
flashCacheLabel |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_FLASH_CACHE. It identifies the flash cache device to which this event applies. |
string |
communityNameString |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_SNMP_COMMUNITY. The community name string can contain up to 31 characters. |
string |
destinationIpAddress |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_SNMP_TRAP_DESTINATION. It contains an ASCII representation of the destination address (the maximum number of characters is 40 for IPV6, 15 characters for IPV4. |
string |
fcTargetLocation |
This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_FC_TARGET. It contains location data that is an 8-byte binary SCSI name. |
|
fanCruLocation |
Location information for fan CRU. |
|
powerSupplyCruLocation |
Power supply CRU location. |
|
nvmeInitiatorLocation |
This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_NVME_INITIATOR. It identifies the NVMe initiator to which the event applies. |
4.389. ComponentRelativeLocation
Name | Description | Schema |
---|---|---|
componentType |
The type of component. |
enum (unknown, drive, powerSply, fan, minihub, tempSensor, channel, esm, controller, battery, enclosure, ups, chip, volume, volumeGrp, portCru, interconnectCru, supportCru, alarm, channelPort, sfpPort, hostBoard, newFormat, ctlrSfp, ctlrSoc, initiator, target, isnsServer, hostIoCard, cacheBackupDevice, cacheMemDimm, host, hostPort, drawer, relative, schedule, asyncMirrorGroup, diskPool, pit, pitConsistencyGroup, cgpit, cgview, flashCache, snmpCommunity, snmpTrapDestination, fcTarget, blankOne, blankTwo, fanOnlyCru, psuCru, nvmeInitiator, __UNDEFINED) |
trayId |
The tray ID of the tray containing the component. |
integer (int32) |
relativePosition |
The relative position within the component’s parent. |
integer (int32) |
parentSize |
The size of the parent array that follows. |
integer (int32) |
parent |
This is an array containing additional parent-relative location information. The first element in the array will contain the parent’s component type and its relative position within it’s parent. |
< ParentRelativeLocation > array |
componentLabel |
Contains the label of the component. |
string |
4.390. ControllerSfpLocation
Name | Description | Schema |
---|---|---|
channelType |
The channel type. |
enum (hostside, driveside, management, __UNDEFINED) |
channel |
The channel type. |
integer (int32) |
sfpPort |
The number of the SFP port on the channel, 1-based. |
integer (int32) |
controllerSlot |
The slot number of the controller, 1 or 2 |
integer (int32) |
4.391. EventControl
Name | Description | Schema |
---|---|---|
oemPriority |
If this value if equal to EVENT_DEFAULT_PRIORITY then the management client should use the priority value from the MelEntry structure when filtering events for display, otherwise this value should be used. |
enum (priorityDefault, priorityCritical, priorityInfo, priorityEmergency, priorityAlert, priorityError, priorityWarning, priorityNotice, priorityDebug, __UNDEFINED) |
defaultNeedsAttention |
This is the default value for needs attention. Its value can be overridden by oemNeedsAttention. |
boolean |
defaultSendAlert |
This is the default value for sending an alert. Its value can be overridden by oemSendAlert. |
boolean |
defaultVisibility |
This is the default value for visibility. Its value can be overridden by oemVisibility. |
boolean |
oemNeedsAttention |
If this value is equal to EVENT_CONTROL_ACCEPT_DEFAULT then the value of defaultNeedsAttention determines whether Needs Attention is set on the array. Otherwise, this field determines whether Needs Attention is set on the array. |
enum (unknown, acceptDefault, overrideToTrue, overrideToFalse, __UNDEFINED) |
oemSendAlert |
If this value is equal to EVENT_CONTROL_ACCEPT_DEFAULT then the value of defaultSendAlert determines whether an alert will be sent. Otherwise this field determines whether an alert will be sent. |
enum (unknown, acceptDefault, overrideToTrue, overrideToFalse, __UNDEFINED) |
oemVisibility |
If this value is equal to EVENT_CONTROL_ACCEPT_DEFAULT then the value of defaultVisibility determines whether the event will be displayed. Otherwise, this field determines whether the event will be displayed. |
enum (unknown, acceptDefault, overrideToTrue, overrideToFalse, __UNDEFINED) |
collectSupportBundle |
If this value is true, a support bundle will be collected. |
boolean |
priorityCaseCreationTrigger |
This flag indicates whether or not this MEL event should be marked as the reason a customer case was automatically created. It’s possible that multiple MEL events could be present in the MEL log that would trigger case creation. But the first MEL event in the log that has this flag set will be tagged as the event that caused the case to be created. |
boolean |
4.392. ExtendedComponentLocation
Name | Description | Schema |
---|---|---|
extLocType |
This enumeration object contains a list of all possible extended component location types that can be returned in a MEL entry. |
enum (unknown, tray, trayslot, minihub, channel, volume, pit, controller, ref, label, volumeGrp, diskPool, __UNDEFINED) |
compChannelLoc |
This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_CHANNEL. This field is deprecated. |
|
compMinihubLoc |
This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_MINIHUB. This field is deprecated. |
|
compTray |
This field is present only if the extLocType value is EXT_COMP_LOCTYPE_TRAY |
integer (int32) |
compTraySlot |
This field is present only if the extLocType value is EXT_COMP_LOCTYPE_TRAYSLOT |
|
compLabel |
This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_VOLUME. This field is deprecated. |
string |
pitSequence |
This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_PIT. |
string (int64) |
compReference |
SYMbolRef of the component or channelPort |
string |
controllerReference |
Controller Reference |
string |
locationLabel |
Label associated with the physical location of the component or port. |
string |
volumeGroupLabel |
This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_VOLUME_GRP. |
string |
diskPoolLabel |
This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_DISK_POOL. |
string |
4.393. FibreChannelTargetLocation
Name | Description | Schema |
---|---|---|
targetName |
The Fibre Channel node name of the target,a binary 8-byte SCSI name. |
string |
4.394. HostIoCardLocation
Name | Description | Schema |
---|---|---|
controllerTray |
The tray ID of the controller that houses the host card. |
integer (int32) |
controllerSlot |
The slot number of the controller that houses the host card. |
integer (int32) |
hostIoCardControllerSlot |
The number of the slot on the controller where the host I/O card (a.k.a., host board) resides. Host I/O card slots are numbered starting at one, independent of other types of slots (e.g., cache backup device slots) on the controller. |
integer (int32) |
4.395. InitiatorLocation
Name | Description | Schema |
---|---|---|
initiatorName |
The iSCSI node name of the initiator, left-truncated if necessary. (Left-truncation preserves the part of the name most likely to vary.) |
string |
4.396. IsnsServerLocation
Name | Description | Schema |
---|---|---|
ipAddress |
The IP address of the iSNS server. |
|
tcpListenPort |
The number of the TCP port on which the iSNS server listens for incoming connections. |
integer (int32) |
4.397. MelEntryEx
Name | Description | Schema |
---|---|---|
sequenceNumber |
The sequence number of the MEL entry. The controller maintains a unique, monotonically increasing 64-bit sequence number value and stamps each MEL entry with the next value of this counter. |
string (int64) |
eventType |
An integer value that indicates the specific type of event being reported. |
integer (int32) |
timeStamp |
The time at which the MEL entry was generated. This value is defined in terms of the number of seconds since midnight GMT on January 1, 1970. |
string (int64) |
category |
The category into which this event falls. This value identifies the general type of activity or event that occurred and caused the entry to be generated. |
enum (error, failure, command, notification, stateChange, hostEntry, general, __UNDEFINED) |
componentType |
The type of component that is associated with this entry. |
enum (unknown, drive, powerSply, fan, minihub, tempSensor, channel, esm, controller, battery, enclosure, ups, chip, volume, volumeGrp, portCru, interconnectCru, supportCru, alarm, channelPort, sfpPort, hostBoard, newFormat, ctlrSfp, ctlrSoc, initiator, target, isnsServer, hostIoCard, cacheBackupDevice, cacheMemDimm, host, hostPort, drawer, relative, schedule, asyncMirrorGroup, diskPool, pit, pitConsistencyGroup, cgpit, cgview, flashCache, snmpCommunity, snmpTrapDestination, fcTarget, blankOne, blankTwo, fanOnlyCru, psuCru, nvmeInitiator, __UNDEFINED) |
componentLocation |
The location, or other identifying value, of the component associated with this entry. |
|
locationValid |
A true/false indication of whether the ComponentLocation field is valid for this entry. |
boolean |
priority |
The priority code associated with this event. |
enum (priorityDefault, priorityCritical, priorityInfo, priorityEmergency, priorityAlert, priorityError, priorityWarning, priorityNotice, priorityDebug, __UNDEFINED) |
eventSourceController |
The controller that is the source of the event (Controller 1 or 2). |
integer (int32) |
senseKey |
The Sense Key value associated with this event, or zero if no key is applicable. |
integer (int32) |
rawData |
The raw data stored for this event. This information may be useful for debugging or troubleshooting problems with the assistance of a field support or development representative. |
string |
extComponentLocation |
Extended component location information for this entry. This data type of this field is a union with discriminator extLocType. If the discriminator is set to something other than EXT_COMP_LOCTYPE_UNKNOWN, then the location information in this field overrides what is in the componentLocation field. |
|
controlParams |
This field allows customized control over the handling of MEL events. |
|
description |
Example : |
string |
location |
Example : |
string |
critical |
Example : |
boolean |
id |
Example : |
string |
asc |
Example : |
integer (int32) |
ascq |
Example : |
integer (int32) |
4.398. MinihubLocation
Name | Description | Schema |
---|---|---|
minihubType |
Information returned is based on the minihub type. |
enum (hostside, driveside, __UNDEFINED) |
channel |
The channel number that this minihub is associated with. |
integer (int32) |
controllerSlot |
Controller number 1 if in top slot. Controller number 2 if in bottom slot. |
integer (int32) |
tray |
Tray ID number. This field is not used and is considered deprecated. |
integer (int32) |
4.399. ParentRelativeLocation
Name | Description | Schema |
---|---|---|
componentType |
The type of component. |
enum (unknown, drive, powerSply, fan, minihub, tempSensor, channel, esm, controller, battery, enclosure, ups, chip, volume, volumeGrp, portCru, interconnectCru, supportCru, alarm, channelPort, sfpPort, hostBoard, newFormat, ctlrSfp, ctlrSoc, initiator, target, isnsServer, hostIoCard, cacheBackupDevice, cacheMemDimm, host, hostPort, drawer, relative, schedule, asyncMirrorGroup, diskPool, pit, pitConsistencyGroup, cgpit, cgview, flashCache, snmpCommunity, snmpTrapDestination, fcTarget, blankOne, blankTwo, fanOnlyCru, psuCru, nvmeInitiator, __UNDEFINED) |
relativePosition |
The relative position within the component’s parent. |
integer (int32) |
4.400. SocLocation
Name | Description | Schema |
---|---|---|
channelType |
The channel type. |
enum (hostside, driveside, management, __UNDEFINED) |
channel |
The channel type. |
integer (int32) |
soc |
The SOC index, 0-based. |
integer (int32) |
port |
The port number, 1-based |
integer (int32) |
controllerSlot |
The controller slot number, 1 or 2 |
integer (int32) |
4.401. TargetLocation
Name | Description | Schema |
---|---|---|
targetName |
The iSCSI node name of the target, left-truncated if necessary. (Left-truncation preserves the part of the name most likely to vary.) |
string |
4.402. TraySlot
Name | Description | Schema |
---|---|---|
tray |
The tray ID of the tray in which the component resides. Note that a Tray ID of -1 means "the controller tray." |
integer (int32) |
slot |
The slot number, or ordinal identifier, of the component within its tray. |
integer (int32) |
4.403. MelExtent
Name | Description | Schema |
---|---|---|
startingSeqNum |
This is the sequence number of the entry at the low end of the extent. So, when this value is returned in getMelExtents, it is the sequence number of the first MEL event that can be returned in getMelEntries. When specified as an input to getMelEntries, it is the sequence number of the first MEL event to be returned. |
string (int64) |
endingSeqNum |
When this value is returned by getMelExtents, it is the sequence number that is one beyond the entry at the high end of the extent. For example, if the ending sequence number is 3232, then MEL entries up to sequence 3231 are retrievable. When this value is input to getMelEntries, it is the sequence number of the last MEL event to be returned. |
string (int64) |
4.404. NVMeoFEntityUpdateRequest
Name | Description | Schema |
---|---|---|
nvmeInterface |
Reference for the interface. |
string |
ipv4Address |
List of IPv4 addresses associated with the NVMe over Fabrics host interface. |
< string > array |
4.405. IbNetworkSettings
Name | Description | Schema |
---|---|---|
ipv4Address |
The IPv4 address. |
string |
4.406. IbSettings
Name | Description | Schema |
---|---|---|
networkSettings |
The Infinband interface network settings |
4.407. NvmeofInterfaceSettings
Name | Description | Schema |
---|---|---|
ibSettings |
The Infiniband settings |
|
roceV2Settings |
The RoCEV2 settings |
4.408. NvmeofInterfaceSettingsUpdateRequest
Name | Description | Schema |
---|---|---|
settings |
The NVMeoF interface settings. |
4.409. RoceV2Ipv4Settings
Name | Description | Schema |
---|---|---|
configurationMethod |
The IPv4 configuration method. |
enum (configDhcp, configStatic, __UNDEFINED) |
address |
The IPv4 address. |
string |
subnetMask |
The subnet mask. |
string |
gatewayAddress |
The gateway address. |
string |
4.410. RoceV2Ipv6Settings
Name | Description | Schema |
---|---|---|
configurationMethod |
The IPv6 configuration method. |
enum (configStatic, configStateless, __UNDEFINED) |
localAddresses |
The list of IPv6 local addresses |
< string > array |
routableAddresses |
The list of IPv6 routable addresses |
< string > array |
routerAddress |
The IPv6 router address |
string |
4.411. RoceV2NetworkSettings
Name | Description | Schema |
---|---|---|
interfaceSpeed |
The interface speed. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
interfaceMtu |
The interface Media Transport Unit (MTU). |
integer (int32) |
ipv4Enabled |
Determines whether IPv4 is enabled. |
boolean |
ipv4Settings |
The IPv4 network settings |
|
ipv6Enabled |
Determines whether IPv6 is enabled. |
boolean |
ipv6Settings |
The IPv6 network settings |
4.412. RoceV2Settings
Name | Description | Schema |
---|---|---|
networkSettings |
The RoCEV2 interface network settings |
4.413. AccessVolume
Name | Description | Schema |
---|---|---|
enabled |
True if the access volume feature (and thus the UTM command transfer capability) is enabled, or false if it is disabled. |
boolean |
volumeHandle |
An identifier value for the AccessVolume object. This will generally correspond to the logical unit number (LUN) that is used to access the volume for UTM protocol command transactions. |
integer (int32) |
capacity |
The (simulated) capacity of the AccessVolume maintained by the controller. Since there is essentially no true data storage capacity present for an AccessVolume, this value is used to determine the block addressing limit of the unit, which is an important aspect of the UTM command transfer protocol. |
string (int64) |
accessVolumeRef |
The identifier value for this AccessVolume. Other objects may use this reference value to refer to the AccessVolume. |
string |
reserved1 |
Example : |
string |
4.414. Alarm
Name | Description | Schema |
---|---|---|
alarmRef |
The reference for this physical alarm. |
string |
physicalLocation |
The location of the alarm. The parent reference in Location identifies the tray containing the alarm, and the position field is set to 1. |
|
status |
The operational status of the alarm. |
enum (unknown, enabled, disabled, sounding, muted, removed, __UNDEFINED) |
isManageable |
True if the alarm is manageable using the setAlarm procedure. |
boolean |
rtrAttributes |
The CRU type of the alarm plus its ready-to-remove attributes, which are based on the CRU type |
|
repairPolicy |
The repair policy for the alarm component. |
4.415. ApplicationAwarenessBundle
Name | Description | Schema |
---|---|---|
keyValueTag |
This is an array of elements that report the a key-value tag and its reference. |
< KeyValueTag > array |
keyValueTagMapping |
This element is an array of the mappings (using references) between a key-value tag and a volume. |
< KeyValueTagMapping > array |
workload |
This is an array of elements that reports Workload references. |
< Workload > array |
workloadVolumeMapping |
This is an array of elements that report the mapping between workloads and volumes. |
< WorkloadVolumeMapping > array |
4.416. AsyncMirrorGroup
Name | Description | Schema |
---|---|---|
groupRef |
The reference (key) for the mirror group. |
string |
worldWideName |
The world wide name of the mirror group. This can be used to identify the AMG pair on both arrays. The AsyncMirrorGroupRef is not guaranteed to be unique across multiple arrays. |
string |
label |
The user assigned name for the mirror group. |
string |
groupState |
The Mirror Group State. This is determined primarily by the presence or lack of a recovery point. |
enum (unknown, initialSync, optimal, degraded, rpFailed, __UNDEFINED) |
localRole |
The current role of this (local) array with respect to this mirror group. |
enum (unknown, primary, secondary, __UNDEFINED) |
remoteRole |
The current role of the peer (remote) array with respect to this mirror group. |
enum (unknown, primary, secondary, __UNDEFINED) |
roleChangeProgress |
This field indicates the current state of the role change process. This may be an extended condition due to the data sync needed for an orderly role change or the recovery point rollback needed for a no-sync or forced role change. |
enum (unknown, none, pending, inProgress, __UNDEFINED) |
syncIntervalMinutes |
The time in minutes between starting points of periodic synchronization intervals. A value of ARVM_MANUAL_SYNC_INTERVAL indicates synchronization intervals are manually started by the user. |
integer (int32) |
syncCompletionTimeAlertThresholdMinutes |
The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete. A value of ARVM_SYNC_COMPLETION_TIME_THRESHOLD_NONE indicates no threshold is set. |
integer (int32) |
recoveryPointAgeAlertThresholdMinutes |
The recovery point age objective (in minutes). The user is notified via needs-attention when the age of the last good recovery point exceeds this value. A value of ARVM_RECOVERY_POINT_AGE_THRESHOLD_NONE indicates no threshold is set. |
integer (int32) |
repositoryUtilizationWarnThreshold |
The repository utilization warning threshold (0-100 percent). A needs attention condition will be generated if the percent of the repository capacity currently utilized exceeds this threshold. |
integer (int32) |
mirrorChannelRemoteTarget |
The path to the remote array to be used by this AMG (a reference to the associated RemoteTarget). |
string |
syncActivity |
Current synchronization activity. |
enum (unknown, idle, active, paused, userSuspended, internallySuspended, __UNDEFINED) |
orphanGroup |
If true, the mirror group is an orphan. |
boolean |
4.417. AsyncMirrorGroupIncompleteMember
Name | Description | Schema |
---|---|---|
memberRef |
The reference (key) for the group member. |
string |
groupRef |
The associated Async Mirror Group. |
string |
primaryVolWWN |
The WWN of the primary volume on the remote array. |
string |
primaryVolCapacity |
Capacity of the primary (used to aid in selection of mirror secondary volume). |
string (int64) |
primaryVolRAIDLevel |
RAID level of the primary volume. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
primaryVolProtectionType |
The protection type of the primary volume. |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
primaryVolSecurityType |
Security type of the primary volume. |
enum (unknown, none, capable, enabled, __UNDEFINED) |
primaryVolUserLabel |
User label of the primary volume. |
string |
orphanIncompleteMember |
If true, the incomplete member is an orphan. |
boolean |
primaryVolumeParameters |
The capacity provisioning parameters for the primary volume. |
|
primaryVolSecurityLevel |
Refines the information in the securityType field to describe the set of drives. |
enum (unknown, none, mixed, fde, fips, __UNDEFINED) |
4.418. AsyncMirrorGroupMember
Name | Description | Schema |
---|---|---|
memberRef |
The reference (key) for the group member. |
string |
mirrorGroup |
The AMG with which this member is associated. |
string |
localVolume |
The local volume for this mirror. This is the volume being mirrored if the AMG role is primary, otherwise this is the target of mirror synchronization. |
string |
remoteVolume |
The remote volume. This is the target of mirror synchronization on the remote array if the AMG role is primary, otherwise this is the volume on the remote array that is being mirrored. |
string |
memberState |
The state of this mirror relationship (as known by this array). |
enum (unknown, initialSync, optimal, failed, incomplete, orphan, stopped, __UNDEFINED) |
lastRecoveryPointTime |
The timestamp, represented in seconds since midnight GMT on January 1, 1970, of the last recovery point PiT on secondary. If no recovery point image exists, the value of this field will be ARVM_NO_RECOVERY_POINT_TIMESTAMP. |
string (int64) |
overUtilizationWarnThreshold |
If true, the repository capacity utilized is over the warning threshold. |
boolean |
mirroredLocalCapacity |
The current local volume capacity that is being mirrored. This will be less than the actual local volume capacity if we have not yet reached a point where the next PiT can be taken and delta-logs resized (and until that point the expanded local capacity will not be opened up to host writes). |
string (int64) |
repositoryVolume |
The metadata volume (Copy-on-Write / DeltaLog Repository) for this mirror. |
string |
worldWideName |
The WWN of the async mirror proxy. |
string |
volumeHandle |
The SSID of the async mirror proxy. |
integer (int32) |
repositoryFull |
If true, the repository is full (100% of available capacity utilized). |
boolean |
id |
Example : |
string |
4.419. Battery
Name | Description | Schema |
---|---|---|
batteryRef |
The reference for this battery. |
string |
status |
The operational status of the battery. |
enum (optimal, fullCharging, nearExpiration, failed, removed, unknown, notInConfig, configMismatch, learning, overtemp, expired, maintenanceCharging, replacementRequired, __UNDEFINED) |
physicalLocation |
The physical location of the battery. The parent reference in Location identifies the CRU that physically houses the battery, and the position field is the parent-relative/like-component relative slot number of the battery, starting at one. |
|
batteryAge |
Current battery age, in days. |
integer (int32) |
batteryLifeRemaining |
Days of battery life remaining. A value of -1 indicates that the battery life expiration age has been set to 0xFF in NVSRAM, disabling cache battery expiration event notification. |
integer (int32) |
batteryTypeData |
Used to determine the scope of the battery. |
|
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
manufacturerDate |
VPD manufacture date. |
string (int64) |
vendorName |
VPD vendor name. |
string |
vendorPN |
VPD part number. |
string |
vendorSN |
VPD serial number. |
string |
fruType |
VPD field replaceable unit type. |
string |
rtrAttributes |
The CRU type of the battery plus its ready-to-remove attributes, which are based on the CRU type. |
|
repairPolicy |
The repair policy for the battery component. |
|
batteryCanExpire |
This boolean field is set to true when cache battery expired event notification is enabled. |
boolean |
automaticAgeReset |
This boolean field is set to true when the batteryCanExpire field in this structure is set to false and when the controller tracks the battery serial number. |
boolean |
learnCycleData |
Contains details about the learn cycle for this battery |
|
id |
Example : |
string |
4.420. BundledFeature
Name | Description | Schema |
---|---|---|
featureId |
This field indicate what feature this instance of BundledFeature represents. |
enum (volumesPerPartition, totalNumberOfVolumes, storagePartitions, snapshot, volumeCopy, remoteMirroring, driveTrayExpansion, mixedDriveTypes, mgmtApplication, supportedDrives, supportedDriveTrays, performanceTier, totalNumberOfSnapshots, totalNumberOfVolCopies, goldKey, snapshotsPerVolume, totalNumberOfMirrors, raid6, stateCapture, sataStrLen, secureVolume, protectionInformation, solidStateDisk, driveSlotLimit, fdeProxyKeyManagement, supportedInterposer, vendorSupportedDrives, flashReadCache, totalNumberOfAsyncMirrorGroups, totalNumberOfAsyncMirrorsPerGroup, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, pitGroupsPerVolume, totalNumberOfPitGroups, pitsPerPitGroup, memberVolsPerPitConsistencyGroup, totalNumberOfPitConsistencyGroups, totalNumberOfPitViews, totalNumberOfThinVolumesPerArray, nativeSataDriveSupport, solidStateDiskLimit, totalNumberOfRemoteMirrorsPerArray, asup, ectSelector, embeddedSnmpOid, asupOnDemand, dacstoreCompatId, samoaHicProtocol, targetPortLunMapping, hildaBaseboardProtocol, denali2Protocol, containerBasedApplication, __UNDEFINED) |
featureAttribute |
This field is a variable-length array of FeatureAttribute instances representing the attributes that apply for this particular feature. |
< FeatureAttribute > array |
4.421. CertificateRevocationSettings
Name | Description | Schema |
---|---|---|
certificateRevocationCheckEnabled |
Used to determine if certificate revocation checking is enabled. |
boolean |
ocspResponderAddress |
If set this will over-ride the OCSP (On-line Certificate Status Protocol) responder address found in the certificate. |
string |
isOCSPResponderAddressSet |
True if the OCSP (On-line Certificate Status Protocol) server address is set; otherwise false. |
boolean |
4.422. Cluster
Name | Description | Schema |
---|---|---|
clusterRef |
The unique identification value for this object. Other objects may use this reference value to refer to the cluster. |
string |
label |
The user-assigned, descriptive label string for the cluster. |
string |
isSAControlled |
If true, indicates that I/O accesses from this cluster are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the cluster are subject to cluster-specific LUN-to-volume mappings. |
boolean |
confirmLUNMappingCreation |
If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other clusters, in addition to this one. |
boolean |
protectionInformationCapableAccessMethod |
This field is true if the host has a PI capable access method. |
boolean |
isLun0Restricted |
Provides an indication as to whether LUN 0 is restricted (i.e., disallowed) for the associated cluster. |
boolean |
name |
Example : |
string |
id |
Example : |
string |
4.423. CompatibleFirmware
Name | Description | Schema |
---|---|---|
fwVersion |
A firmware package version identifier, which may or may not contain bytes with a value of FW_VERSION_WILDCARD. |
string |
compatible |
A true value indicates that any firmware version that matches the one specified in this structure is compatible with the currently-installed storage array firmware. A false value indicates that matching firmware versions are NOT compatible. |
boolean |
4.424. ComponentBundle
Name | Description | Schema |
---|---|---|
fan |
The fan component. |
< Fan > array |
battery |
The battery component. |
< Battery > array |
powerSupply |
The power supply component. |
< PowerSupply > array |
thermalSensor |
The thermal sensor component. |
< ThermalSensor > array |
esm |
The ESM component. |
< Esm > array |
ups |
The UPS component. |
< Ups > array |
minihub |
The minihub component. |
< Minihub > array |
gbic |
The GBIC component. |
< Gbic > array |
sfp |
The SFP component. |
< Sfp > array |
interconnectCRU |
The interconnect CRU. |
< InterconnectCRU > array |
supportCRU |
The Support CRU. |
< SupportCRU > array |
alarm |
The alarm. |
< Alarm > array |
hostBoard |
The host board. |
< HostBoard > array |
sasExpander |
The SAS expanders. |
< SasExpander > array |
cacheBackupDevice |
The cache backup devices. |
< CacheBackupDevice > array |
cacheMemoryDimm |
List of field replaceable cache memory DIMM modules. |
< CacheMemoryDimm > array |
processorMemoryDimm |
List of field replaceable processor memory DIMMs. |
< ProcessorMemoryDimm > array |
drawer |
List of drawers. |
< Drawer > array |
4.425. ConcatVolume
Name | Description | Schema |
---|---|---|
concatVolRef |
A reference (key) for ConcatVolume. |
string |
status |
The status/state of the concatenated volume. This will be the worst status among the member volumes. |
enum (unknown, optimal, degraded, failed, __UNDEFINED) |
memberCount |
The number of actual storage volumes comprising this volume. Note that this is just for convenience, this information can be derived from member objects. |
integer (int32) |
aggregateCapacity |
The aggregate capacity in bytes of all member volumes. |
string (int64) |
mediaScanParams |
Media scan parameters. |
|
volumeHandle |
The volume ssid. This is provided primarily for debug purposes. |
integer (int32) |
allowedOperations |
Operations allowed on the ConcatVolume. This can be used if ConcatVolume is ever exposed as a host-addressable volume to specify whether the volume is host-mappable or not (repository volumes would never be mappable). |
|
id |
Example : |
string |
4.426. ConcatVolumeMember
Name | Description | Schema |
---|---|---|
memberRef |
A reference (key) for ConcatVolumeMember. |
string |
concatVolRef |
A reference to the parent ConcatVolume. |
string |
storageVolumeRef |
A reference to the member RAID volume providing storage capacity. |
string |
parentIndex |
The index (order) of the member in the aggregated parent volume capacity. |
integer (int32) |
4.427. ConsistencyGroup
Name | Description | Schema |
---|---|---|
groupRef |
The consistency group reference. |
string |
4.428. ConsistencyGroupBundle
Name | Description | Schema |
---|---|---|
consistencyGroup |
Bundle of information about the write order consistency group objects. |
< ConsistencyGroup > array |
4.429. ControllerGBIC
Name | Description | Schema |
---|---|---|
controllerGBICType |
Interface (host/drive) to which the GBIC belongs. |
enum (hostside, driveside, __UNDEFINED) |
parentController |
Information on the controller associated with the GBIC. |
string |
channel |
The channel number that this GBIC is associated with. |
integer (int32) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
4.430. DVEVolume
Name | Description | Schema |
---|---|---|
volume |
The reference to the volume. |
string |
amountOfIncrease |
The amount of capacity increase for the volume. |
string (int64) |
4.431. DailySchedule
Name | Description | Schema |
---|---|---|
timeOfDay |
The number of seconds after midnight local time for the first occurrence during the day. |
integer (int32) |
everyNMinutes |
Interval between schedules if timesPerDay is greater than 1. |
integer (int32) |
timesPerDay |
The number of occurrences during the day based on everyNMinutes, including the first occurrence. |
integer (int32) |
4.432. DaylightSavingsTime
Name | Description | Schema |
---|---|---|
time |
Time of day for DST change measured as seconds past midnight. |
integer (int32) |
clockMode |
Reference for time. |
enum (unknown, wallClockTime, standardTime, utcTime, __UNDEFINED) |
month |
Month value: 0 to 12 (and negatives). |
integer (int32) |
dayOfMonth |
Day of month: 0 to 31 (and negatives). |
integer (int32) |
dayOfWeek |
Day of week: 0 to 7 (and negatives). |
integer (int32) |
4.433. DiskPoolData
Name | Description | Schema |
---|---|---|
reconstructionReservedDriveCount |
The number of drives reserved for reconstruction of failed drives. |
integer (int32) |
reconstructionReservedAmt |
The pool capacity reserved to hold rebuild data (in bytes). This value is calculated from the reconstructionReservedDriveCount. |
string (int64) |
reconstructionReservedDriveCountCurrent |
The reserved capacity that is currently available to hold rebuilt data (dynamic). If all of the reserved capacity is available, then this value will equal the reconstructionReservedDriveCount. |
integer (int32) |
poolUtilizationWarningThreshold |
The pool utilization warning threshold as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity. |
integer (int32) |
poolUtilizationCriticalThreshold |
The pool utilization critical threshold as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity. |
integer (int32) |
poolUtilizationState |
The Disk pool state set based on state of the threshold. |
enum (utilizationInvalid, utilizationOptimal, utilizationWarning, utilizationCritical, capacityDepleted, __UNDEFINED) |
unusableCapacity |
This value identifies how much capacity (in bytes) is being wasted due to a mix of drive sizes. This value will be zero as long as the pool consists of like drive sizes. |
string (int64) |
degradedReconstructPriority |
One failed drive degraded reconstruction priority. |
enum (invalid, lowest, low, medium, high, highest, useDefault, __UNDEFINED) |
criticalReconstructPriority |
Two failed drive reconstruction critical priority. |
enum (invalid, lowest, low, medium, high, highest, useDefault, __UNDEFINED) |
backgroundOperationPriority |
Priority of other background operations (DVE,DCE,DCR, and IAF). |
enum (invalid, lowest, low, medium, high, highest, useDefault, __UNDEFINED) |
allocGranularity |
The allocation granularity (in bytes) for volumes in a disk pool. |
string (int64) |
minimumDriveCount |
Minimum number of drives required for this disk pool |
integer (int32) |
4.434. Drive
Name | Description | Schema |
---|---|---|
offline |
True if the drive is in the offline state, false otherwise. This field is valid for missing drives. |
boolean |
hotSpare |
True if the drive has been designated as a hot spare; false otherwise. This field is valid for missing drives. |
boolean |
invalidDriveData |
True if no drive information (serial #, capacity, etc.) can be obtained. This field is always true for missing drives. |
boolean |
available |
True if the drive is available for use in creating a new volume group; false otherwise. This field is valid for missing drives. |
boolean |
pfa |
True if the drive is drive Predicted Failure analysis predicts a drive failure. This field is valid for missing drives. |
boolean |
driveRef |
The identifier value for this drive. Other objects may use this reference value to refer to the drive. This field is valid for missing drives. |
string |
status |
An indication of the current status of the drive. This field is valid for missing drives. |
enum (optimal, failed, replaced, bypassed, unresponsive, removed, incompatible, dataRelocation, preFailCopy, preFailCopyPending, __UNDEFINED) |
cause |
An indication of the reason for the current status of the drive. This field is most useful when the current status is something other than optimal; it identifies the event that caused the status to change to its current value. This field is valid for missing drives. |
enum (none, userOp, writeOp, uncertified, speedMismatch, bypassUnknown, wrongDriveType, incompatibleUprevDacstore, incompatibleDownrevDacstore, incompatibleInternalError, incompatibleSectorSizeMismatch, incompatibleNativeVgRefersToForeignDrive, incompatibleForeignVgRefersToNativeDrive, incompatibleNativeVgForeignDriveMutualRef, incompatibleVgCloned, incompatibleForeignDriveInconsistent, incompatibleVgHasDrivePartOfMultipleVgs, incompatibleForeignDriveHasInconsistentRole, incompatibleVgDrivePartOfMultipleVgs, incompatibleFailedLegacyDrive, incompatibleDdfOtherVendor, incompatibleDbAdoptionFailure, locked, insufficientDriveCapacity, supercapacitorFailure, unsupportedProtocolConnection, unsupportedCapacity, invalidLockKeyPresented, incompatiblePiType, incompatibleDatabaseValidationFailure, incompatibleUnsupportedInterposerFwVersion, incompatibleSataDriveSctUnsupported, incompatibleModelNumberUnsupported, incompatibleAlignmentForEmulationDrive, srcRelocation, dstRelocation, incompatibleDriveMetadataUnusable, pfa, spfa, __UNDEFINED) |
interfaceType |
Information about the I/O interface between the controller and the drive. For example, for a SCSI-attached drive, this field will contain information about the drive’s channel and SCSI ID values. For other interface types, different data will be available in this field. |
|
physicalLocation |
The physical location of the drive. Beginning with the Allegheny release, the parent reference in Location identifies the tray or drawer containing the drive, and the position field is the parent-relative/like-component relative slot number of the drive, starting at 1. For missing drives this field contains the last known location. |
|
manufacturer |
The variable-length ASCII text string that identifies the drive manufacturer. Note that this information is not returned for most Serial ATA (SATA) drives. |
string |
manufacturerDate |
The date of manufacture of the drive, represented in seconds since midnight GMT on January 1, 1970. Note that this information is not returned for most Serial ATA (SATA) drives. |
string (int64) |
productID |
The variable-length ASCII text string that identifies the product by name, as assigned by the manufacturer. |
string |
serialNumber |
The variable-length ASCII text string for the serial number of the drive. |
string |
softwareVersion |
This data is a variable-length ASCII text string. If an interposer is present in front of SATA drives, the string identifies the version of the interposer package. In this case, the SATA drive firmware version can be found in the physicalDriveTypeData field. If an interposer is not present (always the case for Fibre Channel drives) this field describes the drive firmware version. |
string |
blkSize |
The block (i.e. sector) size used by the drive, represented in bytes. This field is valid for missing drives. |
integer (int32) |
usableCapacity |
The usable capacity of the drive, in bytes, after accounting for any space that is reserved for use by the array controller for overhead information. This field is valid for missing drives. |
string (int64) |
rawCapacity |
The raw capacity of the drive, in bytes. This field is valid for missing drives. |
string (int64) |
worldWideName |
A variable-length, opaque field that contains the drive’s world-wide name, or globally unique identifier value. This field is valid for missing drives. |
string |
currentVolumeGroupRef |
The reference value of the volume group, disk pool, or flash cache to which this drive is currently assigned. If a hot spare drive is actively sparing for a failed drive, this field will identify the volume group, disk pool, or flash cache that is using the hot spare drive. If the drive is not currently assigned, or is an idle hot spare, the reference value will be null. This field is valid for missing drives. |
string |
sparedForDriveRef |
The reference value of the drive for which this drive is acting as a hot spare. This field is only used if the Drive object represents a global hot spare that is actively sparing for a failed drive. This field is valid for missing drives. |
string |
mirrorDrive |
This field is only used if the Drive object represents a drive that is part of a RAID-1 volume group. It identifies the drive that is tied to this one for RAID-1 mirroring operations. This field is valid for missing drives. |
string |
nonRedundantAccess |
True if the drive does not have redundant access. |
boolean |
workingChannel |
The channel to the tray that is still operational (if nonRedundantAccess is True). |
integer (int32) |
volumeGroupIndex |
The volume group index. This is the zero-relative position of the drive with respect to the stripe-ordering for the volume group. A value of -1 indicates that the drive does not belong to any group. This field is valid for missing drives. |
integer (int32) |
currentSpeed |
The speed of the drive. Will be unknown for a SCSI drive. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maxSpeed |
The maximum speed of the drive. Currently not used. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
uncertified |
True, if the drive has the DR_UNCERTIFIED flag set. This field is valid for missing drives. |
boolean |
hasDegradedChannel |
True, if a path to this drive is degraded. |
boolean |
degradedChannels |
The IDs of degraded channels. |
< integer (int32) > array |
phyDriveType |
The physical drive type. |
enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) |
spindleSpeed |
The drive reported spindle speed. Solid State Disk (SSD) drives report zero. |
integer (int32) |
rtrAttributes |
The CRU type of the drive plus its ready-to-remove attributes, which are based on the CRU type. |
|
reserved |
reserved. |
string |
phyDriveTypeData |
Information specific to a physical drive type. |
|
pfaReason |
The reason a PFA condition has been raised for this drive. |
enum (unknown, none, driveReported, synthesized, ssdEndOfLife, dataLoss, __UNDEFINED) |
bypassSource |
A list of object references where each reference identifies the source of a drive bypass condition. Possible referenced objects include the drive itself, a controller, or the ESM(s). When the bypass source is a controller or the drive, the list will typically hold just one reference; when the bypass source is the ESM(s), the list can hold up to two references, indicating either one or both ESMs. The list normally holds valid data whenever the drive is in the bypassed state (DRIVE_STAT_BYPASSED) , however it may be empty if the source of the bypass is unknown. It is also possible for the list to hold valid data when the drive is optimal, if only one ESM has bypassed the drive. |
< ObjectReference > array |
repairPolicy |
This field contains the repair policy for the Drive. |
|
fdeCapable |
True if the drive supports FDE, false otherwise |
boolean |
fdeEnabled |
true if drive security is enabled; false if disabled |
boolean |
fdeLocked |
True if the drive is locked, false if the drive is unlocked |
boolean |
lockKeyID |
The lock key ID as read from the drive. |
string |
ssdWearLife |
Contains wear life data for the SSD drive. |
|
driveMediaType |
This field is set to the drive media type of the drive. |
enum (all, unknown, hdd, ssd, __UNDEFINED) |
fpgaVersion |
This data is a variable-length ASCII text string that identifies the version of the FPGA package. |
string |
protectionInformationCapabilities |
This structure contains a protectionInformationCapable field which is set to true when the drive is formatted to support type 2 protection with a 512-byte logical block size, or if the drive is a type 0 drive formatted with a 520-byte logical block size. It also contains a field that is set to the protection type provided for the drive. |
|
protectionInformationCapable |
Field is no longer used. |
boolean |
protectionType |
Field is no longer used. |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
interposerPresent |
A value of true for this property means the drive is behind an interposer. |
boolean |
interposerRef |
The drive interposer identifier. This field is valid only if the interposerPresent field is set to True. |
string |
currentCommandAgingTimeout |
The current command aging timeout value in hundreds of milliseconds. If this value is 0 the default command aging timeout value will be used, otherwise this value overrides the default value. |
integer (int32) |
defaultCommandAgingTimeout |
The default command aging timeout value in hundreds of milliseconds as specified by the drive. If this value is 0, the drive command aging timeout cannot be changed. |
integer (int32) |
driveTemperature |
Drive temperature data. |
|
blkSizePhysical |
The physical block (i.e., sector) size for the drive, represented in bytes. This field is valid for missing drives. |
integer (int32) |
lowestAlignedLBA |
The lowest aligned LBA for the physical sector. Typically this will be 0, but could be non-zero for emulation drives where LBA 0 starts at some logical sector offset within the physical sector. |
string (int64) |
removed |
True if the drive is in the process of being removed from the volume group. Only applies to Disk Pools |
boolean |
locateInProgress |
Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the drive. |
boolean |
fipsCapable |
This flag is true if the drive supports FIPS (Federal Information Processing Standard). FIPS 140-2 specification. |
boolean |
id |
Example : |
string |
4.435. DriveChannel
Name | Description | Schema |
---|---|---|
channel |
The channel number. |
integer (int32) |
state |
The operational state of the channel. |
enum (optimal, degraded, hwFailed, __UNDEFINED) |
reason |
The reason the channel was degraded. |
enum (none, thresholdExceeded, adminRequest, socNotOperational, socEepromFailure, clearHwFailure, controllerAction, __UNDEFINED) |
degradingController |
If auto degraded, the degraded controller. |
string |
statsControllerA |
The statistics for Controller A. |
|
statsControllerB |
The statistics for Controller B. |
4.436. DriveChannelErrorCounts
Name | Description | Schema |
---|---|---|
nonChannelErrors |
The number of non channel errors. |
integer (int32) |
timeoutErrors |
The number of timeout errors. |
integer (int32) |
controllerDetectedErrors |
The number of controller detected errors. |
integer (int32) |
driveDetectedErrors |
The number of drive detected errors. |
integer (int32) |
linkDownErrors |
The number of link down errors. |
integer (int32) |
4.437. DriveChannelParent
Name | Description | Schema |
---|---|---|
driveChannelParent |
This enumeration object is used to specify the Drive Channel parent. |
enum (parentUnknown, minihub, controller, __UNDEFINED) |
controllerRef |
This field is present only if the DriveChannelParentType is CONTROLLER. |
string |
minihubRef |
This field is present only if the DriveChanelParentType is MINIHUB. |
string |
4.438. DriveChannelPort
Name | Description | Schema |
---|---|---|
portRef |
A reference to the drive channel port. |
string |
channel |
The Fibre Channel number of the port. |
integer (int32) |
portType |
The type of port (XBB/expansion/internal). |
enum (portUnknown, port1, port2, port3, port4, port12, port34, port7, minihubInout, expansionOnly, expansionAndInternal, __UNDEFINED) |
parentType |
The parent type (minihub/controller). |
4.439. DriveChannelStatistics
Name | Description | Schema |
---|---|---|
startTimeStamp |
The time stamp of when the error tracking began. |
string (int64) |
endTimeStamp |
The time stamp of when the error tracking ended. |
string (int64) |
totalIoCount |
The total number of I/Os. |
integer (int32) |
totalIoErrorCount |
The total number of I/O errors. |
integer (int32) |
linkStatus |
The status of the link - up, down, failed |
enum (none, up, down, failed, __UNDEFINED) |
errorCounts |
The error category counts. |
4.440. EmbeddedExternalKMSInformation
Name | Description | Schema |
---|---|---|
installedKMSCertificateFile |
The list of KMS Certificate Files currently installed on the storage array. Only one certificate of each type can ever be installed at a time although not necessarily each possible type will be installed. The specific certificates that need to be installed will depend on the KMIP server, how it is configured, and the CA used to sign certificates. The signed client certificate will always be necessary. |
< enum (certificateFileTypeUnknown, clientCertificate, serverCertificate, __UNDEFINED) > array |
kmsEndpoint |
The external key management server endpoint information. |
4.441. ExtendedSAData
Name | Description | Schema |
---|---|---|
reserved1 |
Example : |
string |
codeVersions |
This is a list of versions for the various firmware components (RAID, NVSRAM, hypervisor, ….). The list contains an entry for every code module applicable to the current platform. |
< VersionDescriptor > array |
4.442. ExternalKMSEndpoint
Name | Description | Schema |
---|---|---|
kmsAddress |
The IP or domain address of the key management server |
|
kmsPort |
The port number to be used for communicating KMIP requests with the key management server. |
integer (int32) |
4.443. FeatureAttribute
Name | Description | Schema |
---|---|---|
featureAttrId |
This enumeration identifies the defined feature attributes. |
enum (shippedEnabled, shippedLimit, keyEnabled, keyLimit, supportedValues, subjectToGoldKey, evalDuration, __UNDEFINED) |
keyEnabled |
The boolean value for a "KEY ENABLED" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_KEY_ENABLED. |
boolean |
keyLimit |
The integer value for a "KEY LIMIT" attribute. This field is only present if featureAttrId is equal to FEAUTRE_ATTR_KEY_LIMIT. |
integer (int32) |
shippedEnabled |
The boolean value for a "SHIPPED ENABLED" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_SHIPPED_ENABLED. |
boolean |
shippedLimit |
The integer value for a "SHIPPED LIMIT" attribute. This field is only present if featurAttrId is equal to FEATURE_ATTR_SHIPPED_LIMIT. |
integer (int32) |
subjectToGoldKey |
The boolean value for a "SUBJECT_TO_GOLD_KEY" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_SUBJECT_TO_GOLD_KEY. |
boolean |
supportedValues |
The set of string values for a "SUPPORTED VALUES" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_SUPPORTED_VALUES. |
< string > array |
evaluationDuration |
An unsigned integer representing the number of days for the "EVALUATION DURATION" attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_EVAL_DURATION. |
integer (int32) |
4.444. FeatureBundle
Name | Description | Schema |
---|---|---|
name |
The name of the feature bundle. |
string |
bundledFeatures |
A variable-length collection of BundledFeature instances, one for every feature comprising the bundle. |
< BundledFeature > array |
bundleSubmodelId |
The submodel Identifier associated with the feature bundle. |
string |
4.445. FeatureParams
Name | Description | Schema |
---|---|---|
maxHotSpares |
The maximum number of hot spare drives that can be assigned. If the value in this field is '0xFFFFFFFF' it means there is no limit to the number of hot spares. |
integer (int32) |
cacheBlockSizes |
A variable-length array in which each element specifies one of the supported cache block sizes that can be set on the controller. Cache block sizes are reported in bytes. |
< integer (int32) > array |
maxDCEDrives |
The maximum number of drives that can be added, in a given operation, to an existing volume group to expand the capacity of the volume group. |
integer (int32) |
maxReadAheadMultiplier |
The maximum multiplier value that can be specified when configuring cache the read-ahead parameter for a volume. (Realize, however, that the volume read-ahead parameter is no longer treated as a quantify, but as a simple on (non-zero) / off (zero) indicator. |
integer (int32) |
minMediaScanPeriod |
The minimum supported period over which a complete media scan can be set to occur (measured in days). |
integer (int32) |
maxMediaScanPeriod |
The maximum supported period over which a complete media scan can be set to occur (measured in days). |
integer (int32) |
supportedSegSizes |
A variable-length array in which each element specifies one of the supported segment size values, in bytes. This array should be consulted prior to attempting to create a volume modify a volume’s segment size via the startVolumeSegmentSizing procedure. |
< integer (int32) > array |
numStandardSegSizes |
The number of standard segment size values (at beginning of list). |
integer (int32) |
segTransitions |
A variable-length array in which each element specifies one of the supported segment size transition options. The user of the SYMbol interface should consult this list to determine a valid new segment size for a volume before attempting to use the startVolumeSegmentSizing procedure. |
< enum (transitionHalf, transitionDouble, __UNDEFINED) > array |
mappableLUNCount |
The maximum number of LUN addresses that are available for volume mapping operations. The range of supported LUN values is thus 0 through mappableLUNCoun-1. |
integer (int32) |
maxPartitionCount |
The number of partitions supported by the controller. |
integer (int32) |
maxMappingsPerVolume |
The number of mappings allowed per volume. |
integer (int32) |
maxVolumes |
The maximum number of standard volumes allowed per array. |
integer (int32) |
maxSnapshots |
The maximum number of snapshot volumes allowed per array. |
integer (int32) |
maxSnapshotsPerBase |
The maximum number of snapshots allowed on any given base volume. |
integer (int32) |
minRepositorySize |
The minimum size of a repository volume in bytes. |
integer (int32) |
maxMirrors |
The maximum number of mirrored volumes allowed per array assuming full size repositories. |
integer (int32) |
maxVolCopys |
The maximum number of volume copies allowed per array. |
integer (int32) |
maxConcurrentBackgroundCopys |
The maximum number of background copies that can be active at any one time. This maximum number applies to the entire array, not just one controller. |
integer (int32) |
maxUtmLunValue |
The maximum value a UTM LUN can be set to. |
integer (int32) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
battery_not_in_configuration |
The NVSRAM setting for optional controller battery. |
boolean |
supportedDriveTypes |
A list of supported drive types. |
< enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) > array |
currentMaxMirrors |
The maximum number of mirrored volumes allowed per array for existing repositories. |
integer (int32) |
maxVolumesPerGroup |
The maximum number of volumes allowed per volume group. |
integer (int32) |
maxDriveDownloadFiles |
The maximum number of drive download files permitted. |
integer (int32) |
maxMgmtClientRecords |
The maximum number of records allowed in the client data storage area. |
integer (int32) |
maxMgmtClientRecordSize |
The maximum record size of a client data record. |
integer (int32) |
redundancyMode |
Indicates whether the system is Simplex or Duplex. |
enum (unknown, duplex, simplex, __UNDEFINED) |
maxExpansionDriveTrays |
The maximum number of expansion drive trays allowed for this storage array. |
integer (int32) |
supportedAuthMethods |
The iSCSI authentication methods supported by the storage array. |
< enum (none, chap, __UNDEFINED) > array |
maxIscsiIpv6LocalAddressesPerPort |
Max number of iSCSI IPV6 local addresses |
integer (int32) |
maxIscsiIpv6RoutableAddressesPerPort |
Max number of iSCSI IPV6 routable addresses |
integer (int32) |
absoluteMaxDssSegmentSize |
The global upper bound, expressed in bytes, on the new segment size that may be requested on the startVolumeSegmentSizing procedure. |
integer (int32) |
smartBatteryTechnology |
This field is set to true if the storage array uses smart battery technology, and false otherwise. |
boolean |
writeCachingEnabledDuringLearnCycle |
This field, which is only applicable if smartBatteryTechnology is true, is set to true if the charge level on a smart battery unit is expected to remain above the minimum level needed to support write caching. |
boolean |
maxSSDsSupported |
The maximum number of SSDs supported on the array. If SSDs are not supported this value is 0. |
integer (int32) |
ssdInterfaceTypeMixingSupported |
True if different SSD interface types (e.g. Fibre Channel, SAS) can be used in the same volume group. |
boolean |
maxDriveSlots |
The maximum number of drive slots supported on the array. |
integer (int32) |
supportedProtectionTypes |
The protection types supported by the storage array. |
< enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) > array |
supportedEventPriorities |
An array listing the MEL event priorities that are configured for use in the current controller firmware build. |
< enum (priorityDefault, priorityCritical, priorityInfo, priorityEmergency, priorityAlert, priorityError, priorityWarning, priorityNotice, priorityDebug, __UNDEFINED) > array |
maxFlashCacheSize |
The maximum flash cache repository size measured in bytes. |
string (int64) |
defaultMediaScanPeriod |
The default media scan period stored in the controller’s NVSRAM. Units are days. |
integer (int32) |
maxNvmeofRoceV2Ipv6LocalAddressesPerPort |
Max number of NVMe ROCEv2 IPV6 local addresses |
integer (int32) |
maxNvmeofRoceV2RoutableAddressesPerPort |
Max number of NVMe ROCE IPV6 routable addresses |
integer (int32) |
4.446. FeatureState
Name | Description | Schema |
---|---|---|
capability |
This field will contain the value of the premium feature being described. |
enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, containerBasedApplication, __UNDEFINED) |
isEnabled |
A true value in this field indicates that the feature is enabled (regardless of compliance) |
boolean |
isCompliant |
A true value in this field indicates that the feature has been purchased (in compliance). A false value indicates that the feature has not been purchased. The user will receive warning messages indicating that they are not in compliance. The warning message will continue until the feature is purchased or the feature is disabled. |
boolean |
isWithinLimits |
This field is deprecated. Use isCompliant field instead. |
boolean |
featureId |
This field contains the value of the feature ID associated with the feature. |
enum (volumesPerPartition, totalNumberOfVolumes, storagePartitions, snapshot, volumeCopy, remoteMirroring, driveTrayExpansion, mixedDriveTypes, mgmtApplication, supportedDrives, supportedDriveTrays, performanceTier, totalNumberOfSnapshots, totalNumberOfVolCopies, goldKey, snapshotsPerVolume, totalNumberOfMirrors, raid6, stateCapture, sataStrLen, secureVolume, protectionInformation, solidStateDisk, driveSlotLimit, fdeProxyKeyManagement, supportedInterposer, vendorSupportedDrives, flashReadCache, totalNumberOfAsyncMirrorGroups, totalNumberOfAsyncMirrorsPerGroup, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, pitGroupsPerVolume, totalNumberOfPitGroups, pitsPerPitGroup, memberVolsPerPitConsistencyGroup, totalNumberOfPitConsistencyGroups, totalNumberOfPitViews, totalNumberOfThinVolumesPerArray, nativeSataDriveSupport, solidStateDiskLimit, totalNumberOfRemoteMirrorsPerArray, asup, ectSelector, embeddedSnmpOid, asupOnDemand, dacstoreCompatId, samoaHicProtocol, targetPortLunMapping, hildaBaseboardProtocol, denali2Protocol, containerBasedApplication, __UNDEFINED) |
featureRef |
This field contains a reference to the feature. |
string |
limit |
A numerical description associated with this FeatureState object, describing the level or tier for this feature. A zero value represents a feature that does not support tiering. Non-zero implies a tiering level. |
integer (int32) |
duration |
Describes the timeframe this feature will be available. A zero value describes an infinite duration. The unit of duration is in days. |
integer (int32) |
enabledTime |
Describes the time when this feature was enabled. |
string (int64) |
supportedFeatureBundleId |
The supported Feature Bundle ID. When not in use this value will be zero. |
integer (int32) |
permanentLicenseApplied |
TRUE if a permanent license for this feature has been applied. FALSE if the feature is being evaluated or is not enabled at all. |
boolean |
4.447. FlashCache
Name | Description | Schema |
---|---|---|
wwn |
The WWN of the high level flash cache volume. |
string |
flashCacheRef |
A reference to the high level flash cache volume. |
string |
flashCacheBase |
Contains the base-level Flash Cache attributes pertaining to all types of Flash Caches. |
|
fcDriveInfo |
Drive information for the flash cache. |
|
id |
Example : |
string |
4.448. FlashCacheBundle
Name | Description | Schema |
---|---|---|
flashCacheMap |
A list of structures that map between the cached volumes and their associated flash cache. |
< FlashCacheMap > array |
flashCache |
A list of flash cache objects. |
< FlashCache > array |
4.449. FlashCacheMap
Name | Description | Schema |
---|---|---|
flashCache |
A reference to the associated flash cache. |
string |
cachedVolume |
A reference to the cached volume. |
string |
flashCacheMapRef |
A unique identifier for the map entry. |
string |
id |
Example : |
string |
4.450. FreeExtent
Name | Description | Schema |
---|---|---|
sectorOffset |
The sector offset of this free extent within its volume group. This value is provided only to allow the client application to determine the relative positions of free extents and volumes within a given volume group. No other assumptions or computations should be made with this value. |
string (int64) |
rawCapacity |
The total raw capacity of this free extent. If the storage array supports mixed RAID levels per volume group, this value will represent the raw capacity without accounting for RAID parity requirements. Otherwise, this value will represent the RAID-factored capacity of the free extent, and thus provide an indication of the maximum volume (using the volume group’s RAID level) that can be created on this free extent. |
string (int64) |
raidLevel |
The RAID level of this free extent, which governs the allowed configuration of volumes that can be created on it. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
volumeGroupRef |
The volume group reference value of the volume group on which this free extent resides. |
string |
freeExtentRef |
The unique identification value for this free extent. Other objects may use this reference value to refer to the free extent. |
string |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
4.451. GBICParentTypeData
Name | Description | Schema |
---|---|---|
gbicParentType |
This enumeration is used to identify the parent type of a GBIC component. |
enum (esm, minihub, controller, __UNDEFINED) |
controllerGBIC |
This field is present only if the gbicParentType value is GBIC_PARENT_TYPE_CONTROLLER. It contains the detailed information about the controller channel. |
|
parentEsm |
No information is returned |
string |
parentMinihub |
This field is present only if the gbicParentType value is GBIC_PARENT_TYPE_MINIHUB. It contains the detailed information about the minihub the GBIC belongs to. |
string |
4.452. Gbic
Name | Description | Schema |
---|---|---|
gbicRef |
The reference for this physical GBIC. |
string |
status |
The operational status of the GBIC. |
enum (optimal, failed, removed, unknown, __UNDEFINED) |
physicalLocation |
The physical location of the GBIC. Note that the tray reference identifies the enclosure containing the GBIC, but the slot information does not apply to this component. |
|
gbicType |
This field is the discriminator value, which identifies the type of GBIC. |
enum (notPresent, cs12Active, cs12Passive, opticalLw, serialModule, opticalSw, opticalLwLxSingleMode, opticalSwSx, __UNDEFINED) |
gbicPort |
This field provides information about the port that the GBIC is associated with. |
enum (port1, port2, __UNDEFINED) |
parentData |
Information returned is based on the type of the GBIC parent. The data returned describes the component or controller that is associated with the GBIC. |
|
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
4.453. GhostVolBundle
Name | Description | Schema |
---|---|---|
ghostVol |
An array of GhostVolume objects. |
< GhostVolume > array |
4.454. GhostVolume
Name | Description | Schema |
---|---|---|
worldWideName |
The World Wide Name of the volume. |
string |
volumeRef |
The reference for this volume. |
string |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
4.455. HLVolumeBundle
Name | Description | Schema |
---|---|---|
snapshotVol |
An array of SnapshotVolume objects. |
< SnapshotVolume > array |
mirrorVol |
An array of MirrorProxyVolume objects. |
< MirrorProxyVolume > array |
metadataVol |
An array of MetadataVolume objects. |
< MetadataVolume > array |
remoteVol |
An array of RemoteVolume objects. |
< RemoteVolume > array |
volumeCopy |
An array of VolumeCopy objects. |
< VolumeCopy > array |
pitGroup |
An array of PITGroup objects. |
< PITGroup > array |
pit |
An array of PiT objects. |
< PIT > array |
pitView |
An array of PITView objects. |
< PITView > array |
pitConsistencyGroup |
An array of PITConsistencyGroup objects. |
< PITConsistencyGroup > array |
concatVolume |
An array of ConcatVolume objects. |
< ConcatVolume > array |
concatVolMember |
An array of ConcatVolumeMember objects. |
< ConcatVolumeMember > array |
pitConsistencyGroupView |
An array of PITConsistencyGroupView objects. |
< PITConsistencyGroupView > array |
thinVolume |
An array of ThinVolume objects. |
< ThinVolume > array |
asyncMirrorGroup |
Async Mirror Groups. |
< AsyncMirrorGroup > array |
asyncMirrorGroupMember |
Async Mirror Group Members. |
< AsyncMirrorGroupMember > array |
asyncMirrorGroupIncompleteMember |
"Incomplete" Async Mirror Group Members. |
< AsyncMirrorGroupIncompleteMember > array |
4.456. HostSpecificValues
Name | Description | Schema |
---|---|---|
waitForDownload |
The download microcode status control. |
boolean |
notReadySenseForQuiescenceInProgress |
This value determines the response of the controller to commands received during the 'controller quiesced' state. |
boolean |
notReadySenseForQuiescenceInProgress2 |
This value determines the response of the controller to commands received during the 'controller quiesced' state. |
boolean |
checkConditionForVendorUniqueUAConditions |
This value determines if the controller will report a vendor unique Unit Attention condition as a Check Condition status. |
boolean |
reportDeferredErrors |
This value is used to determine how deferred errors are reported to the host. |
boolean |
ignoreForceUnitAccess |
This value determines controller treatment of the Force Unit Access Option in the SCSI Read(10) and Write(10) commands. |
boolean |
ignoreWriteCacheDisable |
This value determines if the controller will allow the resetting of the WCE bit in the Mode Select Caching Page to disable write caching. |
boolean |
allowReservationOnUnownedLUNs |
This value determines the controller response to Reservation/Release commands that are received for LUNs that are not owned by the controller. |
boolean |
worldWideNameInStandardInquiry |
Set to true if the WWN is in the standard inquiry data. |
boolean |
propagateHostBusResets |
This value determines whether the controller will propagate a Host Bus Reset/Target Reset/Logical Unit Reset to the other controller in a dual controller subsystem to support Microsoft Clustering Services. |
boolean |
reportSCCDeviceEnable |
Report SCC Device Enable. |
boolean |
conditionalFCLogout |
Conditional Fibre Channel Logout. |
boolean |
forceSCSI2 |
Report SCSI-2 Through Fibre Channel Host Interface. |
boolean |
reportUnconfiguredLUNs |
This value determines the LUN data returned by the Report LUNs command. |
boolean |
ignoreSyncCache |
Ignore Cache Sync Command. |
boolean |
ignoreUTMLunOwnership |
Ignore UTM LUN Ownership. |
boolean |
reportLUNPreferredPathInStandardInquiry |
Report LUN Preferred Path in Standard Inquiry Data. |
boolean |
autoLUNTransfer |
Auto Volume Transfer. |
boolean |
inquiryUnconfiguredDeviceType |
The value returned in the Inquiry Device Type Field when an unconfigured LUN is accessed. |
string |
inquiryUnownedDeviceType |
This value is used to define the device type the controller should return in the first byte of the Inquiry data, if the addressed logical unit is not owned by the addressed controller. |
string |
unownedBlock0Read |
This value is used to define how the controller handles a read request to Block 0 of an unowned volume. When this is enabled, the non-owning controller sends a request for the block 0 data to the owning controller and the owning controller sends the requested block 0 data back to the non-owning controller. If disabled, the controller will do a volume transfer (if AVT is enabled) and then a read of the now owned volume. |
string |
retainLogins |
This field is deprecated. |
boolean |
hostPortType |
The host type. |
string |
maxRestrictedLUNs |
Maximum number of LUNs allowed for host type. |
integer (int32) |
reserved1 |
Example : |
string |
avtExclusionExtentsEnabled |
Enable the AVT exclusion extents for this heterogeneous host region. |
boolean |
suppressVolOffPreferredPathAlert |
If true, then volume-off-preferred events are not considered critical. |
boolean |
hostType |
The host type string. A zero-length string is allowed and indicates that the associated host-specific NVSRAM region has been cleared. This field should be used in place of the deprecated hostPortType field. |
string |
tpgsSupported |
This field is set to true if Target Port Group Support is provided; otherwise it is false. |
boolean |
volumeFormatOptions |
If true, a format unit request will interrupt any in-progress IAF and start a write-zeros initialization. If false, the format unit will be returned with no action. |
boolean |
restrictedLun0 |
If true, LUN 0 is restricted and volume mapping to LUN 0 will not be allowed or be reported in the REPORT LUNS data. If false, a volume-to-LUN mapping can be created to LUN 0 and will be reported in a REPORT LUNS response. |
boolean |
usePage2CQuiescenceTimeout |
The quiescence timeout is the amount of time the controller should wait to achieve a "no I/Os active" state before invoking a forced transfer of LUN ownership. When this field is set to true, the timeout parameter provided by the host initiator in a mode select Page 2C will be used. When this field is set to false, the timeout value applied will be calculated by the controller. |
boolean |
asymmetricLUAccess |
If true, Asymmetric Logical Unit Access is enabled. |
boolean |
ignoreISCSISessionIDInITN |
If true, the array iSCSI target driver will not use the session identifier as part of its internal I_T Nexus identifiers. This reduces churn in I_T Nexus identifiers if the initiator does not re-use iSCSI session identifiers when re-opening a session. |
boolean |
enableLUCheckConditionParallelResponses |
If true, array may return multiple CHECK CONDITION responses simultaneously on a given logical unit. |
boolean |
disableExplicitTPGS |
If true, the standard INQUIRY data reporting TPGS support to the initiator will only indicate support for implicit mode (providing TPGS support is enabled, see tpgsSupported field). |
boolean |
unownedCheckConditionDuringFWActivation |
If true, controller will return a LUN NOT OWNED (05h/94h/01h) CHECK CONDITION when unable to handle I/O during firmware activation. |
boolean |
allowPreferredOwnerReportingSuppression |
If true, the controller will suppress reporting the preferred owner in REPORT TARGET PORT GROUPS or INQUIRY VPD data in conditions when the preferred controller cannot process I/O. |
boolean |
enableTargetFailback |
If true, controller initiates fail-back of volumes to the preferred owner . |
boolean |
enableAutoLoadBalance |
If true, the controller may issue volume ownership changes to balance IO load between controllers. |
boolean |
quiescenceInProgressSenseKey |
Sense Key returned to host for Quiescence In Progress Check Conditions. |
integer (int32) |
quiescenceInProgressASC |
Additional Sense Code returned to host for Quiescence In Progress Check Conditions. |
integer (int32) |
quiescenceInProgressASCQ |
Additional Sense Code Qualifier returned to host for Quiscence In Progress Check Conditions. |
integer (int32) |
persistentID |
Unique identifier for this specific host type. This value is stored in the controller configuration database when persisting Host objects in order to uniquely identify this specific host type across all NVSRAM builds. |
integer (int32) |
nvmeVUFailoverSupported |
If true, a vendor unique (VU) NVMe failover solution is supported on the host. |
boolean |
nvmeStandardFailoverSupported |
If true, the NVMe Asymmetric Namespace Access (ANA) failover solution is supported on the host. |
boolean |
4.457. IOCDumpData
Name | Description | Schema |
---|---|---|
iocDumpEnabled |
If true, IOC Dump is enabled in the controller. |
boolean |
iocDumpNeedsRetrieved |
If true, an IOC Dump currently exists in controller memory and has not been retrieved. |
boolean |
iocDumpTag |
The tag value of the IOC Dump currently in controller memory. Each dump has a unique tag value. A value of IOC_DUMP_NULL_TAG indicates there is no IOC Dump to retrieve. |
integer (int32) |
timeStamp |
The time that the dump was collected measured in seconds since midnight GMT on January 1, 1970. |
string (int64) |
4.458. InterconnectCRU
Name | Description | Schema |
---|---|---|
interconnectCRURef |
The reference for this physical interconnect CRU |
string |
status |
The operational status of the interconnect CRU |
enum (optimal, failed, removed, __UNDEFINED) |
physicalLocation |
The physical location of the interconnect CRU. The parent reference in Location identifies the tray containing the CRU, and the position field is always one. |
|
manufacturerDate |
VPD Manufacture Date |
string (int64) |
vendorName |
The VPD vendor name |
string |
vendorPN |
The VPD part number |
string |
vendorSN |
The VPD serial number |
string |
fruType |
The VPD field replaceable unit type |
string |
readyToRemove |
When set to True, it means that the component is ready to remove (and the Ready to Remove indicator will be turned on). This field is deprecated. The rtrAttributes field should be used instead. |
boolean |
rtrAttributes |
The CRU type of the interconnect CRU plus its ready-to-remove attributes, which are based on the CRU type. |
|
repairPolicy |
The repair policy for the interconnect CRU component. |
4.459. Interposer
Name | Description | Schema |
---|---|---|
interposerRef |
The drive interposer identifier. |
string |
interposerTypeData |
The vendor product data associated with the interposer. |
4.460. InterposerData
Name | Description | Schema |
---|---|---|
vendorID |
This data is a variable length ASCII text string containing the vendor identification of the interposer. |
string |
productID |
This data is a variable length ASCII text string containing the product identification of the interposer. |
string |
revision |
This data is a variable length ASCII text string that represents the current version, or revision level, of the interposer. |
string |
deviceWWN |
This data represents the device name of the interposer. |
string |
serialNumber |
This data is a variable length ASCII text string that represents the serial number of the interposer. |
string |
partNumber |
This data is a variable length ASCII text string that represents the part number of the interposer. |
string |
driveFwVersion |
4 bytes left-justified ASCII drive firmware version as retrieved from the drive’s standard INQUIRY data, followed by 4 blank bytes. |
string |
4.461. InterposerTypeData
Name | Description | Schema |
---|---|---|
interposerType |
This enumeration defines the different interposer types. |
enum (unknown, fcToSas, __UNDEFINED) |
fcSasInterposer |
This field is available when the interfaceTypeData is equal to INTERPOSER_TYPE_FC_TO_SAS |
|
reserved |
Reserved. |
string |
4.462. IoInterfaceHicMap
Name | Description | Schema |
---|---|---|
interfaceRef |
A reference to the I/O interface. |
string |
hostBoardRef |
The reference to the associated HIC. |
string |
4.463. IscsiEntityData
Name | Description | Schema |
---|---|---|
icmpPingResponseEnabled |
True if the storage array is enabled to respond to ICMP ping messages. |
boolean |
unnamedDiscoverySessionsEnabled |
True if the storage array is enabled to participate in unnamed discovery sessions. |
boolean |
isnsServerTcpListenPort |
The number of the TCP port on which the iSNS server listens for incoming connections. |
integer (int32) |
ipv4IsnsServerAddressConfigMethod |
The method by which the storage array determines the IPV4 address of the iSNS server. |
enum (configDhcp, configStatic, __UNDEFINED) |
ipv4IsnsServerAddress |
The method by which the storage array determines the IPV4 address of the iSNS server. |
string |
ipv6IsnsServerAddressConfigMethod |
The method by which the storage array determines the IPV6 address of the iSNS server. This is always set to "static" and cannot be changed. |
enum (configStatic, configStateless, __UNDEFINED) |
ipv6IsnsServerAddress |
The method by which the storage array determines the IPV6 address of the iSNS server. This is always set to "static" and cannot be changed. |
string |
isnsRegistrationState |
The state of the iSCSI entity with respect to iSNS server registration. |
enum (disabled, locatingServer, connectingToServer, completed, __UNDEFINED) |
isnsServerRegistrationEnabled |
True if the storage array is enabled to register with the iSNS (Internet Storage Name Service) server. |
boolean |
hostPortsConfiguredDHCP |
True if all the host ports have DHCP enabled, regardless of the configuration state. |
boolean |
4.464. KeyValueTag
Name | Description | Schema |
---|---|---|
keyValueTagRef |
The unique handle for a key-value object contained within this structure. |
string |
key |
The key is a fixed length, opaque byte sequence that stores user-defined data. |
string |
value |
The value is a fixed length opaque byte sequence that stores user-defined data. |
string |
4.465. KeyValueTagMapping
Name | Description | Schema |
---|---|---|
keyValueTagRef |
This field identifies the key-value tag to be associated with the Volume or Workload. |
string |
associatedObject |
This element identifies the object that is associated with the key-value tag. |
|
mappingRef |
The unique identifier for the specific mapping between the KeyValueTag and the KeyValueTagObjectReference identified in this structure. |
string |
4.466. KeyValueTagObjectReference
Name | Description | Schema |
---|---|---|
objectType |
Enumeration used to define the different type of object that can be associated with a key value tag. |
enum (unknown, volume, workload, __UNDEFINED) |
volume |
This field is returned for an object of type Volume. |
string |
workload |
This field is returned for an object of type Workload. |
string |
4.467. LockKeyID
Name | Description | Schema |
---|---|---|
lockKeyIDRef |
The unique reference to a lockKeyID. |
string |
lockKeyID |
The lock key ID. |
string |
4.468. MetadataVolume
Name | Description | Schema |
---|---|---|
metadataVolRef |
This object identifies the metadata volume. |
string |
metadataVolType |
This object specifies the metadata volume type. |
enum (allMdatTypes, remoteMirror, __UNDEFINED) |
associatedVolume |
Volume that contains data |
string |
preferredManager |
The controller that created the metadata volume. |
string |
perms |
The permissions allowed. |
|
offline |
True, if the volume is offline. |
boolean |
reserved1 |
Example : |
string |
4.469. Minihub
Name | Description | Schema |
---|---|---|
minihubRef |
The reference for this physical minihub. |
string |
status |
The operational status of the minihub. |
enum (optimal, failed, unsupported, unknown, __UNDEFINED) |
physicalLocation |
The physical location of the minihub. Note that the tray reference identifies the enclosure containing the minihub, but the slot information does not apply to this component. |
|
minihubData |
Information returned is based on the minihub type. |
|
currentSpeed |
The current speed of the minihub. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
maxSpeed |
The maximum speed of the minihub. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
channel |
The channel number that this minihub is associated with. |
integer (int32) |
portList |
Detailed information for each port of the minihub. This field is deprecated. |
|
vendorName |
The vendor name of the minihub. |
string |
partNumber |
The part number of the minihub. |
string |
serialNumber |
The serial number of the minihub. |
string |
fruType |
The field replaceable unit type of the minihub. |
string |
manufacturerDate |
The date the minihub was manufactured. |
string (int64) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
rtrAttributes |
The CRU type of the minihub plus its ready-to-remove attributes, which are based on the CRU type |
4.470. MinihubTypeData
Name | Description | Schema |
---|---|---|
minihubType |
This enumeration is used to identify the type of a minihub. |
enum (hostside, driveside, __UNDEFINED) |
parentController |
This field is present only if the minihubType value is equal to MINIHUB_TYPE_HOSTSIDE. It contains the detailed information about the controller the minihub is associated with. |
string |
4.471. MirrorProxyVolume
Name | Description | Schema |
---|---|---|
worldWideName |
The WWN of the local mirror volume. |
string |
mirrorProxyRef |
The reference to the local mirror volume. |
string |
volumeHandle |
The ssid of the local mirror volume. |
integer (int32) |
localMirrorStatus |
The status of the local mirror volume. |
enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED) |
remoteMirrorStatus |
The status of the remote mirror volume. |
enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED) |
localRole |
The role of the local mirror volume. |
enum (primary, secondary, invalid, __UNDEFINED) |
remoteRole |
The role of the remote mirror volume. |
enum (primary, secondary, invalid, __UNDEFINED) |
localPriority |
The synchronization priority for the local mirror volume. |
enum (priority0, priority1, priority2, priority3, priority4, unknown, __UNDEFINED) |
peerPriority |
The synchronization priority for the remote mirror volume. |
enum (priority0, priority1, priority2, priority3, priority4, unknown, __UNDEFINED) |
usableCapacity |
The amount of capacity being used by the mirror. |
string (int64) |
currentManager |
The controller reference that owns the local mirror volume. |
string |
baseVolume |
The reference to the base volume of the local mirror. |
string |
remoteVolRef |
The reference to the remote volume. |
string |
action |
An indication of what current long-running activity, if any, is currently in progress on the volume. |
enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
localWriteMode |
The local mirror volume’s write mode. |
enum (synchronousMode, asynchronousMode, consistentAsyncMode, __UNDEFINED) |
autoResync |
Indicates whether auto resynchronization is allowed. |
boolean |
consistencyGroupRef |
The write consistency group reference. |
string |
4.472. NetworkInterface
Name | Description | Schema |
---|---|---|
interfaceRef |
The SYMbol array-wide unique name for the interface object. |
string |
channelType |
The type of channel that the interface is associated with. |
enum (hostside, driveside, management, __UNDEFINED) |
netInterfaceTypeData |
A field whose contents vary depending on the type of the interface. |
4.473. ObjectBundle
Name | Description | Schema |
---|---|---|
configGeneration |
The configuration generation number that was in effect at the time this object bundle was constructed by the controller. The client can use this value to determine if it currently holds the latest version of the object graph. |
string (int64) |
sa |
A StorageArray object that contains base information about the storage array as a whole. |
|
tray |
A variable-length array of Tray structures. This array contains one element for each tray object that exists within the storage array. |
< Tray > array |
componentBundle |
A variable-length array of Component structures. This array contains one element for each physical component object that exists within the storage array. |
|
controller |
A variable-length array of Controller structures. This array contains one element for each RAID controller object that exists within the storage array. |
< Controller > array |
drive |
A variable-length array of Drive structures. This array contains one element for each physical disk drive object that exists within the storage array. |
< Drive > array |
volumeGroup |
A variable-length array of VolumeGroup structures. This array contains one element for each volume group object that exists within the storage array. |
< VolumeGroup > array |
volume |
A variable-length array of VolumeGroup structures. This array contains one element for each volume group object that exists within the storage array. |
< Volume > array |
freeExtent |
A variable-length array of FreeExtent structures. This array contains one element for each free extent object that exists within the storage array. |
< FreeExtent > array |
dveVol |
A variable-length array of DVE structures. This array contains one element for each volume being expanded. |
< DVEVolume > array |
storagePoolBundle |
An embedded object bundle that contains all configuration information relative to the "Storage Partitions" feature. |
|
highLevelVolBundle |
An embedded object bundle that contains all the information relative to the Higher-Level Volumes. |
|
ghostVolBundle |
An embedded object bundle that contains all the information relative to missing volumes. |
|
consistencyGroupBundle |
Write consistency group bundle. |
|
ioInterface |
A variable-length array of IoInterface structures. This array contains one element for each I/O interface object that exists within the storage array |
< IoInterface > array |
networkInterface |
A variable-length array of NetworkInterface structures. This array contains one element for each network interface object that exists within the storage array |
< NetworkInterface > array |
lockKeyIDs |
A variable length array of LockKeyID structures. Contains lock key information for the array. |
< LockKeyID > array |
interposer |
A variable length array of drive interposer data. An entry will appear in this array only if the interposerPresent field in the corresponding Drive structure is set to True. |
< Interposer > array |
ioInterfaceHicMap |
This is a list of structures that provides a mapping from I/O interfaces to their associated HICs. |
< IoInterfaceHicMap > array |
schedule |
A list of current schedules. |
< ScheduleInstance > array |
remoteArray |
This is a list of remote arrays which this array has visibility to for monitoring. |
< RemoteArray > array |
flashCacheBundle |
An embedded object bundle that contains all of the information related to flash cache objects. |
|
snmpBundle |
SNMP-related objects |
|
applicationAwarenessBundle |
This reports the key-value pairs and their references, and the mappings between Volumes and these key-value pairs. The data is used by the application and is opaque to the CFW. |
4.474. PIT
Name | Description | Schema |
---|---|---|
pitRef |
The reference (key) for this PiT. |
string |
pitGroupRef |
A reference to the associated PiT Group. |
string |
creationMethod |
The PiT creation method. |
enum (unknown, user, schedule, __UNDEFINED) |
pitTimestamp |
The controller-time (measured in seconds since January 1, 1970) when the PiT was created. |
string (int64) |
pitSequenceNumber |
The sequence number within PITGroup. This is a monotonically increasing sequence value that can be used to determine the absolute order of the PiTs within a PiT group. Using this sequence number avoids issues with timestamps when real-time clocks are changed. Note that this sequence number will be the same on all PiTs taken in multiple PITGroups at the same time under a single IO suspension, either as part of a consistency group operation (createCGPIT) or when a list of PITGroups is passed to createPIT. |
string (int64) |
status |
The state of this PiT. |
enum (unknown, optimal, failed, purged, __UNDEFINED) |
activeCOW |
If true, the PiT is actively recording copy-on-write data. |
boolean |
isRollbackSource |
If true, the PiT is a rollback source. |
boolean |
pitCapacity |
The capacity in bytes of this PiT (capacity of the base at the time the PiT was created). |
string (int64) |
repositoryCapacityUtilization |
Repository utilization in bytes (only reported if activeCOW = false). |
string (int64) |
id |
Example : |
string |
4.475. PITGroup
Name | Description | Schema |
---|---|---|
pitGroupRef |
The reference (key) for the PiT Group. |
string |
label |
The name of the PiT Group. If this PiT group is part of a consistency group, then this label does not have to be present or unique as the parent consistency group label will be used. |
string |
status |
The status of the PiT Group. |
enum (unknown, optimal, full, failed, overThreshold, __UNDEFINED) |
baseVolume |
The base volume for this PiT Group. |
string |
repositoryVolume |
The copy-on-write (CoW) Repository for this PiT group. |
string |
clusterSize |
The cluster size (in bytes). |
integer (int32) |
maxRepositoryCapacity |
The maximum allowable repository size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group. |
string (int64) |
maxBaseCapacity |
The maximum allowable base volume size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group. |
string (int64) |
unusableRepositoryCapacity |
The amount of repository capacity that is unusable due to limited addressability of the current cluster size. |
string (int64) |
repFullPolicy |
The behavior on repository full condition. Overridden by consistency group setting if this PITGroup is associated with a consistency group. |
enum (unknown, failbasewrites, purgepit, __UNDEFINED) |
fullWarnThreshold |
The repository utilization warning threshold percentage. |
integer (int32) |
autoDeleteLimit |
The auto-delete indicator. If non-zero, the oldest PiT will be automatically deleted when creating a new one to keep the total number of PiTs limited to the number specified. This value is overridden by the consistency group setting if this PITGroup is associated with a consistency group. |
integer (int32) |
action |
Long running operation. |
enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED) |
rollbackStatus |
The status of the rollback (if rollback is indicated in VolumeAction above). |
enum (unknown, none, inProgress, pending, paused, __UNDEFINED) |
rollbackPriority |
The importance of the rollback operation. |
enum (highest, high, medium, low, lowest, __UNDEFINED) |
consistencyGroup |
If true, this PiT group is part of a consistency group. |
boolean |
consistencyGroupRef |
A reference to the parent consistency group, if applicable. This value will be NULL if this PiT group is not part of a consistency group. |
string |
creationPendingStatus |
The status of Pending PiT Creation. |
enum (unknown, none, waiting, failed, __UNDEFINED) |
volumeHandle |
The PiT group SSID. This is provided primarily for debug purposes. |
integer (int32) |
name |
Example : |
string |
id |
Example : |
string |
4.476. PITView
Name | Description | Schema |
---|---|---|
viewRef |
The reference (key) for this view. |
string |
worldWideName |
The WWN of the view. |
string |
baseVol |
A reference to the base volume with which this view is associated. |
string |
basePIT |
A reference to the particular PiT of the base for which this view applies. This field is only valid if the boundToPIT field is true. |
string |
boundToPIT |
If true, this flag indicates that the basePIT field is a valid reference to an associated PIT. If false, the view is disassociated from the PiT so the basePIT reference is invalid. |
boolean |
accessMode |
The view access mode. |
enum (modeUnknown, readWrite, readOnly, __UNDEFINED) |
label |
The name of the view. |
string |
status |
The view status. |
enum (unknown, optimal, stopped, failed, overThreshold, full, __UNDEFINED) |
currentManager |
The current owner of the view. |
string |
preferredManager |
The preferred owner of the view. |
string |
repositoryVolume |
The copy-on-write repository for this view. |
string |
fullWarnThreshold |
The repository utilization warning threshold percentage. |
integer (int32) |
viewTime |
The controller-time (measured in seconds since January 1, 1970) when view was created or re-attached to another PiT. |
string (int64) |
viewSequenceNumber |
Sequence number. This is a monotonically increasing sequence value that can be used to determine related views when the view was created as part of a consistency group operation. |
string (int64) |
perms |
The permissions for the view. |
|
volumeHandle |
The volume ssid. This is provided primarily for debug purposes. |
integer (int32) |
clusterSize |
The cluster size in bytes. |
integer (int32) |
maxRepositoryCapacity |
The maximum allowable repository size in bytes based on current cluster size. |
string (int64) |
unusableRepositoryCapacity |
The amount of repository capacity in bytes that is unusable due to limited addressability of the current cluster size. |
string (int64) |
membership |
This view’s relationship (if any) to a Consistency Group View. |
|
mgmtClientAttribute |
The management client attribute. |
integer (int32) |
offline |
The view is offline due to the associated repository volume state. |
boolean |
extendedUniqueIdentifier |
A variable-length opaque field that provides the volume’s extended unique identification value. |
string |
name |
Example : |
string |
id |
Example : |
string |
4.477. ParityCheckOnMediaType
Name | Description | Schema |
---|---|---|
enabledOnHDD |
Indicate whether or not P and Q parity validation is performed on HDD drives during reconstruction of RAID 6 and disk pool volumes. |
boolean |
enabledOnSSD |
Indicate whether or not P and Q parity validation is performed on SSD drives during reconstruction of RAID 6 and disk pool volumes. |
boolean |
4.478. PremiumFeature
Name | Description | Schema |
---|---|---|
capability |
This field will contain the value of the premium feature being described. |
enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, containerBasedApplication, __UNDEFINED) |
isEnabled |
A true value in this field indicates that the feature is enabled (regardless of compliance) |
boolean |
isCompliant |
A true value in this field indicates that the feature has been purchased (in compliance). A false value indicates that the feature has not been purchased. The user will receive warning messages indicating that they are not in compliance. The warning message will continue until the feature is purchased or the feature is disabled. |
boolean |
isWithinLimits |
A true value in this field indicates that the feature has been purchased and the subsystem configuration does not exceed the feature options specified at purchase. A false value in this field indicates that the feature has been purchased but new subsystem configuration has caused the user to exceed the feature options that were purchased. The user will receive warning messages indicating that they are no longer in compliance. The user can change the subsystem configuration so that it is in compliance with feature options or the user can purchase additional feature options so that the subsystem is again in compliance. The warning messages will continue until the feature is again in compliance or is disabled. |
boolean |
featureId |
This field contains the value of the feature ID associated with the feature. |
enum (volumesPerPartition, totalNumberOfVolumes, storagePartitions, snapshot, volumeCopy, remoteMirroring, driveTrayExpansion, mixedDriveTypes, mgmtApplication, supportedDrives, supportedDriveTrays, performanceTier, totalNumberOfSnapshots, totalNumberOfVolCopies, goldKey, snapshotsPerVolume, totalNumberOfMirrors, raid6, stateCapture, sataStrLen, secureVolume, protectionInformation, solidStateDisk, driveSlotLimit, fdeProxyKeyManagement, supportedInterposer, vendorSupportedDrives, flashReadCache, totalNumberOfAsyncMirrorGroups, totalNumberOfAsyncMirrorsPerGroup, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, pitGroupsPerVolume, totalNumberOfPitGroups, pitsPerPitGroup, memberVolsPerPitConsistencyGroup, totalNumberOfPitConsistencyGroups, totalNumberOfPitViews, totalNumberOfThinVolumesPerArray, nativeSataDriveSupport, solidStateDiskLimit, totalNumberOfRemoteMirrorsPerArray, asup, ectSelector, embeddedSnmpOid, asupOnDemand, dacstoreCompatId, samoaHicProtocol, targetPortLunMapping, hildaBaseboardProtocol, denali2Protocol, containerBasedApplication, __UNDEFINED) |
4.479. ProcessorMemoryDimm
Name | Description | Schema |
---|---|---|
processorMemoryDimmRef |
The SYMbol reference value that uniquely identifies an instance of a cache memory DIMM object. |
string |
parentController |
The SYMbol reference of the DIMM’s parent controller. |
string |
dimmControllerSlot |
The controller-relative slot number of the DIMM, where "1" is the first slot number. |
integer (int32) |
status |
The operational status of the DIMM. |
enum (unknown, optimal, empty, failed, __UNDEFINED) |
capacityInMegabytes |
The capacity of the DIMM expressed in megabytes. |
integer (int32) |
serialNumber |
The serial number of the DIMM. |
string |
partNumber |
The LSI Logic part number of the DIMM. |
string |
oemPartNumber |
The OEM part number of the DIMM. |
string |
manufacturerPartNumber |
The manufacturer part number of the DIMM. |
string |
manufacturer |
The manufacturer part number of the DIMM. |
string |
manufactureDate |
The manufacture date of the DIMM |
string (int64) |
repairPolicy |
The repair policy for the processor memory DIMM component. |
|
physicalLocation |
The physical location of the processor memory DIMM. The parent field of Location is set to the controller where the DIMM physically resides, and the position field is the parent-relative/like-component-relative slot number of the DIMM, starting at one. |
|
revisionCode |
The module revision code of the DIMM. |
string |
4.480. Recurrence
Name | Description | Schema |
---|---|---|
recurrenceType |
This enumeration is used to specify the type of schedule recurrence. |
enum (unknown, unlimited, count, endDate, __UNDEFINED) |
recurrenceCount |
This field is present only if recurrenceType is equal to RECURRENCE_COUNT. |
integer (int32) |
recurrenceEndDate |
This field is present only if recurrenceType is equal to RECURRENCE_END_DATE. |
string (int64) |
4.481. RemoteArray
Name | Description | Schema |
---|---|---|
remoteArrayRef |
A unique identifier for this RemoteArray object. |
string |
saId |
The storage array ID of the remote array. |
|
remoteTargets |
One or more paths to the remote array. Note these could be differing protocols. |
< string > array |
4.482. SACache
Name | Description | Schema |
---|---|---|
cacheBlkSize |
The characteristic size, in bytes, of a cache block. |
integer (int32) |
demandFlushAmount |
Specifies the amount of cache data that will be flushed to disk when a cache flush operation is initiated. This value is specified as an integer in the range 0-100 that represents the percentage of the controller’s write cache data that can remain in the "dirty", or unflushed state. When demand flush operations are started, data will be flushed from cache to disk until the overall amount of dirty data drops to or below the percentage specified by this value. |
integer (int32) |
demandFlushThreshold |
Specifies the "level of fullness" of "dirty" data in the controller’s write cache which, when reached, will cause the controller to begin flushing data from cache to disk. This value is specified as a percentage, in the range 0-100, of the overall write cache capacity of the controller. After flushing begins, it will continue until enough data has been flushed to drop the percentage of dirty data to or below the value specified in the demandFlushAmount parameter described above. |
integer (int32) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
cacheMirroringProtectionInformation |
True if checking of protection information during cache mirroring is enabled, false otherwise. |
boolean |
4.483. SAData
Name | Description | Schema |
---|---|---|
needsAttention |
An indication of whether the array needs attention. A value of true is returned if there are any components that have been marked failed for any reason. Otherwise, if all components are operating properly, a value of false is returned. |
boolean |
fixing |
An indication of whether the array is in the process of recovering from a Needs Attention condition. A value of true indicates that no physical components are currently marked failed, but that some residual recovery activity (such as reconstruction, copyback, etc.) is still in progress. |
boolean |
saId |
The globally-unique identifier value for this storage array. |
|
managementClassName |
The name of the application-level entity required to manage configuration operations for the storage array. |
string |
storageArrayLabel |
The user-assigned label for the storage array. |
string |
bootTime |
The timestamp value for the time at which the responding controller last booted. Note that this value may differ between the individual controllers of a storage array. This value is defined in terms of the number of seconds since midnight GMT on January 1, 1970. |
string (int64) |
fwVersion |
The version identifier of the currently-installed array firmware. |
string |
appVersion |
The version identifier of the "application" component of the currently-installed array firmware. |
string |
bootVersion |
The version identifier of the "boot" component of the currently-installed array firmware. |
string |
nvsramVersion |
An ASCII string that describes the currently-installed NVSRAM contents. |
string |
fwPrefix |
An ASCII string that describes the firmware prefix. |
string |
chassisSerialNumber |
An ASCII string that describes the chassis serial number. |
string |
eventConfigurationDataVersion |
An ASCII string that identifies the version of the MEL event configuration data. This is used for the event logging enhancements in Chessie 2. |
string |
arrayAttributes |
SAAttributeID attribute-value pairs. |
< integer (int32) > array |
res4 |
Example : |
< integer (int32) > array |
res5 |
Example : |
< integer (int32) > array |
res6 |
Example : |
< integer (int32) > array |
res7 |
Example : |
string |
extendedSAData |
This element allows additional content to be added to SAData with actually adding any new elements to the struct. The element replaces a reserved field that was of variable length. |
4.484. SAPort
Name | Description | Schema |
---|---|---|
saPortRef |
This object uniquely identifies an SAPort. |
string |
saPortGroupRef |
This object uniquely identifies an SAPortGroup. |
string |
controllerRef |
The reference value of the controller. |
string |
portId |
The host-side I/O port identifier of the port on the controller. |
integer (int32) |
4.485. SAPortGroup
Name | Description | Schema |
---|---|---|
saPortGroupRef |
This object uniquely identifies a specific SAPortGroup. |
string |
label |
The user assigned label for the SAPortGroup. |
string |
4.486. SNMPAgentBundle
Name | Description | Schema |
---|---|---|
community |
All configured SNMP communities |
< SNMPCommunity > array |
trapDestination |
SNMP Trap Destinations. Traps will be delivered to these destinations when an alertable MEL event is generated. |
< SNMPTrapDestination > array |
systemVariables |
Current settings for SNMP "system" variables |
4.487. SNMPCommunity
Name | Description | Schema |
---|---|---|
communityRef |
A reference to the SNMP community. |
string |
communityName |
Community name |
string |
communityPermissions |
Community permissions |
enum (unknown, readOnly, readWrite, __UNDEFINED) |
4.488. SNMPSystemVariables
Name | Description | Schema |
---|---|---|
sysName |
Value to be returned for system.sysName variable |
string |
sysContact |
Value to be returned for system.sysContact variable |
string |
sysLocation |
Value to be returned for system.sysLocation variable |
string |
4.489. SNMPTrapDestination
Name | Description | Schema |
---|---|---|
trapDestinationRef |
SNMP trap destination reference. |
string |
trapReceiverIpAddress |
IPVx address of the trap receiver |
|
communityRef |
Community associated with the trap destination |
string |
sendAuthenticationFailureTraps |
Send authentication failure traps to this destination. |
boolean |
4.490. Schedule
Name | Description | Schema |
---|---|---|
calendar |
Daily, weekly, or monthly calendar information. |
|
startDate |
The schedule will not run until this date/time, measured as seconds since midnight, January 1st, 1970 local time. |
string (int64) |
recurrence |
The number of days, weeks, or months to run. |
|
timezone |
Specification of the time zone. |
4.491. ScheduleCalendar
Name | Description | Schema |
---|---|---|
scheduleMethod |
This enumeration specifies the different types of scheduling methods. |
enum (unknown, daily, weekly, monthlyDate, monthlyDay, __UNDEFINED) |
daily |
This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_DAILY. |
|
weekly |
This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_WEEKLY. |
|
monthlyByDate |
This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_MONTHLY_DATE. |
|
monthlyByDay |
This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_MONTHLY_DAY. |
4.492. ScheduleDaily
Name | Description | Schema |
---|---|---|
dailySchedule |
Conveys time information, including time of day, recurrence and occurrence frequency. |
4.493. ScheduleInstance
Name | Description | Schema |
---|---|---|
schedRef |
A reference to the schedule object. |
string |
scheduleStatus |
The current status of the schedule. |
enum (unknown, active, disabled, completed, __UNDEFINED) |
action |
The type of action to be taken. |
enum (unknown, resnap, newpit, newcgpit, __UNDEFINED) |
targetObject |
The object associated with schedule. |
string |
schedule |
The schedule information. |
|
creationTime |
The schedule creation time (local time) measured as seconds since January 1, 1970. |
string (int64) |
lastRunTime |
The last run time (local time) measured as seconds since January 1, 1970. |
string (int64) |
nextRunTime |
The next run time (local time) measured as seconds since January 1, 1970. |
string (int64) |
stopTime |
The local time after which schedule is no longer active, measured as seconds since January 1, 1970. |
string (int64) |
id |
Example : |
string |
4.494. ScheduleMonthlyByDate
Name | Description | Schema |
---|---|---|
daysOfMonth |
This is a bit mask. Values from the DayOfMonth enumeration should be added (or OR’ed) together to set this value. |
< enum (dayOfMonthLast, dayOfMonthNotSpecified, dayOfMonth01, dayOfMonth02, dayOfMonth03, dayOfMonth04, dayOfMonth05, dayOfMonth06, dayOfMonth07, dayOfMonth08, dayOfMonth09, dayOfMonth10, dayOfMonth11, dayOfMonth12, dayOfMonth13, dayOfMonth14, dayOfMonth15, dayOfMonth16, dayOfMonth17, dayOfMonth18, dayOfMonth19, dayOfMonth20, dayOfMonth21, dayOfMonth22, dayOfMonth23, dayOfMonth24, dayOfMonth25, dayOfMonth26, dayOfMonth27, dayOfMonth28, dayOfMonth29, __UNDEFINED, dayOfMonth30, dayOfMonth31) > array |
monthsOfYear |
This is a bit mask. Values from the MonthOfYear enumeration should be added (or OR’ed) together to set this value. |
< enum (notSpecified, january, february, march, april, may, june, july, august, september, october, november, december, __UNDEFINED) > array |
dailySchedule |
Conveys time information, including time of day, recurrence and occurrence frequency. |
4.495. ScheduleMonthlyByDay
Name | Description | Schema |
---|---|---|
dayOfWeek |
The day of the week. This is NOT a bit mask. |
enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED) |
dailySchedule |
Conveys time information, including time of day, recurrence and occurrence frequency. |
|
weekNumber |
The week number during the month. For example, 1 = first, 2 = second, etc., and 5 = last. |
integer (int32) |
monthsOfYear |
This is a bit mask. Values from the MonthOfYear enumeration should be added (or OR’ed) together to set this value. |
< enum (notSpecified, january, february, march, april, may, june, july, august, september, october, november, december, __UNDEFINED) > array |
4.496. ScheduleWeekly
Name | Description | Schema |
---|---|---|
daysOfWeek |
This is a bit mask. Values from the DayOfWeek enumeration should be added (or OR’ed) together to set this value. |
< enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED) > array |
dailySchedule |
Conveys time information, including time of day, recurrence and occurrence frequency. |
4.497. SecuritySettings
Name | Description | Schema |
---|---|---|
certificateRevocationSettings |
The certificate revocation settings. |
4.498. SnapshotVolume
Name | Description | Schema |
---|---|---|
worldWideName |
The World Wide Name of the snapshot. |
string |
snapshotRef |
Reference (key) for the snapshot volume. |
string |
label |
Name of the snapshot. |
string |
status |
Indicates status of the snapshot. |
enum (active, failed, disabled, offline, __UNDEFINED) |
action |
Long running action. |
enum (none, rollback, __UNDEFINED) |
currentManager |
Current owner of the snapshot. |
string |
baseVolume |
Base volume for this snapshot. |
string |
repositoryVolume |
Repository volume for this snapshot. |
string |
fullWarnThreshold |
Repository utilization warning threshold. |
integer (int32) |
overWarnThreshold |
True if the repository utilization is over the warning threshold. |
boolean |
repositoryFull |
True, if the repository is full. |
boolean |
repFullPolicy |
Indication of the volume behavior when the repository is full. |
enum (failwrites, failsnap, __UNDEFINED) |
rollbackPriority |
The importance of the rollback operation (0-4). Not used in this release of software. |
integer (int32) |
extentStart |
The start position of the extent in the base volume (bytes). Not used in this release of software. |
string (int64) |
extentSize |
The size of the extent in bytes. Not used in this release of software. |
string (int64) |
snapshotTime |
The controller time when the snapshot was created. |
string (int64) |
perms |
Permissions allowed on volume. |
|
childrenInactive |
True if all child volumes are offline or failed. Child volumes are the base volume and the REPOSITORY volume. |
boolean |
volumeHandle |
Volume SSID. |
integer (int32) |
mgmtClientAttribute |
For use by management client. |
integer (int32) |
rollbackStatus |
Status of current action being performed on snapshot. |
enum (none, inProgress, pending, paused, __UNDEFINED) |
id |
Example : |
string |
4.499. StagedFirmware
Name | Description | Schema |
---|---|---|
stagedFwValid |
False, staged FW areas on the controllers are not valid and cannot be activated. True, the staged FW areas on the controllers are valid and can be activated. |
boolean |
fwVersion |
The firmware package version identifier. |
string |
appVersion |
The application code version number. |
string |
bootVersion |
The boot code version number. |
string |
nvsramVersion |
The NVSRAM version number. |
string |
timeStamp |
Timestamp when the staged FW was downloaded |
string (int64) |
nvsramVersionString |
The field is deprecated. The nvsramVersion field should be used instead. |
string |
codeVersions |
Version descriptors for staged code modules |
< VersionDescriptor > array |
4.500. StorageArray
Name | Description | Schema |
---|---|---|
saData |
General information and characteristics of the storage array. |
|
safeId |
This field contains a unique identifier maintained by SAFE for use by storage management software. Storage management software uses this data to enable SAFE features and perform Feature Bundle migration. |
|
cache |
Information about cache settings that apply to the storage array as a whole. |
|
accessVolume |
Information about the access volume that is used to convey configuration commands (via the UTM protocol) to the controllers within the storage array. |
|
featureParameters |
An object that provides information about the parameters and limits of certain functions that are supported by the controllers that reside within the storage array. |
|
mediaScanPeriod |
The current value of the media scan period parameter for the storage array. This value indicates the number of days over which a complete scan of the media will occur. The array controller(s) will attempt to achieve this configured period on a best-effort basis, but certain operational factors may cause slight deviations from the configured value. |
integer (int32) |
capabilities |
A variable-length array that provides an enumeration of the high-level capabilities that are supported by the controllers that reside within the storage array. |
< enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, containerBasedApplication, __UNDEFINED) > array |
premiumFeatures |
An object that provides information about the premium features that are currently enabled. This field is deprecated. The featureBundle and featureState fields can be used in its place to obtain information about how features are defined and the state they are in. |
< PremiumFeature > array |
trayPositionList |
A list of tray positions that provides information to the client of the SYMbol interface about the relative physical positions of the trays (i.e. enclosures) that comprise the storage array. In the current implementation of the SYMbol interface, the client is responsible for providing this information to the controller for long-term storage, and also for retrieving it from the controller via this object. That is, the controller does not initially contain a valid tray position list; in fact, the default is an empty list. The client is responsible for obtaining any pertinent information about tray positions via an appropriate external mechanism, and then informing the controller about it via the setSATrayPositions procedure. Once this is done, the controller will always return the position information as part of the StorageArray object. |
|
hostPortType |
This variable-length array has label values that provide descriptive strings for each supported index value that can appear in the HostPort object and its associated elements. |
< string > array |
hostSpecificVals |
The values from the heterogeneous host regions. Each element in this array corresponds to a type in the hostPortType array, and the ordering of the types in this array matches that of the hostPortType array, i.e., hostPortType[i] is equal to hostSpecificVals[i].hostPortType. |
< HostSpecificValues > array |
compatibility |
A variable-length array of firmware compatibility specifiers. These values generally identify certain levels of firmware that are allowed for downgrading the current storage array firmware. |
< CompatibleFirmware > array |
usageHints |
The recommended usage parameter combinations. |
< VolumeUsageHint > array |
definedPartitionCount |
The number of partitions calculated from the user’s current mappings. |
integer (int32) |
defaultHostPortTypeIndex |
The Host Port Type Index to use for undefined and newly created host ports. The defaultHostPortTypeIndex can only be set if Storage Partitions are disabled through the SYMbol Interface. |
integer (int32) |
remoteAccessID |
Array-specific ID used for remote device discovery. |
string |
remoteMirroringActive |
True if RVM is activated. |
boolean |
volXferAlertDelayPeriod |
Volume transfer alert delay period. |
integer (int32) |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
stagedFirmware |
Information on possible staged controller firmware. |
|
unreadableSectors |
Storage array unreadable sector count and max limit. |
|
driveChannels |
A list of drive channel structures. |
< DriveChannel > array |
portLocations |
A list of drive channel port locations. |
< DriveChannelPort > array |
ddcTag |
The tag value to be used in retrieving DDC log data. A value of DDC_NULL_TAG indicates there is no DDC log data to retrieve. |
integer (int32) |
featureBundle |
A structure describing the features and feature limits that are associated with this storage array product. |
|
featureState |
An array describing the current state of the array feature set - one element in the array per feature. This array is used by host software to track feature licensing compliance. It is populated with all supported features having both a feature ID and a capability code, regardless of their enabled or compliance state. Features that are not supported because of gold key restrictions or because there is no way to enable them (i.e., both SHIPPED_ENABLED and KEY_ENABLED are false) are not in the list. |
< FeatureState > array |
channelPortLocations |
A list of all channel ports in the storage array, including host channel ports, drive channel ports, and ESM channel ports. |
< ChannelPort > array |
iscsiEntityData |
Information about the storage array pertaining to its role as an iSCSI entity. |
|
hostType |
This variable-length array has label values that provide descriptive strings for each supported index value that can appear in the Host object. Zero-length strings are allowed and indicate that the associated host-specific NVSRAM regions have been cleared. This field should be used in place of the deprecated hostPortType field. |
< string > array |
defaultHostTypeIndex |
The Host Type Index to use for undefined and newly created host ports. |
integer (int32) |
rvmControllerHostChannel |
The number (in the range 1 through n, where n is the number of host ports on an individual controller) of the controller host channel that the firmware uses for remote volume mirroring. This field is set to zero when the data is unavailable or not applicable, including when the RVM feature is disabled, |
integer (int32) |
smartBatteryData |
sub-structure of StorageArray contains info relating to smart battery configuration. Meaningful if the smartBatteryTechnology field in the featureParameters sub-structure is set to true. Moved to the Battery object instead to support per-battery reporting |
|
invalidSystemConfig |
True if the storage array has an invalid system configuration; otherwise false. |
boolean |
securityLockKey |
A boolean which describes the current state of the lock key. True if the array lock key has been set, otherwise false. |
boolean |
lockKeyIDRef |
The lock key ID for the storage array. |
string |
syslogConfiguration |
This field contains the configuration information used by the storage array for writing MEL events to a syslog server. |
|
securityExternalKmsEnable |
True if external key management is in effect and false if controller is using local key management. |
boolean |
newKeySequence |
Sequence number used to serialize installNewKey requests from multiple proxy key management SYMbol servers. |
integer (int32) |
securityExternalKmsKeyStatus |
The controller’s current key status. If external key management not enabled, set to EXTERNAL_KMS_KEY_STATUS_OK. |
enum (ok, keyNeeded, newKeyNeeded, validationNeeded, __UNDEFINED) |
lockKeyNeededList |
Contains the lock key IDs of keys needed by the array controller. |
< string > array |
dplCoreDumpData |
Information about a core dump in controller memory, if one exists. |
|
fcRVMState |
Indicator of whether fibre channel remote mirroring has been enabled, and if so, whether it is enabled for use by legacy (synchronous) mirroring or ARVM. If this is set to something other than FC_MIRROR_STATE_DISABLED or FC_MIRROR_STATE_UNKNOWN, then the rvmControllerHostChannel field can be used to determine the particular host channel reserved for remote mirroring. |
enum (unknown, disabled, enabledLegacyRvm, enabledArvm, enabledAll, __UNDEFINED) |
asupEnabled |
True if Autosupport is enabled. |
boolean |
asupOnDemandEnabled |
True if Autosupport On Demand is enabled. |
boolean |
asupRemoteDiagsEnabled |
True if Autosupport On Demand Remote Diagnostics is enabled. |
boolean |
iocDumpData |
Information about an IOC Dump in controller memory, if one exists. |
|
driveChannelPortDisabled |
True if one or more drive channel ports have been disabled by the controllers to protect against faulty expansion cabling. This could have been necessitated by a miswire condition or by a bad expansion cable. Check the Recovery Events for an indication of which connection(s) have been disabled and correct the cabling as required. |
boolean |
directExpansionPortInUse |
This boolean is true if direct expansion ports are in use by the controllers. |
boolean |
highResolutionStatisticsEnabled |
Cumulative Performance stats high resolution indicator |
boolean |
autoLoadBalancingEnabled |
Auto Load Balancing is user-enabled on this array |
boolean |
reserved3 |
This reserved field is needed to maintain compatibility with host applications. |
string |
embeddedExternalKMSInformation |
This structure contains the external key management information. See the structure definition for details. |
|
isLun0RestrictedForDefaultPartition |
Provides an indication of whether LUN 0 is restricted (disallowed) for the default storage partition. |
boolean |
securitySettings |
Storage array security settings. |
|
parityCheckOnMediaType |
Indicate whether or not P and Q parity validation is performed on certain drive media types during reconstruction of RAID 6 and disk pool volumes on the Storage Array. |
|
hostConnectivityReportingEnabled |
If host connectivity reporting is enabled/disabled for the the array. |
boolean |
vaaienabled |
Example : |
boolean |
odxenabled |
Example : |
boolean |
4.501. StoragePoolBundle
Name | Description | Schema |
---|---|---|
saPortGroup |
A variable-length array containing all SAPortGroup objects that are currently configured and available. |
< SAPortGroup > array |
saPort |
A variable-length array containing all SAPortGroup objects that are currently configured and available. |
< SAPort > array |
cluster |
A variable-length array containing all defined Cluster objects for the storage array configuration. |
< Cluster > array |
host |
A variable-length array containing all defined Host objects for the storage array configuration. |
< Host > array |
hostPort |
A variable-length array containing all defined HostPort objects for the storage array configuration. |
< HostPort > array |
lunMapping |
A variable-length array containing all defined LUNMapping objects for the storage array configuration. |
< LUNMapping > array |
initiator |
A variable-length array containing all Initiator objects defined in the storage array configuration. |
< Initiator > array |
target |
A variable-length array containing all Target objects defined in the storage array configuration. |
< Target > array |
remoteTarget |
A variable-length array containing all Remote Target objects defined in the storage array configuration. Remote Target objects define the initiator/target on a remote array. |
< RemoteTarget > array |
4.502. SyslogConfiguration
Name | Description | Schema |
---|---|---|
syslogEnabled |
This field is set to true if the writing of MEL events to a syslog server is enabled; otherwise it is false. |
boolean |
syslogServerPortNumber |
This field holds the UDP port number of the syslog server. The default value of this field is SYSLOG_DEFAULT_UDP_PORT. |
integer (int32) |
syslogServerIpAddress |
This field holds the IPVx address of the syslog server. The default value of this field is zero (0.0.0.0). |
4.503. ThinVolume
Name | Description | Schema |
---|---|---|
volumeHandle |
The volumeHandle (SSID) for this volume. |
integer (int32) |
worldWideName |
The World wide name of the volume. |
string |
label |
The name of the volume. |
string |
allocationGranularity |
The allocation cluster size for the Expandable Repository Volume. |
integer (int32) |
capacity |
The virtual capacity of the volume in bytes. |
string (int64) |
reconPriority |
Importance of fixing the volume if failed (0-4). |
integer (int32) |
volumeRef |
The reference (key) for this volume. |
string |
status |
The operational status of the volume. |
enum (unknown, optimal, full, overThresh, failed, initializing, __UNDEFINED) |
repositoryRef |
The Expandable Repository Volume underlying this Thin Volume. |
string |
currentManager |
The controller that currently manages the volume. |
string |
preferredManager |
The controller that should manage the volume. |
string |
perms |
Operations allowed on this volume. |
|
mgmtClientAttribute |
For use by management client. |
integer (int32) |
preReadRedundancyCheckEnabled |
If true, verify RAID redundancy on read operations. |
boolean |
protectionType |
The protection type of the volume. |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
applicationTagOwned |
True if application tag is owned by the storage array. |
boolean |
maxVirtualCapacity |
The maximum virtual capacity to which this thin volume can grow (in bytes). |
string (int64) |
initialProvisionedCapacity |
The initial provisioned capacity for the Expandable Repository Volume for this thin volume (in bytes). |
string (int64) |
currentProvisionedCapacity |
The current provisioned capacity of the Expandable Repository Volume (in bytes). |
string (int64) |
provisionedCapacityQuota |
The maximum capacity of the Expandable Repository Volume (in bytes). |
string (int64) |
growthAlertThreshold |
The percent value at which an alert is generated. |
integer (int32) |
expansionPolicy |
The automatic Expandable Repository Volume expansion policy. |
enum (unknown, manual, automatic, __UNDEFINED) |
volumeCache |
The cache parameters of the underlying repository. |
|
offline |
The thin volume is offline due to the associated repository volume state. |
boolean |
reportingPolicy |
Indicates how the thin volume is reported on the SCSI interface. |
enum (unknown, asThick, asThin, __UNDEFINED) |
extendedUniqueIdentifier |
A variable-length opaque field that provides the volume’s extended unique identification value. |
string |
id |
Example : |
string |
4.504. TimeZoneDescription
Name | Description | Schema |
---|---|---|
tzLabel |
The time zone identifier (ASCII). |
string |
tzOffset |
The time zone offset measured in seconds +/- from GMT. |
integer (int32) |
dstStart |
The DST start date and time. |
|
dstEnd |
The DST end date and time. |
|
dstAdjust |
The number of seconds to adjust the clock during DST |
integer (int32) |
4.505. TrayPosition
Name | Description | Schema |
---|---|---|
trayId |
The tray ID of the tray. |
integer (int32) |
rackId |
An identifier of the enclosure (i.e. rack) in which the tray resides. This is not supported in the current release of the firmware. |
integer (int32) |
4.506. TrayPositionList
Name | Description | Schema |
---|---|---|
trayPosition |
A variable-length array of TrayPosition objects. |
< TrayPosition > array |
4.507. UnreadableSectors
Name | Description | Schema |
---|---|---|
count |
The current number of unreadable sectors persisted. |
integer (int32) |
maxLimit |
The maximum number of unreadable sectors allowed. |
integer (int32) |
4.508. Ups
Name | Description | Schema |
---|---|---|
upsRef |
The reference for this physical UPS. |
string |
status |
The operational status of the UPS. |
enum (optimal, onBattery, __UNDEFINED) |
physicalLocation |
The physical location of the UPS. Note that the tray reference identifies the enclosure containing the UPS, but the slot information does not apply to this component. |
|
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
4.509. Volume
Name | Description | Schema |
---|---|---|
offline |
An indication of whether the volume is currently offline. |
boolean |
extremeProtection |
An indication of whether the volume is configured for extreme protection. Such configurations generally call for extensive consistency checks and parity validations with each I/O request to the volume. |
boolean |
volumeHandle |
The internal identifier value associated with this volume. When the Storage Partitions feature is NOT present, this value represents the logical unit number (LUN) that is used to access the volume via the host I/O path. If the Storage Partitions feature IS enabled, this field has no external meaning. |
integer (int32) |
raidLevel |
The RAID level for which this volume is configured. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
sectorOffset |
The sector offset of this volume within its volume group. This value is provided only to allow the client application to determine the relative positions of multiple volumes within a given volume group. No other assumptions or computations should be made with this value. |
string (int64) |
worldWideName |
A variable-length opaque field that provides the volume’s worldwide unique identification value. |
string |
label |
The user-assigned symbol label associated with the volume. |
string |
blkSize |
The block size (in bytes) of the volume. |
integer (int32) |
capacity |
The capacity (in bytes) of the volume. |
string (int64) |
reconPriority |
The reconstruction priority value for the volume. This value is in the range 0-4, with 0 indicating that reconstruction is favored over any I/O, and 4 indicating that reconstruction should be performed with minimal impact to I/O. Intermediate values indicate various levels of compromise between these two extremes. |
integer (int32) |
segmentSize |
The segment size (in bytes) of the volume. The segment size is, for the most part, an indication of the stripe depth used to lay out the volume’s block addresses. |
integer (int32) |
action |
An indication of what current long-running activity, if any, is currently in progress on the volume. |
enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED) |
cache |
The volume-specific caching parameters currently in effect for the volume. |
|
mediaScan |
The volume-specific media scan settings currently in effect for the volume. |
|
volumeRef |
The unique identification value for this volume. Other objects may use this reference value to refer to the volume. |
string |
status |
The current operational state of the volume. |
enum (optimal, degraded, failed, impaired, creating, deleting, __UNDEFINED) |
volumeGroupRef |
The volume group reference value of the volume group on which this volume resides. |
string |
currentManager |
The reference value of the controller that currently owns (i.e. manages) this volume. In non-AVT (Auto Volume Transfer) mode, host I/O access to the blocks in this volume is permitted only through the controller that is the current manager. In AVT mode, an I/O access to the controller that is not the current manager causes it to automatically become the current manager. |
string |
preferredManager |
The reference value of the controller that is the preferred manager of the volume. The preferred manager is tracked independent of the current manager, since the current manager may be switched dynamically as a result of host-base multi-path transitions. Later, when the error conditions that cause a multi-path transition have been corrected it is still possible to determine the preferred manager and switch ownership back to it. |
string |
perms |
Operations allowed on this volume. |
|
mgmtClientAttribute |
For use by management client. |
integer (int32) |
dssPreallocEnabled |
True if dynamic segment sizing pre-allocation is enabled for the volume. |
boolean |
dssMaxSegmentSize |
The maximum segment size (in bytes) that this volume could assume with the dynamic segment sizing feature. This field is only meaningful if dssPreallocEnabled is true. |
integer (int32) |
preReadRedundancyCheckEnabled |
If set to true, then the storage controller will, on READ operations, verify the consistency of RAID redundancy data for the stripe(s) containing the READ data. |
boolean |
protectionInformationCapable |
This field is no longer used. |
boolean |
protectionType |
The protection type of the volume. |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
applicationTagOwned |
True if application tag is owned by the storage array. |
boolean |
repairedBlockCount |
This element contains a count of the number of blocks in the volume that have had data assurance errors repaired. |
integer (int32) |
extendedUniqueIdentifier |
A variable-length opaque field that provides the volume’s extended unique identification value. |
string |
cacheMirroringValidateProtectionInformation |
True if checking of protection information during cache mirroring is enabled for this volume, false otherwise |
boolean |
expectedProtectionInformationAppTag |
Expected Protection Information Application Tag for the volume |
integer (int32) |
name |
Example : |
string |
id |
Example : |
string |
4.510. VolumeCache
Name | Description | Schema |
---|---|---|
cwob |
A true value means that the controller is allowed to use write-back caching of dirty data even when the cache memory’s battery-backup protection is not available or not operational. A false value means that any problems with the battery-backup protection of the write cache will cause the controller to suspend all write-back caching operations for the volume. |
boolean |
enterpriseCacheDump |
A true value means that all dirty data in the write cache will be flushed immediately and further write-back caching will be disabled if the controller detects that a UPS unit has switched from standard power to battery backup. A false value means that write-back caching is not impacted by the state of the UPS. |
boolean |
mirrorActive |
An indication of whether the cache mirroring option is active for the volume’s data. |
boolean |
mirrorEnable |
An indication of whether the cache mirroring feature is currently enabled for this volume. It is possible that the mirrorEnable and mirrorActive values differ; this may occur, for example, if the alternate controller is removed or failed. |
boolean |
readCacheActive |
An indication of whether read caching is active for the volume. |
boolean |
readCacheEnable |
An indication of whether read caching is enabled for the volume. Note that this value may not match the readCacheActive setting in cases where problems with the controller cache or its battery back-up have been detected. |
boolean |
writeCacheActive |
An indication of whether write-back caching is active for the volume. |
boolean |
writeCacheEnable |
An indication of whether write-back caching is enabled for the volume. Note that this value may not match the writeCacheActive setting in cases where problems with the controller cache or its battery back-up have been detected. |
boolean |
cacheFlushModifier |
The cache flush modifier value, which is used to specify the maximum amount of time that dirty data for this volume may be retained in the controller’s write cache prior to being flushed to disk. |
enum (flushImmediate, flush250Msec, flush500Msec, flush750Msec, flush1Sec, flush1500Msec, flush2Sec, flush5Sec, flush10Sec, flush20Sec, flush60Sec, flush120Sec, flush300Sec, flush1200Sec, flush3600Sec, flushInfinite, __UNDEFINED) |
readAheadMultiplier |
A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled. |
integer (int32) |
4.511. VolumeCopy
Name | Description | Schema |
---|---|---|
worldWideName |
The World Wide Name of the volume copy. |
string |
volcopyHandle |
The Volume Copy ID(ssid of proxy). |
integer (int32) |
volcopyRef |
Reference (key) for copy. |
string |
status |
Indicates status of copy. |
enum (inProgress, complete, halted, failed, pending, __UNDEFINED) |
sourceVolume |
Source volume reference. |
string |
targetVolume |
Target volume reference. |
string |
currentManager |
Current owner of copy. |
string |
idleTargetWriteProt |
Apply write protection to target volume when copy is idle (true/false). |
boolean |
copyCompleteTime |
Time copy operation completed. |
string (int64) |
copyStartTime |
Time copy operation began. |
string (int64) |
copyPriority |
Importance of copy operation. |
enum (priority0, priority1, priority2, priority3, priority4, __UNDEFINED) |
reserved1 |
Example : |
string |
cloneCopy |
The volume copy is a clone. |
boolean |
pgRef |
For clones based on PiT Groups, this will identify the PiT Group. |
string |
id |
Example : |
string |
4.512. VolumeGroup
Name | Description | Schema |
---|---|---|
sequenceNum |
A sequence number that uniquely identifies this volume group within the array in which it resides. Sequence numbers are assigned to volume groups when they are created or imported into a storage array. The controller assigns the lowest unused sequence number during a creation or import operation. |
integer (int32) |
offline |
An indication of whether the volume group is currently offline. A volume group can be taken offline by the operator in preparation for removing its drives and transporting them to another storage array. |
boolean |
raidLevel |
The RAID level associated with this volume group. If the storage array supports multiple RAID levels per volume group, this value will be set to RAID_ALL. Otherwise, it will indicate the precise RAID level defined for the volume group. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
worldWideName |
A variable-length opaque field that provides the volume group’s worldwide unique identification value. |
string |
volumeGroupRef |
The unique identification value for this volume group. Other objects may use this reference value to refer to the volume group. |
string |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
trayLossProtection |
An indication as to whether the volume group has tray loss protection. |
boolean |
label |
The volume group label, which can be set by the user. |
string |
state |
The state of the volume group. |
enum (contingent, exported, forced, complete, partial, incomplete, missing, __UNDEFINED) |
spindleSpeedMatch |
Set to true if all of the drives in the group have matching normalized spindle speeds. (Normalized spindle speeds are standardized norms (e.g., 5400, 7200, etc.) that are used for spindle speed matching, even though actual spindle speeds may be within a designated delta of the normalized speed.) |
boolean |
spindleSpeed |
Set to true if all of the drives in the group have matching normalized spindle speeds. (Normalized spindle speeds are standardized norms (e.g., 5400, 7200, etc.) that are used for spindle speed matching, even though actual spindle speeds may be within a designated delta of the normalized speed.) |
integer (int32) |
isInaccessible |
True if the volume group contains incompatible drives that have been locked out. |
boolean |
securityType |
security status of the drive group |
enum (unknown, none, capable, enabled, __UNDEFINED) |
drawerLossProtection |
This field is set to true when the volume group has drawer loss protection; otherwise it is set to false |
boolean |
protectionInformationCapable |
This field is no longer used. |
boolean |
protectionInformationCapabilities |
This structure contains a protectionInformationCapable field which is set to true if all drives in the volume group are Protection Information (PI) capable. It also contains a field that is set to the protection type for the volume group. |
|
volumeGroupData |
Information about the Volume Group. |
|
usage |
the volume group usage. |
enum (unknown, standard, flashcache, __UNDEFINED) |
driveBlockFormat |
Identifies the drive block format of the volume candidate. |
enum (unknown, allNative, allEmulated, mixed, __UNDEFINED) |
reservedSpaceAllocated |
This field will be used to report whether or not reserved space has been claimed on all drives in the volume group. The recovery-volume script will include this field for each volume group record it creates, so that during volume recovery the volume group is recreated correctly. |
boolean |
securityLevel |
Refines the information in the securityType field to describe the set of drives. |
enum (unknown, none, mixed, fde, fips, __UNDEFINED) |
name |
Example : |
string |
id |
Example : |
string |
4.513. VolumeGroupTypeData
Name | Description | Schema |
---|---|---|
type |
This enumeration is used to indicate the type of the volume group. |
enum (unknown, traditional, diskPool, __UNDEFINED) |
diskPoolData |
This field is present only if the value of type is equal to VG_TYPE_DISK_POOL. |
4.514. VolumeUsageHint
Name | Description | Schema |
---|---|---|
usageHint |
How the volume will be used (e.g. multimedia, transactional, file system). |
enum (multimedia, transactional, filesystem, __UNDEFINED) |
segmentSize |
The volume segment size. |
integer (int32) |
readAhead |
A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled. |
integer (int32) |
4.515. Workload
Name | Description | Schema |
---|---|---|
workloadRef |
The unique handle for the object contained within this structure (a 1st class object). |
string |
description |
The workload description describes the workload (not the workload type). |
string |
4.516. WorkloadVolumeMapping
Name | Description | Schema |
---|---|---|
mappingRef |
This field is the unique identifier for the mapping between the workload and the volume. |
string |
workloadRef |
This field is the unique identifier for the Workload. |
string |
volumeRef |
This field is the unique identifier for the volume. |
string |
4.517. PasswordStatusResponse
Indicate if the passwords are set on the storage array
Name | Description | Schema |
---|---|---|
adminPasswordSet |
Example : |
boolean |
readOnlyPasswordSet |
Example : |
boolean |
4.518. PasswordSetRequest
Passed in to set the passwords. The security on this call is a little different. If the admin password is <b>not</b> set and adminPassword is true, than this call is allowed. If the admin password is set, then the user must have a valid login session as admin
Name | Description | Schema |
---|---|---|
currentAdminPassword |
The current admin password |
string |
adminPassword |
If this is true, this call will set the admin password, if false, it sets the RO password |
boolean |
newPassword |
The new password |
string |
4.519. RemoteMirrorPair
Name | Description | Schema |
---|---|---|
base |
Example : |
|
target |
Example : |
|
baseArray |
Example : |
string |
targetArray |
Example : |
string |
id |
Example : |
string |
lastStartTime |
Example : |
string (date-time) |
lastCompleteTime |
Example : |
string (date-time) |
state |
Example : |
integer (int32) |
priority |
Example : |
integer (int32) |
writeMode |
Example : |
integer (int32) |
autoResync |
Example : |
boolean |
featureActive |
Example : |
boolean |
status |
Example : |
enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED) |
baseStatus |
Example : |
enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED) |
targetStatus |
Example : |
enum (optimal, unsynchronized, synchronizing, notready, suspended, failed, failedsuspended, degradedSynchronizing, degradedUnsynchronized, __UNDEFINED) |
4.520. VolumeEx
Name | Description | Schema |
---|---|---|
offline |
An indication of whether the volume is currently offline. |
boolean |
extremeProtection |
An indication of whether the volume is configured for extreme protection. Such configurations generally call for extensive consistency checks and parity validations with each I/O request to the volume. |
boolean |
volumeHandle |
The internal identifier value associated with this volume. When the Storage Partitions feature is NOT present, this value represents the logical unit number (LUN) that is used to access the volume via the host I/O path. If the Storage Partitions feature IS enabled, this field has no external meaning. |
integer (int32) |
raidLevel |
The RAID level for which this volume is configured. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
sectorOffset |
The sector offset of this volume within its volume group. This value is provided only to allow the client application to determine the relative positions of multiple volumes within a given volume group. No other assumptions or computations should be made with this value. |
string (int64) |
worldWideName |
A variable-length opaque field that provides the volume’s worldwide unique identification value. |
string |
label |
The user-assigned symbol label associated with the volume. |
string |
blkSize |
The block size (in bytes) of the volume. |
integer (int32) |
capacity |
The capacity (in bytes) of the volume. |
string (int64) |
reconPriority |
The reconstruction priority value for the volume. This value is in the range 0-4, with 0 indicating that reconstruction is favored over any I/O, and 4 indicating that reconstruction should be performed with minimal impact to I/O. Intermediate values indicate various levels of compromise between these two extremes. |
integer (int32) |
segmentSize |
The segment size (in bytes) of the volume. The segment size is, for the most part, an indication of the stripe depth used to lay out the volume’s block addresses. |
integer (int32) |
action |
An indication of what current long-running activity, if any, is currently in progress on the volume. |
enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED) |
cache |
The volume-specific caching parameters currently in effect for the volume. |
|
mediaScan |
The volume-specific media scan settings currently in effect for the volume. |
|
volumeRef |
The unique identification value for this volume. Other objects may use this reference value to refer to the volume. |
string |
status |
The current operational state of the volume. |
enum (optimal, degraded, failed, impaired, creating, deleting, __UNDEFINED) |
volumeGroupRef |
The volume group reference value of the volume group on which this volume resides. |
string |
currentManager |
The reference value of the controller that currently owns (i.e. manages) this volume. In non-AVT (Auto Volume Transfer) mode, host I/O access to the blocks in this volume is permitted only through the controller that is the current manager. In AVT mode, an I/O access to the controller that is not the current manager causes it to automatically become the current manager. |
string |
preferredManager |
The reference value of the controller that is the preferred manager of the volume. The preferred manager is tracked independent of the current manager, since the current manager may be switched dynamically as a result of host-base multi-path transitions. Later, when the error conditions that cause a multi-path transition have been corrected it is still possible to determine the preferred manager and switch ownership back to it. |
string |
perms |
Operations allowed on this volume. |
|
mgmtClientAttribute |
For use by management client. |
integer (int32) |
dssPreallocEnabled |
True if dynamic segment sizing pre-allocation is enabled for the volume. |
boolean |
dssMaxSegmentSize |
The maximum segment size (in bytes) that this volume could assume with the dynamic segment sizing feature. This field is only meaningful if dssPreallocEnabled is true. |
integer (int32) |
preReadRedundancyCheckEnabled |
If set to true, then the storage controller will, on READ operations, verify the consistency of RAID redundancy data for the stripe(s) containing the READ data. |
boolean |
protectionInformationCapable |
This field is no longer used. |
boolean |
protectionType |
The protection type of the volume. |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
applicationTagOwned |
True if application tag is owned by the storage array. |
boolean |
repairedBlockCount |
This element contains a count of the number of blocks in the volume that have had data assurance errors repaired. |
integer (int32) |
extendedUniqueIdentifier |
A variable-length opaque field that provides the volume’s extended unique identification value. |
string |
cacheMirroringValidateProtectionInformation |
True if checking of protection information during cache mirroring is enabled for this volume, false otherwise |
boolean |
expectedProtectionInformationAppTag |
Expected Protection Information Application Tag for the volume |
integer (int32) |
volumeUse |
Example : |
enum (standardVolume, repositoryVolume, mirrorTargetVolume, mirrorSourceVolume, concatVolume, freeRepositoryVolume, asyncMirrorSourceVolume, asyncMirrorTargetVolume) |
volumeFull |
Example : |
boolean |
volumeCopyTarget |
This value is true if the volume is currently the target of a volume copy pair. |
boolean |
volumeCopySource |
This value is true if the volume is currently the source in a volume copy pair. |
boolean |
pitBaseVolume |
Example : |
boolean |
asyncMirrorTarget |
This value is true if the volume is currently the target in an Asynchronous Mirror relationship. |
boolean |
asyncMirrorSource |
This value is true if the volume is currently the source in an Asynchronous Mirror relationship. |
boolean |
remoteMirrorSource |
True if the volume is a source (primary), in an Remote Volume Mirror relationship. |
boolean |
remoteMirrorTarget |
True if the volume is a target (secondary), in an Remote Volume Mirror relationship. |
boolean |
diskPool |
True if the volume was defined on a DiskPool. |
boolean |
flashCached |
True if this volume is added to a flashCache. |
boolean |
increasingBy |
If a Dynamic Volume Expansion (DVE) is in progress, the total capacity the volume is being increased by, otherwise zero. |
string (int64) |
metadata |
Metadata associated with the volume |
< VolumeMetadataItem > array |
dataAssurance |
Example : |
boolean |
objectType |
Example : |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
currentControllerId |
Example : |
string |
wwn |
Example : |
string |
listOfMappings |
Example : |
< LUNMapping > array |
mapped |
Example : |
boolean |
totalSizeInBytes |
Example : |
string (int64) |
preferredControllerId |
Example : |
string |
onlineVolumeCopy |
Example : |
boolean |
cacheSettings |
The volume-specific caching parameters currently in effect for the volume. |
|
thinProvisioned |
Example : |
boolean |
name |
Example : |
string |
id |
Example : |
string |
4.521. VolumeMetadataItem
Key/Value pair for volume meta data
Name | Description | Schema |
---|---|---|
key |
They key for the property. Some keys are reserved include:workload |
string |
value |
The value associated with the key |
string |
4.522. RemoteVolumeMirrorCreateRequest
Creates new Remote Volume Mirror
Name | Description | Schema |
---|---|---|
srcVolID |
Remote Volume Mirror source volume ID. |
string |
tgtVolWWN |
Example : |
string |
remoteArrayId |
Example : |
string |
copyType |
Example : |
integer (int32) |
priority |
Example : |
integer (int32) |
autoResync |
Example : |
boolean |
4.523. RemoteVolumeMirrorUpdateRequest
Updates the RemoteVolumeMirror Data.
Name | Description | Schema |
---|---|---|
baseVolumeId |
Remote Volume Mirror base volume. |
string |
remoteVolumeId |
Remote Volume Mirror remote volume. |
string |
role |
Remote Volume Mirror role. 0, set role to primary. 1, set role to secondary |
integer (int32) |
updateType |
Remote Volume Mirror update type request. |
enum (suspend, resume, resync, roleChange, updateParams) |
priority |
Example : |
integer (int32) |
writeMode |
Example : |
integer (int32) |
autoResync |
Example : |
boolean |
4.524. RemoteCommunicationData
Name | Description | Schema |
---|---|---|
samples |
Example : |
< integer (int32) > array |
timeout |
Example : |
integer (int32) |
4.525. JobProgress
A Volume Copy Job Control provides the start-stop operation for a <a href="VolumeCopyPair.html">Volume Copy Job</a> and reports the copy progress of the volume copy job. <br/><br/> The valid values for the PUT control attribute are "start" and "stop"
Name | Description | Schema |
---|---|---|
objectId |
Example : |
string |
percentComplete |
Example : |
integer (int32) |
4.526. RemoteMirrorCandidate
Name | Description | Schema |
---|---|---|
sourceVolume |
Example : |
|
targetVolumes |
Example : |
< VolumeEx > array |
targetArrayName |
Example : |
string |
targetArrayId |
Example : |
string |
4.527. CVCandidateResponse
Name | Description | Schema |
---|---|---|
raidLevelMatch |
Example : |
boolean |
samePool |
Example : |
boolean |
candidate |
Example : |
|
volumeGroupId |
Example : |
string |
capacityMatch |
Example : |
boolean |
qosMatch |
Example : |
boolean |
diskPool |
Example : |
boolean |
capacity |
Example : |
string (int64) |
baseMappableObjectId |
Example : |
string |
candidateType |
Example : |
enum (unknown, newVol, existingVols, expansion, __UNDEFINED) |
securityMatch |
True if the drive security settings for the base pool and the candidate’s pool match. |
boolean |
daMatch |
True if the DataAssurance settings for the base and the candidate match. |
boolean |
driveTypeMatch |
True if the drives for the base pool and the candidate’s pool match. |
boolean |
existingCandidate |
True if the repository candidate is based on an existing volume and does not require a volume creation to occur. |
boolean |
4.528. CVCandidateSelectionRequest
Name | Description | Schema |
---|---|---|
useFreeRepositoryVolumes |
Default : |
boolean |
candidateRequest |
Example : |
|
exclusions |
Example : |
< ConcatVolumeCandidate > array |
4.529. ConcatVolumeCandidateRequest
Name | Description | Schema |
---|---|---|
baseVolumeRef |
Example : |
string |
percentCapacity |
Percent capacity of the baseVolume to use for the repository. |
number (double) |
concatVolumeType |
Define the type of object the repository will be utilized for. This will allow the capacity to be adjusted to meet required minimums. |
enum (snapshot, thinVolume, asyncMirror, other) |
4.530. CVCandidateMultipleSelectionRequest
Name | Description | Schema |
---|---|---|
candidateRequests |
Example : |
< ConcatVolumeCandidateRequest > array |
exclusions |
Example : |
< ConcatVolumeCandidate > array |
useFreeRepositoryVolumes |
Default : |
boolean |
4.531. ConcatRepositoryVolume
Name | Description | Schema |
---|---|---|
concatVolRef |
A reference (key) for ConcatVolume. |
string |
status |
The status/state of the concatenated volume. This will be the worst status among the member volumes. |
enum (unknown, optimal, degraded, failed, __UNDEFINED) |
memberCount |
The number of actual storage volumes comprising this volume. Note that this is just for convenience, this information can be derived from member objects. |
integer (int32) |
aggregateCapacity |
The aggregate capacity in bytes of all member volumes. |
string (int64) |
mediaScanParams |
Media scan parameters. |
|
volumeHandle |
The volume ssid. This is provided primarily for debug purposes. |
integer (int32) |
allowedOperations |
Operations allowed on the ConcatVolume. This can be used if ConcatVolume is ever exposed as a host-addressable volume to specify whether the volume is host-mappable or not (repository volumes would never be mappable). |
|
memberRefs |
Example : |
< string > array |
baseObjectType |
Example : |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
baseObjectId |
Example : |
string |
id |
Example : |
string |
4.532. ConcatVolumeExpansionRequest
Expand the repository of a Snapshot Group, Snapshot Volume, AsyncMirror Member, or ThinVolume.
Name | Description | Schema |
---|---|---|
repositoryRef |
Identifier of the concatVolume to expand. |
string |
expansionCandidate |
An expansion candidate to use for expanding the capacity of the repository. |
4.533. SamlConfiguration
The SAML configuration
Name | Description | Schema |
---|---|---|
samlEnabled |
True if SAML enabled, false otherwise |
boolean |
identityProviders |
List of configured Identity Providers |
< SamlIdentityProvider > array |
serviceProviders |
List of Service Providers |
< SamlServiceProvider > array |
4.534. SamlIdentityProvider
Identity Provider instance
Name | Description | Schema |
---|---|---|
id |
Identity Provider Id |
string |
entityId |
Globally unique name for SAML entity |
string |
singleSignOnEndpoint |
Single sign-on endpoint users will be redirected to for authentication |
string |
singleLogoutEndpoint |
Single sign-on endpoint users will be redirected to for logout |
string |
namedIdFormats |
List of named Id formats |
< string > array |
roles |
List of role mappings for this identity provider |
< SamlRole > array |
signingCertificates |
List of X.509 certificates used by the identity provider to sign messages |
< string > array |
4.535. SamlRole
SAML role instance
Name | Description | Schema |
---|---|---|
attribute |
Group attributes from the Identity Provider |
string |
match |
Regex to match against |
string |
roles |
Local storage array roles |
< enum (security_admin, storage_none, support_admin, storage_monitor, storage_admin) > array |
4.536. SamlServiceProvider
Service provider information
Name | Description | Schema |
---|---|---|
domainName |
Service Provider domain name |
string |
controllerPosition |
Managing controller position |
integer (int32) |
4.537. SamlTestResponse
Response for SAML test
Name | Description | Schema |
---|---|---|
status |
The status of the test |
enum (ok, failed, notRun, running, missingRequiredRoles) |
startTime |
Start time of the test |
string (int64) |
4.538. SamlLoginRequest
Payload for a SAML authentication request
Name | Description | Schema |
---|---|---|
redirectUrl |
The URL to return to after successful authentication |
string |
4.539. SamlRolesRequest
Payload to map roles to an identity provider
Name | Description | Schema |
---|---|---|
roles |
SAML role configuration |
< SamlRole > array |
4.540. SecureVolumeKeyResponse
Name | Description | Schema |
---|---|---|
fileSize |
Example : |
string (int64) |
fileName |
Example : |
string |
lockKeyId |
The id of the lock key. |
string |
4.541. SecureVolumeKeyRequest
Creates a secure volume (FDE) key.
Name | Description | Schema |
---|---|---|
lockKeyId |
An id used to identify the generated lock key. |
string |
passPhrase |
Passphrase for the key. |
string |
setLockKey |
Apply the generated lock key. |
boolean |
4.542. SecurityKeyFileRequest
This class describes the input for a obtaining a security key file
Name | Description | Schema |
---|---|---|
fileName |
The name that the exported file should be given |
string |
passPhrase |
The passphrase for the security key |
string |
4.543. HttpResponseHeader
Customized HTTP response headers. HTTP response headers can be customized on specific base URL paths and will override the default HTTP response header if it is already present.
Name | Description | Schema |
---|---|---|
header |
HTTP response header. Only a subset of HTTP response headers are supported. |
enum (xFrameOptions) |
value |
Value of the HTTP response header. A null or empty string will cause this header to be omitted from the HTTP response. |
string |
baseUrlPath |
Base URL path in which to include this HTTP response header. A "/", null or empty string will cause this header to be added to every response. |
string |
4.544. ServerSettings
Server settings.
Name | Description | Schema |
---|---|---|
httpResponseHeaders |
Customized HTTP response headers. HTTP response headers can be customized on specific base URL paths and will override the default HTTP response header if it is already present. |
< HttpResponseHeader > array |
4.545. Settings
Settings that apply to the entire Web Services instance.
Name | Description | Schema |
---|---|---|
serverSettings |
Server settings. |
4.546. SnapshotGroup
Name | Description | Schema |
---|---|---|
pitGroupRef |
The reference (key) for the PiT Group. |
string |
label |
The name of the PiT Group. If this PiT group is part of a consistency group, then this label does not have to be present or unique as the parent consistency group label will be used. |
string |
status |
The status of the PiT Group. |
enum (unknown, optimal, full, failed, overThreshold, __UNDEFINED) |
baseVolume |
The base volume for this PiT Group. |
string |
repositoryVolume |
The copy-on-write (CoW) Repository for this PiT group. |
string |
clusterSize |
The cluster size (in bytes). |
integer (int32) |
maxRepositoryCapacity |
The maximum allowable repository size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group. |
string (int64) |
maxBaseCapacity |
The maximum allowable base volume size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group. |
string (int64) |
unusableRepositoryCapacity |
The amount of repository capacity that is unusable due to limited addressability of the current cluster size. |
string (int64) |
repFullPolicy |
The behavior on repository full condition. Overridden by consistency group setting if this PITGroup is associated with a consistency group. |
enum (unknown, failbasewrites, purgepit, __UNDEFINED) |
fullWarnThreshold |
The repository utilization warning threshold percentage. |
integer (int32) |
autoDeleteLimit |
The auto-delete indicator. If non-zero, the oldest PiT will be automatically deleted when creating a new one to keep the total number of PiTs limited to the number specified. This value is overridden by the consistency group setting if this PITGroup is associated with a consistency group. |
integer (int32) |
action |
Long running operation. |
enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED) |
rollbackStatus |
The status of the rollback (if rollback is indicated in VolumeAction above). |
enum (unknown, none, inProgress, pending, paused, __UNDEFINED) |
rollbackPriority |
The importance of the rollback operation. |
enum (highest, high, medium, low, lowest, __UNDEFINED) |
consistencyGroup |
If true, this PiT group is part of a consistency group. |
boolean |
consistencyGroupRef |
A reference to the parent consistency group, if applicable. This value will be NULL if this PiT group is not part of a consistency group. |
string |
creationPendingStatus |
The status of Pending PiT Creation. |
enum (unknown, none, waiting, failed, __UNDEFINED) |
volumeHandle |
The PiT group SSID. This is provided primarily for debug purposes. |
integer (int32) |
volcopyId |
Example : |
string |
snapshotCount |
Example : |
integer (int32) |
repositoryCapacity |
The aggregate capacity of the repository in bytes |
string (int64) |
id |
Example : |
string |
name |
Example : |
string |
4.547. SnapshotGroupUpdateRequest
Updates a Snapshot Group (PiT Group).
Name | Description | Schema |
---|---|---|
name |
The name of the new snapshot group. |
string |
warningThreshold |
The repository utilization warning threshold, as a percentage of the repository volume capacity. |
integer (int32) |
autoDeleteLimit |
The automatic deletion indicator. If non-zero, the oldest snapshot image will be automatically deleted when creating a new snapshot image to keep the total number of snapshot images limited to the number specified. |
integer (int32) |
fullPolicy |
The behavior on when the data repository becomes full. This value is overridden by consistency group setting if this snapshot group is associated with a consistency group. |
enum (unknown, failbasewrites, purgepit, __UNDEFINED) |
rollbackPriority |
The importance of the rollback operation. This value is overridden by consistency group setting if this snapshot group is associated with a consistency group. |
enum (highest, high, medium, low, lowest, __UNDEFINED) |
4.548. ScheduleCreateRequest
Creates a Schedule for a Snapshot (PiT) or Legacy Snapshot.
Name | Description | Schema |
---|---|---|
action |
The schedule action type. |
enum (unknown, resnap, newpit, newcgpit, __UNDEFINED) |
targetObject |
The SYMbol reference of the target object. |
string |
scheduleMethod |
The schedule calendar type. |
enum (unknown, daily, weekly, monthlyDate, monthlyDay, __UNDEFINED) |
dailySchedule |
The daily schedule times for all schedule methods. |
|
daysOfWeek |
The days of the week for the weekly schedule method. |
< enum (notSpecified, sunday, monday, tuesday, wednesday, thursday, friday, saturday, __UNDEFINED) > array |
monthsOfYear |
The months of the year for the monthly by date schedule method. |
< enum (notSpecified, january, february, march, april, may, june, july, august, september, october, november, december, __UNDEFINED) > array |
daysOfMonth |
The days of the month for the monthly by date schedule method. |
< enum (dayOfMonthLast, dayOfMonthNotSpecified, dayOfMonth01, dayOfMonth02, dayOfMonth03, dayOfMonth04, dayOfMonth05, dayOfMonth06, dayOfMonth07, dayOfMonth08, dayOfMonth09, dayOfMonth10, dayOfMonth11, dayOfMonth12, dayOfMonth13, dayOfMonth14, dayOfMonth15, dayOfMonth16, dayOfMonth17, dayOfMonth18, dayOfMonth19, dayOfMonth20, dayOfMonth21, dayOfMonth22, dayOfMonth23, dayOfMonth24, dayOfMonth25, dayOfMonth26, dayOfMonth27, dayOfMonth28, dayOfMonth29, __UNDEFINED, dayOfMonth30, dayOfMonth31) > array |
startDate |
The start date for the schedule. |
string (int64) |
endDate |
The end date for the schedule, 0 for no end date. |
string (int64) |
timezone |
The schedule time zone information. |
4.549. SnapshotGroupCreateRequest
Creates a Snapshot Group (PiT Group).
Name | Description | Schema |
---|---|---|
baseMappableObjectId |
The identifier of the volume or thin volume to use as the base for the new snapshot group. |
string |
name |
The name of the new snapshot group. |
string |
repositoryPercentage |
The size of the repository in relation to the size of the base volume. |
number (double) |
warningThreshold |
The repository utilization warning threshold, as a percentage of the repository volume capacity. |
integer (int32) |
autoDeleteLimit |
The automatic deletion indicator. If non-zero, the oldest snapshot image will be automatically deleted when creating a new snapshot image to keep the total number of snapshot images limited to the number specified. This value is overridden by the consistency group setting if this snapshot group is associated with a consistency group. |
integer (int32) |
fullPolicy |
The behavior on when the data repository becomes full. This value is overridden by consistency group setting if this snapshot group is associated with a consistency group. |
enum (unknown, failbasewrites, purgepit, __UNDEFINED) |
storagePoolId |
The identifier of the storage pool on which to allocate the repository volume. Ignored if a repositoryCandidate is provided. |
string |
repositoryCandidate |
Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected. |
|
schedule |
An optional schedule to be used to automatically create snapshot images. |
4.550. PITGroupRepositoryUtilization
Name | Description | Schema |
---|---|---|
pitGroupBytesUsed |
The total number of bytes used in the repository for all PiTs in the group. |
string (int64) |
pitGroupBytesAvailable |
The total number of bytes available for ongoing copy-on-write operations. |
string (int64) |
groupRef |
The PiT Group for which this utilization information applies. |
string |
pitUtilization |
The repository utilization of each specific PiT in the PiT group. |
< PITRepositoryUtilization > array |
4.551. PITRepositoryUtilization
Name | Description | Schema |
---|---|---|
pitRef |
A reference to the specific PiT for which utilization is being reported. |
string |
bytesUsed |
The total number of bytes in use in the repository for this specific PiTs metadata, copy-on-write indexes, and copy-on-write data. |
string (int64) |
4.552. SnapshotCreateRequest
Creates a Snapshot (PiT) within the specified Snapshot Group (PiT Group).
Name | Description | Schema |
---|---|---|
groupId |
The identifier of the snapshot group for the new snapshot image. |
string |
4.553. PITViewRepositoryUtilization
Name | Description | Schema |
---|---|---|
viewBytesUsed |
The number of bytes used in the repository for the view metadata, copy-on-write indexes, and copy-on-write data. |
string (int64) |
viewBytesAvailable |
The total number of bytes available for ongoing copy-on-write operations. |
string (int64) |
viewRef |
The ViewRef for which this utilization applies. |
string |
4.554. SnapshotViewCreateRequest
Creates a Snapshot (PiT) View.
Name | Description | Schema |
---|---|---|
snapshotImageId |
The identifier of the snapshot image used to create the new snapshot volume. |
string |
fullThreshold |
The repository utilization warning threshold percentage. |
integer (int32) |
name |
The name of the new snapshot volume. |
string |
viewMode |
The snapshot volume access mode. |
enum (modeUnknown, readWrite, readOnly, __UNDEFINED) |
repositoryPercentage |
The size of the view in relation to the size of the base volume. |
number (double) |
repositoryPoolId |
The identifier of the storage pool on which to allocate the repository volume. Ignored if a repositoryCandidate is provided. |
string |
repositoryCandidate |
Allows a repository candidate to be manually specified for use in the creation. By default, the best candidate will be selected. |
4.555. SnapshotViewUpdateRequest
Updates a Snapshot (PiT) View.
Name | Description | Schema |
---|---|---|
name |
The name of the new snapshot volume. |
string |
fullThreshold |
The repository utilization warning threshold percentage. |
integer (int32) |
4.556. SnapshotVolumeModeConversionRequest
Convert a Snapshot Volume from ReadOnly to ReadWrite mode.
Name | Description | Schema |
---|---|---|
repositoryPercentage |
Percentage of the base capacity to make the repository. |
number (double) |
repositoryCandidate |
Allows a repository candidate to be manually specified for use in the conversion. By default, the best candidate will be selected. |
|
fullThreshold |
The repository utilization warning threshold percentage. |
integer (int32) |
4.557. SnmpCommunity
SNMP Community configured on storage system
Name | Description | Schema |
---|---|---|
id |
The reference ID for the community |
string |
name |
The name of the community |
string |
permissions |
The permission types for this SNMP Community |
enum (unknown, readOnly, readWrite) |
trapDestinations |
The trap destinations to configure on this community |
< SnmpTrapDestination > array |
4.558. SnmpConfiguration
The SNMP configuration on the storage system
Name | Description | Schema |
---|---|---|
sysName |
The sysname of the storage system |
string |
sysLocation |
The syslocation of the storage system |
string |
sysContact |
The syscontact of the storage system |
string |
communities |
The list of communities on the storage system |
< SnmpCommunity > array |
4.559. SnmpTrapDestination
Response data about a trap destination
Name | Description | Schema |
---|---|---|
id |
The reference ID for the trap destination |
string |
receiverAddress |
IPV4 or IPV6 address for this trap destination |
string |
sendAuthenticationFailureTraps |
If authentication failure traps should be sent to this destination |
boolean |
4.560. SnmpCommunityRequest
Payload to create SNMP community
Name | Description | Schema |
---|---|---|
name |
The name of the community |
string |
permissions |
The permission types for this SNMP Community |
enum (unknown, readOnly, readWrite) |
trapDestinations |
The trap destinations to configure on this community |
< SnmpTrapDestinationRequest > array |
4.561. SnmpConfigurationRequest
Request to create SNMP configuration on storage system
Name | Description | Schema |
---|---|---|
sysName |
The sysname of the storage system |
string |
sysLocation |
The syslocation of the storage system |
string |
sysContact |
The syscontact of the storage system |
string |
communities |
The list of communities on the storage system |
< SnmpCommunityRequest > array |
4.562. SnmpTrapDestinationRequest
Payload to create a trap destination
Name | Description | Schema |
---|---|---|
receiverAddress |
IPV4 or IPV6 address for this trap destination |
string |
sendAuthenticationFailureTraps |
If authentication failure traps should be sent to this destination |
boolean |
4.563. UserVolume
Name | Description | Schema |
---|---|---|
metadata |
Example : |
< VolumeMetadataItem > array |
volumeGroupRef |
Example : |
string |
mediaScan |
Example : |
|
protectionType |
Example : |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
blkSize |
Example : |
integer (int32) |
flashCached |
Example : |
boolean |
segmentSize |
Example : |
integer (int32) |
cacheSettings |
The volume-specific caching parameters currently in effect for the volume. |
|
thinProvisioned |
Example : |
boolean |
dataAssurance |
Example : |
boolean |
diskPool |
Example : |
boolean |
objectType |
Example : |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
currentControllerId |
Example : |
string |
wwn |
Example : |
string |
listOfMappings |
Example : |
< LUNMapping > array |
mapped |
Example : |
boolean |
totalSizeInBytes |
Example : |
string (int64) |
preferredControllerId |
Example : |
string |
name |
Example : |
string |
id |
Example : |
string |
4.564. PoolQosResponse
Name | Description | Schema |
---|---|---|
poolId |
The pool unique identifier |
string |
name |
The pool name |
string |
pool |
Example : |
|
flashCacheCapable |
True if the pool supports flashCaching created volumes |
boolean |
dataAssuranceCapable |
True if created volumes can have dataAssurance enabled |
boolean |
encrypted |
True if the pool supports encryption |
boolean |
thinProvisioningCapable |
True if thin provisioned volumes can be defined on this pool |
boolean |
spindleSpeed |
The normalized spindle speed for the drives on this pool |
enum (spindleSpeedUnknown, spindleSpeedSSD, spindleSpeed5400, spindleSpeed7200, spindleSpeed10k, spindleSpeed15k) |
raidLevel |
The normalized RAID Level |
enum (raid0, raid1, raid5, raid6, raidDiskPool, unknown) |
availableFreeExtentCapacities |
The available sections of freeSpace available, in descending order |
< string (int64) > array |
4.565. VolumeGroupEx
Name | Description | Schema |
---|---|---|
sequenceNum |
A sequence number that uniquely identifies this volume group within the array in which it resides. Sequence numbers are assigned to volume groups when they are created or imported into a storage array. The controller assigns the lowest unused sequence number during a creation or import operation. |
integer (int32) |
offline |
An indication of whether the volume group is currently offline. A volume group can be taken offline by the operator in preparation for removing its drives and transporting them to another storage array. |
boolean |
raidLevel |
The RAID level associated with this volume group. If the storage array supports multiple RAID levels per volume group, this value will be set to RAID_ALL. Otherwise, it will indicate the precise RAID level defined for the volume group. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
worldWideName |
A variable-length opaque field that provides the volume group’s worldwide unique identification value. |
string |
volumeGroupRef |
The unique identification value for this volume group. Other objects may use this reference value to refer to the volume group. |
string |
reserved1 |
Example : |
string |
reserved2 |
Example : |
string |
trayLossProtection |
An indication as to whether the volume group has tray loss protection. |
boolean |
label |
The volume group label, which can be set by the user. |
string |
state |
The state of the volume group. |
enum (contingent, exported, forced, complete, partial, incomplete, missing, __UNDEFINED) |
spindleSpeedMatch |
Set to true if all of the drives in the group have matching normalized spindle speeds. (Normalized spindle speeds are standardized norms (e.g., 5400, 7200, etc.) that are used for spindle speed matching, even though actual spindle speeds may be within a designated delta of the normalized speed.) |
boolean |
spindleSpeed |
The spindle speed of the drives composing the pool (RPM) |
integer (int32) |
isInaccessible |
True if the volume group contains incompatible drives that have been locked out. |
boolean |
securityType |
security status of the drive group |
enum (unknown, none, capable, enabled, __UNDEFINED) |
drawerLossProtection |
This field is set to true when the volume group has drawer loss protection; otherwise it is set to false |
boolean |
protectionInformationCapable |
This field is no longer used. |
boolean |
protectionInformationCapabilities |
This structure contains a protectionInformationCapable field which is set to true if all drives in the volume group are Protection Information (PI) capable. It also contains a field that is set to the protection type for the volume group. |
|
volumeGroupData |
Information about the Volume Group. |
|
usage |
the volume group usage. |
enum (unknown, standard, flashcache, __UNDEFINED) |
driveBlockFormat |
Identifies the drive block format of the volume candidate. |
enum (unknown, allNative, allEmulated, mixed, __UNDEFINED) |
reservedSpaceAllocated |
This field will be used to report whether or not reserved space has been claimed on all drives in the volume group. The recovery-volume script will include this field for each volume group record it creates, so that during volume recovery the volume group is recreated correctly. |
boolean |
securityLevel |
Refines the information in the securityType field to describe the set of drives. |
enum (unknown, none, mixed, fde, fips, __UNDEFINED) |
usedSpace |
Example : |
string (int64) |
totalRaidedSpace |
Raw capacity of the volumeGroup |
string (int64) |
extents |
Example : |
< FreeExtent > array |
largestFreeExtentSize |
Example : |
string (int64) |
raidStatus |
The raid status reflects the worst case raid level of any volume on the group |
enum (optimal, degraded, failed, impaired, creating, deleting, __UNDEFINED) |
freeSpace |
Example : |
string (int64) |
drivePhysicalType |
Defines the physical interface type of the underlying drives. |
enum (all, scsi, fibre, sata, pata, fibre520b, sas, unknown, sas4k, __UNDEFINED) |
driveMediaType |
Defines whether is an SSD or a spinning drive. |
enum (all, unknown, hdd, ssd, __UNDEFINED) |
normalizedSpindleSpeed |
The normalized spindle speed of the drives composing the pool. Ex: 7200, 5400, 15000. If drives have mismatched spindle speeds, this value may not be accurate. |
enum (spindleSpeedUnknown, spindleSpeedSSD, spindleSpeed5400, spindleSpeed7200, spindleSpeed10k, spindleSpeed15k) |
diskPool |
True if the RAID Level is defined as raidDiskPool. |
boolean |
id |
Example : |
string |
name |
Example : |
string |
4.566. SscVolumeCreateRequest
Name | Description | Schema |
---|---|---|
poolId |
The id of the storage pool to create the volume on |
string |
name |
The name of the volume |
string |
sizeUnit |
The unit for the request capacity |
enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb) |
size |
The requested capacity of the volume in units |
string (int64) |
readCacheEnable |
Example : |
boolean |
writeCacheEnable |
Example : |
boolean |
flashCacheEnable |
Add this volume to a flashCache |
boolean |
dataAssuranceEnable |
Enable the dataAssurance capability |
boolean |
thinProvision |
Define a thinProvisioned volume |
boolean |
metaTags |
Optional list of MetaData tags to assign to the volume. |
< VolumeMetadataItem > array |
4.567. SscVolumeUpdateRequest
Updates a volume.
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the volume. |
string |
newSize |
Expand the volume to this capacity. |
string (int64) |
sizeUnit |
Expand the volume to this capacity. |
enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb) |
flashCache |
If true, add the volume to the flashCache if one is defined. If false, remove from the flashCache if one exists. |
boolean |
owningControllerId |
Set the preferred owning controller |
string |
readCacheEnable |
Example : |
boolean |
writeCacheEnable |
Example : |
boolean |
scanSettings |
Configure scan settings with regard to the controller’s background media scan operation |
|
metaTags |
Optional list of MetaData tags to assign to the volume. This will replace any existing tags. |
< VolumeMetadataItem > array |
4.568. StorageSystemConfigResponse
Name | Description | Schema |
---|---|---|
name |
Name of the storage system |
string |
4.569. StorageSystemConfigUpdateRequest
For updating StorageSystem configuration.
Name | Description | Schema |
---|---|---|
name |
New name for the storage system |
string |
4.570. ManagementInterface
Name | Description | Schema |
---|---|---|
interfaceName |
Name of the Ethernet port, as reported by the controller. |
string |
channel |
The channel number of this Ethernet interface. |
integer (int32) |
speed |
The speed of the interface, as currently configured, in Mbit/sec. |
integer (int32) |
ip |
The 32-bit IP protocol address assigned to the interface. |
integer (int32) |
alias |
An ASCII string that identifies the alias name for the interface; this name is presumed to be associated with the IP protocol address. |
string |
macAddr |
An ASCII string representation of the globally-unique 48-bit MAC address assigned to the Ethernet interface. |
string |
gatewayIp |
IP address of the gateway. |
integer (int32) |
subnetMask |
Network subnet mask. |
integer (int32) |
bootpUsed |
Bootpserver used to get network parameters. |
boolean |
rloginEnabled |
True if rlogin sessions are allowed. |
boolean |
reserved1 |
Example : |
string |
setupError |
Set to true if there is a configuration error. |
boolean |
reserved2 |
Example : |
string |
interfaceRef |
The unique identifier for a given instance of this structure. |
string |
linkStatus |
The status of the network link for this interface. |
enum (none, up, down, failed, __UNDEFINED) |
ipv4Enabled |
True if IPV4 is enabled for this interface; otherwise false. |
boolean |
ipv4Address |
The IPV4 address for the interface. |
string |
ipv4SubnetMask |
The IPV4 subnet mask for the interface. |
string |
ipv4AddressConfigMethod |
The method by which the IPV4 address information is configured. |
enum (configDhcp, configStatic, __UNDEFINED) |
ipv6Enabled |
True if IPV6 is enabled for this interface; otherwise false. |
boolean |
ipv6LocalAddress |
The IPV6 local address for the interface and associated data. |
|
ipv6PortStaticRoutableAddress |
The IPV6 static routable address for the interface and associated data. |
|
ipv6PortRoutableAddresses |
The set of IPV6 port routable addresses for the interface. |
< IpV6AddressData > array |
ipv6AddressConfigMethod |
The method by which the IPV6 address information is configured for the interface. |
enum (configStatic, configStateless, __UNDEFINED) |
fullDuplex |
If set to true, the interface is operating in full duplex mode; otherwise, it is operating in half-duplex mode. |
boolean |
supportedSpeedSettings |
Support speed setting for interface |
< enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED) > array |
configuredSpeedSetting |
Configured setting for the interface. |
enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED) |
currentSpeed |
Current speed of the interface. |
enum (speedUnknown, speed1gig, speed2gig, speed4gig, speed10gig, speed15gig, speed3gig, speed10meg, speed100meg, speed2pt5Gig, speed5gig, speed20gig, speed30gig, speed60gig, speed8gig, speed6gig, speed40gig, speed16gig, speed56gig, speed12gig, speed25gig, speed32gig, speed100gig, speed50gig, speedAuto, __UNDEFINED) |
physicalLocation |
The physical location of the Ethernet interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying "1st ethernet interface relative to the parent," "2nd ethernet interface relative to the parent," etc. This "interface number" is independent of the interface’s channel association. |
|
ipv4GatewayAddress |
Example : |
string |
controllerRef |
Example : |
string |
controllerSlot |
Example : |
integer (int32) |
dnsProperties |
Example : |
|
ntpProperties |
Example : |
|
id |
Example : |
string |
4.571. ManagementConfigurationRequest
Name | Description | Schema |
---|---|---|
controllerRef |
Example : |
string |
enableRemoteAccess |
If set to true, the controller is enabled for establishment of a remote access session. Depending on the controller platform, the method for remote access could be rlogin or telnet |
boolean |
ipv4GatewayAddress |
Manually specify the address of the gateway. |
string |
ipv6GatewayAddress |
Example : |
string |
ipv6StaticRoutableAddress |
Example : |
string |
interfaceRef |
Reference to the Ethernet interface to configure |
string |
interfaceName |
Name of Ethernet port |
string |
ipv4Enabled |
True if 'ipv4' is to be enabled for this interface; otherwise false. |
boolean |
ipv4Address |
The 'ipv4' address for the interface. Required for static configuration. |
string |
ipv4SubnetMask |
The 'ipv4' subnet mask for the interface. Required for static configuration. |
string |
ipv4AddressConfigMethod |
Setting that determines how the 'ipv4' address is configured. Required if ipv4 is enabled. |
enum (configDhcp, configStatic, __UNDEFINED) |
ipv6Enabled |
True if 'ipv6' is to be enabled for this interface; otherwise false. |
boolean |
ipv6LocalAddress |
The 'ipv6' local address for the interface. |
string |
ipv6AddressConfigMethod |
The method by which the 'ipv6' address information is configured for the interface. |
enum (configStatic, configStateless, __UNDEFINED) |
speedSetting |
The configured speed setting for the Ethernet interface. |
enum (speedNone, speedAutoNegotiated, speed10MbitHalfDuplex, speed10MbitFullDuplex, speed100MbitHalfDuplex, speed100MbitFullDuplex, speed1000MbitHalfDuplex, speed1000MbitFullDuplex, __UNDEFINED) |
dnsAcquisitionDescriptor |
The configuration for the DNS on this management interface |
|
ntpAcquisitionDescriptor |
The configuration for the NTP on this management interface |
4.572. AddStorageSystemReturn
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
alreadyExists |
Example : |
boolean |
4.573. KeyValue
Key value pair. Can be a key to single value or key to valueList.
Name | Description | Schema |
---|---|---|
key |
Key |
string |
valueList |
Provide a list of values |
< string > array |
4.574. StorageSystemCreateRequest
Used to create a storage system.
Name | Description | Schema |
---|---|---|
id |
ID to assign to the storage system. This must be left null or be unique. If null, a unique ID will be assigned |
string |
controllerAddresses |
A list of controller IP addresses or host names. |
< string > array |
acceptCertificate |
If set to true, any self-signed certificates on the storage system will be automatically accepted. |
boolean |
validate |
Enables validation of the added storage array. Returns errors if there are wwn mismatches or if the storage array cannot be contacted. |
boolean |
password |
The SYMbol password for the storage system. |
string |
wwn |
The world wide name for the storage system. This is only needed for in-band management with an in-band agent that is managing more than a single storage system. If provided, all alphabetical characters that are part of the WWN must be in uppercase. |
string |
enableTrace |
Enable trace logging for SYMbol calls to the storage system. |
boolean |
metaTags |
Optional meta tags to associate to this storage system |
< KeyValue > array |
4.575. StorageSystemResponse
A Storage System is a collection of both physical components and logical components. Physical components include disk drives, controllers, fans, and other hardware. The physical disk drives are grouped into Storage Pools. The storage capacity of these Storage Pools is provisioned into logical Volumes.
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
name |
Example : |
string |
wwn |
Example : |
string |
passwordStatus |
Example : |
enum (unknown, invalid, valid, securityLockout) |
passwordSet |
Example : |
boolean |
status |
Example : |
enum (neverContacted, offline, optimal, needsAttn, removed, newDevice, lockDown) |
certificateStatus |
The consolidated certificate status of all management paths. |
enum (trusted, partiallyTrusted, untrusted, unknown) |
ip1 |
Example : |
string |
ip2 |
Example : |
string |
managementPaths |
Example : |
< string > array |
controllers |
Example : |
< DiscoveredController > array |
driveCount |
Example : |
integer (int32) |
trayCount |
Example : |
integer (int32) |
traceEnabled |
Example : |
boolean |
types |
Example : |
string |
model |
Example : |
string |
metaTags |
Example : |
< KeyValue > array |
hotSpareSize |
Example : |
string (int64) |
usedPoolSpace |
Example : |
string (int64) |
freePoolSpace |
Example : |
string (int64) |
unconfiguredSpace |
Example : |
string (int64) |
driveTypes |
Example : |
< enum (scsi, fibre, unknown, sas, sata, __UNDEFINED) > array |
hostSpareCountInStandby |
Example : |
integer (int32) |
hotSpareCount |
Example : |
integer (int32) |
hostSparesUsed |
Example : |
integer (int32) |
bootTime |
Deprecated: The controller boot time. |
string (date-time) |
fwVersion |
Example : |
string |
appVersion |
Example : |
string |
bootVersion |
Example : |
string |
nvsramVersion |
Example : |
string |
chassisSerialNumber |
Example : |
string |
accessVolume |
Example : |
|
unconfiguredSpaceByDriveType |
Example : |
< string, string (int64) > map |
mediaScanPeriod |
Example : |
integer (int32) |
driveChannelPortDisabled |
True if one or more drive channel ports have been disabled by the controllers to protect against faulty expansion cabling. |
boolean |
recoveryModeEnabled |
True if recovery mode is enabled on the array. |
boolean |
autoLoadBalancingEnabled |
True if auto load balance is enabled on the array. |
boolean |
hostConnectivityReportingEnabled |
True if host connectivity reporting is enabled on the array. |
boolean |
remoteMirroringEnabled |
Can Remote Volume Mirrors be created on this StorageDevice? |
boolean |
fcRemoteMirroringState |
The remote mirroring state on this StorageDevice |
enum (unknown, disabled, enabledLegacyRvm, enabledArvm, enabledAll, __UNDEFINED) |
asupEnabled |
True if ASUP is enabled for this StorageDevice |
boolean |
securityKeyEnabled |
Example : |
boolean |
externalKeyEnabled |
Example : |
boolean |
lastContacted |
The last time that the device was considered accessible. |
string (date-time) |
definedPartitionCount |
The number of partitions calculated from the user’s current mappings. |
integer (int32) |
simplexModeEnabled |
True if the redundancy mode of the system is simplex. |
boolean |
supportedManagementPorts |
The management port types that are supported on this storage system. A type listed could be disabled even though it is supported. |
< enum (symbol, https) > array |
freePoolSpaceAsString |
Example : |
string |
hotSpareSizeAsString |
Example : |
string |
unconfiguredSpaceAsStrings |
Example : |
string |
usedPoolSpaceAsString |
Example : |
string |
4.576. StorageSystemUpdateRequest
Structure used to pass update information for the storage system
Name | Description | Schema |
---|---|---|
acceptCertificate |
If set to true, any self-signed certificates on the storage system will be automatically accepted. |
boolean |
storedPassword |
The new password for the storage system stored. Note, this only updates the password stored on the proxy. To update the password on the storage system itself (as well as the stored password), use the passwords URL |
string |
metaTags |
Optional meta tags to associate to this storage system. This must be a complete list. If the list is empty or null, no action is taken. If you want to just remove all tags, just set the removeAllTags boolean to true/ The removeAllTags will be processed before this new list is processed |
< KeyValue > array |
removeAllTags |
See the description for metaTags |
boolean |
enableTrace |
Enable trace logging for SYMbol calls to the storage system. |
boolean |
controllerAddresses |
Replacement list of controller IP addresses or host names. |
< string > array |
4.577. CapabilitiesResponse
Information on StorageSystem capabilities, features, and limits.
Name | Description | Schema |
---|---|---|
featureBundle |
Example : |
|
capabilities |
Example : |
< enum (none, sharedVolume, storagePoolsTo4, mixedRaidlevel, autoCodeSync, autoLunTransfer, subLunsAllowed, storagePoolsTo8, storagePoolsTo2, storagePoolsToMax, storagePoolsTo64, storagePoolsTo16, snapshots, remoteMirroring, volumeCopy, stagedDownload, mixedDriveTypes, goldKey, driveTrayExpansion, bundleMigration, storagePoolsTo128, storagePoolsTo256, raid6, performanceTier, storagePoolsTo32, storagePoolsTo96, storagePoolsTo192, storagePoolsTo512, remoteMirrorsTo16, remoteMirrorsTo32, remoteMirrorsTo64, remoteMirrorsTo128, snapshotsPerVolTo4, snapshotsPerVolTo8, snapshotsPerVolTo16, snapshotsPerVolTo2, secureVolume, protectionInformation, ssdSupport, driveSlotLimitTo112, driveSlotLimitTo120, driveSlotLimitTo256, driveSlotLimitTo448, driveSlotLimitTo480, driveSlotLimitToMax, driveSlotLimit, driveSlotLimitTo12, driveSlotLimitTo16, driveSlotLimitTo24, driveSlotLimitTo32, driveSlotLimitTo48, driveSlotLimitTo60, driveSlotLimitTo64, driveSlotLimitTo72, driveSlotLimitTo96, driveSlotLimitTo128, driveSlotLimitTo136, driveSlotLimitTo144, driveSlotLimitTo180, driveSlotLimitTo192, driveSlotLimitTo272, fdeProxyKeyManagement, remoteMirrorsTo8, driveSlotLimitTo384, driveSlotLimitTo300, driveSlotLimitTo360, flashReadCache, storagePoolsType2, remoteMirroringType2, totalNumberOfArvmMirrorsPerArray, totalNumberOfPitsPerArray, totalNumberOfThinVolumesPerArray, driveSlotLimitTo240, snapshotsType2, targetPortLunMapping, containerBasedApplication, __UNDEFINED) > array |
productCapabilities |
Example : |
< enum (capabilityNone, capabilityCacheBackup, capabilityCoreIscsi, capabilityDap520b, capabilityDualPortedSata, capabilityFdeDriveSupport, capabilityFieldRepCacheMem, capabilityGbEthMgmtPort, capabilityInfinibandSupport, capabilityIpv6MgmtPortIpv6, capabilityIscsiIpv6, capabilitySasSupport, capabilitySimplex, capabilitySmartBatteryMgmt, capabilityCal6141, capabilityCal6334, capabilityCfgDbAdoption, capabilityCtrlLockdown, capabilityCtrlStateCapture, capabilityDiagDataCapture, capabilityDriveDataRelocation, capabilityDriveEnclosureMiswires, capabilityDriveMgmt, capabilityDriveMixWithinTray, capabilityDrvChannelDiags, capabilityFeatureBundles, capabilityHostContextAgent, capabilityImmediateHostTopology, capabilityOnlineDrvFwDwnld, capabilityParentRelativeLocation, capabilityParentRelativeStatus, capabilityPompanoSupport, capabilityRaid6, capabilitySocStatistics, capabilitySupportsVirtualization, capabilityT10, capabilityInfusion, capabilityDriveLimitManagement, capabilitySfpPlus, capabilityIscsi10gbHostCard, capabilityEnhancedLun0Support, capabilityEnhancedFormatUnitSupport, capabilityDriveSideTrunkSupport, capabilitySsdSupport, capabilityBaseControllerDiags, capabilityCacheMemoryDiags, capabilityDriveSlotLimit, capabilityFdeProxyKeyMgmt, capabilityIosSupport, capabilityLockout2tbDrives, capabilityParentRelativeMel, capabilityRaid6PrereadRedCheck, capabilitySataDriveLockout, capabilitySyslogMsgs, capabilityWembleyEnclosure, capabilityCacheBackupDeviceDiags, capabilityHicDiags, capabilitySetTrayAttributes, capabilityIscsiTarget, capabilityIscsiInitiator, capabilityPsuFirmwareUpdate, capabilityDplCoreDump, capabilityDiskPools, capabilityAsupSupport, capabilityEmbeddedSnmpAgent, capabilityFtdcTraceHistory, capabilityAdvancedFormatSupport, capability4knativeAdvancedFormatSupport, capabilityAsupOnDemandSupport, capabilityIocDump, capabilityDrivePowerCycle, capabilityLowAndHighSampling, capabilityAutoLoadBalancing, capabilityWlcLogging, capabilityFipsDriveSupport, capabilityApplicationAwareness, capabilityEmbeddedEkms, capabilityCacheMirroringProtectionInformation, capabilityIntegratedHealthCheck, capabilitySignedFirmware, capabilityContainerBasedApplication, __UNDEFINED) > array |
featureStates |
Example : |
< FeatureState > array |
storageSystemAttributes |
Configuration parameters, constants, and other useful information for clients that may vary between storage-systems. |
|
featureParameters |
Example : |
4.578. StorageSystemAttributes
Name | Description | Schema |
---|---|---|
isLun0RestrictedForDefaultPartition |
A true value in this field indicates that one or more host bus adapter (HBA) host ports in the default host group is using an I/O protocol that does not allow volumes to be mapped to LUN 0. |
boolean |
4.579. SupportArtifact
API object that includes information about a single support artifact.
Name | Description | Schema |
---|---|---|
fileName |
Relative path to artifact. |
string |
lastModifiedTime |
Timestamp of last modification. |
string (date-time) |
size |
Size of artifact in bytes. |
string (int64) |
4.580. SupportArtifacts
API object that includes information about all support artifacts of a single type.
Name | Description | Schema |
---|---|---|
type |
Type of support artifacts. |
enum (recoveryProfile, supportBundle, dbCapture, ioStatistics, other) |
artifacts |
Array of support artifacts of the specified type. |
< SupportArtifact > array |
4.581. Progress
Name | Description | Schema |
---|---|---|
complete |
Has the operation completed? |
boolean |
percentage |
The approximate progress to completion of the operation. |
integer (int32) |
4.582. SupportDataResponse
Name | Description | Schema |
---|---|---|
requestId |
A unique identifier for the request |
string (int64) |
progress |
The progress of the operation. |
|
sizeInBytes |
The size of the support file |
string (int64) |
type |
The type of support data being collected. |
enum (driveData, traceBuffers, ioPathStatistics, supportBundle, coreDump, storageArrayConfiguration, deviceProfile, firmwareInventory, unreadableSectors, iscsiSessionsConnections) |
filename |
The name of the file to be retrieved. |
string |
4.583. SaveConfigSpec
Name | Description | Schema |
---|---|---|
storageArraySettings |
Set true to save general storage array settings. |
boolean |
volumeConfiguration |
Set true to save storage array volume configuration. |
boolean |
hostConfiguration |
Set true to save host and host port configuration. |
boolean |
volumeMappings |
Set true to save volume mappings. |
boolean |
4.584. SupportDataRequest
Name | Description | Schema |
---|---|---|
type |
The name of the file to be retrieved. |
enum (driveData, traceBuffers, ioPathStatistics, supportBundle, coreDump, storageArrayConfiguration, deviceProfile, firmwareInventory, unreadableSectors, iscsiSessionsConnections) |
filename |
Specify the name of the file, which will be utilized if it doesn’t already exist. |
string |
traceSpec |
Specifies the controllers to retrieve data from for type=traceBuffers |
|
driveSpec |
Specifies the drives to retrieve logs for for type=driveData |
|
saveConfigSpec |
Specifies the settings for type=storageArrayConfiguration |
4.585. TraceBufferSpec
Name | Description | Schema |
---|---|---|
controllerA |
Example : |
boolean |
controllerB |
Example : |
boolean |
4.586. SymbolPortResponse
Name | Description | Schema |
---|---|---|
symbolPortEnabled |
If the symbol port is enabled |
boolean |
4.587. SymbolPortRequest
Name | Description | Schema |
---|---|---|
enable |
Enable the SYMbol port |
boolean |
4.588. SyslogComponent
Syslog server component configuration.
Name | Description | Schema |
---|---|---|
type |
Component type |
enum (auditLog) |
4.589. SyslogServer
Syslog server configuration.
Name | Description | Schema |
---|---|---|
id |
Syslog server configuration id |
string |
serverAddress |
Fully qualified name or IP address of receiver |
string |
port |
Port number |
integer (int32) |
protocol |
Transmission protocol |
enum (udp, tcp, tls) |
components |
Array of associated components |
< SyslogComponent > array |
4.590. SyslogServerRequest
Create server configuration.
Name | Description | Schema |
---|---|---|
serverAddress |
Fully qualified name or IP address |
string |
port |
Port number. |
integer (int32) |
protocol |
Transmission protocol. |
enum (udp, tcp, tls) |
components |
Associated components |
< SyslogComponent > array |
4.591. SyslogServerUpdateRequest
Update syslog server configuration.
Name | Description | Schema |
---|---|---|
serverAddress |
Fully qualified name or IP address |
string |
port |
Port number |
integer (int32) |
protocol |
Transmission protocol |
enum (udp, tcp, tls) |
components |
Associated components |
< SyslogComponent > array |
4.592. DriveLocation
Uniquely specifies a drive location
Name | Description | Schema |
---|---|---|
tray |
Tray containing the drive |
integer (int32) |
drawer |
Optional drawer containing the drive. -1 indicates the drive is not in a drawer. |
integer (int32) |
slot |
Slot of drive |
integer (int32) |
4.593. PoolConfig
Storage pool for configuring volumes
Name | Description | Schema |
---|---|---|
drives |
List of drives |
< DriveLocation > array |
label |
A unique label |
string |
securityType |
The type of security used during creation |
enum (none, capable, enabled) |
reservedSpaceAllocated |
Indicates whether reserved space is allocated on the drives during volume creation |
boolean |
utilizationWarningThreshold |
The pool utilization warning threshold as a percentage of the total user configurable capacity |
integer (int32) |
utilizationCriticalThreshold |
The pool utilization critical threshold as a percentage of the total user configurable capacity |
integer (int32) |
backgroundOperationPriority |
Priority of operations that are not reconstruct, such as volume expansion |
enum (defaultPriority, highest, high, medium, low, lowest) |
criticalReconstructionPriority |
Priority of critical reconstruction operations (two failed drives) |
enum (defaultPriority, highest, high, medium, low, lowest) |
degradedReconstructionPriority |
Priority of degraded reconstruction operations (one failed drive) |
enum (defaultPriority, highest, high, medium, low, lowest) |
reservedDriveCount |
The number of drives reserved for reconstruction of failed drives |
integer (int32) |
4.594. SystemCacheSettings
Cache settings that apply at the system level
Name | Description | Schema |
---|---|---|
blockSize |
The characteristic size, in bytes, of a cache block |
integer (int32) |
flushStart |
Specifies the level of fullness of dirty data in the controller’s write cache which, when reached, will cause the controller to begin flushing data from cache to disk. This value is specified as a percentage, in the range 0-100, of the overall write cache capacity of the controller. After flushing begins, it will continue until enough data has been flushed to drop the percentage of dirty data to or below the value specified in the cacheFlushStop parameter. |
integer (int32) |
flushStop |
Specifies the amount of cache data that will be flushed to disk when a cache flush operation is initiated. This value is specified as an integer in the range 0-100 that represents the percentage of the controller’s write cache data that can remain in the dirty, or unflushed, state. When demand flush operations are started, data will be flushed from cache to disk until the overall amount of dirty data drops to or below the percentage specified by this value. |
integer (int32) |
mirroringProtectionInformationEnabled |
True if checking of protection information during cache mirroring is enabled, false otherwise. |
boolean |
4.595. SystemConfig
System configuration data
Name | Description | Schema |
---|---|---|
volumeGroups |
List of volume groups |
< VolumeGroupConfig > array |
pools |
List of pools |
< PoolConfig > array |
volumes |
List of volumes |
< VolumeConfig > array |
hotSpareDrives |
List of hot spare drives |
< DriveLocation > array |
systemSettings |
System settings |
4.596. SystemSettings
Storage system settings
Name | Description | Schema |
---|---|---|
cacheSettings |
System cache settings |
|
mediaScanPeriod |
Media scan period |
integer (int32) |
autoLoadBalancingEnabled |
Indicates whether auto load balancing is enabled |
boolean |
4.597. VolumeCacheConfig
Cache settings for a volume
Name | Description | Schema |
---|---|---|
cacheFlushModifier |
The cache flush modifier value, which indicates the amount of time dirty data is retained in write cache prior to being flushed to disk |
enum (immediate, twoHundredFiftyMillis, fiveHundredMillis, sevenHundredFiftyMillis, fifteenHundredMillis, oneSecond, twoSeconds, fiveSeconds, tenSeconds, twentySeconds, sixtySeconds, oneHundredTwentySeconds, threeHundredSeconds, twelveHundredSeconds, thirtySixHundredSeconds, infinite) |
cachingWithoutBatteriesEnabled |
Indicates whether write-back caching of dirty data is allowed when the cache memory’s battery is not available or not functioning |
boolean |
mirrorEnabled |
Indicates whether cache mirroring is enabled for the volume |
boolean |
readAheadEnabled |
Indicates whether automatic cache read-ahead is enabled for the volume |
boolean |
readCacheEnabled |
Indicates whether read caching is enabled for the volume |
boolean |
writeCacheEnabled |
Indicates whether write-back caching is enabled for the volume |
boolean |
4.598. VolumeConfig
Configuration data for volumes in volume groups and pools
Name | Description | Schema |
---|---|---|
label |
A label for the volume |
string |
volumeGroupLabel |
The label of the volume group or pool the volume is in |
string |
capacity |
The capacity of the volume |
string (int64) |
segmentSize |
The segment size of the volume |
integer (int32) |
owningController |
The controller that owns the volume |
enum (a, b) |
t10ProtectionType |
T10 protection information type for the volume |
enum (none, type1, type2, type3) |
dssPreallocateEnabled |
Indicates whether the DSS preallocation calculation is used for the volume |
boolean |
cacheSettings |
Cache settings for the volume |
|
preReadRedundancyCheckEnabled |
Indicates the storage controller will, on read operations, verify the consistency of RAID redundancy data for the stripe(s) containing the READ data |
boolean |
mediaScanSettings |
Background media scan settings for a volume |
|
reconstructionPriority |
Reconstruction priority |
integer (int32) |
4.599. VolumeGroupConfig
A RAID group for configuring volumes
Name | Description | Schema |
---|---|---|
drives |
List of drives |
< DriveLocation > array |
label |
A unique label |
string |
securityType |
The type of security used during creation |
enum (none, capable, enabled) |
reservedSpaceAllocated |
Indicates whether reserved space is allocated on the drives during volume creation |
boolean |
raidLevel |
The RAID level of the volume group |
enum (raid0, raid1, raid3, raid5, raid6) |
4.600. VolumeMediaScanSettings
Background media scan settings for a volume
Name | Description | Schema |
---|---|---|
enabled |
Indicates whether the controller should perform a media scan for this volume as part of its background processing |
boolean |
parityValidationEnabled |
Indicates whether the background media scan should include computation and validation of all parity blocks for the volume during the media scan |
boolean |
4.601. InProgressJobInfo
Information about an in progress replication job
Name | Description | Schema |
---|---|---|
id |
Job identifier |
string |
startTime |
Time the job was started |
string (date-time) |
configTypes |
Requested types to configure |
< enum (all, pools, volumeGroups, volumes, hotSpares, arraySettings) > array |
durationMs |
Amount of time in milliseconds the job has been running |
string (int64) |
percentComplete |
Percentage complete of job. Valid values are 0 - 100 (inclusive) |
integer (int32) |
numberSteps |
Number of steps performed |
integer (int32) |
numberFailures |
Number of steps that failed |
integer (int32) |
4.602. SystemConfigStatus
Status of an in progress array configuration operation
Name | Description | Schema |
---|---|---|
operationInProgress |
Reports whether a system config operation is currently in progress |
boolean |
job |
Information about an in progress replication job |
4.603. JobInfo
Information about a replication job
Name | Description | Schema |
---|---|---|
id |
Job identifier |
string |
startTime |
Time the job was started |
string (date-time) |
configTypes |
Requested types to configure |
< enum (all, pools, volumeGroups, volumes, hotSpares, arraySettings) > array |
configModel |
Requested configuration model |
|
durationMs |
Total duration of the job in milliseconds. |
string (int64) |
state |
State of the job |
enum (running, canceled, completed, failed) |
percentComplete |
Percentage complete of Job. Valid values are 0 - 100 (inclusive) |
integer (int32) |
numberSteps |
Number of steps performed |
integer (int32) |
numberFailures |
Number of steps that failed |
integer (int32) |
steps |
Information on the job’s executed steps |
< JobStep > array |
4.604. JobStep
Information about a replication job step
Name | Description | Schema |
---|---|---|
sequenceNumber |
Sequence number of the this job step within the job |
integer (int32) |
type |
Type of the job step |
enum (createVolumeGroup, createPool, createVolume, configureVolumeSettings, configureVolumeCacheSettings, configureVolumeMediaScanSettings, assignHotSpare, configureSystemCacheSettings, configureSystemCacheMirroringProtectionSettings, configureSystemMediaScanSettings, configureSystemAutoLoadBalancingSettings, undefinedStep) |
objectName |
Name of the affected object |
string |
startTime |
Time the job step was started |
string (date-time) |
durationMs |
Total duration of the job step in milliseconds. |
string (int64) |
state |
State of the job step |
enum (success, failedAndHalted, failedAndContinued) |
errorType |
Type of error reported |
enum (none, internal, symbol, http) |
errorCode |
Error code for additional info on failures |
string |
4.605. SystemConfigCapabilities
List of system configuration operations supported on this system. Note that all is never returned in the list as it is not an operation in itself but rather a collection of all supported operations.
Name | Description | Schema |
---|---|---|
capabilities |
The list of supported capabilities |
< enum (all, pools, volumeGroups, volumes, hotSpares, arraySettings) > array |
4.606. SystemConfigStartResponse
Name | Description | Schema |
---|---|---|
jobId |
The job identifier |
string |
4.607. SystemConfigStartRequest
Name | Description | Schema |
---|---|---|
volumeGroups |
List of volume groups |
< VolumeGroupConfig > array |
pools |
List of pools |
< PoolConfig > array |
volumes |
List of volumes |
< VolumeConfig > array |
hotSpareDrives |
List of hot spare drives |
< DriveLocation > array |
systemSettings |
System settings |
|
jobId |
The identifier to use for the job. If not provided, an identifier will be generated. |
string |
4.608. ThinVolumeEx
Name | Description | Schema |
---|---|---|
volumeHandle |
The volumeHandle (SSID) for this volume. |
integer (int32) |
worldWideName |
The World wide name of the volume. |
string |
label |
The name of the volume. |
string |
allocationGranularity |
The allocation cluster size for the Expandable Repository Volume. |
integer (int32) |
capacity |
The virtual capacity of the volume in bytes. |
string (int64) |
reconPriority |
Importance of fixing the volume if failed (0-4). |
integer (int32) |
volumeRef |
The reference (key) for this volume. |
string |
status |
The operational status of the volume. |
enum (unknown, optimal, full, overThresh, failed, initializing, __UNDEFINED) |
repositoryRef |
The Expandable Repository Volume underlying this Thin Volume. |
string |
currentManager |
The controller that currently manages the volume. |
string |
preferredManager |
The controller that should manage the volume. |
string |
perms |
Operations allowed on this volume. |
|
mgmtClientAttribute |
For use by management client. |
integer (int32) |
preReadRedundancyCheckEnabled |
If true, verify RAID redundancy on read operations. |
boolean |
protectionType |
The protection type of the volume. |
enum (type0Protection, type1Protection, type2Protection, type3Protection, __UNDEFINED) |
applicationTagOwned |
True if application tag is owned by the storage array. |
boolean |
maxVirtualCapacity |
The maximum virtual capacity to which this thin volume can grow (in bytes). |
string (int64) |
initialProvisionedCapacity |
The initial provisioned capacity for the Expandable Repository Volume for this thin volume (in bytes). |
string (int64) |
currentProvisionedCapacity |
The current provisioned capacity of the Expandable Repository Volume (in bytes). |
string (int64) |
provisionedCapacityQuota |
The maximum capacity of the Expandable Repository Volume (in bytes). |
string (int64) |
growthAlertThreshold |
The percent value at which an alert is generated. |
integer (int32) |
expansionPolicy |
The automatic Expandable Repository Volume expansion policy. |
enum (unknown, manual, automatic, __UNDEFINED) |
volumeCache |
The cache parameters of the underlying repository. |
|
offline |
The thin volume is offline due to the associated repository volume state. |
boolean |
reportingPolicy |
Indicates how the thin volume is reported on the SCSI interface. |
enum (unknown, asThick, asThin, __UNDEFINED) |
extendedUniqueIdentifier |
A variable-length opaque field that provides the volume’s extended unique identification value. |
string |
volumeFull |
Example : |
boolean |
volumeGroupRef |
Example : |
string |
blkSize |
Example : |
integer (int32) |
storageVolumeRef |
Example : |
string |
volumeCopyTarget |
Example : |
boolean |
volumeCopySource |
Example : |
boolean |
pitBaseVolume |
Example : |
boolean |
asyncMirrorTarget |
True if the volume is a target in an Asynchronous Mirror relationship. |
boolean |
asyncMirrorSource |
True if the volume is a source in an Asynchronous Mirror relationship. |
boolean |
remoteMirrorSource |
True if the volume is a source (primary), in an Remote Volume Mirror relationship. |
boolean |
remoteMirrorTarget |
True if the volume is a target (secondary), in an Remote Volume Mirror relationship. |
boolean |
flashCached |
True if this volume is added to a flashCache. |
boolean |
mediaScan |
Example : |
|
metadata |
Metadata associated with the volume |
< VolumeMetadataItem > array |
dataAssurance |
Example : |
boolean |
objectType |
Example : |
enum (unknown, volume, pool, host, lunMapping, hostGroup, thinVolume, drive, volumeCopy, pit, pitView, snapshotGroup, snapshot, accessVolume, legacySnapshot, hostType, metadataTag, managementUrl, folder, asyncMirrorGroup, asyncMirrorGroupMember, asyncMirrorGroupIncompleteMember, consistencyGroup, consistencyGroupView, fan, battery, storageSystem, controller, powerSupply, minihub, esm, drawer, hostBoard, interconnectCRU, cacheBackupDevice, tray, supportCRU, hostPort, initiator, snapshotSchedule, thermalSensor, sfp, flashCache, featureAttribute, featureState, lockKeyId, remoteVolume, mirrorVolume, vaultMirrorVolume, vaultMirrorGroup, metadataVolume, sasPort, sasExpander, channelPort, speedNegError, snmpAgentBundle, stagedFirmware, workload, ekmsCertRevocatSettings) |
currentControllerId |
Example : |
string |
wwn |
Example : |
string |
listOfMappings |
Example : |
< LUNMapping > array |
mapped |
Example : |
boolean |
totalSizeInBytes |
Example : |
string (int64) |
preferredControllerId |
Example : |
string |
onlineVolumeCopy |
Example : |
boolean |
segmentSize |
Example : |
integer (int32) |
cacheSettings |
The volume-specific caching parameters currently in effect for the volume. |
|
thinProvisioned |
Example : |
boolean |
diskPool |
Example : |
boolean |
name |
Example : |
string |
id |
Example : |
string |
4.609. ThinVolumeCreateRequest
Creates a Thin Volume.
Name | Description | Schema |
---|---|---|
poolId |
The identifier of the storage pool from which the volume will be allocated. |
string |
name |
The user-label to assign to the new volume. |
string |
sizeUnit |
Unit for "size" |
enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb) |
virtualSize |
Initial virtual capacity of the volume in units (See sizeUnit). |
string (int64) |
repositorySize |
Number of units (See sizeUnit) to make the repository volume, which is the backing for the thin volume. Must be between 4GB & 256GB. This value must align along a 4GB boundary. If it does not, it will be automatically adjusted to the next 4GB value. |
string (int64) |
maximumRepositorySize |
Maximum size (in sizeUnits) to which the thin volume repository can grow. |
string (int64) |
owningControllerId |
Set the preferred owning controller. By default this field will alternate between available controllers |
string |
growthAlertThreshold |
The repository utilization warning threshold (in percent). This parameter is only required for thin-provisioned volumes. Default: 95 |
integer (int32) |
createDefaultMapping |
Create the default volume mapping. Defaults to false. |
boolean |
expansionPolicy |
Thin Volume expansion policy. If automatic, the thin volume will be expanded automatically when capacity is exceeded, if manual, the volume must be expanded manually. Defaults to automatic. |
enum (unknown, manual, automatic, __UNDEFINED) |
cacheReadAhead |
Deprecated(This field is no longer valid for thin volumes): Enable/Disable automatic cache read-ahead |
boolean |
dataAssuranceEnabled |
Example : |
boolean |
metaTags |
Optional array of Meta Data tags for the volume. |
< VolumeMetadataItem > array |
4.610. ThinVolumeCacheSettings
Name | Description | Schema |
---|---|---|
readCacheEnable |
Indicates whether read caching should be enabled for the volume. |
boolean |
writeCacheEnable |
Indicates whether write-back caching should be enabled for the volume. |
boolean |
cacheFlushModifier |
The cache flush modifier value, which is used to specify the maximum amount of time that dirty data for this volume may be retained in the controller’s write cache prior to being flushed to disk. |
enum (flushImmediate, flush250Msec, flush500Msec, flush750Msec, flush1Sec, flush1500Msec, flush2Sec, flush5Sec, flush10Sec, flush20Sec, flush60Sec, flush120Sec, flush300Sec, flush1200Sec, flush3600Sec, flushInfinite, __UNDEFINED) |
4.611. ThinVolumeUpdateRequest
Updates a Thin Volume.
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the volume. |
string |
growthAlertThreshold |
The repository utilization warning threshold (in percent). |
integer (int32) |
flashCache |
If true, add the volume to the flashCache if one is defined. If false, remove from the flashCache if one exists. |
boolean |
metaTags |
Optional array of Meta Data tags for the volume. |
< VolumeMetadataItem > array |
expansionPolicy |
Thin Volume expansion policy. If automatic, the thin volume will be expanded automatically when capacity is exceeded, if manual, the volume must be expanded manually. |
enum (unknown, manual, automatic, __UNDEFINED) |
owningControllerId |
Set the preferred owning controller |
string |
cacheSettings |
Configure cache settings for the volume |
|
scanSettings |
Configure scan settings with regard to the controller’s background media scan operation |
4.612. ThinVolumeExpansionRequest
Expands a Thin Volume.
Name | Description | Schema |
---|---|---|
sizeUnit |
Unit for "size" |
enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb) |
newVirtualSize |
The new virtual capacity for the thin volume. New virtual capacity cannot be smaller than original value! |
string (int64) |
newRepositorySize |
The new repository capacity of the thin volume. If expansion policy is Automatic, this will increase the maximum repository capacity. If the expansion policy is Manual, this will increase the capacity of the repository directly. |
string (int64) |
4.613. UnassociatedHostPort
A Port seen on the Storage Area Network but not currently associated to a host
Name | Description | Schema |
---|---|---|
type |
The host port’s IO interface type. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
id |
The host port’s id. |
string |
address |
The host port’s unique address identifier. |
string |
mediaTransportProtocolType |
The host port’s media transport protocol type. |
enum (notImplemented, scsi, fc, sata, sas, iscsi, ib, fcoe, nvmeof, ethernet, nvmeCouplingDriver, __UNDEFINED) |
4.614. UpgradeManagerResponse
This response contains the correlation Id that can be used to correlate software download events from the global event channel to this request
Name | Description | Schema |
---|---|---|
correlationId |
The correlation Id. This can be match to events from the event system to match events to this request |
string |
4.615. SoftwareVersion
Version information for a component/context in the server
Name | Description | Schema |
---|---|---|
context |
The context for the component |
string |
version |
The version for the component |
string |
4.616. SoftwareVersions
Collection of version information for the current and staged versions of sotware
Name | Description | Schema |
---|---|---|
stagedVersions |
The staged versions |
< SoftwareVersion > array |
currentVersions |
The current versions |
< SoftwareVersion > array |
4.617. VolumeCopyProgress
Object to represent the Volume Copy progress.
Name | Description | Schema |
---|---|---|
percentComplete |
The completion percentage of a "long-running" operation on a volume. |
integer (int32) |
timeToCompletion |
The estimated elapsed time to completion in minutes. Note that this field is always set to -1 for basic RAID volumes. |
integer (int32) |
volumeCopyId |
Example : |
string |
4.618. VolumeCopyPair
Name | Description | Schema |
---|---|---|
worldWideName |
The World Wide Name of the volume copy. |
string |
volcopyHandle |
The Volume Copy ID(ssid of proxy). |
integer (int32) |
volcopyRef |
Reference (key) for copy. |
string |
status |
Indicates status of copy. |
enum (inProgress, complete, halted, failed, pending, __UNDEFINED) |
sourceVolume |
Source volume reference. |
string |
targetVolume |
Target volume reference. |
string |
currentManager |
Current owner of copy. |
string |
idleTargetWriteProt |
Apply write protection to target volume when copy is idle (true/false). |
boolean |
copyCompleteTime |
Time copy operation completed. |
string (int64) |
copyStartTime |
Time copy operation began. |
string (int64) |
copyPriority |
Importance of copy operation. |
enum (priority0, priority1, priority2, priority3, priority4, __UNDEFINED) |
reserved1 |
Example : |
string |
cloneCopy |
The volume copy is a clone. |
boolean |
pgRef |
For clones based on PiT Groups, this will identify the PiT Group. |
string |
baseSourceVolumeId |
The source’s base volume identifier (the same as the sourceVolume in the case of an offline copy). |
string |
onlineCopy |
Example : |
boolean |
id |
Example : |
string |
4.619. VolumeCopyUpdateRequest
Updates a Volume Copy.
Name | Description | Schema |
---|---|---|
copyPriority |
The priority of the copy job (0 is the lowest priority, 4 is the highest priority). Defaults to priority 2. |
enum (priority0, priority1, priority2, priority3, priority4, __UNDEFINED) |
targetWriteProtected |
Specifies whether to block write I/O to the target volume while the copy job exists. |
boolean |
4.620. VolumeCopyCreateRequest
Creates a Volume Copy.
Name | Description | Schema |
---|---|---|
sourceId |
The identifier of the source volume for the copy job. |
string |
targetId |
The identifier of the target volume for the copy job. |
string |
copyPriority |
The priority of the copy job (0 is the lowest priority, 4 is the highest priority). Defaults to priority 2. |
enum (priority0, priority1, priority2, priority3, priority4, __UNDEFINED) |
targetWriteProtected |
Specifies whether to block write I/O to the target volume while the copy job exists. |
boolean |
onlineCopy |
If true, a snapshot will be created of the source volume, and the copy initiated on it to prevent any loss of use of the source volume. |
boolean |
repositoryCandidate |
Allows a repository candidate to be manually specified for use in the creation of the snapshot. By default, the best candidate will be selected if onlineCopy is specified as true |
4.621. DiskPoolReductionRequest
Reduce the number of drives in a VolumeGroup.
Name | Description | Schema |
---|---|---|
drives |
Id list of drives to remove. |
< string > array |
4.622. StoragePoolCreateRequest
Creates a Storage Pool.
Name | Description | Schema |
---|---|---|
raidLevel |
The RAID configuration for the new storage pool. |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
diskDriveIds |
The identifiers of the disk drives to use for creating the storage pool. |
< string > array |
eraseSecuredDrives |
Security-enabled drives that were previously part of a secured storage pool must be erased before they can be re-used. Enable to automatically erase such drives. |
boolean |
name |
The user-label to assign to the new storage pool. |
string |
4.623. DiskPoolPriorityUpdateRequest
Name | Description | Schema |
---|---|---|
priority |
Pool operation priority |
enum (invalid, lowest, low, medium, high, highest, useDefault, __UNDEFINED) |
priorityType |
The priority type |
enum (invalid, degraded, critical, background, __UNDEFINED) |
4.624. DiskPoolThresholdUpdateRequest
Name | Description | Schema |
---|---|---|
thresholdType |
The threshold type to configure |
enum (invalid, warning, critical, __UNDEFINED) |
value |
New threshold setting (0-100). 0 to disable the threshold. |
integer (int32) |
4.625. StoragePoolUpdateRequest
Updates a Storage Pool.
Name | Description | Schema |
---|---|---|
name |
The new user-label to assign to the storage pool. |
string |
securePool |
Convert to a secure Storage Pool if all of the drives that constitute the Pool are security capable |
boolean |
reservedDriveCount |
Set the number of drives reserved by the storage pool for reconstruction operations (only for RAID Type: raidDiskPool) |
integer (int32) |
poolPriority |
Set the reconstruction and background operation priorities (only for RAID Type: raidDiskPool) |
|
poolThreshold |
Set the reconstruction and background operation priorities (only for RAID Type: raidDiskPool) |
4.626. RaidMigrationRequest
Name | Description | Schema |
---|---|---|
raidLevel |
Example : |
enum (raidUnsupported, raidAll, raid0, raid1, raid3, raid5, raid6, raidDiskPool, __UNDEFINED) |
4.627. OperationProgress
Name | Description | Schema |
---|---|---|
volumeRef |
Example : |
string |
currentAction |
Example : |
enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED) |
progressPercentage |
Example : |
integer (int32) |
estimatedTimeToCompletion |
Example : |
integer (int32) |
4.628. VolumeGroupExpansionCandidate
Name | Description | Schema |
---|---|---|
drives |
An array of references to drives comprising the set that can be used to expand the volume group. |
< string > array |
trayLossProtection |
Set to true if the expanded volume group will have tray loss protection. |
boolean |
wastedCapacity |
The number of bytes of wasted capacity in the given drive set if is used to expand the volume. Wasting of capacity occurs when the drives in the set are larger than the drives in the volume group being expanded. |
string (int64) |
spindleSpeedMatch |
Set to true if the expanded volume group will have uniform spindle speed across its drives. |
boolean |
drawerLossProtection |
Set to true if the expanded volume group will have drawer loss protection. |
boolean |
usableCapacity |
The total usable capacity of the expansion candidate in bytes. |
string (int64) |
driveBlockFormat |
Identifies the drive block format of the volume candidate. |
enum (unknown, allNative, allEmulated, mixed, __UNDEFINED) |
4.629. StoragePoolExpansionRequest
Used for expanding the capacity of a Storage Pool.
Name | Description | Schema |
---|---|---|
drives |
The list of drives to add to the Pool. A maximum of 12 drives is allowed for Pools of type raidDiskPool and 2 for others. |
< string > array |
4.630. RemovableDriveResponse
Name | Description | Schema |
---|---|---|
poolId |
The id of the StoragePool. |
string |
removableDriveCount |
Maximum number of drives that can be removed from the StoragePool in order to shrink its capacity and disk usage. |
integer (int32) |
4.631. VolumeCacheSettings
Change configured cache settings for a volume.
Name | Description | Schema |
---|---|---|
readCacheEnable |
Indicates whether read caching should be enabled for the volume. |
boolean |
writeCacheEnable |
Indicates whether write-back caching should be enabled for the volume. |
boolean |
readAheadEnable |
Indicates whether or not automatic cache read-ahead is enabled |
boolean |
cacheFlushModifier |
The cache flush modifier value, which is used to specify the maximum amount of time that dirty data for this volume may be retained in the controller’s write cache prior to being flushed to disk. |
enum (flushImmediate, flush250Msec, flush500Msec, flush750Msec, flush1Sec, flush1500Msec, flush2Sec, flush5Sec, flush10Sec, flush20Sec, flush60Sec, flush120Sec, flush300Sec, flush1200Sec, flush3600Sec, flushInfinite, __UNDEFINED) |
mirrorEnable |
Indicates whether cache mirroring should be enabled for this volume. If enabled, all cache data will be mirrored across controllers to provide increased resilience to potential controller failures. |
boolean |
cacheWithoutBatteries |
Indicates whether caching without batteries should be allowed for this volume. Note that setting this attribute to true may result in data loss if the array’s cache hold-up battery fails, and then a disorderly power-down of the array occurs. This feature should be used only with extreme caution. |
boolean |
4.632. VolumeUpdateRequest
Updates a Volume.
Name | Description | Schema |
---|---|---|
name |
The user-label to assign to the new volume. |
string |
owningControllerId |
Set the preferred owning controller |
string |
cacheSettings |
Configure cache settings for the volume |
|
flashCache |
If true, add the volume to the flashCache if one is defined. If false, remove from the flashCache if one exists. |
boolean |
scanSettings |
Configure scan settings with regard to the controller’s background media scan operation |
|
metaTags |
Optional array of Meta Data tags for the volume. |
< VolumeMetadataItem > array |
4.633. VolumeCreateRequest
Creates a Volume.
Name | Description | Schema |
---|---|---|
poolId |
The identifier of the storage pool from which the volume will be allocated. |
string |
name |
The user-label to assign to the new volume. |
string |
sizeUnit |
Unit for "size" |
enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb) |
size |
Number of units (See sizeUnit) to make the volume. |
string (int64) |
segSize |
The segment size (KB) of the volume. A zero value will set a system-specific default value. |
integer (int32) |
dataAssuranceEnabled |
Default : |
boolean |
owningControllerId |
Set the preferred owning controller. By default this field will alternate between available controllers |
string |
metaTags |
Optional array of Meta Data tags for the volume. |
< VolumeMetadataItem > array |
4.634. VolumeActionProgressResponse
Object to represent an operation (VolumeAction) on a Volume along with operational data.
Name | Description | Schema |
---|---|---|
percentComplete |
The completion percentage of a "long-running" operation on a volume. |
integer (int32) |
timeToCompletion |
The estimated elapsed time to completion in minutes. Note that this field is always set to -1 for basic RAID volumes. |
integer (int32) |
action |
Enum defining the current volume action in progress. |
enum (none, copyback, initializing, reconstructing, remappingDce, remappingDrm, remappingDcedrm, remappingDseg, remappingDve, remappingDcedve, remappingInternal, remappingDefrag, formatting, synchronizing, parityScan, volumeCopy, snapshotRollback, pitRollback, asyncMirrorGroupInitialSync, reconstructingCritical, rebalancing, copyThenFail, copyThenFailPending, copyThenReplace, copyThenReplaceAndFail, thinDefrag, creating, deleting, __UNDEFINED) |
4.635. VolumeExpansionRequest
Expands a Volume.
Name | Description | Schema |
---|---|---|
sizeUnit |
Unit for "expansionSize" |
enum (bytes, b, kb, mb, gb, tb, pb, eb, zb, yb) |
expansionSize |
Number of units (See sizeUnit) to make the volume (must be greater than the current capacity). |
string (int64) |
4.636. VolumeMappingCreateRequest
Creates a Volume Mapping - maps a Volume to a Host or Host Group.
Name | Description | Schema |
---|---|---|
mappableObjectId |
The mappable object such as a volume or snapshot volume. |
string |
targetId |
The host group or a host for the volume mapping. If left null, the default host group will be used |
string |
lun |
The LUN for the volume mapping. |
integer (int32) |
4.637. VolumeMappingMoveRequest
Move a volume mapping from a Host/Group to another Host/Group
Name | Description | Schema |
---|---|---|
targetId |
The host group or a host for the volume mapping. If left null, the default host group will be used |
string |
lun |
The LUN for the volume mapping. |
integer (int32) |
4.638. WorkloadAttribute
An attribute assigned to a work load. This is completely arbitrary and can be used for any purpose by the user..
Name | Description | Schema |
---|---|---|
key |
The key for this attribute. |
string |
value |
The value for the attribute. |
string |
4.639. WorkloadModel
A workload is a tag that can be assigned to a volume. It is completely arbitrary and can be used for any purpose by the user..
Name | Description | Schema |
---|---|---|
id |
The id for this workload. |
string |
name |
The name for this workload. |
string |
workloadAttributes |
Key/Value pairs to assigned to this workload. |
< WorkloadAttribute > array |
key |
Example : |
string |
4.640. WorkloadUpdateRequest
A workload is a tag that can be assigned to a volume. It is completely arbitrary and can be used for any purpose by the user..
Name | Description | Schema |
---|---|---|
workloadAttributes |
Key/Value pairs to assigned to this workload. |
< WorkloadAttribute > array |
4.641. WorkloadCreateRequest
A workload is a tag that can be assigned to a volume. It is completely arbitrary and can be used for any purpose by the user..
Name | Description | Schema |
---|---|---|
name |
The id for this workload. |
string |
workloadAttributes |
Key/Value pairs to assigned to this workload. |
< WorkloadAttribute > array |
4.642. WorkloadCopyRequest
Copies a workload and names it with the given name
Name | Description | Schema |
---|---|---|
newWorkloadName |
Name of the new workload. |
string |
changeVolumeTags |
If true, volumes tagged to the old workload will be moved to be tagged to the new workload |
boolean |
4.643. BatchJobDetails
Name | Description | Schema |
---|---|---|
httpStatusCode |
The numeric HTTP result code returned for this job step. |
integer (int32) |
httpStatusPhrase |
A short phrase describing the HTTP status code. |
string |
httpResultHeaders |
The HTTP headers returned. |
< Pair > array |
httpReturnBody |
The JSON body returned from this job step. This data must be decoded by the client as it will be specific for the type of call made. |
string |
4.644. BatchJobStepStatus
Name | Description | Schema |
---|---|---|
jobName |
The name of this job. This value will be the batch name plus the job ID. |
string |
jobId |
The numeric ID for this individual job. |
integer (int32) |
jobComplete |
If true then this job has completed. |
boolean |
percentComplete |
The percent complete for this step (may be estimated). |
integer (int32) |
systemId |
The System Id that this job executed against. |
string |
systemName |
The name of the system that this job executed against. |
string |
httpVerb |
The HTTP method called. |
string |
executionUrl |
The URL that this command executed against. For dual controller systems this provides the path to the controller that executed the command. |
string |
executionMillis |
The number of milliseconds that this job took to execute. |
integer (int32) |
retriesAttempted |
The number of retries that were attempted for this job. |
integer (int32) |
resultStatus |
The job result enum value. |
enum (NOTSTARTED, INPROGRESS, SUCCESS, FAILED, CANCELLED, TIMEOUT, CONNECTFAILED) |
stepResult |
The detailed return data for this step. |
4.645. BatchResponse
Name | Description | Schema |
---|---|---|
batchId |
The ID for this batch request. |
integer (int32) |
batchName |
The batch name. |
string |
batchGroupId |
The batch group id. |
string |
startTime |
The time that this batch was initiated. |
string (date-time) |
batchComplete |
If true the entire batch is complete. |
boolean |
percentComplete |
The percent complete for the entire batch (estimated). |
integer (int32) |
batchState |
Describes the process state for this batch request. |
enum (NOTSTARTED, STARTING, RUNNING, CANCELLED, COMPLETE) |
numberJobs |
The number of job status results contained within the batch response. |
integer (int32) |
numberSystemIds |
The number of system Ids the batch was executed against. |
integer (int32) |
numberJobSteps |
The number of individual job steps executed within this batch. |
integer (int32) |
jobStepStatus |
An array of BatchJobStepStatus objects. |
< BatchJobStepStatus > array |
4.646. Pair
Name | Description | Schema |
---|---|---|
key |
The key for this pair. |
string |
value |
The value for this pair. |
string |
4.647. BatchInfo
Name | Description | Schema |
---|---|---|
info |
Example : |
< BatchMetadata > array |
4.648. BatchMetadata
Name | Description | Schema |
---|---|---|
batchId |
The batch ID for this batch. |
integer (int32) |
batchName |
The batch name. |
string |
batchGroupId |
The batch group id. |
string |
systemIds |
Array of System Ids this batch was run against. If multiple jobs were defined, this list contains all systemIds from all jobs. |
< string > array |
apiUrl |
The set of URLs that the batch was initiated against. Note that for batches with more than one job, there may be multiple URLs. |
< string > array |
state |
The current state of the batch. |
enum (NOTSTARTED, STARTING, RUNNING, CANCELLED, COMPLETE) |
4.649. SystemReplicationFailureEntry
Name | Description | Schema |
---|---|---|
startTime |
The time that this step started. |
string (date-time) |
systemId |
The Id of the system that had the failure. |
string |
systemName |
The name of the system that had the failure. |
string |
sequenceNum |
The sequence number of the operation that was performed on the system. |
integer (int32) |
jobStepType |
Job step type enumeration. |
enum (createVolumeGroup, createPool, createVolume, configureVolumeSettings, configureVolumeCacheSettings, configureVolumeMediaScanSettings, assignHotSpare, configureSystemCacheSettings, configureSystemCacheMirroringProtectionSettings, configureSystemMediaScanSettings, configureSystemAutoLoadBalancingSettings, undefinedStep) |
jobStepTypeText |
Text description of the operation. |
string |
stepDuration |
The duration that the step took in milliseconds. |
string (int64) |
objectName |
The name of the object that was operated on. |
string |
statusDesc |
A text description of the result status of the operation. |
string |
statusCode |
The status code of the operation. |
string |
statusCodeSource |
The status code source type enumeration. |
enum (none, internal, symbol, http) |
4.650. SystemReplicationResponseData
Name | Description | Schema |
---|---|---|
jobId |
The ID for this system replication job. |
string |
sourceSystemId |
The ID of the source system. |
string |
sourceSystemName |
Name of the source system. |
string |
targetSystemIds |
The IDs of the target systems. |
< string > array |
state |
The current or final state of the job. |
enum (running, complete, failed, cancelled, timeout, notStarted) |
processFailureReason |
A text reason that the overall process failed. Only set if the replication process failed, not if an individual array did not complete successfully. |
string |
percentComplete |
The overall percent complete for this job. |
integer (int32) |
systemFailureCount |
The number of systems that incurred failures during processing. |
integer (int32) |
startTime |
The start time for this job. |
string (date-time) |
elapsedTime |
Total runtime for the job in seconds. If the job is still in progress, depicts time thus far. |
string (int64) |
sourceDocument |
The source input document describing the system that was replicated. |
string |
configTypes |
List of the types of configuration elements applied to the target systems. |
< enum (all, pools, volumeGroups, volumes, hotSpares, arraySettings) > array |
failureEntries |
A list of system failure records. Note, these values are only supplied if detailed results are requested. |
< SystemReplicationFailureEntry > array |
4.651. JobDescriptor
Name | Description | Schema |
---|---|---|
httpVerb |
Designates the type of HTTP request to be made (GET, POST, etc.). |
enum (GET, POST, PUT, DELETE) |
apiURL |
The URL for the operation that is to be called. For paths behind "storage-systems" that have a system ID, use a place holder for the ID {id}. This value will be substituted before making the call. Any other query parameters or path values should be specified directly in the URL. |
string |
systemIds |
A list of storage system ID’s (or WWN’s) that the operation is performed against. |
< string > array |
numberRetries |
The number of times a given job will be retried if a timeout or failure occurs. |
integer (int32) |
timeoutSeconds |
The number of seconds to wait on an API call against a target system before timing out. |
integer (int32) |
requestBodyDocument |
The JSON payload body for this request (POST, PUT). Blank if there is no body. |
string |
4.652. StartBatchRequest
Name | Description | Schema |
---|---|---|
batchName |
The name of the batch to be started |
string |
batchGroupId |
The optional group ID which can be used to group multiple batch operations together, if not specified a group id will be generated. |
string |
jobDescription |
Example : |
< JobDescriptor > array |
4.653. AsyncStringResponse
Provides a unique string identifier for requesting status of an asynchronous call.
Name | Description | Schema |
---|---|---|
requestId |
A unique value that identifies the request ID for later retrieval. |
string |
4.654. AsyncResponse
Name | Description | Schema |
---|---|---|
requestId |
Example : |
string (int64) |
4.655. SystemReplicationRequest
Name | Description | Schema |
---|---|---|
sourceSystemId |
The ID of the source system. |
string |
targetSystemIds |
The IDs of the target systems. |
< string > array |
configurationElements |
A list of input document elements to apply to the target systems. |
< enum (all, pools, volumeGroups, volumes, hotSpares, arraySettings) > array |