Welcome back to our adventure in Storage Automation using APIs! This post will be focusing on getting the Python Script in place so we can eventually build out some nice reports.
Since you were willing to take the Red Pill and weren't scared off by the after math, Let's keep digging in!
Below is the script that I came up with by building off of the original which was created in my last step of the process (Downloadable version of the script at my GitHub):
1: #------------------------------------------------------------------------------
2: #Imports modules to be used within the script
3: #------------------------------------------------------------------------------
4: #Allows API Calls to be made to the VMAX
5: import requests
6:
7: #Allows the API Call to Authenticate with username/password
8: from requests.auth import HTTPBasicAuth
9:
10: #Allows you to ignore the Security warning associated with unsecured certificates
11: from requests.packages.urllib3.exceptions import InsecureRequestWarning
12: requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
13: #------------------------------------------------------------------------------
14:
15: #------------------------------------------------------------------------------
16: #Build Variables to be used within the API Call
17: #------------------------------------------------------------------------------
18: username="<User ID>"
19: password="<Password>"
20:
21: #Calls for all Volumes which are true tdevs (customer facing)
22: #NOTE: Use the specific Univmax version API Calls that you have installed on the VMAX
23: #(Ex: I use '83' API Calls because we are running UniVMAX 8.3)
24: url = 'https://<VMAX IP>:8443/univmax/restapi/83/sloprovisioning/symmetrix/<VMAX SID>/volume?tdev=true'
25:
26: headers = {'content-type': 'application/json',
27: 'accept': 'application/json'}
28: verifySSL=False
29: #------------------------------------------------------------------------------
30:
31: #------------------------------------------------------------------------------
32: #Build the Session to make the API call to the VMAX
33: #------------------------------------------------------------------------------
34: session = requests.session()
35: session.headers = headers
36: session.auth = HTTPBasicAuth(username, password)
37: session.verify = verifySSL
38: #------------------------------------------------------------------------------
39:
40: #------------------------------------------------------------------------------
41: #Make a GET request to the VMAX for a list of LUNs/TDEVs
42: #------------------------------------------------------------------------------
43: lun_id_get = session.request('GET', url=url, timeout=60).json()
44: lun_list = lun_id_get.get('resultList')
45:
46: #Loop thru each of the LUNs and pull the relevant data for reporting purposes
47: for i in lun_list.get('result'):
48: lun_id=i.get('volumeId')
49: print ('-----------------------------------------------------------------')
50: print ('Volume ID: ' + lun_id)
51: print ('-----------------------------------------------------------------')
52:
53: # Grab each LUNs relevant data for reporting purposes
54: url = 'https://<VMAX IP>:8443/univmax/restapi/83/sloprovisioning/symmetrix/<VMAX SID>/volume/' + lun_id
55: response = session.request('GET', url=url, timeout=60)
56: data = response.json()
57: lun_name = data['volume'][0]['volume_identifier']
58: lun_cap = data['volume'][0]['cap_gb']
59: lun_used = data['volume'][0]['allocated_percent']
60: print('LUN Name: ' + lun_name)
61: print('LUN Capacity: ' + str(lun_cap))
62: print('LUN Used: ' + str(lun_used))
63: print('-----------------------------------------------------------------')
64: print('')
65: #------------------------------------------------------------------------------
As you walk through the script, you will see the backbone is still the same as the previous version but with a bit of a twist.
- Adjusted my URL call to use the specific version of UniVMAX (8.3) as to match up exactly what the array is expected to see.
- Added the "tdev=true" filter to the API URL to only return the LUNs that I need to see, and not the backend LUNs behind the scenes.
- I added a Loop, which allows us to take the list of LUNs/TDEVs returned from the array and pull specific data we would like to report on.
- Volume Name
- Volume Max Capacity
- Volume Allocated Percent
- etc...
What's up Next?
Now that we have the desired data that we can play with, our next step is to take that data and create a nice and pretty report to show off to your co-workers and friends. I'm hoping to tie a report into Slack and post it within a Slack Channel.
Previous Blogs in the Series
- Episode 0 - Storage DevOps: A Great Adventure - The Prelude
- Episode 1 - Storage Automation: A Great Adventure - Red Pill
Tools Used in the Making of this Episode
- PyCharm: Python IDE that seems to have favor of the community
- PyU4V Project: GUI for building API Calls to the VMAX
Special Thanks
- Paul Martin (@rawstorage) for helping to continue down this rabbit hole
