White Papers

Table of contents
3 Dell Storage Manager REST API Cookbook | 3089-WP-SAN
Table of contents
Revisions............................................................................................................................................................................. 2
Acknowledgements ............................................................................................................................................................. 2
Table of contents ................................................................................................................................................................ 3
Executive summary ............................................................................................................................................................. 6
1 Getting started .............................................................................................................................................................. 7
1.1 REST overview ................................................................................................................................................... 7
1.2 Install and configure Python ............................................................................................................................... 7
1.3 Deploy modules and logging .............................................................................................................................. 8
1.4 DSM REST API installation and help ................................................................................................................. 8
1.5 Establish the DSM parameters ........................................................................................................................... 9
1.6 Define the base URL and header information .................................................................................................... 9
1.7 Create a requests.Session() object .................................................................................................................... 9
2 Connecting to a DSM Data Collector ......................................................................................................................... 10
2.1 Open a connection ........................................................................................................................................... 10
2.2 Close a connection ........................................................................................................................................... 10
2.3 Understanding instanceId ................................................................................................................................. 11
2.3.1 <instanceId> API connection ............................................................................................................................ 11
2.3.2 <instanceId> All SC Series arrays managed by a DSM Data Collector ........................................................... 12
2.3.3 <instanceId> All volume folder objects ............................................................................................................. 13
2.3.4 <instanceId> All volume objects ....................................................................................................................... 14
2.3.5 <instanceId> All server folder objects .............................................................................................................. 14
2.3.6 <instanceId> All server objects ......................................................................................................................... 15
2.3.7 <instanceId> All operating system types .......................................................................................................... 16
2.4 Putting it together.............................................................................................................................................. 17
2.5 Console output .................................................................................................................................................. 17
2.5.1 HTTP response codes ...................................................................................................................................... 18
2.5.2 Python dictionary data structure ....................................................................................................................... 18
3 Working with the SC Series array .............................................................................................................................. 19
3.1 Server folders ................................................................................................................................................... 19
3.1.1 Create a server folder ....................................................................................................................................... 19
3.1.2 Modify a server folder ....................................................................................................................................... 20
3.1.3 Delete a server folder ....................................................................................................................................... 21
3.2 Servers ............................................................................................................................................................. 22
3.2.1 Create an FC or iSCSI server ........................................................................................................................... 22