Sunday, December 28, 2014

Sample code: Using the Oracle ZFS Storage Appliance REST API from Python

Most (all?) of the Oracle ZFS Storage Appliance (ZS3-4 in my case) management functions are also exposed through REST API so it is possible to script and automate the storage management tasks. No proprietary clients or GUI needed, just need to write a simple script that can send some REST commands over HTTPS to the appliance and parse the JSON output.

I had a task of automating test database refresh from production and part of that workflow is also cloning and attaching LUNs from ZFSSA. I did not find any sample code to access ZFSSA online, so here am I publishing my code. It is a Python script that makes a use of a few ZFSSA REST API calls and publishes them as Fabric tasks.

This script exposes four tasks:

  • clone - Creates a new clone from replication
  • attach_stage1 - Attaches all LUNs in a project to a single target server
  • attach_stage2 - Attaches all LUNs in a project to multiple target servers
  • drop - Deletes a project

ZFSSA REST API works fine if each LUN has only a single initiator group, but when assigning LUN to multiple initiator groups (to be used in a RAC setup), I observed the following errors (they must be ZFSSA REST API bugs):

  • When modifying LUN to be part of multiple initiator groups (PUT request to /api/storage/v1/pools/_poolname_/projects/_projectname_/luns/_lunname_), then the API responds with (argument numbers may be different): {"fault": {"message": "invalid input argument (assignednumber: invalid literal for int() with base 10: '0,0,0')", "code": 400, "name": "ERR_INVALID_ARG"}}. Nevertheless, ZFS GUI confirms that the operation was completed successfully. This script just ignores the returned error message, when assigning LUN to multiple initiator groups.
  • If any LUN in the project has multiple initiator groups defined, then API call to get the list of LUNs (GET request to /api/storage/v1/pools/_poolname_/projects/_projectname_/luns) in a project returns an error immediately: {"luns":[{"fault": {"message": "internal error", "code": 500, "name": "ERR_INTERNAL"}}]}. This script cannot reattach the LUNs in this case, since getting the list of LUNs fails.

No comments:

Post a Comment