What's New in the PowerMax API 10.2
Thu, 17 Oct 2024 15:44:45 -0000
|Read Time: 0 minutes
Unisphere 10.2 has just been released, and as usual I will try to give the 1000 foot overview of the top changes in the REST API, and why you should consider upgrading.
The full API documentation is available, as always, at https://developer.dell.com/apis/. Just search for PowerMax and you can explore online or download the OpenApi.json documentation from the overview section to use with your favorite API development tool. A full change log is published on https://www.dell.com/support/home/en-us/product-support/product/unisphere-powermax/docs.
First off, if you’re not using it already, get the REST Client, providing, of course, you are permitted to install it on your corporate device. It is hosted on my personal blog with best effort support (I did not develop it, I’m not really that smart!). The new REST Client is a great tool and will save you hours trying to decipher documentation. As a visual and hands on learner, this tool makes me productive quicker. As usual, a new version of PyU4V is also available for Python developers on GitHub and available for installation with PIP.
NOTE: Upgrading provides support for the current version, and the two previous versions of the PowerMax API. Upgrading to Unisphere 10.2 provides backward compatibility for version 10.1 and 10.0. If you are using an older version to support scripts, please validate your workflows before switching to new endpoints.
Running the GET version API call will give you this information:
{ "version": "V10.2.0.1", "api_version": "102", "supported_api_versions": [ "102", "101", "100" ] }
Ok, now onto the improvements...
The enhanced API keeps getting better
The changes in this release are seamless to customers and all under the hood, making them even more efficient on server resources.
Customers already using the enhanced APIs for bulk data gathering have been impressed by the simplicity and flexibility of the new calls. These enhanced API calls are versatile and reduce the amount of code you need to maintain to accomplish a wide range of telemetry/monitoring tasks on your storage configuration and performance.
Enhanced APIs are under a different Base URL https://ipaddress:8443/univmax/rest/v1/.There are three resources there at present:
- systems/{id}/performance-categories
- systems/{id}/storage-groups
- systems/{id}/volumes
For more information on using these calls and selection and filtering operations, check out my blog here.
Improvements for SRDF API users
When protecting new workloads with SRDF replication, administrators want to ensure that they are not going to impact existing replicated applications. Managing this at scale can be challenging, but our development team recognizes this and has built in analytics to help users protect themselves and their automated workflows.
With the 10.2 API call optional enum performance_impact_validation_option has been added to the payload SRDF POST calls. This applies to MetroDR environments also.
The performance_Impact_Validation_Option has two possible values:
- Preview - Run performance impact tests and return performance impact scores for the requested operation. Return input object (with generated fields, if applicable) for the relevant follow up API.
- IfRecommended - Run performance impact tests. If no performance capacity threshold is breached, run the requested configuration change operation. If a performance capacity threshold is breached, the action will not proceed.
Setting either option returns tested input objects (with generated fields, if applicable), performance impact scores for the requested operation, and relevant warnings and/or errors.
The API call below shows the new inputs and payload:
To use these new options the array must be registered for performance data collection and have at least 14 days of data available.
Reverse Replication Support for SRDF MetroDR
Unisphere for PowerMax 10.2 introduces an enhancement to MetroDR which offers the ability to replicate from the disaster recovery (DR) site to the Metro region after a failover. The enhancement enables the ability for the Metro region to have a full copy of data from the DR site prior to failing back to the Metro region. An optional Boolean key to reverse has been added to the PUT payload to enable this functionality.
NOTE: This functionality requires PowerMax OS 10.2.
SRDF Auto Recovery Enable/Disable with REST
With PowerMax OS 10.2, new functionality has been added to automatically recover SRDF/A sessions in the event of a temporary issue. A new action EnableSrdfAutoRecovery is available for RDFG PUT calls. Setting this corresponding key enable_srdfa_auto_recovery value to True enables this feature.
NOTE: This functionality requires PowerMax OS 10.2.
The API call is shown in the image below along with the payload to enable:
LDAP Configuration Endpoints
New GET and PUT calls for configuring and checking LDAP authority management are available under the endpoint address https://ipaddress:8443/univmax/restapi/102/system/authorization/ldap.
Sample payload for PUT:
{ "action": "Enable",
"enable_ldap_authority": {
"server": "10.247.73.473",
"port": "636",
"bind_dn": "CN=tuser1,CN=Users,DC=eee,DC=infra,DC=dev",
"bind_password": "Password1",
"user_search_path": "DC=eee,DC=infra,DC=dev",
"user_object_class": "user",
"user_id_attribute": "samaccountname",
"group_search_path": "DC=eee,DC=infra,DC=dev",
"group_name_attribute": "cn",
"group_member_attribute": "member",
"group_object_class": "group",
"ssl_certificate": "-----BEGIN CERTIFICATE-----\nMIIG9TCCBN2gAwIBAgITLQAAABmeFwVg8WOc6AAAAAAAGTANBgkqhkiG9w0BAQ0FADBbMRMwEQYKCZImiZPyLGQBGRYDZGV2MRUwEwYKCZImiZPyLGQBGRYFaW5mcmExEzARBgoJkiaJk/IsZAEZFgNlZWUxGDAWBgNVBAMTD2VlZS1MMlNFMDE3My1DQTAeFw0yMzA3MjMxNjA4MzRaFw0yNTA3MjMxNjE4MzRaMCExHzAdBgNVBAMTFmwyc2UwMTczLmVlZS5pbmZyYS5kZXYwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDdtSBnyDuj+SuApps5m91HpqJsCMbVAfjGBkd3SQZ02zTwXFPXJO/3L7TYX3hJO8v0rEojwB2QypnRLOmrZ1Bgr8wlhQ1dJ8J6cR00Jpq25djOETEDiy7hlycEvdMIszJhHoLyq9zFQCmwOST4n9FISKk6iSW5yEjE91E/Tge44SQpVnMWJeeSFhspHnMg17tzCGBBzGUU/zCj2NPt5ejUTEb/mNuti3DuynEy/nySeeTiu1HpIHxEP5CraBh9RkaBfNFQNchLf+c+6IyAED3KboifVV3Qa5X9tjsZKd/jd1MLYEM2AEHOAOTIqbVZxe7uhMiCDG630Kf2lj38kWHhAgMBAAGjggLqMIIC5jA8BgkrBgEEAYI3FQcELzAtBiUrBgEEAYI3FQiDw/A0gsH0UYPZlxeF+qxwhou2V22K1SmEiehbAgFkAgEEMDIGA1UdJQQrMCkGCCsGAQUFBwMCBggrBgEFBQcDAQYKKwYBBAGCNxQCAgYHKwYBBQIDBTAOBgNVHQ8BAf8EBAMCBaAwQAYJKwYBBAGCNxUKBDMwMTAKBggrBgEFBQcDAjAKBggrBgEFBQcDATAMBgorBgEEAYI3FAICMAkGBysGAQUCAwUwHQYDVR0OBBYEFJKBJWOmHLvBpLiUr5IRuueR7W7VMEEGA1UdEQQ6MDiCFmwyc2UwMTczLmVlZS5pbmZyYS5kZXaCGGwyc2UwMTczLmhvcC5sYWIuZW1jLmNvbYcECvdJrTAfBgNVHSMEGDAWgBRB/561uVCYeSDObCoZEFWISuBtfTCB0wYDVR0fBIHLMIHIMIHFoIHCoIG/hoG8bGRhcDovLy9DTj1lZWUtTDJTRTAxNzMtQ0EsQ049bDJzZTAxNzMsQ049Q0RQLENOPVB1YmxpYyUyMEtleSUyMFNlcnZpY2VzLENOPVNlcnZpY2VzLENOPUNvbmZpZ3VyYXRpb24sREM9ZWVlLERDPWluZnJhLERDPWRldj9jZXJ0aWZpY2F0ZVJldm9jYXRpb25MaXN0P2Jhc2U/b2JqZWN0Q2xhc3M9Y1JMRGlzdHJpYnV0aW9uUG9pbnQwgcYGCCsGAQUFBwEBBIG5MIG2MIGzBggrBgEFBQcwAoaBpmxkYXA6Ly8vQ049ZWVlLUwyU0UwMTczLUNBLENOPUFJQSxDTj1QdWJsaWMlMjBLZXklMjBTZXJ2aWNlcyxDTj1TZXJ2aWNlcyxDTj1Db25maWd1cmF0aW9uLERDPWVlZSxEQz1pbmZyYSxEQz1kZXY/Y0FDZXJ0aWZpY2F0ZT9iYXNlP29iamVjdENsYXNzPWNlcnRpZmljYXRpb25BdXRob3JpdHkwDQYJKoZIhvcNAQENBQADggIBAKosFfyaOyNFjlJsQa4OUQXzUzORaaSbtHgCwiIishSoxlqW5peCGQR7DZobjyM5LWkakDtVjT77cX9iNkBATlHVzXo553g8J9EmjyPqrWd6YV6+gms6orOxNteqIw7w1tw+WUyaSOv2Y5YHVbvhGz86ariLK33EV3E1hR6Z6djItXRM8aUICRUYaJfky+4sWSPsCfdcwKRuuFBVHol709Ajwkb0k9XAMyEOGNVUslSBi+juapV3Q44accFmdM4MLuVfULfHhRdHgQSsUnNB11jlYfs0e4wVitXDNT7ZCJwxtERJe6H+ys+U31TS2+DXwlSX0v7UTMSZ/MHJ3DlFX/eaSpXyLMWNjhnEF19QiHadNTXnRME+7a5Q5l87PMb3OyRYtJvNedxakGj5b201PCd8kle4Uo+NtLBz+TBQ4qUzmiJ0THW45RjFkRl2iP3fUgNCJw52dS075o+QjgQpXcIwJvah6FzTlY9fZv41uDbanMVbZGhvnBseCRrdEmcwb0Cf/F94Tpi0phS/epVEy1xILhMzc1ddOM367t/q612wYbgz3akgJEiMVsyqS09RLZT2fXtenlHVorSN3WeSqYhKR0yDuLUb+YOIZB1zIpTlzcNEJPKvOmXWNRFYSCQK3MEDmLVrgM78oRnVeeoRrMIJRqq+MEfgPBLfG+XvguyP\n-----END CERTIFICATE-----\n",
"limit_authentication_to_ldap_group_members": false,
"ldap_group_names": ""
}
}
Changes From Customer Feedback
1. Remove WWN spoofing on migrated devices
The change is implemented with a new I on the payload for the PUT method endpoint address:
https://ipaddress:8443/univmax/restapi/102/sloprovisioning/symmetrix/{symmetrixId}/volume/{volumeId} (PUT)
{ "editVolumeActionParam": { "reset_wwn_param": { "reset_wwn": "true" } } }
2. Ability to enable or disable CHAP Authentication on iSCSI Ports
These options are shown in the following image:
To support this function new properties have been added to the corresponding GET calls so users can verify everything is set correctly.
NOTE: This is not an exhaustive list of new API updates; just a few of the highlights. See the change log for the full list.
With every release, our developers make improvements to the underlying server infrastructure supporting our API and yielding efficiencies in how it operates. While these changes typically go unnoticed, it’s worth mentioning when you do upgrade, these changes are made without modifying the code. Thanks for taking the time to read this post, and if you have a question, please open a discussion on GitHub for PyU4V and we’ll do our best to answer in a timely manner.
Author: Paul Martin Senior Principal Engineer Technical Marketing
@rawstorage