+ Developer Guide Overview
QuantaStor REST API
QuantaStor was designed from the start with REST APIs to enable development of applications and extensions to remotely manage QuantaStor storage systems.
Supported Languages
You can use just about any programming language you like to communicate with QuantaStor via our RESTful API. Recommended tools:
Browser Tools
We highly recommend installing a tool like JSONView or other similar browser tool so that you can view the JSON output from the various API calls in an easy to read format. When experimenting with various APIs you can then use your browser to call the API, see the results, and plan for how to integrate it into your script or application.
Examples
Here's are some examples of how to enumerate various objects using the RESTful API and the curl utility:
curl -u admin:password https://192.168.0.116:8153/qstorapi/hostEnum -k curl -u admin:password https://192.168.0.116:8153/qstorapi/storageVolumeEnum -k curl -u admin:password https://192.168.0.116:8153/qstorapi/storageSystemGet -k curl -u admin:password https://192.168.0.116:8153/qstorapi/storagePoolEnum -k curl -u admin:password https://192.168.0.116:8153/qstorapi/userEnum -k curl -u admin:password https://192.168.0.116:8153/qstorapi/networkShareEnum -k
One quick way to test is to just enter one of these URLs (https://192.168.0.116:8153/qstorapi/hostEnum) into your web browser which will work as long as your system admin account is still using the default password. Pretty much every known language has a curl type library/module for it so the above technique will work everywhere, you just need to get up to speed with your preferred language's curl API mechanism.
Note you can even access APIs using wget which in this example will store the results into a file called hostEnum:
wget --no-check-certificate https://192.168.0.135:8153/qstorapi/hostEnum
Passing Args as a File
You can also call one of our RESTful APIs by passing a file instead of command line arguments. To do this your command will look something like this:
curl -k -u admin:password -d @file.json https://192.168.0.116:8153/qstorapi/jsonrpc
An example of how the file should be formatted looks like this:
{ "method": "echo", "params": { "inputMessage": "Message" } }
The format being used is JSON. You specify the command you would like to call using the key "method". Then the parameters are passed in using the key "params". If more than one parameter is specified, separate them with a comma.
{ "method": "command", "params": { "param1": "<value1>", "param2": "<value2>", "param3": "<value3>" } }
Reflection
The RESTful API has basic support for reflection, meaning that you can learn about all the arguments for a given API just by calling it with the 'help' parameter like so:
curl -k -u admin:password https://192.168.0.116:8153/qstorapi/hostAdd?help
Calling APIs with Parameters
To call an API with parameters you'll need to add a & between each parameter you specify and a ? between the API name and the start of the parameters like so:
curl -k -u admin:password "https://192.168.0.116:8153/qstorapi/hostAdd?iqn=iqn.1991-05.com.microsoft:osn-mediaserver3&hostname=mediaserver3&flags=0"
Which will return JSON output like this (note the quotes so that the ampersand is not interpreted by the shell). Also note that sometimes it can be hard to read the JSON output so we recommend using a JSON Formatter when you're developing your integration code.
{ "task":{ "i18nDescription":{ "messageText":null, "messageId":null }, "operation":"add", "id":"ca54a531-6386-a4f7-b9de-30f505329bb1", "objectType":"Host", "finishTimeStamp":"1969-12-31 16:00:00", "isRemote":false, "createdTimeStamp":"2012-08-23 21:53:40", "state":0, "acls":[ { "reserved":0, "objectId":"ca54a531-6386-a4f7-b9de-30f505329bb1", "ownerType":23, "ownerId":"252d4786-b19f-ae43-1ff6-453bee8a652e", "accessLevel":2, "objectType":16 } ], "clientIpAddress":"127.0.0.1", "parentId":null, "modifiedByUserId":null, "progress":0, "customId":null, "type":16, "description":"Adding host 'mediaserver3' to service with iSCSI initiator IQN 'iqn.1991-05.com.microsoft:osn-mediaserver3'.", "errorMessage":{ "function":null, "severity":0, "errorCode":0, "file":null, "message":{ "messageText":null, "messageId":null }, "line":0 }, "modifiedTimeStamp":"1969-12-31 16:00:00", "storageSystemId":"50ce62e6-6846-c5b3-d8a1-27061a696604", "createdByUserId":"252d4786-b19f-ae43-1ff6-453bee8a652e", "name":"Add Host", "startTimeStamp":"2012-08-23 21:53:40", "taskState":2 }, "obj":{ "username":null, "storageSystemId":"50ce62e6-6846-c5b3-d8a1-27061a696604", "isRemote":false, "hostGroupId":null, "name":"mediaserver3", "ipAddress":null, "createdByUserId":"252d4786-b19f-ae43-1ff6-453bee8a652e", "modifiedTimeStamp":"1969-12-31 16:00:00", "createdTimeStamp":"2012-08-23 21:53:40", "state":0, "hostOsType":0, "initiatorPortList":[ { "storageSystemId":"50ce62e6-6846-c5b3-d8a1-27061a696604", "isRemote":false, "hostId":"4fb8c2da-235a-18f9-2620-1d8aa5da89c5", "name":"iqn.1991-05.com.microsoft:osn-mediaserver3", "ipAddress":null, "createdByUserId":"252d4786-b19f-ae43-1ff6-453bee8a652e", "modifiedTimeStamp":"1969-12-31 16:00:00", "createdTimeStamp":"2012-08-23 21:53:40", "wwpn":null, "state":0, "iqn":"iqn.1991-05.com.microsoft:osn-mediaserver3", "initiatorType":0, "modifiedByUserId":null, "customId":null, "type":13, "id":"535abed2-830a-a437-d6fd-5af7c5b5c263" } ], "modifiedByUserId":null, "customId":null, "password":"********", "type":11, "id":"4fb8c2da-235a-18f9-2620-1d8aa5da89c5", "description":"None" } }
Async vs. Sync (blocking vs non-blocking) API calls
All of the APIs for QuantaStor that modify the configuration in any way will start a task in the system. If you call any API with the flags parameter set to 0 it'll be treated as a blocking call which wait for the task to complete before returning. If you want to call the function and have it return immediately you can pass a 1 as the flags parameter which indicates to the server that the caller wants this to be an asynchronous non-blocking call. With asynchronous calls you'll get the task object back so that you can use the taskGet API to monitor the progress of the operation. When the task completes it will populate the customId property of the task to contain the ID(s) of the objects which were created/deleted/modified by the task.
Task Monitoring
As indicated above, sometimes you'll want to call an API asynchronously so that you can monitor the progress of the task and/or because you want to queue up multiple operations to run simultaneously. In such cases where you call an API asynchronously (flags=1) you can monitor the progress of the task using the tastGet API or the tastEnum API if you want to see all running tasks. When the task is completed you can check the customId property to see the ID(s) of the objects created/modified.
API Error Code Definitions
For all APIs a 0 is returned for SUCCESS and a non-zero error code is returned if there is a command failure along with a description of the error. Full list of error codes are available here.
Security
QuantaStor REST interface always uses SSL via HTTPS. You can change the pem keys on your system by replacing the qstorapi_server.pem file located in /opt/osnexus/quantastor/restsrv/ with your own. If you want to use plain HTTP without SSL you can rename or remove the qstorapi_server.pem and the RESTful service will automatically fall back to using HTTP. After removing the file just restart the RESTful service interface with:
service restsrv restart
If you want to block access to the restful interface you can stop the service and/or you can remove access to port 8153 by removing the entry associated with that port number from the /etc/init.d/iptables configuration file and then restart iptables like so:
service iptables restart
In a similar manner you can block access to the web management interface on port 80/8080.
Supported SOAP / WebServices Implementations
- gSOAP (C++, all platforms)
- Apache Axis (Java, all platforms)
- .NET (C# & Visual Basic, Windows)
API List
The following represents the full API list for every API in QuantaStor. Nothing is left out, if you can do it from the web management interface or the CLI, it's here.
Examples
curl -u username:password -k https://hostname:8153/qstorapi/aclAdd?objectId=<id>&ownerType=<int>&ownerId=<id>&accessLevel=<int>&objectType=<int> curl -u username:password -k https://hostname:8153/userAdd?username=tiger&password=passWORD1&firstName=Tiger&lastName=Woods&role=Administrator curl -u username:password -k -d @data.json https://hostname:8153/qstorapi/jsonrpc
Example Script
Here is an example script in python. To use this example replace the ip address with your QuantaStor boxes ip.
import json import subprocess print "I am getting the storage system info..." #To get the data make an http request (such as a curl call) proc = subprocess.Popen(["curl", "-k", "-u", "admin:password", "https://192.168.0.142:8153/qstorapi/storageSystemGet?"], stdout=subprocess.PIPE) (out, err) = proc.communicate() print print "Here is what the returned data looks like when I get it:" print print str(out) print #call json.loads to turn it into a python dictionary out = json.loads(out) print "Here is how to get a single field from the output:" print storageSystemId = out["id"] print storageSystemId
Contents
- 1 QuantaStor REST API
- 1.1 Supported Languages
- 1.2 Browser Tools
- 1.3 Examples
- 1.4 Reflection
- 1.5 Calling APIs with Parameters
- 1.6 Async vs. Sync (blocking vs non-blocking) API calls
- 1.7 Task Monitoring
- 1.8 API Error Code Definitions
- 1.9 Security
- 1.10 Supported SOAP / WebServices Implementations
- 1.11 API List
- 1.11.1 Examples
- 1.11.2 aclAdd API
- 1.11.3 aclModify API
- 1.11.4 aclRemove API
- 1.11.5 activeDirectoryUserAndGroupEnum API
- 1.11.6 alertClear API
- 1.11.7 alertClearAll API
- 1.11.8 alertConfigGet API
- 1.11.9 alertConfigSet API
- 1.11.10 alertEnum API
- 1.11.11 alertGet API
- 1.11.12 alertRaise API
- 1.11.13 auditLogClear API
- 1.11.14 auditLogDisable API
- 1.11.15 auditLogEnable API
- 1.11.16 auditLogGet API
- 1.11.17 backupJobCancel API
- 1.11.18 backupJobEnum API
- 1.11.19 backupJobGet API
- 1.11.20 backupJobStart API
- 1.11.21 backupJobStatusUpdate API
- 1.11.22 backupPolicyCreate API
- 1.11.23 backupPolicyDelete API
- 1.11.24 backupPolicyDisable API
- 1.11.25 backupPolicyEnable API
- 1.11.26 backupPolicyEnum API
- 1.11.27 backupPolicyGet API
- 1.11.28 backupPolicyModify API
- 1.11.29 backupPolicyTrigger API
- 1.11.30 cephBlockDeviceCreate API
- 1.11.31 cephBlockDeviceDelete API
- 1.11.32 cephBlockDeviceEnum API
- 1.11.33 cephBlockDeviceGet API
- 1.11.34 cephBlockDeviceModify API
- 1.11.35 cephBlockDeviceResize API
- 1.11.36 cephBlockDeviceSnapshot API
- 1.11.37 cephClusterEnum API
- 1.11.38 cephClusterGet API
- 1.11.39 cephHaFailoverInterfaceEnum API
- 1.11.40 cephHaFailoverInterfaceGet API
- 1.11.41 cephMonitorEnum API
- 1.11.42 cephMonitorGet API
- 1.11.43 cephOsdCreate API
- 1.11.44 cephOsdDelete API
- 1.11.45 cephOsdEnum API
- 1.11.46 cephOsdGet API
- 1.11.47 cephPoolCreate API
- 1.11.48 cephPoolDelete API
- 1.11.49 cephPoolEnum API
- 1.11.50 cephPoolGet API
- 1.11.51 cephPoolModify API
- 1.11.52 cephPoolOsdAssocEnum API
- 1.11.53 cephPoolOsdAssocGet API
- 1.11.54 cloudBackupScheduleAssocEnum API
- 1.11.55 cloudBackupScheduleAssocGet API
- 1.11.56 cloudBackupScheduleCreate API
- 1.11.57 cloudBackupScheduleDelete API
- 1.11.58 cloudBackupScheduleDisable API
- 1.11.59 cloudBackupScheduleEnable API
- 1.11.60 cloudBackupScheduleEnum API
- 1.11.61 cloudBackupScheduleGet API
- 1.11.62 cloudBackupScheduleModify API
- 1.11.63 cloudBackupScheduleTrigger API
- 1.11.64 cloudBackupScheduleVolumeAddRemove API
- 1.11.65 cloudContainerAdd API
- 1.11.66 cloudContainerCreate API
- 1.11.67 cloudContainerDelete API
- 1.11.68 cloudContainerDisable API
- 1.11.69 cloudContainerEnable API
- 1.11.70 cloudContainerEnum API
- 1.11.71 cloudContainerGet API
- 1.11.72 cloudContainerModify API
- 1.11.73 cloudContainerRemove API
- 1.11.74 cloudContainerRepair API
- 1.11.75 cloudProviderCredentialsAdd API
- 1.11.76 cloudProviderCredentialsEnum API
- 1.11.77 cloudProviderCredentialsGet API
- 1.11.78 cloudProviderCredentialsRemove API
- 1.11.79 cloudProviderEnum API
- 1.11.80 cloudProviderGet API
- 1.11.81 cloudProviderLocationAdd API
- 1.11.82 cloudProviderLocationEnum API
- 1.11.83 cloudProviderLocationGet API
- 1.11.84 cloudProviderLocationRemove API
- 1.11.85 clusterFailoverGroupActivate API
- 1.11.86 clusterFailoverGroupCreate API
- 1.11.87 clusterFailoverGroupDelete API
- 1.11.88 clusterFailoverGroupEnum API
- 1.11.89 clusterFailoverGroupGet API
- 1.11.90 clusterFailoverGroupModify API
- 1.11.91 customApi API
- 1.11.92 echo API
- 1.11.93 eventEnum API
- 1.11.94 eventListenerNotify API
- 1.11.95 eventListenerRegister API
- 1.11.96 eventListenerUnregister API
- 1.11.97 fcTargetPortDisable API
- 1.11.98 fcTargetPortEnable API
- 1.11.99 fcTargetPortEnum API
- 1.11.100 fcTargetPortGet API
- 1.11.101 getHardwareConfig API
- 1.11.102 getLocalizedMessage API
- 1.11.103 getSecurityConfig API
- 1.11.104 getSystemConfig API
- 1.11.105 glusterBrickCreate API
- 1.11.106 glusterBrickDelete API
- 1.11.107 glusterBrickEnum API
- 1.11.108 glusterBrickGet API
- 1.11.109 glusterHaFailoverInterfaceCreate API
- 1.11.110 glusterHaFailoverInterfaceDelete API
- 1.11.111 glusterHaFailoverInterfaceEnum API
- 1.11.112 glusterHaFailoverInterfaceGet API
- 1.11.113 glusterHaFailoverInterfaceMove API
- 1.11.114 glusterPeerDetach API
- 1.11.115 glusterPeerEnum API
- 1.11.116 glusterPeerGet API
- 1.11.117 glusterPeerProbe API
- 1.11.118 glusterServiceRestart API
- 1.11.119 glusterVolumeAddBricks API
- 1.11.120 glusterVolumeCreate API
- 1.11.121 glusterVolumeDelete API
- 1.11.122 glusterVolumeEnum API
- 1.11.123 glusterVolumeGet API
- 1.11.124 glusterVolumeModify API
- 1.11.125 glusterVolumeRebalance API
- 1.11.126 glusterVolumeReplaceBrick API
- 1.11.127 glusterVolumeStart API
- 1.11.128 glusterVolumeStop API
- 1.11.129 hostAdd API
- 1.11.130 hostEnum API
- 1.11.131 hostGet API
- 1.11.132 hostGroupCreate API
- 1.11.133 hostGroupDelete API
- 1.11.134 hostGroupEnum API
- 1.11.135 hostGroupGet API
- 1.11.136 hostGroupHostAddRemove API
- 1.11.137 hostGroupModify API
- 1.11.138 hostInitiatorAdd API
- 1.11.139 hostInitiatorEnum API
- 1.11.140 hostInitiatorGet API
- 1.11.141 hostInitiatorRemove API
- 1.11.142 hostModify API
- 1.11.143 hostRemove API
- 1.11.144 hwAlarmEnum API
- 1.11.145 hwAlarmGet API
- 1.11.146 hwBatteryBackupUnitEnum API
- 1.11.147 hwBatteryBackupUnitGet API
- 1.11.148 hwControllerChangeSecurityKey API
- 1.11.149 hwControllerClearAlarms API
- 1.11.150 hwControllerCreateSecurityKey API
- 1.11.151 hwControllerEnum API
- 1.11.152 hwControllerGet API
- 1.11.153 hwControllerGroupEnum API
- 1.11.154 hwControllerGroupGet API
- 1.11.155 hwControllerImportForeignUnits API
- 1.11.156 hwControllerModify API
- 1.11.157 hwControllerRescan API
- 1.11.158 hwControllerRescanAll API
- 1.11.159 hwControllerSilenceAlarms API
- 1.11.160 hwDiskEnum API
- 1.11.161 hwDiskGet API
- 1.11.162 hwDiskIdentify API
- 1.11.163 hwDiskMarkGood API
- 1.11.164 hwDiskMarkHotSpare API
- 1.11.165 hwDiskModify API
- 1.11.166 hwDiskRemove API
- 1.11.167 hwEnclosureEnum API
- 1.11.168 hwEnclosureGet API
- 1.11.169 hwEnclosureLayoutEnum API
- 1.11.170 hwEnclosureLayoutGet API
- 1.11.171 hwEnclosureModify API
- 1.11.172 hwLogicalDriveEnum API
- 1.11.173 hwLogicalDriveGet API
- 1.11.174 hwSwitchAdapterEnum API
- 1.11.175 hwSwitchAdapterGet API
- 1.11.176 hwSwitchCredentialsAdd API
- 1.11.177 hwSwitchCredentialsEnum API
- 1.11.178 hwSwitchCredentialsGet API
- 1.11.179 hwSwitchCredentialsModify API
- 1.11.180 hwSwitchCredentialsRemove API
- 1.11.181 hwSwitchEnum API
- 1.11.182 hwSwitchFailoverGroupActivate API
- 1.11.183 hwSwitchFailoverGroupCreate API
- 1.11.184 hwSwitchFailoverGroupDelete API
- 1.11.185 hwSwitchFailoverGroupEnum API
- 1.11.186 hwSwitchFailoverGroupGet API
- 1.11.187 hwSwitchFailoverGroupModify API
- 1.11.188 hwSwitchFailoverGroupPoolAssocEnum API
- 1.11.189 hwSwitchFailoverGroupPoolAssocGet API
- 1.11.190 hwSwitchFailoverGroupSetMode API
- 1.11.191 hwSwitchFailoverGroupSystemAssocAdd API
- 1.11.192 hwSwitchFailoverGroupSystemAssocEnum API
- 1.11.193 hwSwitchFailoverGroupSystemAssocGet API
- 1.11.194 hwSwitchFailoverGroupSystemAssocRemove API
- 1.11.195 hwSwitchGet API
- 1.11.196 hwSwitchRescan API
- 1.11.197 hwSwitchZonesetActivate API
- 1.11.198 hwSwitchZonesetEnum API
- 1.11.199 hwSwitchZonesetGet API
- 1.11.200 hwUnitCreate API
- 1.11.201 hwUnitDelete API
- 1.11.202 hwUnitDiskAssocEnum API
- 1.11.203 hwUnitDiskAssocGet API
- 1.11.204 hwUnitEnableEncryption API
- 1.11.205 hwUnitEnum API
- 1.11.206 hwUnitGet API
- 1.11.207 hwUnitGrow API
- 1.11.208 hwUnitIdentify API
- 1.11.209 hwUnitModify API
- 1.11.210 hwUnitSsdCacheCreate API
- 1.11.211 hwUnitSsdCacheDisable API
- 1.11.212 hwUnitSsdCacheEnable API
- 1.11.213 ibTargetPortEnum API
- 1.11.214 ibTargetPortGet API
- 1.11.215 libratoMetricsConfigGet API
- 1.11.216 libratoMetricsConfigSet API
- 1.11.217 licenseActivate API
- 1.11.218 licenseActivateOnline API
- 1.11.219 licenseAdd API
- 1.11.220 licenseEnum API
- 1.11.221 licenseGet API
- 1.11.222 licenseRemove API
- 1.11.223 login API
- 1.11.224 networkShareCifsOptionEnum API
- 1.11.225 networkShareCifsOptionGet API
- 1.11.226 networkShareClientAdd API
- 1.11.227 networkShareClientEnum API
- 1.11.228 networkShareClientGet API
- 1.11.229 networkShareClientModify API
- 1.11.230 networkShareClientRemove API
- 1.11.231 networkShareClone API
- 1.11.232 networkShareCreate API
- 1.11.233 networkShareCreateEx API
- 1.11.234 networkShareDelete API
- 1.11.235 networkShareDeleteEx API
- 1.11.236 networkShareDisable API
- 1.11.237 networkShareEnable API
- 1.11.238 networkShareEnum API
- 1.11.239 networkShareEnumQuotas API
- 1.11.240 networkShareGet API
- 1.11.241 networkShareJoinDomain API
- 1.11.242 networkShareLeaveDomain API
- 1.11.243 networkShareModify API
- 1.11.244 networkShareNfsConfig API
- 1.11.245 networkShareRestore API
- 1.11.246 networkShareRollback API
- 1.11.247 networkShareServicesRestart API
- 1.11.248 networkShareSetQuotas API
- 1.11.249 networkShareSnapshot API
- 1.11.250 networkShareUserAccessEnum API
- 1.11.251 networkShareUserAccessGet API
- 1.11.252 objectEnum API
- 1.11.253 objectGet API
- 1.11.254 objectLock API
- 1.11.255 objectPropertyGet API
- 1.11.256 objectPropertySet API
- 1.11.257 objectUnlock API
- 1.11.258 permissionDefinitionEnum API
- 1.11.259 physicalDiskDataMigration API
- 1.11.260 physicalDiskEnum API
- 1.11.261 physicalDiskGet API
- 1.11.262 physicalDiskGlobalSpareAddRemove API
- 1.11.263 physicalDiskGlobalSpareEnum API
- 1.11.264 physicalDiskHotspareMarkerCleanup API
- 1.11.265 physicalDiskHotspareMarkerEnum API
- 1.11.266 physicalDiskHotspareMarkerGet API
- 1.11.267 physicalDiskIdentify API
- 1.11.268 physicalDiskPathAssocEnum API
- 1.11.269 physicalDiskPathAssocGet API
- 1.11.270 physicalDiskScan API
- 1.11.271 registerSecurityToken API
- 1.11.272 remoteNfsExportsEnum API
- 1.11.273 remoteStoragePoolEnum API
- 1.11.274 replicaAssocDelete API
- 1.11.275 replicaAssocEnum API
- 1.11.276 replicaAssocGet API
- 1.11.277 replicaAssocUpdate API
- 1.11.278 replicaCreate API
- 1.11.279 replicaCreateNetworkShareTarget API
- 1.11.280 replicaCreateVolumeTarget API
- 1.11.281 replicaRollback API
- 1.11.282 replicaStatusUpdate API
- 1.11.283 replicaStop API
- 1.11.284 replicaSync API
- 1.11.285 replicationScheduleAddRemove API
- 1.11.286 replicationScheduleAssocEnum API
- 1.11.287 replicationScheduleAssocGet API
- 1.11.288 replicationScheduleCreate API
- 1.11.289 replicationScheduleDelete API
- 1.11.290 replicationScheduleDisable API
- 1.11.291 replicationScheduleEnable API
- 1.11.292 replicationScheduleEnum API
- 1.11.293 replicationScheduleGet API
- 1.11.294 replicationScheduleModify API
- 1.11.295 replicationScheduleTrigger API
- 1.11.296 roleCreate API
- 1.11.297 roleDelete API
- 1.11.298 roleEnum API
- 1.11.299 roleGet API
- 1.11.300 roleModify API
- 1.11.301 rolePermissionAssignmentEnum API
- 1.11.302 rolePermissionAssignmentGet API
- 1.11.303 rolePermissionsAddRemove API
- 1.11.304 roleSubjectAssocEnum API
- 1.11.305 roleSubjectAssocGet API
- 1.11.306 sessionClose API
- 1.11.307 sessionEnum API
- 1.11.308 sessionGet API
- 1.11.309 siteAssocEnum API
- 1.11.310 siteAssocGet API
- 1.11.311 siteCreate API
- 1.11.312 siteDelete API
- 1.11.313 siteEnum API
- 1.11.314 siteGet API
- 1.11.315 siteModify API
- 1.11.316 siteStorageSystemAddRemove API
- 1.11.317 snapshotScheduleAssocEnum API
- 1.11.318 snapshotScheduleAssocGet API
- 1.11.319 snapshotScheduleCreate API
- 1.11.320 snapshotScheduleDelete API
- 1.11.321 snapshotScheduleDisable API
- 1.11.322 snapshotScheduleEnable API
- 1.11.323 snapshotScheduleEnum API
- 1.11.324 snapshotScheduleGet API
- 1.11.325 snapshotScheduleModify API
- 1.11.326 snapshotScheduleTrigger API
- 1.11.327 snapshotScheduleVolumeAddRemove API
- 1.11.328 storageCloudCreate API
- 1.11.329 storageCloudDelete API
- 1.11.330 storageCloudEnum API
- 1.11.331 storageCloudGet API
- 1.11.332 storageCloudModify API
- 1.11.333 storageCloudResourceAddRemove API
- 1.11.334 storageCloudResourceAssocEnum API
- 1.11.335 storageCloudResourceAssocGet API
- 1.11.336 storageCloudResourceSetMode API
- 1.11.337 storageCloudSubjectAssocEnum API
- 1.11.338 storageCloudSubjectAssocGet API
- 1.11.339 storageCloudUserAddRemove API
- 1.11.340 storagePoolCacheAddRemove API
- 1.11.341 storagePoolCreate API
- 1.11.342 storagePoolDestroy API
- 1.11.343 storagePoolDeviceEnum API
- 1.11.344 storagePoolDeviceGet API
- 1.11.345 storagePoolEnum API
- 1.11.346 storagePoolExpand API
- 1.11.347 storagePoolExport API
- 1.11.348 storagePoolGet API
- 1.11.349 storagePoolGrow API
- 1.11.350 storagePoolHaFailoverGroupActivate API
- 1.11.351 storagePoolHaFailoverGroupCreate API
- 1.11.352 storagePoolHaFailoverGroupDeactivate API
- 1.11.353 storagePoolHaFailoverGroupDelete API
- 1.11.354 storagePoolHaFailoverGroupEnum API
- 1.11.355 storagePoolHaFailoverGroupFailover API
- 1.11.356 storagePoolHaFailoverGroupGet API
- 1.11.357 storagePoolHaFailoverGroupModify API
- 1.11.358 storagePoolHaFailoverInterfaceCreate API
- 1.11.359 storagePoolHaFailoverInterfaceDelete API
- 1.11.360 storagePoolHaFailoverInterfaceEnum API
- 1.11.361 storagePoolHaFailoverInterfaceGet API
- 1.11.362 storagePoolHaFailoverModuleEnum API
- 1.11.363 storagePoolHaFailoverModuleGet API
- 1.11.364 storagePoolIdentify API
- 1.11.365 storagePoolModify API
- 1.11.366 storagePoolProfileEnum API
- 1.11.367 storagePoolProfileGet API
- 1.11.368 storagePoolRescan API
- 1.11.369 storagePoolScrubStart API
- 1.11.370 storagePoolScrubStop API
- 1.11.371 storagePoolSpareAddRemove API
- 1.11.372 storagePoolStart API
- 1.11.373 storagePoolStop API
- 1.11.374 storagePoolUpdateRedirect API
- 1.11.375 storageQuotaCreate API
- 1.11.376 storageQuotaDelete API
- 1.11.377 storageQuotaEnum API
- 1.11.378 storageQuotaGet API
- 1.11.379 storageQuotaModify API
- 1.11.380 storageQuotaShareAddRemove API
- 1.11.381 storageQuotaShareAssocEnum API
- 1.11.382 storageQuotaShareAssocGet API
- 1.11.383 storageQuotaVolumeAddRemove API
- 1.11.384 storageQuotaVolumeAssocEnum API
- 1.11.385 storageQuotaVolumeAssocGet API
- 1.11.386 storageSystemClusterAssocEnum API
- 1.11.387 storageSystemClusterAssocGet API
- 1.11.388 storageSystemClusterCreate API
- 1.11.389 storageSystemClusterDelete API
- 1.11.390 storageSystemClusterEnum API
- 1.11.391 storageSystemClusterGet API
- 1.11.392 storageSystemClusterGetHostsConfig API
- 1.11.393 storageSystemClusterModify API
- 1.11.394 storageSystemClusterNodeAdd API
- 1.11.395 storageSystemClusterNodeEject API
- 1.11.396 storageSystemClusterNodeJoin API
- 1.11.397 storageSystemClusterNodeRemove API
- 1.11.398 storageSystemClusterNodeSetMaster API
- 1.11.399 storageSystemClusterNodeSync API
- 1.11.400 storageSystemClusterSetHostsConfig API
- 1.11.401 storageSystemEnum API
- 1.11.402 storageSystemGet API
- 1.11.403 storageSystemGroupAddRemoveLinks API
- 1.11.404 storageSystemGroupAssocEnum API
- 1.11.405 storageSystemGroupAssocGet API
- 1.11.406 storageSystemGroupCreate API
- 1.11.407 storageSystemGroupDelete API
- 1.11.408 storageSystemGroupEnum API
- 1.11.409 storageSystemGroupGet API
- 1.11.410 storageSystemGroupModify API
- 1.11.411 storageSystemGroupSetPassword API
- 1.11.412 storageSystemLinkCreate API
- 1.11.413 storageSystemLinkDelete API
- 1.11.414 storageSystemLinkDisconnect API
- 1.11.415 storageSystemLinkEnum API
- 1.11.416 storageSystemLinkEstablish API
- 1.11.417 storageSystemLinkGet API
- 1.11.418 storageSystemLinkModify API
- 1.11.419 storageSystemLinkRefresh API
- 1.11.420 storageSystemLinkSetCredentials API
- 1.11.421 storageSystemLinkVerify API
- 1.11.422 storageSystemModify API
- 1.11.423 storageSystemRecover API
- 1.11.424 storageSystemRecoveryPointEnum API
- 1.11.425 storageSystemRestart API
- 1.11.426 storageSystemSendLogs API
- 1.11.427 storageSystemServicesRestart API
- 1.11.428 storageSystemShutdown API
- 1.11.429 storageSystemUpdateCheck API
- 1.11.430 storageSystemUpgrade API
- 1.11.431 storageTierAssocEnum API
- 1.11.432 storageTierAssocGet API
- 1.11.433 storageTierCreate API
- 1.11.434 storageTierDelete API
- 1.11.435 storageTierEnum API
- 1.11.436 storageTierGet API
- 1.11.437 storageTierModify API
- 1.11.438 storageTierPoolAddRemove API
- 1.11.439 storageVolumeAclAddRemove API
- 1.11.440 storageVolumeAclAddRemoveEx API
- 1.11.441 storageVolumeAclEnum API
- 1.11.442 storageVolumeAclGet API
- 1.11.443 storageVolumeClone API
- 1.11.444 storageVolumeCloudBackupCreate API
- 1.11.445 storageVolumeCloudBackupRestore API
- 1.11.446 storageVolumeCreate API
- 1.11.447 storageVolumeCreateEx API
- 1.11.448 storageVolumeDelete API
- 1.11.449 storageVolumeDeleteEx API
- 1.11.450 storageVolumeEnum API
- 1.11.451 storageVolumeGet API
- 1.11.452 storageVolumeGroupAssocEnum API
- 1.11.453 storageVolumeGroupAssocGet API
- 1.11.454 storageVolumeGroupClone API
- 1.11.455 storageVolumeGroupCreate API
- 1.11.456 storageVolumeGroupDelete API
- 1.11.457 storageVolumeGroupEnum API
- 1.11.458 storageVolumeGroupGet API
- 1.11.459 storageVolumeGroupModify API
- 1.11.460 storageVolumeGroupSnapshot API
- 1.11.461 storageVolumeGroupVolumeAddRemove API
- 1.11.462 storageVolumeImport API
- 1.11.463 storageVolumeModify API
- 1.11.464 storageVolumeResize API
- 1.11.465 storageVolumeRestore API
- 1.11.466 storageVolumeRollback API
- 1.11.467 storageVolumeSnapshot API
- 1.11.468 storageVolumeUtilizationEnum API
- 1.11.469 storageVolumeUtilizationGet API
- 1.11.470 storageVolumeUtilizationGetRetentionPeriod API
- 1.11.471 storageVolumeUtilizationSetRetentionPeriod API
- 1.11.472 targetPortDisable API
- 1.11.473 targetPortEnable API
- 1.11.474 targetPortEnum API
- 1.11.475 targetPortGet API
- 1.11.476 targetPortModify API
- 1.11.477 targetPortRescan API
- 1.11.478 targetPortRestart API
- 1.11.479 targetVirtualInterfaceCreate API
- 1.11.480 targetVirtualInterfaceMove API
- 1.11.481 targetVirtualPortCreate API
- 1.11.482 targetVirtualPortDelete API
- 1.11.483 targetVlanInterfaceCreate API
- 1.11.484 taskCancel API
- 1.11.485 taskClearAll API
- 1.11.486 taskEnum API
- 1.11.487 taskGet API
- 1.11.488 taskUpdateProgress API
- 1.11.489 traceLevelGet API
- 1.11.490 traceLevelModify API
- 1.11.491 userAdd API
- 1.11.492 userEnum API
- 1.11.493 userGet API
- 1.11.494 userGroupAssocEnum API
- 1.11.495 userGroupAssocGet API
- 1.11.496 userGroupCreate API
- 1.11.497 userGroupDelete API
- 1.11.498 userGroupEnum API
- 1.11.499 userGroupGet API
- 1.11.500 userGroupModify API
- 1.11.501 userGroupUserAddRemove API
- 1.11.502 userModify API
- 1.11.503 userPasswordSet API
- 1.11.504 userRemove API
- 1.11.505 virtualInterfaceAssocEnum API
- 1.11.506 virtualInterfaceAssocGet API
- 1.11.507 widgetCreate API
- 1.12 Enumeration Types
aclAdd API
Enables access to the specific volume for a specific user.
Argument List
ownerId: <string> ownerType: <unsignedInt> objectId: <string> objectType: <unsignedInt> accessLevel: <unsignedInt> flags: <unsignedInt>
aclModify API
Modifies the current acl assignment.
Argument List
ownerId: <string> ownerType: <unsignedInt> objectId: <string> objectType: <unsignedInt> accessLevel: <unsignedInt> flags: <unsignedInt>
aclRemove API
Removes the acl assignment.
Argument List
ownerId: <string> ownerType: <unsignedInt> objectId: <string> objectType: <unsignedInt> flags: <unsignedInt>
activeDirectoryUserAndGroupEnum API
Argument List
storageSystemId: <string> networkShareId: <string> groupFilter: <string> userFilter: <string> refreshCache: <boolean> flags: <unsignedInt>
alertClear API
Deletes the alert with the specified ID.
Argument List
id: <string> flags: <unsignedInt>
alertClearAll API
Clears all the alerts.
Argument List
flags: <unsignedInt>
alertConfigGet API
Alert configuration settings indicate where alert notifications should be sent.
Argument List
flags: <unsignedInt>
alertConfigSet API
Sets the alert configuration settings such as the administrator email address.
Argument List
senderEmailAddress: <string> smtpServerIpAddress: <string> smtpUsername: <string> smtpPassword: <string> smtpAuthType: <unsignedInt> customerSupportEmailAddress: <string> poolFreeSpaceWarningThreshold: <unsignedInt> poolFreeSpaceAlertThreshold: <unsignedInt> poolFreeSpaceCriticalAlertThreshold: <unsignedInt> pagerDutyServiceKey: <string> flags: <unsignedInt>
alertEnum API
Returns a list of all the alerts.
Argument List
flags: <unsignedInt>
alertGet API
Gets information about a specific alert.
Argument List
id: <string> flags: <unsignedInt>
alertRaise API
Allows one to raise a user generated alert for testing the SMTP server configuration settings.
Argument List
message: <string> severity: <unsignedInt> flags: <unsignedInt>
auditLogClear API
Clears the audit log.
Argument List
flags: <unsignedInt>
auditLogDisable API
Disables the audit log
Argument List
flags: <unsignedInt>
auditLogEnable API
Enables the audit log.
Argument List
flags: <unsignedInt>
auditLogGet API
Get an entry from the audit log.
Argument List
user: <string> startDate: <dateTime> endDate: <dateTime> flags: <unsignedInt>
backupJobCancel API
Argument List
backupJob: <string> flags: <unsignedInt>
backupJobEnum API
Argument List
flags: <unsignedInt>
backupJobGet API
Argument List
backupJob: <string> flags: <unsignedInt>
backupJobStart API
Argument List
backupPolicy: <string> flags: <unsignedInt>
backupJobStatusUpdate API
Argument List
statusXml: <string> flags: <unsignedInt>
backupPolicyCreate API
Argument List
name: <string> description: <string> networkShareId: <string> remoteHostname: <string> remoteExportPath: <string> remoteMountType: <unsignedInt> daysOfWeek: <unsignedInt> hoursOfDay: <unsignedInt> retentionCriteria: <unsignedInt> startDate: <dateTime> policyType: <unsignedInt> scanThreads: <unsignedInt> retentionDays: <unsignedInt> purgePolicy: <unsignedInt> createBackupLogs: <boolean> backupToShareRoot: <boolean> setEnabled: <boolean> scheduleType: <unsignedInt> delayInterval: <unsignedInt> flags: <unsignedInt>
backupPolicyDelete API
Argument List
backupPolicy: <string> flags: <unsignedInt>
backupPolicyDisable API
Argument List
backupPolicy: <string> flags: <unsignedInt>
backupPolicyEnable API
Argument List
backupPolicy: <string> flags: <unsignedInt>
backupPolicyEnum API
Argument List
flags: <unsignedInt>
backupPolicyGet API
Argument List
backupPolicy: <string> flags: <unsignedInt>
backupPolicyModify API
Argument List
backupPolicy: <string> name: <string> description: <string> networkShareId: <string> remoteHostname: <string> remoteExportPath: <string> remoteMountType: <unsignedInt> daysOfWeek: <unsignedInt> hoursOfDay: <unsignedInt> retentionCriteria: <unsignedInt> startDate: <dateTime> policyType: <unsignedInt> scanThreads: <unsignedInt> retentionDays: <unsignedInt> purgePolicy: <unsignedInt> createBackupLogs: <boolean> backupToShareRoot: <boolean> setEnabled: <boolean> scheduleType: <unsignedInt> delayInterval: <unsignedInt> flags: <unsignedInt>
backupPolicyTrigger API
Argument List
backupPolicy: <string> flags: <unsignedInt>
cephBlockDeviceCreate API
Argument List
name: <string> description: <string> cephPoolId: <string> size: <unsignedLong> flags: <unsignedInt>
cephBlockDeviceDelete API
Argument List
cephBlockDevice: <string> flags: <unsignedInt>
cephBlockDeviceEnum API
Argument List
flags: <unsignedInt>
cephBlockDeviceGet API
Argument List
cephBlockDevice: <string> flags: <unsignedInt>
cephBlockDeviceModify API
Argument List
cephBlockDevice: <string> name: <string> description: <string> flags: <unsignedInt>
cephBlockDeviceResize API
Argument List
cephBlockDevice: <string> size: <unsignedLong> flags: <unsignedInt>
cephBlockDeviceSnapshot API
Argument List
cephBlockDevice: <string> snapshotName: <string> snapshotDescription: <string> flags: <unsignedInt>
cephClusterEnum API
Argument List
flags: <unsignedInt>
cephClusterGet API
Argument List
cephCluster: <string> flags: <unsignedInt>
cephHaFailoverInterfaceEnum API
Argument List
flags: <unsignedInt>
cephHaFailoverInterfaceGet API
Argument List
cephPoolId: <string> failoverInterfaceId: <string> flags: <unsignedInt>
cephMonitorEnum API
Argument List
flags: <unsignedInt>
cephMonitorGet API
Argument List
cephMonitor: <string> flags: <unsignedInt>
cephOsdCreate API
Argument List
name: <string> description: <string> cephClusterId: <string> storagePoolId: <string> weight: <unsignedInt> flags: <unsignedInt>
cephOsdDelete API
Argument List
cephOsd: <string> deleteData: <boolean> flags: <unsignedInt>
cephOsdEnum API
Argument List
flags: <unsignedInt>
cephOsdGet API
Argument List
cephOsd: <string> flags: <unsignedInt>
cephPoolCreate API
Argument List
name: <string> description: <string> placementGroupCount: <unsignedInt> maxReplicaCount: <unsignedInt> minReplicaCount: <unsignedInt> cephPoolType: <string> storagePoolList: <string[]> flags: <unsignedInt>
cephPoolDelete API
Argument List
cephPool: <string> flags: <unsignedInt>
cephPoolEnum API
Argument List
flags: <unsignedInt>
cephPoolGet API
Argument List
cephPool: <string> flags: <unsignedInt>
cephPoolModify API
Argument List
cephPool: <string> name: <string> description: <string> flags: <unsignedInt>
cephPoolOsdAssocEnum API
Argument List
cephPool: <string> flags: <unsignedInt>
cephPoolOsdAssocGet API
Argument List
cephPool: <string> cephOsd: <string> flags: <unsignedInt>
cloudBackupScheduleAssocEnum API
List the cloud backup schedule associations.
Argument List
schedule: <string> flags: <unsignedInt>
cloudBackupScheduleAssocGet API
Get a cloud backup schedule association.
Argument List
scheduleId: <string> storageVolumeId: <string>
cloudBackupScheduleCreate API
Creates a new schedule to automate backups to a cloud backup container.
Argument List
name: <string> description: <string> cloudContainerId: <string> priority: <unsignedInt> setEnabled: <unsignedInt> startDate: <dateTime> maxBackups: <unsignedInt> daysOfWeek: <unsignedInt> hoursOfDay: <unsignedInt> storageVolumeList: <string[]> scheduleType: <unsignedInt> delayInterval: <unsignedInt> flags: <unsignedInt>
cloudBackupScheduleDelete API
Deletes the specified cloud backup schedule.
Argument List
schedule: <string> flags: <unsignedInt>
cloudBackupScheduleDisable API
Disables a cloud backup schedule so that it does not trigger backups.
Argument List
schedule: <string> flags: <unsignedInt>
cloudBackupScheduleEnable API
Enables a cloud backup schedule that was previously disabled.
Argument List
schedule: <string> flags: <unsignedInt>
cloudBackupScheduleEnum API
Lists all the cloud backup schedules in the system.
Argument List
flags: <unsignedInt>
cloudBackupScheduleGet API
Gets detailed information about a specific cloud backup schedule.
Argument List
schedule: <string> flags: <unsignedInt>
cloudBackupScheduleModify API
Modifies the settings for the specified cloud backup schedule.
Argument List
schedule: <string> name: <string> description: <string> cloudContainerId: <string> setEnabled: <unsignedInt> startDate: <dateTime> maxBackups: <unsignedInt> daysOfWeek: <unsignedInt> hoursOfDay: <unsignedInt> scheduleType: <unsignedInt> delayInterval: <unsignedInt> flags: <unsignedInt>
cloudBackupScheduleTrigger API
Argument List
schedule: <string> flags: <unsignedInt>
cloudBackupScheduleVolumeAddRemove API
Add/Remove storage volumes to an existing cloud backup schedule.
Argument List
schedule: <string> modType: <unsignedInt> storageVolumeList: <string[]> flags: <unsignedInt>
cloudContainerAdd API
Recovers a cloud backup container that was previously removed or used with a prior installation.
Argument List
credentialsId: <string> locationId: <string> encryptionKey: <string> storageUrl: <string> enableNfs: <boolean> flags: <unsignedInt>
cloudContainerCreate API
Creates a cloud backup container into which cloud backups of storage volumes can be made.
Argument List
name: <string> description: <string> credentialsId: <string> locationId: <string> encryptionKey: <string> storageUrl: <string> enableNfs: <boolean> attachToStorageSystem: <string> flags: <unsignedInt>
cloudContainerDelete API
Deletes the specified cloud backup container. WARNING, all data in the container will be destroyed.
Argument List
container: <string> flags: <unsignedInt>
cloudContainerDisable API
Disables access to the specified cloud container without having to remove it.
Argument List
container: <string> flags: <unsignedInt>
cloudContainerEnable API
Enables a cloud container that was previously disabled or was inaccessible due to network connection issues.
Argument List
container: <string> attachToStorageSystem: <string> flags: <unsignedInt>
cloudContainerEnum API
Returns a list of cloud backup containers in the system.
Argument List
flags: <unsignedInt>
cloudContainerGet API
Returns detailed information on a specific cloud backup container.
Argument List
container: <string> flags: <unsignedInt>
cloudContainerModify API
Modifies the specified cloud backup container settings.
Argument List
container: <string> name: <string> description: <string> encryptionKey: <string> enableNfs: <boolean> flags: <unsignedInt>
cloudContainerRemove API
Removes the specified cloud backup container from the system but does not delete any backup data in the cloud.
Argument List
container: <string> flags: <unsignedInt>
cloudContainerRepair API
Repairs the specified cloud backup container.
Argument List
container: <string> flags: <unsignedInt>
cloudProviderCredentialsAdd API
Adds cloud provider credentials to enable cloud backup to cloud backup containers.
Argument List
username: <string> password: <string> providerId: <string> machine: <string> flags: <unsignedInt>
cloudProviderCredentialsEnum API
Returns a list of all the cloud provider credentials in the system. Passwords are masked.
Argument List
flags: <unsignedInt>
cloudProviderCredentialsGet API
Returns information about the specified cloud provider credential.
Argument List
credentialId: <string> flags: <unsignedInt>
cloudProviderCredentialsRemove API
Removes the specified cloud provider credentials
Argument List
credentialsId: <string> flags: <unsignedInt>
cloudProviderEnum API
Returns the list of supported cloud providers.
Argument List
flags: <unsignedInt>
cloudProviderGet API
Returns detailed information about the specified cloud provider.
Argument List
providerId: <string> flags: <unsignedInt>
cloudProviderLocationAdd API
Argument List
providerId: <string> locationTag: <string> flags: <unsignedInt>
cloudProviderLocationEnum API
Argument List
flags: <unsignedInt>
cloudProviderLocationGet API
Argument List
locationId: <string> flags: <unsignedInt>
cloudProviderLocationRemove API
Argument List
locationId: <string> flags: <unsignedInt>
clusterFailoverGroupActivate API
Activate the cluster fail over group.
Argument List
clusterFailoverGroup: <string> storageSystemId: <string> flags: <unsignedInt>
clusterFailoverGroupCreate API
Creates a new management grid. A given storage system can only be a member of one grid at a time.
Argument List
storageSystemCluster: <string> name: <string> description: <string> storagePool: <string> zoneConfig: <string> flags: <unsignedInt>
clusterFailoverGroupDelete API
Deletes the management grid. After the grid is deleted each node in the grid operates independently again.
Argument List
clusterFailoverGroup: <string> flags: <unsignedInt>
clusterFailoverGroupEnum API
Returns a list of all the managed storage system nodes in the grid.
Argument List
flags: <unsignedInt>
clusterFailoverGroupGet API
Get general information about the storage system management grid.
Argument List
clusterFailoverGroup: <string> flags: <unsignedInt>
clusterFailoverGroupModify API
Modify the management grid properties.
Argument List
clusterFailoverGroup: <string> name: <string> description: <string> storagePool: <string> zoneConfig: <string> flags: <unsignedInt>
customApi API
Argument List
method: <string> params: <keyValuePair[]> flags: <unsignedInt>
echo API
Test method which pings the server with a simple string
Argument List
inputMessage: <string>
eventEnum API
Returns a list of all the internal events in the event queue (used for service monitoring).
Argument List
startingIndex: <unsignedInt> maxEvents: <unsignedInt> serviceTimeStamp: <dateTime>
eventListenerNotify API
Argument List
storageSystemId: <string> list: <event[]>
eventListenerRegister API
Argument List
eventListenerObj: <eventListener>
eventListenerUnregister API
Argument List
listenerId: <string>
fcTargetPortDisable API
Disables the specified fiber channel port.
Argument List
port: <string> flags: <unsignedInt>
fcTargetPortEnable API
Enables the specified fiber channel port.
Argument List
port: <string> flags: <unsignedInt>
fcTargetPortEnum API
Returns a list of all the fiber channel target ports in the system.
Argument List
flags: <unsignedInt>
fcTargetPortGet API
Returns information about the specified fiber channel target port.
Argument List
port: <string> flags: <unsignedInt>
getHardwareConfig API
Argument List
flags: <unsignedInt>
getLocalizedMessage API
Argument List
locale: <string> i18nStr: <i18nString> flags: <unsignedInt>
getSecurityConfig API
Gets the complete security profile for the service.
Argument List
storageSystemId: <string> flags: <unsignedInt>
getSystemConfig API
Gets the storage systems configuration.
Argument List
storageSystemId: <string> flags: <unsignedInt>
glusterBrickCreate API
Argument List
glusterVolume: <string> storagePool: <string> flags: <unsignedInt>
glusterBrickDelete API
Argument List
glusterBrick: <string> deleteData: <boolean> flags: <unsignedInt>
glusterBrickEnum API
Argument List
flags: <unsignedInt>
glusterBrickGet API
Argument List
glusterBrick: <string> flags: <unsignedInt>
glusterHaFailoverInterfaceCreate API
Argument List
glusterVolumeId: <string> primaryStorageSystemId: <string> secondaryStorageSystemId: <string> failoverPolicy: <unsignedInt> tag: <string> parentInterfaceName: <string> description: <string> ipAddress: <string> gateway: <string> subnetMask: <string> macAddress: <string> flags: <unsignedInt>
glusterHaFailoverInterfaceDelete API
Argument List
glusterVolumeId: <string> failoverInterfaceId: <string> flags: <unsignedInt>
glusterHaFailoverInterfaceEnum API
Argument List
flags: <unsignedInt>
glusterHaFailoverInterfaceGet API
Argument List
glusterVolumeId: <string> failoverInterfaceId: <string> flags: <unsignedInt>
glusterHaFailoverInterfaceMove API
Argument List
glusterVolumeId: <string> failoverInterfaceId: <string> moveToStorageSystemId: <string> flags: <unsignedInt>
glusterPeerDetach API
Argument List
glusterPeer: <string> flags: <unsignedInt>
glusterPeerEnum API
Argument List
flags: <unsignedInt>
glusterPeerGet API
Argument List
glusterPeer: <string> flags: <unsignedInt>
glusterPeerProbe API
Argument List
storageSystem: <string> hostname: <string> flags: <unsignedInt>
glusterServiceRestart API
Argument List
storageSystem: <string> flags: <unsignedInt>
glusterVolumeAddBricks API
Argument List
glusterVolume: <string> storagePoolList: <string[]> restripeVolume: <boolean> flags: <unsignedInt>
glusterVolumeCreate API
Argument List
name: <string> description: <string> storagePoolList: <string[]> replicaCount: <unsignedInt> stripeVolume: <boolean> flags: <unsignedInt>
glusterVolumeDelete API
Argument List
glusterVolume: <string> flags: <unsignedInt>
glusterVolumeEnum API
Argument List
flags: <unsignedInt>
glusterVolumeGet API
Argument List
glusterVolume: <string> flags: <unsignedInt>
glusterVolumeModify API
Argument List
glusterVolume: <string> name: <string> description: <string> flags: <unsignedInt>
glusterVolumeRebalance API
Argument List
glusterVolume: <string> option: <unsignedInt> flags: <unsignedInt>
glusterVolumeReplaceBrick API
Argument List
glusterVolume: <string> oldBrick: <string> newBrick: <string> flags: <unsignedInt>
glusterVolumeStart API
Argument List
glusterVolume: <string> flags: <unsignedInt>
glusterVolumeStop API
Argument List
glusterVolume: <string> flags: <unsignedInt>
hostAdd API
Adds the specified host.
Argument List
hostname: <string> ipAddress: <string> username: <string> password: <string> hostType: <unsignedInt> description: <string> iqn: <string> flags: <unsignedInt>
hostEnum API
Returns a list of all the hosts.
Argument List
flags: <unsignedInt>
hostGet API
Gets information about a specific host.
Argument List
host: <string> flags: <unsignedInt>
hostGroupCreate API
Creates a new host group with the specified name.
Argument List
name: <string> description: <string> hostList: <string[]> flags: <unsignedInt>
hostGroupDelete API
Removes the specified host group.
Argument List
host: <string> deleteAssociatedHosts: <boolean> flags: <unsignedInt>
hostGroupEnum API
Returns a list of all the host groups.
Argument List
flags: <unsignedInt>
hostGroupGet API
Gets information about a specific host group.
Argument List
hostGroup: <string> flags: <unsignedInt>
hostGroupHostAddRemove API
Adds/Removes a host to the specified host group.
Argument List
hostGroup: <string> modType: <unsignedInt> hostList: <string[]> flags: <unsignedInt>
hostGroupModify API
Modifies the properties of a host group such as its name and/or description.
Argument List
hostGroup: <string> newName: <string> newDescription: <string> flags: <unsignedInt>
hostInitiatorAdd API
Adds an additional iSCSI host initiator IQN to the specified host.
Argument List
host: <string> iqn: <string> flags: <unsignedInt>
hostInitiatorEnum API
Returns a list of all the initiators (IQN) of the specified host.
Argument List
host: <string> flags: <unsignedInt>
hostInitiatorGet API
Gets information about a specific host identified by its initiator IQN.
Argument List
initiator: <string> flags: <unsignedInt>
hostInitiatorRemove API
Removes a iSCSI host initiator (IQN) from the specified host.
Argument List
host: <string> iqn: <string> flags: <unsignedInt>
hostModify API
Modifies a host.
Argument List
host: <string> newIpAddress: <string> newUsername: <string> newPassword: <string> newHostType: <unsignedInt> newDescription: <string> flags: <unsignedInt>
hostRemove API
Removes the specified host, *WARNING* host's active iSCSI sessions will be dropped.
Argument List
host: <string> flags: <unsignedInt>
hwAlarmEnum API
Returns a list of all the current hardware alarms/alert messages generated from the controller.
Argument List
hwController: <string> flags: <unsignedInt>
hwAlarmGet API
Returns information about a specific hardware alarm.
Argument List
hwAlarm: <string> flags: <unsignedInt>
hwBatteryBackupUnitEnum API
Enumerates the battery backup information for the specified controller.
Argument List
hwController: <string> flags: <unsignedInt>
hwBatteryBackupUnitGet API
Gets the battery backup unit information for the specified battery backup unit.
Argument List
hwBatteryBackupUnit: <string> flags: <unsignedInt>
hwControllerChangeSecurityKey API
Argument List
controllerId: <string> oldSecurityKey: <string> newSecurityKey: <string> flags: <unsignedInt>
hwControllerClearAlarms API
Clears all the hardware alarms that have been recorded for the specified hardware RAID controller.
Argument List
controllerId: <string> flags: <unsignedInt>
hwControllerCreateSecurityKey API
Argument List
controllerId: <string> securityKey: <string> flags: <unsignedInt>
hwControllerEnum API
Returns a list of all the hardware controllers.
Argument List
hwControllerGroup: <string> flags: <unsignedInt>
hwControllerGet API
Returns information about a specific hardware RAID controller.
Argument List
hwController: <string> flags: <unsignedInt>
hwControllerGroupEnum API
Returns a list of all the hardware controller groups.
Argument List
flags: <unsignedInt>
hwControllerGroupGet API
Returns information about all the support hardware RAID controller group types.
Argument List
hwControllerGroup: <string> flags: <unsignedInt>
hwControllerImportForeignUnits API
Argument List
controllerId: <string> flags: <unsignedInt>
hwControllerModify API
Argument List
controllerId: <string> altName: <string> description: <string> flags: <unsignedInt>
hwControllerRescan API
Rescans the hardware controller to look for new disks and RAID units.
Argument List
controllerId: <string> flags: <unsignedInt>
hwControllerRescanAll API
Rescans all of the hardware controllers to look for new disks and RAID units.
Argument List
storageSystemId: <string> flags: <unsignedInt>
hwControllerSilenceAlarms API
Silences the alarms for specified hardware controller.
Argument List
controllerId: <string> flags: <unsignedInt>
hwDiskEnum API
Returns a list of all the disks managed by the specified hardware controller.
Argument List
hwController: <string> flags: <unsignedInt>
hwDiskGet API
Returns information about a specific disk managed by a hardware RAID controller.
Argument List
hwDisk: <string> flags: <unsignedInt>
hwDiskIdentify API
Flashes the LED indicator light on the specified disk so that it can be identified in the enclosure chassis.
Argument List
diskId: <string> durationInSeconds: <unsignedInt> flags: <unsignedInt>
hwDiskMarkGood API
Argument List
diskId: <string> flags: <unsignedInt>
hwDiskMarkHotSpare API
Marks the specified disk as a universal hot spare within the group of RAID units managed by the controller in which the disk is attached.
Argument List
diskId: <string> clearMark: <boolean> flags: <unsignedInt>
hwDiskModify API
Argument List
diskId: <string> altName: <string> description: <string> flags: <unsignedInt>
hwDiskRemove API
Marks the disk as removable (safe way to swap the drives).
Argument List
diskId: <string> flags: <unsignedInt>
hwEnclosureEnum API
Returns a list of all the enclosures managed by the specified hardware RAID controller.
Argument List
hwController: <string> flags: <unsignedInt>
hwEnclosureGet API
Returns information about a specific enclosure managed by the specified hardware RAID controller.
Argument List
hwEnclosure: <string> flags: <unsignedInt>
hwEnclosureLayoutEnum API
Argument List
flags: <unsignedInt>
hwEnclosureLayoutGet API
Argument List
hwEnclosureLayout: <string> flags: <unsignedInt>
hwEnclosureModify API
Argument List
diskId: <string> altName: <string> description: <string> enclosureLayout: <string> flags: <unsignedInt>
hwLogicalDriveEnum API
Argument List
hwUnit: <string> flags: <unsignedInt>
hwLogicalDriveGet API
Argument List
hwLogicalDrive: <string> flags: <unsignedInt>
hwSwitchAdapterEnum API
Returns a list of all the storage switch management adapters.
Argument List
flags: <unsignedInt>
hwSwitchAdapterGet API
Returns information about the specified HW switch management module.
Argument List
switchAdapterId: <string> flags: <unsignedInt>
hwSwitchCredentialsAdd API
Adds storage switch login credentials for a specific switch management adapter.
Argument List
username: <string> password: <string> domainPassword: <string> ipAddress: <string> managementProtocol: <unsignedInt> switchType: <unsignedInt> switchAdapterId: <string> primaryStorageSystem: <string> secondaryStorageSystem: <string> flags: <unsignedInt>
hwSwitchCredentialsEnum API
Returns a list of all the storage switch login credentials.
Argument List
switchAdapterId: <string> flags: <unsignedInt>
hwSwitchCredentialsGet API
Returns information about specific storage switch login credentials.
Argument List
switchCredentials: <string> flags: <unsignedInt>
hwSwitchCredentialsModify API
Modifies the switch login credentials.
Argument List
credentialsId: <string> password: <string> domainPassword: <string> primaryStorageSystem: <string> secondaryStorageSystem: <string> flags: <unsignedInt>
hwSwitchCredentialsRemove API
Removes storage switch login credentials.
Argument List
credsId: <string> flags: <unsignedInt>
hwSwitchEnum API
Returns a list of all the discovered storage switches.
Argument List
switchAdapterId: <string> flags: <unsignedInt>
hwSwitchFailoverGroupActivate API
Activates the pools in a switch failover group on the specified storage system.
Argument List
hwSwitchFailoverGroup: <string> storageSystemId: <string> flags: <unsignedInt>
hwSwitchFailoverGroupCreate API
Creates a new switch failover group.
Argument List
name: <string> description: <string> virtualHostIpAddress: <string> virtualHostSubnet: <string> virtualHostGateway: <string> storagePoolList: <string[]> primaryStorageSystemId: <string> primaryZonesetId: <string> secondaryStorageSystemId: <string> secondaryZonesetId: <string> flags: <unsignedInt>
hwSwitchFailoverGroupDelete API
Deletes a failover group.
Argument List
hwSwitchFailoverGroup: <string> flags: <unsignedInt>
hwSwitchFailoverGroupEnum API
Returns a list of all the switch failover groups.
Argument List
flags: <unsignedInt>
hwSwitchFailoverGroupGet API
Returns information about a specific switch failover group.
Argument List
hwSwitchFailoverGroupId: <string> flags: <unsignedInt>
hwSwitchFailoverGroupModify API
Modifies the properties of a failover group.
Argument List
hwSwitchFailoverGroup: <string> name: <string> description: <string> virtualHostIpAddress: <string> virtualHostSubnet: <string> virtualHostGateway: <string> storagePoolList: <string[]> primaryStorageSystemId: <string> primaryZonesetId: <string> secondaryStorageSystemId: <string> secondaryZonesetId: <string> flags: <unsignedInt>
hwSwitchFailoverGroupPoolAssocEnum API
Argument List
hwSwitchFailoverGroup: <string> flags: <unsignedInt>
hwSwitchFailoverGroupPoolAssocGet API
Argument List
hwSwitchFailoverGroupId: <string> storagePoolId: <string> flags: <unsignedInt>
hwSwitchFailoverGroupSetMode API
Argument List
hwSwitchFailoverGroup: <string> failoverMode: <unsignedInt> flags: <unsignedInt>
hwSwitchFailoverGroupSystemAssocAdd API
Adds another storage system to which the failover group can failover to.
Argument List
hwSwitchFailoverGroup: <string> storageSystemId: <string> zonesetId: <string> flags: <unsignedInt>
hwSwitchFailoverGroupSystemAssocEnum API
Argument List
hwSwitchFailoverGroup: <string> flags: <unsignedInt>
hwSwitchFailoverGroupSystemAssocGet API
Argument List
hwSwitchFailoverGroupId: <string> storageSystemId: <string> flags: <unsignedInt>
hwSwitchFailoverGroupSystemAssocRemove API
Removes a storage system from the failover group.
Argument List
hwSwitchFailoverGroup: <string> storageSystemId: <string> flags: <unsignedInt>
hwSwitchGet API
Returns detailed information about a storage switch.
Argument List
switchId: <string> flags: <unsignedInt>
hwSwitchRescan API
Rescans the hardware switch.
Argument List
switchId: <string> flags: <unsignedInt>
hwSwitchZonesetActivate API
Activates a specific storage switch zonset.
Argument List
switchCredentialsId: <string> zonesetId: <string> flags: <unsignedInt>
hwSwitchZonesetEnum API
Returns a list of all the discovered zonesets.
Argument List
switchCredentialsId: <string> flags: <unsignedInt>
hwSwitchZonesetGet API
Returns information about a specific switch zoneset.
Argument List
switchZoneset: <string> flags: <unsignedInt>
hwUnitCreate API
Creates a new hardware RAID unit using the specified controller.
Argument List
controllerId: <string> raidType: <unsignedInt> legLength: <unsignedInt> blockSizeKb: <unsignedInt> diskList: <string[]> flags: <unsignedInt>
hwUnitDelete API
Deletes the specified RAID unit. Note that you must first delete the Storage Pool before you delete the RAID unit.
Argument List
unitId: <string> flags: <unsignedInt>
hwUnitDiskAssocEnum API
Argument List
hwUnit: <string> flags: <unsignedInt>
hwUnitDiskAssocGet API
Argument List
hwUnit: <string> hwDisk: <string> flags: <unsignedInt>
hwUnitEnableEncryption API
Argument List
unitId: <string> options: <unsignedInt> flags: <unsignedInt>
hwUnitEnum API
Returns a list of all the disks managed by the specified hardware controller.
Argument List
hwController: <string> flags: <unsignedInt>
hwUnitGet API
Returns information about a specific disk managed by a hardware RAID controller.
Argument List
hwUnit: <string> flags: <unsignedInt>
hwUnitGrow API
Grows the hardware unit by adding specified disks.
Argument List
unitId: <string> diskList: <string[]> stripeSizeKb: <unsignedInt> initPriority: <unsignedInt> flags: <unsignedInt>
hwUnitIdentify API
Flashes the LED indicator light on all the disks in the RAID unit so that it can be identified in the enclosure.
Argument List
unitId: <string> durationInSeconds: <unsignedInt> flags: <unsignedInt>
hwUnitModify API
Argument List
unitId: <string> altName: <string> description: <string> flags: <unsignedInt>
hwUnitSsdCacheCreate API
Argument List
controllerId: <string> raidType: <unsignedInt> ssdDiskList: <string[]> flags: <unsignedInt>
hwUnitSsdCacheDisable API
Argument List
unitId: <string> flags: <unsignedInt>
hwUnitSsdCacheEnable API
Argument List
unitId: <string> unitSsdCacheId: <string> flags: <unsignedInt>
ibTargetPortEnum API
Returns a list of all the infiniband ports in the system.
Argument List
flags: <unsignedInt>
ibTargetPortGet API
Returns information about the specified infiniband port.
Argument List
port: <string> flags: <unsignedInt>
libratoMetricsConfigGet API
Get the current username, token, and interval settings for Librato Metrics.
Argument List
storageSystem: <string> flags: <unsignedInt>
libratoMetricsConfigSet API
Set the username, token, and interval for Librato Metrics posting.
Argument List
storageSystem: <string> username: <string> token: <string> postIntervalSec: <unsignedInt> autoDashboardCreate: <boolean> enableAlertAnnotations: <boolean> enableConfigAnnotations: <boolean> flags: <unsignedInt>
licenseActivate API
Activates the system using a activation key received from customer support.
Argument List
activationKey: <string> flags: <unsignedInt>
licenseActivateOnline API
Requests automatic activation via the online activation service.
Argument List
licenseKey: <string> flags: <unsignedInt>
licenseAdd API
Adds a license key using a license key block.
Argument List
storageSystem: <string> keyBlock: <string> flags: <unsignedInt>
licenseEnum API
Returns a list of all the registered license keys.
Argument List
flags: <unsignedInt>
licenseGet API
Shows the current license key info, and any activation request code.
Argument List
license: <string> flags: <unsignedInt>
licenseRemove API
Removes the specified license key.
Argument List
license: <string> flags: <unsignedInt>
login API
Argument List
reserved: <string>
Argument List
networkShare: <string> flags: <unsignedInt>
Argument List
networkShareId: <string> key: <string> flags: <unsignedInt>
Adds a client for the specified network share.
Argument List
networkShareId: <string> clientFilter: <string> async: <boolean> secure: <boolean> subtreeCheck: <boolean> readOnly: <boolean> customOptions: <string> flags: <unsignedInt>
Returns a list of clients for the specified network share.
Argument List
networkShare: <string> flags: <unsignedInt>
Returns information about the specific network share client.
Argument List
networkShareId: <string> networkShareClientId: <string> flags: <unsignedInt>
Modifies a client for the specified network share.
Argument List
networkShareId: <string> networkShareClientId: <string> readOnly: <boolean> secure: <boolean> async: <boolean> subtreeCheck: <boolean> customOptions: <string> flags: <unsignedInt>
Removes a client for the specified network share.
Argument List
networkShareId: <string> networkShareClientId: <string> flags: <unsignedInt>
Clones the specified network share.
Argument List
networkShare: <string> cloneName: <string> description: <string> provisionableId: <string> readOnly: <boolean> isActive: <boolean> flags: <unsignedInt>
Creates a new NFSv3 network share.
Argument List
name: <string> description: <string> provisionableId: <string> isPublic: <boolean> isActive: <boolean> flags: <unsignedInt>
Argument List
name: <string> description: <string> provisionableId: <string> isPublic: <boolean> isActive: <boolean> enableCifs: <boolean> userAccessList: <string[]> cifsOptions: <string[]> disableSnapBrowsing: <boolean> spaceQuota: <unsignedLong> flags: <unsignedInt>
Deletes the specified network share.
Argument List
networkShareId: <string> flags: <unsignedInt>
Argument List
networkShareList: <string[]> flags: <unsignedInt>
Disables the specified network share.
Argument List
networkShare: <string> flags: <unsignedInt>
Enables the specified network share.
Argument List
networkShare: <string> flags: <unsignedInt>
Returns a list of all the network shares in the system.
Argument List
flags: <unsignedInt>
Argument List
networkShare: <string> flags: <unsignedInt>
Returns information about the specified network share.
Argument List
networkShare: <string> flags: <unsignedInt>
Argument List
storageSystemId: <string> domain: <string> realm: <string> kdc: <string> domainAdmin: <string> password: <string> flags: <unsignedInt>
Argument List
storageSystemId: <string> domainAdmin: <string> password: <string> flags: <unsignedInt>
Modifies a client for the specified network share.
Argument List
networkShare: <string> name: <string> description: <string> isActive: <boolean> enableCifs: <boolean> userAccessList: <string[]> cifsOptions: <string[]> disableSnapBrowsing: <boolean> spaceQuota: <unsignedLong> syncPolicy: <unsignedInt> compressionType: <string> copies: <unsignedInt> flags: <unsignedInt>
Argument List
storageSystem: <string> nfsMode: <unsignedInt> enableKerberos: <boolean> defaultOptions: <string> reserved: <string> flags: <unsignedInt>
Restores the network share from a previous snapshot of the share.
Argument List
networkShare: <string> snapshotShare: <string> flags: <unsignedInt>
Argument List
networkShare: <string> snapshotShare: <string> flags: <unsignedInt>
Restarts the network share service.
Argument List
storageSystem: <string> restartNfs: <boolean> restartSamba: <boolean> flags: <unsignedInt>
Argument List
networkShare: <string> list: <networkShareQuota[]> flags: <unsignedInt>
Snapshots the specified network share.
Argument List
networkShare: <string> snapshotName: <string> description: <string> provisionableId: <string> readOnly: <boolean> isActive: <boolean> flags: <unsignedInt>
Argument List
networkShare: <string> flags: <unsignedInt>
Argument List
networkShareUserAccessId: <string> flags: <unsignedInt>
objectEnum API
Argument List
propKey: <string> propValue: <string> propType: <unsignedInt> flags: <unsignedInt>
objectGet API
Gets the object based on the id provided.
Argument List
id: <string> flags: <unsignedInt>
objectLock API
Locks the specified object.
Argument List
id: <string>
objectPropertyGet API
Gets the specified property on an object.
Argument List
objectId: <string> propKey: <string> flags: <unsignedInt>
objectPropertySet API
Sets the specified property on an object.
Argument List
objectId: <string> propKey: <string> propValue: <string> propType: <unsignedInt> flags: <unsignedInt>
objectUnlock API
Unlocks an object.
Argument List
id: <string>
permissionDefinitionEnum API
Argument List
flags: <unsignedInt>
physicalDiskDataMigration API
Argument List
physicalDriveId: <string> storageVolumeName: <string> provisionableId: <string> blockSizeKb: <unsignedInt> flags: <unsignedInt>
physicalDiskEnum API
Enumerates all physical disks.
Argument List
physicalDiskList: <string[]> flags: <unsignedInt>
physicalDiskGet API
Gets information about a specific physical disk.
Argument List
physicalDrive: <string> flags: <unsignedInt>
physicalDiskGlobalSpareAddRemove API
Argument List
physicalDriveList: <string[]> modType: <unsignedInt> flags: <unsignedInt>
physicalDiskGlobalSpareEnum API
Argument List
flags: <unsignedInt>
physicalDiskHotspareMarkerCleanup API
Argument List
flags: <unsignedInt>
physicalDiskHotspareMarkerEnum API
Argument List
flags: <unsignedInt>
physicalDiskHotspareMarkerGet API
Argument List
markerId: <string> flags: <unsignedInt>
physicalDiskIdentify API
Pulses the disk activity light so that the specified disk can be identified in the chassis.
Argument List
physicalDrive: <string> pattern: <string> duration: <unsignedInt> flags: <unsignedInt>
physicalDiskPathAssocEnum API
Argument List
multipathDiskId: <string> flags: <unsignedInt>
physicalDiskPathAssocGet API
Argument List
multipathDiskId: <string> physicalDiskId: <string> flags: <unsignedInt>
physicalDiskScan API
Scans for any new physical disks that may have been hot-plugged into the storage system.
Argument List
storageSystemId: <string> flags: <unsignedInt>
registerSecurityToken API
Argument List
token: <string> signedToken: <string> flags: <unsignedInt>
remoteNfsExportsEnum API
Argument List
networkShare: <string> nfsHostname: <string> backupPolicy: <string> flags: <unsignedInt>
remoteStoragePoolEnum API
Returns a list of all the remote storage pools.
Argument List
remoteStorageSystemId: <string> flags: <unsignedInt>
replicaAssocDelete API
Argument List
assocId: <string> deleteSourceReplicatable: <boolean> deleteTargetReplicatable: <boolean> deleteReplicaAssocHead: <boolean> flags: <unsignedInt>
replicaAssocEnum API
Argument List
replicatableId: <string> sourcesOnly: <boolean> targetsOnly: <boolean> flags: <unsignedInt>
replicaAssocGet API
Argument List
assocId: <string> flags: <unsignedInt>
replicaAssocUpdate API
Argument List
assocObj: <replicaAssoc> flags: <unsignedInt>
replicaCreate API
Argument List
replicatableId: <string> storageSystemLinkId: <string> replicaName: <string> replicaDescription: <string> targetStoragePoolId: <string> replicationPriority: <unsignedInt> smartSync: <boolean> forcePrimary: <boolean> reserved: <string> flags: <unsignedInt>
Argument List
sourceShare: <networkShare> sourceShareParent: <networkShare> replicaName: <string> replicaDescription: <string> targetStoragePoolId: <string> replicationPriority: <unsignedInt> smartSync: <boolean> forcePrimary: <boolean> reserved: <string> flags: <unsignedInt>
replicaCreateVolumeTarget API
Argument List
sourceVolume: <storageVolume> sourceVolumeParent: <storageVolume> replicaName: <string> replicaDescription: <string> targetStoragePoolId: <string> replicationPriority: <unsignedInt> smartSync: <boolean> forcePrimary: <boolean> reserved: <string> flags: <unsignedInt>
replicaRollback API
Argument List
assocId: <string> flags: <unsignedInt>
replicaStatusUpdate API
Argument List
replicationStatusXml: <string> flags: <unsignedInt>
replicaStop API
Argument List
assocId: <string> flags: <unsignedInt>
replicaSync API
Argument List
assocId: <string> flags: <unsignedInt>
replicationScheduleAddRemove API
Argument List
schedule: <string> modType: <unsignedInt> storageVolumeList: <string[]> networkShareList: <string[]> flags: <unsignedInt>
replicationScheduleAssocEnum API
Argument List
schedule: <string> flags: <unsignedInt>
replicationScheduleAssocGet API
Argument List
scheduleId: <string> replicatableId: <string>
replicationScheduleCreate API
Argument List
name: <string> description: <string> storageCloudId: <string> storageSystemLinkId: <string> targetStorageCloudId: <string> targetProvisionableId: <string> priority: <unsignedInt> setEnabled: <unsignedInt> startDate: <dateTime> maxReplicas: <unsignedInt> daysOfWeek: <unsignedInt> hoursOfDay: <unsignedInt> storageVolumeList: <string[]> networkShareList: <string[]> scheduleType: <unsignedInt> delayInterval: <unsignedInt> offsetMinutes: <unsignedInt> flags: <unsignedInt>
replicationScheduleDelete API
Argument List
schedule: <string> flags: <unsignedInt>
replicationScheduleDisable API
Argument List
schedule: <string> flags: <unsignedInt>
replicationScheduleEnable API
Argument List
schedule: <string> flags: <unsignedInt>
replicationScheduleEnum API
Argument List
flags: <unsignedInt>
replicationScheduleGet API
Argument List
schedule: <string> flags: <unsignedInt>
replicationScheduleModify API
Argument List
schedule: <string> name: <string> description: <string> storageCloudId: <string> setEnabled: <unsignedInt> startDate: <dateTime> maxReplicas: <unsignedInt> daysOfWeek: <unsignedInt> hoursOfDay: <unsignedInt> scheduleType: <unsignedInt> delayInterval: <unsignedInt> offsetMinutes: <unsignedInt> flags: <unsignedInt>
replicationScheduleTrigger API
Argument List
schedule: <string> flags: <unsignedInt>
roleCreate API
Adds a new role to the role based access control (RBAC) system.
Argument List
name: <string> description: <string> permissionList: <permissionAssignment[]> inheritsFrom: <string> flags: <unsignedInt>
roleDelete API
Removes the specified role identified by name or ID.
Argument List
role: <string> flags: <unsignedInt>
roleEnum API
Returns a list of all the defined roles the RBAC system.
Argument List
flags: <unsignedInt>
roleGet API
Gets information about the specified role.
Argument List
role: <string> flags: <unsignedInt>
roleModify API
Modifies the name and/or description of a role.
Argument List
role: <string> newName: <string> newDescription: <string> flags: <unsignedInt>
rolePermissionAssignmentEnum API
Lists all of the role permission assignments.
Argument List
roleId: <string> flags: <unsignedInt>
rolePermissionAssignmentGet API
Gets the specified role permission assignment.
Argument List
role: <string> objectType: <string> operation: <string> flags: <unsignedInt>
rolePermissionsAddRemove API
Adds/Removes one or more permissions and/or permission groups from the specified role.
Argument List
role: <string> modType: <unsignedInt> permissionList: <permissionAssignment[]> flags: <unsignedInt>
roleSubjectAssocEnum API
Argument List
role: <string> flags: <unsignedInt>
roleSubjectAssocGet API
Argument List
role: <string> subject: <string> flags: <unsignedInt>
sessionClose API
Forcibly closes the specified iSCSI session; generally not recommended, use acl-remove instead.
Argument List
sessionId: <string> flags: <unsignedInt>
sessionEnum API
Returns a list of all the active iSCSI sessions.
Argument List
host: <string> storageVolume: <string> flags: <unsignedInt>
sessionGet API
Returns detailed information on a specific iSCSI session.
Argument List
sessionId: <string> flags: <unsignedInt>
siteAssocEnum API
Argument List
flags: <unsignedInt>
siteAssocGet API
Argument List
siteId: <string> storageSystemId: <string> flags: <unsignedInt>
siteCreate API
Argument List
name: <string> description: <string> location: <string> storageSystemList: <string[]> flags: <unsignedInt>
siteDelete API
Argument List
site: <string> flags: <unsignedInt>
siteEnum API
Argument List
flags: <unsignedInt>
siteGet API
Argument List
site: <string> flags: <unsignedInt>
siteModify API
Argument List
siteId: <string> name: <string> description: <string> location: <string> flags: <unsignedInt>
siteStorageSystemAddRemove API
Argument List
site: <string> modType: <unsignedInt> storageSystemList: <string[]> flags: <unsignedInt>
snapshotScheduleAssocEnum API
Argument List
schedule: <string> flags: <unsignedInt>
snapshotScheduleAssocGet API
Argument List
scheduleId: <string> storageVolumeId: <string>
snapshotScheduleCreate API
Creates a new snapshot schedule comprised of the specified storage volumes.
Argument List
name: <string> description: <string> storageCloudId: <string> setEnabled: <unsignedInt> startDate: <dateTime> maxSnapshots: <unsignedInt> daysOfWeek: <unsignedInt> hoursOfDay: <unsignedInt> storageVolumeList: <string[]> networkShareList: <string[]> scheduleType: <unsignedInt> delayInterval: <unsignedInt> flags: <unsignedInt>
snapshotScheduleDelete API
Deletes a snapshot schedule, snapshots associated with the schedule are not removed.
Argument List
schedule: <string> flags: <unsignedInt>
snapshotScheduleDisable API
Disables the specified snapshot schedule.
Argument List
schedule: <string> flags: <unsignedInt>
snapshotScheduleEnable API
Enables the specified snapshot schedule.
Argument List
schedule: <string> flags: <unsignedInt>
snapshotScheduleEnum API
Returns a list of all the snapshot schedules.
Argument List
flags: <unsignedInt>
snapshotScheduleGet API
Returns information about a specific snapshot schedule.
Argument List
schedule: <string> flags: <unsignedInt>
snapshotScheduleModify API
Modifies the name, description or other properties of a snapshot schedule.
Argument List
schedule: <string> name: <string> description: <string> storageCloudId: <string> setEnabled: <unsignedInt> startDate: <dateTime> maxSnapshots: <unsignedInt> daysOfWeek: <unsignedInt> hoursOfDay: <unsignedInt> scheduleType: <unsignedInt> delayInterval: <unsignedInt> flags: <unsignedInt>
snapshotScheduleTrigger API
Argument List
schedule: <string> flags: <unsignedInt>
snapshotScheduleVolumeAddRemove API
Adds/Removes one or more volumes to the specified schedule.
Argument List
schedule: <string> modType: <unsignedInt> storageVolumeList: <string[]> networkShareList: <string[]> flags: <unsignedInt>
storageCloudCreate API
Creates a new storage cloud comprised of the specified users, resources and chap information.
Argument List
name: <string> description: <string> userList: <storageCloudSubjectAssoc[]> resourceList: <storageCloudResourceAssoc[]> parentStorageCloudId: <string> tier: <string> organization: <string> defaultChapUsername: <string> defaultChapPassword: <string> flags: <unsignedInt>
storageCloudDelete API
Deletes a storage cloud, the resources and users will not be deleted.
Argument List
storageCloud: <string> flags: <unsignedInt>
storageCloudEnum API
Returns a list of all the storage clouds.
Argument List
flags: <unsignedInt>
storageCloudGet API
Returns information of the specified storage clouds.
Argument List
storageCloud: <string> flags: <unsignedInt>
storageCloudModify API
Modify the name, description, parent storage cloud, tier, organization, and chap information of a storage cloud.
Argument List
storageCloud: <string> name: <string> description: <string> parentStorageCloudId: <string> tier: <string> organization: <string> defaultChapUsername: <string> defaultChapPassword: <string> flags: <unsignedInt>
storageCloudResourceAddRemove API
Add/Remove one or more resources to the specified storage cloud.
Argument List
storageCloud: <string> modType: <unsignedInt> resourceList: <storageCloudResourceAssoc[]> flags: <unsignedInt>
storageCloudResourceAssocEnum API
Returns a list of associated resources of the specified storage cloud.
Argument List
resource: <string> flags: <unsignedInt>
storageCloudResourceAssocGet API
Returns associated information of specified resource in the storage cloud.
Argument List
storageCloud: <string> resource: <string> flags: <unsignedInt>
storageCloudResourceSetMode API
Set the mode of a specified resource in the storage cloud.
Argument List
storageCloud: <string> resource: <string> accessMode: <unsignedInt> flags: <unsignedInt>
storageCloudSubjectAssocEnum API
Returns a list of associated storage clouds to the specified subject.
Argument List
subject: <string> flags: <unsignedInt>
storageCloudSubjectAssocGet API
Returns associated information of a specified subject for a storage cloud.
Argument List
storageCloud: <string> subject: <string> flags: <unsignedInt>
storageCloudUserAddRemove API
Add/Remove one or more users to the specified storage cloud.
Argument List
storageCloud: <string> modType: <unsignedInt> userList: <storageCloudSubjectAssoc[]> flags: <unsignedInt>
storagePoolCacheAddRemove API
Argument List
storagePool: <string> modType: <unsignedInt> readCacheDeviceList: <string[]> writeCacheDeviceList: <string[]> flags: <unsignedInt>
storagePoolCreate API
Creates a new storage pool from which storage volumes can be created.
Argument List
name: <string> physicalDiskList: <string[]> description: <string> raidType: <unsignedInt> poolType: <unsignedInt> isDefault: <boolean> enableSsd: <boolean> enableCompression: <boolean> noBarriers: <boolean> profile: <string> raidSetSize: <unsignedInt> flags: <unsignedInt>
storagePoolDestroy API
Deletes a storage pool, *WARNING* any data in the pool will be lost.
Argument List
storagePool: <string> flags: <unsignedInt>
storagePoolDeviceEnum API
Returns a list of all the storage pool devices.
Argument List
storagePoolId: <string> flags: <unsignedInt>
storagePoolDeviceGet API
Gets information about a specific storage pool device.
Argument List
storagePoolDevice: <string> flags: <unsignedInt>
storagePoolEnum API
Returns a list of all the storage pools.
Argument List
flags: <unsignedInt>
storagePoolExpand API
Expands a storage pool after the underlying hardware RAID unit has been grown underneath.
Argument List
storagePool: <string> flags: <unsignedInt>
storagePoolExport API
Deactivate and removes the storage pool from the storage system database so that it can be exported and used on another system.
Argument List
storagePool: <string> flags: <unsignedInt>
storagePoolGet API
Gets information about a specific storage pool.
Argument List
storagePool: <string> flags: <unsignedInt>
storagePoolGrow API
Grows the specified storage pool by adding an additional disk. You can only grow storage pools that are using the RAID5 or RAID6 layout.
Argument List
storagePool: <string> physicalDiskList: <string[]> raidType: <unsignedInt> flags: <unsignedInt>
storagePoolHaFailoverGroupActivate API
Argument List
failoverGroup: <string> flags: <unsignedInt>
storagePoolHaFailoverGroupCreate API
Argument List
name: <string> description: <string> storagePoolId: <string> primaryStorageSystemId: <string> secondaryStorageSystemId: <string> failoverModuleId: <string> settleTimeInSec: <unsignedInt> flags: <unsignedInt>
storagePoolHaFailoverGroupDeactivate API
Argument List
failoverGroup: <string> flags: <unsignedInt>
storagePoolHaFailoverGroupDelete API
Argument List
failoverGroup: <string> flags: <unsignedInt>
storagePoolHaFailoverGroupEnum API
Argument List
flags: <unsignedInt>
storagePoolHaFailoverGroupFailover API
Argument List
failoverGroup: <string> targetStorageSystem: <string> flags: <unsignedInt>
storagePoolHaFailoverGroupGet API
Argument List
failoverGroup: <string> flags: <unsignedInt>
storagePoolHaFailoverGroupModify API
Argument List
failoverGroup: <string> name: <string> description: <string> secondaryStorageSystemId: <string> failoverModuleId: <string> settleTimeInSec: <unsignedInt> flags: <unsignedInt>
storagePoolHaFailoverInterfaceCreate API
Argument List
failoverGroup: <string> tag: <string> parentInterfaceName: <string> description: <string> ipAddress: <string> gateway: <string> subnetMask: <string> macAddress: <string> iscsiEnabled: <boolean> flags: <unsignedInt>
storagePoolHaFailoverInterfaceDelete API
Argument List
failoverGroup: <string> failoverInterface: <string> flags: <unsignedInt>
storagePoolHaFailoverInterfaceEnum API
Argument List
flags: <unsignedInt>
storagePoolHaFailoverInterfaceGet API
Argument List
failoverGroup: <string> failoverInterface: <string> flags: <unsignedInt>
storagePoolHaFailoverModuleEnum API
Argument List
flags: <unsignedInt>
storagePoolHaFailoverModuleGet API
Argument List
failoverModule: <string> flags: <unsignedInt>
storagePoolIdentify API
Pulses the disk activity lights for all disks in the pool so they can be identified in the chassis.
Argument List
storagePool: <string> pattern: <string> duration: <unsignedInt> flags: <unsignedInt>
storagePoolModify API
Modifies the properties of the storage pool such as it's name and description.
Argument List
storagePool: <string> newName: <string> newDescription: <string> isDefault: <boolean> enableSsd: <boolean> enableCompression: <boolean> noBarriers: <boolean> profile: <string> syncPolicy: <unsignedInt> compressionType: <string> hotspareRepairPolicy: <unsignedInt> copies: <unsignedInt> flags: <unsignedInt>
storagePoolProfileEnum API
Returns a list of all the storage pool profiles.
Argument List
flags: <unsignedInt>
storagePoolProfileGet API
Gets information about a specific storage pool profile.
Argument List
storagePoolProfile: <string> flags: <unsignedInt>
storagePoolRescan API
Rescans the specified storage system for storage pools.
Argument List
storageSystem: <string> options: <string> flags: <unsignedInt>
storagePoolScrubStart API
Argument List
storagePool: <string> flags: <unsignedInt>
storagePoolScrubStop API
Argument List
storagePool: <string> flags: <unsignedInt>
storagePoolSpareAddRemove API
Adds/Removes a dedicated hot-spare to the specified storage pool.
Argument List
storagePool: <string> modType: <unsignedInt> physicalDiskList: <string[]> flags: <unsignedInt>
storagePoolStart API
Starts up a previously stopped storage pool.
Argument List
storagePool: <string> flags: <unsignedInt>
storagePoolStop API
Stops all volume activity to the pool and disables it for maintenance.
Argument List
storagePool: <string> flags: <unsignedInt>
storagePoolUpdateRedirect API
Argument List
storagePool: <string> flags: <unsignedInt>
storageQuotaCreate API
Creates a new storage quota on a pool for the specified storage cloud.
Argument List
name: <string> description: <string> storagePoolId: <string> storageCloudId: <string> provisionableSize: <unsignedLong> utilizableSpace: <unsignedLong> maxVolumes: <unsignedInt> maxShares: <unsignedInt> policyFlags: <unsignedInt> flags: <unsignedInt>
storageQuotaDelete API
Deletes a storage quota, the associated volumes are not deleted.
Argument List
storageQuota: <string> flags: <unsignedInt>
storageQuotaEnum API
Returns a list of all the storage quotas.
Argument List
flags: <unsignedInt>
storageQuotaGet API
Returns information about a specific storage quota.
Argument List
storageQuota: <string> flags: <unsignedInt>
storageQuotaModify API
Modifies one to change the name and/or description of a storage quota.
Argument List
storageQuota: <string> name: <string> description: <string> storageCloudId: <string> provisionableSize: <unsignedLong> utilizableSpace: <unsignedLong> maxVolumes: <unsignedInt> maxShares: <unsignedInt> policyFlags: <unsignedInt> flags: <unsignedInt>
Adds/Removes one or more volumes to the specified quota.
Argument List
storageQuota: <string> modType: <unsignedInt> storageShareList: <string[]> flags: <unsignedInt>
Returns a list of all the associated quotas of a specified share.
Argument List
networkShare: <string> flags: <unsignedInt>
Returns information about the associated quotas of a specified share.
Argument List
storageQuotaId: <string> shareId: <string>
storageQuotaVolumeAddRemove API
Adds/Removes one or more volumes to the specified quota.
Argument List
storageQuota: <string> modType: <unsignedInt> storageVolumeList: <string[]> flags: <unsignedInt>
storageQuotaVolumeAssocEnum API
Returns a list of all the associated quotas of a specified volume.
Argument List
storageVolume: <string> flags: <unsignedInt>
storageQuotaVolumeAssocGet API
Return information about the associated quotas of a specified volume.
Argument List
storageQuotaId: <string> storageVolumeId: <string>
storageSystemClusterAssocEnum API
Returns a list of the associated storage system nodes in the grid.
Argument List
flags: <unsignedInt>
storageSystemClusterAssocGet API
Get general information about the associated storage system management grid.
Argument List
storageSystemClusterId: <string> storageSystemId: <string> flags: <unsignedInt>
storageSystemClusterCreate API
Creates a new management grid. A given storage system can only be a member of one grid at a time.
Argument List
name: <string> description: <string> virtualHostName: <string> virtualHostIpAddress: <string> virtualHostSubnetMask: <string> virtualHostGateway: <string> targetPort: <string> enableGridVif: <boolean> gridBindPortAddress: <string> gridIndex: <unsignedInt> flags: <unsignedInt>
storageSystemClusterDelete API
Deletes the management grid. After the grid is deleted each node in the grid operates independently again.
Argument List
flags: <unsignedInt>
storageSystemClusterEnum API
Returns a list of all the managed storage system nodes in the grid.
Argument List
flags: <unsignedInt>
storageSystemClusterGet API
Get general information about the storage system management grid.
Argument List
storageSystemCluster: <string> flags: <unsignedInt>
storageSystemClusterGetHostsConfig API
Argument List
storageSystem: <string> flags: <unsignedInt>
storageSystemClusterModify API
Modify the management grid properties.
Argument List
name: <string> description: <string> virtualHostName: <string> virtualHostIpAddress: <string> virtualHostSubnetMask: <string> virtualHostGateway: <string> targetPort: <string> enableGridVif: <boolean> gridBindPortAddress: <string> gridIndex: <unsignedInt> flags: <unsignedInt>
storageSystemClusterNodeAdd API
Adds the specified storage system to the management grid.
Argument List
nodeIpAddress: <string> nodeAdminUsername: <string> nodeAdminPassword: <string> flags: <unsignedInt>
storageSystemClusterNodeEject API
Ejects the specified storage system from the management grid.
Argument List
storageSystemClusterObj: <storageSystemCluster> flags: <unsignedInt>
storageSystemClusterNodeJoin API
Joins the specified storage system to the management grid.
Argument List
storageSystemClusterObj: <storageSystemCluster> masterNode: <storageSystem> flags: <unsignedInt>
storageSystemClusterNodeRemove API
Removes the specified storage system from the management grid.
Argument List
storageSystemId: <string> flags: <unsignedInt>
storageSystemClusterNodeSetMaster API
Sets the master node for a storage system.
Argument List
storageSystemId: <string> flags: <unsignedInt>
storageSystemClusterNodeSync API
Argument List
storageSystemClusterObj: <storageSystemCluster> masterNode: <storageSystem> flags: <unsignedInt>
storageSystemClusterSetHostsConfig API
Argument List
storageSystem: <string> targetPortIdList: <string[]> options: <unsignedInt> flags: <unsignedInt>
storageSystemEnum API
Returns a list of all the managed storage systems. This is always a single system unless the system is a member of a management grid.
Argument List
flags: <unsignedInt>
storageSystemGet API
Get general information about the storage system.
Argument List
storageSystem: <string> flags: <unsignedInt>
storageSystemGroupAddRemoveLinks API
Argument List
groupId: <string> linkIdList: <string[]> modType: <unsignedInt> flags: <unsignedInt>
storageSystemGroupAssocEnum API
Argument List
flags: <unsignedInt>
storageSystemGroupAssocGet API
Argument List
groupId: <string> linkId: <string> flags: <unsignedInt>
storageSystemGroupCreate API
Argument List
name: <string> description: <string> virtualIpAddress: <string> groupPassword: <string> flags: <unsignedInt>
storageSystemGroupDelete API
Argument List
groupId: <string> deleteAssociatedLinks: <boolean> flags: <unsignedInt>
storageSystemGroupEnum API
Argument List
flags: <unsignedInt>
storageSystemGroupGet API
Argument List
groupId: <string> flags: <unsignedInt>
storageSystemGroupModify API
Argument List
groupId: <string> name: <string> description: <string> virtualIpAddress: <string> flags: <unsignedInt>
storageSystemGroupSetPassword API
Argument List
groupId: <string> groupPassword: <string> flags: <unsignedInt>
storageSystemLinkCreate API
Create a new storage system link so that storage volumes may be replicated between storage systems.
Argument List
storageSystemId: <string> remoteSystemId: <string> localIpAddress: <string> remoteIpAddress: <string> bandwidthLimit: <unsignedInt> linkType: <unsignedInt> description: <string> flags: <unsignedInt>
storageSystemLinkDelete API
Delete an existing storage system link.
Argument List
linkId: <string> flags: <unsignedInt>
storageSystemLinkDisconnect API
Disconnect a storage system link.
Argument List
remoteStorageSystemId: <string> flags: <unsignedInt>
storageSystemLinkEnum API
List the existing storage system remote replication links.
Argument List
flags: <unsignedInt>
storageSystemLinkEstablish API
Establishes a storage system remote replication link.
Argument List
linkObj: <storageSystemLink> flags: <unsignedInt>
storageSystemLinkGet API
Get information about the storage system link.
Argument List
linkId: <string> flags: <unsignedInt>
storageSystemLinkModify API
Modify the properties of the storage system link.
Argument List
linkId: <string> remoteIpAddress: <string> localIpAddress: <string> bandwidthLimit: <unsignedInt> linkType: <unsignedInt> description: <string> flags: <unsignedInt>
storageSystemLinkRefresh API
Refreshes a storage system link.
Argument List
linkId: <string> flags: <unsignedInt>
storageSystemLinkSetCredentials API
Change the credentials for an existing storage system link.
Argument List
linkId: <string> remoteAdminUser: <string> remoteAdminPassword: <string> flags: <unsignedInt>
storageSystemLinkVerify API
Argument List
linkObj: <storageSystemLink> flags: <unsignedInt>
storageSystemModify API
Modifies the name and/or description of the storage system.
Argument List
storageSystem: <string> newName: <string> newDescription: <string> newLocation: <string> domainSuffix: <string> searchSuffix: <string> arpFilterMode: <unsignedInt> bondMode: <unsignedInt> newDnsServerList: <string[]> externalHostName: <string> gridPreferredPort: <string> flags: <unsignedInt>
storageSystemRecover API
Argument List
storageSystem: <string> recoveryPoint: <string> recoverNetworkConfig: <boolean> flags: <unsignedInt>
storageSystemRecoveryPointEnum API
Returns a list of all the available system meta data recovery points. Recovery points allow you to restore system information such as network, host, users, and other system information from a prior automatic backup.
Argument List
storageSystem: <string> flags: <unsignedInt>
storageSystemRestart API
Restarts the entire storage system.
Argument List
storageSystem: <string> flags: <unsignedInt>
storageSystemSendLogs API
Argument List
storageSystemId: <string> flags: <unsignedInt>
storageSystemServicesRestart API
Argument List
storageSystem: <string> servicesList: <string> flags: <unsignedInt>
storageSystemShutdown API
Shutdown the storage system.
Argument List
storageSystem: <string> flags: <unsignedInt>
storageSystemUpdateCheck API
Checks for updates for specified storage system.
Argument List
storageSystem: <string> flags: <unsignedInt>
storageSystemUpgrade API
Upgrade to the latest version of the core packages.
Argument List
storageSystem: <string> upgradeManager: <boolean> upgradeService: <boolean> upgradeTarget: <boolean> upgradeWebServer: <boolean> flags: <unsignedInt>
storageTierAssocEnum API
Argument List
storagePool: <string> flags: <unsignedInt>
storageTierAssocGet API
Argument List
storageTierId: <string> storagePoolId: <string>
storageTierCreate API
Argument List
name: <string> description: <string> storageClass: <string> storageType: <unsignedInt> performanceLevel: <unsignedInt> poolList: <string[]> flags: <unsignedInt>
storageTierDelete API
Argument List
storageTier: <string> flags: <unsignedInt>
storageTierEnum API
Argument List
flags: <unsignedInt>
storageTierGet API
Argument List
storageTier: <string> flags: <unsignedInt>
storageTierModify API
Argument List
storageTier: <string> newName: <string> description: <string> storageClass: <string> storageType: <unsignedInt> performanceLevel: <unsignedInt> flags: <unsignedInt>
storageTierPoolAddRemove API
Argument List
storageTier: <string> modType: <unsignedInt> poolList: <string[]> flags: <unsignedInt>
storageVolumeAclAddRemove API
Enables/Disables access to the specific volume from the specified host.
Argument List
storageVolume: <string> modType: <unsignedInt> hostList: <string[]> flags: <unsignedInt>
storageVolumeAclAddRemoveEx API
Enables access to the specific volume from the specified host.
Argument List
host: <string> modType: <unsignedInt> storageVolumeList: <string[]> flags: <unsignedInt>
storageVolumeAclEnum API
Returns a list of all the volume to host assignments, optionally filtered by host or storage volume.
Argument List
host: <string> storageVolume: <string> flags: <unsignedInt>
storageVolumeAclGet API
Gets the assignment information for specified host or storage volume.
Argument List
host: <string> storageVolume: <string> flags: <unsignedInt>
storageVolumeClone API
Creates a complete block copy of the source volume.
Argument List
storageVolume: <string> cloneName: <string> description: <string> provisionableId: <string> accessMode: <unsignedInt> flags: <unsignedInt>
storageVolumeCloudBackupCreate API
Argument List
sourceVolumeId: <string> cloudContainerId: <string> backupVolumeName: <string> backupVolumeDescription: <string> priority: <unsignedInt> reserved: <string> flags: <unsignedInt>
storageVolumeCloudBackupRestore API
Argument List
sourceVolumeId: <string> storagePoolId: <string> recoveredVolumeName: <string> recoveredVolumeDescription: <string> priority: <unsignedInt> reserved: <string> flags: <unsignedInt>
storageVolumeCreate API
Creates a new storage volume in the specified storage pool.
Argument List
name: <string> description: <string> provisionableId: <string> size: <unsignedLong> thinProvisioned: <boolean> accessMode: <unsignedInt> chapPolicy: <unsignedInt> chapUsername: <string> chapPassword: <string> count: <unsignedInt> flags: <unsignedInt>
storageVolumeCreateEx API
Argument List
name: <string> description: <string> provisionableId: <string> size: <unsignedLong> percentReserved: <unsignedInt> accessMode: <unsignedInt> chapPolicy: <unsignedInt> chapUsername: <string> chapPassword: <string> count: <unsignedInt> blockSizeKb: <unsignedInt> flags: <unsignedInt>
storageVolumeDelete API
Deletes a storage volume, *WARNING* any data in the volume will be lost.
Argument List
storageVolumeList: <string[]> recursivelyDeleteSnapshots: <boolean> flags: <unsignedInt>
storageVolumeDeleteEx API
Argument List
storageVolume: <string> flags: <unsignedInt>
storageVolumeEnum API
Returns a list of all the storage volumes.
Argument List
storageVolumeList: <string[]> flags: <unsignedInt>
storageVolumeGet API
Returns information about a specific storage volume.
Argument List
storageVolume: <string> flags: <unsignedInt>
storageVolumeGroupAssocEnum API
Argument List
storageVolume: <string> flags: <unsignedInt>
storageVolumeGroupAssocGet API
Argument List
storageVolumeGroupId: <string> storageVolumeId: <string>
storageVolumeGroupClone API
Creates a complete block by block copy of all volumes in the group.
Argument List
storageVolumeGroup: <string> cloneNamePrefix: <string> description: <string> provisionableId: <string> accessMode: <unsignedInt> flags: <unsignedInt>
storageVolumeGroupCreate API
Creates a new storage volume group comprised of the specified storage volumes.
Argument List
name: <string> description: <string> storageVolumeList: <string[]> flags: <unsignedInt>
storageVolumeGroupDelete API
Deletes a storage volume group, the volumes are not deleted unless the delete-volumes flag is set.
Argument List
storageVolumeGroup: <string> deleteAssociatedVolumes: <boolean> flags: <unsignedInt>
storageVolumeGroupEnum API
Returns a list of all the storage volume groups.
Argument List
flags: <unsignedInt>
storageVolumeGroupGet API
Returns information about a specific storage volume group.
Argument List
storageVolumeGroup: <string> flags: <unsignedInt>
storageVolumeGroupModify API
Modifies the name and/or description of a storage volume group.
Argument List
storageVolumeGroup: <string> newName: <string> newDescription: <string> flags: <unsignedInt>
storageVolumeGroupSnapshot API
Creates a space efficient copy of all volumes in the group.
Argument List
storageVolumeGroup: <string> snapshotNamePrefix: <string> description: <string> provisionableId: <string> count: <unsignedInt> accessMode: <unsignedInt> flags: <unsignedInt>
storageVolumeGroupVolumeAddRemove API
Adds/Removes one or more volumes to the specified volume group.
Argument List
storageVolumeGroup: <string> modType: <unsignedInt> storageVolumeList: <string[]> flags: <unsignedInt>
storageVolumeImport API
Argument List
storagePool: <string> importTypes: <unsignedInt> cleanupSnapshots: <boolean> replicationScheduleId: <string[]> flags: <unsignedInt>
storageVolumeModify API
Modifies a the name, description or other properties of the storage volume.
Argument List
storageVolume: <string> newName: <string> newDescription: <string> newAccessMode: <unsignedInt> chapPolicy: <unsignedInt> chapUsername: <string> chapPassword: <string> clearSnapshotFlag: <boolean> enableCaching: <boolean> isActiveCheckpoint: <boolean> syncPolicy: <unsignedInt> compressionType: <string> copies: <unsignedInt> flags: <unsignedInt>
storageVolumeResize API
Resizes a storage volume to make it larger, volumes cannot be reduced in size.
Argument List
storageVolume: <string> provisionableId: <string> newSizeInBytes: <unsignedLong> flags: <unsignedInt>
storageVolumeRestore API
Restores a storage volume to a previous point in time using a snapshot.
Argument List
storageVolume: <string> snapshotVolume: <string> flags: <unsignedInt>
storageVolumeRollback API
Argument List
storageVolume: <string> snapshotVolume: <string> flags: <unsignedInt>
storageVolumeSnapshot API
Creates a space efficient copy of the source volume.
Argument List
storageVolume: <string> snapshotName: <string> description: <string> provisionableId: <string> accessMode: <unsignedInt> count: <unsignedInt> flags: <unsignedInt>
storageVolumeUtilizationEnum API
Returns volume utilization information for a specific storage volume or all storage volumes if no volume is specified.
Argument List
storageVolume: <string> flags: <unsignedInt>
storageVolumeUtilizationGet API
Returns a specific volume utilization metrics for a single volume and specific date.
Argument List
utilizationId: <string> flags: <unsignedInt>
storageVolumeUtilizationGetRetentionPeriod API
Argument List
flags: <unsignedInt>
storageVolumeUtilizationSetRetentionPeriod API
Argument List
daysToRetain: <unsignedInt> flags: <unsignedInt>
targetPortDisable API
Disables the specified target port.
Argument List
port: <string> flags: <unsignedInt>
targetPortEnable API
Enables the specified target port.
Argument List
port: <string> flags: <unsignedInt>
targetPortEnum API
Returns a list of all the target ports in the system.
Argument List
flags: <unsignedInt>
targetPortGet API
Returns information about the specified target port.
Argument List
port: <string> flags: <unsignedInt>
targetPortModify API
Modifies target port settings including IP address, gateway, mtu, etc.
Argument List
port: <string> configType: <string> ipAddress: <string> netmask: <string> gateway: <string> mtu: <unsignedInt> iscsiEnabled: <boolean> description: <string> vportFloatList: <string[]> bondMode: <unsignedInt> flags: <unsignedInt>
targetPortRescan API
Discovers new target ports and/or any manual modifications made to the configuration of the target ports.
Argument List
storageSystem: <string> flags: <unsignedInt>
targetPortRestart API
Restarts the specified target port.
Argument List
port: <string> flags: <unsignedInt>
targetVirtualInterfaceCreate API
Creates a new virtual network interface which is linked to a physical network port.
Argument List
storageSystemId: <string> parentPortId: <string> ipAddress: <string> netmask: <string> gateway: <string> macAddress: <string> portList: <string[]> mtu: <unsignedInt> description: <string> flags: <unsignedInt>
targetVirtualInterfaceMove API
Moves the specified virtual network interface to a different physical network port.
Argument List
virtualInterfaceId: <string> targetPortId: <string> flags: <unsignedInt>
targetVirtualPortCreate API
Argument List
storageSystemId: <string> ipAddress: <string> netmask: <string> gateway: <string> macAddress: <string> portList: <string[]> mtu: <unsignedInt> description: <string> bondMode: <unsignedInt> flags: <unsignedInt>
targetVirtualPortDelete API
Argument List
port: <string> flags: <unsignedInt>
targetVlanInterfaceCreate API
Argument List
storageSystemId: <string> parentPortId: <string> ipAddress: <string> netmask: <string> gateway: <string> vlanId: <unsignedInt> vlanQos: <unsignedInt> mtu: <unsignedInt> description: <string> flags: <unsignedInt>
taskCancel API
Cancels the specified task that is in the queue or is running.
Argument List
id: <string> flags: <unsignedInt>
taskClearAll API
Clears all the completed and/or failed tasks.
Argument List
flags: <unsignedInt>
taskEnum API
Returns a list of all the tasks including active, completed, and failed tasks.
Argument List
taskIdlist: <string[]> flags: <unsignedInt>
taskGet API
Returns information about the specified task.
Argument List
id: <string> flags: <unsignedInt>
taskUpdateProgress API
Argument List
taskId: <string> description: <string> progress: <unsignedInt> state: <unsignedInt> flags: <unsignedInt>
traceLevelGet API
Argument List
flags: <unsignedInt>
traceLevelModify API
Argument List
traceLevel: <unsignedInt> stdOut: <boolean> traceFilter: <string[]> flags: <unsignedInt>
userAdd API
Adds a new user to the system. User accounts can access QuantaStor via the web management interface, remote scripting and via the qstorapi RESTful API.
Argument List
username: <string> password: <string> role: <string> firstName: <string> lastName: <string> emailAddress: <string> description: <string> defaultChapUsername: <string> defaultChapPassword: <string> alertSubscriptions: <unsignedInt> flags: <unsignedInt>
userEnum API
Returns a list of all the users.
Argument List
flags: <unsignedInt>
userGet API
Gets information about the specified user.
Argument List
user: <string> flags: <unsignedInt>
userGroupAssocEnum API
Argument List
user: <string> flags: <unsignedInt>
userGroupAssocGet API
Argument List
userGroupId: <string> userId: <string>
userGroupCreate API
Creates a new storage user group comprised of the specified storage users.
Argument List
name: <string> description: <string> userList: <string[]> flags: <unsignedInt>
userGroupDelete API
Deletes a storage user group, the users are not deleted unless the delete-users flag is set.
Argument List
userGroup: <string> flags: <unsignedInt>
userGroupEnum API
Returns a list of all the storage user groups.
Argument List
flags: <unsignedInt>
userGroupGet API
Returns information about a specific storage user group.
Argument List
userGroup: <string> flags: <unsignedInt>
userGroupModify API
Modifies the name and/or description of a storage user group.
Argument List
userGroup: <string> newName: <string> newDescription: <string> flags: <unsignedInt>
userGroupUserAddRemove API
Adds/Removes one or more users to the specified user group.
Argument List
userGroup: <string> modType: <unsignedInt> userList: <string[]> flags: <unsignedInt>
userModify API
Modifies the name and/or description of a storage user group.
Argument List
user: <string> newName: <string> newRole: <string> newFirstName: <string> newLastName: <string> newEmailAddress: <string> newDescription: <string> newDefaultChapUsername: <string> newDefaultChapPassword: <string> alertSubscriptions: <unsignedInt> flags: <unsignedInt>
userPasswordSet API
Sets a new password for specified user.
Argument List
user: <string> oldPassword: <string> newPassword: <string> flags: <unsignedInt>
userRemove API
Removes specified user.
Argument List
user: <string> flags: <unsignedInt>
virtualInterfaceAssocEnum API
Argument List
flags: <unsignedInt>
virtualInterfaceAssocGet API
Argument List
virtualInterfaceId: <string> targetPortId: <string> flags: <unsignedInt>
widgetCreate API
Argument List
name: <string> flags: <unsignedInt>
Enumeration Types
The enumeration types listed below are used with APIs noted above. Many of the enumerations have assigned values like "OSN_CMN_FLAG_ASYNC = 0x0001" but for those that do not have assigned values note that they are 0 indexed. For example, OSN_CMN_ACCESSTYPE_READWRITE should be specified as 0 and OSN_CMN_ACCESSTYPE_READONLY specified as a 1 to the storageVolumeModify API as the accessMode for changing the configuration of a storage volume.
Enumeration Definitions
typedef enum osn__flags { OSN_CMN_FLAG_NONE = 0x0000, OSN_CMN_FLAG_ASYNC = 0x0001, OSN_CMN_FLAG_FORCE = 0x0002, OSN_CMN_FLAG_ASYNC_FORCE = 0x0003, OSN_CMN_FLAG_RESCAN = 0x0004, OSN_CMN_FLAG_ASYNC_RESCAN = 0x0005, OSN_CMN_FLAG_FORCE_RESCAN = 0x0006, OSN_CMN_FLAG_FORCE_ASYNC_RESCAN = 0x0007, OSN_CMN_FLAG_GENERATE_NAME = 0x0008, OSN_CMN_FLAG_SYNC_PRIMARY = 0x0010, OSN_CMN_FLAG_SYNC_SECONDARY = 0x0020, OSN_CMN_FLAG_REDIRECT = 0x0040, OSN_CMN_FLAG_SUPPRESS_ALARMS = 0x0080, OSN_CMN_FLAG_STOP_VERIFY = 0x0100, OSN_CMN_FLAG_USE_GUID_IQN = 0x0200, OSN_CMN_FLAG_EXPORT = 0x0400, OSN_CMN_FLAG_RESCUE_MODE = 0x0800, OSN_CMN_FLAG_START_REPAIR = 0x1000, OSN_CMN_FLAG_SPARES_ONLY = 0x2000, OSN_CMN_FLAG_LAZY = 0x4000, OSN_CMN_FLAG_MAX = 0x8000 } osn__flags_t; //--spares-only args.hasArg("spares-only") ? flags | OSN_CMN_FLAG_SPARES_ONLY : flags typedef enum osn__modifyType { OSN_CMN_MOD_OP_ADD = 0, OSN_CMN_MOD_OP_REMOVE = 1, OSN_CMN_MOD_OP_SET = 2 } osn__modifyType_t; typedef enum osn__nfsServiceMode { OSN_CMN_NFS_MODE_V3 = 0, OSN_CMN_NFS_MODE_V4 = 1, OSN_CMN_NFS_MODE_GLUSTER = 2 } osn__nfsServiceMode_t; typedef enum osn__accessType { OSN_CMN_ACCESSTYPE_READWRITE, OSN_CMN_ACCESSTYPE_READONLY, OSN_CMN_ACCESSTYPE_NONE } osn__accessType_t; typedef enum osn__cifsUserAccessMode { OSN_CMN_CIFS_USER_ACCESS_NONE, OSN_CMN_CIFS_USER_ACCESS_VALID, OSN_CMN_CIFS_USER_ACCESS_ADMIN, OSN_CMN_CIFS_USER_ACCESS_INVALID } osn__cifsUserAccessMode_t; typedef enum osn__cacheType { OSN_CMN_ACCESSTYPE_WRITETHRU, OSN_CMN_ACCESSTYPE_WRITEBACK } osn__cacheType_t; typedef enum osn__syncPolicy { OSN_CMN_SYNCTYPE_STANDARD, OSN_CMN_SYNCTYPE_ALWAYS, OSN_CMN_SYNCTYPE_DISABLED, OSN_CMN_SYNCTYPE_AUTO } osn__syncPolicy_t; typedef enum osn__chapPolicy { OSN_CHAP_DISABLED=0, OSN_CHAP_USE_TARGET_CHAP=1, OSN_CHAP_USE_USER_CHAP_DEFAULTS=2, OSN_CHAP_USE_TARGET_AND_USER_CHAP=3, OSN_CHAP_USE_STORAGE_CLOUD_CHAP_DEFAULTS=4 } osn__chapPolicy_t; typedef enum osn__alertTriggerDataType { OSN_CMN_ALERT_DATATYPE_UNKNOWN, OSN_CMN_ALERT_DATATYPE_DURATION_IN_SEC, OSN_CMN_ALERT_DATATYPE_PERCENTAGE, OSN_CMN_ALERT_DATATYPE_BOOL_ON_OFF, OSN_CMN_ALERT_DATATYPE_COUNT, OSN_CMN_ALERT_DATATYPE_MAX } osn__alertTriggerDataType_t; typedef enum osn__quotaPolicy { OSN_CMN_QUOTA_POLICY_SOFT, OSN_CMN_QUOTA_POLICY_HARD } osn__quotaPolicy_t; typedef enum osn__initiatorType { OSN_CMN_INITIATOR_ISCSI=0, OSN_CMN_INITIATOR_FCP=1, OSN_CMN_INITIATOR_IB=2 } osn__initiatorType_t; typedef enum osn__linkState { OSN_CMN_LINKSTATE_UP, OSN_CMN_LINKSTATE_DOWN, OSN_CMN_LINKSTATE_UNKNOWN } osn__linkState_t; typedef enum osn__objectState { OSN_CMN_OBJSTATE_NORMAL, OSN_CMN_OBJSTATE_WARNING, OSN_CMN_OBJSTATE_BUSY, OSN_CMN_OBJSTATE_ERROR, OSN_CMN_OBJSTATE_INITIALIZING, OSN_CMN_OBJSTATE_MISSING, OSN_CMN_OBJSTATE_OFFLINE, OSN_CMN_OBJSTATE_DISCONNECTED } osn__objectState_t; typedef enum osn__dataType { OSN_CMN_DATATYPE_STRING, OSN_CMN_DATATYPE_INT, OSN_CMN_DATATYPE_TIME, OSN_CMN_DATATYPE_FLOAT } osn__dataType_t; typedef enum osn__eventType { OSN_CMN_EVENTTYPE_ADD, OSN_CMN_EVENTTYPE_REMOVE, OSN_CMN_EVENTTYPE_MODIFY } osn__eventType_t; typedef enum osn__eventListenerType { OSN_CMN_LISTENERTYPE_OBSERVER=0, OSN_CMN_LISTENERTYPE_SECONDARY=1, OSN_CMN_LISTENERTYPE_PRIMARY=2 } osn__eventListenerType_t; typedef enum osn__eventListenerMode { OSN_CMN_LISTENERMODE_ENQUEUE=0, OSN_CMN_LISTENERMODE_PROCESS=1, OSN_CMN_LISTENERMODE_FLUSH=2 } osn__eventListenerMode_t; typedef enum osn__replicaAssocType { OSN_CMN_REPLICA_CHILD, OSN_CMN_REPLICA_HEAD } osn__replicaAssocType_t; typedef enum osn__replicationActionType { OSN_CMN_REPLICATION_SETUP, OSN_CMN_REPLICATION_CONNECT, OSN_CMN_REPLICATION_DISCONNECT, OSN_CMN_REPLICATION_RECONNECT, OSN_CMN_REPLICATION_ADJUST } osn__replicationActionType_t; typedef enum osn__replicationCongestionPolicy { OSN_CMN_REPLICATION_CONGESTION_POLICY_SYNC, OSN_CMN_REPLICATION_CONGESTION_POLICY_PULL_AHEAD } osn__replicationCongestionPolicy_t; typedef enum osn__initPriorityType { OSN_INITPRIORITY_DEFAULT, OSN_INITPRIORITY_LOW, OSN_INITPRIORITY_MEDIUM, OSN_INITPRIORITY_HIGH } osn__initPriorityType_t; typedef enum osn__objectType { OSN_CMN_OBJECTTYPE_UNKNOWN, OSN_CMN_OBJECTTYPE_SNAPSHOT_SCHEDULE, OSN_CMN_OBJECTTYPE_SNAPSHOT_SCHEDULE_ASSOC, OSN_CMN_OBJECTTYPE_STORAGE_VOLUME, OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_UTILIZATION, OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_GROUP, OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_GROUP_ASSOC, OSN_CMN_OBJECTTYPE_STORAGE_POOL, OSN_CMN_OBJECTTYPE_STORAGE_POOL_DEVICE, OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM, OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_ACL, OSN_CMN_OBJECTTYPE_HOST, OSN_CMN_OBJECTTYPE_HOST_GROUP, OSN_CMN_OBJECTTYPE_INITIATOR_PORT, OSN_CMN_OBJECTTYPE_TARGET_PORT, OSN_CMN_OBJECTTYPE_PHYSICAL_DISK, OSN_CMN_OBJECTTYPE_TASK, OSN_CMN_OBJECTTYPE_AUDIT_ENTRY, OSN_CMN_OBJECTTYPE_AUDIT_SETTINGS, OSN_CMN_OBJECTTYPE_ALERT, OSN_CMN_OBJECTTYPE_ALERT_CONFIG_SETTINGS, OSN_CMN_OBJECTTYPE_LICENSE, OSN_CMN_OBJECTTYPE_LICENSE_ACTIVATION, OSN_CMN_OBJECTTYPE_USER, OSN_CMN_OBJECTTYPE_USER_PERMISSION_ASSIGNMENT, OSN_CMN_OBJECTTYPE_USER_GROUP, OSN_CMN_OBJECTTYPE_USER_GROUP_ASSOC, OSN_CMN_OBJECTTYPE_ROLE, OSN_CMN_OBJECTTYPE_ROLE_PERMISSION_ASSIGNMENT, OSN_CMN_OBJECTTYPE_ROLE_SUBJECT_ASSOC, OSN_CMN_OBJECTTYPE_PERMISSION_DEFINITION, OSN_CMN_OBJECTTYPE_STORAGE_CLOUD, OSN_CMN_OBJECTTYPE_STORAGE_CLOUD_ASSOC, OSN_CMN_OBJECTTYPE_STORAGE_CLOUD_SUBJECT_ASSOC, OSN_CMN_OBJECTTYPE_SESSION, OSN_CMN_OBJECTTYPE_STORAGE_TIER, OSN_CMN_OBJECTTYPE_STORAGE_TIER_ASSOC, OSN_CMN_OBJECTTYPE_STORAGE_QUOTA, OSN_CMN_OBJECTTYPE_STORAGE_QUOTA_ASSOC, OSN_CMN_OBJECTTYPE_ACL, OSN_CMN_OBJECTTYPE_OBJECT_PROPERTY, OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_LINK, OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_GROUP, OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_GROUP_ASSOC, OSN_CMN_OBJECTTYPE_REPLICA_ASSOC, OSN_CMN_OBJECTTYPE_PHYSICAL_DISK_PATH_ASSOC, OSN_CMN_OBJECTTYPE_HW_ALARM, OSN_CMN_OBJECTTYPE_HW_BBU, OSN_CMN_OBJECTTYPE_HW_DISK, OSN_CMN_OBJECTTYPE_HW_UNIT, OSN_CMN_OBJECTTYPE_HW_ENCLOSURE, OSN_CMN_OBJECTTYPE_HW_CONTROLLER, OSN_CMN_OBJECTTYPE_HW_CONTROLLER_GROUP, OSN_CMN_OBJECTTYPE_NETWORK_SHARE, OSN_CMN_OBJECTTYPE_NETWORK_SHARE_CLIENT, OSN_CMN_OBJECTTYPE_REPLICATION_SCHEDULE, OSN_CMN_OBJECTTYPE_REPLICATION_SCHEDULE_ASSOC, OSN_CMN_OBJECTTYPE_HW_LOGICAL_DRIVE, OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_RECOVERY_POINT, OSN_CMN_OBJECTTYPE_CLOUD_CONTAINER, OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER, OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER_CREDENTIALS, OSN_CMN_OBJECTTYPE_CLOUD_BACKUP_SCHEDULE, OSN_CMN_OBJECTTYPE_CLOUD_BACKUP_SCHEDULE_ASSOC, OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER_LOCATION, OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_CLUSTER, OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_CLUSTER_ASSOC, OSN_CMN_OBJECTTYPE_CLUSTER_FAILOVER_GROUP, OSN_CMN_OBJECTTYPE_FC_TARGET_PORT, OSN_CMN_OBJECTTYPE_NETWORK_SHARE_SERVICE_CONFIG, OSN_CMN_OBJECTTYPE_WIDGET, OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_LINK_KEY, OSN_CMN_OBJECTTYPE_STORAGE_POOL_PROFILE, OSN_CMN_OBJECTTYPE_STORAGE_QUOTA_SHARE_ASSOC, OSN_CMN_OBJECTTYPE_SITE, OSN_CMN_OBJECTTYPE_SITE_ASSOC, OSN_CMN_OBJECTTYPE_VIRTUAL_INTERFACE_ASSOC, OSN_CMN_OBJECTTYPE_IB_TARGET_PORT, OSN_CMN_OBJECTTYPE_HW_SWITCH_CREDENTIALS, OSN_CMN_OBJECTTYPE_HW_SWITCH, OSN_CMN_OBJECTTYPE_HW_SWITCH_ZONESET, OSN_CMN_OBJECTTYPE_HW_SWITCH_ADAPTER, OSN_CMN_OBJECTTYPE_HW_SWITCH_FAILOVER_GROUP, OSN_CMN_OBJECTTYPE_HW_SWITCH_FAILOVER_GROUP_POOL_ASSOC, OSN_CMN_OBJECTTYPE_HW_SWITCH_FAILOVER_GROUP_SYSTEM_ASSOC, OSN_CMN_OBJECTTYPE_HW_SWITCH_CREDENTIALS_SYSTEM_ASSOC, OSN_CMN_OBJECTTYPE_LIBRATO_METRICS_CONFIG, OSN_CMN_OBJECTTYPE_STORAGE_POOL_REPLICATION_CONFIG, OSN_CMN_OBJECTTYPE_GLUSTER_VOLUME, OSN_CMN_OBJECTTYPE_GLUSTER_BRICK, OSN_CMN_OBJECTTYPE_GLUSTER_PEER, OSN_CMN_OBJECTTYPE_NETWORK_SHARE_USER_ACCESS, OSN_CMN_OBJECTTYPE_NETWORK_SHARE_CIFS_OPTION, OSN_CMN_OBJECTTYPE_ALERT_TRIGGER, OSN_CMN_OBJECTTYPE_HW_ENCLOSURE_LAYOUT, OSN_CMN_OBJECTTYPE_HW_UNIT_DISK_ASSOC, OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_GROUP, OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_INTERFACE, OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_MODULE, OSN_CMN_OBJECTTYPE_BACKUP_POLICY, OSN_CMN_OBJECTTYPE_BACKUP_JOB, OSN_CMN_OBJECTTYPE_GLUSTER_HA_FAILOVER_INTERFACE, OSN_CMN_OBJECTTYPE_CEPH_POOL, OSN_CMN_OBJECTTYPE_CEPH_OSD, OSN_CMN_OBJECTTYPE_CEPH_POOL_OSD_ASSOC, OSN_CMN_OBJECTTYPE_CEPH_CLUSTER, OSN_CMN_OBJECTTYPE_CEPH_MONITOR, OSN_CMN_OBJECTTYPE_CEPH_HA_FAILOVER_INTERFACE, OSN_CMN_OBJECTTYPE_CEPH_BLOCK_DEVICE, OSN_CMN_OBJECTTYPE_PHYSICAL_DISK_HOTSPARE_MARKER, OSN_CMN_OBJECTTYPE_MAX } osn__objectType_t; typedef enum osn__backupJobStage { OSN_CMN_BACKUP_STAGE_INITIALIZING = 0x0000, OSN_CMN_BACKUP_STAGE_SCANNING = 0x0001, OSN_CMN_BACKUP_STAGE_COPYING = 0x0002, OSN_CMN_BACKUP_STAGE_PURGING = 0x0003, OSN_CMN_BACKUP_STAGE_COMPLETED = 0x0004, OSN_CMN_BACKUP_STAGE_FAILED = 0x0005, } osn__backupJobStage_t; typedef enum osn__backupPurgePolicy { OSN_CMN_BACKUP_PURGE_POLICY_NEVER = 0x0000, OSN_CMN_BACKUP_PURGE_POLICY_AFTER_BACKUP = 0x0001, OSN_CMN_BACKUP_PURGE_POLICY_DAILY = 0x0002, OSN_CMN_BACKUP_PURGE_POLICY_WEEKLY = 0x0003, } osn__backupPurgePolicy_t; typedef enum osn__backupPolicyType { OSN_CMN_BACKUP_POLICY_TYPE_INBOUND = 0x0000, OSN_CMN_BACKUP_POLICY_TYPE_OUTBOUND = 0x0001, } osn__backupPolicyType_t; typedef enum osn__backupPolicyMountType { OSN_CMN_BACKUP_POLICY_MOUNT_NFS = 0x0000, OSN_CMN_BACKUP_POLICY_MOUNT_GLUSTER = 0x0001, OSN_CMN_BACKUP_POLICY_MOUNT_OCFS2 = 0x0002, OSN_CMN_BACKUP_POLICY_MOUNT_CIFS = 0x0003, } osn__backupPolicyMountType_t; typedef enum osn__backupPolicyRetentionCriteria { OSN_CMN_BACKUP_POLICY_RETENTION_ACCESS_TIME = 0x0001, OSN_CMN_BACKUP_POLICY_RETENTION_MODIFY_TIME = 0x0002, OSN_CMN_BACKUP_POLICY_RETENTION_CREATE_TIME = 0x0004, } osn__backupPolicyRetentionCriteria_t; typedef enum osn__alertSubscription { OSN_CMN_ALERT_SUBSCRIPTION_NONE = 0, OSN_CMN_ALERT_SUBSCRIPTION_CRITICAL = 1, OSN_CMN_ALERT_SUBSCRIPTION_ERROR = 2, OSN_CMN_ALERT_SUBSCRIPTION_WARNING = 4, OSN_CMN_ALERT_SUBSCRIPTION_INFO = 8 } osn__alertSubscription_t; typedef enum osn__errorLevel { OSN_CMN_SEVERITY_ALWAYS = 0, OSN_CMN_SEVERITY_CRITICAL = 1, OSN_CMN_SEVERITY_ERROR = 2, OSN_CMN_SEVERITY_WARNING = 3, OSN_CMN_SEVERITY_INFO = 4, OSN_CMN_SEVERITY_DEBUG = 5, OSN_CMN_SEVERITY_VERBOSE = 6, OSN_CMN_SEVERITY_DEBUG2 = 7 } osn__errorLevel_t; typedef enum osn__taskState { OSN_TASKSTATE_INITIALIZING, OSN_TASKSTATE_QUEUED, OSN_TASKSTATE_RUNNING, OSN_TASKSTATE_FAILED, OSN_TASKSTATE_CANCELLED, OSN_TASKSTATE_COMPLETED } osn__taskState_t; typedef enum osn__hostType { OSN_HOSTTYPE_UNKNOWN, OSN_HOSTTYPE_AIX, OSN_HOSTTYPE_HPUX, OSN_HOSTTYPE_LINUX, OSN_HOSTTYPE_SOLARIS, OSN_HOSTTYPE_VMWARE, OSN_HOSTTYPE_WINDOWS, OSN_HOSTTYPE_XENSERVER, OSN_HOSTTYPE_OTHER, OSN_HOSTTYPE_MAC, OSN_HOSTTYPE_MAX } osn__hostType_t; typedef enum osn__retentionTag { OSN_RETENTIONTAG_NONE=0, OSN_RETENTIONTAG_DAY=1, OSN_RETENTIONTAG_WEEK=2, OSN_RETENTIONTAG_MONTH=4, OSN_RETENTIONTAG_YEARLY=8, OSN_RETENTIONTAG_MAX=9 } osn__retentionTag_t; typedef enum osn__networkShareType { OSN_NETWORKSHARETYPE_STANDARD, OSN_NETWORKSHARETYPE_SUBVOL_BTRFS, OSN_NETWORKSHARETYPE_S3QL, OSN_NETWORKSHARETYPE_SUBVOL_ZFS, OSN_NETWORKSHARETYPE_GLUSTER_VOLUME } osn__networkShareType_t; typedef enum osn__storageVolumeType { OSN_STORAGEVOLUMETYPE_FILE, OSN_STORAGEVOLUMETYPE_FILE_BTRFS, OSN_STORAGEVOLUMETYPE_FILE_EXT3, OSN_STORAGEVOLUMETYPE_FILE_EXT4, OSN_STORAGEVOLUMETYPE_RAW_DEVICE, OSN_STORAGEVOLUMETYPE_FILE_ZFS, OSN_STORAGEVOLUMETYPE_FILE_XFS, OSN_STORAGEVOLUMETYPE_FILE_S3QL, OSN_STORAGEVOLUMETYPE_FILE_JFS, OSN_STORAGEVOLUMETYPE_CEPH_RBD } osn__storageVolumeType_t; typedef enum osn__hwEnclosureLayoutFlow { OSN_ENCLOSURELAYOUT_FLOW_T2B_L2R, OSN_ENCLOSURELAYOUT_FLOW_T2B_R2L, OSN_ENCLOSURELAYOUT_FLOW_B2T_L2R, OSN_ENCLOSURELAYOUT_FLOW_B2T_R2L, OSN_ENCLOSURELAYOUT_FLOW_R2L_T2B, OSN_ENCLOSURELAYOUT_FLOW_R2L_B2T, OSN_ENCLOSURELAYOUT_FLOW_L2R_T2B, OSN_ENCLOSURELAYOUT_FLOW_L2R_B2T } osn__hwEnclosureLayoutFlow_t; typedef enum osn__replicationState { OSN_CMN_REPLICATION_STATE_PREPARING, OSN_CMN_REPLICATION_STATE_INITIALIZING, OSN_CMN_REPLICATION_STATE_SYNCHRONIZING, OSN_CMN_REPLICATION_STATE_SYNCHRONIZED, OSN_CMN_REPLICATION_STATE_RESYNCHRONIZING, OSN_CMN_REPLICATION_STATE_PAUSED, OSN_CMN_REPLICATION_STATE_INIT_FAILED, OSN_CMN_REPLICATION_STATE_SYNC_FAILED, OSN_CMN_REPLICATION_STATE_RESYNC_FAILED } osn__replicationState_t; typedef enum osn__remoteReplicaFlags { OSN_CMN_REPLICA_FLAG_NONE, OSN_CMN_REPLICA_FLAG_SOURCE, OSN_CMN_REPLICA_FLAG_TARGET, OSN_CMN_REPLICA_FLAG_SOURCE_AND_TARGET } osn__remoteReplicaFlags_t; typedef enum osn__raidType { OSN_RAIDTYPE_RAID0=0, OSN_RAIDTYPE_RAID1=1, OSN_RAIDTYPE_RAID2=2, OSN_RAIDTYPE_RAID3=3, OSN_RAIDTYPE_RAID4=4, OSN_RAIDTYPE_RAID5=5, OSN_RAIDTYPE_RAID6=6, OSN_RAIDTYPE_RAID7=7, OSN_RAIDTYPE_RAID8=8, OSN_RAIDTYPE_RAID9=9, OSN_RAIDTYPE_RAID10=10, OSN_RAIDTYPE_RAID_AUTO=11, OSN_RAIDTYPE_SINGLE=12, OSN_RAIDTYPE_JBOD=13, OSN_RAIDTYPE_RAID50=14, OSN_RAIDTYPE_RAID60=15, OSN_RAIDTYPE_RAID70=16, OSN_RAIDTYPE_MAX=17 } osn__raidType_t; typedef enum osn__storagePoolType { OSN_STORAGEPOOLTYPE_BTRFS, OSN_STORAGEPOOLTYPE_EXT3, OSN_STORAGEPOOLTYPE_EXT4, OSN_STORAGEPOOLTYPE_XFS, OSN_STORAGEPOOLTYPE_S3QL, OSN_STORAGEPOOLTYPE_JFS, OSN_STORAGEPOOLTYPE_ZFS, OSN_STORAGEPOOLTYPE_CEPH } osn__storagePoolType_t; typedef enum osn__hotsparePoolRepairPolicy { OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_ASSIGNED_AND_GLOBAL = 0, OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_ASSIGNED_ONLY = 1, OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_EXACTMATCH = 2, OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_ASSIGNED_ONLY_EXACTMATCH = 3, OSN_HOTSPARE_POOL_REPAIR_POLICY_MANUAL_REPAIR = 4, OSN_HOTSPARE_POOL_REPAIR_POLICY_MAX = 5 } osn__hotsparePoolRepairPolicy_t; typedef enum osn__hotsparePoolRepairState { OSN_HOTSPARE_POOL_REPAIR_STATE_HEALTHY = 0, OSN_HOTSPARE_POOL_REPAIR_STATE_REPAIR_NEEDED = 1, OSN_HOTSPARE_POOL_REPAIR_STATE_REPAIR_NEEDED_OPERATOR_APPROVAL_REQUIRED = 2, OSN_HOTSPARE_POOL_REPAIR_STATE_AUTO_REPAIR_IN_PROGRESS = 3, OSN_HOTSPARE_POOL_REPAIR_STATE_MAX = 4 } osn__hotsparePoolRepairState_t; typedef enum osn__arpFilterStatus { OSN_ARP_FILTERING_ENABLED, OSN_ARP_FILTERING_DISABLED } osn__arpFilterStatus_t; typedef enum osn__arpFilterMode { OSN_ARP_FILTER_MODE_AUTO, OSN_ARP_FILTER_MODE_ENABLED, OSN_ARP_FILTER_MODE_DISABLED } osn__arpFilterMode_t; typedef enum osn__bondMode { OSN_BOND_MODE_ROUND_ROBIN=0, OSN_BOND_MODE_ACTIVE_BACKUP=1, OSN_BOND_MODE_BALANCE_XOR=2, OSN_BOND_MODE_BROADCAST=3, OSN_BOND_MODE_LACP=4, OSN_BOND_MODE_BALANCE_TLB=5, OSN_BOND_MODE_BALANCE_TRLB=6 } osn__bondMode_t; typedef enum osn__permissionScope { OSN_SCOPE_NONE=0, OSN_SCOPE_USER=1, OSN_SCOPE_STORAGE_CLOUD=2, OSN_SCOPE_SYSTEM=3, OSN_SCOPE_GRID=4 } osn__permissionScope_t; typedef enum osn__resourceAccessRequestType { OSN_CMN_REQUEST_VIEW, OSN_CMN_REQUEST_UTILIZE, OSN_CMN_REQUEST_MODIFY } osn__resourceRequestType_t; //todo: needs to be refactored typedef enum osn__resourceAccessMode { OSN_CMN_RESOURCEACCESS_AUTO =0x0000, OSN_CMN_RESOURCEACCESS_MULTIGROUP_SHARED =0x0001, OSN_CMN_RESOURCEACCESS_GROUP_EXCLUSIVE =0x0002, OSN_CMN_RESOURCEACCESS_IMMUTABLE =0x0004, OSN_CMN_RESOURCEACCESS_MULTIGROUP_SHARED_IMMUTABLE =0x0005, OSN_CMN_RESOURCEACCESS_GROUP_EXCLUSIVE_IMMUTABLE =0x0006, } osn__resourceAccessMode_t; typedef enum osn__diskType { OSN_DISKTYPE_UNKNOWN=0, OSN_DISKTYPE_IDE=1, OSN_DISKTYPE_SATA=2, OSN_DISKTYPE_SCSI=3, OSN_DISKTYPE_SSD=4, OSN_DISKTYPE_SSHD=5, OSN_DISKTYPE_AOE=6, OSN_DISKTYPE_MULTI=7, } osn__diskType_t; typedef enum osn__licenseEdition { OSN_LICENSE_EDITION_FREE, OSN_LICENSE_EDITION_TRIAL, OSN_LICENSE_EDITION_STANDARD, OSN_LICENSE_EDITION_ENTERPRISE, OSN_LICENSE_EDITION_PLATINUM, OSN_LICENSE_EDITION_CLOUD } osn__licenseEdition_t; typedef enum osn__licenseDuration { OSN_LICENSE_DURATION_PERPETUAL, OSN_LICENSE_DURATION_TIMELIMITED } osn__licenseDuration_t; typedef enum osn__licenseCategory { OSN_LICENSE_CATEGORY_SYSTEM, OSN_LICENSE_CATEGORY_FEATURE, OSN_LICENSE_CATEGORY_FEATURE_TERABYTES, OSN_LICENSE_CATEGORY_FEATURE_VOLUMES, OSN_LICENSE_CATEGORY_FEATURE_SNAPSHOTS, OSN_LICENSE_CATEGORY_FEATURE_CLOUDS, OSN_LICENSE_CATEGORY_FEATURE_NODES, OSN_LICENSE_CATEGORY_FEATURE_USERS, OSN_LICENSE_CATEGORY_FEATURE_SSD, OSN_LICENSE_CATEGORY_FEATURE_REPLICATION } osn__licenseCategory_t; typedef enum osn__licenseType { OSN_LICENSE_TYPE_NODE, OSN_LICENSE_TYPE_VOLUME, OSN_LICENSE_TYPE_SITE } osn__licenseType_t; typedef enum osn__lockType { OSN_LOCK_SHARED, OSN_LOCK_PROTECTED, OSN_LOCK_EXCLUSIVE } osn__lockType_t; typedef enum osn__cloudProviderType { OSN_CLOUD_PROVIDER_AMAZON_S3, OSN_CLOUD_PROVIDER_SFTP, OSN_CLOUD_PROVIDER_GOOGLE, OSN_CLOUD_PROVIDER_MICROSOFT_AZURE, OSN_CLOUD_PROVIDER_OPENSTACK_SWIFT } osn__cloudProviderType_t; typedef enum osn__hwControllerCapabilities { HW_CONTROLLER_API_NONE=0, HW_CONTROLLER_API_RESCAN=1, HW_CONTROLLER_API_CREATE_UNIT=2, HW_CONTROLLER_API_NA3=3, HW_CONTROLLER_API_GROW_UNIT=4, HW_CONTROLLER_API_NA5=5, HW_CONTROLLER_API_NA6=6, HW_CONTROLLER_API_NA7=7, HW_CONTROLLER_API_GROW_UNIT_ADV_STRIPE=8, HW_CONTROLLER_API_NA9=9, HW_CONTROLLER_API_NA10=10, HW_CONTROLLER_API_NA11=11, HW_CONTROLLER_API_NA12=12, HW_CONTROLLER_API_NA13=13, HW_CONTROLLER_API_NA14=14, HW_CONTROLLER_API_NA15=15, HW_CONTROLLER_API_GROW_UNIT_ADV_PRIORITY=16, HW_CONTROLLER_API_NA17=17, HW_CONTROLLER_API_NA18=18, HW_CONTROLLER_API_NA19=19, HW_CONTROLLER_API_NA20=20, HW_CONTROLLER_API_NA21=21, HW_CONTROLLER_API_NA22=22, HW_CONTROLLER_API_NA23=23, HW_CONTROLLER_API_NA24=24, HW_CONTROLLER_API_NA25=25, HW_CONTROLLER_API_NA26=26, HW_CONTROLLER_API_NA27=27, HW_CONTROLLER_API_NA28=28, HW_CONTROLLER_API_NA29=29, HW_CONTROLLER_API_NA30=30, HW_CONTROLLER_API_NA31=31, HW_CONTROLLER_API_CREATE_SSD_CACHE=32, HW_CONTROLLER_API_SUPPORTS_SSD_CACHE_RAID=64, HW_CONTROLLER_API_SUPPORTS_UNIT_DISK_CORRELATION=128, HW_CONTROLLER_API_SUPPORTS_ENCRYPTION=256 } osn__hwControllerCapabilities_t; typedef enum osn__hwDiskCapabilities { HW_DISK_API_NONE=0, HW_DISK_API_MARK_HOT_SPARE=1, HW_DISK_API_IDENTIFY=2, HW_DISK_API_NA3=3, HW_DISK_API_REMOVE_DISK=4, HW_DISK_API_NA5=5, HW_DISK_API_NA6=6, HW_DISK_API_NA7=7, HW_DISK_API_SUPPORTS_ENCRYPTION=8 } osn__hwDiskCapabilities_t; typedef enum osn__hwUnitCapabilities { HW_UNIT_API_NONE=0, HW_UNIT_API_IDENTIFY=1, HW_UNIT_API_DELETE=2, HW_UNIT_API_NA3=3, HW_UNIT_API_NA4=4, HW_UNIT_API_NA5=5, HW_UNIT_API_NA6=6, HW_UNIT_API_NA7=7, HW_UNIT_API_SUPPORTS_ENCRYPTION=8 } osn__hwUnitCapabilities_t;