Difference between revisions of "+ Developer Guide Overview"
m (→Async vs. Sync API calls) |
m (→Async vs. Sync API (blocking vs non-blocking) calls) |
||
Line 9: | Line 9: | ||
* PHP curl - [http://php.net/manual/en/book.curl.php] | * PHP curl - [http://php.net/manual/en/book.curl.php] | ||
− | == Async vs. Sync | + | == 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. | 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. |
Revision as of 22:17, 23 August 2012
QuantaStor was designed from the ground up so that you can develop your own applications to remotely manage your storage systems.
Contents
- 1 Supported Languages
- 2 Async vs. Sync (blocking vs non-blocking) API calls
- 3 Task Monitoring
- 4 Security
- 5 Supported SOAP / WebServices Implementations
- 6 API List
- 6.1 aclAdd API
- 6.2 aclModify API
- 6.3 aclRemove API
- 6.4 alertClear API
- 6.5 alertClearAll API
- 6.6 alertConfigGet API
- 6.7 alertConfigSet API
- 6.8 alertEnum API
- 6.9 alertGet API
- 6.10 alertRaise API
- 6.11 auditLogClear API
- 6.12 auditLogDisable API
- 6.13 auditLogEnable API
- 6.14 auditLogGet API
- 6.15 cloudBackupScheduleAssocEnum API
- 6.16 cloudBackupScheduleAssocGet API
- 6.17 cloudBackupScheduleCreate API
- 6.18 cloudBackupScheduleDelete API
- 6.19 cloudBackupScheduleDisable API
- 6.20 cloudBackupScheduleEnable API
- 6.21 cloudBackupScheduleEnum API
- 6.22 cloudBackupScheduleGet API
- 6.23 cloudBackupScheduleModify API
- 6.24 cloudBackupScheduleVolumeAddRemove API
- 6.25 cloudContainerAdd API
- 6.26 cloudContainerCreate API
- 6.27 cloudContainerDelete API
- 6.28 cloudContainerDisable API
- 6.29 cloudContainerEnable API
- 6.30 cloudContainerEnum API
- 6.31 cloudContainerGet API
- 6.32 cloudContainerModify API
- 6.33 cloudContainerRemove API
- 6.34 cloudContainerRepair API
- 6.35 cloudProviderCredentialsAdd API
- 6.36 cloudProviderCredentialsEnum API
- 6.37 cloudProviderCredentialsGet API
- 6.38 cloudProviderCredentialsRemove API
- 6.39 cloudProviderEnum API
- 6.40 cloudProviderGet API
- 6.41 cloudProviderLocationAdd API
- 6.42 cloudProviderLocationEnum API
- 6.43 cloudProviderLocationGet API
- 6.44 cloudProviderLocationRemove API
- 6.45 clusterFailoverGroupActivate API
- 6.46 clusterFailoverGroupCreate API
- 6.47 clusterFailoverGroupDelete API
- 6.48 clusterFailoverGroupEnum API
- 6.49 clusterFailoverGroupGet API
- 6.50 clusterFailoverGroupModify API
- 6.51 customApi API
- 6.52 echo API
- 6.53 eventEnum API
- 6.54 eventListenerNotify API
- 6.55 eventListenerRegister API
- 6.56 eventListenerUnregister API
- 6.57 fcTargetPortDisable API
- 6.58 fcTargetPortEnable API
- 6.59 fcTargetPortEnum API
- 6.60 fcTargetPortGet API
- 6.61 getHardwareConfig API
- 6.62 getLocalizedMessage API
- 6.63 getSecurityConfig API
- 6.64 getSystemConfig API
- 6.65 hostAdd API
- 6.66 hostEnum API
- 6.67 hostGet API
- 6.68 hostGroupCreate API
- 6.69 hostGroupDelete API
- 6.70 hostGroupEnum API
- 6.71 hostGroupGet API
- 6.72 hostGroupHostAddRemove API
- 6.73 hostGroupModify API
- 6.74 hostInitiatorAdd API
- 6.75 hostInitiatorEnum API
- 6.76 hostInitiatorGet API
- 6.77 hostInitiatorRemove API
- 6.78 hostModify API
- 6.79 hostRemove API
- 6.80 hwAlarmEnum API
- 6.81 hwAlarmGet API
- 6.82 hwBatteryBackupUnitEnum API
- 6.83 hwBatteryBackupUnitGet API
- 6.84 hwControllerClearAlarms API
- 6.85 hwControllerEnum API
- 6.86 hwControllerGet API
- 6.87 hwControllerGroupEnum API
- 6.88 hwControllerGroupGet API
- 6.89 hwControllerImportForeignUnits API
- 6.90 hwControllerRescan API
- 6.91 hwControllerRescanAll API
- 6.92 hwControllerSilenceAlarms API
- 6.93 hwDiskEnum API
- 6.94 hwDiskGet API
- 6.95 hwDiskIdentify API
- 6.96 hwDiskMarkHotSpare API
- 6.97 hwDiskRemove API
- 6.98 hwEnclosureEnum API
- 6.99 hwEnclosureGet API
- 6.100 hwLogicalDriveEnum API
- 6.101 hwLogicalDriveGet API
- 6.102 hwSwitchAdapterEnum API
- 6.103 hwSwitchAdapterGet API
- 6.104 hwSwitchCredentialsAdd API
- 6.105 hwSwitchCredentialsEnum API
- 6.106 hwSwitchCredentialsGet API
- 6.107 hwSwitchCredentialsModify API
- 6.108 hwSwitchCredentialsRemove API
- 6.109 hwSwitchEnum API
- 6.110 hwSwitchFailoverGroupActivate API
- 6.111 hwSwitchFailoverGroupCreate API
- 6.112 hwSwitchFailoverGroupDelete API
- 6.113 hwSwitchFailoverGroupEnum API
- 6.114 hwSwitchFailoverGroupGet API
- 6.115 hwSwitchFailoverGroupModify API
- 6.116 hwSwitchFailoverGroupPoolAssocEnum API
- 6.117 hwSwitchFailoverGroupPoolAssocGet API
- 6.118 hwSwitchFailoverGroupSetMode API
- 6.119 hwSwitchFailoverGroupSystemAssocAdd API
- 6.120 hwSwitchFailoverGroupSystemAssocEnum API
- 6.121 hwSwitchFailoverGroupSystemAssocGet API
- 6.122 hwSwitchFailoverGroupSystemAssocRemove API
- 6.123 hwSwitchGet API
- 6.124 hwSwitchRescan API
- 6.125 hwSwitchZonesetActivate API
- 6.126 hwSwitchZonesetEnum API
- 6.127 hwSwitchZonesetGet API
- 6.128 hwUnitCreate API
- 6.129 hwUnitDelete API
- 6.130 hwUnitEnum API
- 6.131 hwUnitGet API
- 6.132 hwUnitGrow API
- 6.133 hwUnitIdentify API
- 6.134 hwUnitSsdCacheCreate API
- 6.135 hwUnitSsdCacheDisable API
- 6.136 hwUnitSsdCacheEnable API
- 6.137 ibTargetPortEnum API
- 6.138 ibTargetPortGet API
- 6.139 libratoMetricsConfigGet API
- 6.140 libratoMetricsConfigSet API
- 6.141 licenseActivate API
- 6.142 licenseActivateOnline API
- 6.143 licenseAdd API
- 6.144 licenseEnum API
- 6.145 licenseGet API
- 6.146 licenseRemove API
- 6.147 login API
- 6.148 networkShareClientAdd API
- 6.149 networkShareClientEnum API
- 6.150 networkShareClientGet API
- 6.151 networkShareClientModify API
- 6.152 networkShareClientRemove API
- 6.153 networkShareClone API
- 6.154 networkShareCreate API
- 6.155 networkShareDelete API
- 6.156 networkShareDisable API
- 6.157 networkShareEnable API
- 6.158 networkShareEnum API
- 6.159 networkShareGet API
- 6.160 networkShareModify API
- 6.161 networkShareNfsConfig API
- 6.162 networkShareRestore API
- 6.163 networkShareServicesRestart API
- 6.164 networkShareSnapshot API
- 6.165 objectEnum API
- 6.166 objectGet API
- 6.167 objectLock API
- 6.168 objectPropertyGet API
- 6.169 objectPropertySet API
- 6.170 objectUnlock API
- 6.171 permissionDefinitionEnum API
- 6.172 physicalDiskEnum API
- 6.173 physicalDiskGet API
- 6.174 physicalDiskIdentify API
- 6.175 physicalDiskPathAssocEnum API
- 6.176 physicalDiskPathAssocGet API
- 6.177 physicalDiskScan API
- 6.178 registerSecurityToken API
- 6.179 remoteStoragePoolEnum API
- 6.180 replicaAssocDelete API
- 6.181 replicaAssocEnum API
- 6.182 replicaAssocGet API
- 6.183 replicaAssocUpdate API
- 6.184 replicaCreate API
- 6.185 replicaCreateNetworkShareTarget API
- 6.186 replicaCreateVolumeTarget API
- 6.187 replicaStop API
- 6.188 replicaSync API
- 6.189 replicationScheduleAddRemove API
- 6.190 replicationScheduleAssocEnum API
- 6.191 replicationScheduleAssocGet API
- 6.192 replicationScheduleCreate API
- 6.193 replicationScheduleDelete API
- 6.194 replicationScheduleDisable API
- 6.195 replicationScheduleEnable API
- 6.196 replicationScheduleEnum API
- 6.197 replicationScheduleGet API
- 6.198 replicationScheduleModify API
- 6.199 roleCreate API
- 6.200 roleDelete API
- 6.201 roleEnum API
- 6.202 roleGet API
- 6.203 roleModify API
- 6.204 rolePermissionAssignmentEnum API
- 6.205 rolePermissionAssignmentGet API
- 6.206 rolePermissionsAddRemove API
- 6.207 roleSubjectAssocEnum API
- 6.208 roleSubjectAssocGet API
- 6.209 sessionClose API
- 6.210 sessionEnum API
- 6.211 sessionGet API
- 6.212 siteAssocEnum API
- 6.213 siteAssocGet API
- 6.214 siteCreate API
- 6.215 siteDelete API
- 6.216 siteEnum API
- 6.217 siteGet API
- 6.218 siteModify API
- 6.219 siteStorageSystemAddRemove API
- 6.220 snapshotScheduleAssocEnum API
- 6.221 snapshotScheduleAssocGet API
- 6.222 snapshotScheduleCreate API
- 6.223 snapshotScheduleDelete API
- 6.224 snapshotScheduleDisable API
- 6.225 snapshotScheduleEnable API
- 6.226 snapshotScheduleEnum API
- 6.227 snapshotScheduleGet API
- 6.228 snapshotScheduleModify API
- 6.229 snapshotScheduleVolumeAddRemove API
- 6.230 storageCloudCreate API
- 6.231 storageCloudDelete API
- 6.232 storageCloudEnum API
- 6.233 storageCloudGet API
- 6.234 storageCloudModify API
- 6.235 storageCloudResourceAddRemove API
- 6.236 storageCloudResourceAssocEnum API
- 6.237 storageCloudResourceAssocGet API
- 6.238 storageCloudResourceSetMode API
- 6.239 storageCloudSubjectAssocEnum API
- 6.240 storageCloudSubjectAssocGet API
- 6.241 storageCloudUserAddRemove API
- 6.242 storagePoolCreate API
- 6.243 storagePoolDestroy API
- 6.244 storagePoolDeviceEnum API
- 6.245 storagePoolDeviceGet API
- 6.246 storagePoolEnum API
- 6.247 storagePoolExpand API
- 6.248 storagePoolExport API
- 6.249 storagePoolGet API
- 6.250 storagePoolGrow API
- 6.251 storagePoolIdentify API
- 6.252 storagePoolModify API
- 6.253 storagePoolProfileEnum API
- 6.254 storagePoolProfileGet API
- 6.255 storagePoolReplicationConfigCreate API
- 6.256 storagePoolReplicationConfigDelete API
- 6.257 storagePoolReplicationConfigEnum API
- 6.258 storagePoolReplicationConfigGet API
- 6.259 storagePoolReplicationConfigModify API
- 6.260 storagePoolRescan API
- 6.261 storagePoolSpareAddRemove API
- 6.262 storagePoolStart API
- 6.263 storagePoolStop API
- 6.264 storagePoolUpdateRedirect API
- 6.265 storageQuotaCreate API
- 6.266 storageQuotaDelete API
- 6.267 storageQuotaEnum API
- 6.268 storageQuotaGet API
- 6.269 storageQuotaModify API
- 6.270 storageQuotaShareAddRemove API
- 6.271 storageQuotaShareAssocEnum API
- 6.272 storageQuotaShareAssocGet API
- 6.273 storageQuotaVolumeAddRemove API
- 6.274 storageQuotaVolumeAssocEnum API
- 6.275 storageQuotaVolumeAssocGet API
- 6.276 storageSystemClusterAssocEnum API
- 6.277 storageSystemClusterAssocGet API
- 6.278 storageSystemClusterCreate API
- 6.279 storageSystemClusterDelete API
- 6.280 storageSystemClusterEnum API
- 6.281 storageSystemClusterGet API
- 6.282 storageSystemClusterModify API
- 6.283 storageSystemClusterNodeAdd API
- 6.284 storageSystemClusterNodeEject API
- 6.285 storageSystemClusterNodeJoin API
- 6.286 storageSystemClusterNodeRemove API
- 6.287 storageSystemClusterNodeSetMaster API
- 6.288 storageSystemClusterNodeSync API
- 6.289 storageSystemEnum API
- 6.290 storageSystemGet API
- 6.291 storageSystemGroupAddRemoveLinks API
- 6.292 storageSystemGroupAssocEnum API
- 6.293 storageSystemGroupAssocGet API
- 6.294 storageSystemGroupCreate API
- 6.295 storageSystemGroupDelete API
- 6.296 storageSystemGroupEnum API
- 6.297 storageSystemGroupGet API
- 6.298 storageSystemGroupModify API
- 6.299 storageSystemGroupSetPassword API
- 6.300 storageSystemLinkCreate API
- 6.301 storageSystemLinkDelete API
- 6.302 storageSystemLinkDisconnect API
- 6.303 storageSystemLinkEnum API
- 6.304 storageSystemLinkEstablish API
- 6.305 storageSystemLinkGet API
- 6.306 storageSystemLinkModify API
- 6.307 storageSystemLinkRefresh API
- 6.308 storageSystemLinkSetCredentials API
- 6.309 storageSystemLinkVerify API
- 6.310 storageSystemModify API
- 6.311 storageSystemRecover API
- 6.312 storageSystemRecoveryPointEnum API
- 6.313 storageSystemRestart API
- 6.314 storageSystemSendLogs API
- 6.315 storageSystemShutdown API
- 6.316 storageSystemUpdateCheck API
- 6.317 storageSystemUpgrade API
- 6.318 storageVolumeAclAddRemove API
- 6.319 storageVolumeAclAddRemoveEx API
- 6.320 storageVolumeAclEnum API
- 6.321 storageVolumeAclGet API
- 6.322 storageVolumeClone API
- 6.323 storageVolumeCloudBackupCreate API
- 6.324 storageVolumeCloudBackupRestore API
- 6.325 storageVolumeCreate API
- 6.326 storageVolumeCreateEx API
- 6.327 storageVolumeDelete API
- 6.328 storageVolumeEnum API
- 6.329 storageVolumeGet API
- 6.330 storageVolumeGroupAssocEnum API
- 6.331 storageVolumeGroupAssocGet API
- 6.332 storageVolumeGroupClone API
- 6.333 storageVolumeGroupCreate API
- 6.334 storageVolumeGroupDelete API
- 6.335 storageVolumeGroupEnum API
- 6.336 storageVolumeGroupGet API
- 6.337 storageVolumeGroupModify API
- 6.338 storageVolumeGroupSnapshot API
- 6.339 storageVolumeGroupVolumeAddRemove API
- 6.340 storageVolumeModify API
- 6.341 storageVolumeResize API
- 6.342 storageVolumeRestore API
- 6.343 storageVolumeSnapshot API
- 6.344 storageVolumeUtilizationEnum API
- 6.345 storageVolumeUtilizationGet API
- 6.346 storageVolumeUtilizationGetRetentionPeriod API
- 6.347 storageVolumeUtilizationSetRetentionPeriod API
- 6.348 targetPortDisable API
- 6.349 targetPortEnable API
- 6.350 targetPortEnum API
- 6.351 targetPortGet API
- 6.352 targetPortModify API
- 6.353 targetPortRescan API
- 6.354 targetPortRestart API
- 6.355 targetVirtualInterfaceCreate API
- 6.356 targetVirtualInterfaceMove API
- 6.357 targetVirtualPortCreate API
- 6.358 targetVirtualPortDelete API
- 6.359 taskCancel API
- 6.360 taskClearAll API
- 6.361 taskEnum API
- 6.362 taskGet API
- 6.363 userAdd API
- 6.364 userEnum API
- 6.365 userGet API
- 6.366 userGroupAssocEnum API
- 6.367 userGroupAssocGet API
- 6.368 userGroupCreate API
- 6.369 userGroupDelete API
- 6.370 userGroupEnum API
- 6.371 userGroupGet API
- 6.372 userGroupModify API
- 6.373 userGroupUserAddRemove API
- 6.374 userModify API
- 6.375 userPasswordSet API
- 6.376 userRemove API
- 6.377 virtualInterfaceAssocEnum API
- 6.378 virtualInterfaceAssocGet API
- 6.379 widgetCreate API
Supported Languages
You can use just about any programming language you like to communicate with QuantaStor via our RESTful API. Recommended tools:
- C/C++ - libcurl [1]
- Python - PyCurl [2]
- Unix/Linux/VMware/XenServer scripting - curl [3]
- PHP curl - [4]
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
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/. 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
Supported SOAP / WebServices Implementations
- gSOAP (C++, all platforms)
- Apache Axis (Java, all platforms)
- .NET (C# & Visual Basic, Windows)
API List
aclAdd API
Example
Argument List
objectId: <xs:string> ownerType: <xs:unsignedInt> flags: <xs:unsignedInt> ownerId: <xs:string> accessLevel: <xs:unsignedInt> objectType: <xs:unsignedInt>
aclModify API
Example
Argument List
objectId: <xs:string> ownerType: <xs:unsignedInt> flags: <xs:unsignedInt> ownerId: <xs:string> accessLevel: <xs:unsignedInt> objectType: <xs:unsignedInt>
aclRemove API
Example
Argument List
ownerId: <xs:string> ownerType: <xs:unsignedInt> flags: <xs:unsignedInt> objectId: <xs:string> objectType: <xs:unsignedInt>
alertClear API
Example
Argument List
flags: <xs:unsignedInt> id: <xs:string>
alertClearAll API
Example
Argument List
flags: <xs:unsignedInt>
alertConfigGet API
Example
Argument List
flags: <xs:unsignedInt>
alertConfigSet API
Example
Argument List
smtpServerIpAddress: <xs:string> smtpPassword: <xs:string> poolFreeSpaceCriticalAlertThreshold: <xs:unsignedInt> poolFreeSpaceAlertThreshold: <xs:unsignedInt> poolFreeSpaceWarningThreshold: <xs:unsignedInt> senderEmailAddress: <xs:string> customerSupportEmailAddress: <xs:string> flags: <xs:unsignedInt> pagerDutyServiceKey: <xs:string> smtpUsername: <xs:string> smtpAuthType: <xs:unsignedInt>
alertEnum API
Example
Argument List
flags: <xs:unsignedInt>
alertGet API
Example
Argument List
flags: <xs:unsignedInt> id: <xs:string>
alertRaise API
Example
Argument List
message: <xs:string> flags: <xs:unsignedInt> severity: <xs:unsignedInt>
auditLogClear API
Example
Argument List
flags: <xs:unsignedInt>
auditLogDisable API
Example
Argument List
flags: <xs:unsignedInt>
auditLogEnable API
Example
Argument List
flags: <xs:unsignedInt>
auditLogGet API
Example
Argument List
startDate: <xs:dateTime> endDate: <xs:dateTime> user: <xs:string> flags: <xs:unsignedInt>
cloudBackupScheduleAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
cloudBackupScheduleAssocGet API
Example
Argument List
scheduleId: <xs:string> storageVolumeId: <xs:string>
cloudBackupScheduleCreate API
Example
Argument List
storageVolumeList: <xs:string[]> setEnabled: <xs:unsignedInt> name: <xs:string> startDate: <xs:dateTime> hoursOfDay: <xs:unsignedInt> daysOfWeek: <xs:unsignedInt> maxBackups: <xs:unsignedInt> priority: <xs:unsignedInt> cloudContainerId: <xs:string> flags: <xs:unsignedInt> description: <xs:string>
cloudBackupScheduleDelete API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
cloudBackupScheduleDisable API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
cloudBackupScheduleEnable API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
cloudBackupScheduleEnum API
Example
Argument List
flags: <xs:unsignedInt>
cloudBackupScheduleGet API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
cloudBackupScheduleModify API
Example
Argument List
setEnabled: <xs:unsignedInt> description: <xs:string> startDate: <xs:dateTime> hoursOfDay: <xs:unsignedInt> schedule: <xs:string> daysOfWeek: <xs:unsignedInt> maxBackups: <xs:unsignedInt> cloudContainerId: <xs:string> flags: <xs:unsignedInt> name: <xs:string>
cloudBackupScheduleVolumeAddRemove API
Example
Argument List
storageVolumeList: <xs:string[]> modType: <xs:unsignedInt> flags: <xs:unsignedInt> schedule: <xs:string>
cloudContainerAdd API
Example
Argument List
storageUrl: <xs:string> flags: <xs:unsignedInt> enableNfs: <xs:boolean> credentialsId: <xs:string> locationId: <xs:string> encryptionKey: <xs:string>
cloudContainerCreate API
Example
Argument List
name: <xs:string> storageUrl: <xs:string> flags: <xs:unsignedInt> locationId: <xs:string> enableNfs: <xs:boolean> credentialsId: <xs:string> encryptionKey: <xs:string> description: <xs:string>
cloudContainerDelete API
Example
Argument List
flags: <xs:unsignedInt> container: <xs:string>
cloudContainerDisable API
Example
Argument List
flags: <xs:unsignedInt> container: <xs:string>
cloudContainerEnable API
Example
Argument List
flags: <xs:unsignedInt> container: <xs:string>
cloudContainerEnum API
Example
Argument List
flags: <xs:unsignedInt>
cloudContainerGet API
Example
Argument List
flags: <xs:unsignedInt> container: <xs:string>
cloudContainerModify API
Example
Argument List
container: <xs:string> name: <xs:string> flags: <xs:unsignedInt> enableNfs: <xs:boolean> encryptionKey: <xs:string> description: <xs:string>
cloudContainerRemove API
Example
Argument List
flags: <xs:unsignedInt> container: <xs:string>
cloudContainerRepair API
Example
Argument List
flags: <xs:unsignedInt> container: <xs:string>
cloudProviderCredentialsAdd API
Example
Argument List
username: <xs:string> machine: <xs:string> providerId: <xs:string> password: <xs:string> flags: <xs:unsignedInt>
cloudProviderCredentialsEnum API
Example
Argument List
flags: <xs:unsignedInt>
cloudProviderCredentialsGet API
Example
Argument List
credentialId: <xs:string> flags: <xs:unsignedInt>
cloudProviderCredentialsRemove API
Example
Argument List
flags: <xs:unsignedInt> credentialsId: <xs:string>
cloudProviderEnum API
Example
Argument List
flags: <xs:unsignedInt>
cloudProviderGet API
Example
Argument List
providerId: <xs:string> flags: <xs:unsignedInt>
cloudProviderLocationAdd API
Example
Argument List
flags: <xs:unsignedInt> providerId: <xs:string> locationTag: <xs:string>
cloudProviderLocationEnum API
Example
Argument List
flags: <xs:unsignedInt>
cloudProviderLocationGet API
Example
Argument List
flags: <xs:unsignedInt> locationId: <xs:string>
cloudProviderLocationRemove API
Example
Argument List
flags: <xs:unsignedInt> locationId: <xs:string>
clusterFailoverGroupActivate API
Example
Argument List
storageSystemId: <xs:string> flags: <xs:unsignedInt> clusterFailoverGroup: <xs:string>
clusterFailoverGroupCreate API
Example
Argument List
storageSystemCluster: <xs:string> name: <xs:string> zoneConfig: <xs:string> flags: <xs:unsignedInt> storagePool: <xs:string> description: <xs:string>
clusterFailoverGroupDelete API
Example
Argument List
flags: <xs:unsignedInt> clusterFailoverGroup: <xs:string>
clusterFailoverGroupEnum API
Example
Argument List
flags: <xs:unsignedInt>
clusterFailoverGroupGet API
Example
Argument List
flags: <xs:unsignedInt> clusterFailoverGroup: <xs:string>
clusterFailoverGroupModify API
Example
Argument List
description: <xs:string> zoneConfig: <xs:string> flags: <xs:unsignedInt> clusterFailoverGroup: <xs:string> storagePool: <xs:string> name: <xs:string>
customApi API
Example
Argument List
flags: <xs:unsignedInt> params: <ns0:keyValuePair[]> method: <xs:string>
echo API
Example
Argument List
inputMessage: <xs:string>
eventEnum API
Example
Argument List
maxEvents: <xs:unsignedInt> serviceTimeStamp: <xs:dateTime> startingIndex: <xs:unsignedInt>
eventListenerNotify API
Example
Argument List
storageSystemId: <xs:string> list: <ns0:event[]>
eventListenerRegister API
Example
Argument List
eventListenerObj: <ns0:eventListener>
eventListenerUnregister API
Example
Argument List
listenerId: <xs:string>
fcTargetPortDisable API
Example
Argument List
flags: <xs:unsignedInt> port: <xs:string>
fcTargetPortEnable API
Example
Argument List
flags: <xs:unsignedInt> port: <xs:string>
fcTargetPortEnum API
Example
Argument List
flags: <xs:unsignedInt>
fcTargetPortGet API
Example
Argument List
flags: <xs:unsignedInt> port: <xs:string>
getHardwareConfig API
Example
Argument List
flags: <xs:unsignedInt>
getLocalizedMessage API
Example
Argument List
locale: <xs:string> flags: <xs:unsignedInt> i18nStr: <ns0:i18nString>
getSecurityConfig API
Example
Argument List
storageSystemId: <xs:string> flags: <xs:unsignedInt>
getSystemConfig API
Example
Argument List
storageSystemId: <xs:string> flags: <xs:unsignedInt>
hostAdd API
Example
Argument List
username: <xs:string> description: <xs:string> hostname: <xs:string> hostType: <xs:unsignedInt> iqn: <xs:string> flags: <xs:unsignedInt> password: <xs:string> ipAddress: <xs:string>
hostEnum API
Example
Argument List
flags: <xs:unsignedInt>
hostGet API
Example
Argument List
host: <xs:string> flags: <xs:unsignedInt>
hostGroupCreate API
Example
Argument List
hostList: <xs:string[]> flags: <xs:unsignedInt> name: <xs:string> description: <xs:string>
hostGroupDelete API
Example
Argument List
host: <xs:string> flags: <xs:unsignedInt> deleteAssociatedHosts: <xs:boolean>
hostGroupEnum API
Example
Argument List
flags: <xs:unsignedInt>
hostGroupGet API
Example
Argument List
flags: <xs:unsignedInt> hostGroup: <xs:string>
hostGroupHostAddRemove API
Example
Argument List
hostList: <xs:string[]> modType: <xs:unsignedInt> flags: <xs:unsignedInt> hostGroup: <xs:string>
hostGroupModify API
Example
Argument List
newName: <xs:string> flags: <xs:unsignedInt> newDescription: <xs:string> hostGroup: <xs:string>
hostInitiatorAdd API
Example
Argument List
host: <xs:string> iqn: <xs:string> flags: <xs:unsignedInt>
hostInitiatorEnum API
Example
Argument List
host: <xs:string> flags: <xs:unsignedInt>
hostInitiatorGet API
Example
Argument List
initiator: <xs:string> flags: <xs:unsignedInt>
hostInitiatorRemove API
Example
Argument List
host: <xs:string> iqn: <xs:string> flags: <xs:unsignedInt>
hostModify API
Example
Argument List
newIpAddress: <xs:string> newUsername: <xs:string> newPassword: <xs:string> newHostType: <xs:unsignedInt> host: <xs:string> flags: <xs:unsignedInt> newDescription: <xs:string>
hostRemove API
Example
Argument List
host: <xs:string> flags: <xs:unsignedInt>
hwAlarmEnum API
Example
Argument List
flags: <xs:unsignedInt> hwController: <xs:string>
hwAlarmGet API
Example
Argument List
hwAlarm: <xs:string> flags: <xs:unsignedInt>
hwBatteryBackupUnitEnum API
Example
Argument List
flags: <xs:unsignedInt> hwController: <xs:string>
hwBatteryBackupUnitGet API
Example
Argument List
hwBatteryBackupUnit: <xs:string> flags: <xs:unsignedInt>
hwControllerClearAlarms API
Example
Argument List
controllerId: <xs:string> flags: <xs:unsignedInt>
hwControllerEnum API
Example
Argument List
hwControllerGroup: <xs:string> flags: <xs:unsignedInt>
hwControllerGet API
Example
Argument List
flags: <xs:unsignedInt> hwController: <xs:string>
hwControllerGroupEnum API
Example
Argument List
flags: <xs:unsignedInt>
hwControllerGroupGet API
Example
Argument List
hwControllerGroup: <xs:string> flags: <xs:unsignedInt>
hwControllerImportForeignUnits API
Example
Argument List
controllerId: <xs:string> flags: <xs:unsignedInt>
hwControllerRescan API
Example
Argument List
controllerId: <xs:string> flags: <xs:unsignedInt>
hwControllerRescanAll API
Example
Argument List
storageSystemId: <xs:string> flags: <xs:unsignedInt>
hwControllerSilenceAlarms API
Example
Argument List
controllerId: <xs:string> flags: <xs:unsignedInt>
hwDiskEnum API
Example
Argument List
flags: <xs:unsignedInt> hwController: <xs:string>
hwDiskGet API
Example
Argument List
hwDisk: <xs:string> flags: <xs:unsignedInt>
hwDiskIdentify API
Example
Argument List
flags: <xs:unsignedInt> durationInSeconds: <xs:unsignedInt> diskId: <xs:string>
hwDiskMarkHotSpare API
Example
Argument List
clearMark: <xs:boolean> flags: <xs:unsignedInt> diskId: <xs:string>
hwDiskRemove API
Example
Argument List
flags: <xs:unsignedInt> diskId: <xs:string>
hwEnclosureEnum API
Example
Argument List
flags: <xs:unsignedInt> hwController: <xs:string>
hwEnclosureGet API
Example
Argument List
hwEnclosure: <xs:string> flags: <xs:unsignedInt>
hwLogicalDriveEnum API
Example
Argument List
hwUnit: <xs:string> flags: <xs:unsignedInt>
hwLogicalDriveGet API
Example
Argument List
hwLogicalDrive: <xs:string> flags: <xs:unsignedInt>
hwSwitchAdapterEnum API
Example
Argument List
flags: <xs:unsignedInt>
hwSwitchAdapterGet API
Example
Argument List
flags: <xs:unsignedInt> switchAdapterId: <xs:string>
hwSwitchCredentialsAdd API
Example
Argument List
username: <xs:string> domainPassword: <xs:string> primaryStorageSystem: <xs:string> secondaryStorageSystem: <xs:string> switchAdapterId: <xs:string> switchType: <xs:unsignedInt> managementProtocol: <xs:unsignedInt> flags: <xs:unsignedInt> password: <xs:string> ipAddress: <xs:string>
hwSwitchCredentialsEnum API
Example
Argument List
flags: <xs:unsignedInt> switchAdapterId: <xs:string>
hwSwitchCredentialsGet API
Example
Argument List
flags: <xs:unsignedInt> switchCredentials: <xs:string>
hwSwitchCredentialsModify API
Example
Argument List
domainPassword: <xs:string> flags: <xs:unsignedInt> primaryStorageSystem: <xs:string> credentialsId: <xs:string> secondaryStorageSystem: <xs:string> password: <xs:string>
hwSwitchCredentialsRemove API
Example
Argument List
credsId: <xs:string> flags: <xs:unsignedInt>
hwSwitchEnum API
Example
Argument List
flags: <xs:unsignedInt> switchAdapterId: <xs:string>
hwSwitchFailoverGroupActivate API
Example
Argument List
storageSystemId: <xs:string> hwSwitchFailoverGroup: <xs:string> flags: <xs:unsignedInt>
hwSwitchFailoverGroupCreate API
Example
Argument List
primaryStorageSystemId: <xs:string> name: <xs:string> secondaryStorageSystemId: <xs:string> virtualHostSubnet: <xs:string> storagePoolList: <xs:string[]> secondaryZonesetId: <xs:string> virtualHostIpAddress: <xs:string> virtualHostGateway: <xs:string> flags: <xs:unsignedInt> primaryZonesetId: <xs:string> description: <xs:string>
hwSwitchFailoverGroupDelete API
Example
Argument List
hwSwitchFailoverGroup: <xs:string> flags: <xs:unsignedInt>
hwSwitchFailoverGroupEnum API
Example
Argument List
flags: <xs:unsignedInt>
hwSwitchFailoverGroupGet API
Example
Argument List
hwSwitchFailoverGroupId: <xs:string> flags: <xs:unsignedInt>
hwSwitchFailoverGroupModify API
Example
Argument List
primaryStorageSystemId: <xs:string> name: <xs:string> primaryZonesetId: <xs:string> secondaryStorageSystemId: <xs:string> virtualHostSubnet: <xs:string> storagePoolList: <xs:string[]> secondaryZonesetId: <xs:string> virtualHostIpAddress: <xs:string> virtualHostGateway: <xs:string> flags: <xs:unsignedInt> hwSwitchFailoverGroup: <xs:string> description: <xs:string>
hwSwitchFailoverGroupPoolAssocEnum API
Example
Argument List
hwSwitchFailoverGroup: <xs:string> flags: <xs:unsignedInt>
hwSwitchFailoverGroupPoolAssocGet API
Example
Argument List
hwSwitchFailoverGroupId: <xs:string> storagePoolId: <xs:string> flags: <xs:unsignedInt>
hwSwitchFailoverGroupSetMode API
Example
Argument List
hwSwitchFailoverGroup: <xs:string> flags: <xs:unsignedInt> failoverMode: <xs:unsignedInt>
hwSwitchFailoverGroupSystemAssocAdd API
Example
Argument List
storageSystemId: <xs:string> zonesetId: <xs:string> hwSwitchFailoverGroup: <xs:string> flags: <xs:unsignedInt>
hwSwitchFailoverGroupSystemAssocEnum API
Example
Argument List
hwSwitchFailoverGroup: <xs:string> flags: <xs:unsignedInt>
hwSwitchFailoverGroupSystemAssocGet API
Example
Argument List
storageSystemId: <xs:string> hwSwitchFailoverGroupId: <xs:string> flags: <xs:unsignedInt>
hwSwitchFailoverGroupSystemAssocRemove API
Example
Argument List
storageSystemId: <xs:string> hwSwitchFailoverGroup: <xs:string> flags: <xs:unsignedInt>
hwSwitchGet API
Example
Argument List
switchId: <xs:string> flags: <xs:unsignedInt>
hwSwitchRescan API
Example
Argument List
switchId: <xs:string> flags: <xs:unsignedInt>
hwSwitchZonesetActivate API
Example
Argument List
zonesetId: <xs:string> flags: <xs:unsignedInt> switchCredentialsId: <xs:string>
hwSwitchZonesetEnum API
Example
Argument List
flags: <xs:unsignedInt> switchCredentialsId: <xs:string>
hwSwitchZonesetGet API
Example
Argument List
switchZoneset: <xs:string> flags: <xs:unsignedInt>
hwUnitCreate API
Example
Argument List
raidType: <xs:unsignedInt> diskList: <xs:string[]> controllerId: <xs:string> flags: <xs:unsignedInt>
hwUnitDelete API
Example
Argument List
flags: <xs:unsignedInt> unitId: <xs:string>
hwUnitEnum API
Example
Argument List
flags: <xs:unsignedInt> hwController: <xs:string>
hwUnitGet API
Example
Argument List
hwUnit: <xs:string> flags: <xs:unsignedInt>
hwUnitGrow API
Example
Argument List
diskList: <xs:string[]> flags: <xs:unsignedInt> stripeSizeKb: <xs:unsignedInt> initPriority: <xs:unsignedInt> unitId: <xs:string>
hwUnitIdentify API
Example
Argument List
flags: <xs:unsignedInt> durationInSeconds: <xs:unsignedInt> unitId: <xs:string>
hwUnitSsdCacheCreate API
Example
Argument List
raidType: <xs:unsignedInt> ssdDiskList: <xs:string[]> controllerId: <xs:string> flags: <xs:unsignedInt>
hwUnitSsdCacheDisable API
Example
Argument List
flags: <xs:unsignedInt> unitId: <xs:string>
hwUnitSsdCacheEnable API
Example
Argument List
unitSsdCacheId: <xs:string> flags: <xs:unsignedInt> unitId: <xs:string>
ibTargetPortEnum API
Example
Argument List
flags: <xs:unsignedInt>
ibTargetPortGet API
Example
Argument List
flags: <xs:unsignedInt> port: <xs:string>
libratoMetricsConfigGet API
Example
Argument List
flags: <xs:unsignedInt> storageSystem: <xs:string>
libratoMetricsConfigSet API
Example
Argument List
username: <xs:string> enableAlertAnnotations: <xs:boolean> storageSystem: <xs:string> postIntervalSec: <xs:unsignedInt> token: <xs:string> enableConfigAnnotations: <xs:boolean> autoDashboardCreate: <xs:boolean> flags: <xs:unsignedInt>
licenseActivate API
Example
Argument List
activationKey: <xs:string> flags: <xs:unsignedInt>
licenseActivateOnline API
Example
Argument List
flags: <xs:unsignedInt> licenseKey: <xs:string>
licenseAdd API
Example
Argument List
keyBlock: <xs:string> flags: <xs:unsignedInt> storageSystem: <xs:string>
licenseEnum API
Example
Argument List
flags: <xs:unsignedInt>
licenseGet API
Example
Argument List
flags: <xs:unsignedInt> license: <xs:string>
licenseRemove API
Example
Argument List
flags: <xs:unsignedInt> license: <xs:string>
login API
Example
Argument List
reserved: <xs:string>
Example
Argument List
secure: <xs:boolean> subtreeCheck: <xs:boolean> clientFilter: <xs:string> readOnly: <xs:boolean> flags: <xs:unsignedInt> networkShareId: <xs:string> customOptions: <xs:string> async: <xs:boolean>
Example
Argument List
networkShare: <xs:string> flags: <xs:unsignedInt>
Example
Argument List
flags: <xs:unsignedInt> networkShareClientId: <xs:string> networkShareId: <xs:string>
Example
Argument List
secure: <xs:boolean> subtreeCheck: <xs:boolean> networkShareClientId: <xs:string> readOnly: <xs:boolean> flags: <xs:unsignedInt> networkShareId: <xs:string> customOptions: <xs:string> async: <xs:boolean>
Example
Argument List
flags: <xs:unsignedInt> networkShareClientId: <xs:string> networkShareId: <xs:string>
Example
Argument List
description: <xs:string> readOnly: <xs:boolean> networkShare: <xs:string> flags: <xs:unsignedInt> cloneName: <xs:string> provisionableId: <xs:string> isActive: <xs:boolean>
Example
Argument List
name: <xs:string> isPublic: <xs:boolean> flags: <xs:unsignedInt> provisionableId: <xs:string> isActive: <xs:boolean> description: <xs:string>
Example
Argument List
flags: <xs:unsignedInt> networkShareId: <xs:string>
Example
Argument List
networkShare: <xs:string> flags: <xs:unsignedInt>
Example
Argument List
networkShare: <xs:string> flags: <xs:unsignedInt>
Example
Argument List
flags: <xs:unsignedInt>
Example
Argument List
networkShare: <xs:string> flags: <xs:unsignedInt>
Example
Argument List
networkShare: <xs:string> flags: <xs:unsignedInt> name: <xs:string> isActive: <xs:boolean> description: <xs:string>
Example
Argument List
nfsMode: <xs:unsignedInt> reserved: <xs:string> enableKerberos: <xs:boolean> storageSystem: <xs:string> defaultOptions: <xs:string> flags: <xs:unsignedInt>
Example
Argument List
snapshotShare: <xs:string> networkShare: <xs:string> flags: <xs:unsignedInt>
Example
Argument List
flags: <xs:unsignedInt> storageSystem: <xs:string>
Example
Argument List
description: <xs:string> snapshotName: <xs:string> readOnly: <xs:boolean> networkShare: <xs:string> flags: <xs:unsignedInt> provisionableId: <xs:string> isActive: <xs:boolean>
objectEnum API
Example
Argument List
propValue: <xs:string> flags: <xs:unsignedInt> propType: <xs:unsignedInt> propKey: <xs:string>
objectGet API
Example
Argument List
flags: <xs:unsignedInt> id: <xs:string>
objectLock API
Example
Argument List
id: <xs:string>
objectPropertyGet API
Example
Argument List
flags: <xs:unsignedInt> objectId: <xs:string> propKey: <xs:string>
objectPropertySet API
Example
Argument List
propType: <xs:unsignedInt> propValue: <xs:string> flags: <xs:unsignedInt> objectId: <xs:string> propKey: <xs:string>
objectUnlock API
Example
Argument List
id: <xs:string>
permissionDefinitionEnum API
Example
Argument List
flags: <xs:unsignedInt>
physicalDiskEnum API
Example
Argument List
flags: <xs:unsignedInt> physicalDiskList: <xs:string[]>
physicalDiskGet API
Example
Argument List
physicalDrive: <xs:string> flags: <xs:unsignedInt>
physicalDiskIdentify API
Example
Argument List
physicalDrive: <xs:string> pattern: <xs:string> duration: <xs:unsignedInt> flags: <xs:unsignedInt>
physicalDiskPathAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> multipathDiskId: <xs:string>
physicalDiskPathAssocGet API
Example
Argument List
flags: <xs:unsignedInt> multipathDiskId: <xs:string> physicalDiskId: <xs:string>
physicalDiskScan API
Example
Argument List
storageSystemId: <xs:string> flags: <xs:unsignedInt>
registerSecurityToken API
Example
Argument List
flags: <xs:unsignedInt> token: <xs:string> signedToken: <xs:string>
remoteStoragePoolEnum API
Example
Argument List
remoteStorageSystemId: <xs:string> flags: <xs:unsignedInt>
replicaAssocDelete API
Example
Argument List
deleteReplicaAssocHead: <xs:boolean> flags: <xs:unsignedInt> assocId: <xs:string> deleteSourceReplicatable: <xs:boolean> deleteTargetReplicatable: <xs:boolean>
replicaAssocEnum API
Example
Argument List
replicatableId: <xs:string> targetsOnly: <xs:boolean> flags: <xs:unsignedInt> sourcesOnly: <xs:boolean>
replicaAssocGet API
Example
Argument List
flags: <xs:unsignedInt> assocId: <xs:string>
replicaAssocUpdate API
Example
Argument List
assocObj: <ns0:replicaAssoc> flags: <xs:unsignedInt>
replicaCreate API
Example
Argument List
replicaDescription: <xs:string> reserved: <xs:string> replicationPriority: <xs:unsignedInt> targetStoragePoolId: <xs:string> forcePrimary: <xs:boolean> replicatableId: <xs:string> smartSync: <xs:boolean> flags: <xs:unsignedInt> replicaName: <xs:string> storageSystemLinkId: <xs:string>
Example
Argument List
replicaDescription: <xs:string> sourceShare: <ns0:networkShare> reserved: <xs:string> replicationPriority: <xs:unsignedInt> sourceShareParent: <ns0:networkShare> targetStoragePoolId: <xs:string> forcePrimary: <xs:boolean> smartSync: <xs:boolean> flags: <xs:unsignedInt> replicaName: <xs:string>
replicaCreateVolumeTarget API
Example
Argument List
replicaDescription: <xs:string> reserved: <xs:string> replicationPriority: <xs:unsignedInt> targetStoragePoolId: <xs:string> forcePrimary: <xs:boolean> smartSync: <xs:boolean> flags: <xs:unsignedInt> replicaName: <xs:string> sourceVolumeParent: <ns0:storageVolume> sourceVolume: <ns0:storageVolume>
replicaStop API
Example
Argument List
flags: <xs:unsignedInt> assocId: <xs:string>
replicaSync API
Example
Argument List
flags: <xs:unsignedInt> assocId: <xs:string>
replicationScheduleAddRemove API
Example
Argument List
storageVolumeList: <xs:string[]> networkShareList: <xs:string[]> modType: <xs:unsignedInt> flags: <xs:unsignedInt> schedule: <xs:string>
replicationScheduleAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
replicationScheduleAssocGet API
Example
Argument List
replicatableId: <xs:string> scheduleId: <xs:string>
replicationScheduleCreate API
Example
Argument List
storageVolumeList: <xs:string[]> setEnabled: <xs:unsignedInt> name: <xs:string> targetProvisionableId: <xs:string> startDate: <xs:dateTime> targetStorageCloudId: <xs:string> storageCloudId: <xs:string> daysOfWeek: <xs:unsignedInt> priority: <xs:unsignedInt> networkShareList: <xs:string[]> flags: <xs:unsignedInt> storageSystemLinkId: <xs:string> hoursOfDay: <xs:unsignedInt> maxReplicas: <xs:unsignedInt> description: <xs:string>
replicationScheduleDelete API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
replicationScheduleDisable API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
replicationScheduleEnable API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
replicationScheduleEnum API
Example
Argument List
flags: <xs:unsignedInt>
replicationScheduleGet API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
replicationScheduleModify API
Example
Argument List
setEnabled: <xs:unsignedInt> description: <xs:string> startDate: <xs:dateTime> hoursOfDay: <xs:unsignedInt> storageCloudId: <xs:string> daysOfWeek: <xs:unsignedInt> schedule: <xs:string> flags: <xs:unsignedInt> maxReplicas: <xs:unsignedInt> name: <xs:string>
roleCreate API
Example
Argument List
flags: <xs:unsignedInt> permissionList: <ns0:permissionAssignment[]> inheritsFrom: <xs:string> name: <xs:string> description: <xs:string>
roleDelete API
Example
Argument List
flags: <xs:unsignedInt> role: <xs:string>
roleEnum API
Example
Argument List
flags: <xs:unsignedInt>
roleGet API
Example
Argument List
flags: <xs:unsignedInt> role: <xs:string>
roleModify API
Example
Argument List
newName: <xs:string> flags: <xs:unsignedInt> role: <xs:string> newDescription: <xs:string>
rolePermissionAssignmentEnum API
Example
Argument List
roleId: <xs:string> flags: <xs:unsignedInt>
rolePermissionAssignmentGet API
Example
Argument List
flags: <xs:unsignedInt> operation: <xs:string> role: <xs:string> objectType: <xs:string>
rolePermissionsAddRemove API
Example
Argument List
flags: <xs:unsignedInt> modType: <xs:unsignedInt> role: <xs:string> permissionList: <ns0:permissionAssignment[]>
roleSubjectAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> role: <xs:string>
roleSubjectAssocGet API
Example
Argument List
flags: <xs:unsignedInt> role: <xs:string> subject: <xs:string>
sessionClose API
Example
Argument List
sessionId: <xs:string> flags: <xs:unsignedInt>
sessionEnum API
Example
Argument List
flags: <xs:unsignedInt> host: <xs:string> storageVolume: <xs:string>
sessionGet API
Example
Argument List
sessionId: <xs:string> flags: <xs:unsignedInt>
siteAssocEnum API
Example
Argument List
flags: <xs:unsignedInt>
siteAssocGet API
Example
Argument List
storageSystemId: <xs:string> flags: <xs:unsignedInt> siteId: <xs:string>
siteCreate API
Example
Argument List
storageSystemList: <xs:string[]> location: <xs:string> flags: <xs:unsignedInt> name: <xs:string> description: <xs:string>
siteDelete API
Example
Argument List
flags: <xs:unsignedInt> site: <xs:string>
siteEnum API
Example
Argument List
flags: <xs:unsignedInt>
siteGet API
Example
Argument List
flags: <xs:unsignedInt> site: <xs:string>
siteModify API
Example
Argument List
flags: <xs:unsignedInt> location: <xs:string> siteId: <xs:string> name: <xs:string> description: <xs:string>
siteStorageSystemAddRemove API
Example
Argument List
storageSystemList: <xs:string[]> modType: <xs:unsignedInt> flags: <xs:unsignedInt> site: <xs:string>
snapshotScheduleAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
snapshotScheduleAssocGet API
Example
Argument List
scheduleId: <xs:string> storageVolumeId: <xs:string>
snapshotScheduleCreate API
Example
Argument List
storageVolumeList: <xs:string[]> setEnabled: <xs:unsignedInt> name: <xs:string> startDate: <xs:dateTime> hoursOfDay: <xs:unsignedInt> storageCloudId: <xs:string> daysOfWeek: <xs:unsignedInt> networkShareList: <xs:string[]> flags: <xs:unsignedInt> maxSnapshots: <xs:unsignedInt> description: <xs:string>
snapshotScheduleDelete API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
snapshotScheduleDisable API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
snapshotScheduleEnable API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
snapshotScheduleEnum API
Example
Argument List
flags: <xs:unsignedInt>
snapshotScheduleGet API
Example
Argument List
flags: <xs:unsignedInt> schedule: <xs:string>
snapshotScheduleModify API
Example
Argument List
setEnabled: <xs:unsignedInt> description: <xs:string> startDate: <xs:dateTime> hoursOfDay: <xs:unsignedInt> storageCloudId: <xs:string> daysOfWeek: <xs:unsignedInt> schedule: <xs:string> flags: <xs:unsignedInt> maxSnapshots: <xs:unsignedInt> name: <xs:string>
snapshotScheduleVolumeAddRemove API
Example
Argument List
storageVolumeList: <xs:string[]> networkShareList: <xs:string[]> modType: <xs:unsignedInt> flags: <xs:unsignedInt> schedule: <xs:string>
storageCloudCreate API
Example
Argument List
defaultChapPassword: <xs:string> tier: <xs:string> name: <xs:string> parentStorageCloudId: <xs:string> userList: <ns0:storageCloudSubjectAssoc[]> flags: <xs:unsignedInt> resourceList: <ns0:storageCloudResourceAssoc[]> organization: <xs:string> defaultChapUsername: <xs:string> description: <xs:string>
storageCloudDelete API
Example
Argument List
storageCloud: <xs:string> flags: <xs:unsignedInt>
storageCloudEnum API
Example
Argument List
flags: <xs:unsignedInt>
storageCloudGet API
Example
Argument List
storageCloud: <xs:string> flags: <xs:unsignedInt>
storageCloudModify API
Example
Argument List
defaultChapPassword: <xs:string> name: <xs:string> parentStorageCloudId: <xs:string> flags: <xs:unsignedInt> tier: <xs:string> organization: <xs:string> storageCloud: <xs:string> defaultChapUsername: <xs:string> description: <xs:string>
storageCloudResourceAddRemove API
Example
Argument List
resourceList: <ns0:storageCloudResourceAssoc[]> storageCloud: <xs:string> modType: <xs:unsignedInt> flags: <xs:unsignedInt>
storageCloudResourceAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> resource: <xs:string>
storageCloudResourceAssocGet API
Example
Argument List
flags: <xs:unsignedInt> storageCloud: <xs:string> resource: <xs:string>
storageCloudResourceSetMode API
Example
Argument List
flags: <xs:unsignedInt> storageCloud: <xs:string> resource: <ns0:storageCloudResourceAssoc>
storageCloudSubjectAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> subject: <xs:string>
storageCloudSubjectAssocGet API
Example
Argument List
storageCloud: <xs:string> flags: <xs:unsignedInt> subject: <xs:string>
storageCloudUserAddRemove API
Example
Argument List
userList: <ns0:storageCloudSubjectAssoc[]> storageCloud: <xs:string> modType: <xs:unsignedInt> flags: <xs:unsignedInt>
storagePoolCreate API
Example
Argument List
profile: <xs:string> physicalDiskList: <xs:string[]> name: <xs:string> raidType: <xs:unsignedInt> poolType: <xs:unsignedInt> enableCompression: <xs:boolean> noBarriers: <xs:boolean> enableSsd: <xs:boolean> flags: <xs:unsignedInt> isDefault: <xs:boolean> description: <xs:string>
storagePoolDestroy API
Example
Argument List
flags: <xs:unsignedInt> storagePool: <xs:string>
storagePoolDeviceEnum API
Example
Argument List
storagePoolId: <xs:string> flags: <xs:unsignedInt>
storagePoolDeviceGet API
Example
Argument List
flags: <xs:unsignedInt> storagePoolDevice: <xs:string>
storagePoolEnum API
Example
Argument List
flags: <xs:unsignedInt>
storagePoolExpand API
Example
Argument List
flags: <xs:unsignedInt> storagePool: <xs:string>
storagePoolExport API
Example
Argument List
flags: <xs:unsignedInt> storagePool: <xs:string>
storagePoolGet API
Example
Argument List
flags: <xs:unsignedInt> storagePool: <xs:string>
storagePoolGrow API
Example
Argument List
raidType: <xs:unsignedInt> flags: <xs:unsignedInt> physicalDiskList: <xs:string[]> storagePool: <xs:string>
storagePoolIdentify API
Example
Argument List
duration: <xs:unsignedInt> pattern: <xs:string> flags: <xs:unsignedInt> storagePool: <xs:string>
storagePoolModify API
Example
Argument List
profile: <xs:string> newName: <xs:string> enableCompression: <xs:boolean> isDefault: <xs:boolean> storagePool: <xs:string> noBarriers: <xs:boolean> enableSsd: <xs:boolean> flags: <xs:unsignedInt> newDescription: <xs:string>
storagePoolProfileEnum API
Example
Argument List
flags: <xs:unsignedInt>
storagePoolProfileGet API
Example
Argument List
storagePoolProfile: <xs:string> flags: <xs:unsignedInt>
storagePoolReplicationConfigCreate API
Example
Argument List
primaryStoragePoolId: <xs:string> diskBarrier: <xs:boolean> protocolType: <xs:string> replicationPort: <xs:unsignedInt> secondaryStoragePoolId: <xs:string> flags: <xs:unsignedInt> resyncRate: <xs:unsignedLong> diskFlushes: <xs:boolean> storageSystemLinkId: <xs:string>
storagePoolReplicationConfigDelete API
Example
Argument List
scrubMetadataDevice: <xs:boolean> flags: <xs:unsignedInt> storagePoolReplicationConfigId: <xs:string>
storagePoolReplicationConfigEnum API
Example
Argument List
flags: <xs:unsignedInt>
storagePoolReplicationConfigGet API
Example
Argument List
storagePoolReplicationConfig: <xs:string> flags: <xs:unsignedInt>
storagePoolReplicationConfigModify API
Example
Argument List
diskBarrier: <xs:boolean> protocolType: <xs:string> replicationPort: <xs:unsignedInt> flags: <xs:unsignedInt> resyncRate: <xs:unsignedLong> diskFlushes: <xs:boolean> storageSystemLinkId: <xs:string> storagePoolReplicationConfigId: <xs:string>
storagePoolRescan API
Example
Argument List
flags: <xs:unsignedInt> storageSystem: <xs:string> options: <xs:string>
storagePoolSpareAddRemove API
Example
Argument List
flags: <xs:unsignedInt> modType: <xs:unsignedInt> physicalDiskList: <xs:string[]> storagePool: <xs:string>
storagePoolStart API
Example
Argument List
flags: <xs:unsignedInt> storagePool: <xs:string>
storagePoolStop API
Example
Argument List
flags: <xs:unsignedInt> storagePool: <xs:string>
storagePoolUpdateRedirect API
Example
Argument List
flags: <xs:unsignedInt> storagePool: <xs:string>
storageQuotaCreate API
Example
Argument List
utilizableSpace: <xs:unsignedLong> name: <xs:string> maxVolumes: <xs:unsignedInt> storageCloudId: <xs:string> policyFlags: <xs:unsignedInt> provisionableSize: <xs:unsignedLong> storagePoolId: <xs:string> flags: <xs:unsignedInt> maxShares: <xs:unsignedInt> description: <xs:string>
storageQuotaDelete API
Example
Argument List
storageQuota: <xs:string> flags: <xs:unsignedInt>
storageQuotaEnum API
Example
Argument List
flags: <xs:unsignedInt>
storageQuotaGet API
Example
Argument List
storageQuota: <xs:string> flags: <xs:unsignedInt>
storageQuotaModify API
Example
Argument List
utilizableSpace: <xs:unsignedLong> name: <xs:string> maxVolumes: <xs:unsignedInt> storageCloudId: <xs:string> policyFlags: <xs:unsignedInt> provisionableSize: <xs:unsignedLong> storageQuota: <xs:string> flags: <xs:unsignedInt> maxShares: <xs:unsignedInt> description: <xs:string>
Example
Argument List
storageQuota: <xs:string> modType: <xs:unsignedInt> storageShareList: <xs:string[]> flags: <xs:unsignedInt>
Example
Argument List
networkShare: <xs:string> flags: <xs:unsignedInt>
Example
Argument List
storageQuotaId: <xs:string> shareId: <xs:string>
storageQuotaVolumeAddRemove API
Example
Argument List
storageVolumeList: <xs:string[]> storageQuota: <xs:string> modType: <xs:unsignedInt> flags: <xs:unsignedInt>
storageQuotaVolumeAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> storageVolume: <xs:string>
storageQuotaVolumeAssocGet API
Example
Argument List
storageQuotaId: <xs:string> storageVolumeId: <xs:string>
storageSystemClusterAssocEnum API
Example
Argument List
flags: <xs:unsignedInt>
storageSystemClusterAssocGet API
Example
Argument List
storageSystemId: <xs:string> storageSystemClusterId: <xs:string> flags: <xs:unsignedInt>
storageSystemClusterCreate API
Example
Argument List
targetPort: <xs:string> name: <xs:string> virtualHostIpAddress: <xs:string> virtualHostGateway: <xs:string> flags: <xs:unsignedInt> virtualHostSubnetMask: <xs:string> virtualHostName: <xs:string> description: <xs:string>
storageSystemClusterDelete API
Example
Argument List
flags: <xs:unsignedInt>
storageSystemClusterEnum API
Example
Argument List
flags: <xs:unsignedInt>
storageSystemClusterGet API
Example
Argument List
storageSystemCluster: <xs:string> flags: <xs:unsignedInt>
storageSystemClusterModify API
Example
Argument List
targetPort: <xs:string> name: <xs:string> virtualHostIpAddress: <xs:string> virtualHostGateway: <xs:string> flags: <xs:unsignedInt> virtualHostSubnetMask: <xs:string> virtualHostName: <xs:string> description: <xs:string>
storageSystemClusterNodeAdd API
Example
Argument List
nodeAdminUsername: <xs:string> flags: <xs:unsignedInt> nodeIpAddress: <xs:string> nodeAdminPassword: <xs:string>
storageSystemClusterNodeEject API
Example
Argument List
storageSystemClusterObj: <ns0:storageSystemCluster> flags: <xs:unsignedInt>
storageSystemClusterNodeJoin API
Example
Argument List
flags: <xs:unsignedInt> storageSystemClusterObj: <ns0:storageSystemCluster> masterNode: <ns0:storageSystem>
storageSystemClusterNodeRemove API
Example
Argument List
storageSystemId: <xs:string> flags: <xs:unsignedInt>
storageSystemClusterNodeSetMaster API
Example
Argument List
storageSystemId: <xs:string> flags: <xs:unsignedInt>
storageSystemClusterNodeSync API
Example
Argument List
flags: <xs:unsignedInt> storageSystemClusterObj: <ns0:storageSystemCluster> masterNode: <ns0:storageSystem>
storageSystemEnum API
Example
Argument List
flags: <xs:unsignedInt>
storageSystemGet API
Example
Argument List
flags: <xs:unsignedInt> storageSystem: <xs:string>
storageSystemGroupAddRemoveLinks API
Example
Argument List
linkIdList: <xs:string[]> modType: <xs:unsignedInt> flags: <xs:unsignedInt> groupId: <xs:string>
storageSystemGroupAssocEnum API
Example
Argument List
flags: <xs:unsignedInt>
storageSystemGroupAssocGet API
Example
Argument List
linkId: <xs:string> flags: <xs:unsignedInt> groupId: <xs:string>
storageSystemGroupCreate API
Example
Argument List
groupPassword: <xs:string> flags: <xs:unsignedInt> name: <xs:string> virtualIpAddress: <xs:string> description: <xs:string>
storageSystemGroupDelete API
Example
Argument List
deleteAssociatedLinks: <xs:boolean> flags: <xs:unsignedInt> groupId: <xs:string>
storageSystemGroupEnum API
Example
Argument List
flags: <xs:unsignedInt>
storageSystemGroupGet API
Example
Argument List
flags: <xs:unsignedInt> groupId: <xs:string>
storageSystemGroupModify API
Example
Argument List
description: <xs:string> flags: <xs:unsignedInt> groupId: <xs:string> virtualIpAddress: <xs:string> name: <xs:string>
storageSystemGroupSetPassword API
Example
Argument List
groupPassword: <xs:string> flags: <xs:unsignedInt> groupId: <xs:string>
storageSystemLinkCreate API
Example
Argument List
linkType: <xs:unsignedInt> localIpAddress: <xs:string> description: <xs:string> remoteAdminPassword: <xs:string> storageSystemId: <xs:string> flags: <xs:unsignedInt> remoteIpAddress: <xs:string> remoteAdminUser: <xs:string> bandwidthLimit: <xs:unsignedInt>
storageSystemLinkDelete API
Example
Argument List
linkId: <xs:string> flags: <xs:unsignedInt>
storageSystemLinkDisconnect API
Example
Argument List
remoteStorageSystemId: <xs:string> flags: <xs:unsignedInt>
storageSystemLinkEnum API
Example
Argument List
flags: <xs:unsignedInt>
storageSystemLinkEstablish API
Example
Argument List
linkObj: <ns0:storageSystemLink> flags: <xs:unsignedInt>
storageSystemLinkGet API
Example
Argument List
linkId: <xs:string> flags: <xs:unsignedInt>
storageSystemLinkModify API
Example
Argument List
linkType: <xs:unsignedInt> description: <xs:string> linkId: <xs:string> localIpAddress: <xs:string> flags: <xs:unsignedInt> remoteIpAddress: <xs:string> bandwidthLimit: <xs:unsignedInt>
storageSystemLinkRefresh API
Example
Argument List
linkId: <xs:string> flags: <xs:unsignedInt>
storageSystemLinkSetCredentials API
Example
Argument List
linkId: <xs:string> remoteAdminPassword: <xs:string> flags: <xs:unsignedInt> remoteAdminUser: <xs:string>
storageSystemLinkVerify API
Example
Argument List
linkObj: <ns0:storageSystemLink> flags: <xs:unsignedInt>
storageSystemModify API
Example
Argument List
searchSuffix: <xs:string> newName: <xs:string> newLocation: <xs:string> storageSystem: <xs:string> newDnsServerList: <xs:string[]> arpFilterMode: <xs:unsignedInt> bondMode: <xs:unsignedInt> domainSuffix: <xs:string> flags: <xs:unsignedInt> newDescription: <xs:string>
storageSystemRecover API
Example
Argument List
recoveryPoint: <xs:string> recoverNetworkConfig: <xs:boolean> flags: <xs:unsignedInt> storageSystem: <xs:string>
storageSystemRecoveryPointEnum API
Example
Argument List
flags: <xs:unsignedInt> storageSystem: <xs:string>
storageSystemRestart API
Example
Argument List
flags: <xs:unsignedInt> storageSystem: <xs:string>
storageSystemSendLogs API
Example
Argument List
storageSystemId: <xs:string> flags: <xs:unsignedInt>
storageSystemShutdown API
Example
Argument List
flags: <xs:unsignedInt> storageSystem: <xs:string>
storageSystemUpdateCheck API
Example
Argument List
flags: <xs:unsignedInt> storageSystem: <xs:string>
storageSystemUpgrade API
Example
Argument List
upgradeTarget: <xs:boolean> upgradeService: <xs:boolean> storageSystem: <xs:string> upgradeWebServer: <xs:boolean> flags: <xs:unsignedInt> upgradeManager: <xs:boolean>
storageVolumeAclAddRemove API
Example
Argument List
flags: <xs:unsignedInt> hostList: <xs:string[]> modType: <xs:unsignedInt> storageVolume: <xs:string>
storageVolumeAclAddRemoveEx API
Example
Argument List
storageVolumeList: <xs:string[]> host: <xs:string> modType: <xs:unsignedInt> flags: <xs:unsignedInt>
storageVolumeAclEnum API
Example
Argument List
flags: <xs:unsignedInt> host: <xs:string> storageVolume: <xs:string>
storageVolumeAclGet API
Example
Argument List
flags: <xs:unsignedInt> host: <xs:string> storageVolume: <xs:string>
storageVolumeClone API
Example
Argument List
storageVolume: <xs:string> description: <xs:string> accessMode: <xs:unsignedInt> cloneName: <xs:string> flags: <xs:unsignedInt> provisionableId: <xs:string>
storageVolumeCloudBackupCreate API
Example
Argument List
reserved: <xs:string> sourceVolumeId: <xs:string> priority: <xs:unsignedInt> backupVolumeName: <xs:string> cloudContainerId: <xs:string> flags: <xs:unsignedInt> backupVolumeDescription: <xs:string>
storageVolumeCloudBackupRestore API
Example
Argument List
reserved: <xs:string> recoveredVolumeName: <xs:string> sourceVolumeId: <xs:string> priority: <xs:unsignedInt> storagePoolId: <xs:string> flags: <xs:unsignedInt> recoveredVolumeDescription: <xs:string>
storageVolumeCreate API
Example
Argument List
chapPolicy: <xs:unsignedInt> count: <xs:unsignedInt> name: <xs:string> accessMode: <xs:unsignedInt> description: <xs:string> flags: <xs:unsignedInt> thinProvisioned: <xs:boolean> chapPassword: <xs:string> provisionableId: <xs:string> chapUsername: <xs:string> size: <xs:unsignedLong>
storageVolumeCreateEx API
Example
Argument List
count: <xs:unsignedInt> name: <xs:string> accessMode: <xs:unsignedInt> description: <xs:string> flags: <xs:unsignedInt> percentReserved: <xs:unsignedInt> chapPolicy: <xs:unsignedInt> chapPassword: <xs:string> provisionableId: <xs:string> chapUsername: <xs:string> size: <xs:unsignedLong>
storageVolumeDelete API
Example
Argument List
storageVolumeList: <xs:string[]> flags: <xs:unsignedInt> recursivelyDeleteSnapshots: <xs:boolean>
storageVolumeEnum API
Example
Argument List
storageVolumeList: <xs:string[]> flags: <xs:unsignedInt>
storageVolumeGet API
Example
Argument List
flags: <xs:unsignedInt> storageVolume: <xs:string>
storageVolumeGroupAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> storageVolume: <xs:string>
storageVolumeGroupAssocGet API
Example
Argument List
storageVolumeGroupId: <xs:string> storageVolumeId: <xs:string>
storageVolumeGroupClone API
Example
Argument List
storageVolumeGroup: <xs:string> description: <xs:string> accessMode: <xs:unsignedInt> flags: <xs:unsignedInt> cloneNamePrefix: <xs:string> provisionableId: <xs:string>
storageVolumeGroupCreate API
Example
Argument List
storageVolumeList: <xs:string[]> flags: <xs:unsignedInt> name: <xs:string> description: <xs:string>
storageVolumeGroupDelete API
Example
Argument List
flags: <xs:unsignedInt> storageVolumeGroup: <xs:string> deleteAssociatedVolumes: <xs:boolean>
storageVolumeGroupEnum API
Example
Argument List
flags: <xs:unsignedInt>
storageVolumeGroupGet API
Example
Argument List
flags: <xs:unsignedInt> storageVolumeGroup: <xs:string>
storageVolumeGroupModify API
Example
Argument List
newName: <xs:string> flags: <xs:unsignedInt> storageVolumeGroup: <xs:string> newDescription: <xs:string>
storageVolumeGroupSnapshot API
Example
Argument List
count: <xs:unsignedInt> storageVolumeGroup: <xs:string> description: <xs:string> accessMode: <xs:unsignedInt> snapshotNamePrefix: <xs:string> flags: <xs:unsignedInt> provisionableId: <xs:string>
storageVolumeGroupVolumeAddRemove API
Example
Argument List
storageVolumeList: <xs:string[]> flags: <xs:unsignedInt> modType: <xs:unsignedInt> storageVolumeGroup: <xs:string>
storageVolumeModify API
Example
Argument List
storageVolume: <xs:string> newName: <xs:string> flags: <xs:unsignedInt> newAccessMode: <xs:unsignedInt> chapUsername: <xs:string> chapPolicy: <xs:unsignedInt> chapPassword: <xs:string> clearSnapshotFlag: <xs:boolean> newDescription: <xs:string>
storageVolumeResize API
Example
Argument List
flags: <xs:unsignedInt> newSizeInBytes: <xs:unsignedLong> storageVolume: <xs:string> provisionableId: <xs:string>
storageVolumeRestore API
Example
Argument List
snapshotVolume: <xs:string> storageVolume: <xs:string> flags: <xs:unsignedInt>
storageVolumeSnapshot API
Example
Argument List
count: <xs:unsignedInt> storageVolume: <xs:string> description: <xs:string> accessMode: <xs:unsignedInt> flags: <xs:unsignedInt> snapshotName: <xs:string> provisionableId: <xs:string>
storageVolumeUtilizationEnum API
Example
Argument List
flags: <xs:unsignedInt> storageVolume: <xs:string>
storageVolumeUtilizationGet API
Example
Argument List
flags: <xs:unsignedInt> utilizationId: <xs:string>
storageVolumeUtilizationGetRetentionPeriod API
Example
Argument List
flags: <xs:unsignedInt>
storageVolumeUtilizationSetRetentionPeriod API
Example
Argument List
flags: <xs:unsignedInt> daysToRetain: <xs:unsignedInt>
targetPortDisable API
Example
Argument List
flags: <xs:unsignedInt> port: <xs:string>
targetPortEnable API
Example
Argument List
flags: <xs:unsignedInt> port: <xs:string>
targetPortEnum API
Example
Argument List
flags: <xs:unsignedInt>
targetPortGet API
Example
Argument List
flags: <xs:unsignedInt> port: <xs:string>
targetPortModify API
Example
Argument List
description: <xs:string> iscsiEnabled: <xs:boolean> mtu: <xs:unsignedInt> configType: <xs:string> netmask: <xs:string> vportFloatList: <xs:string[]> gateway: <xs:string> flags: <xs:unsignedInt> ipAddress: <xs:string> port: <xs:string>
targetPortRescan API
Example
Argument List
flags: <xs:unsignedInt> storageSystem: <xs:string>
targetPortRestart API
Example
Argument List
flags: <xs:unsignedInt> port: <xs:string>
targetVirtualInterfaceCreate API
Example
Argument List
macAddress: <xs:string> description: <xs:string> portList: <xs:string[]> parentPortId: <xs:string> mtu: <xs:unsignedInt> storageSystemId: <xs:string> netmask: <xs:string> flags: <xs:unsignedInt> ipAddress: <xs:string> gateway: <xs:string>
targetVirtualInterfaceMove API
Example
Argument List
targetPortId: <xs:string> flags: <xs:unsignedInt> virtualInterfaceId: <xs:string>
targetVirtualPortCreate API
Example
Argument List
macAddress: <xs:string> description: <xs:string> portList: <xs:string[]> mtu: <xs:unsignedInt> storageSystemId: <xs:string> netmask: <xs:string> flags: <xs:unsignedInt> ipAddress: <xs:string> gateway: <xs:string>
targetVirtualPortDelete API
Example
Argument List
flags: <xs:unsignedInt> port: <xs:string>
taskCancel API
Example
Argument List
flags: <xs:unsignedInt> id: <xs:string>
taskClearAll API
Example
Argument List
flags: <xs:unsignedInt>
taskEnum API
Example
Argument List
taskIdlist: <xs:string[]> flags: <xs:unsignedInt>
taskGet API
Example
Argument List
flags: <xs:unsignedInt> id: <xs:string>
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.
Example
curl -U username:password -k https://hostname:8153/userAdd?username=tiger&password=passWORD1&firstName=Tiger&lastName=Woods&role=Administrator
Argument List
username: <xs:string> defaultChapPassword: <xs:string> alertSubscriptions: <xs:unsignedInt> description: <xs:string> firstName: <xs:string> lastName: <xs:string> flags: <xs:unsignedInt> emailAddress: <xs:string> role: <xs:string> password: <xs:string> defaultChapUsername: <xs:string>
userEnum API
Example
Argument List
flags: <xs:unsignedInt>
userGet API
Example
Argument List
flags: <xs:unsignedInt> user: <xs:string>
userGroupAssocEnum API
Example
Argument List
flags: <xs:unsignedInt> user: <xs:string>
userGroupAssocGet API
Example
Argument List
userId: <xs:string> userGroupId: <xs:string>
userGroupCreate API
Example
Argument List
userList: <xs:string[]> flags: <xs:unsignedInt> name: <xs:string> description: <xs:string>
userGroupDelete API
Example
Argument List
flags: <xs:unsignedInt> userGroup: <xs:string>
userGroupEnum API
Example
Argument List
flags: <xs:unsignedInt>
userGroupGet API
Example
Argument List
flags: <xs:unsignedInt> userGroup: <xs:string>
userGroupModify API
Example
Argument List
newName: <xs:string> flags: <xs:unsignedInt> newDescription: <xs:string> userGroup: <xs:string>
userGroupUserAddRemove API
Example
Argument List
userList: <xs:string[]> modType: <xs:unsignedInt> flags: <xs:unsignedInt> userGroup: <xs:string>
userModify API
Example
Argument List
newFirstName: <xs:string> newDefaultChapPassword: <xs:string> newName: <xs:string> alertSubscriptions: <xs:unsignedInt> flags: <xs:unsignedInt> user: <xs:string> newDefaultChapUsername: <xs:string> newLastName: <xs:string> newEmailAddress: <xs:string> newDescription: <xs:string> newRole: <xs:string>
userPasswordSet API
Example
Argument List
newPassword: <xs:string> oldPassword: <xs:string> flags: <xs:unsignedInt> user: <xs:string>
userRemove API
Example
Argument List
flags: <xs:unsignedInt> user: <xs:string>
virtualInterfaceAssocEnum API
Example
Argument List
flags: <xs:unsignedInt>
virtualInterfaceAssocGet API
Example
Argument List
targetPortId: <xs:string> flags: <xs:unsignedInt> virtualInterfaceId: <xs:string>
widgetCreate API
Example
Argument List
flags: <xs:unsignedInt> name: <xs:string>