QuantaStor REST API Reference Guide
Contents
- 1 Service API Definitions
- 1.1 aclAdd
- 1.2 aclModify
- 1.3 aclRemove
- 1.4 activeDirectoryDomainEnum
- 1.5 activeDirectoryUserAndGroupEnumEx
- 1.6 alertClear
- 1.7 alertClearAll
- 1.8 alertConfigGet
- 1.9 alertConfigSet
- 1.10 alertEnum
- 1.11 alertGet
- 1.12 alertRaise
- 1.13 alertTypeEnum
- 1.14 alertTypeGet
- 1.15 auditLogClear
- 1.16 auditLogDisable
- 1.17 auditLogEnable
- 1.18 auditLogGet
- 1.19 backupJobCancel
- 1.20 backupJobEnum
- 1.21 backupJobGet
- 1.22 backupJobStart
- 1.23 backupJobStatusUpdate
- 1.24 backupPolicyCreate
- 1.25 backupPolicyDelete
- 1.26 backupPolicyDisable
- 1.27 backupPolicyEnable
- 1.28 backupPolicyEnum
- 1.29 backupPolicyGet
- 1.30 backupPolicyModify
- 1.31 backupPolicyTrigger
- 1.32 bucketCreate
- 1.33 bucketDelete
- 1.34 bucketEnum
- 1.35 bucketGet
- 1.36 bucketModify
- 1.37 bucketObjectEnum
- 1.38 bucketRescan
- 1.39 bucketUserAssocEnum
- 1.40 bucketUserAssocGet
- 1.41 cephClusterAddNode
- 1.42 cephClusterCreate
- 1.43 cephClusterDelete
- 1.44 cephClusterEnum
- 1.45 cephClusterFixClockSkew
- 1.46 cephClusterGet
- 1.47 cephClusterMemberEnum
- 1.48 cephClusterMemberGet
- 1.49 cephClusterModify
- 1.50 cephClusterRemoveNode
- 1.51 cephClusterServiceEventDelete
- 1.52 cephClusterServiceEventEnum
- 1.53 cephCrushRuleCreate
- 1.54 cephCrushRuleDelete
- 1.55 cephCrushRuleEnum
- 1.56 cephCrushRuleGet
- 1.57 cephFilesystemCreate
- 1.58 cephFilesystemDelete
- 1.59 cephFilesystemEnum
- 1.60 cephFilesystemGet
- 1.61 cephFilesystemModify
- 1.62 cephFilesystemPoolAssocEnum
- 1.63 cephFilesystemPoolAssocGet
- 1.64 cephJournalDeviceCreate
- 1.65 cephJournalDeviceDelete
- 1.66 cephJournalDeviceEnum
- 1.67 cephJournalDeviceGet
- 1.68 cephJournalDeviceMigrate
- 1.69 cephJournalGroupCreate
- 1.70 cephJournalGroupDelete
- 1.71 cephJournalGroupEnum
- 1.72 cephJournalGroupGet
- 1.73 cephMdsAdd
- 1.74 cephMdsEnum
- 1.75 cephMdsGet
- 1.76 cephMdsRemove
- 1.77 cephMonitorAdd
- 1.78 cephMonitorEnum
- 1.79 cephMonitorGet
- 1.80 cephMonitorRemove
- 1.81 cephMultiOsdCreate
- 1.82 cephObjectPoolGroupCreate
- 1.83 cephObjectPoolGroupDelete
- 1.84 cephObjectPoolGroupEnum
- 1.85 cephObjectPoolGroupGet
- 1.86 cephOsdCreate
- 1.87 cephOsdDelete
- 1.88 cephOsdEnum
- 1.89 cephOsdGet
- 1.90 cephOsdIdentify
- 1.91 cephOsdModify
- 1.92 cephOsdServiceUpdate
- 1.93 cephPgSetEnum
- 1.94 cephPgSetGet
- 1.95 cephPoolCreate
- 1.96 cephPoolDelete
- 1.97 cephPoolEnum
- 1.98 cephPoolGet
- 1.99 cephPoolModify
- 1.100 cephPoolOsdAssocEnum
- 1.101 cephPoolOsdAssocGet
- 1.102 cephPoolProfileCreate
- 1.103 cephPoolProfileDelete
- 1.104 cephPoolProfileEnum
- 1.105 cephPoolProfileGet
- 1.106 cephRadosGatewayAdd
- 1.107 cephRadosGatewayEnum
- 1.108 cephRadosGatewayGet
- 1.109 cephRadosGatewayRemove
- 1.110 cephRadosGatewayStartStopRestart
- 1.111 cloudBackupScheduleAssocEnum
- 1.112 cloudBackupScheduleAssocGet
- 1.113 cloudBackupScheduleCreate
- 1.114 cloudBackupScheduleDelete
- 1.115 cloudBackupScheduleDisable
- 1.116 cloudBackupScheduleEnable
- 1.117 cloudBackupScheduleEnum
- 1.118 cloudBackupScheduleGet
- 1.119 cloudBackupScheduleModify
- 1.120 cloudBackupScheduleTrigger
- 1.121 cloudBackupScheduleVolumeAddRemove
- 1.122 cloudContainerAdd
- 1.123 cloudContainerBucketScan
- 1.124 cloudContainerCacheSettingsGet
- 1.125 cloudContainerCacheSettingsModify
- 1.126 cloudContainerCreate
- 1.127 cloudContainerDelete
- 1.128 cloudContainerDisable
- 1.129 cloudContainerEnable
- 1.130 cloudContainerEnum
- 1.131 cloudContainerGet
- 1.132 cloudContainerRepair
- 1.133 cloudProviderAdd
- 1.134 cloudProviderCredentialsAdd
- 1.135 cloudProviderCredentialsEnum
- 1.136 cloudProviderCredentialsGet
- 1.137 cloudProviderCredentialsRemove
- 1.138 cloudProviderEnum
- 1.139 cloudProviderGet
- 1.140 cloudProviderLocationAdd
- 1.141 cloudProviderLocationEnum
- 1.142 cloudProviderLocationGet
- 1.143 cloudProviderLocationRemove
- 1.144 cloudProviderRemove
- 1.145 clusterRingCreate
- 1.146 clusterRingDelete
- 1.147 clusterRingEnum
- 1.148 clusterRingGet
- 1.149 clusterRingMemberEnum
- 1.150 clusterRingMemberGet
- 1.151 customApi
- 1.152 eventEnum
- 1.153 eventListenerNotify
- 1.154 eventListenerRegister
- 1.155 eventListenerUnregister
- 1.156 eventPulse
- 1.157 fcTargetPortDisable
- 1.158 fcTargetPortEnable
- 1.159 fcTargetPortEnum
- 1.160 fcTargetPortGet
- 1.161 getLocalizedMessage
- 1.162 getMultiFactorAuthDevices
- 1.163 hostAdd
- 1.164 hostEnum
- 1.165 hostGet
- 1.166 hostGroupCreate
- 1.167 hostGroupDelete
- 1.168 hostGroupEnum
- 1.169 hostGroupGet
- 1.170 hostGroupHostAddRemove
- 1.171 hostGroupModify
- 1.172 hostInitiatorAdd
- 1.173 hostInitiatorEnum
- 1.174 hostInitiatorGet
- 1.175 hostInitiatorRemove
- 1.176 hostModify
- 1.177 hostRemove
- 1.178 hwAlarmEnum
- 1.179 hwAlarmGet
- 1.180 hwBatteryBackupUnitEnum
- 1.181 hwBatteryBackupUnitGet
- 1.182 hwControllerChangeSecurityKey
- 1.183 hwControllerClearAlarms
- 1.184 hwControllerCreateSecurityKey
- 1.185 hwControllerEnum
- 1.186 hwControllerGet
- 1.187 hwControllerGroupEnum
- 1.188 hwControllerGroupGet
- 1.189 hwControllerImportForeignUnits
- 1.190 hwControllerModify
- 1.191 hwControllerRescan
- 1.192 hwControllerRescanAll
- 1.193 hwControllerSilenceAlarms
- 1.194 hwDiskClearMissing
- 1.195 hwDiskEnum
- 1.196 hwDiskGet
- 1.197 hwDiskIdentify
- 1.198 hwDiskMarkGood
- 1.199 hwDiskMarkHotSpare
- 1.200 hwDiskModify
- 1.201 hwDiskRemove
- 1.202 hwDiskUnmarkHotSpare
- 1.203 hwEnclosureEnum
- 1.204 hwEnclosureGet
- 1.205 hwEnclosureLayoutEnum
- 1.206 hwEnclosureLayoutGet
- 1.207 hwEnclosureLayoutVendorGroupEnum
- 1.208 hwEnclosureLayoutVendorGroupGet
- 1.209 hwEnclosureModify
- 1.210 hwEnclosureSlotIdentify
- 1.211 hwLogicalDriveEnum
- 1.212 hwLogicalDriveGet
- 1.213 hwUnitAutoCreate
- 1.214 hwUnitCreate
- 1.215 hwUnitDelete
- 1.216 hwUnitDiskAssocEnum
- 1.217 hwUnitDiskAssocGet
- 1.218 hwUnitEnableEncryption
- 1.219 hwUnitEnum
- 1.220 hwUnitGet
- 1.221 hwUnitGrow
- 1.222 hwUnitIdentify
- 1.223 hwUnitModify
- 1.224 hwUnitSsdCacheCreate
- 1.225 hwUnitSsdCacheDisable
- 1.226 hwUnitSsdCacheEnable
- 1.227 ibTargetPortEnum
- 1.228 ibTargetPortGet
- 1.229 keyInfoEnum
- 1.230 keyVaultCheckConnectivity
- 1.231 keyVaultModuleEnum
- 1.232 keyVaultModuleGet
- 1.233 keyVaultProfileEnum
- 1.234 keyVaultProfileGet
- 1.235 keyVaultProfileRegister
- 1.236 keyVaultProfileUnRegister
- 1.237 libratoMetricsConfigGet
- 1.238 libratoMetricsConfigSet
- 1.239 licenseActivate
- 1.240 licenseActivateOnline
- 1.241 licenseAdd
- 1.242 licenseEnum
- 1.243 licenseGet
- 1.244 licenseModifySupportInfo
- 1.245 licenseRemove
- 1.246 login
- 1.247 loginVerify
- 1.248 logout
- 1.249 multiFactorAuthConfigCreate
- 1.250 multiFactorAuthConfigDelete
- 1.251 multiFactorAuthConfigEnum
- 1.252 multiFactorAuthConfigGet
- 1.253 multiFactorAuthConfigModify
- 1.254 multiFactorAuthConfigUserAssignUnassign
- 1.255 networkShareAddGroupQuota
- 1.256 networkShareAddUserQuota
- 1.257 networkShareCifsOptionEnum
- 1.258 networkShareCifsOptionGet
- 1.259 networkShareClientAdd
- 1.260 networkShareClientEnum
- 1.261 networkShareClientGet
- 1.262 networkShareClientModify
- 1.263 networkShareClientRemove
- 1.264 networkShareClone
- 1.265 networkShareCreate
- 1.266 networkShareCreateAlias
- 1.267 networkShareCreateEx
- 1.268 networkShareDelete
- 1.269 networkShareDeleteEx
- 1.270 networkShareDisable
- 1.271 networkShareEnable
- 1.272 networkShareEnum
- 1.273 networkShareEnumQuotas
- 1.274 networkShareFileCopy
- 1.275 networkShareFileCreate
- 1.276 networkShareFileDelete
- 1.277 networkShareFileExpand
- 1.278 networkShareFileLockEnum
- 1.279 networkShareGet
- 1.280 networkShareHealthCheck
- 1.281 networkShareJoinDomain
- 1.282 networkShareLeaveDomain
- 1.283 networkShareModify
- 1.284 networkShareNamespaceAddRemove
- 1.285 networkShareNamespaceCreate
- 1.286 networkShareNamespaceDelete
- 1.287 networkShareNamespaceEnum
- 1.288 networkShareNamespaceGet
- 1.289 networkShareNamespaceModify
- 1.290 networkShareNamespaceShareAssocEnum
- 1.291 networkShareNamespaceShareAssocGet
- 1.292 networkShareNamespaceSystemAssocEnum
- 1.293 networkShareNamespaceSystemAssocGet
- 1.294 networkShareNfsConfig
- 1.295 networkShareRemoveGroupQuota
- 1.296 networkShareRemoveUserQuota
- 1.297 networkShareRestore
- 1.298 networkShareRollback
- 1.299 networkShareServicesRestart
- 1.300 networkShareSessionEnum
- 1.301 networkShareSessionGet
- 1.302 networkShareSetQuotas
- 1.303 networkShareSnapshot
- 1.304 networkShareUserAccessEnum
- 1.305 networkShareUserAccessGet
- 1.306 objectEnum
- 1.307 objectGet
- 1.308 objectPropertyDelete
- 1.309 objectPropertyEnum
- 1.310 objectPropertyGet
- 1.311 objectPropertySet
- 1.312 passwordPolicyGet
- 1.313 passwordPolicySet
- 1.314 permissionDefinitionEnum
- 1.315 physicalDiskCopy
- 1.316 physicalDiskDataMigration
- 1.317 physicalDiskEnum
- 1.318 physicalDiskFormat
- 1.319 physicalDiskGet
- 1.320 physicalDiskGlobalSpareAddRemove
- 1.321 physicalDiskGlobalSpareEnum
- 1.322 physicalDiskHotspareMarkerCleanup
- 1.323 physicalDiskHotspareMarkerDelete
- 1.324 physicalDiskHotspareMarkerEnum
- 1.325 physicalDiskHotspareMarkerGet
- 1.326 physicalDiskIdentify
- 1.327 physicalDiskMultipathConfigAddRemove
- 1.328 physicalDiskMultipathConfigEnum
- 1.329 physicalDiskMultipathConfigScan
- 1.330 physicalDiskPathAssocEnum
- 1.331 physicalDiskPathAssocGet
- 1.332 physicalDiskScan
- 1.333 pingCheck
- 1.334 providerAppEnum
- 1.335 providerAppGet
- 1.336 providerAppRegister
- 1.337 providerAppUnregister
- 1.338 qosPolicyCreate
- 1.339 qosPolicyDelete
- 1.340 qosPolicyEnum
- 1.341 qosPolicyGet
- 1.342 qosPolicyModify
- 1.343 remoteNfsExportsEnum
- 1.344 remoteStoragePoolEnum
- 1.345 replicaAssocDelete
- 1.346 replicaAssocEnum
- 1.347 replicaAssocGet
- 1.348 replicaAssocUpdate
- 1.349 replicaCreate
- 1.350 replicaReportEntryEnum
- 1.351 replicaReportEntryGet
- 1.352 replicaReportSummaryDelete
- 1.353 replicaReportSummaryEnum
- 1.354 replicaReportSummaryGet
- 1.355 replicaRollback
- 1.356 replicaStop
- 1.357 replicaSync
- 1.358 replicationScheduleActivateCheckpoints
- 1.359 replicationScheduleAddRemove
- 1.360 replicationScheduleAssocEnum
- 1.361 replicationScheduleAssocGet
- 1.362 replicationScheduleCreate
- 1.363 replicationScheduleDeactivateCheckpoints
- 1.364 replicationScheduleDelete
- 1.365 replicationScheduleDisable
- 1.366 replicationScheduleEnable
- 1.367 replicationScheduleEnum
- 1.368 replicationScheduleGet
- 1.369 replicationScheduleModify
- 1.370 replicationScheduleTrigger
- 1.371 reportGenerate
- 1.372 reportScheduleAddRemove
- 1.373 reportScheduleAssocEnum
- 1.374 reportScheduleAssocGet
- 1.375 reportScheduleCreate
- 1.376 reportScheduleDelete
- 1.377 reportScheduleDisable
- 1.378 reportScheduleEnable
- 1.379 reportScheduleEnum
- 1.380 reportScheduleGet
- 1.381 reportScheduleModify
- 1.382 reportScheduleTrigger
- 1.383 resourceDomainAssocEnum
- 1.384 resourceDomainAssocGet
- 1.385 resourceDomainCreate
- 1.386 resourceDomainDelete
- 1.387 resourceDomainEnum
- 1.388 resourceDomainGet
- 1.389 resourceDomainModify
- 1.390 resourceDomainStorageSystemAddRemove
- 1.391 roleCreate
- 1.392 roleDelete
- 1.393 roleEnum
- 1.394 roleGet
- 1.395 roleModify
- 1.396 rolePermissionAssignmentEnum
- 1.397 rolePermissionAssignmentGet
- 1.398 rolePermissionsAddRemove
- 1.399 roleSubjectAssocEnum
- 1.400 roleSubjectAssocGet
- 1.401 s3ProxyCreate
- 1.402 s3ProxyDelete
- 1.403 s3ProxyEnum
- 1.404 s3ProxyGet
- 1.405 s3ProxyModify
- 1.406 s3QuotaEnum
- 1.407 s3QuotaGet
- 1.408 s3QuotaSetGlobal
- 1.409 s3UserAccessKeyAdd
- 1.410 s3UserAccessKeyEnum
- 1.411 s3UserAccessKeyGet
- 1.412 s3UserAccessKeyModify
- 1.413 s3UserAccessKeyRemove
- 1.414 s3UserCreate
- 1.415 s3UserDelete
- 1.416 s3UserDisable
- 1.417 s3UserEnable
- 1.418 s3UserEnum
- 1.419 s3UserGet
- 1.420 s3UserModify
- 1.421 scrubScheduleAddRemove
- 1.422 scrubScheduleAssocEnum
- 1.423 scrubScheduleAssocGet
- 1.424 scrubScheduleCreate
- 1.425 scrubScheduleDelete
- 1.426 scrubScheduleDisable
- 1.427 scrubScheduleEnable
- 1.428 scrubScheduleEnum
- 1.429 scrubScheduleGet
- 1.430 scrubScheduleModify
- 1.431 scrubScheduleTrigger
- 1.432 serviceFirewallDefEnum
- 1.433 sessionClose
- 1.434 sessionEnum
- 1.435 sessionGet
- 1.436 setAuthMode
- 1.437 singleSignOnPolicyGet
- 1.438 singleSignOnPolicySet
- 1.439 siteClusterAssocEnum
- 1.440 siteClusterAssocGet
- 1.441 siteClusterCreate
- 1.442 siteClusterDelete
- 1.443 siteClusterEnum
- 1.444 siteClusterGet
- 1.445 siteClusterModify
- 1.446 siteClusterRestartServices
- 1.447 siteStorageSystemAddRemove
- 1.448 siteVifResourceCreate
- 1.449 siteVifResourceDelete
- 1.450 siteVifResourceEnum
- 1.451 siteVifResourceGet
- 1.452 siteVifResourceMove
- 1.453 snapshotScheduleAssocEnum
- 1.454 snapshotScheduleAssocGet
- 1.455 snapshotScheduleCreate
- 1.456 snapshotScheduleDelete
- 1.457 snapshotScheduleDisable
- 1.458 snapshotScheduleEnable
- 1.459 snapshotScheduleEnum
- 1.460 snapshotScheduleGet
- 1.461 snapshotScheduleModify
- 1.462 snapshotScheduleTrigger
- 1.463 snapshotScheduleVolumeAddRemove
- 1.464 storageCloudCreate
- 1.465 storageCloudDelete
- 1.466 storageCloudEnum
- 1.467 storageCloudGet
- 1.468 storageCloudModify
- 1.469 storageCloudResourceAddRemove
- 1.470 storageCloudResourceAssocEnum
- 1.471 storageCloudResourceAssocGet
- 1.472 storageCloudResourceSetMode
- 1.473 storageCloudSubjectAssocEnum
- 1.474 storageCloudSubjectAssocGet
- 1.475 storageCloudUserAddRemove
- 1.476 storagePoolCacheAddRemove
- 1.477 storagePoolCreate
- 1.478 storagePoolDestroy
- 1.479 storagePoolDeviceEnum
- 1.480 storagePoolDeviceGet
- 1.481 storagePoolDeviceGroupEnum
- 1.482 storagePoolDeviceGroupGet
- 1.483 storagePoolDeviceGroupIdentify
- 1.484 storagePoolEnum
- 1.485 storagePoolExpand
- 1.486 storagePoolExport
- 1.487 storagePoolGet
- 1.488 storagePoolGrow
- 1.489 storagePoolHaFailoverGroupActivate
- 1.490 storagePoolHaFailoverGroupCreate
- 1.491 storagePoolHaFailoverGroupDeactivate
- 1.492 storagePoolHaFailoverGroupDelete
- 1.493 storagePoolHaFailoverGroupEnum
- 1.494 storagePoolHaFailoverGroupFailover
- 1.495 storagePoolHaFailoverGroupGet
- 1.496 storagePoolHaFailoverGroupModify
- 1.497 storagePoolHaFailoverInterfaceCreate
- 1.498 storagePoolHaFailoverInterfaceDelete
- 1.499 storagePoolHaFailoverInterfaceEnum
- 1.500 storagePoolHaFailoverInterfaceGet
- 1.501 storagePoolHealthCheck
- 1.502 storagePoolIdentify
- 1.503 storagePoolImport
- 1.504 storagePoolImportEncrypted
- 1.505 storagePoolModify
- 1.506 storagePoolPreimportScan
- 1.507 storagePoolProfileEnum
- 1.508 storagePoolProfileGet
- 1.509 storagePoolPropertiesUpdate
- 1.510 storagePoolRescan
- 1.511 storagePoolScrubStart
- 1.512 storagePoolScrubStop
- 1.513 storagePoolSetPassphrase
- 1.514 storagePoolSpareAddRemove
- 1.515 storagePoolStart
- 1.516 storagePoolStop
- 1.517 storagePoolTrim
- 1.518 storagePoolUpdateRedirect
- 1.519 storageQuotaCreate
- 1.520 storageQuotaDelete
- 1.521 storageQuotaEnum
- 1.522 storageQuotaGet
- 1.523 storageQuotaModify
- 1.524 storageQuotaShareAddRemove
- 1.525 storageQuotaShareAssocEnum
- 1.526 storageQuotaShareAssocGet
- 1.527 storageQuotaVolumeAddRemove
- 1.528 storageQuotaVolumeAssocEnum
- 1.529 storageQuotaVolumeAssocGet
- 1.530 storageSystemClusterAssocEnum
- 1.531 storageSystemClusterAssocGet
- 1.532 storageSystemClusterCreate
- 1.533 storageSystemClusterDelete
- 1.534 storageSystemClusterEnum
- 1.535 storageSystemClusterGet
- 1.536 storageSystemClusterGetHostsConfig
- 1.537 storageSystemClusterMerge
- 1.538 storageSystemClusterModify
- 1.539 storageSystemClusterNodeAdd
- 1.540 storageSystemClusterNodeEject
- 1.541 storageSystemClusterNodeJoin
- 1.542 storageSystemClusterNodeRemove
- 1.543 storageSystemClusterNodeSetMaster
- 1.544 storageSystemClusterNodeSync
- 1.545 storageSystemClusterSendSupportLogs
- 1.546 storageSystemClusterSetHostsConfig
- 1.547 storageSystemClusterSplit
- 1.548 storageSystemEnum
- 1.549 storageSystemGet
- 1.550 storageSystemLinkCreate
- 1.551 storageSystemLinkDelete
- 1.552 storageSystemLinkDisconnect
- 1.553 storageSystemLinkEnum
- 1.554 storageSystemLinkEstablish
- 1.555 storageSystemLinkGet
- 1.556 storageSystemLinkModify
- 1.557 storageSystemLinkRefresh
- 1.558 storageSystemLinkSetCredentials
- 1.559 storageSystemLinkVerify
- 1.560 storageSystemMaintenance
- 1.561 storageSystemModify
- 1.562 storageSystemRecover
- 1.563 storageSystemRecoveryPointEnum
- 1.564 storageSystemRestart
- 1.565 storageSystemSendLogs
- 1.566 storageSystemServicesRestart
- 1.567 storageSystemShutdown
- 1.568 storageSystemSignalManager
- 1.569 storageSystemTimeZoneEnum
- 1.570 storageSystemTimeZoneSet
- 1.571 storageSystemTunableEnum
- 1.572 storageSystemTunableGet
- 1.573 storageSystemTunableProfileApply
- 1.574 storageSystemTunableProfileCreate
- 1.575 storageSystemTunableProfileDelete
- 1.576 storageSystemTunableProfileEnum
- 1.577 storageSystemTunableProfileGet
- 1.578 storageSystemTunableProfileModify
- 1.579 storageSystemTunableSet
- 1.580 storageSystemUpdateCheck
- 1.581 storageSystemUpgrade
- 1.582 storageSystemVersion
- 1.583 storageTierAssocEnum
- 1.584 storageTierAssocGet
- 1.585 storageTierCreate
- 1.586 storageTierDelete
- 1.587 storageTierEnum
- 1.588 storageTierGet
- 1.589 storageTierModify
- 1.590 storageTierPoolAddRemove
- 1.591 storageVolumeAclAddRemove
- 1.592 storageVolumeAclAddRemoveEx
- 1.593 storageVolumeAclEnum
- 1.594 storageVolumeAclGet
- 1.595 storageVolumeClone
- 1.596 storageVolumeCloudBackupCreate
- 1.597 storageVolumeCloudBackupRestore
- 1.598 storageVolumeCreate
- 1.599 storageVolumeCreateEx
- 1.600 storageVolumeCreatePassthru
- 1.601 storageVolumeDelete
- 1.602 storageVolumeDeleteEx
- 1.603 storageVolumeEnum
- 1.604 storageVolumeGet
- 1.605 storageVolumeGroupAssocEnum
- 1.606 storageVolumeGroupAssocGet
- 1.607 storageVolumeGroupClone
- 1.608 storageVolumeGroupCreate
- 1.609 storageVolumeGroupDelete
- 1.610 storageVolumeGroupEnum
- 1.611 storageVolumeGroupGet
- 1.612 storageVolumeGroupModify
- 1.613 storageVolumeGroupSnapshot
- 1.614 storageVolumeGroupVolumeAddRemove
- 1.615 storageVolumeHealthCheck
- 1.616 storageVolumeImport
- 1.617 storageVolumeModify
- 1.618 storageVolumeProfileEnum
- 1.619 storageVolumeProfileGet
- 1.620 storageVolumeReassignSchedule
- 1.621 storageVolumeResize
- 1.622 storageVolumeRestore
- 1.623 storageVolumeRollback
- 1.624 storageVolumeSetQosControls
- 1.625 storageVolumeSnapshot
- 1.626 storageVolumeSnapshotRevert
- 1.627 storageVolumeUtilizationEnum
- 1.628 storageVolumeUtilizationGet
- 1.629 storageVolumeUtilizationGetRetentionPeriod
- 1.630 storageVolumeUtilizationSetRetentionPeriod
- 1.631 swControllerEnum
- 1.632 swControllerGet
- 1.633 swControllerGroupEnum
- 1.634 swControllerGroupGet
- 1.635 swControllerIscsiConfigAdd
- 1.636 swControllerPortalAdd
- 1.637 swControllerPortalRemove
- 1.638 swControllerPortalScan
- 1.639 swControllerTargetEnum
- 1.640 swControllerTargetGet
- 1.641 swControllerTargetLogin
- 1.642 swControllerTargetLogout
- 1.643 swDiskSessionEnum
- 1.644 swDiskSessionGet
- 1.645 systemCapabilityMetaDataGet
- 1.646 targetPortDisable
- 1.647 targetPortEnable
- 1.648 targetPortEnum
- 1.649 targetPortGet
- 1.650 targetPortModify
- 1.651 targetPortRescan
- 1.652 targetPortRestart
- 1.653 targetVirtualInterfaceCreate
- 1.654 targetVirtualInterfaceMove
- 1.655 targetVirtualPortCreate
- 1.656 targetVirtualPortDelete
- 1.657 targetVlanInterfaceCreate
- 1.658 taskCancel
- 1.659 taskClearAll
- 1.660 taskEnum
- 1.661 taskGet
- 1.662 taskLockEnum
- 1.663 taskLockRelease
- 1.664 taskProceed
- 1.665 taskUpdateProgress
- 1.666 traceLevelGet
- 1.667 traceLevelModify
- 1.668 traceLogMessage
- 1.669 userAdd
- 1.670 userAppTokenCreate
- 1.671 userAppTokenEnum
- 1.672 userAppTokenGet
- 1.673 userAppTokenRegen
- 1.674 userAppTokenRemove
- 1.675 userAuthenticate
- 1.676 userAuthorization
- 1.677 userEnum
- 1.678 userGet
- 1.679 userGroupAssocEnum
- 1.680 userGroupAssocGet
- 1.681 userGroupCreate
- 1.682 userGroupDelete
- 1.683 userGroupEnum
- 1.684 userGroupGet
- 1.685 userGroupModify
- 1.686 userGroupUserAddRemove
- 1.687 userModify
- 1.688 userPasswordSet
- 1.689 userRemove
- 1.690 virtualInterfaceAssocEnum
- 1.691 virtualInterfaceAssocGet
- 2 Object Type Definitions
- 2.1 osn:acl
- 2.2 osn:activeDirDomain
- 2.3 osn:activeDirUserGroup
- 2.4 osn:alert
- 2.5 osn:alertConfigSettings
- 2.6 osn:alertType
- 2.7 osn:auditEntry
- 2.8 osn:auditSettings
- 2.9 osn:backupJob
- 2.10 osn:backupPolicy
- 2.11 osn:bucket
- 2.12 osn:bucketObject
- 2.13 osn:bucketUserAssoc
- 2.14 osn:capabilityMetaData
- 2.15 osn:cephCluster
- 2.16 osn:cephClusterMember
- 2.17 osn:cephClusterServiceEvent
- 2.18 osn:cephCrushRule
- 2.19 osn:cephFilesystem
- 2.20 osn:cephFilesystemPoolAssoc
- 2.21 osn:cephJournalDevice
- 2.22 osn:cephJournalGroup
- 2.23 osn:cephMds
- 2.24 osn:cephMonitor
- 2.25 osn:cephObjectPoolGroup
- 2.26 osn:cephOsd
- 2.27 osn:cephPgSet
- 2.28 osn:cephPool
- 2.29 osn:cephPoolOsdAssoc
- 2.30 osn:cephPoolProfile
- 2.31 osn:cephRadosGateway
- 2.32 osn:cloudBackupSchedule
- 2.33 osn:cloudBackupScheduleAssoc
- 2.34 osn:cloudContainer
- 2.35 osn:cloudContainerCacheSettings
- 2.36 osn:cloudProvider
- 2.37 osn:cloudProviderCredentials
- 2.38 osn:cloudProviderLocation
- 2.39 osn:clusterRing
- 2.40 osn:clusterRingMember
- 2.41 osn:errorMessage
- 2.42 osn:event
- 2.43 osn:eventListener
- 2.44 osn:fcTargetPort
- 2.45 osn:hardwareConfiguration
- 2.46 osn:host
- 2.47 osn:hostGroup
- 2.48 osn:hwAlarm
- 2.49 osn:hwBatteryBackupUnit
- 2.50 osn:hwController
- 2.51 osn:hwControllerGroup
- 2.52 osn:hwDisk
- 2.53 osn:hwEnclosure
- 2.54 osn:hwEnclosureLayout
- 2.55 osn:hwEnclosureLayoutSlotExclusion
- 2.56 osn:hwEnclosureLayoutVendorGroup
- 2.57 osn:hwLogicalDrive
- 2.58 osn:hwUnit
- 2.59 osn:hwUnitDiskAssoc
- 2.60 osn:i18nString
- 2.61 osn:ibTargetPort
- 2.62 osn:initiatorPort
- 2.63 osn:keyInfo
- 2.64 osn:keyValuePair
- 2.65 osn:keyVaultModule
- 2.66 osn:keyVaultProfile
- 2.67 osn:libratoMetricsConfig
- 2.68 osn:license
- 2.69 osn:licenseActivation
- 2.70 osn:licenseLease
- 2.71 osn:lock
- 2.72 osn:mfaLogin
- 2.73 osn:multiFactorAuthConfig
- 2.74 osn:multiFactorAuthDevice
- 2.75 osn:multipathConfig
- 2.76 osn:networkShare
- 2.77 osn:networkShareCifsOption
- 2.78 osn:networkShareClient
- 2.79 osn:networkShareFile
- 2.80 osn:networkShareFileLock
- 2.81 osn:networkShareNamespace
- 2.82 osn:networkShareNamespaceShareAssoc
- 2.83 osn:networkShareNamespaceSystemAssoc
- 2.84 osn:networkShareQuota
- 2.85 osn:networkShareServiceConfig
- 2.86 osn:networkShareSession
- 2.87 osn:networkShareUserAccess
- 2.88 osn:nodeAssoc
- 2.89 osn:object
- 2.90 osn:objectProperty
- 2.91 osn:passwordPolicy
- 2.92 osn:permissionAssignment
- 2.93 osn:permissionDefinition
- 2.94 osn:physicalDisk
- 2.95 osn:physicalDiskHotspareMarker
- 2.96 osn:physicalDiskPathAssoc
- 2.97 osn:providerApp
- 2.98 osn:provisionable
- 2.99 osn:qosPolicy
- 2.100 osn:replicaAssoc
- 2.101 osn:replicaReportEntry
- 2.102 osn:replicaReportSummary
- 2.103 osn:replicatable
- 2.104 osn:replicationSchedule
- 2.105 osn:replicationScheduleAssocEx
- 2.106 osn:report
- 2.107 osn:reportEntry
- 2.108 osn:reportSchedule
- 2.109 osn:reportScheduleAssoc
- 2.110 osn:resourceDomain
- 2.111 osn:resourceDomainAssoc
- 2.112 osn:resourceHealthCheck
- 2.113 osn:role
- 2.114 osn:rolePermissionAssignment
- 2.115 osn:roleSubjectAssoc
- 2.116 osn:s3Proxy
- 2.117 osn:s3Quota
- 2.118 osn:s3User
- 2.119 osn:s3UserAccessKey
- 2.120 osn:schedule
- 2.121 osn:scrubSchedule
- 2.122 osn:scrubScheduleAssoc
- 2.123 osn:serviceFirewallDef
- 2.124 osn:session
- 2.125 osn:singleSignOnPolicy
- 2.126 osn:siteCluster
- 2.127 osn:siteClusterAssoc
- 2.128 osn:siteVifResource
- 2.129 osn:snapshotReference
- 2.130 osn:snapshotSchedule
- 2.131 osn:snapshotScheduleAssoc
- 2.132 osn:storageCloud
- 2.133 osn:storageCloudResourceAssoc
- 2.134 osn:storageCloudSubjectAssoc
- 2.135 osn:storagePool
- 2.136 osn:storagePoolDevice
- 2.137 osn:storagePoolDeviceGroup
- 2.138 osn:storagePoolHaFailoverGroup
- 2.139 osn:storagePoolHaFailoverInterface
- 2.140 osn:storagePoolProfile
- 2.141 osn:storageQuota
- 2.142 osn:storageQuotaShareAssoc
- 2.143 osn:storageQuotaVolumeAssoc
- 2.144 osn:storageSystem
- 2.145 osn:storageSystemCluster
- 2.146 osn:storageSystemClusterAssoc
- 2.147 osn:storageSystemHwConfig
- 2.148 osn:storageSystemLink
- 2.149 osn:storageSystemLinkKey
- 2.150 osn:storageSystemRecoveryPoint
- 2.151 osn:storageSystemTunable
- 2.152 osn:storageSystemTunableAssoc
- 2.153 osn:storageSystemTunableProfile
- 2.154 osn:storageTier
- 2.155 osn:storageTierAssoc
- 2.156 osn:storageVolume
- 2.157 osn:storageVolumeAcl
- 2.158 osn:storageVolumeGroup
- 2.159 osn:storageVolumeGroupAssoc
- 2.160 osn:storageVolumeProfile
- 2.161 osn:storageVolumeUtilization
- 2.162 osn:subject
- 2.163 osn:swController
- 2.164 osn:swControllerGroup
- 2.165 osn:swControllerTarget
- 2.166 osn:swDiskSession
- 2.167 osn:targetPort
- 2.168 osn:task
- 2.169 osn:timeZone
- 2.170 osn:traceLevel
- 2.171 osn:user
- 2.172 osn:userAppToken
- 2.173 osn:userGroup
- 2.174 osn:userGroupAssoc
- 2.175 osn:virtualInterfaceAssoc
- 3 Enum Definitions
- 3.1 enum:accessKeyType
- 3.2 enum:accessType
- 3.3 enum:aclType
- 3.4 enum:activeDirSearchStatus
- 3.5 enum:alertHandlerWebhookType
- 3.6 enum:alertSubscription
- 3.7 enum:arpFilterMode
- 3.8 enum:arpFilterStatus
- 3.9 enum:backupJobStage
- 3.10 enum:backupPolicyMountType
- 3.11 enum:backupPolicyRetentionCriteria
- 3.12 enum:backupPolicyType
- 3.13 enum:backupPurgePolicy
- 3.14 enum:blinkReason
- 3.15 enum:blinkType
- 3.16 enum:bondMode
- 3.17 enum:bucketAclType
- 3.18 enum:bucketObjectLockMode
- 3.19 enum:bucketType
- 3.20 enum:cacheType
- 3.21 enum:capabilityValType
- 3.22 enum:cephClusterAuthMode
- 3.23 enum:cephCrushDeviceClass
- 3.24 enum:cephCrushRuleType
- 3.25 enum:cephECPlugin
- 3.26 enum:cephECTechnique
- 3.27 enum:cephFailureDomain
- 3.28 enum:cephJournalGroupType
- 3.29 enum:cephJournalMode
- 3.30 enum:cephMonOsdSubtreeLimit
- 3.31 enum:cephOsdType
- 3.32 enum:cephOsdWeightPolicy
- 3.33 enum:cephUseCase
- 3.34 enum:cephUserAccessOpMask
- 3.35 enum:chapPolicy
- 3.36 enum:cifsUserAccessMode
- 3.37 enum:cloudContainerCacheMode
- 3.38 enum:cloudContainerType
- 3.39 enum:cloudProviderType
- 3.40 enum:consistencyCheck
- 3.41 enum:correlationDiskType
- 3.42 enum:dataShredMode
- 3.43 enum:dataType
- 3.44 enum:daysOfWeekMask
- 3.45 enum:dfsNamespaceModeType
- 3.46 enum:diskCategory
- 3.47 enum:diskSmrZoningType
- 3.48 enum:diskStateDetail
- 3.49 enum:diskType
- 3.50 enum:enterMaintenanceModeMask
- 3.51 enum:errorLevel
- 3.52 enum:ethPortNaming
- 3.53 enum:eventListenerMode
- 3.54 enum:eventListenerType
- 3.55 enum:eventType
- 3.56 enum:exitMaintenanceModeMask
- 3.57 enum:failoverReason
- 3.58 enum:fipsState
- 3.59 enum:flags
- 3.60 enum:haClientConnectivityPolicy
- 3.61 enum:haLinkStateFailoverPolicy
- 3.62 enum:hostType
- 3.63 enum:hotsparePoolRepairPolicy
- 3.64 enum:hotsparePoolRepairState
- 3.65 enum:hwAutoMaintenanceMask
- 3.66 enum:hwCachePolicy
- 3.67 enum:hwControllerCapabilities
- 3.68 enum:hwDiskCapabilities
- 3.69 enum:hwEnclosureLayoutFlow
- 3.70 enum:hwEnclosureLayoutType
- 3.71 enum:hwUnitCapabilities
- 3.72 enum:imageFileType
- 3.73 enum:initPriorityType
- 3.74 enum:initiatorType
- 3.75 enum:ipmiHealthState
- 3.76 enum:keyType
- 3.77 enum:keyVaultType
- 3.78 enum:licenseCategory
- 3.79 enum:licenseDuration
- 3.80 enum:licenseEdition
- 3.81 enum:licenseState
- 3.82 enum:licenseType
- 3.83 enum:linkState
- 3.84 enum:lockType
- 3.85 enum:logCollectionMode
- 3.86 enum:lunAssignmentPolicy
- 3.87 enum:managerClass
- 3.88 enum:memoryEccType
- 3.89 enum:modifyType
- 3.90 enum:multiFactorAuthMode
- 3.91 enum:multiFactorAuthProvider
- 3.92 enum:multiFactorAuthStatus
- 3.93 enum:multipathConfigMode
- 3.94 enum:networkShareFileAccess
- 3.95 enum:networkShareFileOplock
- 3.96 enum:networkShareSessionType
- 3.97 enum:networkShareType
- 3.98 enum:nfsKerberosMode
- 3.99 enum:nfsNamespaceModeType
- 3.100 enum:nfsServiceMode
- 3.101 enum:objectState
- 3.102 enum:objectType
- 3.103 enum:passwordComplexityReq
- 3.104 enum:permissionScope
- 3.105 enum:poolEnclosureRedundancy
- 3.106 enum:protocolDisable
- 3.107 enum:providerRegistrationScope
- 3.108 enum:providerType
- 3.109 enum:quotaPolicy
- 3.110 enum:quotaSubjectType
- 3.111 enum:raidType
- 3.112 enum:remoteReplicaFlags
- 3.113 enum:replicaAssocType
- 3.114 enum:replicaRetentionTag
- 3.115 enum:replicationActionType
- 3.116 enum:replicationCongestionPolicy
- 3.117 enum:replicationState
- 3.118 enum:reportCategory
- 3.119 enum:reportImpact
- 3.120 enum:reportOutputFormat
- 3.121 enum:reportSeverity
- 3.122 enum:reportTypes
- 3.123 enum:resourceAccessMode
- 3.124 enum:resourceAccessRequestType
- 3.125 enum:resourceDomainTypes
- 3.126 enum:retentionTag
- 3.127 enum:s3QuotaScope
- 3.128 enum:sambaIdmapMode
- 3.129 enum:scheduleTimerType
- 3.130 enum:securityWebAccessMode
- 3.131 enum:serviceUpdateMode
- 3.132 enum:shareSettingsInheritance
- 3.133 enum:sourceType
- 3.134 enum:storagePoolCacheType
- 3.135 enum:storagePoolType
- 3.136 enum:storageSystemLinkType
- 3.137 enum:storageVolumeType
- 3.138 enum:swControllerConnectionState
- 3.139 enum:swControllerSessionState
- 3.140 enum:swControllerType
- 3.141 enum:syncPolicy
- 3.142 enum:targetType
- 3.143 enum:taskState
- 3.144 enum:trimStatus
- 3.145 enum:tunableDataType
- 3.146 enum:tunableOption
- 3.147 enum:userAccountType
- 3.148 enum:userAppTokenAccessMode
- 3.149 enum:vdevType
- 3.150 enum:vvolType
- 3.151 enum:wuiSectionDisable
- 3.152 enum:wuiTabDisable
Service API Definitions
aclAdd
Request Parameters
{ "method": "aclAdd", "params": { "ownerId": xsd:string "ownerType": xsd:unsignedInt "objectId": xsd:string "objectType": xsd:unsignedInt "accessLevel": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:object }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/aclAdd?ownerId=val0&ownerType=0&objectId=val2&objectType=0&accessLevel=0&flags=0"
curl -k -u admin:password -d @aclAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
aclModify
Request Parameters
{ "method": "aclModify", "params": { "ownerId": xsd:string "ownerType": xsd:unsignedInt "objectId": xsd:string "objectType": xsd:unsignedInt "accessLevel": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:object }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/aclModify?ownerId=val0&ownerType=0&objectId=val2&objectType=0&accessLevel=0&flags=0"
curl -k -u admin:password -d @aclModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
aclRemove
Request Parameters
{ "method": "aclRemove", "params": { "ownerId": xsd:string "ownerType": xsd:unsignedInt "objectId": xsd:string "objectType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:object }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/aclRemove?ownerId=val0&ownerType=0&objectId=val2&objectType=0&flags=0"
curl -k -u admin:password -d @aclRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
activeDirectoryDomainEnum
Request Parameters
{ "method": "activeDirectoryDomainEnum", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:activeDirDomain }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/activeDirectoryDomainEnum?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @activeDirectoryDomainEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
activeDirectoryUserAndGroupEnumEx
Request Parameters
{ "method": "activeDirectoryUserAndGroupEnumEx", "params": { "storageSystemId": xsd:string "isGroup": xsd:boolean "domain": xsd:string "filter": xsd:string "organizationalUnit": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:activeDirUserGroup "activeDirStatus": xsd:unsignedInt }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/activeDirectoryUserAndGroupEnumEx?storageSystemId=val0&isGroup=val1&domain=val2&filter=val3&organizationalUnit=val4&flags=0"
curl -k -u admin:password -d @activeDirectoryUserAndGroupEnumEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
alertClear
Request Parameters
{ "method": "alertClear", "params": { "filter": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:alert }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertClear?filter=val0&flags=0"
curl -k -u admin:password -d @alertClear.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
alertClearAll
Request Parameters
{ "method": "alertClearAll", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:alert }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertClearAll?flags=0"
curl -k -u admin:password -d @alertClearAll.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
alertConfigGet
Request Parameters
{ "method": "alertConfigGet", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:alertConfigSettings }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertConfigGet?flags=0"
curl -k -u admin:password -d @alertConfigGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
alertConfigSet
Request Parameters
{ "method": "alertConfigSet", "params": { "senderEmailAddress": xsd:string "smtpServerIpAddress": xsd:string "smtpServerPort": xsd:unsignedInt "smtpUsername": xsd:string "smtpPassword": xsd:string "smtpAuthType": xsd:unsignedInt "customerSupportEmailAddress": xsd:string "poolFreeSpaceWarningThreshold": xsd:unsignedInt "poolFreeSpaceAlertThreshold": xsd:unsignedInt "poolFreeSpaceCriticalAlertThreshold": xsd:unsignedInt "pagerDutyServiceKey": xsd:string "slackWebhookUrl": xsd:string "mattermostWebhookUrl": xsd:string "enableAlertTypes": xsd:string "disableAlertTypes": xsd:string "pauseAlertTypes": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:alertConfigSettings }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertConfigSet?senderEmailAddress=val0&smtpServerIpAddress=val1&smtpServerPort=0&smtpUsername=val3&smtpPassword=val4&smtpAuthType=0&customerSupportEmailAddress=val6&poolFreeSpaceWarningThreshold=0&poolFreeSpaceAlertThreshold=0&poolFreeSpaceCriticalAlertThreshold=0&pagerDutyServiceKey=val10&slackWebhookUrl=val11&mattermostWebhookUrl=val12&enableAlertTypes=val13&disableAlertTypes=val14&pauseAlertTypes=val15&flags=0"
curl -k -u admin:password -d @alertConfigSet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
alertEnum
Request Parameters
{ "method": "alertEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:alert }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertEnum?flags=0"
curl -k -u admin:password -d @alertEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
alertGet
Request Parameters
{ "method": "alertGet", "params": { "id": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:alert }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertGet?id=val0&flags=0"
curl -k -u admin:password -d @alertGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
alertRaise
Request Parameters
{ "method": "alertRaise", "params": { "title": xsd:string "message": xsd:string "severity": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:alert }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertRaise?title=val0&message=val1&severity=0&flags=0"
curl -k -u admin:password -d @alertRaise.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
alertTypeEnum
Request Parameters
{ "method": "alertTypeEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:alertType }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertTypeEnum?flags=0"
curl -k -u admin:password -d @alertTypeEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
alertTypeGet
Request Parameters
{ "method": "alertTypeGet", "params": { "alertType": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:alertType }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertTypeGet?alertType=val0&flags=0"
curl -k -u admin:password -d @alertTypeGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
auditLogClear
Request Parameters
{ "method": "auditLogClear", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:auditEntry }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/auditLogClear?flags=0"
curl -k -u admin:password -d @auditLogClear.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
auditLogDisable
Request Parameters
{ "method": "auditLogDisable", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:auditSettings }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/auditLogDisable?flags=0"
curl -k -u admin:password -d @auditLogDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
auditLogEnable
Request Parameters
{ "method": "auditLogEnable", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:auditSettings }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/auditLogEnable?flags=0"
curl -k -u admin:password -d @auditLogEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
auditLogGet
Request Parameters
{ "method": "auditLogGet", "params": { "user": xsd:string "startDate": xsd:dateTime "endDate": xsd:dateTime "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:auditEntry }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/auditLogGet?user=val0&startDate=val1&endDate=val2&flags=0"
curl -k -u admin:password -d @auditLogGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupJobCancel
Request Parameters
{ "method": "backupJobCancel", "params": { "backupJob": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupJob }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobCancel?backupJob=val0&flags=0"
curl -k -u admin:password -d @backupJobCancel.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupJobEnum
Request Parameters
{ "method": "backupJobEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:backupJob }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobEnum?flags=0"
curl -k -u admin:password -d @backupJobEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupJobGet
Request Parameters
{ "method": "backupJobGet", "params": { "backupJob": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupJob }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobGet?backupJob=val0&flags=0"
curl -k -u admin:password -d @backupJobGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupJobStart
Request Parameters
{ "method": "backupJobStart", "params": { "backupPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupJob }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobStart?backupPolicy=val0&flags=0"
curl -k -u admin:password -d @backupJobStart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupJobStatusUpdate
Request Parameters
{ "method": "backupJobStatusUpdate", "params": { "statusXml": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupJob }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobStatusUpdate?statusXml=val0&flags=0"
curl -k -u admin:password -d @backupJobStatusUpdate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupPolicyCreate
Request Parameters
{ "method": "backupPolicyCreate", "params": { "name": xsd:string "description": xsd:string "networkShareId": xsd:string "remoteHostname": xsd:string "remoteExportPath": xsd:string "remoteMountType": xsd:unsignedInt "maxSnapshots": xsd:unsignedInt "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "retentionCriteria": xsd:unsignedInt "startDate": xsd:dateTime "policyType": xsd:unsignedInt "scanThreads": xsd:unsignedInt "retentionDays": xsd:unsignedInt "purgePolicy": xsd:unsignedInt "createBackupLogs": xsd:boolean "backupToShareRoot": xsd:boolean "setEnabled": xsd:boolean "scheduleType": xsd:unsignedInt "delayInterval": xsd:unsignedInt "offsetMinutes": xsd:unsignedInt "retentionCountHourlies": xsd:unsignedInt "retentionCountDailies": xsd:unsignedInt "retentionCountWeeklies": xsd:unsignedInt "retentionCountMonthlies": xsd:unsignedInt "retentionCountQuarterlies": xsd:unsignedInt "remoteSmbUsername": xsd:string "remoteSmbPassword": xsd:string "minFileAgeDays": xsd:unsignedInt "maxFileAgeDays": xsd:unsignedInt "createLinks": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyCreate?name=val0&description=val1&networkShareId=val2&remoteHostname=val3&remoteExportPath=val4&remoteMountType=0&maxSnapshots=0&daysOfWeek=0&hoursOfDay=0&retentionCriteria=0&startDate=val10&policyType=0&scanThreads=0&retentionDays=0&purgePolicy=0&createBackupLogs=val15&backupToShareRoot=val16&setEnabled=val17&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&remoteSmbUsername=val26&remoteSmbPassword=val27&minFileAgeDays=0&maxFileAgeDays=0&createLinks=val30&flags=0"
curl -k -u admin:password -d @backupPolicyCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupPolicyDelete
Request Parameters
{ "method": "backupPolicyDelete", "params": { "backupPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyDelete?backupPolicy=val0&flags=0"
curl -k -u admin:password -d @backupPolicyDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupPolicyDisable
Request Parameters
{ "method": "backupPolicyDisable", "params": { "backupPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyDisable?backupPolicy=val0&flags=0"
curl -k -u admin:password -d @backupPolicyDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupPolicyEnable
Request Parameters
{ "method": "backupPolicyEnable", "params": { "backupPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyEnable?backupPolicy=val0&flags=0"
curl -k -u admin:password -d @backupPolicyEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupPolicyEnum
Request Parameters
{ "method": "backupPolicyEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:backupPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyEnum?flags=0"
curl -k -u admin:password -d @backupPolicyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupPolicyGet
Request Parameters
{ "method": "backupPolicyGet", "params": { "backupPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyGet?backupPolicy=val0&flags=0"
curl -k -u admin:password -d @backupPolicyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupPolicyModify
Request Parameters
{ "method": "backupPolicyModify", "params": { "backupPolicy": xsd:string "name": xsd:string "description": xsd:string "networkShareId": xsd:string "remoteHostname": xsd:string "remoteExportPath": xsd:string "remoteMountType": xsd:unsignedInt "maxSnapshots": xsd:unsignedInt "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "retentionCriteria": xsd:unsignedInt "startDate": xsd:dateTime "policyType": xsd:unsignedInt "scanThreads": xsd:unsignedInt "retentionDays": xsd:unsignedInt "purgePolicy": xsd:unsignedInt "createBackupLogs": xsd:boolean "backupToShareRoot": xsd:boolean "setEnabled": xsd:boolean "scheduleType": xsd:unsignedInt "delayInterval": xsd:unsignedInt "offsetMinutes": xsd:unsignedInt "retentionCountHourlies": xsd:unsignedInt "retentionCountDailies": xsd:unsignedInt "retentionCountWeeklies": xsd:unsignedInt "retentionCountMonthlies": xsd:unsignedInt "retentionCountQuarterlies": xsd:unsignedInt "remoteSmbUsername": xsd:string "remoteSmbPassword": xsd:string "minFileAgeDays": xsd:unsignedInt "maxFileAgeDays": xsd:unsignedInt "createLinks": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyModify?backupPolicy=val0&name=val1&description=val2&networkShareId=val3&remoteHostname=val4&remoteExportPath=val5&remoteMountType=0&maxSnapshots=0&daysOfWeek=0&hoursOfDay=0&retentionCriteria=0&startDate=val11&policyType=0&scanThreads=0&retentionDays=0&purgePolicy=0&createBackupLogs=val16&backupToShareRoot=val17&setEnabled=val18&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&remoteSmbUsername=val27&remoteSmbPassword=val28&minFileAgeDays=0&maxFileAgeDays=0&createLinks=val31&flags=0"
curl -k -u admin:password -d @backupPolicyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
backupPolicyTrigger
Request Parameters
{ "method": "backupPolicyTrigger", "params": { "backupPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:backupPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyTrigger?backupPolicy=val0&flags=0"
curl -k -u admin:password -d @backupPolicyTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
bucketCreate
Creates a new S3 bucket in the specified Ceph Cluster
Request Parameters
{ "method": "bucketCreate", "params": { "name": xsd:string "cephClusterId": xsd:string "quotaSize": xsd:unsignedLong "userAccessEntry": xsd:string "bucketAclType": xsd:unsignedInt - see osn__bucketAclType "objectLockMode": xsd:unsignedInt - see osn__bucketObjectLockMode "objectLockRetentionDays": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:bucket }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketCreate?name=val0&cephClusterId=val1"aSize=val2&userAccessEntry=val3&bucketAclType=0&objectLockMode=0&objectLockRetentionDays=0&flags=0"
curl -k -u admin:password -d @bucketCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
bucketDelete
Deletes the specified S3 bucket
Request Parameters
{ "method": "bucketDelete", "params": { "cephClusterId": xsd:string "bucketList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:bucket }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketDelete?cephClusterId=val0&bucketList=val1&flags=0"
curl -k -u admin:password -d @bucketDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
bucketEnum
Returns a list of all the buckets, optionally filtered by Ceph Cluster
Request Parameters
{ "method": "bucketEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:bucket }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @bucketEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
bucketGet
Returns detailed info of the specified bucket
Request Parameters
{ "method": "bucketGet", "params": { "cephClusterId": xsd:string "bucket": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:bucket }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketGet?cephClusterId=val0&bucket=val1&flags=0"
curl -k -u admin:password -d @bucketGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
bucketModify
Modifies S3 bucket with passed arguments
Request Parameters
{ "method": "bucketModify", "params": { "bucketId": xsd:string "objectLockMode": xsd:unsignedInt - see osn__bucketObjectLockMode "objectLockRetentionDays": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:bucket }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketModify?bucketId=val0&objectLockMode=0&objectLockRetentionDays=0&flags=0"
curl -k -u admin:password -d @bucketModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
bucketObjectEnum
Returns a list of objects contained within the specified bucket
Request Parameters
{ "method": "bucketObjectEnum", "params": { "cephClusterId": xsd:string "bucket": xsd:string "startingIndex": xsd:unsignedInt "maxEntries": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:bucketObject "bucketStartingIndex": xsd:unsignedInt "bucketObjectCount": xsd:unsignedInt }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketObjectEnum?cephClusterId=val0&bucket=val1&startingIndex=0&maxEntries=0&flags=0"
curl -k -u admin:password -d @bucketObjectEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
bucketRescan
Starts an immediate scan for S3 buckets that have been added or removed.
Request Parameters
{ "method": "bucketRescan", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketRescan?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @bucketRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
bucketUserAssocEnum
Returns a list of all the bucket quotas, optionally filtered by ceph cluster
Request Parameters
{ "method": "bucketUserAssocEnum", "params": { "cephClusterId": xsd:string "bucketId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:bucketUserAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketUserAssocEnum?cephClusterId=val0&bucketId=val1&flags=0"
curl -k -u admin:password -d @bucketUserAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
bucketUserAssocGet
Returns a list of all the bucket quotas, optionally filtered by ceph cluster
Request Parameters
{ "method": "bucketUserAssocGet", "params": { "bucketId": xsd:string "cephUserAccessId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:bucketUserAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketUserAssocGet?bucketId=val0&cephUserAccessId=val1&flags=0"
curl -k -u admin:password -d @bucketUserAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterAddNode
Request Parameters
{ "method": "cephClusterAddNode", "params": { "clusterId": xsd:string "storageSystemId": xsd:string "interfacePortId": xsd:string "publicnetwork": xsd:string "clusternetwork": xsd:string "enableObjectStore": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterAddNode?clusterId=val0&storageSystemId=val1&interfacePortId=val2&publicnetwork=val3&clusternetwork=val4&enableObjectStore=val5&flags=0"
curl -k -u admin:password -d @cephClusterAddNode.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterCreate
Request Parameters
{ "method": "cephClusterCreate", "params": { "name": xsd:string "description": xsd:string "domainSuffix": xsd:string "clientInterfacePortList": xsd:string "backendInterfacePortList": xsd:string "clientNetwork": xsd:string "backendNetwork": xsd:string "clusterAuthMode": xsd:unsignedInt "osdOutSubtreeLimit": xsd:unsignedInt "enableOsdEncryption": xsd:boolean "enableOsdCompression": xsd:boolean "osdDownTimeoutSec": xsd:unsignedInt "osdOutTimeoutSec": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterCreate?name=val0&description=val1&domainSuffix=val2&clientInterfacePortList=val3&backendInterfacePortList=val4&clientNetwork=val5&backendNetwork=val6&clusterAuthMode=0&osdOutSubtreeLimit=0&enableOsdEncryption=val9&enableOsdCompression=val10&osdDownTimeoutSec=0&osdOutTimeoutSec=0&flags=0"
curl -k -u admin:password -d @cephClusterCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterDelete
Request Parameters
{ "method": "cephClusterDelete", "params": { "cluster": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterDelete?cluster=val0&flags=0"
curl -k -u admin:password -d @cephClusterDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterEnum
Request Parameters
{ "method": "cephClusterEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterEnum?flags=0"
curl -k -u admin:password -d @cephClusterEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterFixClockSkew
Request Parameters
{ "method": "cephClusterFixClockSkew", "params": { "cephCluster": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterFixClockSkew?cephCluster=val0&flags=0"
curl -k -u admin:password -d @cephClusterFixClockSkew.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterGet
Request Parameters
{ "method": "cephClusterGet", "params": { "cephCluster": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterGet?cephCluster=val0&flags=0"
curl -k -u admin:password -d @cephClusterGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterMemberEnum
Request Parameters
{ "method": "cephClusterMemberEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephClusterMember }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterMemberEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephClusterMemberEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterMemberGet
Request Parameters
{ "method": "cephClusterMemberGet", "params": { "cephCluster": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephClusterMember }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterMemberGet?cephCluster=val0&flags=0"
curl -k -u admin:password -d @cephClusterMemberGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterModify
Request Parameters
{ "method": "cephClusterModify", "params": { "cephCluster": xsd:string "name": xsd:string "description": xsd:string "osdDownTimeoutSec": xsd:unsignedInt "osdOutTimeoutSec": xsd:unsignedInt "nearFillFullPercent": xsd:unsignedInt "backFillFullPercent": xsd:unsignedInt "fullPercent": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterModify?cephCluster=val0&name=val1&description=val2&osdDownTimeoutSec=0&osdOutTimeoutSec=0&nearFillFullPercent=0&backFillFullPercent=0&fullPercent=0&flags=0"
curl -k -u admin:password -d @cephClusterModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterRemoveNode
Request Parameters
{ "method": "cephClusterRemoveNode", "params": { "clusterId": xsd:string "memberNodeId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterRemoveNode?clusterId=val0&memberNodeId=val1&flags=0"
curl -k -u admin:password -d @cephClusterRemoveNode.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterServiceEventDelete
Request Parameters
{ "method": "cephClusterServiceEventDelete", "params": { "clusterId": xsd:string "prune": xsd:boolean "crashIdList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterServiceEventDelete?clusterId=val0&prune=val1&crashIdList=val2&flags=0"
curl -k -u admin:password -d @cephClusterServiceEventDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephClusterServiceEventEnum
Request Parameters
{ "method": "cephClusterServiceEventEnum", "params": { "clusterId": xsd:string "includeOld": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephClusterServiceEvent }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterServiceEventEnum?clusterId=val0&includeOld=val1&flags=0"
curl -k -u admin:password -d @cephClusterServiceEventEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephCrushRuleCreate
Request Parameters
{ "method": "cephCrushRuleCreate", "params": { "name": xsd:string "description": xsd:string "cephClusterId": xsd:string "crushRuleType": xsd:string "failureDomain": xsd:string "crushRoot": xsd:string "deviceClass": xsd:string "crushPoolProfileId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCrushRule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephCrushRuleCreate?name=val0&description=val1&cephClusterId=val2&crushRuleType=val3&failureDomain=val4&crushRoot=val5&deviceClass=val6&crushPoolProfileId=val7&flags=0"
curl -k -u admin:password -d @cephCrushRuleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephCrushRuleDelete
Request Parameters
{ "method": "cephCrushRuleDelete", "params": { "cephCrushRuleId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephCrushRule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephCrushRuleDelete?cephCrushRuleId=val0&flags=0"
curl -k -u admin:password -d @cephCrushRuleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephCrushRuleEnum
Request Parameters
{ "method": "cephCrushRuleEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephCrushRule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephCrushRuleEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephCrushRuleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephCrushRuleGet
Request Parameters
{ "method": "cephCrushRuleGet", "params": { "cephCrushRule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephCrushRule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephCrushRuleGet?cephCrushRule=val0&flags=0"
curl -k -u admin:password -d @cephCrushRuleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephFilesystemCreate
Request Parameters
{ "method": "cephFilesystemCreate", "params": { "name": xsd:string "description": xsd:string "cephClusterId": xsd:string "scalingFactor": xsd:unsignedInt "maxReplicaCount": xsd:unsignedInt "minReplicaCount": xsd:unsignedInt "cephPoolType": xsd:string "crushProfile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephFilesystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemCreate?name=val0&description=val1&cephClusterId=val2&scalingFactor=0&maxReplicaCount=0&minReplicaCount=0&cephPoolType=val6&crushProfile=val7&flags=0"
curl -k -u admin:password -d @cephFilesystemCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephFilesystemDelete
Request Parameters
{ "method": "cephFilesystemDelete", "params": { "cephFilesystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephFilesystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemDelete?cephFilesystemId=val0&flags=0"
curl -k -u admin:password -d @cephFilesystemDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephFilesystemEnum
Request Parameters
{ "method": "cephFilesystemEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephFilesystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephFilesystemEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephFilesystemGet
Request Parameters
{ "method": "cephFilesystemGet", "params": { "cephFilesystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephFilesystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemGet?cephFilesystemId=val0&flags=0"
curl -k -u admin:password -d @cephFilesystemGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephFilesystemModify
Request Parameters
{ "method": "cephFilesystemModify", "params": { "cephFilesystemId": xsd:string "description": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephFilesystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemModify?cephFilesystemId=val0&description=val1&flags=0"
curl -k -u admin:password -d @cephFilesystemModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephFilesystemPoolAssocEnum
Request Parameters
{ "method": "cephFilesystemPoolAssocEnum", "params": { "cephFilesystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephFilesystemPoolAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemPoolAssocEnum?cephFilesystemId=val0&flags=0"
curl -k -u admin:password -d @cephFilesystemPoolAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephFilesystemPoolAssocGet
Request Parameters
{ "method": "cephFilesystemPoolAssocGet", "params": { "cephFilesystemId": xsd:string "cephPoolId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephFilesystemPoolAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemPoolAssocGet?cephFilesystemId=val0&cephPoolId=val1&flags=0"
curl -k -u admin:password -d @cephFilesystemPoolAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephJournalDeviceCreate
Request Parameters
{ "method": "cephJournalDeviceCreate", "params": { "cephJournalGroup": xsd:string "size": xsd:unsignedLong "mirrorJournals": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephJournalDevice }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceCreate?cephJournalGroup=val0&size=val1&mirrorJournals=val2&flags=0"
curl -k -u admin:password -d @cephJournalDeviceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephJournalDeviceDelete
Request Parameters
{ "method": "cephJournalDeviceDelete", "params": { "cephJournalDevice": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephJournalDevice }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceDelete?cephJournalDevice=val0&flags=0"
curl -k -u admin:password -d @cephJournalDeviceDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephJournalDeviceEnum
Request Parameters
{ "method": "cephJournalDeviceEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephJournalDevice }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephJournalDeviceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephJournalDeviceGet
Request Parameters
{ "method": "cephJournalDeviceGet", "params": { "cephJournalDevice": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephJournalDevice }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceGet?cephJournalDevice=val0&flags=0"
curl -k -u admin:password -d @cephJournalDeviceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephJournalDeviceMigrate
Request Parameters
{ "method": "cephJournalDeviceMigrate", "params": { "cephCluster": xsd:string "cephJournalDevice": xsd:string "newJournalGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephJournalDevice }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceMigrate?cephCluster=val0&cephJournalDevice=val1&newJournalGroup=val2&flags=0"
curl -k -u admin:password -d @cephJournalDeviceMigrate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephJournalGroupCreate
Request Parameters
{ "method": "cephJournalGroupCreate", "params": { "primaryDisk": xsd:string "secondaryDisk": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephJournalGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalGroupCreate?primaryDisk=val0&secondaryDisk=val1&flags=0"
curl -k -u admin:password -d @cephJournalGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephJournalGroupDelete
Request Parameters
{ "method": "cephJournalGroupDelete", "params": { "cephJournalGroupId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephJournalGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalGroupDelete?cephJournalGroupId=val0&flags=0"
curl -k -u admin:password -d @cephJournalGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephJournalGroupEnum
Request Parameters
{ "method": "cephJournalGroupEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephJournalGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalGroupEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephJournalGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephJournalGroupGet
Request Parameters
{ "method": "cephJournalGroupGet", "params": { "cephJournalGroupId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephJournalGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalGroupGet?cephJournalGroupId=val0&flags=0"
curl -k -u admin:password -d @cephJournalGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephMdsAdd
Request Parameters
{ "method": "cephMdsAdd", "params": { "clusterId": xsd:string "cephMemberId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephMds }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMdsAdd?clusterId=val0&cephMemberId=val1&flags=0"
curl -k -u admin:password -d @cephMdsAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephMdsEnum
Request Parameters
{ "method": "cephMdsEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephMds }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMdsEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephMdsEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephMdsGet
Request Parameters
{ "method": "cephMdsGet", "params": { "cephMds": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephMds }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMdsGet?cephMds=val0&flags=0"
curl -k -u admin:password -d @cephMdsGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephMdsRemove
Request Parameters
{ "method": "cephMdsRemove", "params": { "clusterId": xsd:string "mdsNodeId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephMds }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMdsRemove?clusterId=val0&mdsNodeId=val1&flags=0"
curl -k -u admin:password -d @cephMdsRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephMonitorAdd
Request Parameters
{ "method": "cephMonitorAdd", "params": { "clusterId": xsd:string "cephMemberId": xsd:string "monitorIPAddress": xsd:string "monitorPort": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephMonitor }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMonitorAdd?clusterId=val0&cephMemberId=val1&monitorIPAddress=val2&monitorPort=0&flags=0"
curl -k -u admin:password -d @cephMonitorAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephMonitorEnum
Request Parameters
{ "method": "cephMonitorEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephMonitor }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMonitorEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephMonitorEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephMonitorGet
Request Parameters
{ "method": "cephMonitorGet", "params": { "cephMonitor": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephMonitor }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMonitorGet?cephMonitor=val0&flags=0"
curl -k -u admin:password -d @cephMonitorGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephMonitorRemove
Request Parameters
{ "method": "cephMonitorRemove", "params": { "clusterId": xsd:string "monitorNodeId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephMonitor }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMonitorRemove?clusterId=val0&monitorNodeId=val1&flags=0"
curl -k -u admin:password -d @cephMonitorRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephMultiOsdCreate
Request Parameters
{ "method": "cephMultiOsdCreate", "params": { "cephClusterId": xsd:string "physicalDiskList": xsd:string "journalDiskList": xsd:string "useExistingJournalGroups": xsd:boolean "mirrorJournals": xsd:boolean "quickFormat": xsd:boolean "allowedMixedSizeJournalMedia": xsd:boolean "forceExternalJDev": xsd:boolean "sizeWAL": xsd:unsignedLong "sizeDB": xsd:unsignedLong "osdType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:cephOsd }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMultiOsdCreate?cephClusterId=val0&physicalDiskList=val1&journalDiskList=val2&useExistingJournalGroups=val3&mirrorJournals=val4&quickFormat=val5&allowedMixedSizeJournalMedia=val6&forceExternalJDev=val7&sizeWAL=val8&sizeDB=val9&osdType=0&flags=0"
curl -k -u admin:password -d @cephMultiOsdCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephObjectPoolGroupCreate
Request Parameters
{ "method": "cephObjectPoolGroupCreate", "params": { "cephClusterId": xsd:string "description": xsd:string "zone": xsd:string "zoneGroup": xsd:string "dataPoolType": xsd:string "minReplicaCount": xsd:unsignedInt "maxReplicaCount": xsd:unsignedInt "poolProfile": xsd:string "storageSystemIds": xsd:string "useCase": xsd:unsignedInt "scalingFactor": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephObjectPoolGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupCreate?cephClusterId=val0&description=val1&zone=val2&zoneGroup=val3&dataPoolType=val4&minReplicaCount=0&maxReplicaCount=0&poolProfile=val7&storageSystemIds=val8&useCase=0&scalingFactor=0&flags=0"
curl -k -u admin:password -d @cephObjectPoolGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephObjectPoolGroupDelete
Request Parameters
{ "method": "cephObjectPoolGroupDelete", "params": { "cephObjectStoragePoolGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephObjectPoolGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupDelete?cephObjectStoragePoolGroup=val0&flags=0"
curl -k -u admin:password -d @cephObjectPoolGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephObjectPoolGroupEnum
Request Parameters
{ "method": "cephObjectPoolGroupEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephObjectPoolGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephObjectPoolGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephObjectPoolGroupGet
Request Parameters
{ "method": "cephObjectPoolGroupGet", "params": { "cephObjectStoragePoolGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephObjectPoolGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupGet?cephObjectStoragePoolGroup=val0&flags=0"
curl -k -u admin:password -d @cephObjectPoolGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephOsdCreate
Request Parameters
{ "method": "cephOsdCreate", "params": { "description": xsd:string "cephClusterId": xsd:string "datastoragePoolId": xsd:string "journalGroupId": xsd:string "enableWAL": xsd:boolean "enableDB": xsd:boolean "walSize": xsd:unsignedLong "dbSize": xsd:unsignedLong "osdType": xsd:unsignedInt "weight": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephOsd }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdCreate?description=val0&cephClusterId=val1&datastoragePoolId=val2&journalGroupId=val3&enableWAL=val4&enableDB=val5&walSize=val6&dbSize=val7&osdType=0&weight=0&flags=0"
curl -k -u admin:password -d @cephOsdCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephOsdDelete
Request Parameters
{ "method": "cephOsdDelete", "params": { "cephClusterId": xsd:string "cephOsd": xsd:string "deleteData": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephOsd }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdDelete?cephClusterId=val0&cephOsd=val1&deleteData=val2&flags=0"
curl -k -u admin:password -d @cephOsdDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephOsdEnum
Request Parameters
{ "method": "cephOsdEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephOsd }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephOsdEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephOsdGet
Request Parameters
{ "method": "cephOsdGet", "params": { "cephOsd": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephOsd }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdGet?cephOsd=val0&flags=0"
curl -k -u admin:password -d @cephOsdGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephOsdIdentify
Request Parameters
{ "method": "cephOsdIdentify", "params": { "osdIdList": xsd:string "durationInSeconds": xsd:unsignedInt "blinkType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:cephOsd }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdIdentify?osdIdList=val0&durationInSeconds=0&blinkType=0&flags=0"
curl -k -u admin:password -d @cephOsdIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephOsdModify
Request Parameters
{ "method": "cephOsdModify", "params": { "cephClusterId": xsd:string "cephOsd": xsd:string "description": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephOsd }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdModify?cephClusterId=val0&cephOsd=val1&description=val2&flags=0"
curl -k -u admin:password -d @cephOsdModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephOsdServiceUpdate
Request Parameters
{ "method": "cephOsdServiceUpdate", "params": { "osdIdList": xsd:string "mode": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:cephOsd }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdServiceUpdate?osdIdList=val0&mode=0&flags=0"
curl -k -u admin:password -d @cephOsdServiceUpdate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPgSetEnum
Request Parameters
{ "method": "cephPgSetEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephPgSet }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPgSetEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephPgSetEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPgSetGet
Request Parameters
{ "method": "cephPgSetGet", "params": { "cephPgSet": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephPgSet }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPgSetGet?cephPgSet=val0&flags=0"
curl -k -u admin:password -d @cephPgSetGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolCreate
Request Parameters
{ "method": "cephPoolCreate", "params": { "name": xsd:string "description": xsd:string "cephClusterId": xsd:string "scalingFactor": xsd:unsignedInt "maxReplicaCount": xsd:unsignedInt "minReplicaCount": xsd:unsignedInt "cephPoolType": xsd:string "storagePoolList": xsd:string "crushProfile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephPool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolCreate?name=val0&description=val1&cephClusterId=val2&scalingFactor=0&maxReplicaCount=0&minReplicaCount=0&cephPoolType=val6&storagePoolList=val7&crushProfile=val8&flags=0"
curl -k -u admin:password -d @cephPoolCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolDelete
Request Parameters
{ "method": "cephPoolDelete", "params": { "cephClusterId": xsd:string "cephPool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephPool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolDelete?cephClusterId=val0&cephPool=val1&flags=0"
curl -k -u admin:password -d @cephPoolDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolEnum
Request Parameters
{ "method": "cephPoolEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephPool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephPoolEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolGet
Request Parameters
{ "method": "cephPoolGet", "params": { "cephPool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephPool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolGet?cephPool=val0&flags=0"
curl -k -u admin:password -d @cephPoolGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolModify
Request Parameters
{ "method": "cephPoolModify", "params": { "cephClusterId": xsd:string "cephPool": xsd:string "name": xsd:string "description": xsd:string "maxReplicaCount": xsd:unsignedInt "poolCrushRule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephPool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolModify?cephClusterId=val0&cephPool=val1&name=val2&description=val3&maxReplicaCount=0&poolCrushRule=val5&flags=0"
curl -k -u admin:password -d @cephPoolModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolOsdAssocEnum
Request Parameters
{ "method": "cephPoolOsdAssocEnum", "params": { "cephPool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephPoolOsdAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolOsdAssocEnum?cephPool=val0&flags=0"
curl -k -u admin:password -d @cephPoolOsdAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolOsdAssocGet
Request Parameters
{ "method": "cephPoolOsdAssocGet", "params": { "cephPool": xsd:string "cephOsd": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephPoolOsdAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolOsdAssocGet?cephPool=val0&cephOsd=val1&flags=0"
curl -k -u admin:password -d @cephPoolOsdAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolProfileCreate
Request Parameters
{ "method": "cephPoolProfileCreate", "params": { "name": xsd:string "description": xsd:string "cephClusterId": xsd:string "dataChunkCount": xsd:unsignedInt "codeChunkCount": xsd:unsignedInt "failureDomain": xsd:string "technique": xsd:string "plugin": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephPoolProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolProfileCreate?name=val0&description=val1&cephClusterId=val2&dataChunkCount=0&codeChunkCount=0&failureDomain=val5&technique=val6&plugin=val7&flags=0"
curl -k -u admin:password -d @cephPoolProfileCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolProfileDelete
Request Parameters
{ "method": "cephPoolProfileDelete", "params": { "cephPoolProfile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephPoolProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolProfileDelete?cephPoolProfile=val0&flags=0"
curl -k -u admin:password -d @cephPoolProfileDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolProfileEnum
Request Parameters
{ "method": "cephPoolProfileEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephPoolProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolProfileEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephPoolProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephPoolProfileGet
Request Parameters
{ "method": "cephPoolProfileGet", "params": { "cephPoolProfile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephPoolProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolProfileGet?cephPoolProfile=val0&flags=0"
curl -k -u admin:password -d @cephPoolProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephRadosGatewayAdd
Request Parameters
{ "method": "cephRadosGatewayAdd", "params": { "clusterId": xsd:string "cephMemberId": xsd:string "cephRadosGatewayIPAddress": xsd:string "cephRadosGatewayPort": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephRadosGateway }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayAdd?clusterId=val0&cephMemberId=val1&cephRadosGatewayIPAddress=val2&cephRadosGatewayPort=0&flags=0"
curl -k -u admin:password -d @cephRadosGatewayAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephRadosGatewayEnum
Request Parameters
{ "method": "cephRadosGatewayEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cephRadosGateway }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @cephRadosGatewayEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephRadosGatewayGet
Request Parameters
{ "method": "cephRadosGatewayGet", "params": { "cephGatewayId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cephRadosGateway }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayGet?cephGatewayId=val0&flags=0"
curl -k -u admin:password -d @cephRadosGatewayGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephRadosGatewayRemove
Request Parameters
{ "method": "cephRadosGatewayRemove", "params": { "clusterId": xsd:string "cephRadosGatewayId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephRadosGateway }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayRemove?clusterId=val0&cephRadosGatewayId=val1&flags=0"
curl -k -u admin:password -d @cephRadosGatewayRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cephRadosGatewayStartStopRestart
Request Parameters
{ "method": "cephRadosGatewayStartStopRestart", "params": { "cephRadosGatewayId": xsd:string "modType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cephRadosGateway }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayStartStopRestart?cephRadosGatewayId=val0&modType=0&flags=0"
curl -k -u admin:password -d @cephRadosGatewayStartStopRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleAssocEnum
Request Parameters
{ "method": "cloudBackupScheduleAssocEnum", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cloudBackupScheduleAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleAssocEnum?schedule=val0&flags=0"
curl -k -u admin:password -d @cloudBackupScheduleAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleAssocGet
Request Parameters
{ "method": "cloudBackupScheduleAssocGet", "params": { "scheduleId": xsd:string "storageVolumeId": xsd:string } }
Response Parameters
{ "obj": osn:cloudBackupScheduleAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleAssocGet?scheduleId=val0&storageVolumeId=val1"
curl -k -u admin:password -d @cloudBackupScheduleAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleCreate
Request Parameters
{ "method": "cloudBackupScheduleCreate", "params": { "name": xsd:string "description": xsd:string "cloudContainerId": xsd:string "priority": xsd:unsignedInt "setEnabled": xsd:unsignedInt "startDate": xsd:dateTime "maxBackups": xsd:unsignedInt "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "storageVolumeList": xsd:string "scheduleType": xsd:unsignedInt "delayInterval": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudBackupSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleCreate?name=val0&description=val1&cloudContainerId=val2&priority=0&setEnabled=0&startDate=val5&maxBackups=0&daysOfWeek=0&hoursOfDay=0&storageVolumeList=val9&scheduleType=0&delayInterval=0&flags=0"
curl -k -u admin:password -d @cloudBackupScheduleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleDelete
Request Parameters
{ "method": "cloudBackupScheduleDelete", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudBackupSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleDelete?schedule=val0&flags=0"
curl -k -u admin:password -d @cloudBackupScheduleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleDisable
Request Parameters
{ "method": "cloudBackupScheduleDisable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudBackupSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleDisable?schedule=val0&flags=0"
curl -k -u admin:password -d @cloudBackupScheduleDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleEnable
Request Parameters
{ "method": "cloudBackupScheduleEnable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudBackupSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleEnable?schedule=val0&flags=0"
curl -k -u admin:password -d @cloudBackupScheduleEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleEnum
Request Parameters
{ "method": "cloudBackupScheduleEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cloudBackupSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleEnum?flags=0"
curl -k -u admin:password -d @cloudBackupScheduleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleGet
Request Parameters
{ "method": "cloudBackupScheduleGet", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cloudBackupSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleGet?schedule=val0&flags=0"
curl -k -u admin:password -d @cloudBackupScheduleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleModify
Request Parameters
{ "method": "cloudBackupScheduleModify", "params": { "schedule": xsd:string "name": xsd:string "description": xsd:string "cloudContainerId": xsd:string "setEnabled": xsd:unsignedInt "startDate": xsd:dateTime "maxBackups": xsd:unsignedInt "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "scheduleType": xsd:unsignedInt "delayInterval": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudBackupSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleModify?schedule=val0&name=val1&description=val2&cloudContainerId=val3&setEnabled=0&startDate=val5&maxBackups=0&daysOfWeek=0&hoursOfDay=0&scheduleType=0&delayInterval=0&flags=0"
curl -k -u admin:password -d @cloudBackupScheduleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleTrigger
Request Parameters
{ "method": "cloudBackupScheduleTrigger", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudBackupSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleTrigger?schedule=val0&flags=0"
curl -k -u admin:password -d @cloudBackupScheduleTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudBackupScheduleVolumeAddRemove
Request Parameters
{ "method": "cloudBackupScheduleVolumeAddRemove", "params": { "schedule": xsd:string "modType": xsd:unsignedInt "storageVolumeList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudBackupSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudBackupScheduleVolumeAddRemove?schedule=val0&modType=0&storageVolumeList=val2&flags=0"
curl -k -u admin:password -d @cloudBackupScheduleVolumeAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerAdd
Request Parameters
{ "method": "cloudContainerAdd", "params": { "credentialsId": xsd:string "locationId": xsd:string "encryptionKey": xsd:string "storageUrl": xsd:string "enableNfs": xsd:boolean "attachToStorageSystem": xsd:string "containerType": xsd:unsignedInt "mountOptions": xsd:string "storageClass": xsd:string "cacheMode": xsd:unsignedInt "dirCacheTime": xsd:string "cacheShareId": xsd:string "bufferSize": xsd:unsignedLong "vfsCacheMaxAge": xsd:string "vfsCacheMaxSize": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudContainer }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerAdd?credentialsId=val0&locationId=val1&encryptionKey=val2&storageUrl=val3&enableNfs=val4&attachToStorageSystem=val5&containerType=0&mountOptions=val7&storageClass=val8&cacheMode=0&dirCacheTime=val10&cacheShareId=val11&bufferSize=val12&vfsCacheMaxAge=val13&vfsCacheMaxSize=val14&flags=0"
curl -k -u admin:password -d @cloudContainerAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerBucketScan
Request Parameters
{ "method": "cloudContainerBucketScan", "params": { "credentialsId": xsd:string "locationId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": xsd:string }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerBucketScan?credentialsId=val0&locationId=val1&flags=0"
curl -k -u admin:password -d @cloudContainerBucketScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerCacheSettingsGet
Request Parameters
{ "method": "cloudContainerCacheSettingsGet", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cloudContainerCacheSettings }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerCacheSettingsGet?storageSystem=val0&flags=0"
curl -k -u admin:password -d @cloudContainerCacheSettingsGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerCacheSettingsModify
Request Parameters
{ "method": "cloudContainerCacheSettingsModify", "params": { "cloudSettingsId": xsd:string "cacheMode": xsd:unsignedInt "dirCacheTime": xsd:string "cacheShareId": xsd:string "bufferSize": xsd:unsignedLong "vfsCacheMaxAge": xsd:string "vfsCacheMaxSize": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudContainerCacheSettings }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerCacheSettingsModify?cloudSettingsId=val0&cacheMode=0&dirCacheTime=val2&cacheShareId=val3&bufferSize=val4&vfsCacheMaxAge=val5&vfsCacheMaxSize=val6&flags=0"
curl -k -u admin:password -d @cloudContainerCacheSettingsModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerCreate
Request Parameters
{ "method": "cloudContainerCreate", "params": { "name": xsd:string "description": xsd:string "credentialsId": xsd:string "locationId": xsd:string "encryptionKey": xsd:string "storageUrl": xsd:string "enableNfs": xsd:boolean "attachToStorageSystem": xsd:string "containerType": xsd:unsignedInt "mountOptions": xsd:string "storageClass": xsd:string "cacheMode": xsd:unsignedInt "dirCacheTime": xsd:string "cacheShareId": xsd:string "bufferSize": xsd:unsignedLong "vfsCacheMaxAge": xsd:string "vfsCacheMaxSize": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudContainer }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerCreate?name=val0&description=val1&credentialsId=val2&locationId=val3&encryptionKey=val4&storageUrl=val5&enableNfs=val6&attachToStorageSystem=val7&containerType=0&mountOptions=val9&storageClass=val10&cacheMode=0&dirCacheTime=val12&cacheShareId=val13&bufferSize=val14&vfsCacheMaxAge=val15&vfsCacheMaxSize=val16&flags=0"
curl -k -u admin:password -d @cloudContainerCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerDelete
Request Parameters
{ "method": "cloudContainerDelete", "params": { "container": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudContainer }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerDelete?container=val0&flags=0"
curl -k -u admin:password -d @cloudContainerDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerDisable
Request Parameters
{ "method": "cloudContainerDisable", "params": { "container": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudContainer }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerDisable?container=val0&flags=0"
curl -k -u admin:password -d @cloudContainerDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerEnable
Request Parameters
{ "method": "cloudContainerEnable", "params": { "container": xsd:string "attachToStorageSystem": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudContainer }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerEnable?container=val0&attachToStorageSystem=val1&flags=0"
curl -k -u admin:password -d @cloudContainerEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerEnum
Request Parameters
{ "method": "cloudContainerEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cloudContainer }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerEnum?flags=0"
curl -k -u admin:password -d @cloudContainerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerGet
Request Parameters
{ "method": "cloudContainerGet", "params": { "container": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cloudContainer }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerGet?container=val0&flags=0"
curl -k -u admin:password -d @cloudContainerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudContainerRepair
Request Parameters
{ "method": "cloudContainerRepair", "params": { "container": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudContainer }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerRepair?container=val0&flags=0"
curl -k -u admin:password -d @cloudContainerRepair.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderAdd
Request Parameters
{ "method": "cloudProviderAdd", "params": { "name": xsd:string "description": xsd:string "locationName": xsd:string "locationTag": xsd:string "locationEndpoint": xsd:string "credUsername": xsd:string "credPassword": xsd:string "credProjectId": xsd:string "authFile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudProvider }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderAdd?name=val0&description=val1&locationName=val2&locationTag=val3&locationEndpoint=val4&credUsername=val5&credPassword=val6&credProjectId=val7&authFile=val8&flags=0"
curl -k -u admin:password -d @cloudProviderAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderCredentialsAdd
Request Parameters
{ "method": "cloudProviderCredentialsAdd", "params": { "username": xsd:string "password": xsd:string "providerId": xsd:string "machine": xsd:string "projectId": xsd:string "authFile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudProviderCredentials }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderCredentialsAdd?username=val0&password=val1&providerId=val2&machine=val3&projectId=val4&authFile=val5&flags=0"
curl -k -u admin:password -d @cloudProviderCredentialsAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderCredentialsEnum
Request Parameters
{ "method": "cloudProviderCredentialsEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cloudProviderCredentials }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderCredentialsEnum?flags=0"
curl -k -u admin:password -d @cloudProviderCredentialsEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderCredentialsGet
Request Parameters
{ "method": "cloudProviderCredentialsGet", "params": { "credentialId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cloudProviderCredentials }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderCredentialsGet?credentialId=val0&flags=0"
curl -k -u admin:password -d @cloudProviderCredentialsGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderCredentialsRemove
Request Parameters
{ "method": "cloudProviderCredentialsRemove", "params": { "credentialsId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudProviderCredentials }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderCredentialsRemove?credentialsId=val0&flags=0"
curl -k -u admin:password -d @cloudProviderCredentialsRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderEnum
Request Parameters
{ "method": "cloudProviderEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cloudProvider }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderEnum?flags=0"
curl -k -u admin:password -d @cloudProviderEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderGet
Request Parameters
{ "method": "cloudProviderGet", "params": { "providerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cloudProvider }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderGet?providerId=val0&flags=0"
curl -k -u admin:password -d @cloudProviderGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderLocationAdd
Request Parameters
{ "method": "cloudProviderLocationAdd", "params": { "providerId": xsd:string "name": xsd:string "locationTag": xsd:string "endpoint": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudProviderLocation }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderLocationAdd?providerId=val0&name=val1&locationTag=val2&endpoint=val3&flags=0"
curl -k -u admin:password -d @cloudProviderLocationAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderLocationEnum
Request Parameters
{ "method": "cloudProviderLocationEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:cloudProviderLocation }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderLocationEnum?flags=0"
curl -k -u admin:password -d @cloudProviderLocationEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderLocationGet
Request Parameters
{ "method": "cloudProviderLocationGet", "params": { "locationId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:cloudProviderLocation }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderLocationGet?locationId=val0&flags=0"
curl -k -u admin:password -d @cloudProviderLocationGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderLocationRemove
Request Parameters
{ "method": "cloudProviderLocationRemove", "params": { "locationId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudProviderLocation }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderLocationRemove?locationId=val0&flags=0"
curl -k -u admin:password -d @cloudProviderLocationRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
cloudProviderRemove
Request Parameters
{ "method": "cloudProviderRemove", "params": { "providerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:cloudProvider }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderRemove?providerId=val0&flags=0"
curl -k -u admin:password -d @cloudProviderRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
clusterRingCreate
Request Parameters
{ "method": "clusterRingCreate", "params": { "siteClusterId": xsd:string "ring": xsd:unsignedInt "mcastPort": xsd:unsignedInt "bindNetAddress": xsd:string "memberAddresses": xsd:string "options": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:clusterRing }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingCreate?siteClusterId=val0&ring=0&mcastPort=0&bindNetAddress=val3&memberAddresses=val4&options=0&flags=0"
curl -k -u admin:password -d @clusterRingCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
clusterRingDelete
Request Parameters
{ "method": "clusterRingDelete", "params": { "clusterRing": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:clusterRing }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingDelete?clusterRing=val0&flags=0"
curl -k -u admin:password -d @clusterRingDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
clusterRingEnum
Request Parameters
{ "method": "clusterRingEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:clusterRing }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingEnum?flags=0"
curl -k -u admin:password -d @clusterRingEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
clusterRingGet
Request Parameters
{ "method": "clusterRingGet", "params": { "clusterRing": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:clusterRing }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingGet?clusterRing=val0&flags=0"
curl -k -u admin:password -d @clusterRingGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
clusterRingMemberEnum
Request Parameters
{ "method": "clusterRingMemberEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:clusterRingMember }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingMemberEnum?flags=0"
curl -k -u admin:password -d @clusterRingMemberEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
clusterRingMemberGet
Request Parameters
{ "method": "clusterRingMemberGet", "params": { "clusterRingMember": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:clusterRingMember }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingMemberGet?clusterRingMember=val0&flags=0"
curl -k -u admin:password -d @clusterRingMemberGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
customApi
Request Parameters
{ "method": "customApi", "params": { "method": xsd:string "params": osn:keyValuePair "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "resultOutput": xsd:string }
eventEnum
Request Parameters
{ "method": "eventEnum", "params": { "startingIndex": xsd:unsignedInt "maxEvents": xsd:unsignedInt "serviceTimeStamp": xsd:dateTime } }
Response Parameters
{ "list": osn:event "endingIndex": xsd:unsignedInt }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/eventEnum?startingIndex=0&maxEvents=0&serviceTimeStamp=val2"
curl -k -u admin:password -d @eventEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
eventListenerNotify
Request Parameters
{ "method": "eventListenerNotify", "params": { "storageSystemId": xsd:string "list": osn:event "epoch": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:eventListener }
eventListenerRegister
Request Parameters
{ "method": "eventListenerRegister", "params": { "eventListenerObj": osn:eventListener } }
Response Parameters
{ "task": osn:task "obj": osn:eventListener }
eventListenerUnregister
Request Parameters
{ "method": "eventListenerUnregister", "params": { "listenerId": xsd:string } }
Response Parameters
{ "task": osn:task "obj": osn:eventListener }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/eventListenerUnregister?listenerId=val0"
curl -k -u admin:password -d @eventListenerUnregister.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
eventPulse
updates object time stamps of all objects of type objectType. This pulses a series of events into the grid for load testing.
Request Parameters
{ "method": "eventPulse", "params": { "storageSystemId": xsd:string "objectType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:object }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/eventPulse?storageSystemId=val0&objectType=0&flags=0"
curl -k -u admin:password -d @eventPulse.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
fcTargetPortDisable
Disabling a FC port changes it from Target mode to Initiator mode
Request Parameters
{ "method": "fcTargetPortDisable", "params": { "port": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:fcTargetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcTargetPortDisable?port=val0&flags=0"
curl -k -u admin:password -d @fcTargetPortDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
fcTargetPortEnable
Enabling a FC port changes it from Initiator mode to Target mode, only QLogic FC cards can be put into target mode
Request Parameters
{ "method": "fcTargetPortEnable", "params": { "port": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:fcTargetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcTargetPortEnable?port=val0&flags=0"
curl -k -u admin:password -d @fcTargetPortEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
fcTargetPortEnum
Returns a list of all the FC ports
Request Parameters
{ "method": "fcTargetPortEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:fcTargetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcTargetPortEnum?flags=0"
curl -k -u admin:password -d @fcTargetPortEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
fcTargetPortGet
Returns information about a specific FC port
Request Parameters
{ "method": "fcTargetPortGet", "params": { "port": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:fcTargetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcTargetPortGet?port=val0&flags=0"
curl -k -u admin:password -d @fcTargetPortGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
getLocalizedMessage
Request Parameters
{ "method": "getLocalizedMessage", "params": { "locale": xsd:string "i18nStr": osn:i18nString "flags": xsd:unsignedInt } }
Response Parameters
{ "msgLocale": xsd:string "msgLocalized": xsd:string }
getMultiFactorAuthDevices
Request Parameters
{ "method": "getMultiFactorAuthDevices", "params": { "authRequestCode": xsd:string } }
Response Parameters
{ "deviceList": osn:multiFactorAuthDevice }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/getMultiFactorAuthDevices?authRequestCode=val0"
curl -k -u admin:password -d @getMultiFactorAuthDevices.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostAdd
Adds a new Host entry so that Storage Volumes may be assigned to them. The iqn field bay be a iSCSI IQN or a FC WWPN.
Request Parameters
{ "method": "hostAdd", "params": { "hostname": xsd:string "ipAddress": xsd:string "username": xsd:string "password": xsd:string "hostType": xsd:unsignedInt "description": xsd:string "iqn": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:host }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostAdd?hostname=val0&ipAddress=val1&username=val2&password=val3&hostType=0&description=val5&iqn=val6&flags=0"
curl -k -u admin:password -d @hostAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostEnum
Returns a list of all the #osn:host entries.
Request Parameters
{ "method": "hostEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:host }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostEnum?flags=0"
curl -k -u admin:password -d @hostEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostGet
Returns detailed information about a specific #osn:host entry.
Request Parameters
{ "method": "hostGet", "params": { "host": xsd:string - UUID or name of the Host to gather information about "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:host }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGet?host=val0&flags=0"
curl -k -u admin:password -d @hostGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostGroupCreate
Creates a #osn:hostGroup which simplifies assignment of Storage Volumes to groups of #osn:hosts which typically constitue a cluster.
Request Parameters
{ "method": "hostGroupCreate", "params": { "name": xsd:string "description": xsd:string "hostList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hostGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupCreate?name=val0&description=val1&hostList=val2&flags=0"
curl -k -u admin:password -d @hostGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostGroupDelete
Deletes the specified Host Group and all Storage Volume assignments associated with the group.
Request Parameters
{ "method": "hostGroupDelete", "params": { "hostGroup": xsd:string "deleteAssociatedHosts": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hostGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupDelete?hostGroup=val0&deleteAssociatedHosts=val1&flags=0"
curl -k -u admin:password -d @hostGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostGroupEnum
Returns a list of all the Host Groups
Request Parameters
{ "method": "hostGroupEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:hostGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupEnum?flags=0"
curl -k -u admin:password -d @hostGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostGroupGet
Returns detailed information about a specific Host Group
Request Parameters
{ "method": "hostGroupGet", "params": { "hostGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hostGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupGet?hostGroup=val0&flags=0"
curl -k -u admin:password -d @hostGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostGroupHostAddRemove
Add or removes entries to/from a Host Group
Request Parameters
{ "method": "hostGroupHostAddRemove", "params": { "hostGroup": xsd:string "modType": xsd:unsignedInt - {{{1}}} "hostList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hostGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupHostAddRemove?hostGroup=val0&modType=0&hostList=val2&flags=0"
curl -k -u admin:password -d @hostGroupHostAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostGroupModify
Modifies the specified #osn:hostGroup
Request Parameters
{ "method": "hostGroupModify", "params": { "hostGroup": xsd:string - name or UUID of the Host Group "newName": xsd:string "newDescription": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hostGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupModify?hostGroup=val0&newName=val1&newDescription=val2&flags=0"
curl -k -u admin:password -d @hostGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostInitiatorAdd
Adds a #osn:host with the specified IQN or WWPN
Request Parameters
{ "method": "hostInitiatorAdd", "params": { "host": xsd:string - hostname or UUID of a #osn:host "iqn": xsd:string - IQN or WWPN "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:host }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostInitiatorAdd?host=val0&iqn=val1&flags=0"
curl -k -u admin:password -d @hostInitiatorAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostInitiatorEnum
Returns the list of #osn:initatorPort entries associated with the #osn:host
Request Parameters
{ "method": "hostInitiatorEnum", "params": { "host": xsd:string - host name or UUID of the Host entry or to get all entries for all hosts "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:initiatorPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostInitiatorEnum?host=val0&flags=0"
curl -k -u admin:password -d @hostInitiatorEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostInitiatorGet
Returns information about a specific #osn:initiatorPort entry associated with a host.
Request Parameters
{ "method": "hostInitiatorGet", "params": { "initiator": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "obj": osn:initiatorPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostInitiatorGet?initiator=val0&flags=0"
curl -k -u admin:password -d @hostInitiatorGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostInitiatorRemove
Request Parameters
{ "method": "hostInitiatorRemove", "params": { "host": xsd:string "iqn": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:host }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostInitiatorRemove?host=val0&iqn=val1&flags=0"
curl -k -u admin:password -d @hostInitiatorRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostModify
Modifies the specified host entry to change it's properties. See #hostInitiatorAdd to add additional WWPNs and IQNs.
Request Parameters
{ "method": "hostModify", "params": { "host": xsd:string - Host name or UUID of the osn:host entry to modify "newIpAddress": xsd:string - IP address of the Host "newUsername": xsd:string - username to associate with the host (optional) "newPassword": xsd:string - password to associate with the host (optional) "newHostType": xsd:unsignedInt - host type, see #enum:hostType "newDescription": xsd:string "newHostName": xsd:string - new hostname for this Host entry "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:host }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostModify?host=val0&newIpAddress=val1&newUsername=val2&newPassword=val3&newHostType=0&newDescription=val5&newHostName=val6&flags=0"
curl -k -u admin:password -d @hostModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hostRemove
Removes a #osn:host entry and removes all Storage Volume assignments associated with this host.
Request Parameters
{ "method": "hostRemove", "params": { "host": xsd:string - hostname or UUID of a #osn:host "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:host }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostRemove?host=val0&flags=0"
curl -k -u admin:password -d @hostRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwAlarmEnum
Request Parameters
{ "method": "hwAlarmEnum", "params": { "hwController": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwAlarm }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwAlarmEnum?hwController=val0&flags=0"
curl -k -u admin:password -d @hwAlarmEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwAlarmGet
Request Parameters
{ "method": "hwAlarmGet", "params": { "hwAlarm": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwAlarm }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwAlarmGet?hwAlarm=val0&flags=0"
curl -k -u admin:password -d @hwAlarmGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwBatteryBackupUnitEnum
Request Parameters
{ "method": "hwBatteryBackupUnitEnum", "params": { "hwController": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwBatteryBackupUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwBatteryBackupUnitEnum?hwController=val0&flags=0"
curl -k -u admin:password -d @hwBatteryBackupUnitEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwBatteryBackupUnitGet
Request Parameters
{ "method": "hwBatteryBackupUnitGet", "params": { "hwBatteryBackupUnit": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwBatteryBackupUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwBatteryBackupUnitGet?hwBatteryBackupUnit=val0&flags=0"
curl -k -u admin:password -d @hwBatteryBackupUnitGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerChangeSecurityKey
Request Parameters
{ "method": "hwControllerChangeSecurityKey", "params": { "controllerId": xsd:string "oldSecurityKey": xsd:string "newSecurityKey": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerChangeSecurityKey?controllerId=val0&oldSecurityKey=val1&newSecurityKey=val2&flags=0"
curl -k -u admin:password -d @hwControllerChangeSecurityKey.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerClearAlarms
Request Parameters
{ "method": "hwControllerClearAlarms", "params": { "controllerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerClearAlarms?controllerId=val0&flags=0"
curl -k -u admin:password -d @hwControllerClearAlarms.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerCreateSecurityKey
Request Parameters
{ "method": "hwControllerCreateSecurityKey", "params": { "controllerId": xsd:string "securityKey": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerCreateSecurityKey?controllerId=val0&securityKey=val1&flags=0"
curl -k -u admin:password -d @hwControllerCreateSecurityKey.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerEnum
Request Parameters
{ "method": "hwControllerEnum", "params": { "hwControllerGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerEnum?hwControllerGroup=val0&flags=0"
curl -k -u admin:password -d @hwControllerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerGet
Request Parameters
{ "method": "hwControllerGet", "params": { "hwController": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerGet?hwController=val0&flags=0"
curl -k -u admin:password -d @hwControllerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerGroupEnum
Request Parameters
{ "method": "hwControllerGroupEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwControllerGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerGroupEnum?flags=0"
curl -k -u admin:password -d @hwControllerGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerGroupGet
Request Parameters
{ "method": "hwControllerGroupGet", "params": { "hwControllerGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwControllerGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerGroupGet?hwControllerGroup=val0&flags=0"
curl -k -u admin:password -d @hwControllerGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerImportForeignUnits
Request Parameters
{ "method": "hwControllerImportForeignUnits", "params": { "controllerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerImportForeignUnits?controllerId=val0&flags=0"
curl -k -u admin:password -d @hwControllerImportForeignUnits.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerModify
Request Parameters
{ "method": "hwControllerModify", "params": { "controllerId": xsd:string "altName": xsd:string "description": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerModify?controllerId=val0&altName=val1&description=val2&flags=0"
curl -k -u admin:password -d @hwControllerModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerRescan
Request Parameters
{ "method": "hwControllerRescan", "params": { "controllerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerRescan?controllerId=val0&flags=0"
curl -k -u admin:password -d @hwControllerRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerRescanAll
Request Parameters
{ "method": "hwControllerRescanAll", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerRescanAll?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @hwControllerRescanAll.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwControllerSilenceAlarms
Request Parameters
{ "method": "hwControllerSilenceAlarms", "params": { "controllerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerSilenceAlarms?controllerId=val0&flags=0"
curl -k -u admin:password -d @hwControllerSilenceAlarms.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwDiskClearMissing
Request Parameters
{ "method": "hwDiskClearMissing", "params": { "storageSystemId": xsd:string "controllerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:hwDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskClearMissing?storageSystemId=val0&controllerId=val1&flags=0"
curl -k -u admin:password -d @hwDiskClearMissing.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwDiskEnum
Request Parameters
{ "method": "hwDiskEnum", "params": { "hwController": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskEnum?hwController=val0&flags=0"
curl -k -u admin:password -d @hwDiskEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwDiskGet
Request Parameters
{ "method": "hwDiskGet", "params": { "hwDisk": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskGet?hwDisk=val0&flags=0"
curl -k -u admin:password -d @hwDiskGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwDiskIdentify
Request Parameters
{ "method": "hwDiskIdentify", "params": { "diskIdList": xsd:string "durationInSeconds": xsd:unsignedInt "blinkType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:hwDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskIdentify?diskIdList=val0&durationInSeconds=0&blinkType=0&flags=0"
curl -k -u admin:password -d @hwDiskIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwDiskMarkGood
Request Parameters
{ "method": "hwDiskMarkGood", "params": { "diskIdList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:hwDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskMarkGood?diskIdList=val0&flags=0"
curl -k -u admin:password -d @hwDiskMarkGood.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwDiskMarkHotSpare
Request Parameters
{ "method": "hwDiskMarkHotSpare", "params": { "diskIdList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:hwDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskMarkHotSpare?diskIdList=val0&flags=0"
curl -k -u admin:password -d @hwDiskMarkHotSpare.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwDiskModify
Request Parameters
{ "method": "hwDiskModify", "params": { "diskId": xsd:string "altName": xsd:string "description": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskModify?diskId=val0&altName=val1&description=val2&flags=0"
curl -k -u admin:password -d @hwDiskModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwDiskRemove
Request Parameters
{ "method": "hwDiskRemove", "params": { "diskIdList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:hwDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskRemove?diskIdList=val0&flags=0"
curl -k -u admin:password -d @hwDiskRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwDiskUnmarkHotSpare
Request Parameters
{ "method": "hwDiskUnmarkHotSpare", "params": { "diskIdList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:hwDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskUnmarkHotSpare?diskIdList=val0&flags=0"
curl -k -u admin:password -d @hwDiskUnmarkHotSpare.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwEnclosureEnum
Request Parameters
{ "method": "hwEnclosureEnum", "params": { "hwController": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwEnclosure }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureEnum?hwController=val0&flags=0"
curl -k -u admin:password -d @hwEnclosureEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwEnclosureGet
Request Parameters
{ "method": "hwEnclosureGet", "params": { "hwEnclosure": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwEnclosure }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureGet?hwEnclosure=val0&flags=0"
curl -k -u admin:password -d @hwEnclosureGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwEnclosureLayoutEnum
Request Parameters
{ "method": "hwEnclosureLayoutEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwEnclosureLayout }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureLayoutEnum?flags=0"
curl -k -u admin:password -d @hwEnclosureLayoutEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwEnclosureLayoutGet
Request Parameters
{ "method": "hwEnclosureLayoutGet", "params": { "hwEnclosureLayout": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwEnclosureLayout }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureLayoutGet?hwEnclosureLayout=val0&flags=0"
curl -k -u admin:password -d @hwEnclosureLayoutGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwEnclosureLayoutVendorGroupEnum
Request Parameters
{ "method": "hwEnclosureLayoutVendorGroupEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwEnclosureLayoutVendorGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureLayoutVendorGroupEnum?flags=0"
curl -k -u admin:password -d @hwEnclosureLayoutVendorGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwEnclosureLayoutVendorGroupGet
Request Parameters
{ "method": "hwEnclosureLayoutVendorGroupGet", "params": { "hwEnclosureLayoutVendorGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwEnclosureLayoutVendorGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureLayoutVendorGroupGet?hwEnclosureLayoutVendorGroup=val0&flags=0"
curl -k -u admin:password -d @hwEnclosureLayoutVendorGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwEnclosureModify
Request Parameters
{ "method": "hwEnclosureModify", "params": { "diskId": xsd:string "altName": xsd:string "description": xsd:string "enclosureLayout": xsd:string "chassisTag": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwEnclosure }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureModify?diskId=val0&altName=val1&description=val2&enclosureLayout=val3&chassisTag=val4&flags=0"
curl -k -u admin:password -d @hwEnclosureModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwEnclosureSlotIdentify
Request Parameters
{ "method": "hwEnclosureSlotIdentify", "params": { "enclosureId": xsd:string "slotList": xsd:string "durationInSeconds": xsd:unsignedInt "blinkType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwEnclosure }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureSlotIdentify?enclosureId=val0&slotList=val1&durationInSeconds=0&blinkType=0&flags=0"
curl -k -u admin:password -d @hwEnclosureSlotIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwLogicalDriveEnum
Request Parameters
{ "method": "hwLogicalDriveEnum", "params": { "hwUnit": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwLogicalDrive }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwLogicalDriveEnum?hwUnit=val0&flags=0"
curl -k -u admin:password -d @hwLogicalDriveEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwLogicalDriveGet
Request Parameters
{ "method": "hwLogicalDriveGet", "params": { "hwLogicalDrive": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwLogicalDrive }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwLogicalDriveGet?hwLogicalDrive=val0&flags=0"
curl -k -u admin:password -d @hwLogicalDriveGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitAutoCreate
Request Parameters
{ "method": "hwUnitAutoCreate", "params": { "storageSystemId": xsd:string "hwControllerId": xsd:string "raidType": xsd:unsignedInt "disksPerUnit": xsd:unsignedInt "blockSizeKb": xsd:unsignedInt "diskCategory": xsd:unsignedInt "diskSizeMinimum": xsd:unsignedLong "diskSizeMaximum": xsd:unsignedLong "unitCount": xsd:unsignedInt "options": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitAutoCreate?storageSystemId=val0&hwControllerId=val1&raidType=0&disksPerUnit=0&blockSizeKb=0&diskCategory=0&diskSizeMinimum=val6&diskSizeMaximum=val7&unitCount=0&options=val9&flags=0"
curl -k -u admin:password -d @hwUnitAutoCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitCreate
Request Parameters
{ "method": "hwUnitCreate", "params": { "controllerId": xsd:string "raidType": xsd:unsignedInt "legLength": xsd:unsignedInt "blockSizeKb": xsd:unsignedInt "diskList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitCreate?controllerId=val0&raidType=0&legLength=0&blockSizeKb=0&diskList=val4&flags=0"
curl -k -u admin:password -d @hwUnitCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitDelete
Request Parameters
{ "method": "hwUnitDelete", "params": { "unitId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitDelete?unitId=val0&flags=0"
curl -k -u admin:password -d @hwUnitDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitDiskAssocEnum
Request Parameters
{ "method": "hwUnitDiskAssocEnum", "params": { "hwUnit": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwUnitDiskAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitDiskAssocEnum?hwUnit=val0&flags=0"
curl -k -u admin:password -d @hwUnitDiskAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitDiskAssocGet
Request Parameters
{ "method": "hwUnitDiskAssocGet", "params": { "hwUnit": xsd:string "hwDisk": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwUnitDiskAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitDiskAssocGet?hwUnit=val0&hwDisk=val1&flags=0"
curl -k -u admin:password -d @hwUnitDiskAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitEnableEncryption
Request Parameters
{ "method": "hwUnitEnableEncryption", "params": { "unitId": xsd:string "options": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitEnableEncryption?unitId=val0&options=0&flags=0"
curl -k -u admin:password -d @hwUnitEnableEncryption.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitEnum
Request Parameters
{ "method": "hwUnitEnum", "params": { "hwController": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitEnum?hwController=val0&flags=0"
curl -k -u admin:password -d @hwUnitEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitGet
Request Parameters
{ "method": "hwUnitGet", "params": { "hwUnit": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitGet?hwUnit=val0&flags=0"
curl -k -u admin:password -d @hwUnitGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitGrow
Request Parameters
{ "method": "hwUnitGrow", "params": { "unitId": xsd:string "diskList": xsd:string "stripeSizeKb": xsd:unsignedInt "initPriority": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitGrow?unitId=val0&diskList=val1&stripeSizeKb=0&initPriority=0&flags=0"
curl -k -u admin:password -d @hwUnitGrow.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitIdentify
Request Parameters
{ "method": "hwUnitIdentify", "params": { "unitId": xsd:string "durationInSeconds": xsd:unsignedInt "blinkType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitIdentify?unitId=val0&durationInSeconds=0&blinkType=0&flags=0"
curl -k -u admin:password -d @hwUnitIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitModify
Request Parameters
{ "method": "hwUnitModify", "params": { "unitId": xsd:string "altName": xsd:string "description": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitModify?unitId=val0&altName=val1&description=val2&flags=0"
curl -k -u admin:password -d @hwUnitModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitSsdCacheCreate
Request Parameters
{ "method": "hwUnitSsdCacheCreate", "params": { "controllerId": xsd:string "raidType": xsd:unsignedInt "ssdDiskList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitSsdCacheCreate?controllerId=val0&raidType=0&ssdDiskList=val2&flags=0"
curl -k -u admin:password -d @hwUnitSsdCacheCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitSsdCacheDisable
Request Parameters
{ "method": "hwUnitSsdCacheDisable", "params": { "unitId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitSsdCacheDisable?unitId=val0&flags=0"
curl -k -u admin:password -d @hwUnitSsdCacheDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
hwUnitSsdCacheEnable
Request Parameters
{ "method": "hwUnitSsdCacheEnable", "params": { "unitId": xsd:string "unitSsdCacheId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:hwUnit }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitSsdCacheEnable?unitId=val0&unitSsdCacheId=val1&flags=0"
curl -k -u admin:password -d @hwUnitSsdCacheEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
ibTargetPortEnum
Returns a list of all the Infiniband ports
Request Parameters
{ "method": "ibTargetPortEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:ibTargetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/ibTargetPortEnum?flags=0"
curl -k -u admin:password -d @ibTargetPortEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
ibTargetPortGet
Returns detailed information on a specific Infiniband port
Request Parameters
{ "method": "ibTargetPortGet", "params": { "port": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:ibTargetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/ibTargetPortGet?port=val0&flags=0"
curl -k -u admin:password -d @ibTargetPortGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
keyInfoEnum
Request Parameters
{ "method": "keyInfoEnum", "params": { "keyVaultProfileId": xsd:string "keyType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:keyInfo }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyInfoEnum?keyVaultProfileId=val0&keyType=0&flags=0"
curl -k -u admin:password -d @keyInfoEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
keyVaultCheckConnectivity
Request Parameters
{ "method": "keyVaultCheckConnectivity", "params": { "keyVaultProfileId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "connectivityStatus": xsd:unsignedInt "statusStr": xsd:string "obj": osn:keyVaultProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyVaultCheckConnectivity?keyVaultProfileId=val0&flags=0"
curl -k -u admin:password -d @keyVaultCheckConnectivity.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
keyVaultModuleEnum
Request Parameters
{ "method": "keyVaultModuleEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:keyVaultModule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyVaultModuleEnum?flags=0"
curl -k -u admin:password -d @keyVaultModuleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
keyVaultModuleGet
Request Parameters
{ "method": "keyVaultModuleGet", "params": { "keyVaultModule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:keyVaultModule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyVaultModuleGet?keyVaultModule=val0&flags=0"
curl -k -u admin:password -d @keyVaultModuleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
keyVaultProfileEnum
Request Parameters
{ "method": "keyVaultProfileEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:keyVaultProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyVaultProfileEnum?flags=0"
curl -k -u admin:password -d @keyVaultProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
keyVaultProfileGet
Request Parameters
{ "method": "keyVaultProfileGet", "params": { "keyVaultProfileId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:keyVaultProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyVaultProfileGet?keyVaultProfileId=val0&flags=0"
curl -k -u admin:password -d @keyVaultProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
keyVaultProfileRegister
Request Parameters
{ "method": "keyVaultProfileRegister", "params": { "name": xsd:string "description": xsd:string "gridId": xsd:string "apiKey": xsd:string "serviceKey": xsd:string "accessAddress": xsd:string "iamAddress": xsd:string "kvModuleId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:keyVaultProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyVaultProfileRegister?name=val0&description=val1&gridId=val2&apiKey=val3&serviceKey=val4&accessAddress=val5&iamAddress=val6&kvModuleId=val7&flags=0"
curl -k -u admin:password -d @keyVaultProfileRegister.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
keyVaultProfileUnRegister
Request Parameters
{ "method": "keyVaultProfileUnRegister", "params": { "keyVaultProfileId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:keyVaultProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyVaultProfileUnRegister?keyVaultProfileId=val0&flags=0"
curl -k -u admin:password -d @keyVaultProfileUnRegister.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
libratoMetricsConfigGet
Request Parameters
{ "method": "libratoMetricsConfigGet", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:libratoMetricsConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/libratoMetricsConfigGet?storageSystem=val0&flags=0"
curl -k -u admin:password -d @libratoMetricsConfigGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
libratoMetricsConfigSet
Request Parameters
{ "method": "libratoMetricsConfigSet", "params": { "storageSystem": xsd:string "username": xsd:string "token": xsd:string "postIntervalSec": xsd:unsignedInt "autoDashboardCreate": xsd:boolean "enableAlertAnnotations": xsd:boolean "enableConfigAnnotations": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:libratoMetricsConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/libratoMetricsConfigSet?storageSystem=val0&username=val1&token=val2&postIntervalSec=0&autoDashboardCreate=val4&enableAlertAnnotations=val5&enableConfigAnnotations=val6&flags=0"
curl -k -u admin:password -d @libratoMetricsConfigSet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
licenseActivate
Request Parameters
{ "method": "licenseActivate", "params": { "activationKey": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:license }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseActivate?activationKey=val0&flags=0"
curl -k -u admin:password -d @licenseActivate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
licenseActivateOnline
Request Parameters
{ "method": "licenseActivateOnline", "params": { "licenseKey": xsd:string "leaseRenewal": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:license }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseActivateOnline?licenseKey=val0&leaseRenewal=val1&flags=0"
curl -k -u admin:password -d @licenseActivateOnline.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
licenseAdd
Request Parameters
{ "method": "licenseAdd", "params": { "storageSystem": xsd:string "keyBlock": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:license }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseAdd?storageSystem=val0&keyBlock=val1&flags=0"
curl -k -u admin:password -d @licenseAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
licenseEnum
Request Parameters
{ "method": "licenseEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:license }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseEnum?flags=0"
curl -k -u admin:password -d @licenseEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
licenseGet
Request Parameters
{ "method": "licenseGet", "params": { "license": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:license }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseGet?license=val0&flags=0"
curl -k -u admin:password -d @licenseGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
licenseModifySupportInfo
Request Parameters
{ "method": "licenseModifySupportInfo", "params": { "licenseKey": xsd:string "resellerName": xsd:string "resellerContactNumber": xsd:string "resellerEmail": xsd:string "supportContractRef": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:license }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseModifySupportInfo?licenseKey=val0&resellerName=val1&resellerContactNumber=val2&resellerEmail=val3&supportContractRef=val4&flags=0"
curl -k -u admin:password -d @licenseModifySupportInfo.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
licenseRemove
Request Parameters
{ "method": "licenseRemove", "params": { "license": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:license }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseRemove?license=val0&flags=0"
curl -k -u admin:password -d @licenseRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
login
Request Parameters
{ "method": "login", "params": { "reserved": xsd:string "multiFactorAuthToken": xsd:string } }
Response Parameters
{ "authObj": osn:mfaLogin "roleObj": osn:role "userObj": osn:user "storageCloudList": osn:storageCloud }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/login?reserved=val0&multiFactorAuthToken=val1"
curl -k -u admin:password -d @login.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
loginVerify
Request Parameters
{ "method": "loginVerify", "params": { "authRequestCode": xsd:string "passcode": xsd:string } }
Response Parameters
{ "authObj": osn:mfaLogin "userObj": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/loginVerify?authRequestCode=val0&passcode=val1"
curl -k -u admin:password -d @loginVerify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
logout
Request Parameters
{ "method": "logout", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/logout?flags=0"
curl -k -u admin:password -d @logout.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
multiFactorAuthConfigCreate
Request Parameters
{ "method": "multiFactorAuthConfigCreate", "params": { "apiHost": xsd:string "integrationKey": xsd:string "secretKey": xsd:string "name": xsd:string "description": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:multiFactorAuthConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigCreate?apiHost=val0&integrationKey=val1&secretKey=val2&name=val3&description=val4&flags=0"
curl -k -u admin:password -d @multiFactorAuthConfigCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
multiFactorAuthConfigDelete
Request Parameters
{ "method": "multiFactorAuthConfigDelete", "params": { "mfaConfigList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:multiFactorAuthConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigDelete?mfaConfigList=val0&flags=0"
curl -k -u admin:password -d @multiFactorAuthConfigDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
multiFactorAuthConfigEnum
Request Parameters
{ "method": "multiFactorAuthConfigEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:multiFactorAuthConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigEnum?flags=0"
curl -k -u admin:password -d @multiFactorAuthConfigEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
multiFactorAuthConfigGet
Request Parameters
{ "method": "multiFactorAuthConfigGet", "params": { "mfaConfig": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:multiFactorAuthConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigGet?mfaConfig=val0&flags=0"
curl -k -u admin:password -d @multiFactorAuthConfigGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
multiFactorAuthConfigModify
Request Parameters
{ "method": "multiFactorAuthConfigModify", "params": { "mfaConfig": xsd:string "newSecretKey": xsd:string "newName": xsd:string "newDescription": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:multiFactorAuthConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigModify?mfaConfig=val0&newSecretKey=val1&newName=val2&newDescription=val3&flags=0"
curl -k -u admin:password -d @multiFactorAuthConfigModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
multiFactorAuthConfigUserAssignUnassign
Request Parameters
{ "method": "multiFactorAuthConfigUserAssignUnassign", "params": { "configMappings": xsd:string "modType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigUserAssignUnassign?configMappings=val0&modType=0&flags=0"
curl -k -u admin:password -d @multiFactorAuthConfigUserAssignUnassign.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareAddGroupQuota", "params": { "networkShare": xsd:string "group": xsd:string "quota": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareAddGroupQuota?networkShare=val0&group=val1"a=val2&flags=0"
curl -k -u admin:password -d @networkShareAddGroupQuota.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareAddUserQuota", "params": { "networkShare": xsd:string "user": xsd:string "quota": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareAddUserQuota?networkShare=val0&user=val1"a=val2&flags=0"
curl -k -u admin:password -d @networkShareAddUserQuota.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareCifsOptionEnum", "params": { "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:networkShareCifsOption }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCifsOptionEnum?networkShare=val0&flags=0"
curl -k -u admin:password -d @networkShareCifsOptionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareCifsOptionGet", "params": { "networkShareId": xsd:string "key": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:networkShareCifsOption }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCifsOptionGet?networkShareId=val0&key=val1&flags=0"
curl -k -u admin:password -d @networkShareCifsOptionGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareClientAdd", "params": { "networkShareId": xsd:string "clientFilter": xsd:string "async": xsd:boolean "secure": xsd:boolean "subtreeCheck": xsd:boolean "readOnly": xsd:boolean "customOptions": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientAdd?networkShareId=val0&clientFilter=val1&async=val2&secure=val3&subtreeCheck=val4&readOnly=val5&customOptions=val6&flags=0"
curl -k -u admin:password -d @networkShareClientAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareClientEnum", "params": { "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:networkShareClient }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientEnum?networkShare=val0&flags=0"
curl -k -u admin:password -d @networkShareClientEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareClientGet", "params": { "networkShareId": xsd:string "networkShareClientId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:networkShareClient }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientGet?networkShareId=val0&networkShareClientId=val1&flags=0"
curl -k -u admin:password -d @networkShareClientGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareClientModify", "params": { "networkShareId": xsd:string "networkShareClientId": xsd:string "readOnly": xsd:boolean "secure": xsd:boolean "async": xsd:boolean "subtreeCheck": xsd:boolean "customOptions": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientModify?networkShareId=val0&networkShareClientId=val1&readOnly=val2&secure=val3&async=val4&subtreeCheck=val5&customOptions=val6&flags=0"
curl -k -u admin:password -d @networkShareClientModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareClientRemove", "params": { "networkShareId": xsd:string "networkShareClientId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientRemove?networkShareId=val0&networkShareClientId=val1&flags=0"
curl -k -u admin:password -d @networkShareClientRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareClone", "params": { "networkShare": xsd:string "cloneName": xsd:string "description": xsd:string "provisionableId": xsd:string "readOnly": xsd:boolean "isActive": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClone?networkShare=val0&cloneName=val1&description=val2&provisionableId=val3&readOnly=val4&isActive=val5&flags=0"
curl -k -u admin:password -d @networkShareClone.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareCreate", "params": { "name": xsd:string "description": xsd:string "provisionableId": xsd:string "isPublic": xsd:boolean "isActive": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCreate?name=val0&description=val1&provisionableId=val2&isPublic=val3&isActive=val4&flags=0"
curl -k -u admin:password -d @networkShareCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareCreateAlias", "params": { "name": xsd:string "description": xsd:string "parentShareId": xsd:string "subSharePath": xsd:string "inheritParentSettings": xsd:unsignedInt "isPublic": xsd:boolean "isActive": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCreateAlias?name=val0&description=val1&parentShareId=val2&subSharePath=val3&inheritParentSettings=0&isPublic=val5&isActive=val6&flags=0"
curl -k -u admin:password -d @networkShareCreateAlias.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareCreateEx", "params": { "name": xsd:string "description": xsd:string "provisionableId": xsd:string "isPublic": xsd:boolean "isActive": xsd:boolean "enableCifs": xsd:boolean "userAccessList": xsd:string "cifsOptions": xsd:string "disableSnapBrowsing": xsd:boolean "spaceQuota": xsd:unsignedLong "spaceQuotaExcludeSnapshots": xsd:boolean "syncPolicy": xsd:unsignedInt "compressionType": xsd:string "copies": xsd:unsignedInt "shareOwner": xsd:string "shareOwnerGroup": xsd:string "permissions": xsd:string "blockSizeKb": xsd:unsignedInt "spaceReserved": xsd:unsignedLong "vvolType": xsd:unsignedInt "protocolEndPointId": xsd:string "isCloudContainerCache": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCreateEx?name=val0&description=val1&provisionableId=val2&isPublic=val3&isActive=val4&enableCifs=val5&userAccessList=val6&cifsOptions=val7&disableSnapBrowsing=val8&spaceQuota=val9&spaceQuotaExcludeSnapshots=val10&syncPolicy=0&compressionType=val12&copies=0&shareOwner=val14&shareOwnerGroup=val15&permissions=val16&blockSizeKb=0&spaceReserved=val18&vvolType=0&protocolEndPointId=val20&isCloudContainerCache=val21&flags=0"
curl -k -u admin:password -d @networkShareCreateEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareDelete", "params": { "networkShareId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareDelete?networkShareId=val0&flags=0"
curl -k -u admin:password -d @networkShareDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareDeleteEx", "params": { "networkShareList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareDeleteEx?networkShareList=val0&flags=0"
curl -k -u admin:password -d @networkShareDeleteEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareDisable", "params": { "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareDisable?networkShare=val0&flags=0"
curl -k -u admin:password -d @networkShareDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareEnable", "params": { "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareEnable?networkShare=val0&flags=0"
curl -k -u admin:password -d @networkShareEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareEnum", "params": { "networkShareList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareEnum?networkShareList=val0&flags=0"
curl -k -u admin:password -d @networkShareEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareEnumQuotas", "params": { "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "userSpaceList": osn:networkShareQuota "groupSpaceList": osn:networkShareQuota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareEnumQuotas?networkShare=val0&flags=0"
curl -k -u admin:password -d @networkShareEnumQuotas.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareFileCopy", "params": { "networkShare": xsd:string "sourceFilePath": xsd:string "targetFilePath": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareFile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareFileCopy?networkShare=val0&sourceFilePath=val1&targetFilePath=val2&flags=0"
curl -k -u admin:password -d @networkShareFileCopy.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareFileCreate", "params": { "networkShare": xsd:string "filePath": xsd:string "size": xsd:unsignedLong "thinProvisioned": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareFile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareFileCreate?networkShare=val0&filePath=val1&size=val2&thinProvisioned=val3&flags=0"
curl -k -u admin:password -d @networkShareFileCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareFileDelete", "params": { "networkShare": xsd:string "filePath": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareFile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareFileDelete?networkShare=val0&filePath=val1&flags=0"
curl -k -u admin:password -d @networkShareFileDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareFileExpand", "params": { "networkShare": xsd:string "filePath": xsd:string "newSize": xsd:unsignedLong "thickProvisioned": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareFile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareFileExpand?networkShare=val0&filePath=val1&newSize=val2&thickProvisioned=val3&flags=0"
curl -k -u admin:password -d @networkShareFileExpand.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareFileLockEnum", "params": { "networkShareId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:networkShareFileLock }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareFileLockEnum?networkShareId=val0&flags=0"
curl -k -u admin:password -d @networkShareFileLockEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareGet", "params": { "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareGet?networkShare=val0&flags=0"
curl -k -u admin:password -d @networkShareGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareHealthCheck", "params": { "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:resourceHealthCheck }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareHealthCheck?networkShare=val0&flags=0"
curl -k -u admin:password -d @networkShareHealthCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareJoinDomain", "params": { "storageSystemId": xsd:string "domain": xsd:string "realm": xsd:string "kdc": xsd:string "domainAdmin": xsd:string "password": xsd:string "idmapMode": xsd:unsignedInt "allowTrustedDomains": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareServiceConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareJoinDomain?storageSystemId=val0&domain=val1&realm=val2&kdc=val3&domainAdmin=val4&password=val5&idmapMode=0&allowTrustedDomains=val7&flags=0"
curl -k -u admin:password -d @networkShareJoinDomain.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareLeaveDomain", "params": { "storageSystemId": xsd:string "domainAdmin": xsd:string "password": xsd:string "preserveAdUserAccessEntries": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareServiceConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareLeaveDomain?storageSystemId=val0&domainAdmin=val1&password=val2&preserveAdUserAccessEntries=val3&flags=0"
curl -k -u admin:password -d @networkShareLeaveDomain.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareModify", "params": { "networkShare": xsd:string "name": xsd:string "description": xsd:string "isActive": xsd:boolean "enableCifs": xsd:boolean "userAccessList": xsd:string "cifsOptions": xsd:string "disableSnapBrowsing": xsd:boolean "spaceQuota": xsd:unsignedLong "spaceQuotaExcludeSnapshots": xsd:boolean "syncPolicy": xsd:unsignedInt "compressionType": xsd:string "copies": xsd:unsignedInt "shareOwner": xsd:string "shareOwnerGroup": xsd:string "permissions": xsd:string "blockSizeKb": xsd:unsignedInt "isActiveCheckpoint": xsd:boolean "spaceReserved": xsd:unsignedLong "modifyShareQuota": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareModify?networkShare=val0&name=val1&description=val2&isActive=val3&enableCifs=val4&userAccessList=val5&cifsOptions=val6&disableSnapBrowsing=val7&spaceQuota=val8&spaceQuotaExcludeSnapshots=val9&syncPolicy=0&compressionType=val11&copies=0&shareOwner=val13&shareOwnerGroup=val14&permissions=val15&blockSizeKb=0&isActiveCheckpoint=val17&spaceReserved=val18&modifyShareQuota=val19&flags=0"
curl -k -u admin:password -d @networkShareModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceAddRemove", "params": { "networkShareNamespace": xsd:string "modType": xsd:unsignedInt "preferredPortList": xsd:string "shareList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareNamespace }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceAddRemove?networkShareNamespace=val0&modType=0&preferredPortList=val2&shareList=val3&flags=0"
curl -k -u admin:password -d @networkShareNamespaceAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceCreate", "params": { "name": xsd:string "description": xsd:string "enableMicrosoftDfs": xsd:boolean "enableNfsRefferals": xsd:boolean "dfsMode": xsd:unsignedInt "preferredPortList": xsd:string "shareList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareNamespace }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceCreate?name=val0&description=val1&enableMicrosoftDfs=val2&enableNfsRefferals=val3&dfsMode=0&preferredPortList=val5&shareList=val6&flags=0"
curl -k -u admin:password -d @networkShareNamespaceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceDelete", "params": { "networkShareNamespace": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareNamespace }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceDelete?networkShareNamespace=val0&flags=0"
curl -k -u admin:password -d @networkShareNamespaceDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:networkShareNamespace }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceEnum?flags=0"
curl -k -u admin:password -d @networkShareNamespaceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceGet", "params": { "networkShareNamespace": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:networkShareNamespace }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceGet?networkShareNamespace=val0&flags=0"
curl -k -u admin:password -d @networkShareNamespaceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceModify", "params": { "networkShareNamespace": xsd:string "name": xsd:string "description": xsd:string "enableMicrosoftDfs": xsd:boolean "enableNfsRefferals": xsd:boolean "dfsMode": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareNamespace }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceModify?networkShareNamespace=val0&name=val1&description=val2&enableMicrosoftDfs=val3&enableNfsRefferals=val4&dfsMode=0&flags=0"
curl -k -u admin:password -d @networkShareNamespaceModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceShareAssocEnum", "params": { "networkShareNamespace": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:networkShareNamespaceShareAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceShareAssocEnum?networkShareNamespace=val0&flags=0"
curl -k -u admin:password -d @networkShareNamespaceShareAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceShareAssocGet", "params": { "networkShareNamespace": xsd:string "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:networkShareNamespaceShareAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceShareAssocGet?networkShareNamespace=val0&networkShare=val1&flags=0"
curl -k -u admin:password -d @networkShareNamespaceShareAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceSystemAssocEnum", "params": { "networkShareNamespace": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:networkShareNamespaceSystemAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceSystemAssocEnum?networkShareNamespace=val0&flags=0"
curl -k -u admin:password -d @networkShareNamespaceSystemAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNamespaceSystemAssocGet", "params": { "networkShareNamespace": xsd:string "storageSystem": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:networkShareNamespaceSystemAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceSystemAssocGet?networkShareNamespace=val0&storageSystem=val1&flags=0"
curl -k -u admin:password -d @networkShareNamespaceSystemAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareNfsConfig", "params": { "storageSystem": xsd:string "nfsMode": xsd:unsignedInt "enableKerberos": xsd:boolean "defaultOptions": xsd:string "reserved": xsd:string "nfsKerberosMode": xsd:unsignedInt "disableBrowsing": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShareServiceConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNfsConfig?storageSystem=val0&nfsMode=0&enableKerberos=val2&defaultOptions=val3&reserved=val4&nfsKerberosMode=0&disableBrowsing=val6&flags=0"
curl -k -u admin:password -d @networkShareNfsConfig.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareRemoveGroupQuota", "params": { "networkShare": xsd:string "group": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareRemoveGroupQuota?networkShare=val0&group=val1&flags=0"
curl -k -u admin:password -d @networkShareRemoveGroupQuota.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareRemoveUserQuota", "params": { "networkShare": xsd:string "user": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareRemoveUserQuota?networkShare=val0&user=val1&flags=0"
curl -k -u admin:password -d @networkShareRemoveUserQuota.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareRestore", "params": { "networkShare": xsd:string "snapshotShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareRestore?networkShare=val0&snapshotShare=val1&flags=0"
curl -k -u admin:password -d @networkShareRestore.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareRollback", "params": { "networkShare": xsd:string "snapshotShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareRollback?networkShare=val0&snapshotShare=val1&flags=0"
curl -k -u admin:password -d @networkShareRollback.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareServicesRestart", "params": { "storageSystem": xsd:string "restartNfs": xsd:boolean "restartSamba": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareServicesRestart?storageSystem=val0&restartNfs=val1&restartSamba=val2&flags=0"
curl -k -u admin:password -d @networkShareServicesRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareSessionEnum", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:networkShareSession }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareSessionEnum?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @networkShareSessionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareSessionGet", "params": { "sessionId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:networkShareSession }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareSessionGet?sessionId=val0&flags=0"
curl -k -u admin:password -d @networkShareSessionGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareSetQuotas", "params": { "networkShare": xsd:string "list": osn:networkShareQuota "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Request Parameters
{ "method": "networkShareSnapshot", "params": { "networkShare": xsd:string "snapshotName": xsd:string "description": xsd:string "provisionableId": xsd:string "readOnly": xsd:boolean "isActive": xsd:boolean "uuid": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:networkShare }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareSnapshot?networkShare=val0&snapshotName=val1&description=val2&provisionableId=val3&readOnly=val4&isActive=val5&uuid=val6&flags=0"
curl -k -u admin:password -d @networkShareSnapshot.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareUserAccessEnum", "params": { "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:networkShareUserAccess }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareUserAccessEnum?networkShare=val0&flags=0"
curl -k -u admin:password -d @networkShareUserAccessEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "networkShareUserAccessGet", "params": { "networkShareUserAccessId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:networkShareUserAccess }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareUserAccessGet?networkShareUserAccessId=val0&flags=0"
curl -k -u admin:password -d @networkShareUserAccessGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
objectEnum
Request Parameters
{ "method": "objectEnum", "params": { "propKey": xsd:string "propValue": xsd:string "propType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:object }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectEnum?propKey=val0&propValue=val1&propType=0&flags=0"
curl -k -u admin:password -d @objectEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
objectGet
Request Parameters
{ "method": "objectGet", "params": { "objectId": xsd:string "objectType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:object }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectGet?objectId=val0&objectType=0&flags=0"
curl -k -u admin:password -d @objectGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
objectPropertyDelete
Request Parameters
{ "method": "objectPropertyDelete", "params": { "objectId": xsd:string "propKey": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:objectProperty }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectPropertyDelete?objectId=val0&propKey=val1&flags=0"
curl -k -u admin:password -d @objectPropertyDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
objectPropertyEnum
Request Parameters
{ "method": "objectPropertyEnum", "params": { "objectId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:objectProperty }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectPropertyEnum?objectId=val0&flags=0"
curl -k -u admin:password -d @objectPropertyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
objectPropertyGet
Request Parameters
{ "method": "objectPropertyGet", "params": { "objectId": xsd:string "propKey": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:objectProperty }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectPropertyGet?objectId=val0&propKey=val1&flags=0"
curl -k -u admin:password -d @objectPropertyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
objectPropertySet
Request Parameters
{ "method": "objectPropertySet", "params": { "objectId": xsd:string "objectType": xsd:unsignedInt "propKey": xsd:string "propValue": xsd:string "propType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:objectProperty }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectPropertySet?objectId=val0&objectType=0&propKey=val2&propValue=val3&propType=0&flags=0"
curl -k -u admin:password -d @objectPropertySet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
passwordPolicyGet
Request Parameters
{ "method": "passwordPolicyGet", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:passwordPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/passwordPolicyGet?flags=0"
curl -k -u admin:password -d @passwordPolicyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
passwordPolicySet
Sets the policy for user password complexity enforcement. Use #passwordPolicyGet to get current settings then call Set to modify with adjusted values.
Request Parameters
{ "method": "passwordPolicySet", "params": { "allowedSpecialChars": xsd:string - set of allowed special characters "complexityReq": xsd:unsignedInt - see enum:passwordComplexityReq "minLength": xsd:unsignedInt - {{{1}}} "maxLength": xsd:unsignedInt - Maximum allowed password length "allowedLoginAttemptsUntilShortLockout": xsd:unsignedInt - Number of bad logins until account hits 2 min temporary lockout, 0 indicates no lockout "allowedLoginAttemptsUntilPermLockout": xsd:unsignedInt - Number of bad logins until account is locked, 0 indicates no lockout "daysUntilExpiration": xsd:unsignedInt - Number of days until user password expires, 0 indicates no expiration. "uniquePasswordsUntilReuse": xsd:unsignedInt - prevents users from reusing passwords by recording previously used password hashes "minDaysBetweenPasswordChange": xsd:unsignedInt - minimum days between password change makes it so that passwords cannot be frequently modified, 0 indicates no min days "minutesUntilWebAutoLogout": xsd:unsignedInt - Time elapsed until automatic web logout from the WUI if user is idle "systemUseNotification": xsd:string - arbitrary notice to present in the WUI when users login "webAccessMode": xsd:unsignedInt - 0 allow HTTP & HTTPS, 1 disable HTTP, 2 redirect HTTP port to HTTPS "accountInactiveDaysUntilLockout": xsd:unsignedInt - locks out inactive accounts not used for a given amount of time, set to 0 for no lockout "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:passwordPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/passwordPolicySet?allowedSpecialChars=val0&complexityReq=0&minLength=0&maxLength=0&allowedLoginAttemptsUntilShortLockout=0&allowedLoginAttemptsUntilPermLockout=0&daysUntilExpiration=0&uniquePasswordsUntilReuse=0&minDaysBetweenPasswordChange=0&minutesUntilWebAutoLogout=0&systemUseNotification=val10&webAccessMode=0&accountInactiveDaysUntilLockout=0&flags=0"
curl -k -u admin:password -d @passwordPolicySet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
permissionDefinitionEnum
Request Parameters
{ "method": "permissionDefinitionEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:permissionDefinition }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/permissionDefinitionEnum?flags=0"
curl -k -u admin:password -d @permissionDefinitionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskCopy
Provide a way for 3rd party SAN FC/iSCSI LUNs (Block Device) or Storage Volume to be copied to a new Storage Volume, Network Share, or Block Device
Request Parameters
{ "method": "physicalDiskCopy", "params": { "sourceId": xsd:string "targetId": xsd:string "sourceType": xsd:unsignedInt "targetType": xsd:unsignedInt "targetName": xsd:string "blockSizeKb": xsd:unsignedInt "targetImageFileType": xsd:unsignedInt "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "storageVolumeObj": osn:storageVolume "networkShareObj": osn:networkShare "physicalDiskObj": osn:physicalDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskCopy?sourceId=val0&targetId=val1&sourceType=0&targetType=0&targetName=val4&blockSizeKb=0&targetImageFileType=0&flags=0"
curl -k -u admin:password -d @physicalDiskCopy.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskDataMigration
Provide a way for 3rd party SAN FC/iSCSI LUNs to be copied to a new Storage Volume on a specified storage pool (provisionableId)
Request Parameters
{ "method": "physicalDiskDataMigration", "params": { "physicalDriveId": xsd:string "storageVolumeName": xsd:string "provisionableId": xsd:string "blockSizeKb": xsd:unsignedInt "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskDataMigration?physicalDriveId=val0&storageVolumeName=val1&provisionableId=val2&blockSizeKb=0&flags=0"
curl -k -u admin:password -d @physicalDiskDataMigration.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskEnum
Returns a list of all disk/storage media devices. Optionally specific disks or filter criteria may be passed into the physical disk list including, [nopaths], [paths], [spares], [nospares], [local], [used], [unused], [N] where N is some number of unused disks to be selected, [gt:SIZE] indicating the disk size must be greater than some value SIZE, [lt:SIZE] for disks less than a specific size, and [eq:SIZE] for disks that are a specific size. Other APIs including #storagePoolCreate, #storagePoolGrow, #storagePoolSpareAddRemove, and #storagePoolCacheAddRemove also support this filtering / disk search syntax. Other supported filter parameters includ storage system IDs, friendly disk names, device names like 'sdc', device paths, device scsiId, device serialNumber, and property filters like [vendor:VVVV], [product:PPPP], and [disktype:N].
Request Parameters
{ "method": "physicalDiskEnum", "params": { "physicalDiskList": xsd:string "flags": xsd:unsignedInt - supports the NORMALIZE flag to reduce results so that multiple instances of the same disk (from different systems and/or controllers) is reduced to a unique instance of each disk } }
Response Parameters
{ "list": osn:physicalDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskEnum?physicalDiskList=val0&flags=0"
curl -k -u admin:password -d @physicalDiskEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskFormat
Formats the specified physical disk with optional data shreding.
Request Parameters
{ "method": "physicalDiskFormat", "params": { "physicalDriveIdList": xsd:string "quickFormat": xsd:unsignedInt "shredMode": xsd:unsignedInt "releaseIoFence": xsd:boolean "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "list": osn:physicalDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskFormat?physicalDriveIdList=val0&quickFormat=0&shredMode=0&releaseIoFence=val3&flags=0"
curl -k -u admin:password -d @physicalDiskFormat.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskGet
Request Parameters
{ "method": "physicalDiskGet", "params": { "physicalDrive": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:physicalDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskGet?physicalDrive=val0&flags=0"
curl -k -u admin:password -d @physicalDiskGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskGlobalSpareAddRemove
Add/Removes the specified disks to the pool of global hot-spares.
Request Parameters
{ "method": "physicalDiskGlobalSpareAddRemove", "params": { "physicalDriveList": xsd:string "modType": xsd:unsignedInt - {{{1}}} "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "list": osn:physicalDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskGlobalSpareAddRemove?physicalDriveList=val0&modType=0&flags=0"
curl -k -u admin:password -d @physicalDiskGlobalSpareAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskGlobalSpareEnum
Request Parameters
{ "method": "physicalDiskGlobalSpareEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:physicalDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskGlobalSpareEnum?flags=0"
curl -k -u admin:password -d @physicalDiskGlobalSpareEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskHotspareMarkerCleanup
Request Parameters
{ "method": "physicalDiskHotspareMarkerCleanup", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:physicalDiskHotspareMarker }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskHotspareMarkerCleanup?flags=0"
curl -k -u admin:password -d @physicalDiskHotspareMarkerCleanup.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskHotspareMarkerDelete
Request Parameters
{ "method": "physicalDiskHotspareMarkerDelete", "params": { "markerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:physicalDiskHotspareMarker }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskHotspareMarkerDelete?markerId=val0&flags=0"
curl -k -u admin:password -d @physicalDiskHotspareMarkerDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskHotspareMarkerEnum
Request Parameters
{ "method": "physicalDiskHotspareMarkerEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:physicalDiskHotspareMarker }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskHotspareMarkerEnum?flags=0"
curl -k -u admin:password -d @physicalDiskHotspareMarkerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskHotspareMarkerGet
Request Parameters
{ "method": "physicalDiskHotspareMarkerGet", "params": { "markerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:physicalDiskHotspareMarker }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskHotspareMarkerGet?markerId=val0&flags=0"
curl -k -u admin:password -d @physicalDiskHotspareMarkerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskIdentify
Activates the LED beacon on the specified drive.
Request Parameters
{ "method": "physicalDiskIdentify", "params": { "physicalDrive": xsd:string "pattern": xsd:string "duration": xsd:unsignedInt "blinkType": xsd:unsignedInt "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:physicalDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskIdentify?physicalDrive=val0&pattern=val1&duration=0&blinkType=0&flags=0"
curl -k -u admin:password -d @physicalDiskIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskMultipathConfigAddRemove
Request Parameters
{ "method": "physicalDiskMultipathConfigAddRemove", "params": { "storageSystemId": xsd:string "modType": xsd:unsignedInt "deviceTagList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:multipathConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskMultipathConfigAddRemove?storageSystemId=val0&modType=0&deviceTagList=val2&flags=0"
curl -k -u admin:password -d @physicalDiskMultipathConfigAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskMultipathConfigEnum
Request Parameters
{ "method": "physicalDiskMultipathConfigEnum", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:multipathConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskMultipathConfigEnum?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @physicalDiskMultipathConfigEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskMultipathConfigScan
Forces an immediate scan and configuration of multipath devices on the specified system.
Request Parameters
{ "method": "physicalDiskMultipathConfigScan", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "list": osn:multipathConfig }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskMultipathConfigScan?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @physicalDiskMultipathConfigScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskPathAssocEnum
Request Parameters
{ "method": "physicalDiskPathAssocEnum", "params": { "multipathDiskId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:physicalDiskPathAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskPathAssocEnum?multipathDiskId=val0&flags=0"
curl -k -u admin:password -d @physicalDiskPathAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskPathAssocGet
Request Parameters
{ "method": "physicalDiskPathAssocGet", "params": { "multipathDiskId": xsd:string "physicalDiskId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:physicalDiskPathAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskPathAssocGet?multipathDiskId=val0&physicalDiskId=val1&flags=0"
curl -k -u admin:password -d @physicalDiskPathAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
physicalDiskScan
Forces an immediate rescan to discover disk devices
Request Parameters
{ "method": "physicalDiskScan", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "list": osn:physicalDisk }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskScan?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @physicalDiskScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
pingCheck
Request Parameters
{ "method": "pingCheck", "params": { "storageSystem": xsd:string "verifyClientIps": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": xsd:string }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/pingCheck?storageSystem=val0&verifyClientIps=val1&flags=0"
curl -k -u admin:password -d @pingCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
providerAppEnum
Returns a list of registered Provider Apps (ex: VMware VASA).
Request Parameters
{ "method": "providerAppEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:providerApp }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/providerAppEnum?flags=0"
curl -k -u admin:password -d @providerAppEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
providerAppGet
Returns details of a specific Provider App registered on a Storage System
Request Parameters
{ "method": "providerAppGet", "params": { "storageSystem": xsd:string "providerType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:providerApp }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/providerAppGet?storageSystem=val0&providerType=0&flags=0"
curl -k -u admin:password -d @providerAppGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
providerAppRegister
Registers an external provider component with the Storage Grid (ex: VASA)
Request Parameters
{ "method": "providerAppRegister", "params": { "storageSystem": xsd:string "providerType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:providerApp }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/providerAppRegister?storageSystem=val0&providerType=0&flags=0"
curl -k -u admin:password -d @providerAppRegister.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
providerAppUnregister
Unreigsters a provider (ex: VMware VASA)
Request Parameters
{ "method": "providerAppUnregister", "params": { "providerApp": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:providerApp }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/providerAppUnregister?providerApp=val0&flags=0"
curl -k -u admin:password -d @providerAppUnregister.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
qosPolicyCreate
Request Parameters
{ "method": "qosPolicyCreate", "params": { "name": xsd:string "description": xsd:string "qosReadIops": xsd:unsignedLong "qosWriteIops": xsd:unsignedLong "qosReadBandwidth": xsd:unsignedLong "qosWriteBandwidth": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:qosPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyCreate?name=val0&description=val1&qosReadIops=val2&qosWriteIops=val3&qosReadBandwidth=val4&qosWriteBandwidth=val5&flags=0"
curl -k -u admin:password -d @qosPolicyCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
qosPolicyDelete
Request Parameters
{ "method": "qosPolicyDelete", "params": { "qosPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:qosPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyDelete?qosPolicy=val0&flags=0"
curl -k -u admin:password -d @qosPolicyDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
qosPolicyEnum
Request Parameters
{ "method": "qosPolicyEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:qosPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyEnum?flags=0"
curl -k -u admin:password -d @qosPolicyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
qosPolicyGet
Request Parameters
{ "method": "qosPolicyGet", "params": { "qosPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:qosPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyGet?qosPolicy=val0&flags=0"
curl -k -u admin:password -d @qosPolicyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
qosPolicyModify
Request Parameters
{ "method": "qosPolicyModify", "params": { "qosPolicy": xsd:string "name": xsd:string "description": xsd:string "qosReadIops": xsd:unsignedLong "qosWriteIops": xsd:unsignedLong "qosReadBandwidth": xsd:unsignedLong "qosWriteBandwidth": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:qosPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyModify?qosPolicy=val0&name=val1&description=val2&qosReadIops=val3&qosWriteIops=val4&qosReadBandwidth=val5&qosWriteBandwidth=val6&flags=0"
curl -k -u admin:password -d @qosPolicyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
remoteNfsExportsEnum
Request Parameters
{ "method": "remoteNfsExportsEnum", "params": { "networkShare": xsd:string "nfsHostname": xsd:string "backupPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": xsd:string }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/remoteNfsExportsEnum?networkShare=val0&nfsHostname=val1&backupPolicy=val2&flags=0"
curl -k -u admin:password -d @remoteNfsExportsEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
remoteStoragePoolEnum
Request Parameters
{ "method": "remoteStoragePoolEnum", "params": { "remoteStorageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/remoteStoragePoolEnum?remoteStorageSystemId=val0&flags=0"
curl -k -u admin:password -d @remoteStoragePoolEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaAssocDelete
Request Parameters
{ "method": "replicaAssocDelete", "params": { "assocId": xsd:string "deleteSourceReplicatable": xsd:boolean "deleteTargetReplicatable": xsd:boolean "deleteReplicaAssocHead": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicaAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaAssocDelete?assocId=val0&deleteSourceReplicatable=val1&deleteTargetReplicatable=val2&deleteReplicaAssocHead=val3&flags=0"
curl -k -u admin:password -d @replicaAssocDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaAssocEnum
Request Parameters
{ "method": "replicaAssocEnum", "params": { "replicatableId": xsd:string "sourcesOnly": xsd:boolean "targetsOnly": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:replicaAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaAssocEnum?replicatableId=val0&sourcesOnly=val1&targetsOnly=val2&flags=0"
curl -k -u admin:password -d @replicaAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaAssocGet
Request Parameters
{ "method": "replicaAssocGet", "params": { "assocId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:replicaAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaAssocGet?assocId=val0&flags=0"
curl -k -u admin:password -d @replicaAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaAssocUpdate
Request Parameters
{ "method": "replicaAssocUpdate", "params": { "assocObj": osn:replicaAssoc "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicaAssoc }
replicaCreate
Request Parameters
{ "method": "replicaCreate", "params": { "replicatableId": xsd:string "storageSystemLinkId": xsd:string "replicaName": xsd:string "replicaDescription": xsd:string "targetStoragePoolId": xsd:string "replicationPriority": xsd:unsignedInt "smartSync": xsd:boolean "forcePrimary": xsd:boolean "reserved": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicaAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaCreate?replicatableId=val0&storageSystemLinkId=val1&replicaName=val2&replicaDescription=val3&targetStoragePoolId=val4&replicationPriority=0&smartSync=val6&forcePrimary=val7&reserved=val8&flags=0"
curl -k -u admin:password -d @replicaCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaReportEntryEnum
Request Parameters
{ "method": "replicaReportEntryEnum", "params": { "summaryId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:replicaReportEntry }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportEntryEnum?summaryId=val0&flags=0"
curl -k -u admin:password -d @replicaReportEntryEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaReportEntryGet
Request Parameters
{ "method": "replicaReportEntryGet", "params": { "entryId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:replicaReportEntry }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportEntryGet?entryId=val0&flags=0"
curl -k -u admin:password -d @replicaReportEntryGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaReportSummaryDelete
Request Parameters
{ "method": "replicaReportSummaryDelete", "params": { "summaryId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicaReportSummary }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportSummaryDelete?summaryId=val0&flags=0"
curl -k -u admin:password -d @replicaReportSummaryDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaReportSummaryEnum
Request Parameters
{ "method": "replicaReportSummaryEnum", "params": { "scheduleId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:replicaReportSummary }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportSummaryEnum?scheduleId=val0&flags=0"
curl -k -u admin:password -d @replicaReportSummaryEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaReportSummaryGet
Request Parameters
{ "method": "replicaReportSummaryGet", "params": { "entryId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:replicaReportSummary }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportSummaryGet?entryId=val0&flags=0"
curl -k -u admin:password -d @replicaReportSummaryGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaRollback
Request Parameters
{ "method": "replicaRollback", "params": { "assocId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicaAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaRollback?assocId=val0&flags=0"
curl -k -u admin:password -d @replicaRollback.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaStop
Request Parameters
{ "method": "replicaStop", "params": { "assocId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicaAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaStop?assocId=val0&flags=0"
curl -k -u admin:password -d @replicaStop.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicaSync
Request Parameters
{ "method": "replicaSync", "params": { "assocId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicaAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaSync?assocId=val0&flags=0"
curl -k -u admin:password -d @replicaSync.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleActivateCheckpoints
Request Parameters
{ "method": "replicationScheduleActivateCheckpoints", "params": { "schedule": xsd:string "storageVolumeList": xsd:string "networkShareList": xsd:string "autoCreateAliases": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleActivateCheckpoints?schedule=val0&storageVolumeList=val1&networkShareList=val2&autoCreateAliases=val3&flags=0"
curl -k -u admin:password -d @replicationScheduleActivateCheckpoints.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleAddRemove
Request Parameters
{ "method": "replicationScheduleAddRemove", "params": { "schedule": xsd:string "modType": xsd:unsignedInt "storageVolumeList": xsd:string "networkShareList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleAddRemove?schedule=val0&modType=0&storageVolumeList=val2&networkShareList=val3&flags=0"
curl -k -u admin:password -d @replicationScheduleAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleAssocEnum
Request Parameters
{ "method": "replicationScheduleAssocEnum", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:replicationScheduleAssocEx }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleAssocEnum?schedule=val0&flags=0"
curl -k -u admin:password -d @replicationScheduleAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleAssocGet
Request Parameters
{ "method": "replicationScheduleAssocGet", "params": { "scheduleId": xsd:string "replicatableId": xsd:string } }
Response Parameters
{ "obj": osn:replicationScheduleAssocEx }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleAssocGet?scheduleId=val0&replicatableId=val1"
curl -k -u admin:password -d @replicationScheduleAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleCreate
Request Parameters
{ "method": "replicationScheduleCreate", "params": { "name": xsd:string "description": xsd:string "storageCloudId": xsd:string "storageSystemLinkId": xsd:string "targetStorageCloudId": xsd:string "targetProvisionableId": xsd:string "priority": xsd:unsignedInt "setEnabled": xsd:unsignedInt "startDate": xsd:dateTime "maxReplicas": xsd:unsignedInt "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "storageVolumeList": xsd:string "networkShareList": xsd:string "scheduleType": xsd:unsignedInt "delayInterval": xsd:unsignedInt "offsetMinutes": xsd:unsignedInt "retentionCountHourlies": xsd:unsignedInt "retentionCountDailies": xsd:unsignedInt "retentionCountWeeklies": xsd:unsignedInt "retentionCountMonthlies": xsd:unsignedInt "retentionCountQuarterlies": xsd:unsignedInt "reuseSourceSnapshot": xsd:boolean "reuseTargetChkpnt": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleCreate?name=val0&description=val1&storageCloudId=val2&storageSystemLinkId=val3&targetStorageCloudId=val4&targetProvisionableId=val5&priority=0&setEnabled=0&startDate=val8&maxReplicas=0&daysOfWeek=0&hoursOfDay=0&storageVolumeList=val12&networkShareList=val13&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&reuseSourceSnapshot=val22&reuseTargetChkpnt=val23&flags=0"
curl -k -u admin:password -d @replicationScheduleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleDeactivateCheckpoints
Request Parameters
{ "method": "replicationScheduleDeactivateCheckpoints", "params": { "schedule": xsd:string "storageVolumeList": xsd:string "networkShareList": xsd:string "reenableSchedule": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleDeactivateCheckpoints?schedule=val0&storageVolumeList=val1&networkShareList=val2&reenableSchedule=val3&flags=0"
curl -k -u admin:password -d @replicationScheduleDeactivateCheckpoints.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleDelete
Request Parameters
{ "method": "replicationScheduleDelete", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleDelete?schedule=val0&flags=0"
curl -k -u admin:password -d @replicationScheduleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleDisable
Request Parameters
{ "method": "replicationScheduleDisable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleDisable?schedule=val0&flags=0"
curl -k -u admin:password -d @replicationScheduleDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleEnable
Request Parameters
{ "method": "replicationScheduleEnable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleEnable?schedule=val0&flags=0"
curl -k -u admin:password -d @replicationScheduleEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleEnum
Request Parameters
{ "method": "replicationScheduleEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleEnum?flags=0"
curl -k -u admin:password -d @replicationScheduleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleGet
Request Parameters
{ "method": "replicationScheduleGet", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleGet?schedule=val0&flags=0"
curl -k -u admin:password -d @replicationScheduleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleModify
Request Parameters
{ "method": "replicationScheduleModify", "params": { "schedule": xsd:string "name": xsd:string "description": xsd:string "storageCloudId": xsd:string "setEnabled": xsd:unsignedInt "startDate": xsd:dateTime "maxReplicas": xsd:unsignedInt "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "scheduleType": xsd:unsignedInt "delayInterval": xsd:unsignedInt "offsetMinutes": xsd:unsignedInt "retentionCountHourlies": xsd:unsignedInt "retentionCountDailies": xsd:unsignedInt "retentionCountWeeklies": xsd:unsignedInt "retentionCountMonthlies": xsd:unsignedInt "retentionCountQuarterlies": xsd:unsignedInt "reuseSourceSnapshot": xsd:boolean "reuseTargetChkpnt": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleModify?schedule=val0&name=val1&description=val2&storageCloudId=val3&setEnabled=0&startDate=val5&maxReplicas=0&daysOfWeek=0&hoursOfDay=0&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&reuseSourceSnapshot=val17&reuseTargetChkpnt=val18&flags=0"
curl -k -u admin:password -d @replicationScheduleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
replicationScheduleTrigger
Request Parameters
{ "method": "replicationScheduleTrigger", "params": { "schedule": xsd:string "reuseSourceSnapshot": xsd:boolean "reuseTargetChkpnt": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:replicationSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleTrigger?schedule=val0&reuseSourceSnapshot=val1&reuseTargetChkpnt=val2&flags=0"
curl -k -u admin:password -d @replicationScheduleTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportGenerate
Does analysis of the configuration of each Storage System and the grid as a whole and returns a report.
Request Parameters
{ "method": "reportGenerate", "params": { "reportType": xsd:unsignedInt "categories": xsd:unsignedInt "reportToEmail": xsd:string "reportToAlertEmails": xsd:boolean "outputFormat": xsd:unsignedInt "storagePoolIdList": xsd:string "maxDepth": xsd:unsignedInt "maxSubdirs": xsd:unsignedInt "minSubdirUsedSpace": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:report }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportGenerate?reportType=0&categories=0&reportToEmail=val2&reportToAlertEmails=val3&outputFormat=0&storagePoolIdList=val5&maxDepth=0&maxSubdirs=0&minSubdirUsedSpace=val8&flags=0"
curl -k -u admin:password -d @reportGenerate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleAddRemove
Used to add/remove Storage Pools to/from a given scrub schedule
Request Parameters
{ "method": "reportScheduleAddRemove", "params": { "schedule": xsd:string "modType": xsd:unsignedInt - {{{1}}} "reportableIdList": xsd:string "flags": xsd:unsignedInt - Pool ID list for pool capacity and share usage reports } }
Response Parameters
{ "task": osn:task "obj": osn:reportSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleAddRemove?schedule=val0&modType=0&reportableIdList=val2&flags=0"
curl -k -u admin:password -d @reportScheduleAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleAssocEnum
Request Parameters
{ "method": "reportScheduleAssocEnum", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:reportScheduleAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleAssocEnum?schedule=val0&flags=0"
curl -k -u admin:password -d @reportScheduleAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleAssocGet
Request Parameters
{ "method": "reportScheduleAssocGet", "params": { "scheduleId": xsd:string "reportableId": xsd:string } }
Response Parameters
{ "obj": osn:reportScheduleAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleAssocGet?scheduleId=val0&reportableId=val1"
curl -k -u admin:password -d @reportScheduleAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleCreate
Creates a new Scrub Schedule to automatically scrub Storage Pools
Request Parameters
{ "method": "reportScheduleCreate", "params": { "name": xsd:string "description": xsd:string "reportToEmail": xsd:string "reportToAlertEmails": xsd:boolean "reportTypes": xsd:unsignedInt "outputFormat": xsd:unsignedInt "setEnabled": xsd:unsignedInt "initialStartDate": xsd:dateTime "delayInterval": xsd:unsignedInt "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "offsetMinutes": xsd:unsignedInt "maxSubdirDepth": xsd:unsignedInt "maxSubdirsPerShare": xsd:unsignedInt "minSubdirUsedSpace": xsd:unsignedLong - Pool ID list for pool capacity and share usage reports "reportableIdList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:reportSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleCreate?name=val0&description=val1&reportToEmail=val2&reportToAlertEmails=val3&reportTypes=0&outputFormat=0&setEnabled=0&initialStartDate=val7&delayInterval=0&daysOfWeek=0&hoursOfDay=0&offsetMinutes=0&maxSubdirDepth=0&maxSubdirsPerShare=0&minSubdirUsedSpace=val14&reportableIdList=val15&flags=0"
curl -k -u admin:password -d @reportScheduleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleDelete
Deletes the specified scrub schedule.
Request Parameters
{ "method": "reportScheduleDelete", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:reportSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleDelete?schedule=val0&flags=0"
curl -k -u admin:password -d @reportScheduleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleDisable
Disables the specified scrub schedule. The schedule will not run again until it is re-enabled.
Request Parameters
{ "method": "reportScheduleDisable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:reportSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleDisable?schedule=val0&flags=0"
curl -k -u admin:password -d @reportScheduleDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleEnable
Enables a scrub schedule that is offline.
Request Parameters
{ "method": "reportScheduleEnable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:reportSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleEnable?schedule=val0&flags=0"
curl -k -u admin:password -d @reportScheduleEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleEnum
Returns a list of all the Scrub Schedules
Request Parameters
{ "method": "reportScheduleEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:reportSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleEnum?flags=0"
curl -k -u admin:password -d @reportScheduleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleGet
Returns detail on a specific Scrub Schedule
Request Parameters
{ "method": "reportScheduleGet", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:reportSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleGet?schedule=val0&flags=0"
curl -k -u admin:password -d @reportScheduleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleModify
Modifies the properties and replication interval schedule for a specific schedule
Request Parameters
{ "method": "reportScheduleModify", "params": { "schedule": xsd:string - Name or ID of a scrub schedule "name": xsd:string "description": xsd:string "reportToEmail": xsd:string "reportToAlertEmails": xsd:boolean "reportTypes": xsd:unsignedInt "outputFormat": xsd:unsignedInt "setEnabled": xsd:unsignedInt "initialStartDate": xsd:dateTime "delayInterval": xsd:unsignedInt "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "offsetMinutes": xsd:unsignedInt "maxSubdirDepth": xsd:unsignedInt "maxSubdirsPerShare": xsd:unsignedInt "minSubdirUsedSpace": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:reportSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleModify?schedule=val0&name=val1&description=val2&reportToEmail=val3&reportToAlertEmails=val4&reportTypes=0&outputFormat=0&setEnabled=0&initialStartDate=val8&delayInterval=0&daysOfWeek=0&hoursOfDay=0&offsetMinutes=0&maxSubdirDepth=0&maxSubdirsPerShare=0&minSubdirUsedSpace=val15&flags=0"
curl -k -u admin:password -d @reportScheduleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
reportScheduleTrigger
Signals the schedule manager to run the selected schedule immediately.
Request Parameters
{ "method": "reportScheduleTrigger", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:reportSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleTrigger?schedule=val0&flags=0"
curl -k -u admin:password -d @reportScheduleTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
resourceDomainAssocEnum
Request Parameters
{ "method": "resourceDomainAssocEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:resourceDomainAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainAssocEnum?flags=0"
curl -k -u admin:password -d @resourceDomainAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
resourceDomainAssocGet
Request Parameters
{ "method": "resourceDomainAssocGet", "params": { "resourceDomainAssocId": xsd:string "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:resourceDomainAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainAssocGet?resourceDomainAssocId=val0&storageSystemId=val1&flags=0"
curl -k -u admin:password -d @resourceDomainAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
resourceDomainCreate
Request Parameters
{ "method": "resourceDomainCreate", "params": { "name": xsd:string "description": xsd:string "resourceDomainType": xsd:unsignedInt "resourceDomainParentId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:resourceDomain }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainCreate?name=val0&description=val1&resourceDomainType=0&resourceDomainParentId=val3&flags=0"
curl -k -u admin:password -d @resourceDomainCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
resourceDomainDelete
Request Parameters
{ "method": "resourceDomainDelete", "params": { "resourceDomain": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:resourceDomain }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainDelete?resourceDomain=val0&flags=0"
curl -k -u admin:password -d @resourceDomainDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
resourceDomainEnum
Request Parameters
{ "method": "resourceDomainEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:resourceDomain }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainEnum?flags=0"
curl -k -u admin:password -d @resourceDomainEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
resourceDomainGet
Request Parameters
{ "method": "resourceDomainGet", "params": { "resourceDomain": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:resourceDomain }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainGet?resourceDomain=val0&flags=0"
curl -k -u admin:password -d @resourceDomainGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
resourceDomainModify
Request Parameters
{ "method": "resourceDomainModify", "params": { "resourceDomainId": xsd:string "name": xsd:string "description": xsd:string "resourceDomainType": xsd:unsignedInt "resourceDomainParentId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:resourceDomain }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainModify?resourceDomainId=val0&name=val1&description=val2&resourceDomainType=0&resourceDomainParentId=val4&flags=0"
curl -k -u admin:password -d @resourceDomainModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
resourceDomainStorageSystemAddRemove
Request Parameters
{ "method": "resourceDomainStorageSystemAddRemove", "params": { "resourceDomain": xsd:string "modType": xsd:unsignedInt "storageSystemList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:resourceDomain }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainStorageSystemAddRemove?resourceDomain=val0&modType=0&storageSystemList=val2&flags=0"
curl -k -u admin:password -d @resourceDomainStorageSystemAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
roleCreate
Request Parameters
{ "method": "roleCreate", "params": { "name": xsd:string "description": xsd:string "permissionList": osn:permissionAssignment "inheritsFrom": xsd:string "ldapGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:role }
roleDelete
Request Parameters
{ "method": "roleDelete", "params": { "role": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:role }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleDelete?role=val0&flags=0"
curl -k -u admin:password -d @roleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
roleEnum
Request Parameters
{ "method": "roleEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:role }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleEnum?flags=0"
curl -k -u admin:password -d @roleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
roleGet
Request Parameters
{ "method": "roleGet", "params": { "role": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:role }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleGet?role=val0&flags=0"
curl -k -u admin:password -d @roleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
roleModify
Request Parameters
{ "method": "roleModify", "params": { "role": xsd:string "newName": xsd:string "newDescription": xsd:string "ldapGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:role }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleModify?role=val0&newName=val1&newDescription=val2&ldapGroup=val3&flags=0"
curl -k -u admin:password -d @roleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
rolePermissionAssignmentEnum
Request Parameters
{ "method": "rolePermissionAssignmentEnum", "params": { "roleId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:rolePermissionAssignment }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/rolePermissionAssignmentEnum?roleId=val0&flags=0"
curl -k -u admin:password -d @rolePermissionAssignmentEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
rolePermissionAssignmentGet
Request Parameters
{ "method": "rolePermissionAssignmentGet", "params": { "role": xsd:string "objectType": xsd:string "operation": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:rolePermissionAssignment }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/rolePermissionAssignmentGet?role=val0&objectType=val1&operation=val2&flags=0"
curl -k -u admin:password -d @rolePermissionAssignmentGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
rolePermissionsAddRemove
Request Parameters
{ "method": "rolePermissionsAddRemove", "params": { "role": xsd:string "modType": xsd:unsignedInt "permissionList": osn:permissionAssignment "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:role }
roleSubjectAssocEnum
Request Parameters
{ "method": "roleSubjectAssocEnum", "params": { "role": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:roleSubjectAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleSubjectAssocEnum?role=val0&flags=0"
curl -k -u admin:password -d @roleSubjectAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
roleSubjectAssocGet
Request Parameters
{ "method": "roleSubjectAssocGet", "params": { "role": xsd:string "subject": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:roleSubjectAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleSubjectAssocGet?role=val0&subject=val1&flags=0"
curl -k -u admin:password -d @roleSubjectAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3ProxyCreate
Request Parameters
{ "method": "s3ProxyCreate", "params": { "storageSystem": xsd:string "name": xsd:string "description": xsd:string "proxyServerName": xsd:string "proxyLocationEndpoint": xsd:string "sslCertificate": xsd:string "sslCertificateKey": xsd:string "portNums": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3Proxy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyCreate?storageSystem=val0&name=val1&description=val2&proxyServerName=val3&proxyLocationEndpoint=val4&sslCertificate=val5&sslCertificateKey=val6&portNums=val7&flags=0"
curl -k -u admin:password -d @s3ProxyCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3ProxyDelete
Request Parameters
{ "method": "s3ProxyDelete", "params": { "s3Proxy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3Proxy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyDelete?s3Proxy=val0&flags=0"
curl -k -u admin:password -d @s3ProxyDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3ProxyEnum
Request Parameters
{ "method": "s3ProxyEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:s3Proxy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyEnum?flags=0"
curl -k -u admin:password -d @s3ProxyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3ProxyGet
Request Parameters
{ "method": "s3ProxyGet", "params": { "s3Proxy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:s3Proxy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyGet?s3Proxy=val0&flags=0"
curl -k -u admin:password -d @s3ProxyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3ProxyModify
Request Parameters
{ "method": "s3ProxyModify", "params": { "s3Proxy": xsd:string "name": xsd:string "description": xsd:string "proxyServerName": xsd:string "proxyLocationEndpoint": xsd:string "sslCertificate": xsd:string "sslCertificateKey": xsd:string "portNums": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3Proxy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyModify?s3Proxy=val0&name=val1&description=val2&proxyServerName=val3&proxyLocationEndpoint=val4&sslCertificate=val5&sslCertificateKey=val6&portNums=val7&flags=0"
curl -k -u admin:password -d @s3ProxyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3QuotaEnum
Returns a list of all the bucket quotas, optionally filtered by ceph cluster
Request Parameters
{ "method": "s3QuotaEnum", "params": { "cephClusterId": xsd:string "quotaScope": xsd:unsignedInt - see osn__s3QuotaScope "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:s3Quota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3QuotaEnum?cephClusterId=val0"aScope=0&flags=0"
curl -k -u admin:password -d @s3QuotaEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3QuotaGet
Returns details of a specific bucket quota
Request Parameters
{ "method": "s3QuotaGet", "params": { "bucketQuotaId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:s3Quota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3QuotaGet?bucketQuotaId=val0&flags=0"
curl -k -u admin:password -d @s3QuotaGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3QuotaSetGlobal
Modifies the global default quota settings for the cluster
Request Parameters
{ "method": "s3QuotaSetGlobal", "params": { "cephClusterId": xsd:string "bucketMaxObjectCountEnable": xsd:boolean - enforce per bucket max object count for this user "bucketMaxObjectCount": xsd:unsignedLong "bucketMaxSizeEnable": xsd:boolean - enforce per bucket max capacity for this user "bucketMaxSize": xsd:unsignedLong "userMaxObjectCountEnable": xsd:boolean - enforce max object count for this user "userMaxObjectCount": xsd:unsignedLong "userMaxSizeEnable": xsd:boolean - enforce max total capacity for this user "userMaxSize": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:s3Quota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3QuotaSetGlobal?cephClusterId=val0&bucketMaxObjectCountEnable=val1&bucketMaxObjectCount=val2&bucketMaxSizeEnable=val3&bucketMaxSize=val4&userMaxObjectCountEnable=val5&userMaxObjectCount=val6&userMaxSizeEnable=val7&userMaxSize=val8&flags=0"
curl -k -u admin:password -d @s3QuotaSetGlobal.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserAccessKeyAdd
Returns detailed info of the specified bucket access key with the added key
Request Parameters
{ "method": "s3UserAccessKeyAdd", "params": { "s3UserId": xsd:string "accessKey": xsd:string "secretKey": xsd:string "keyType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyAdd?s3UserId=val0&accessKey=val1&secretKey=val2&keyType=0&flags=0"
curl -k -u admin:password -d @s3UserAccessKeyAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserAccessKeyEnum
Returns a list of all the bucket access keys, optionally filtered by Ceph Cluster
Request Parameters
{ "method": "s3UserAccessKeyEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:s3UserAccessKey }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @s3UserAccessKeyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserAccessKeyGet
Returns detailed info of the specified bucket access key
Request Parameters
{ "method": "s3UserAccessKeyGet", "params": { "accessKeyId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:s3UserAccessKey }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyGet?accessKeyId=val0&flags=0"
curl -k -u admin:password -d @s3UserAccessKeyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserAccessKeyModify
Returns detailed info of the specified bucket access key with the added key
Request Parameters
{ "method": "s3UserAccessKeyModify", "params": { "s3UserId": xsd:string "accessKey": xsd:string "newSecretKey": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyModify?s3UserId=val0&accessKey=val1&newSecretKey=val2&flags=0"
curl -k -u admin:password -d @s3UserAccessKeyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserAccessKeyRemove
Returns detailed info of the specified bucket access key with the removed key
Request Parameters
{ "method": "s3UserAccessKeyRemove", "params": { "s3UserId": xsd:string "accessKey": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyRemove?s3UserId=val0&accessKey=val1&flags=0"
curl -k -u admin:password -d @s3UserAccessKeyRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserCreate
Request Parameters
{ "method": "s3UserCreate", "params": { "cephClusterId": xsd:string "tenant": xsd:string "name": xsd:string "displayName": xsd:string "emailAddress": xsd:string "accessKey": xsd:string "secretKey": xsd:string "operationMask": xsd:unsignedInt "bucketMaxObjectCountEnable": xsd:boolean "bucketMaxObjectCount": xsd:unsignedLong "bucketMaxSizeEnable": xsd:boolean "bucketMaxSize": xsd:unsignedLong "userMaxObjectCountEnable": xsd:boolean "userMaxObjectCount": xsd:unsignedLong "userMaxSizeEnable": xsd:boolean "userMaxSize": xsd:unsignedLong "maxBucketCount": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserCreate?cephClusterId=val0&tenant=val1&name=val2&displayName=val3&emailAddress=val4&accessKey=val5&secretKey=val6&operationMask=0&bucketMaxObjectCountEnable=val8&bucketMaxObjectCount=val9&bucketMaxSizeEnable=val10&bucketMaxSize=val11&userMaxObjectCountEnable=val12&userMaxObjectCount=val13&userMaxSizeEnable=val14&userMaxSize=val15&maxBucketCount=0&flags=0"
curl -k -u admin:password -d @s3UserCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserDelete
Request Parameters
{ "method": "s3UserDelete", "params": { "cephClusterId": xsd:string "s3UserId": xsd:string "deleteData": xsd:boolean "deleteKey": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserDelete?cephClusterId=val0&s3UserId=val1&deleteData=val2&deleteKey=val3&flags=0"
curl -k -u admin:password -d @s3UserDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserDisable
Request Parameters
{ "method": "s3UserDisable", "params": { "s3UserId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserDisable?s3UserId=val0&flags=0"
curl -k -u admin:password -d @s3UserDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserEnable
Request Parameters
{ "method": "s3UserEnable", "params": { "s3UserId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserEnable?s3UserId=val0&flags=0"
curl -k -u admin:password -d @s3UserEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserEnum
Request Parameters
{ "method": "s3UserEnum", "params": { "cephClusterId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserEnum?cephClusterId=val0&flags=0"
curl -k -u admin:password -d @s3UserEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserGet
Request Parameters
{ "method": "s3UserGet", "params": { "userId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserGet?userId=val0&flags=0"
curl -k -u admin:password -d @s3UserGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
s3UserModify
Request Parameters
{ "method": "s3UserModify", "params": { "cephClusterId": xsd:string "s3UserId": xsd:string "displayName": xsd:string "emailAddress": xsd:string "bucketMaxObjectCountEnable": xsd:boolean "bucketMaxObjectCount": xsd:unsignedLong "bucketMaxSizeEnable": xsd:boolean "bucketMaxSize": xsd:unsignedLong "userMaxObjectCountEnable": xsd:boolean "userMaxObjectCount": xsd:unsignedLong "userMaxSizeEnable": xsd:boolean "userMaxSize": xsd:unsignedLong "maxBucketCount": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:s3User }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserModify?cephClusterId=val0&s3UserId=val1&displayName=val2&emailAddress=val3&bucketMaxObjectCountEnable=val4&bucketMaxObjectCount=val5&bucketMaxSizeEnable=val6&bucketMaxSize=val7&userMaxObjectCountEnable=val8&userMaxObjectCount=val9&userMaxSizeEnable=val10&userMaxSize=val11&maxBucketCount=0&flags=0"
curl -k -u admin:password -d @s3UserModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleAddRemove
Used to add/remove Storage Pools to/from a given scrub schedule
Request Parameters
{ "method": "scrubScheduleAddRemove", "params": { "schedule": xsd:string "modType": xsd:unsignedInt - {{{1}}} "storagePoolList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:scrubSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleAddRemove?schedule=val0&modType=0&storagePoolList=val2&flags=0"
curl -k -u admin:password -d @scrubScheduleAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleAssocEnum
Request Parameters
{ "method": "scrubScheduleAssocEnum", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:scrubScheduleAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleAssocEnum?schedule=val0&flags=0"
curl -k -u admin:password -d @scrubScheduleAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleAssocGet
Request Parameters
{ "method": "scrubScheduleAssocGet", "params": { "scheduleId": xsd:string "storagePoolId": xsd:string } }
Response Parameters
{ "obj": osn:scrubScheduleAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleAssocGet?scheduleId=val0&storagePoolId=val1"
curl -k -u admin:password -d @scrubScheduleAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleCreate
Creates a new Scrub Schedule to automatically scrub Storage Pools
Request Parameters
{ "method": "scrubScheduleCreate", "params": { "name": xsd:string "description": xsd:string "setEnabled": xsd:unsignedInt "initialStartDate": xsd:dateTime "minDaysBetweenScrubs": xsd:unsignedInt "daysOfWeekAllowStart": xsd:unsignedInt "hoursOfDayAllowStart": xsd:unsignedInt "hoursOfDayOffsetMinutes": xsd:unsignedInt "storagePoolList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:scrubSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleCreate?name=val0&description=val1&setEnabled=0&initialStartDate=val3&minDaysBetweenScrubs=0&daysOfWeekAllowStart=0&hoursOfDayAllowStart=0&hoursOfDayOffsetMinutes=0&storagePoolList=val8&flags=0"
curl -k -u admin:password -d @scrubScheduleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleDelete
Deletes the specified scrub schedule.
Request Parameters
{ "method": "scrubScheduleDelete", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:scrubSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleDelete?schedule=val0&flags=0"
curl -k -u admin:password -d @scrubScheduleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleDisable
Disables the specified scrub schedule. The schedule will not run again until it is re-enabled.
Request Parameters
{ "method": "scrubScheduleDisable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:scrubSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleDisable?schedule=val0&flags=0"
curl -k -u admin:password -d @scrubScheduleDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleEnable
Enables a scrub schedule that is offline.
Request Parameters
{ "method": "scrubScheduleEnable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:scrubSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleEnable?schedule=val0&flags=0"
curl -k -u admin:password -d @scrubScheduleEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleEnum
Returns a list of all the Scrub Schedules
Request Parameters
{ "method": "scrubScheduleEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:scrubSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleEnum?flags=0"
curl -k -u admin:password -d @scrubScheduleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleGet
Returns detail on a specific Scrub Schedule
Request Parameters
{ "method": "scrubScheduleGet", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:scrubSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleGet?schedule=val0&flags=0"
curl -k -u admin:password -d @scrubScheduleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleModify
Modifies the properties and replication interval schedule for a specific schedule
Request Parameters
{ "method": "scrubScheduleModify", "params": { "schedule": xsd:string - Name or ID of a scrub schedule "name": xsd:string "description": xsd:string "setEnabled": xsd:unsignedInt "initialStartDate": xsd:dateTime "minDaysBetweenScrubs": xsd:unsignedInt "daysOfWeekAllowStart": xsd:unsignedInt "hoursOfDayAllowStart": xsd:unsignedInt "hoursOfDayOffsetMinutes": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:scrubSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleModify?schedule=val0&name=val1&description=val2&setEnabled=0&initialStartDate=val4&minDaysBetweenScrubs=0&daysOfWeekAllowStart=0&hoursOfDayAllowStart=0&hoursOfDayOffsetMinutes=0&flags=0"
curl -k -u admin:password -d @scrubScheduleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
scrubScheduleTrigger
Signals the schedule manager to run the selected schedule immediately.
Request Parameters
{ "method": "scrubScheduleTrigger", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:scrubSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/scrubScheduleTrigger?schedule=val0&flags=0"
curl -k -u admin:password -d @scrubScheduleTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
serviceFirewallDefEnum
Request Parameters
{ "method": "serviceFirewallDefEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:serviceFirewallDef }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/serviceFirewallDefEnum?flags=0"
curl -k -u admin:password -d @serviceFirewallDefEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
sessionClose
Request Parameters
{ "method": "sessionClose", "params": { "storageVolume": xsd:string "sessionList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:session }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/sessionClose?storageVolume=val0&sessionList=val1&flags=0"
curl -k -u admin:password -d @sessionClose.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
sessionEnum
Request Parameters
{ "method": "sessionEnum", "params": { "host": xsd:string "storageVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:session }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/sessionEnum?host=val0&storageVolume=val1&flags=0"
curl -k -u admin:password -d @sessionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
sessionGet
Request Parameters
{ "method": "sessionGet", "params": { "sessionId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:session }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/sessionGet?sessionId=val0&flags=0"
curl -k -u admin:password -d @sessionGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
setAuthMode
Request Parameters
{ "method": "setAuthMode", "params": { "authRequestCode": xsd:string "authMode": xsd:unsignedInt "device": osn:multiFactorAuthDevice "passcode": xsd:string } }
Response Parameters
{ "requestStatus": xsd:string }
singleSignOnPolicyGet
Request Parameters
{ "method": "singleSignOnPolicyGet", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:singleSignOnPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/singleSignOnPolicyGet?flags=0"
curl -k -u admin:password -d @singleSignOnPolicyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
singleSignOnPolicySet
Sets the policy for user password complexity enforcement. Use #singleSignPolicyGet to get current settings then call Set to modify with adjusted values.
Request Parameters
{ "method": "singleSignOnPolicySet", "params": { "isEnabled": xsd:boolean "ldapServer": xsd:string - Ldap server FQDN "ldapBaseDn": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:singleSignOnPolicy }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/singleSignOnPolicySet?isEnabled=val0&ldapServer=val1&ldapBaseDn=val2&flags=0"
curl -k -u admin:password -d @singleSignOnPolicySet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteClusterAssocEnum
Request Parameters
{ "method": "siteClusterAssocEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:siteClusterAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterAssocEnum?flags=0"
curl -k -u admin:password -d @siteClusterAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteClusterAssocGet
Request Parameters
{ "method": "siteClusterAssocGet", "params": { "siteAssocId": xsd:string "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:siteClusterAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterAssocGet?siteAssocId=val0&storageSystemId=val1&flags=0"
curl -k -u admin:password -d @siteClusterAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteClusterCreate
Request Parameters
{ "method": "siteClusterCreate", "params": { "name": xsd:string "description": xsd:string "location": xsd:string "storageSystemList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:siteCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterCreate?name=val0&description=val1&location=val2&storageSystemList=val3&flags=0"
curl -k -u admin:password -d @siteClusterCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteClusterDelete
Request Parameters
{ "method": "siteClusterDelete", "params": { "site": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:siteCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterDelete?site=val0&flags=0"
curl -k -u admin:password -d @siteClusterDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteClusterEnum
Request Parameters
{ "method": "siteClusterEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:siteCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterEnum?flags=0"
curl -k -u admin:password -d @siteClusterEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteClusterGet
Request Parameters
{ "method": "siteClusterGet", "params": { "site": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:siteCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterGet?site=val0&flags=0"
curl -k -u admin:password -d @siteClusterGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteClusterModify
Request Parameters
{ "method": "siteClusterModify", "params": { "siteClusterId": xsd:string "name": xsd:string "description": xsd:string "location": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:siteCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterModify?siteClusterId=val0&name=val1&description=val2&location=val3&flags=0"
curl -k -u admin:password -d @siteClusterModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteClusterRestartServices
Request Parameters
{ "method": "siteClusterRestartServices", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterRestartServices?storageSystem=val0&flags=0"
curl -k -u admin:password -d @siteClusterRestartServices.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteStorageSystemAddRemove
Request Parameters
{ "method": "siteStorageSystemAddRemove", "params": { "site": xsd:string "modType": xsd:unsignedInt "storageSystemList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:siteCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteStorageSystemAddRemove?site=val0&modType=0&storageSystemList=val2&flags=0"
curl -k -u admin:password -d @siteStorageSystemAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteVifResourceCreate
Request Parameters
{ "method": "siteVifResourceCreate", "params": { "siteClusterId": xsd:string "parentInterfaceName": xsd:string "ipAddress": xsd:string "subnetMask": xsd:string "mtu": xsd:unsignedInt "isGridVif": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:siteVifResource }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceCreate?siteClusterId=val0&parentInterfaceName=val1&ipAddress=val2&subnetMask=val3&mtu=0&isGridVif=val5&flags=0"
curl -k -u admin:password -d @siteVifResourceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteVifResourceDelete
Request Parameters
{ "method": "siteVifResourceDelete", "params": { "siteVifResource": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:siteVifResource }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceDelete?siteVifResource=val0&flags=0"
curl -k -u admin:password -d @siteVifResourceDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteVifResourceEnum
Request Parameters
{ "method": "siteVifResourceEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:siteVifResource }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceEnum?flags=0"
curl -k -u admin:password -d @siteVifResourceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteVifResourceGet
Request Parameters
{ "method": "siteVifResourceGet", "params": { "siteVifResource": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:siteVifResource }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceGet?siteVifResource=val0&flags=0"
curl -k -u admin:password -d @siteVifResourceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
siteVifResourceMove
Request Parameters
{ "method": "siteVifResourceMove", "params": { "siteVifResource": xsd:string "moveToSystem": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:siteVifResource }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceMove?siteVifResource=val0&moveToSystem=val1&flags=0"
curl -k -u admin:password -d @siteVifResourceMove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleAssocEnum
Request Parameters
{ "method": "snapshotScheduleAssocEnum", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:snapshotScheduleAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleAssocEnum?schedule=val0&flags=0"
curl -k -u admin:password -d @snapshotScheduleAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleAssocGet
Request Parameters
{ "method": "snapshotScheduleAssocGet", "params": { "scheduleId": xsd:string "storageVolumeId": xsd:string } }
Response Parameters
{ "obj": osn:snapshotScheduleAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleAssocGet?scheduleId=val0&storageVolumeId=val1"
curl -k -u admin:password -d @snapshotScheduleAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleCreate
Creates a new Snapshot Schedule to automatically create snapshots of the specified Storage Volumes and/or Network Shares
Request Parameters
{ "method": "snapshotScheduleCreate", "params": { "name": xsd:string "description": xsd:string "storageCloudId": xsd:string "setEnabled": xsd:unsignedInt "startDate": xsd:dateTime "maxSnapshots": xsd:unsignedInt "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "storageVolumeList": xsd:string "networkShareList": xsd:string "scheduleType": xsd:unsignedInt "delayInterval": xsd:unsignedInt "offsetMinutes": xsd:unsignedInt "retentionCountHourlies": xsd:unsignedInt "retentionCountDailies": xsd:unsignedInt "retentionCountWeeklies": xsd:unsignedInt "retentionCountMonthlies": xsd:unsignedInt "retentionCountQuarterlies": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:snapshotSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleCreate?name=val0&description=val1&storageCloudId=val2&setEnabled=0&startDate=val4&maxSnapshots=0&daysOfWeek=0&hoursOfDay=0&storageVolumeList=val8&networkShareList=val9&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&flags=0"
curl -k -u admin:password -d @snapshotScheduleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleDelete
Deletes the specified snapshot schedule.
Request Parameters
{ "method": "snapshotScheduleDelete", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:snapshotSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleDelete?schedule=val0&flags=0"
curl -k -u admin:password -d @snapshotScheduleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleDisable
Disables the specified snapshot schedule. The schedule will not run again until it is re-enabled.
Request Parameters
{ "method": "snapshotScheduleDisable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:snapshotSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleDisable?schedule=val0&flags=0"
curl -k -u admin:password -d @snapshotScheduleDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleEnable
Enables a snapshot schedule that is offline.
Request Parameters
{ "method": "snapshotScheduleEnable", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:snapshotSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleEnable?schedule=val0&flags=0"
curl -k -u admin:password -d @snapshotScheduleEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleEnum
Returns a list of all the Snapshot Schedules
Request Parameters
{ "method": "snapshotScheduleEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:snapshotSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleEnum?flags=0"
curl -k -u admin:password -d @snapshotScheduleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleGet
Returns detail on a specific Snapshot Schedule
Request Parameters
{ "method": "snapshotScheduleGet", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:snapshotSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleGet?schedule=val0&flags=0"
curl -k -u admin:password -d @snapshotScheduleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleModify
Modifies the properties and replication interval schedule for a specific schedule
Request Parameters
{ "method": "snapshotScheduleModify", "params": { "schedule": xsd:string - Name or ID of a snapshot schedule "name": xsd:string - New name for the snapshot schedule "description": xsd:string - Description of the snapshot schedule "storageCloudId": xsd:string - Resource Group to assocate the snapshot schedule with "setEnabled": xsd:unsignedInt - enables/disables the schedule "startDate": xsd:dateTime - start date after which the schedule is active "maxSnapshots": xsd:unsignedInt - Number of snapshots used in a rotation. Note this exludes the snapshots marked for long term rention "daysOfWeek": xsd:unsignedInt - Calendar based, days of the week to do snapshots "hoursOfDay": xsd:unsignedInt - Calendar based, hours of the day to take snapshots "scheduleType": xsd:unsignedInt - Calendar based or Interval Based "delayInterval": xsd:unsignedInt - Delay interval in seconds between snapshots "offsetMinutes": xsd:unsignedInt - Calendar based, offset in minutes for the scheduled hour(S) to take snapshots "retentionCountHourlies": xsd:unsignedInt - Long term snapshot retention rule for how many hourly snapshots to be retained. "retentionCountDailies": xsd:unsignedInt - Long term snapshot retention rule for daily snapshots "retentionCountWeeklies": xsd:unsignedInt - Long term snapshot retention rule for weekly snapshot count to be retained. "retentionCountMonthlies": xsd:unsignedInt - Long term snapshot retention rule for monthly snapshot count to be retained. "retentionCountQuarterlies": xsd:unsignedInt - Long term snapshot retention rule for quarterly snapshots to be retained. "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:snapshotSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleModify?schedule=val0&name=val1&description=val2&storageCloudId=val3&setEnabled=0&startDate=val5&maxSnapshots=0&daysOfWeek=0&hoursOfDay=0&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&flags=0"
curl -k -u admin:password -d @snapshotScheduleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleTrigger
Signals the schedule manager to run the selected schedule immediately.
Request Parameters
{ "method": "snapshotScheduleTrigger", "params": { "schedule": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:snapshotSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleTrigger?schedule=val0&flags=0"
curl -k -u admin:password -d @snapshotScheduleTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
snapshotScheduleVolumeAddRemove
Used to add/remove Storage Volumes and Network Shares to/from a given Snapshot Schedule
Request Parameters
{ "method": "snapshotScheduleVolumeAddRemove", "params": { "schedule": xsd:string "modType": xsd:unsignedInt - {{{1}}} "storageVolumeList": xsd:string "networkShareList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:snapshotSchedule }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleVolumeAddRemove?schedule=val0&modType=0&storageVolumeList=val2&networkShareList=val3&flags=0"
curl -k -u admin:password -d @snapshotScheduleVolumeAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudCreate
Request Parameters
{ "method": "storageCloudCreate", "params": { "name": xsd:string "description": xsd:string "userList": osn:storageCloudSubjectAssoc "resourceList": osn:storageCloudResourceAssoc "parentStorageCloudId": xsd:string "tier": xsd:string "organization": xsd:string "defaultChapUsername": xsd:string "defaultChapPassword": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageCloud }
storageCloudDelete
Request Parameters
{ "method": "storageCloudDelete", "params": { "storageCloud": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageCloud }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageCloudDelete?storageCloud=val0&flags=0"
curl -k -u admin:password -d @storageCloudDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudEnum
Request Parameters
{ "method": "storageCloudEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storageCloud }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageCloudEnum?flags=0"
curl -k -u admin:password -d @storageCloudEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudGet
Request Parameters
{ "method": "storageCloudGet", "params": { "storageCloud": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageCloud }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageCloudGet?storageCloud=val0&flags=0"
curl -k -u admin:password -d @storageCloudGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudModify
Request Parameters
{ "method": "storageCloudModify", "params": { "storageCloud": xsd:string "name": xsd:string "description": xsd:string "parentStorageCloudId": xsd:string "tier": xsd:string "organization": xsd:string "defaultChapUsername": xsd:string "defaultChapPassword": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageCloud }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageCloudModify?storageCloud=val0&name=val1&description=val2&parentStorageCloudId=val3&tier=val4&organization=val5&defaultChapUsername=val6&defaultChapPassword=val7&flags=0"
curl -k -u admin:password -d @storageCloudModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudResourceAddRemove
Request Parameters
{ "method": "storageCloudResourceAddRemove", "params": { "storageCloud": xsd:string "modType": xsd:unsignedInt "resourceList": osn:storageCloudResourceAssoc "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageCloud }
storageCloudResourceAssocEnum
Request Parameters
{ "method": "storageCloudResourceAssocEnum", "params": { "resource": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storageCloudResourceAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageCloudResourceAssocEnum?resource=val0&flags=0"
curl -k -u admin:password -d @storageCloudResourceAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudResourceAssocGet
Request Parameters
{ "method": "storageCloudResourceAssocGet", "params": { "storageCloud": xsd:string "resource": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageCloudResourceAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageCloudResourceAssocGet?storageCloud=val0&resource=val1&flags=0"
curl -k -u admin:password -d @storageCloudResourceAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudResourceSetMode
Request Parameters
{ "method": "storageCloudResourceSetMode", "params": { "storageCloud": xsd:string "resource": xsd:string "accessMode": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageCloud }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageCloudResourceSetMode?storageCloud=val0&resource=val1&accessMode=0&flags=0"
curl -k -u admin:password -d @storageCloudResourceSetMode.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudSubjectAssocEnum
Request Parameters
{ "method": "storageCloudSubjectAssocEnum", "params": { "subject": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storageCloudSubjectAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageCloudSubjectAssocEnum?subject=val0&flags=0"
curl -k -u admin:password -d @storageCloudSubjectAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudSubjectAssocGet
Request Parameters
{ "method": "storageCloudSubjectAssocGet", "params": { "storageCloud": xsd:string "subject": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageCloudSubjectAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageCloudSubjectAssocGet?storageCloud=val0&subject=val1&flags=0"
curl -k -u admin:password -d @storageCloudSubjectAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageCloudUserAddRemove
Request Parameters
{ "method": "storageCloudUserAddRemove", "params": { "storageCloud": xsd:string "modType": xsd:unsignedInt "userList": osn:storageCloudSubjectAssoc "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageCloud }
storagePoolCacheAddRemove
Adds SSDs to the specified Storage Pool to boost read and write performance.
Request Parameters
{ "method": "storagePoolCacheAddRemove", "params": { "storagePool": xsd:string "modType": xsd:unsignedInt - {{{1}}} "readCacheDeviceList": xsd:string "writeLogDeviceList": xsd:string "specialOffloadDeviceList": xsd:string "dedupOffloadDeviceList": xsd:string "flags": xsd:unsignedInt - see API #physicalDiskEnum for information on supported disk selection filters } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolCacheAddRemove?storagePool=val0&modType=0&readCacheDeviceList=val2&writeLogDeviceList=val3&specialOffloadDeviceList=val4&dedupOffloadDeviceList=val5&flags=0"
curl -k -u admin:password -d @storagePoolCacheAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolCreate
Creates a new Storage Pool using the specified disk/device list. System will automatically configure the pool for enclosure redundancy where possible.
Request Parameters
{ "method": "storagePoolCreate", "params": { "name": xsd:string - see API #physicalDiskEnum for information on supported disk selection filters "physicalDiskList": xsd:string "description": xsd:string "raidType": xsd:unsignedInt "poolType": xsd:unsignedInt "isDefault": xsd:boolean "enableSsd": xsd:boolean "enableCompression": xsd:boolean "enableAutoTrim": xsd:boolean "noBarriers": xsd:boolean "profile": xsd:string "raidSetSize": xsd:unsignedInt "enableEncryption": xsd:boolean "encryptionType": xsd:string "encryptionKeyPassphrase": xsd:string "keyvaultType": xsd:unsignedInt "keyVaultProfileId": xsd:string "encryptionRootKeyId": xsd:string "ashift": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolCreate?name=val0&physicalDiskList=val1&description=val2&raidType=0&poolType=0&isDefault=val5&enableSsd=val6&enableCompression=val7&enableAutoTrim=val8&noBarriers=val9&profile=val10&raidSetSize=0&enableEncryption=val12&encryptionType=val13&encryptionKeyPassphrase=val14&keyvaultType=0&keyVaultProfileId=val16&encryptionRootKeyId=val17&ashift=0&flags=0"
curl -k -u admin:password -d @storagePoolCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolDestroy
Request Parameters
{ "method": "storagePoolDestroy", "params": { "storagePool": xsd:string "deleteKeys": xsd:boolean "dataShredMode": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDestroy?storagePool=val0&deleteKeys=val1&dataShredMode=0&flags=0"
curl -k -u admin:password -d @storagePoolDestroy.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolDeviceEnum
Request Parameters
{ "method": "storagePoolDeviceEnum", "params": { "storagePoolId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storagePoolDevice }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceEnum?storagePoolId=val0&flags=0"
curl -k -u admin:password -d @storagePoolDeviceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolDeviceGet
Request Parameters
{ "method": "storagePoolDeviceGet", "params": { "storagePoolDevice": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storagePoolDevice }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceGet?storagePoolDevice=val0&flags=0"
curl -k -u admin:password -d @storagePoolDeviceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolDeviceGroupEnum
Request Parameters
{ "method": "storagePoolDeviceGroupEnum", "params": { "storagePoolId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storagePoolDeviceGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceGroupEnum?storagePoolId=val0&flags=0"
curl -k -u admin:password -d @storagePoolDeviceGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolDeviceGroupGet
Request Parameters
{ "method": "storagePoolDeviceGroupGet", "params": { "storagePoolDeviceGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storagePoolDeviceGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceGroupGet?storagePoolDeviceGroup=val0&flags=0"
curl -k -u admin:password -d @storagePoolDeviceGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolDeviceGroupIdentify
Request Parameters
{ "method": "storagePoolDeviceGroupIdentify", "params": { "storagePoolDeviceGroup": xsd:string "durationInSeconds": xsd:unsignedInt "blinkType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolDeviceGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceGroupIdentify?storagePoolDeviceGroup=val0&durationInSeconds=0&blinkType=0&flags=0"
curl -k -u admin:password -d @storagePoolDeviceGroupIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolEnum
Request Parameters
{ "method": "storagePoolEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolEnum?flags=0"
curl -k -u admin:password -d @storagePoolEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolExpand
Expands the specified storage pool using available unused space on the disk devices.
Request Parameters
{ "method": "storagePoolExpand", "params": { "storagePool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolExpand?storagePool=val0&flags=0"
curl -k -u admin:password -d @storagePoolExpand.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolExport
Request Parameters
{ "method": "storagePoolExport", "params": { "storagePool": xsd:string "releaseIoFence": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolExport?storagePool=val0&releaseIoFence=val1&flags=0"
curl -k -u admin:password -d @storagePoolExport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolGet
Request Parameters
{ "method": "storagePoolGet", "params": { "storagePool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolGet?storagePool=val0&flags=0"
curl -k -u admin:password -d @storagePoolGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolGrow
Grows the specified pool by adding the specified devices to create and add a new Storage Pool Device Gruops (vdevs) to the storage pool.
Request Parameters
{ "method": "storagePoolGrow", "params": { "storagePool": xsd:string - see API #physicalDiskEnum for information on supported disk selection filters "physicalDiskList": xsd:string "raidType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolGrow?storagePool=val0&physicalDiskList=val1&raidType=0&flags=0"
curl -k -u admin:password -d @storagePoolGrow.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverGroupActivate
Request Parameters
{ "method": "storagePoolHaFailoverGroupActivate", "params": { "failoverGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupActivate?failoverGroup=val0&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverGroupActivate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverGroupCreate
Request Parameters
{ "method": "storagePoolHaFailoverGroupCreate", "params": { "storagePoolId": xsd:string "name": xsd:string "description": xsd:string "primaryStorageSystemId": xsd:string "secondaryStorageSystemId": xsd:string "tertiaryStorageSystemId": xsd:string "settleTimeInSec": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupCreate?storagePoolId=val0&name=val1&description=val2&primaryStorageSystemId=val3&secondaryStorageSystemId=val4&tertiaryStorageSystemId=val5&settleTimeInSec=0&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverGroupDeactivate
Request Parameters
{ "method": "storagePoolHaFailoverGroupDeactivate", "params": { "failoverGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupDeactivate?failoverGroup=val0&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverGroupDeactivate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverGroupDelete
Request Parameters
{ "method": "storagePoolHaFailoverGroupDelete", "params": { "failoverGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupDelete?failoverGroup=val0&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverGroupEnum
Request Parameters
{ "method": "storagePoolHaFailoverGroupEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storagePoolHaFailoverGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupEnum?flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverGroupFailover
Request Parameters
{ "method": "storagePoolHaFailoverGroupFailover", "params": { "failoverGroup": xsd:string "targetStorageSystem": xsd:string "failoverReason": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupFailover?failoverGroup=val0&targetStorageSystem=val1&failoverReason=0&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverGroupFailover.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverGroupGet
Request Parameters
{ "method": "storagePoolHaFailoverGroupGet", "params": { "failoverGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupGet?failoverGroup=val0&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverGroupModify
Request Parameters
{ "method": "storagePoolHaFailoverGroupModify", "params": { "failoverGroup": xsd:string "name": xsd:string "description": xsd:string "primaryStorageSystemId": xsd:string "secondaryStorageSystemId": xsd:string "tertiaryStorageSystemId": xsd:string "settleTimeInSec": xsd:unsignedInt "verifyClientIps": xsd:string "haClientFailoverPolicy": xsd:unsignedInt "haLinkStateFailoverPolicy": xsd:unsignedInt "haFcLinkStateFailoverPolicy": xsd:unsignedInt "exportTimeout": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupModify?failoverGroup=val0&name=val1&description=val2&primaryStorageSystemId=val3&secondaryStorageSystemId=val4&tertiaryStorageSystemId=val5&settleTimeInSec=0&verifyClientIps=val7&haClientFailoverPolicy=0&haLinkStateFailoverPolicy=0&haFcLinkStateFailoverPolicy=0&exportTimeout=0&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverInterfaceCreate
Request Parameters
{ "method": "storagePoolHaFailoverInterfaceCreate", "params": { "failoverGroup": xsd:string "tag": xsd:string "parentInterfaceName": xsd:string "description": xsd:string "ipAddress": xsd:string "gateway": xsd:string "subnetMask": xsd:string "macAddress": xsd:string "iscsiEnabled": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverInterface }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverInterfaceCreate?failoverGroup=val0&tag=val1&parentInterfaceName=val2&description=val3&ipAddress=val4&gateway=val5&subnetMask=val6&macAddress=val7&iscsiEnabled=val8&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverInterfaceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverInterfaceDelete
Request Parameters
{ "method": "storagePoolHaFailoverInterfaceDelete", "params": { "failoverGroup": xsd:string "failoverInterface": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverInterface }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverInterfaceDelete?failoverGroup=val0&failoverInterface=val1&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverInterfaceDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverInterfaceEnum
Request Parameters
{ "method": "storagePoolHaFailoverInterfaceEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storagePoolHaFailoverInterface }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverInterfaceEnum?flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverInterfaceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHaFailoverInterfaceGet
Request Parameters
{ "method": "storagePoolHaFailoverInterfaceGet", "params": { "failoverGroup": xsd:string "failoverInterface": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePoolHaFailoverInterface }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverInterfaceGet?failoverGroup=val0&failoverInterface=val1&flags=0"
curl -k -u admin:password -d @storagePoolHaFailoverInterfaceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolHealthCheck
Returns a health check report for the specified Storage Pool
Request Parameters
{ "method": "storagePoolHealthCheck", "params": { "storagePool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:resourceHealthCheck }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHealthCheck?storagePool=val0&flags=0"
curl -k -u admin:password -d @storagePoolHealthCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolIdentify
Request Parameters
{ "method": "storagePoolIdentify", "params": { "storagePool": xsd:string "durationInSeconds": xsd:unsignedInt "blinkType": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolIdentify?storagePool=val0&durationInSeconds=0&blinkType=0&flags=0"
curl -k -u admin:password -d @storagePoolIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolImport
Request Parameters
{ "method": "storagePoolImport", "params": { "storageSystem": xsd:string "storagePoolList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolImport?storageSystem=val0&storagePoolList=val1&flags=0"
curl -k -u admin:password -d @storagePoolImport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolImportEncrypted
Request Parameters
{ "method": "storagePoolImportEncrypted", "params": { "storageSystem": xsd:string "storagePoolList": xsd:string "encryptionKeyPassphrase": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolImportEncrypted?storageSystem=val0&storagePoolList=val1&encryptionKeyPassphrase=val2&flags=0"
curl -k -u admin:password -d @storagePoolImportEncrypted.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolModify
Request Parameters
{ "method": "storagePoolModify", "params": { "storagePool": xsd:string "newName": xsd:string "newDescription": xsd:string "isDefault": xsd:boolean "enableSsd": xsd:boolean "enableCompression": xsd:boolean "enableAutoTrim": xsd:boolean "noBarriers": xsd:boolean "profile": xsd:string "syncPolicy": xsd:unsignedInt "compressionType": xsd:string "hotspareRepairPolicy": xsd:unsignedInt "copies": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolModify?storagePool=val0&newName=val1&newDescription=val2&isDefault=val3&enableSsd=val4&enableCompression=val5&enableAutoTrim=val6&noBarriers=val7&profile=val8&syncPolicy=0&compressionType=val10&hotspareRepairPolicy=0&copies=0&flags=0"
curl -k -u admin:password -d @storagePoolModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolPreimportScan
Request Parameters
{ "method": "storagePoolPreimportScan", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolPreimportScan?storageSystem=val0&flags=0"
curl -k -u admin:password -d @storagePoolPreimportScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolProfileEnum
Request Parameters
{ "method": "storagePoolProfileEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storagePoolProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolProfileEnum?flags=0"
curl -k -u admin:password -d @storagePoolProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolProfileGet
Request Parameters
{ "method": "storagePoolProfileGet", "params": { "storagePoolProfile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storagePoolProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolProfileGet?storagePoolProfile=val0&flags=0"
curl -k -u admin:password -d @storagePoolProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolPropertiesUpdate
Request Parameters
{ "method": "storagePoolPropertiesUpdate", "params": { "storagePoolId": xsd:string "bRequiresReboot": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolPropertiesUpdate?storagePoolId=val0&bRequiresReboot=val1&flags=0"
curl -k -u admin:password -d @storagePoolPropertiesUpdate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolRescan
Request Parameters
{ "method": "storagePoolRescan", "params": { "storageSystem": xsd:string "options": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolRescan?storageSystem=val0&options=val1&flags=0"
curl -k -u admin:password -d @storagePoolRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolScrubStart
Request Parameters
{ "method": "storagePoolScrubStart", "params": { "storagePool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolScrubStart?storagePool=val0&flags=0"
curl -k -u admin:password -d @storagePoolScrubStart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolScrubStop
Request Parameters
{ "method": "storagePoolScrubStop", "params": { "storagePool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolScrubStop?storagePool=val0&flags=0"
curl -k -u admin:password -d @storagePoolScrubStop.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolSetPassphrase
Request Parameters
{ "method": "storagePoolSetPassphrase", "params": { "storagePool": xsd:string "oldEncryptionKeyPassphrase": xsd:string "newEncryptionKeyPassphrase": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolSetPassphrase?storagePool=val0&oldEncryptionKeyPassphrase=val1&newEncryptionKeyPassphrase=val2&flags=0"
curl -k -u admin:password -d @storagePoolSetPassphrase.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolSpareAddRemove
Adds a dedicated hot-spare to the specified Storage Pool. In general it is better to mark spares are global hot-spares so that any pool in the cluster may use the spare.
Request Parameters
{ "method": "storagePoolSpareAddRemove", "params": { "storagePool": xsd:string "modType": xsd:unsignedInt - {{{1}}} "physicalDiskList": xsd:string "flags": xsd:unsignedInt - see API #physicalDiskEnum for information on supported disk selection filters } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolSpareAddRemove?storagePool=val0&modType=0&physicalDiskList=val2&flags=0"
curl -k -u admin:password -d @storagePoolSpareAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolStart
Request Parameters
{ "method": "storagePoolStart", "params": { "storagePool": xsd:string "encryptionKeyPassphrase": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolStart?storagePool=val0&encryptionKeyPassphrase=val1&flags=0"
curl -k -u admin:password -d @storagePoolStart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolStop
Request Parameters
{ "method": "storagePoolStop", "params": { "storagePool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolStop?storagePool=val0&flags=0"
curl -k -u admin:password -d @storagePoolStop.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolTrim
Request Parameters
{ "method": "storagePoolTrim", "params": { "storagePool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolTrim?storagePool=val0&flags=0"
curl -k -u admin:password -d @storagePoolTrim.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storagePoolUpdateRedirect
Request Parameters
{ "method": "storagePoolUpdateRedirect", "params": { "storagePool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolUpdateRedirect?storagePool=val0&flags=0"
curl -k -u admin:password -d @storagePoolUpdateRedirect.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageQuotaCreate
Storage Quotas are provisioning quotas associated with a Resource Group (see #osn:storageCloud) for multi-tenant configurations. For quotas on #osn:networkShares please see the #networkShareModify API.
Request Parameters
{ "method": "storageQuotaCreate", "params": { "name": xsd:string "description": xsd:string "storagePoolId": xsd:string "storageCloudId": xsd:string "provisionableSize": xsd:unsignedLong "utilizableSpace": xsd:unsignedLong "maxVolumes": xsd:unsignedInt "maxShares": xsd:unsignedInt "policyFlags": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageQuota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaCreate?name=val0&description=val1&storagePoolId=val2&storageCloudId=val3&provisionableSize=val4&utilizableSpace=val5&maxVolumes=0&maxShares=0&policyFlags=0&flags=0"
curl -k -u admin:password -d @storageQuotaCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageQuotaDelete
Deletes teh specified provisioning quota
Request Parameters
{ "method": "storageQuotaDelete", "params": { "storageQuota": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageQuota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaDelete?storageQuota=val0&flags=0"
curl -k -u admin:password -d @storageQuotaDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageQuotaEnum
Request Parameters
{ "method": "storageQuotaEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storageQuota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaEnum?flags=0"
curl -k -u admin:password -d @storageQuotaEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageQuotaGet
Request Parameters
{ "method": "storageQuotaGet", "params": { "storageQuota": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageQuota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaGet?storageQuota=val0&flags=0"
curl -k -u admin:password -d @storageQuotaGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageQuotaModify
Modifies the specified provisioning quota to limit how much capacity may be provisioned from the pool associated with the quota
Request Parameters
{ "method": "storageQuotaModify", "params": { "storageQuota": xsd:string "name": xsd:string "description": xsd:string "storageCloudId": xsd:string "provisionableSize": xsd:unsignedLong "utilizableSpace": xsd:unsignedLong "maxVolumes": xsd:unsignedInt "maxShares": xsd:unsignedInt "policyFlags": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageQuota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaModify?storageQuota=val0&name=val1&description=val2&storageCloudId=val3&provisionableSize=val4&utilizableSpace=val5&maxVolumes=0&maxShares=0&policyFlags=0&flags=0"
curl -k -u admin:password -d @storageQuotaModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Add/remove shares from the quota so that they're counted against the provisionable capacity
Request Parameters
{ "method": "storageQuotaShareAddRemove", "params": { "storageQuota": xsd:string "modType": xsd:unsignedInt - {{{1}}} "storageShareList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageQuota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaShareAddRemove?storageQuota=val0&modType=0&storageShareList=val2&flags=0"
curl -k -u admin:password -d @storageQuotaShareAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "storageQuotaShareAssocEnum", "params": { "networkShare": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageQuotaShareAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaShareAssocEnum?networkShare=val0&flags=0"
curl -k -u admin:password -d @storageQuotaShareAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Request Parameters
{ "method": "storageQuotaShareAssocGet", "params": { "storageQuotaId": xsd:string "shareId": xsd:string } }
Response Parameters
{ "obj": osn:storageQuotaShareAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaShareAssocGet?storageQuotaId=val0&shareId=val1"
curl -k -u admin:password -d @storageQuotaShareAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageQuotaVolumeAddRemove
Add/remove volumes from the quota so that they're counted against the provisionable capacity
Request Parameters
{ "method": "storageQuotaVolumeAddRemove", "params": { "storageQuota": xsd:string "modType": xsd:unsignedInt - {{{1}}} "storageVolumeList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageQuota }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaVolumeAddRemove?storageQuota=val0&modType=0&storageVolumeList=val2&flags=0"
curl -k -u admin:password -d @storageQuotaVolumeAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageQuotaVolumeAssocEnum
Request Parameters
{ "method": "storageQuotaVolumeAssocEnum", "params": { "storageVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageQuotaVolumeAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaVolumeAssocEnum?storageVolume=val0&flags=0"
curl -k -u admin:password -d @storageQuotaVolumeAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageQuotaVolumeAssocGet
Request Parameters
{ "method": "storageQuotaVolumeAssocGet", "params": { "storageQuotaId": xsd:string "storageVolumeId": xsd:string } }
Response Parameters
{ "obj": osn:storageQuotaVolumeAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaVolumeAssocGet?storageQuotaId=val0&storageVolumeId=val1"
curl -k -u admin:password -d @storageQuotaVolumeAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterAssocEnum
Request Parameters
{ "method": "storageSystemClusterAssocEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageSystemClusterAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterAssocEnum?flags=0"
curl -k -u admin:password -d @storageSystemClusterAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterAssocGet
Request Parameters
{ "method": "storageSystemClusterAssocGet", "params": { "storageSystemClusterId": xsd:string "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageSystemClusterAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterAssocGet?storageSystemClusterId=val0&storageSystemId=val1&flags=0"
curl -k -u admin:password -d @storageSystemClusterAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterCreate
Request Parameters
{ "method": "storageSystemClusterCreate", "params": { "name": xsd:string "description": xsd:string "storageSystemIds": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterCreate?name=val0&description=val1&storageSystemIds=val2&flags=0"
curl -k -u admin:password -d @storageSystemClusterCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterDelete
Request Parameters
{ "method": "storageSystemClusterDelete", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterDelete?flags=0"
curl -k -u admin:password -d @storageSystemClusterDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterEnum
Request Parameters
{ "method": "storageSystemClusterEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterEnum?flags=0"
curl -k -u admin:password -d @storageSystemClusterEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterGet
Request Parameters
{ "method": "storageSystemClusterGet", "params": { "storageSystemCluster": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterGet?storageSystemCluster=val0&flags=0"
curl -k -u admin:password -d @storageSystemClusterGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterGetHostsConfig
Request Parameters
{ "method": "storageSystemClusterGetHostsConfig", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterGetHostsConfig?storageSystem=val0&flags=0"
curl -k -u admin:password -d @storageSystemClusterGetHostsConfig.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterMerge
Request Parameters
{ "method": "storageSystemClusterMerge", "params": { "masterNodeIpAddress": xsd:string "nodeAdminUsername": xsd:string "nodeAdminPassword": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterMerge?masterNodeIpAddress=val0&nodeAdminUsername=val1&nodeAdminPassword=val2&flags=0"
curl -k -u admin:password -d @storageSystemClusterMerge.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterModify
Request Parameters
{ "method": "storageSystemClusterModify", "params": { "name": xsd:string "description": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterModify?name=val0&description=val1&flags=0"
curl -k -u admin:password -d @storageSystemClusterModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterNodeAdd
Request Parameters
{ "method": "storageSystemClusterNodeAdd", "params": { "nodeIpAddress": xsd:string "nodeAdminUsername": xsd:string "nodeAdminPassword": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterNodeAdd?nodeIpAddress=val0&nodeAdminUsername=val1&nodeAdminPassword=val2&flags=0"
curl -k -u admin:password -d @storageSystemClusterNodeAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterNodeEject
Request Parameters
{ "method": "storageSystemClusterNodeEject", "params": { "storageSystemClusterObj": osn:storageSystemCluster "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
storageSystemClusterNodeJoin
Request Parameters
{ "method": "storageSystemClusterNodeJoin", "params": { "storageSystemClusterObj": osn:storageSystemCluster "masterNode": osn:storageSystem "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
storageSystemClusterNodeRemove
Request Parameters
{ "method": "storageSystemClusterNodeRemove", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterNodeRemove?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @storageSystemClusterNodeRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterNodeSetMaster
Request Parameters
{ "method": "storageSystemClusterNodeSetMaster", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterNodeSetMaster?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @storageSystemClusterNodeSetMaster.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterNodeSync
Request Parameters
{ "method": "storageSystemClusterNodeSync", "params": { "storageSystemClusterObj": osn:storageSystemCluster "masterNode": osn:storageSystem "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
storageSystemClusterSendSupportLogs
Request Parameters
{ "method": "storageSystemClusterSendSupportLogs", "params": { "memberIds": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterSendSupportLogs?memberIds=val0&flags=0"
curl -k -u admin:password -d @storageSystemClusterSendSupportLogs.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterSetHostsConfig
Request Parameters
{ "method": "storageSystemClusterSetHostsConfig", "params": { "storageSystem": xsd:string "targetPortIdList": xsd:string "options": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterSetHostsConfig?storageSystem=val0&targetPortIdList=val1&options=0&flags=0"
curl -k -u admin:password -d @storageSystemClusterSetHostsConfig.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemClusterSplit
Request Parameters
{ "method": "storageSystemClusterSplit", "params": { "newGridName": xsd:string "storageSystemIds": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemCluster }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterSplit?newGridName=val0&storageSystemIds=val1&flags=0"
curl -k -u admin:password -d @storageSystemClusterSplit.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemEnum
Returns a list of all the storage systems in the grid.
Request Parameters
{ "method": "storageSystemEnum", "params": { "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "list": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemEnum?flags=0"
curl -k -u admin:password -d @storageSystemEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemGet
Returns details of a specific #osn:storageSystem
Request Parameters
{ "method": "storageSystemGet", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "obj": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemGet?storageSystem=val0&flags=0"
curl -k -u admin:password -d @storageSystemGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemLinkCreate
Request Parameters
{ "method": "storageSystemLinkCreate", "params": { "storageSystemId": xsd:string "remoteSystemId": xsd:string "localIpAddress": xsd:string "remoteIpAddress": xsd:string "bandwidthLimit": xsd:unsignedInt "linkType": xsd:unsignedInt "description": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemLink }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkCreate?storageSystemId=val0&remoteSystemId=val1&localIpAddress=val2&remoteIpAddress=val3&bandwidthLimit=0&linkType=0&description=val6&flags=0"
curl -k -u admin:password -d @storageSystemLinkCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemLinkDelete
Request Parameters
{ "method": "storageSystemLinkDelete", "params": { "linkId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemLink }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkDelete?linkId=val0&flags=0"
curl -k -u admin:password -d @storageSystemLinkDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemLinkDisconnect
Request Parameters
{ "method": "storageSystemLinkDisconnect", "params": { "remoteStorageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemLink }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkDisconnect?remoteStorageSystemId=val0&flags=0"
curl -k -u admin:password -d @storageSystemLinkDisconnect.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemLinkEnum
Request Parameters
{ "method": "storageSystemLinkEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageSystemLink }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkEnum?flags=0"
curl -k -u admin:password -d @storageSystemLinkEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemLinkEstablish
Request Parameters
{ "method": "storageSystemLinkEstablish", "params": { "linkObj": osn:storageSystemLink "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemLink }
storageSystemLinkGet
Request Parameters
{ "method": "storageSystemLinkGet", "params": { "linkId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageSystemLink }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkGet?linkId=val0&flags=0"
curl -k -u admin:password -d @storageSystemLinkGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemLinkModify
Request Parameters
{ "method": "storageSystemLinkModify", "params": { "linkId": xsd:string "remoteIpAddress": xsd:string "localIpAddress": xsd:string "bandwidthLimit": xsd:unsignedInt "linkType": xsd:unsignedInt "description": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemLink }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkModify?linkId=val0&remoteIpAddress=val1&localIpAddress=val2&bandwidthLimit=0&linkType=0&description=val5&flags=0"
curl -k -u admin:password -d @storageSystemLinkModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemLinkRefresh
Request Parameters
{ "method": "storageSystemLinkRefresh", "params": { "linkId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemLink }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkRefresh?linkId=val0&flags=0"
curl -k -u admin:password -d @storageSystemLinkRefresh.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemLinkSetCredentials
Request Parameters
{ "method": "storageSystemLinkSetCredentials", "params": { "linkId": xsd:string "remoteAdminUser": xsd:string "remoteAdminPassword": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemLink }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkSetCredentials?linkId=val0&remoteAdminUser=val1&remoteAdminPassword=val2&flags=0"
curl -k -u admin:password -d @storageSystemLinkSetCredentials.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemLinkVerify
Request Parameters
{ "method": "storageSystemLinkVerify", "params": { "linkObj": osn:storageSystemLink "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemLink }
storageSystemMaintenance
Puts specific services into maintenance mode
Request Parameters
{ "method": "storageSystemMaintenance", "params": { "storageSystemList": xsd:string "maintenanceFlags": xsd:unsignedInt - see #enum:enterMaintenanceModeMask and #enum:exitMaintenanceModeMask "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystem "list": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemMaintenance?storageSystemList=val0&maintenanceFlags=0&flags=0"
curl -k -u admin:password -d @storageSystemMaintenance.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemModify
Modifies the network and other configuration settings of the storage system.
Request Parameters
{ "method": "storageSystemModify", "params": { "storageSystem": xsd:string "newName": xsd:string "newDescription": xsd:string "newLocation": xsd:string "newEnclosureLayoutId": xsd:string "domainSuffix": xsd:string "searchSuffix": xsd:string "arpFilterMode": xsd:unsignedInt "bondMode": xsd:unsignedInt "newDnsServerList": xsd:string "externalHostName": xsd:string "gridPreferredPort": xsd:string "newNTPServerList": xsd:string "multipathConfigMode": xsd:unsignedInt "hwAutoMaintenanceMode": xsd:unsignedInt "logCollectionMode": xsd:unsignedInt "ethPortNaming": xsd:unsignedInt - see #enum:ethPortNaming "firewallMask": xsd:unsignedInt "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemModify?storageSystem=val0&newName=val1&newDescription=val2&newLocation=val3&newEnclosureLayoutId=val4&domainSuffix=val5&searchSuffix=val6&arpFilterMode=0&bondMode=0&newDnsServerList=val9&externalHostName=val10&gridPreferredPort=val11&newNTPServerList=val12&multipathConfigMode=0&hwAutoMaintenanceMode=0&logCollectionMode=0ðPortNaming=0&firewallMask=0&flags=0"
curl -k -u admin:password -d @storageSystemModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemRecover
Request Parameters
{ "method": "storageSystemRecover", "params": { "storageSystem": xsd:string "recoveryPoint": xsd:string "recoverNetworkConfig": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemRecoveryPoint }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemRecover?storageSystem=val0&recoveryPoint=val1&recoverNetworkConfig=val2&flags=0"
curl -k -u admin:password -d @storageSystemRecover.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemRecoveryPointEnum
returns a list of all the internal database recovery points available for the specified osn:storageSystem.
Request Parameters
{ "method": "storageSystemRecoveryPointEnum", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "list": osn:storageSystemRecoveryPoint }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemRecoveryPointEnum?storageSystem=val0&flags=0"
curl -k -u admin:password -d @storageSystemRecoveryPointEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemRestart
Requests a restart of the specified list of systems.
Request Parameters
{ "method": "storageSystemRestart", "params": { "storageSystemIdList": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystem "list": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemRestart?storageSystemIdList=val0&flags=0"
curl -k -u admin:password -d @storageSystemRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemSendLogs
Sends support logs for the specified system.
Request Parameters
{ "method": "storageSystemSendLogs", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemSendLogs?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @storageSystemSendLogs.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemServicesRestart
Request Parameters
{ "method": "storageSystemServicesRestart", "params": { "storageSystem": xsd:string "servicesList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemServicesRestart?storageSystem=val0&servicesList=val1&flags=0"
curl -k -u admin:password -d @storageSystemServicesRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemShutdown
Requests a shutdown of the specified list of systems.
Request Parameters
{ "method": "storageSystemShutdown", "params": { "storageSystemIdList": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystem "list": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemShutdown?storageSystemIdList=val0&flags=0"
curl -k -u admin:password -d @storageSystemShutdown.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemSignalManager
Request Parameters
{ "method": "storageSystemSignalManager", "params": { "storageSystem": xsd:string "managerClass": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemSignalManager?storageSystem=val0&managerClass=0&flags=0"
curl -k -u admin:password -d @storageSystemSignalManager.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTimeZoneEnum
Returns information about the available time zones.
Request Parameters
{ "method": "storageSystemTimeZoneEnum", "params": { "searchFilter": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "list": osn:timeZone }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTimeZoneEnum?searchFilter=val0&flags=0"
curl -k -u admin:password -d @storageSystemTimeZoneEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTimeZoneSet
Sets the time zone for a specific system.
Request Parameters
{ "method": "storageSystemTimeZoneSet", "params": { "storageSystem": xsd:string "timeZone": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTimeZoneSet?storageSystem=val0&timeZone=val1&flags=0"
curl -k -u admin:password -d @storageSystemTimeZoneSet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTunableEnum
Returns a list of all the storage system tunables (includes ZFS adjustable paramters)
Request Parameters
{ "method": "storageSystemTunableEnum", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "list": osn:storageSystemTunable }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableEnum?storageSystem=val0&flags=0"
curl -k -u admin:password -d @storageSystemTunableEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTunableGet
Request Parameters
{ "method": "storageSystemTunableGet", "params": { "storageSystem": xsd:string "tunableId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageSystemTunable }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableGet?storageSystem=val0&tunableId=val1&flags=0"
curl -k -u admin:password -d @storageSystemTunableGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTunableProfileApply
Request Parameters
{ "method": "storageSystemTunableProfileApply", "params": { "storageSystem": xsd:string "tunableProfile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemTunableProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileApply?storageSystem=val0&tunableProfile=val1&flags=0"
curl -k -u admin:password -d @storageSystemTunableProfileApply.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTunableProfileCreate
Request Parameters
{ "method": "storageSystemTunableProfileCreate", "params": { "name": xsd:string "description": xsd:string "tunableList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemTunableProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileCreate?name=val0&description=val1&tunableList=val2&flags=0"
curl -k -u admin:password -d @storageSystemTunableProfileCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTunableProfileDelete
Request Parameters
{ "method": "storageSystemTunableProfileDelete", "params": { "tunableProfile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemTunableProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileDelete?tunableProfile=val0&flags=0"
curl -k -u admin:password -d @storageSystemTunableProfileDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTunableProfileEnum
Returns a list of storage system tunable profiles. These enables setting all the tunable parameters as a set for a given use case.
Request Parameters
{ "method": "storageSystemTunableProfileEnum", "params": { "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "list": osn:storageSystemTunableProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileEnum?flags=0"
curl -k -u admin:password -d @storageSystemTunableProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTunableProfileGet
Request Parameters
{ "method": "storageSystemTunableProfileGet", "params": { "tunableProfile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageSystemTunableProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileGet?tunableProfile=val0&flags=0"
curl -k -u admin:password -d @storageSystemTunableProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTunableProfileModify
Request Parameters
{ "method": "storageSystemTunableProfileModify", "params": { "tunableProfile": xsd:string "name": xsd:string "description": xsd:string "tunableList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystemTunableProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileModify?tunableProfile=val0&name=val1&description=val2&tunableList=val3&flags=0"
curl -k -u admin:password -d @storageSystemTunableProfileModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemTunableSet
Request Parameters
{ "method": "storageSystemTunableSet", "params": { "storageSystem": xsd:string "tunableList": xsd:string "option": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storageSystemTunable }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableSet?storageSystem=val0&tunableList=val1&option=0&flags=0"
curl -k -u admin:password -d @storageSystemTunableSet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemUpdateCheck
Does an update check on the specified system to see if there are newer packages to upgrade to.
Request Parameters
{ "method": "storageSystemUpdateCheck", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "qstorManagerVersionCurrent": xsd:string "qstorManagerVersionAvailable": xsd:string "qstorServiceVersionCurrent": xsd:string "qstorServiceVersionAvailable": xsd:string "qstorTargetVersionCurrent": xsd:string "qstorTargetVersionAvailable": xsd:string "qstorWebServerVersionCurrent": xsd:string "qstorWebServerVersionAvailable": xsd:string "qstorRestVersionCurrent": xsd:string "qstorRestVersionAvailable": xsd:string "kernelVersionCurrent": xsd:string "kernelVersionAvailable": xsd:string "distroVersionAvailable": xsd:string }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemUpdateCheck?storageSystem=val0&flags=0"
curl -k -u admin:password -d @storageSystemUpdateCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemUpgrade
Starts the upgrade process on the specified list of storage systems.
Request Parameters
{ "method": "storageSystemUpgrade", "params": { "storageSystemIdList": xsd:string "includeKernel": xsd:boolean "distroUpgrade": xsd:boolean "allowReboot": xsd:boolean "coreOnly": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageSystem "list": osn:storageSystem }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemUpgrade?storageSystemIdList=val0&includeKernel=val1&distroUpgrade=val2&allowReboot=val3&coreOnly=val4&flags=0"
curl -k -u admin:password -d @storageSystemUpgrade.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageSystemVersion
Provides system name, id, and version without authentication. This API provides a discovery mechanism that can be used by various service discovery methods.
Request Parameters
{ "method": "storageSystemVersion", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "storageSystemName": xsd:string "storageSystemId": xsd:string "storageSystemVersion": xsd:string }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemVersion?flags=0"
curl -k -u admin:password -d @storageSystemVersion.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageTierAssocEnum
Request Parameters
{ "method": "storageTierAssocEnum", "params": { "storagePool": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageTierAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierAssocEnum?storagePool=val0&flags=0"
curl -k -u admin:password -d @storageTierAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageTierAssocGet
Request Parameters
{ "method": "storageTierAssocGet", "params": { "storageTierId": xsd:string "storagePoolId": xsd:string } }
Response Parameters
{ "obj": osn:storageTierAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierAssocGet?storageTierId=val0&storagePoolId=val1"
curl -k -u admin:password -d @storageTierAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageTierCreate
Creates a new storage provisioning tier which is essentially a group of pools with similar characteristics. Storage Tiers my be used in place of specific Storage Pool IDs when calling APIs requiring a provisionable UUID such as storageVolumeCreate and networkShareCreate. The system will intelligently select a pool within a specified tier based on the available resources when a tier is specified.
Request Parameters
{ "method": "storageTierCreate", "params": { "name": xsd:string "description": xsd:string "storageClass": xsd:string "storageType": xsd:unsignedInt "performanceLevel": xsd:unsignedInt "poolList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageTier }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierCreate?name=val0&description=val1&storageClass=val2&storageType=0&performanceLevel=0&poolList=val5&flags=0"
curl -k -u admin:password -d @storageTierCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageTierDelete
Request Parameters
{ "method": "storageTierDelete", "params": { "storageTier": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageTier }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierDelete?storageTier=val0&flags=0"
curl -k -u admin:password -d @storageTierDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageTierEnum
Request Parameters
{ "method": "storageTierEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageTier }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierEnum?flags=0"
curl -k -u admin:password -d @storageTierEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageTierGet
Request Parameters
{ "method": "storageTierGet", "params": { "storageTier": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageTier }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierGet?storageTier=val0&flags=0"
curl -k -u admin:password -d @storageTierGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageTierModify
Request Parameters
{ "method": "storageTierModify", "params": { "storageTier": xsd:string "newName": xsd:string "description": xsd:string "storageClass": xsd:string "storageType": xsd:unsignedInt "performanceLevel": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageTier }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierModify?storageTier=val0&newName=val1&description=val2&storageClass=val3&storageType=0&performanceLevel=0&flags=0"
curl -k -u admin:password -d @storageTierModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageTierPoolAddRemove
Request Parameters
{ "method": "storageTierPoolAddRemove", "params": { "storageTier": xsd:string "modType": xsd:unsignedInt "poolList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageTier }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierPoolAddRemove?storageTier=val0&modType=0&poolList=val2&flags=0"
curl -k -u admin:password -d @storageTierPoolAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeAclAddRemove
Request Parameters
{ "method": "storageVolumeAclAddRemove", "params": { "storageVolume": xsd:string "modType": xsd:unsignedInt "hostList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storageVolumeAcl }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeAclAddRemove?storageVolume=val0&modType=0&hostList=val2&flags=0"
curl -k -u admin:password -d @storageVolumeAclAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeAclAddRemoveEx
Request Parameters
{ "method": "storageVolumeAclAddRemoveEx", "params": { "host": xsd:string "modType": xsd:unsignedInt "storageVolumeList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storageVolumeAcl }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeAclAddRemoveEx?host=val0&modType=0&storageVolumeList=val2&flags=0"
curl -k -u admin:password -d @storageVolumeAclAddRemoveEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeAclEnum
Request Parameters
{ "method": "storageVolumeAclEnum", "params": { "host": xsd:string "storageVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageVolumeAcl }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeAclEnum?host=val0&storageVolume=val1&flags=0"
curl -k -u admin:password -d @storageVolumeAclEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeAclGet
Request Parameters
{ "method": "storageVolumeAclGet", "params": { "host": xsd:string "storageVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageVolumeAcl }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeAclGet?host=val0&storageVolume=val1&flags=0"
curl -k -u admin:password -d @storageVolumeAclGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeClone
Request Parameters
{ "method": "storageVolumeClone", "params": { "storageVolume": xsd:string "cloneName": xsd:string "description": xsd:string "provisionableId": xsd:string "accessMode": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeClone?storageVolume=val0&cloneName=val1&description=val2&provisionableId=val3&accessMode=0&flags=0"
curl -k -u admin:password -d @storageVolumeClone.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeCloudBackupCreate
Request Parameters
{ "method": "storageVolumeCloudBackupCreate", "params": { "sourceVolumeId": xsd:string "cloudContainerId": xsd:string "backupVolumeName": xsd:string "backupVolumeDescription": xsd:string "priority": xsd:unsignedInt "reserved": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeCloudBackupCreate?sourceVolumeId=val0&cloudContainerId=val1&backupVolumeName=val2&backupVolumeDescription=val3&priority=0&reserved=val5&flags=0"
curl -k -u admin:password -d @storageVolumeCloudBackupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeCloudBackupRestore
Request Parameters
{ "method": "storageVolumeCloudBackupRestore", "params": { "sourceVolumeId": xsd:string "storagePoolId": xsd:string "recoveredVolumeName": xsd:string "recoveredVolumeDescription": xsd:string "priority": xsd:unsignedInt "reserved": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeCloudBackupRestore?sourceVolumeId=val0&storagePoolId=val1&recoveredVolumeName=val2&recoveredVolumeDescription=val3&priority=0&reserved=val5&flags=0"
curl -k -u admin:password -d @storageVolumeCloudBackupRestore.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeCreate
Request Parameters
{ "method": "storageVolumeCreate", "params": { "name": xsd:string "description": xsd:string "provisionableId": xsd:string "size": xsd:unsignedLong "thinProvisioned": xsd:boolean "accessMode": xsd:unsignedInt "chapPolicy": xsd:unsignedInt "chapUsername": xsd:string "chapPassword": xsd:string "count": xsd:unsignedInt "qosPolicy": xsd:string "profile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume "list": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeCreate?name=val0&description=val1&provisionableId=val2&size=val3&thinProvisioned=val4&accessMode=0&chapPolicy=0&chapUsername=val7&chapPassword=val8&count=0&qosPolicy=val10&profile=val11&flags=0"
curl -k -u admin:password -d @storageVolumeCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeCreateEx
Request Parameters
{ "method": "storageVolumeCreateEx", "params": { "name": xsd:string "description": xsd:string "provisionableId": xsd:string "size": xsd:unsignedLong "percentReserved": xsd:unsignedInt "accessMode": xsd:unsignedInt "chapPolicy": xsd:unsignedInt "chapUsername": xsd:string "chapPassword": xsd:string "count": xsd:unsignedInt "blockSizeKb": xsd:unsignedInt "stripeSizeKb": xsd:unsignedInt "stripeCount": xsd:unsignedInt "syncPolicy": xsd:unsignedInt "compressionType": xsd:string "copies": xsd:unsignedInt "qosPolicy": xsd:string "profile": xsd:string "spaceReserved": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume "list": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeCreateEx?name=val0&description=val1&provisionableId=val2&size=val3&percentReserved=0&accessMode=0&chapPolicy=0&chapUsername=val7&chapPassword=val8&count=0&blockSizeKb=0&stripeSizeKb=0&stripeCount=0&syncPolicy=0&compressionType=val14&copies=0&qosPolicy=val16&profile=val17&spaceReserved=val18&flags=0"
curl -k -u admin:password -d @storageVolumeCreateEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeCreatePassthru
Request Parameters
{ "method": "storageVolumeCreatePassthru", "params": { "name": xsd:string "description": xsd:string "physicalDiskList": xsd:string "accessMode": xsd:unsignedInt "chapPolicy": xsd:unsignedInt "chapUsername": xsd:string "chapPassword": xsd:string "blockSizeKb": xsd:unsignedInt "qosPolicy": xsd:string "profile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume "list": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeCreatePassthru?name=val0&description=val1&physicalDiskList=val2&accessMode=0&chapPolicy=0&chapUsername=val5&chapPassword=val6&blockSizeKb=0&qosPolicy=val8&profile=val9&flags=0"
curl -k -u admin:password -d @storageVolumeCreatePassthru.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeDelete
Request Parameters
{ "method": "storageVolumeDelete", "params": { "storageVolumeList": xsd:string "recursivelyDeleteSnapshots": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeDelete?storageVolumeList=val0&recursivelyDeleteSnapshots=val1&flags=0"
curl -k -u admin:password -d @storageVolumeDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeDeleteEx
Request Parameters
{ "method": "storageVolumeDeleteEx", "params": { "storageVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeDeleteEx?storageVolume=val0&flags=0"
curl -k -u admin:password -d @storageVolumeDeleteEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeEnum
Request Parameters
{ "method": "storageVolumeEnum", "params": { "storageVolumeList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeEnum?storageVolumeList=val0&flags=0"
curl -k -u admin:password -d @storageVolumeEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGet
Request Parameters
{ "method": "storageVolumeGet", "params": { "storageVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGet?storageVolume=val0&flags=0"
curl -k -u admin:password -d @storageVolumeGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupAssocEnum
Request Parameters
{ "method": "storageVolumeGroupAssocEnum", "params": { "storageVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageVolumeGroupAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupAssocEnum?storageVolume=val0&flags=0"
curl -k -u admin:password -d @storageVolumeGroupAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupAssocGet
Request Parameters
{ "method": "storageVolumeGroupAssocGet", "params": { "storageVolumeGroupId": xsd:string "storageVolumeId": xsd:string } }
Response Parameters
{ "obj": osn:storageVolumeGroupAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupAssocGet?storageVolumeGroupId=val0&storageVolumeId=val1"
curl -k -u admin:password -d @storageVolumeGroupAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupClone
Request Parameters
{ "method": "storageVolumeGroupClone", "params": { "storageVolumeGroup": xsd:string "cloneNamePrefix": xsd:string "description": xsd:string "provisionableId": xsd:string "accessMode": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolumeGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupClone?storageVolumeGroup=val0&cloneNamePrefix=val1&description=val2&provisionableId=val3&accessMode=0&flags=0"
curl -k -u admin:password -d @storageVolumeGroupClone.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupCreate
Request Parameters
{ "method": "storageVolumeGroupCreate", "params": { "name": xsd:string "description": xsd:string "storageVolumeList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolumeGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupCreate?name=val0&description=val1&storageVolumeList=val2&flags=0"
curl -k -u admin:password -d @storageVolumeGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupDelete
Request Parameters
{ "method": "storageVolumeGroupDelete", "params": { "storageVolumeGroup": xsd:string "deleteAssociatedVolumes": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolumeGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupDelete?storageVolumeGroup=val0&deleteAssociatedVolumes=val1&flags=0"
curl -k -u admin:password -d @storageVolumeGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupEnum
Request Parameters
{ "method": "storageVolumeGroupEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageVolumeGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupEnum?flags=0"
curl -k -u admin:password -d @storageVolumeGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupGet
Request Parameters
{ "method": "storageVolumeGroupGet", "params": { "storageVolumeGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageVolumeGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupGet?storageVolumeGroup=val0&flags=0"
curl -k -u admin:password -d @storageVolumeGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupModify
Request Parameters
{ "method": "storageVolumeGroupModify", "params": { "storageVolumeGroup": xsd:string "newName": xsd:string "newDescription": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolumeGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupModify?storageVolumeGroup=val0&newName=val1&newDescription=val2&flags=0"
curl -k -u admin:password -d @storageVolumeGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupSnapshot
Request Parameters
{ "method": "storageVolumeGroupSnapshot", "params": { "storageVolumeGroup": xsd:string "snapshotNamePrefix": xsd:string "description": xsd:string "provisionableId": xsd:string "count": xsd:unsignedInt "accessMode": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:storageVolumeGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupSnapshot?storageVolumeGroup=val0&snapshotNamePrefix=val1&description=val2&provisionableId=val3&count=0&accessMode=0&flags=0"
curl -k -u admin:password -d @storageVolumeGroupSnapshot.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeGroupVolumeAddRemove
Request Parameters
{ "method": "storageVolumeGroupVolumeAddRemove", "params": { "storageVolumeGroup": xsd:string "modType": xsd:unsignedInt "storageVolumeList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolumeGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupVolumeAddRemove?storageVolumeGroup=val0&modType=0&storageVolumeList=val2&flags=0"
curl -k -u admin:password -d @storageVolumeGroupVolumeAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeHealthCheck
Request Parameters
{ "method": "storageVolumeHealthCheck", "params": { "storageVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:resourceHealthCheck }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeHealthCheck?storageVolume=val0&flags=0"
curl -k -u admin:password -d @storageVolumeHealthCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeImport
Request Parameters
{ "method": "storageVolumeImport", "params": { "storagePool": xsd:string "importTypes": xsd:unsignedInt "cleanupSnapshots": xsd:boolean "replicationScheduleId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storagePool }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeImport?storagePool=val0&importTypes=0&cleanupSnapshots=val2&replicationScheduleId=val3&flags=0"
curl -k -u admin:password -d @storageVolumeImport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeModify
Request Parameters
{ "method": "storageVolumeModify", "params": { "storageVolume": xsd:string "newName": xsd:string "newDescription": xsd:string "newAccessMode": xsd:unsignedInt "chapPolicy": xsd:unsignedInt "chapUsername": xsd:string "chapPassword": xsd:string "clearSnapshotFlag": xsd:boolean "enableCaching": xsd:boolean "isActiveCheckpoint": xsd:boolean "syncPolicy": xsd:unsignedInt "compressionType": xsd:string "copies": xsd:unsignedInt "qosPolicy": xsd:string "profile": xsd:string "spaceReserved": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeModify?storageVolume=val0&newName=val1&newDescription=val2&newAccessMode=0&chapPolicy=0&chapUsername=val5&chapPassword=val6&clearSnapshotFlag=val7&enableCaching=val8&isActiveCheckpoint=val9&syncPolicy=0&compressionType=val11&copies=0&qosPolicy=val13&profile=val14&spaceReserved=val15&flags=0"
curl -k -u admin:password -d @storageVolumeModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeProfileEnum
Request Parameters
{ "method": "storageVolumeProfileEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageVolumeProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeProfileEnum?flags=0"
curl -k -u admin:password -d @storageVolumeProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeProfileGet
Request Parameters
{ "method": "storageVolumeProfileGet", "params": { "storageVolumeProfile": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageVolumeProfile }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeProfileGet?storageVolumeProfile=val0&flags=0"
curl -k -u admin:password -d @storageVolumeProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeReassignSchedule
Request Parameters
{ "method": "storageVolumeReassignSchedule", "params": { "storageVolume": xsd:string "schedule": xsd:string "recursiveUpdateGmtSnaps": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeReassignSchedule?storageVolume=val0&schedule=val1&recursiveUpdateGmtSnaps=val2&flags=0"
curl -k -u admin:password -d @storageVolumeReassignSchedule.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeResize
Request Parameters
{ "method": "storageVolumeResize", "params": { "storageVolume": xsd:string "provisionableId": xsd:string "newSizeInBytes": xsd:unsignedLong "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeResize?storageVolume=val0&provisionableId=val1&newSizeInBytes=val2&flags=0"
curl -k -u admin:password -d @storageVolumeResize.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeRestore
Request Parameters
{ "method": "storageVolumeRestore", "params": { "storageVolume": xsd:string "snapshotVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeRestore?storageVolume=val0&snapshotVolume=val1&flags=0"
curl -k -u admin:password -d @storageVolumeRestore.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeRollback
Request Parameters
{ "method": "storageVolumeRollback", "params": { "storageVolume": xsd:string "snapshotVolume": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeRollback?storageVolume=val0&snapshotVolume=val1&flags=0"
curl -k -u admin:password -d @storageVolumeRollback.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeSetQosControls
Request Parameters
{ "method": "storageVolumeSetQosControls", "params": { "storageVolume": xsd:string "qosReadIops": xsd:unsignedLong "qosWriteIops": xsd:unsignedLong "qosReadBandwidth": xsd:unsignedLong "qosWriteBandwidth": xsd:unsignedLong "qosPolicy": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeSetQosControls?storageVolume=val0&qosReadIops=val1&qosWriteIops=val2&qosReadBandwidth=val3&qosWriteBandwidth=val4&qosPolicy=val5&flags=0"
curl -k -u admin:password -d @storageVolumeSetQosControls.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeSnapshot
Request Parameters
{ "method": "storageVolumeSnapshot", "params": { "storageVolume": xsd:string "snapshotName": xsd:string "description": xsd:string "provisionableId": xsd:string "accessMode": xsd:unsignedInt "count": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume "list": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeSnapshot?storageVolume=val0&snapshotName=val1&description=val2&provisionableId=val3&accessMode=0&count=0&flags=0"
curl -k -u admin:password -d @storageVolumeSnapshot.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeSnapshotRevert
Request Parameters
{ "method": "storageVolumeSnapshotRevert", "params": { "storageVolume": xsd:string "preserveExistingSnapshot": xsd:boolean "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:storageVolume }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeSnapshotRevert?storageVolume=val0&preserveExistingSnapshot=val1&flags=0"
curl -k -u admin:password -d @storageVolumeSnapshotRevert.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeUtilizationEnum
Request Parameters
{ "method": "storageVolumeUtilizationEnum", "params": { "storageVolume": xsd:string "offsetDays": xsd:unsignedInt "numberOfDays": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:storageVolumeUtilization }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeUtilizationEnum?storageVolume=val0&offsetDays=0&numberOfDays=0&flags=0"
curl -k -u admin:password -d @storageVolumeUtilizationEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeUtilizationGet
Request Parameters
{ "method": "storageVolumeUtilizationGet", "params": { "utilizationId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:storageVolumeUtilization }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeUtilizationGet?utilizationId=val0&flags=0"
curl -k -u admin:password -d @storageVolumeUtilizationGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeUtilizationGetRetentionPeriod
Request Parameters
{ "method": "storageVolumeUtilizationGetRetentionPeriod", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "days": xsd:unsignedInt }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeUtilizationGetRetentionPeriod?flags=0"
curl -k -u admin:password -d @storageVolumeUtilizationGetRetentionPeriod.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
storageVolumeUtilizationSetRetentionPeriod
Request Parameters
{ "method": "storageVolumeUtilizationSetRetentionPeriod", "params": { "daysToRetain": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "days": xsd:unsignedInt }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeUtilizationSetRetentionPeriod?daysToRetain=0&flags=0"
curl -k -u admin:password -d @storageVolumeUtilizationSetRetentionPeriod.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerEnum
Request Parameters
{ "method": "swControllerEnum", "params": { "swControllerGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:swController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerEnum?swControllerGroup=val0&flags=0"
curl -k -u admin:password -d @swControllerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerGet
Request Parameters
{ "method": "swControllerGet", "params": { "swController": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:swController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerGet?swController=val0&flags=0"
curl -k -u admin:password -d @swControllerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerGroupEnum
Request Parameters
{ "method": "swControllerGroupEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:swControllerGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerGroupEnum?flags=0"
curl -k -u admin:password -d @swControllerGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerGroupGet
Request Parameters
{ "method": "swControllerGroupGet", "params": { "swControllerGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:swControllerGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerGroupGet?swControllerGroup=val0&flags=0"
curl -k -u admin:password -d @swControllerGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerIscsiConfigAdd
Request Parameters
{ "method": "swControllerIscsiConfigAdd", "params": { "storageSystemList": xsd:string "storageVolumeList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:swController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerIscsiConfigAdd?storageSystemList=val0&storageVolumeList=val1&flags=0"
curl -k -u admin:password -d @swControllerIscsiConfigAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerPortalAdd
Request Parameters
{ "method": "swControllerPortalAdd", "params": { "storageSystemList": xsd:string "name": xsd:string "description": xsd:string "portalIpAddress": xsd:string "portalPortNumber": xsd:unsignedInt "controllerType": xsd:unsignedInt "chapUsername": xsd:string "chapPassword": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:swController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerPortalAdd?storageSystemList=val0&name=val1&description=val2&portalIpAddress=val3&portalPortNumber=0&controllerType=0&chapUsername=val6&chapPassword=val7&flags=0"
curl -k -u admin:password -d @swControllerPortalAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerPortalRemove
Request Parameters
{ "method": "swControllerPortalRemove", "params": { "hwController": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:swController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerPortalRemove?hwController=val0&flags=0"
curl -k -u admin:password -d @swControllerPortalRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerPortalScan
Request Parameters
{ "method": "swControllerPortalScan", "params": { "controllerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:swControllerTarget }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerPortalScan?controllerId=val0&flags=0"
curl -k -u admin:password -d @swControllerPortalScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerTargetEnum
Request Parameters
{ "method": "swControllerTargetEnum", "params": { "controllerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:swControllerTarget }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerTargetEnum?controllerId=val0&flags=0"
curl -k -u admin:password -d @swControllerTargetEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerTargetGet
Request Parameters
{ "method": "swControllerTargetGet", "params": { "swControllerTarget": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:swControllerTarget }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerTargetGet?swControllerTarget=val0&flags=0"
curl -k -u admin:password -d @swControllerTargetGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerTargetLogin
Request Parameters
{ "method": "swControllerTargetLogin", "params": { "controllerId": xsd:string "targetList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:swController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerTargetLogin?controllerId=val0&targetList=val1&flags=0"
curl -k -u admin:password -d @swControllerTargetLogin.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swControllerTargetLogout
Request Parameters
{ "method": "swControllerTargetLogout", "params": { "controllerId": xsd:string "targetList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:swController }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerTargetLogout?controllerId=val0&targetList=val1&flags=0"
curl -k -u admin:password -d @swControllerTargetLogout.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swDiskSessionEnum
Request Parameters
{ "method": "swDiskSessionEnum", "params": { "controllerId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:swDiskSession }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swDiskSessionEnum?controllerId=val0&flags=0"
curl -k -u admin:password -d @swDiskSessionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
swDiskSessionGet
Request Parameters
{ "method": "swDiskSessionGet", "params": { "swDiskSession": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:swDiskSession }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swDiskSessionGet?swDiskSession=val0&flags=0"
curl -k -u admin:password -d @swDiskSessionGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
systemCapabilityMetaDataGet
Used by VMware VASA module to gather capabilities information
Request Parameters
{ "method": "systemCapabilityMetaDataGet", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:capabilityMetaData }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/systemCapabilityMetaDataGet?flags=0"
curl -k -u admin:password -d @systemCapabilityMetaDataGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetPortDisable
Disables the specified network port, this is equivalent to an if-down operation
Request Parameters
{ "method": "targetPortDisable", "params": { "port": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortDisable?port=val0&flags=0"
curl -k -u admin:password -d @targetPortDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetPortEnable
Enabled the specified network port, this is equivalent to an if-up operation
Request Parameters
{ "method": "targetPortEnable", "params": { "port": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortEnable?port=val0&flags=0"
curl -k -u admin:password -d @targetPortEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetPortEnum
Returns a list of all the network ports on all the systems in the grid
Request Parameters
{ "method": "targetPortEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortEnum?flags=0"
curl -k -u admin:password -d @targetPortEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetPortGet
Returns information about a specific network port
Request Parameters
{ "method": "targetPortGet", "params": { "port": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortGet?port=val0&flags=0"
curl -k -u admin:password -d @targetPortGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetPortModify
Modifies the specified target port. Target ports are Network Ports and are typically named ethN, bondN, or a VLAN bondN.M or virtual interface bondN:M
Request Parameters
{ "method": "targetPortModify", "params": { "port": xsd:string "configType": xsd:string "ipAddress": xsd:string "netmask": xsd:string "gateway": xsd:string "mtu": xsd:unsignedInt "iscsiEnabled": xsd:boolean "objectGatewayEnabled": xsd:boolean "description": xsd:string "vportFloatList": xsd:string "bondMode": xsd:unsignedInt "firewallMask": xsd:unsignedInt "firewallForceAllowMask": xsd:unsignedInt "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "list": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortModify?port=val0&configType=val1&ipAddress=val2&netmask=val3&gateway=val4&mtu=0&iscsiEnabled=val6&objectGatewayEnabled=val7&description=val8&vportFloatList=val9&bondMode=0&firewallMask=0&firewallForceAllowMask=0&flags=0"
curl -k -u admin:password -d @targetPortModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetPortRescan
Forces an immediate scan of the network ports. This is generally not needed as they're continuously monitored on a 10sec interval.
Request Parameters
{ "method": "targetPortRescan", "params": { "storageSystem": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "list": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortRescan?storageSystem=val0&flags=0"
curl -k -u admin:password -d @targetPortRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetPortRestart
Forces a restart of the specified network port
Request Parameters
{ "method": "targetPortRestart", "params": { "port": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortRestart?port=val0&flags=0"
curl -k -u admin:password -d @targetPortRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetVirtualInterfaceCreate
Creates a virtual interface (eg: bond0:1) on the specified parent port (eg: bond0)
Request Parameters
{ "method": "targetVirtualInterfaceCreate", "params": { "storageSystemId": xsd:string "parentPortId": xsd:string "ipAddress": xsd:string "netmask": xsd:string "gateway": xsd:string "macAddress": xsd:string "portList": xsd:string "mtu": xsd:unsignedInt "description": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetVirtualInterfaceCreate?storageSystemId=val0&parentPortId=val1&ipAddress=val2&netmask=val3&gateway=val4&macAddress=val5&portList=val6&mtu=0&description=val8&flags=0"
curl -k -u admin:password -d @targetVirtualInterfaceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetVirtualInterfaceMove
Moves the specified virtual interfact to the specified target network port
Request Parameters
{ "method": "targetVirtualInterfaceMove", "params": { "virtualInterfaceId": xsd:string "targetPortId": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetVirtualInterfaceMove?virtualInterfaceId=val0&targetPortId=val1&flags=0"
curl -k -u admin:password -d @targetVirtualInterfaceMove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetVirtualPortCreate
Creates a teaming virtual port (eg: bond0) using the specified port list (eth0, eth1, etc)
Request Parameters
{ "method": "targetVirtualPortCreate", "params": { "storageSystemId": xsd:string "ipAddress": xsd:string "netmask": xsd:string "gateway": xsd:string "macAddress": xsd:string "portList": xsd:string "mtu": xsd:unsignedInt "description": xsd:string "bondMode": xsd:unsignedInt "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetVirtualPortCreate?storageSystemId=val0&ipAddress=val1&netmask=val2&gateway=val3&macAddress=val4&portList=val5&mtu=0&description=val7&bondMode=0&flags=0"
curl -k -u admin:password -d @targetVirtualPortCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetVirtualPortDelete
Request Parameters
{ "method": "targetVirtualPortDelete", "params": { "port": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetVirtualPortDelete?port=val0&flags=0"
curl -k -u admin:password -d @targetVirtualPortDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
targetVlanInterfaceCreate
Creates a VLAN interface on the specified parent port (eg: bond0)
Request Parameters
{ "method": "targetVlanInterfaceCreate", "params": { "storageSystemId": xsd:string "parentPortId": xsd:string "ipAddress": xsd:string "netmask": xsd:string "gateway": xsd:string "vlanId": xsd:unsignedInt "vlanQos": xsd:unsignedInt "mtu": xsd:unsignedInt "description": xsd:string "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "task": osn:task "obj": osn:targetPort }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetVlanInterfaceCreate?storageSystemId=val0&parentPortId=val1&ipAddress=val2&netmask=val3&gateway=val4&vlanId=0&vlanQos=0&mtu=0&description=val8&flags=0"
curl -k -u admin:password -d @targetVlanInterfaceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
taskCancel
Request Parameters
{ "method": "taskCancel", "params": { "id": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:task }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskCancel?id=val0&flags=0"
curl -k -u admin:password -d @taskCancel.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
taskClearAll
Clears all completed or failed tasks. Running, queued, initializing tasks are skipped.
Request Parameters
{ "method": "taskClearAll", "params": { "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "list": osn:task }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskClearAll?flags=0"
curl -k -u admin:password -d @taskClearAll.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
taskEnum
Returns a list of all the tasks. All QuantaStor management operations (API class) are run as async tasks within the storage grid. These Task can be monitored using the #taskEnum and #taskGet APIs.
Request Parameters
{ "method": "taskEnum", "params": { "taskIdlist": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:task }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskEnum?taskIdlist=val0&flags=0"
curl -k -u admin:password -d @taskEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
taskGet
Returns detailed information about a specific #osn:task. Use this API to monitor the progress of tasks. All tasks run asynchronously. As the caller of an API you can block the return of your API call until the task completes bay passing flags=0 to any API. Passing flags=1 to any API will return immediately after the task is queued so that progress may be monitored via the taskGet API. For APIs which create/modify/update an object the customId field of the task object will be populated with the UUID of the created/modified object so that it may be queried after the task completes.
Request Parameters
{ "method": "taskGet", "params": { "id": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:task }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskGet?id=val0&flags=0"
curl -k -u admin:password -d @taskGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
taskLockEnum
Request Parameters
{ "method": "taskLockEnum", "params": { "storageSystemId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:lock }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskLockEnum?storageSystemId=val0&flags=0"
curl -k -u admin:password -d @taskLockEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
taskLockRelease
Request Parameters
{ "method": "taskLockRelease", "params": { "storageSystemId": xsd:string "taskId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:lock }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskLockRelease?storageSystemId=val0&taskId=val1&flags=0"
curl -k -u admin:password -d @taskLockRelease.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
taskProceed
Request Parameters
{ "method": "taskProceed", "params": { "id": xsd:string "options": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:task }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskProceed?id=val0&options=0&flags=0"
curl -k -u admin:password -d @taskProceed.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
taskUpdateProgress
Request Parameters
{ "method": "taskUpdateProgress", "params": { "taskId": xsd:string "description": xsd:string "progress": xsd:unsignedInt "state": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:task }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskUpdateProgress?taskId=val0&description=val1&progress=0&state=0&flags=0"
curl -k -u admin:password -d @taskUpdateProgress.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
traceLevelGet
Request Parameters
{ "method": "traceLevelGet", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:traceLevel }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/traceLevelGet?flags=0"
curl -k -u admin:password -d @traceLevelGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
traceLevelModify
Request Parameters
{ "method": "traceLevelModify", "params": { "traceLevel": xsd:unsignedInt "stdOut": xsd:boolean "traceFilter": xsd:string "traceOptions": xsd:string "eventVerboseFilter": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:traceLevel }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/traceLevelModify?traceLevel=0&stdOut=val1&traceFilter=val2&traceOptions=val3&eventVerboseFilter=val4&flags=0"
curl -k -u admin:password -d @traceLevelModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
traceLogMessage
Request Parameters
{ "method": "traceLogMessage", "params": { "traceLevel": xsd:unsignedInt "messages": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:traceLevel }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/traceLogMessage?traceLevel=0&messages=val1&flags=0"
curl -k -u admin:password -d @traceLogMessage.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userAdd
Request Parameters
{ "method": "userAdd", "params": { "username": xsd:string "password": xsd:string "role": xsd:string "firstName": xsd:string "lastName": xsd:string "emailAddress": xsd:string "description": xsd:string "defaultChapUsername": xsd:string "defaultChapPassword": xsd:string "alertSubscriptions": xsd:unsignedInt "posixUid": xsd:unsignedInt "posixGid": xsd:unsignedInt "allowRootCliTokenAuth": xsd:boolean "accountType": xsd:unsignedInt "terminateTimeStamp": xsd:dateTime "wuiTabDisable": xsd:unsignedInt "wuiSectionDisable": xsd:unsignedInt "enableMultiFactorAuth": xsd:boolean "mfaConfig": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAdd?username=val0&password=val1&role=val2&firstName=val3&lastName=val4&emailAddress=val5&description=val6&defaultChapUsername=val7&defaultChapPassword=val8&alertSubscriptions=0&posixUid=0&posixGid=0&allowRootCliTokenAuth=val12&accountType=0&terminateTimeStamp=val14&wuiTabDisable=0&wuiSectionDisable=0&enableMultiFactorAuth=val17&mfaConfig=val18&flags=0"
curl -k -u admin:password -d @userAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userAppTokenCreate
Request Parameters
{ "method": "userAppTokenCreate", "params": { "user": xsd:string "tokenName": xsd:string "appKey": xsd:string "tokenExpires": xsd:dateTime "isReadOnly": xsd:boolean "appAccessMode": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:userAppToken }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenCreate?user=val0&tokenName=val1&appKey=val2&tokenExpires=val3&isReadOnly=val4&appAccessMode=0&flags=0"
curl -k -u admin:password -d @userAppTokenCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userAppTokenEnum
Request Parameters
{ "method": "userAppTokenEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:userAppToken }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenEnum?flags=0"
curl -k -u admin:password -d @userAppTokenEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userAppTokenGet
Request Parameters
{ "method": "userAppTokenGet", "params": { "appToken": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:userAppToken }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenGet?appToken=val0&flags=0"
curl -k -u admin:password -d @userAppTokenGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userAppTokenRegen
Request Parameters
{ "method": "userAppTokenRegen", "params": { "appToken": xsd:string "tokenExpires": xsd:dateTime "isReadOnly": xsd:boolean "appAccessMode": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:userAppToken }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenRegen?appToken=val0&tokenExpires=val1&isReadOnly=val2&appAccessMode=0&flags=0"
curl -k -u admin:password -d @userAppTokenRegen.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userAppTokenRemove
Request Parameters
{ "method": "userAppTokenRemove", "params": { "appToken": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:userAppToken }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenRemove?appToken=val0&flags=0"
curl -k -u admin:password -d @userAppTokenRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userAuthenticate
Request Parameters
{ "method": "userAuthenticate", "params": { "jwtToken": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAuthenticate?jwtToken=val0&flags=0"
curl -k -u admin:password -d @userAuthenticate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userAuthorization
Request Parameters
{ "method": "userAuthorization", "params": { "jwtToken": xsd:string "objectType": xsd:string "operation": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:rolePermissionAssignment "resourceAssocList": osn:storageCloudResourceAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAuthorization?jwtToken=val0&objectType=val1&operation=val2&flags=0"
curl -k -u admin:password -d @userAuthorization.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userEnum
Request Parameters
{ "method": "userEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userEnum?flags=0"
curl -k -u admin:password -d @userEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userGet
Request Parameters
{ "method": "userGet", "params": { "user": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGet?user=val0&flags=0"
curl -k -u admin:password -d @userGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userGroupAssocEnum
Request Parameters
{ "method": "userGroupAssocEnum", "params": { "user": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "list": osn:userGroupAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupAssocEnum?user=val0&flags=0"
curl -k -u admin:password -d @userGroupAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userGroupAssocGet
Request Parameters
{ "method": "userGroupAssocGet", "params": { "userGroupId": xsd:string "userId": xsd:string } }
Response Parameters
{ "obj": osn:userGroupAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupAssocGet?userGroupId=val0&userId=val1"
curl -k -u admin:password -d @userGroupAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userGroupCreate
Request Parameters
{ "method": "userGroupCreate", "params": { "name": xsd:string "description": xsd:string "userList": xsd:string "posixGid": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:userGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupCreate?name=val0&description=val1&userList=val2&posixGid=0&flags=0"
curl -k -u admin:password -d @userGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userGroupDelete
Request Parameters
{ "method": "userGroupDelete", "params": { "userGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:userGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupDelete?userGroup=val0&flags=0"
curl -k -u admin:password -d @userGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userGroupEnum
Request Parameters
{ "method": "userGroupEnum", "params": { "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "list": osn:userGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupEnum?flags=0"
curl -k -u admin:password -d @userGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userGroupGet
Request Parameters
{ "method": "userGroupGet", "params": { "userGroup": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:userGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupGet?userGroup=val0&flags=0"
curl -k -u admin:password -d @userGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userGroupModify
Request Parameters
{ "method": "userGroupModify", "params": { "userGroup": xsd:string "newName": xsd:string "newDescription": xsd:string "posixGid": xsd:unsignedInt "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:userGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupModify?userGroup=val0&newName=val1&newDescription=val2&posixGid=0&flags=0"
curl -k -u admin:password -d @userGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userGroupUserAddRemove
Request Parameters
{ "method": "userGroupUserAddRemove", "params": { "userGroup": xsd:string "modType": xsd:unsignedInt "userList": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:userGroup }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupUserAddRemove?userGroup=val0&modType=0&userList=val2&flags=0"
curl -k -u admin:password -d @userGroupUserAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userModify
Request Parameters
{ "method": "userModify", "params": { "user": xsd:string "newName": xsd:string "newRole": xsd:string "newFirstName": xsd:string "newLastName": xsd:string "newEmailAddress": xsd:string "newDescription": xsd:string "newDefaultChapUsername": xsd:string "newDefaultChapPassword": xsd:string "alertSubscriptions": xsd:unsignedInt "posixUid": xsd:unsignedInt "posixGid": xsd:unsignedInt "lockAccount": xsd:boolean "allowRootCliTokenAuth": xsd:boolean "wuiTabDisable": xsd:unsignedInt "wuiSectionDisable": xsd:unsignedInt "enableMultiFactorAuth": xsd:boolean "multiFactorAuthConfig": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userModify?user=val0&newName=val1&newRole=val2&newFirstName=val3&newLastName=val4&newEmailAddress=val5&newDescription=val6&newDefaultChapUsername=val7&newDefaultChapPassword=val8&alertSubscriptions=0&posixUid=0&posixGid=0&lockAccount=val12&allowRootCliTokenAuth=val13&wuiTabDisable=0&wuiSectionDisable=0&enableMultiFactorAuth=val16&multiFactorAuthConfig=val17&flags=0"
curl -k -u admin:password -d @userModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userPasswordSet
Request Parameters
{ "method": "userPasswordSet", "params": { "user": xsd:string "oldPassword": xsd:string "newPassword": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userPasswordSet?user=val0&oldPassword=val1&newPassword=val2&flags=0"
curl -k -u admin:password -d @userPasswordSet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
userRemove
Request Parameters
{ "method": "userRemove", "params": { "user": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "task": osn:task "obj": osn:user }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userRemove?user=val0&flags=0"
curl -k -u admin:password -d @userRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
virtualInterfaceAssocEnum
Returns a list of all the virtual interface associations
Request Parameters
{ "method": "virtualInterfaceAssocEnum", "params": { "flags": xsd:unsignedInt - {{{1}}} } }
Response Parameters
{ "list": osn:virtualInterfaceAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/virtualInterfaceAssocEnum?flags=0"
curl -k -u admin:password -d @virtualInterfaceAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
virtualInterfaceAssocGet
Request Parameters
{ "method": "virtualInterfaceAssocGet", "params": { "virtualInterfaceId": xsd:string "targetPortId": xsd:string "flags": xsd:unsignedInt } }
Response Parameters
{ "obj": osn:virtualInterfaceAssoc }
Curl Examples
curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/virtualInterfaceAssocGet?virtualInterfaceId=val0&targetPortId=val1&flags=0"
curl -k -u admin:password -d @virtualInterfaceAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"
Object Type Definitions
osn:acl
Fields
{ "objectId": xsd:string "objectType": xsd:unsignedInt "ownerId": xsd:string "ownerType": xsd:unsignedInt "accessLevel": xsd:unsignedInt "reserved": xsd:unsignedInt }
osn:activeDirDomain
Represents an Active Directory domain.
Inherits From osn:object
Fields
{ "domain": xsd:string }
osn:activeDirUserGroup
Represents an Active Directory user or group, this information is gathered from the server when managing #osn:networkShareUserAccess instances.
Inherits From osn:object
Fields
{ "domain": xsd:string "isGroup": xsd:boolean }
osn:alert
Inherits From osn:object
Fields
{ "objectId": xsd:string "objectType": xsd:unsignedInt "severity": xsd:unsignedInt "timeStamp": xsd:dateTime "title": xsd:string "description": xsd:string "snmpTrapType": xsd:unsignedInt "storageSystemName": xsd:string }
osn:alertConfigSettings
Configuration of the alert settings (call-home) for the Storage System and Storage Grid
Inherits From osn:object
Fields
{ "senderEmailAddress": xsd:string "smtpServerIpAddress": xsd:string "smtpServerPort": xsd:unsignedInt "smtpUsername": xsd:string "smtpPassword": xsd:string "smtpAuthType": xsd:unsignedInt "customerSupportEmailAddress": xsd:string "poolFreeSpaceWarningThreshold": xsd:unsignedInt "poolFreeSpaceAlertThreshold": xsd:unsignedInt "poolFreeSpaceCriticalAlertThreshold": xsd:unsignedInt "pagerDutyServiceKey": xsd:string "slackWebhookUrl": xsd:string "mattermostWebhookUrl": xsd:string }
osn:alertType
Inherits From osn:object
Fields
{ "description": xsd:string "objectType": xsd:unsignedInt "pauseUntilDate": xsd:dateTime "snmpTrapType": xsd:unsignedInt "severity": xsd:unsignedInt }
osn:auditEntry
Inherits From osn:task
Fields
{ }
osn:auditSettings
Fields
{ "id": xsd:string "isEnabled": xsd:boolean }
osn:backupJob
#osn:networkShares can have #osn:backupPolicy associated with them. Each time the Backup Policy runs a #osn:backupJob instance is created to show the progress and status of the backup job.
Inherits From osn:object
Fields
{ "pid": xsd:unsignedInt - process ID associated with the Backup Job "status": xsd:string - Current status of the Backup Job "progress": xsd:unsignedInt - Current progress of the Backup Job as a percentage complete "jobStage": xsd:unsignedInt - Current stage that the backup is in "filesScanned": xsd:unsignedInt - Number of files that were scanned on the source in prep for the transfer "filesCopied": xsd:unsignedInt - Number of files that were copied from source to destination "filesPurged": xsd:unsignedInt - Number of files that were removed due to aging out "backupPolicyId": xsd:string - Backup Policy that this Backup Job was launched from "networkShareId": xsd:string - Network Share the Backup Job is associated with "startDate": xsd:dateTime - date the Backup Job started "finishDate": xsd:dateTime - date the Backup Job completed "policyMode": xsd:string - indicates what move the Backup Policy was set to (move/copy and inbound/outbound) at the time the Backup Job was run. }
osn:backupPolicy
Represents a backup policy which can be used to backup or move data to/from any NFS or SMB share on a given network. This enables QuantaStor to directly backup shares on Windows and Linux systems. It also enables one to automatically migrate files to another NAS system or server based on file age.
Inherits From osn:schedule
Fields
{ "networkShareId": xsd:string "remoteHostname": xsd:string "remoteExportPath": xsd:string "remoteMountType": xsd:unsignedInt "retentionCriteria": xsd:unsignedInt "policyType": xsd:unsignedInt "scanThreads": xsd:unsignedInt "retentionDays": xsd:unsignedInt "purgePolicy": xsd:unsignedInt "createBackupLogs": xsd:boolean "backupToShareRoot": xsd:boolean "smbUsername": xsd:string "smbPassword": xsd:string "maxSnapshots": xsd:unsignedInt "minFileAgeDays": xsd:unsignedInt "maxFileAgeDays": xsd:unsignedInt "smbPasswordAlg": xsd:unsignedInt "createLinks": xsd:boolean "backupJobList": osn:backupJob }
osn:bucket
Ceph Buckets are repositories for S3 objects just the same as AWS buckets. The customId property holds the bucket ID used by Ceph.
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "utilizedSpace": xsd:unsignedLong "owner": xsd:string "vendorType": xsd:unsignedInt "objectLockMode": xsd:unsignedInt "objectLockRetentionDays": xsd:unsignedInt "quotaList": osn:s3Quota "userAssocList": osn:bucketUserAssoc }
osn:bucketObject
Ceph Buckets are repositories for S3 objects just the same as AWS buckets
Inherits From osn:object
Fields
{ "bucketId": xsd:string "size": xsd:unsignedLong "accountedSize": xsd:unsignedLong "owner": xsd:string "ownerDisplayName": xsd:string "contentType": xsd:string "etag": xsd:string "tag": xsd:string "versionedEpoch": xsd:unsignedLong }
osn:bucketUserAssoc
Fields
{ "cephClusterId": xsd:string "bucketId": xsd:string "s3UserId": xsd:string }
osn:capabilityMetaData
Pool capability metadata used to support external integration modules like VMware VASA.
Inherits From osn:object
Fields
{ "category": xsd:string "summary": xsd:string "valueType": xsd:unsignedInt "defaultValue": xsd:string "isImmutable": xsd:boolean "allowedValues": xsd:string }
osn:cephCluster
A ceph scale-out storage cluster which is comprised of one or more #osn:storageSystems.
Inherits From osn:object
Fields
{ "altName": xsd:string "description": xsd:string "status": xsd:string - usually HEALTH_OK "statusSummary": xsd:string - Summary description of status. "clientadminkeyring": xsd:string - Client Admin keyring. "defaultmonitorkeyring": xsd:string - Default monitor keyring. "cephClusterFsid": xsd:string - Ceph Cluster FSID. "cephVersion": xsd:string - Ceph version. "isMaintenanceMode": xsd:boolean - Set to 'true' if Ceph Cluster in in maintenance mode. "osdWeightPolicy": xsd:unsignedInt "encryptedOSD": xsd:boolean - default: false, indicates if OSD level encryption is enabled. "compressedOSD": xsd:boolean - default: false, indicates if OSD level compression is ensabled. "clientadminkeyringAlg": xsd:unsignedInt - Client Admin keyring. "defaultmonitorkeyringAlg": xsd:unsignedInt - Default monitor keyring. "clusterAuthMode": xsd:unsignedInt - see osn__cephClusterAuthMode_t. Default is cephx which is the default and encrypts ceph cluster communication "osdOutSubtreeLimit": xsd:unsignedInt - see osn__cephMonOsdSubtreeLimit. Default is host which doesn't kick out OSDs if the whole host is offline but will kick out individual downed OSDs within a host "osdDownTimeoutSec": xsd:unsignedInt - default is 300 seconds, after no response from an OSD for this time amount it is marked as down "osdOutTimeoutSec": xsd:unsignedInt - default is 86400 seconds, after no reponse from a downed OSD for this amount of time it is kicked out "nearFillFullPercent": xsd:unsignedInt - Setup to receive a warning when your cluster is getting near to its full ratio "backFillFullPercent": xsd:unsignedInt - When cluster has reached this capacity it blocks backfills from starting "fullPercent": xsd:unsignedInt - When cluster has reached this capacity it stops clients from writing data "rawUtilizedSpace": xsd:unsignedLong "rawFreeSpace": xsd:unsignedLong "memberList": osn:cephClusterMember "osdList": osn:cephOsd "monitorList": osn:cephMonitor "pgSetList": osn:cephPgSet "rgwList": osn:cephRadosGateway "mdsList": osn:cephMds "quotaList": osn:s3Quota }
osn:cephClusterMember
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "nodeSystemId": xsd:string "backendInterfaceId": xsd:string "clientInterfaceId": xsd:string "cephCfgHash": xsd:string "cfgModifyTimeStamp": xsd:string "cephVersion": xsd:string }
osn:cephClusterServiceEvent
Represents a ceph crash report
Inherits From osn:object
Fields
{ "crashId": xsd:string "entity": xsd:string "isArchived": xsd:boolean }
osn:cephCrushRule
Inherits From osn:object
Fields
{ "ruleId": xsd:unsignedInt "description": xsd:string "ruleType": xsd:unsignedInt "minSize": xsd:unsignedInt "maxSize": xsd:unsignedInt "listSteps": xsd:string "cephClusterId": xsd:string }
osn:cephFilesystem
A scale-out NAS filesystem, each of these has a #osn:storagePool associated with it.
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "description": xsd:string "size": xsd:unsignedLong "utilizedSpace": xsd:unsignedLong "poolAssocList": osn:cephFilesystemPoolAssoc }
osn:cephFilesystemPoolAssoc
Fields
{ "cephFileSystemId": xsd:string "cephPoolId": xsd:string "isMetadataPool": xsd:boolean }
osn:cephJournalDevice
Represents a journal device used to accelerate the write performance of Ceph OSDs.
Inherits From osn:object
Fields
{ "physicalDiskId": xsd:string "cephJournalGroupId": xsd:string "devicePath": xsd:string "cephOsdId": xsd:string "cephClusterId": xsd:string "size": xsd:unsignedLong "journalMode": xsd:unsignedInt "altDevicePath": xsd:string "nodeSystemId": xsd:string }
osn:cephJournalGroup
Inherits From osn:object
Fields
{ "primaryDiskId": xsd:string "secondaryDiskId": xsd:string "cephClusterId": xsd:string "groupType": xsd:unsignedInt "nodeSystemId": xsd:string "size": xsd:unsignedLong "freeSpace": xsd:unsignedLong "cephJournalDeviceIdList": xsd:string }
osn:cephMds
Ceph Metadata Server must be deployed before a Ceph Filesystem may be provisionioned within a given #osn:cephCluster
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "description": xsd:string "status": xsd:string "gid": xsd:unsignedInt "ipAddress": xsd:string "port": xsd:unsignedInt "rank": xsd:unsignedInt "nodeSystemId": xsd:string }
osn:cephMonitor
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "description": xsd:string "status": xsd:string "monId": xsd:string "rank": xsd:unsignedInt "host": xsd:string "ipAddress": xsd:string "kbTotal": xsd:unsignedLong "kbUsed": xsd:unsignedLong "kbAvail": xsd:unsignedLong "availPercent": xsd:unsignedInt "lastUpdated": xsd:dateTime "health": xsd:string "bytesTotal": xsd:unsignedLong "bytesSST": xsd:unsignedLong "bytesLog": xsd:unsignedLong "bytesMisc": xsd:unsignedLong "insideQuorum": xsd:boolean "outsideQuorum": xsd:boolean "nodeSystemId": xsd:string }
osn:cephObjectPoolGroup
An S3 object storage zone which one may provision buckets within and give users access to via ceph user access entries.
Inherits From osn:object
Fields
{ "description": xsd:string "cephClusterId": xsd:string "zone": xsd:string "zoneGroup": xsd:string "size": xsd:unsignedLong "utilizedSpace": xsd:unsignedLong "freeSpace": xsd:unsignedLong "cephPoolProfileId": xsd:string "poolList": osn:cephPool }
osn:cephOsd
a Ceph Object Storage Daemon has a one to one relationship with a #osn:physicalDisk. HDD based OSDs are also associated with a SSD/NVMe journal device to boost write performance.
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "description": xsd:string "osdId": xsd:string "provisionableId": xsd:string "journalDeviceId": xsd:string "walDeviceId": xsd:string "dbDeviceId": xsd:string "journalType": xsd:unsignedInt "status": xsd:string "mountPath": xsd:string "devicePath": xsd:string "cephClusterFsid": xsd:string "osdFsid": xsd:string "host": xsd:string "osdType": xsd:unsignedInt "size": xsd:unsignedLong "utilizedSpace": xsd:unsignedLong "weight": xsd:string "nodeSystemId": xsd:string "storagePoolId": xsd:string "journalPoolId": xsd:string "journalDeviceSize": xsd:unsignedLong "physicalDiskScsiId": xsd:string "diskEnclosure": xsd:string "diskSlot": xsd:string }
osn:cephPgSet
A group of placement groups within a given #osn:cephCluster.
Inherits From osn:object
Fields
{ "pgCount": xsd:unsignedInt "cephClusterId": xsd:string }
osn:cephPool
A scale-out ceph pool. For pools used for block storage provisioning there is an associated #osn:storagePool.
Inherits From osn:object
Fields
{ "description": xsd:string "placementGroupCount": xsd:unsignedInt "maxReplicaCount": xsd:unsignedInt "minReplicaCount": xsd:unsignedInt "cephPoolType": xsd:string "size": xsd:unsignedLong "utilizedSpace": xsd:unsignedLong "freeSpace": xsd:unsignedLong "cephClusterId": xsd:string "cephObjectPoolGroupId": xsd:string "cephFileSystemId": xsd:string "cephCrushRuleId": xsd:string "osdList": osn:cephOsd }
osn:cephPoolOsdAssoc
Fields
{ "cephPoolId": xsd:string "cephOsdId": xsd:string }
osn:cephPoolProfile
A ceph pool profile defines an erasure-coding configuration. It may be specified when new ceph pools are created.
Inherits From osn:object
Fields
{ "description": xsd:string "cephClusterId": xsd:string "dataChunkCount": xsd:unsignedInt "codeChunkCount": xsd:unsignedInt "plugin": xsd:string "technique": xsd:string "failureDomain": xsd:string "rulesetRoot": xsd:string }
osn:cephRadosGateway
Provides S3 and SWIFT object storage access to a #osn:cephCluster.
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "nodeSystemId": xsd:string "cephObjectPoolGroupId": xsd:string "ipAddress": xsd:string "portNumber": xsd:unsignedInt "targetPortId": xsd:string }
osn:cloudBackupSchedule
Used to backup #osn:storageVolumes to [[#osn:cloudContainer]s.
Inherits From osn:schedule
Fields
{ "storageCloudId": xsd:string "cloudContainerId": xsd:string "maxBackups": xsd:unsignedInt "priority": xsd:unsignedInt "storageVolumeList": osn:storageVolume }
osn:cloudBackupScheduleAssoc
Fields
{ "cloudBackupScheduleId": xsd:string "storageVolumeId": xsd:string }
osn:cloudContainer
Cloud containers represent a mapping of cloud based storage (typically S3 or S3 compatible storage) to a local Network Share so that the cloud storage may be accessed over traditional NAS protocols like SMB and NFS.
Inherits From osn:object
Fields
{ "description": xsd:string "credentialsId": xsd:string "locationId": xsd:string "providerType": xsd:unsignedInt "encryptionKey": xsd:string "storageUrl": xsd:string "mountPoint": xsd:string "markedDisabled": xsd:boolean "enableNfs": xsd:boolean "spaceUtilized": xsd:unsignedLong "containerType": xsd:unsignedInt "mountOptions": xsd:string "configName": xsd:string "storageVolumeList": osn:storageVolume }
osn:cloudContainerCacheSettings
Global NAS Gateway settings
Inherits From osn:object
Fields
{ "dirCacheTime": xsd:string "vfsCacheMode": xsd:unsignedInt "cacheShareId": xsd:string "bufferSize": xsd:unsignedLong "vfsCacheMaxAge": xsd:string - Max age of objects in the cache. (default 1h0m0s) "vfsCacheMaxSize": xsd:unsignedLong - Interval to poll the cache for stale objects. (default 1m0s) }
osn:cloudProvider
Represents a object storage cloud service provider like AWS, Azure, etc.
Inherits From osn:object
Fields
{ "providerType": xsd:unsignedInt "description": xsd:string "driverPath": xsd:string "supportsS3Proxy": xsd:boolean "credentialsList": osn:cloudProviderCredentials "locationList": osn:cloudProviderLocation }
osn:cloudProviderCredentials
Credentials used to login to a given cloud service provider for the purposes of creating, deleting, or connecting #osn:cloudContainer instances. This must be added for one or more cloud service providers (eg AWS, Azure, Dropbox, etc) before one can add or create a #osn:cloudContainer.
Inherits From osn:object
Fields
{ "providerId": xsd:string "providerType": xsd:unsignedInt "machine": xsd:string "username": xsd:string "password": xsd:string "projectId": xsd:string "authFile": xsd:string "containerList": osn:cloudContainer }
osn:cloudProviderLocation
Each cloud provider (AWS, etc) will have one or more location/regions associated with it like us-east, us-west.
Inherits From osn:object
Fields
{ "locationTag": xsd:string "providerId": xsd:string "endpoint": xsd:string "locationConstraint": xsd:string }
osn:clusterRing
Each Site Cluster will have one or two heartbeat rings setup. For production deployments we require two rings so that one can go down without triggering high-availability failover activities. When a #osn:siteCluster is created it is always created with the initial cluster ring. After creation the second ring may be added.
Inherits From osn:object
Fields
{ "siteClusterId": xsd:string "ring": xsd:unsignedInt "mcastPort": xsd:unsignedInt "bindNetAddress": xsd:string "status": xsd:string "ringMemberList": osn:clusterRingMember }
osn:clusterRingMember
Inherits From osn:object
Fields
{ "siteClusterId": xsd:string "clusterRingId": xsd:string "memberAddress": xsd:string }
osn:errorMessage
Fields
{ "severity": xsd:unsignedInt "message": osn:i18nString "errorCode": xsd:unsignedInt "file": xsd:string "line": xsd:unsignedInt "function": xsd:string }
osn:event
Inherits From osn:object
Fields
{ "index": xsd:unsignedInt "operation": xsd:string "objectType": xsd:unsignedInt "objectId": xsd:string "parentId": xsd:string "parentId2": xsd:string "category": xsd:string "serviceTimeStamp": xsd:dateTime "timeStamp": xsd:dateTime "eventId": xsd:string "originId": xsd:string "isSync": xsd:boolean "isRebroadcast": xsd:boolean "objectIdList": xsd:string "objectDataList": xsd:string "params": osn:keyValuePair }
osn:eventListener
Fields
{ "processorSystemId": xsd:string "broadcasterSystemId": xsd:string "preferredIpAddress": xsd:string "ipAddressList": xsd:string "listenerType": xsd:unsignedInt "listenerMode": xsd:unsignedInt "listenerId": xsd:string "serviceTimeStamp": xsd:dateTime "lastRegistrationRequest": xsd:dateTime "lastRegistrationStamp": xsd:dateTime "maxEvents": xsd:unsignedInt "state": xsd:unsignedInt "resyncList": xsd:string }
osn:fcTargetPort
Represents a Fibre Channel port on a FC HBA within a QuantaStor #osn:storageSystem
Inherits From osn:object
Fields
{ "description": xsd:string "isVirtualPort": xsd:boolean "firmwareVersion": xsd:string "driverVersion": xsd:string "pciInfo": xsd:string "isTargetModeEnabled": xsd:boolean "deviceNumber": xsd:unsignedInt "sysfsPath": xsd:string "vendor": xsd:string "linkState": xsd:string "model": xsd:string "portWwn": xsd:string "nodeWwn": xsd:string "status": xsd:string "fabricWwn": xsd:string "activeMode": xsd:unsignedInt "npivPortList": osn:fcTargetPort }
osn:hardwareConfiguration
Inherits From osn:object
Fields
{ "listHwController": osn:hwController "listHwUnit": osn:hwUnit "listHwEnclosure": osn:hwEnclosure "listHwDisk": osn:hwDisk "listHwLogicalDrive": osn:hwLogicalDrive "listHwAlarm": osn:hwAlarm "listHwBbu": osn:hwBatteryBackupUnit "listHwGroup": osn:hwControllerGroup "listHwUnitDiskAssoc": osn:hwUnitDiskAssoc "listSwController": osn:swController "listSwGroup": osn:swControllerGroup "listSwControllerTarget": osn:swControllerTarget "listSwDiskSession": osn:swDiskSession }
osn:host
Represents a host/server with one or more initiator ports which will login to the #osn:storageSystem to access one or more #osn:storageVolumes. Note that Storage Volumes are not accessible until they've been assigned to one or more #osn:hosts. That assignment is represented by one or more #osn:storageVolumeAcls.
Inherits From osn:object
Fields
{ "description": xsd:string "ipAddress": xsd:string "password": xsd:string "username": xsd:string "hostGroupId": xsd:string "hostOsType": xsd:unsignedInt "hostVolumeAclList": osn:storageVolumeAcl "initiatorPortList": osn:initiatorPort }
osn:hostGroup
Provides a convenience mechansim for grouping together #osn:hosts so that Storage Volumes can be assigned to many hosts in a single operation. Typically a Host Group is created for each cluster in the environment be it a VMware cluster, Windows cluster, or some other type of cluster so that the block storage can be assigned/unassigned to all the hosts at once.
Inherits From osn:object
Fields
{ "description": xsd:string "hostGroupVolumeAclList": osn:storageVolumeAcl "hostList": osn:host }
osn:hwAlarm
Hardware RAID controllers and HBAs can generate alerts when issues are detected. These are ingested and presented as #osn:hwAlarm instances.
Inherits From osn:object
Fields
{ "controllerId": xsd:string "timeStamp": xsd:dateTime "severity": xsd:unsignedInt "message": xsd:string "suppressed": xsd:boolean "raised": xsd:boolean }
osn:hwBatteryBackupUnit
provides information about the battery backup or supercapacitor on a RAID controller if installed.
Inherits From osn:object
Fields
{ "controllerId": xsd:string "status": xsd:string "model": xsd:string "serialNumber": xsd:string "chargePercent": xsd:unsignedInt "isReady": xsd:boolean "isOnline": xsd:boolean "needsReplacement": xsd:boolean "hoursUtilized": xsd:unsignedInt }
osn:hwController
Represents a hardware RAID controller or SAS HBA.
Inherits From osn:object
Fields
{ "controllerGroupId": xsd:string "vendor": xsd:string "model": xsd:string "driverVersion": xsd:string "firmwareVersion": xsd:string "biosVersion": xsd:string "serialNum": xsd:string "sasAddresses": xsd:string "pciAddress": xsd:string "ports": xsd:unsignedInt "drives": xsd:unsignedInt "units": xsd:unsignedInt "controllerTemp": xsd:string "rebuildRate": xsd:unsignedInt "verifyRate": xsd:unsignedInt "maxSsdCacheSize": xsd:unsignedLong "currentSsdCacheSize": xsd:unsignedLong "hasBatteryBackupUnit": xsd:boolean "capabilities": xsd:unsignedInt "altName": xsd:string "description": xsd:string "cacheMemorySize": xsd:unsignedLong "enclosureList": osn:hwEnclosure "unitList": osn:hwUnit "diskList": osn:hwDisk "bbuList": osn:hwBatteryBackupUnit }
osn:hwControllerGroup
Represents a hardware controller module for specific vendor/model of RAID or HBA controller.
Inherits From osn:object
Fields
{ "vendor": xsd:string "apiVersion": xsd:string "controllerList": osn:hwController }
osn:hwDisk
Represents storage media (HDD, SSD, NVMe) connected to an HBA or RAID controller. When a hwDisk is passed thru to the system it appears as a #osn:physicalDisk.
Inherits From osn:object
Fields
{ "controllerId": xsd:string "enclosureId": xsd:string "enclosure": xsd:string "enclosureSasAddress": xsd:string "slot": xsd:string "serialNum": xsd:string "firmwareVersion": xsd:string "status": xsd:string "unit": xsd:string "unitId": xsd:string "size": xsd:unsignedLong "diskType": xsd:unsignedInt "stateDetailFlags": xsd:unsignedInt "vendor": xsd:string "model": xsd:string "isSsdDevice": xsd:unsignedInt "isSpare": xsd:boolean "isEncrypted": xsd:boolean "isBlinking": xsd:boolean "capabilities": xsd:unsignedInt "mediumErrors": xsd:unsignedInt "predictiveErrors": xsd:unsignedInt "ssdLifeLeft": xsd:string "driveTemp": xsd:string "altName": xsd:string "description": xsd:string "smartHealthTest": xsd:string "sasAddress": xsd:string "portSasAddress": xsd:string "physicalDiskId": xsd:string }
osn:hwEnclosure
Represents a JBOD / disk chassis connected to a #osn:hwController. In a HA configuration each server will have 2x HBAs (see #osn:hwController) instances each connected to a given JBOD #osn:hwEnclosure so it will typically appear 4x times, once for each HBA.
Inherits From osn:object
Fields
{ "controllerId": xsd:string "enclosureLayoutId": xsd:string "slots": xsd:unsignedInt "drives": xsd:unsignedInt "fans": xsd:unsignedInt "tempSensorUnits": xsd:unsignedInt "powerSupplyUnits": xsd:unsignedInt "alarmCount": xsd:unsignedInt "vendor": xsd:string "model": xsd:string "sesType": xsd:string "sgDevicePath": xsd:string "sasAddress": xsd:string "firmwareVersion": xsd:string "altName": xsd:string "description": xsd:string "chassisTag": xsd:string "diskList": osn:hwDisk }
osn:hwEnclosureLayout
Each vendor and model of disk chassis (JBOD) has an associated enclosure layout object instance which provides detailed information chassis, like the number of drives, flow of drives (top->bottom, left->right) and more. Each #osn:hwEnclosure instance is associated with a #osn:hwEnclosureLayout.
Inherits From osn:object
Fields
{ "description": xsd:string "vendor": xsd:string "model": xsd:string "layoutFlow": xsd:unsignedInt "rows": xsd:unsignedInt "columns": xsd:unsignedInt "excludeSlots": xsd:string "slotsPerDrawer": xsd:unsignedInt "diskNumberingOffset": xsd:unsignedInt "slotStartingIndex": xsd:unsignedInt "diskOrientation": xsd:unsignedInt "drawerLayoutFlow": xsd:unsignedInt "imageName": xsd:string "sesIsEnabled": xsd:unsignedInt "sesVendor": xsd:string "sesProduct": xsd:string "matchTokensVendor": xsd:string "matchTokensProduct": xsd:string "matchTokensSlots": xsd:string "enclosureType": xsd:unsignedInt "parentLayoutId": xsd:string "vendorGroupId": xsd:string "slotExclusionList": osn:hwEnclosureLayoutSlotExclusion }
osn:hwEnclosureLayoutSlotExclusion
some #osn:hwEnclosureLayout have drive slots which are taken up by power supplies, fans or structural elements of the chassis. This indicates what row and column that exclusion is located so that the enclosure can be properly rendered in the WUI.
Fields
{ "row": xsd:unsignedInt "column": xsd:unsignedInt "notation": xsd:string }
osn:hwEnclosureLayoutVendorGroup
Inherits From osn:object
Fields
{ "vendorTag": xsd:string }
osn:hwLogicalDrive
In a hardware RAID controller (see #osn:hwController) the RAID units (see #osn:hwUnit) can be sliced up into multiple logical drives each of which will appear as a separate #osn:physicalDisk to the system.
Inherits From osn:object
Fields
{ "controllerId": xsd:string "unitId": xsd:string "size": xsd:unsignedLong "stripeSize": xsd:unsignedLong "status": xsd:string "devicePath": xsd:string "serialNumber": xsd:string "deviceDescriptor": xsd:string "raidType": xsd:unsignedInt }
osn:hwUnit
Represents a hardware RAID unit which could be RAID1/10/5/50/6/60. We only recommend the use of hardware RAID for the QuantaStor operating system boot device which should be two RAID1 mirrored SSDs which are ideally 200GB or larger in size.
Inherits From osn:object
Fields
{ "controllerId": xsd:string "raidType": xsd:unsignedInt "unitType": xsd:string "serialNum": xsd:string "status": xsd:string "productId": xsd:string "stripeSize": xsd:unsignedLong "size": xsd:unsignedLong "rebuildPercentComplete": xsd:string "vimPercentComplete": xsd:string "consistencyVerified": xsd:unsignedInt "writeCacheEnabled": xsd:boolean "isSystemDevice": xsd:boolean "isEncrypted": xsd:boolean "isSpare": xsd:boolean "physicalDiskId": xsd:string "capabilities": xsd:unsignedInt "hwCachePolicy": xsd:unsignedInt "isSsdCacheUnit": xsd:boolean "ssdCachingEnabled": xsd:boolean "altName": xsd:string "description": xsd:string "diskList": osn:hwDisk "logicalDriveList": osn:hwLogicalDrive }
osn:hwUnitDiskAssoc
Each hardware RAID unit is comprised of one or more disks (HDDs or SSDs). This represents the relationship between a #osn:hwUnit and a #osn:hwDisk. Each #osn:hwUnit contains a list of these associations, one for each disk in the RAID unit.
Fields
{ "unitId": xsd:string "diskId": xsd:string "controllerId": xsd:string }
osn:i18nString
Fields
{ "messageId": xsd:string "messageText": xsd:string "insertionParams": osn:keyValuePair }
osn:ibTargetPort
Represents an Infiniband network port. QuantaStor supports IB ports via IP-over-IB. Support for SRP has been deprecated in favor of iSER.
Inherits From osn:object
Fields
{ "description": xsd:string "caType": xsd:string "firmwareVersion": xsd:string "hwVersion": xsd:string "sysfsPath": xsd:string "vendor": xsd:string "linkState": xsd:string "model": xsd:string "portGuid": xsd:string "nodeGuid": xsd:string "status": xsd:string "rate": xsd:string "baseLid": xsd:unsignedInt "lmc": xsd:unsignedInt "smLid": xsd:unsignedInt "portNumber": xsd:unsignedInt }
osn:initiatorPort
An initiator port associated with a #osn:host. Initiator ports may be FC WWPNs or iSCSI IQNs.
Inherits From osn:object
Fields
{ "ipAddress": xsd:string "hostId": xsd:string "iqn": xsd:string "wwpn": xsd:string "initiatorType": xsd:unsignedInt }
osn:keyInfo
Inherits From osn:object
Fields
{ "deletedBy": xsd:string "deletionDate": xsd:dateTime "expirationDate": xsd:dateTime "keyMode": xsd:string "keyBlob": xsd:string "keyType": xsd:unsignedInt "keyLengthInBits": xsd:unsignedInt }
osn:keyValuePair
Fields
{ "key": xsd:string "value": xsd:string "type": xsd:unsignedInt }
osn:keyVaultModule
Inherits From osn:object
Fields
{ "tag": xsd:string "vendor": xsd:string "description": xsd:string "iamUrl": xsd:string "kvUrl": xsd:string }
osn:keyVaultProfile
Inherits From osn:object
Fields
{ "kvAddress": xsd:string "kvIamAddress": xsd:string "description": xsd:string "apiToken": xsd:string "serviceToken": xsd:string "kvModuleId": xsd:string }
osn:libratoMetricsConfig
Information for connecting a #osn:storageSystem to the Librato Metrics cloud metric monitoring system.
Inherits From osn:object
Fields
{ "username": xsd:string "token": xsd:string "postIntervalSec": xsd:unsignedInt "autoDashboardCreate": xsd:boolean "enableAlertAnnotations": xsd:boolean "enableConfigAnnotations": xsd:boolean }
osn:license
A license key associated with a #osn:storageSystem.
Inherits From osn:object
Fields
{ "licenseKey": xsd:string "fullName": xsd:string "email": xsd:string "version": xsd:string "orderNumber": xsd:string "company": xsd:string "licenseDate": xsd:dateTime "expirationDate": xsd:dateTime "timeUtilizedInMin": xsd:unsignedInt "licenseEdition": xsd:unsignedInt "licenseDuration": xsd:unsignedInt "licenseCategory": xsd:unsignedInt "licenseType": xsd:unsignedInt "nodeLimit": xsd:unsignedInt "cloudLimit": xsd:unsignedInt "snapshotLimit": xsd:unsignedInt "terabyteLimit": xsd:unsignedInt "userLimit": xsd:unsignedInt "volumeLimit": xsd:unsignedInt "remoteReplicationEnabled": xsd:boolean "ssdEnabled": xsd:boolean "cloudBackupEnabled": xsd:boolean "isNFR": xsd:boolean "activationRequestCode": xsd:string "activationStamp": xsd:string "activationKey": xsd:string "country": xsd:string "website": xsd:string "licenseServerFqdn": xsd:string "customFeature": xsd:unsignedInt "encryptionDisabled": xsd:boolean "isHighAvailability": xsd:boolean "parentLicenseKey": xsd:string "replacesLicenseKey": xsd:string "leaseEnforcementEnabled": xsd:boolean "objectStorageDisabled": xsd:boolean "lastLeaseRenewalDate": xsd:dateTime "leaseRenewalKey": xsd:string "resellerName": xsd:string "resellerContactNumber": xsd:string "resellerEmail": xsd:string "supportContractRef": xsd:string }
osn:licenseActivation
Once a license is activated it will have an activation key associated with it which binds the key to a given #osn:storageSystem
Inherits From osn:object
Fields
{ "licenseKey": xsd:string "activationRequestCode": xsd:string "activationStamp": xsd:string "activationKey": xsd:string }
osn:licenseLease
Inherits From osn:object
Fields
{ "licenseKey": xsd:string "lastLeaseRenewalDate": xsd:dateTime "leaseRenewalKey": xsd:string }
osn:lock
Inherits From osn:object
Fields
{ "objectId": xsd:string "objectType": xsd:unsignedInt "lockType": xsd:unsignedInt "taskId": xsd:string }
osn:mfaLogin
Multi-factor authentication login request
Fields
{ "reqCode": xsd:string "reqStatus": xsd:unsignedInt "respMsg": xsd:string }
osn:multiFactorAuthConfig
Multi-factor Authentication configuration which is associated with a MFA provider like Cisco Duo or Google Authenticator.
Inherits From osn:object
Fields
{ "encodingMode": xsd:unsignedInt "provider": xsd:unsignedInt "apiHost": xsd:string "integrationKey": xsd:string "secretKey": xsd:string "description": xsd:string }
osn:multiFactorAuthDevice
Represents a multi-factor authentication device like a phone
Inherits From osn:object
Fields
{ "capabilities": xsd:unsignedInt "device": xsd:string "displayName": xsd:string "nextSmsPasscode": xsd:string "number": xsd:string "deviceType": xsd:string }
osn:multipathConfig
Inherits From osn:object
Fields
{ "vendor": xsd:string "product": xsd:string "wwid": xsd:string }
Represents NAS file storage which is accessible via NFS and SMB file protocols.
Inherits From osn:replicatable
Fields
{ "sharePath": xsd:string "description": xsd:string "isActive": xsd:boolean "shareType": xsd:unsignedInt "snapshotIdList": xsd:string "enableCifs": xsd:boolean "isCloudBackup": xsd:boolean "spaceQuota": xsd:unsignedLong "cloudContainerId": xsd:string "disableSnapBrowsing": xsd:boolean "ownerUid": xsd:unsignedInt "ownerGid": xsd:unsignedInt "permissions": xsd:string "aclType": xsd:unsignedInt "spaceQuotaExcludeSnapshots": xsd:boolean "blockSizeKb": xsd:unsignedInt "parentShareId": xsd:string "exportPath": xsd:string "isCloudContainerCache": xsd:boolean "subshareIdList": xsd:string "nfsClients": osn:networkShareClient "cifsUserAccessList": osn:networkShareUserAccess "cifsOptionList": osn:networkShareCifsOption "backupPolicies": osn:backupPolicy }
Each #osn:networkShare has configurable SMB/CIFS options such as browsable=on, each represented by a key (eg: browsable) and a value (eg: on)
Fields
{ "networkShareId": xsd:string "key": xsd:string "value": xsd:string }
Represents an NFS access entry for a given #osn:networkShare
Inherits From osn:object
Fields
{ "networkShareId": xsd:string "hostId": xsd:string "clientFilter": xsd:string "readOnly": xsd:boolean "secure": xsd:boolean "async": xsd:boolean "subtreeCheck": xsd:boolean "customOptions": xsd:string }
Represents a file within a #osn:networkShare
Fields
{ "name": xsd:string "id": xsd:string "filePath": xsd:string "networkShareId": xsd:string "size": xsd:unsignedLong }
An SMB level lock on a #osn:networkShare.
Inherits From osn:object
Fields
{ "pid": xsd:unsignedInt "uid": xsd:unsignedInt "oplock": xsd:unsignedInt "rw": xsd:unsignedInt "networkShareId": xsd:string "networkShareName": xsd:string "filePath": xsd:string "timeStamp": xsd:dateTime }
Represents a global namespace where visbility to #osn:networkShares can be made available via a group of systems within a storage grid. Each namespace is associated with a list of systems where the shares will be presented as available and a list of shares to present. Namespaces use DFS technology for SMB connections and NFS redirects for NFS connections to route clients to the correct system where the #osn:networkShare is located.
Inherits From osn:object
Fields
{ "description": xsd:string "enableMicrosoftDfs": xsd:boolean "enableNfsRefferals": xsd:boolean "dfsMode": xsd:unsignedInt "systemAssocList": osn:networkShareNamespaceSystemAssoc "shareAssocList": osn:networkShareNamespaceShareAssoc }
Network Shares can be associated with global namespaces so that they're easier to locate by users. Each #osn:networkShare in the global namespace is associated with the namespace via a #osn:networkShareNamespaceShareAssoc. The redirectIpAddress is only used when a given #osn:networkShare is from a #osn:storagePool which does not have a HA virtual interface associated with it.
Fields
{ "networkShareId": xsd:string "networkShareNamespaceId": xsd:string "redirectIpAddress": xsd:string }
Represents the list of systems on which the #osn:networkShare should be visible for a given global namespace (see #osn:networkShareNamespace).
Fields
{ "storageSystemId": xsd:string "networkShareNamespaceId": xsd:string "preferredNetworkPortId": xsd:string }
Network shares can have multiple per user/group quotas associated with them where subjectName is the name of the user or group.
Fields
{ "isGroupSpace": xsd:boolean "subjectType": xsd:unsignedInt "subjectName": xsd:string "spaceUsed": xsd:unsignedLong "spaceQuota": xsd:unsignedLong }
SMB and NFS configuration options for a given #osn:storageSystem.
Inherits From osn:object
Fields
{ "nfsMode": xsd:unsignedInt "nfs4KerberosEnabled": xsd:boolean "defaultOptions": xsd:string "sambaSecurityMode": xsd:string "realm": xsd:string "domain": xsd:string "kdc": xsd:string "idmapMode": xsd:unsignedInt "nfsKerberosMode": xsd:unsignedInt "nfs4BrowsingDisabled": xsd:boolean "sambaVersion": xsd:string "allowTrustedDomains": xsd:boolean "preserveAdUserAccessEntries": xsd:boolean }
A client SMB or NFS session to a #osn:networkShare. SMB sessions provide more detailed information than NFS sessions.
Inherits From osn:object
Fields
{ "networkShareId": xsd:string "pid": xsd:unsignedInt "uid": xsd:unsignedInt "gid": xsd:unsignedInt "clientIpAddress": xsd:string "serverIpAddress": xsd:string "protocolVersion": xsd:string "protocolType": xsd:unsignedInt }
Represents a SMB/CIFS access entry for a given #osn:networkShare
Inherits From osn:object
Fields
{ "networkShareId": xsd:string "userId": xsd:string "username": xsd:string "domain": xsd:string "userSid": xsd:string "groupSid": xsd:string "isGroup": xsd:boolean "userAccessMode": xsd:unsignedInt "posixUid": xsd:unsignedInt "posixGid": xsd:unsignedInt }
osn:nodeAssoc
Fields
{ "storageSystemId": xsd:string "isRemote": xsd:boolean }
osn:object
Fields
{ "id": xsd:string "name": xsd:string "customId": xsd:string "state": xsd:unsignedInt "stateDetail": xsd:string "type": xsd:unsignedInt "createdTimeStamp": xsd:dateTime "createdByUserId": xsd:string "modifiedTimeStamp": xsd:dateTime "modifiedByUserId": xsd:string "isRemote": xsd:boolean "storageSystemId": xsd:string "ownershipRevision": xsd:unsignedInt "acls": osn:acl "properties": osn:objectProperty }
osn:objectProperty
Fields
{ "objectId": xsd:string "objectType": xsd:unsignedInt "key": xsd:string "value": xsd:string "type": xsd:unsignedInt }
osn:passwordPolicy
Policy for enforcing NIST and other compliance standards to all #osn:user accounts within a given storage grid.
Inherits From osn:object
Fields
{ "allowedSpecialChars": xsd:string "complexityReq": xsd:unsignedInt "minLength": xsd:unsignedInt "maxLength": xsd:unsignedInt "allowedLoginAttemptsUntilShortLockout": xsd:unsignedInt "allowedLoginAttemptsUntilPermLockout": xsd:unsignedInt "daysUntilExpiration": xsd:unsignedInt "uniquePasswordsUntilReuse": xsd:unsignedInt "minDaysBetweenPasswordChange": xsd:unsignedInt "minutesUntilWebAutoLogout": xsd:unsignedInt "accountInactiveDaysUntilLockout": xsd:unsignedInt "systemUseNotification": xsd:string "webAccessMode": xsd:unsignedInt }
osn:permissionAssignment
Permission definitions are assigned to #osn:roles via permission assignements.
Fields
{ "objectType": xsd:string "operation": xsd:string "scope": xsd:unsignedInt }
osn:permissionDefinition
QuantaStor's RBAC system provides adminitrators with the ability to give access to specific operations on specific object types. Every operation has an associated permission definition.
Fields
{ "objectType": xsd:string "operation": xsd:string }
osn:physicalDisk
a physical disk represents a instance of some storage media in a given #osn:storageSystem. If multipathParentDiskId is set then represents a multipath path.
Inherits From osn:object
Fields
{ "devicePath": xsd:string "altDevicePath": xsd:string "serialNumber": xsd:string "scsiId": xsd:string "sasAddressPort0": xsd:string "sasAddressPort1": xsd:string "diskType": xsd:unsignedInt "zoningType": xsd:unsignedInt "supportsMultipath": xsd:boolean "freeSpace": xsd:unsignedLong "productId": xsd:string "size": xsd:unsignedLong "storagePoolId": xsd:string "unitId": xsd:string "vendorId": xsd:string "revisionLevel": xsd:string "isSpare": xsd:boolean "isEncrypted": xsd:boolean "isMounted": xsd:boolean "multipathEnabled": xsd:boolean "ssdLifeLeft": xsd:string "smartHealthTest": xsd:string "driveTemp": xsd:string "multipathParentDiskId": xsd:string "hwDiskId": xsd:string "hotspareMarkerId": xsd:string "encryptionCipher": xsd:string "passthruVolumeId": xsd:string "sourceVolumeId": xsd:string "hasJournal": xsd:boolean "storagePoolDeviceId": xsd:string "cephOsdId": xsd:string "cephJournalGroupId": xsd:string "iofenceTag": xsd:string "iofencePoolId": xsd:string "iofenceSystemId": xsd:string "isSsdDevice": xsd:boolean "trimSupported": xsd:boolean "blockSize": xsd:unsignedLong "pathList": osn:physicalDiskPathAssoc }
osn:physicalDiskHotspareMarker
Represents a global hot-spare which can be used to repair a Storage Pool on any system that has connectivity to the device. In this way a spare can be shared by many storage pools and multiple systems which are connected to the JBOD where the hotspare resides. Hence the hotspare marker identifies a spare by the #osn:physicalDisk serialNum and scsiId which will be the same for a given device on all systems.
Inherits From osn:object
Fields
{ "serialNumber": xsd:string "devicePath": xsd:string "scsiId": xsd:string "vendorId": xsd:string "productId": xsd:string "size": xsd:unsignedLong }
osn:physicalDiskPathAssoc
represents a relationship between two #osn:physicalDisk objects, typically to show multipathing information.
Fields
{ "storageSystemId": xsd:string "isRemote": xsd:boolean "multipathDeviceId": xsd:string "standardDeviceId": xsd:string "policyType": xsd:string "pathStatus": xsd:string }
osn:providerApp
Defines an instance of a 3rd party provider integration (eg VMware VASA)
Inherits From osn:object
Fields
{ "providerType": xsd:unsignedInt "userAppTokenId": xsd:string "registrationScope": xsd:unsignedInt "nodeSystemId": xsd:string }
osn:provisionable
Base type for #osn:storagePool and #osn:storageTier.
Inherits From osn:object
Fields
{ "size": xsd:unsignedLong "freeSpace": xsd:unsignedLong }
osn:qosPolicy
#osn:storageVolumes may have a QoS policy assigned to them to limit the read and write bandwidth available to a given volume. Current limiting is throughput based with separate controls for reads (qosReadBandwith) and writes (qosWriteBandwidth).
Inherits From osn:object
Fields
{ "description": xsd:string "qosReadIops": xsd:unsignedLong "qosWriteIops": xsd:unsignedLong "qosReadBandwidth": xsd:unsignedLong "qosWriteBandwidth": xsd:unsignedLong }
osn:replicaAssoc
once a #osn:networkShare or #osn:storageVolume has been replicated, a #osn:replicaAssoc instance is created to represent the relationship between the source and target resource. This is used to support rollback and to provide detailed information about when the last transfer completed and more.
Inherits From osn:object
Fields
{ "sourceStorageSystemId": xsd:string "sourceParentId": xsd:string "sourceId": xsd:string "sourcePath": xsd:string "sourceName": xsd:string "sourceSupportsSnapshots": xsd:boolean "targetStorageSystemId": xsd:string "targetParentId": xsd:string "targetId": xsd:string "targetName": xsd:string "targetStoragePoolId": xsd:string "targetSupportsSnapshots": xsd:boolean "description": xsd:string "objectAssocType": xsd:unsignedInt "associationType": xsd:unsignedInt "replicationState": xsd:unsignedInt "progress": xsd:unsignedInt "priority": xsd:unsignedInt "parentReplicaAssoc": xsd:string "syncStartedTimeStamp": xsd:dateTime "syncCompletedTimeStamp": xsd:dateTime "replicationProcessId": xsd:unsignedInt "replicationScheduleId": xsd:string "timeRemaining": xsd:string "transferSpeed": xsd:string "currentFileName": xsd:string "currentFileProgress": xsd:unsignedInt "estTotalTransfer": xsd:unsignedLong "amountTransfered": xsd:unsignedLong "pseudoParentTaskId": xsd:string }
osn:replicaReportEntry
Each #osn:replicaReportSummary contains a series of entries, one for each #osn:networkShare or #osn:storageVolume being replicated. This provides granular information about a specific transfer.
Inherits From osn:object
Fields
{ "sourceStorageSystemId": xsd:string "sourceName": xsd:string "replicationScheduleId": xsd:string "targetStorageSystemId": xsd:string "targetName": xsd:string "pseudoParentTaskId": xsd:string "summaryReportId": xsd:string "replicationState": xsd:unsignedInt "progress": xsd:unsignedInt "syncStartedTimeStamp": xsd:dateTime "syncCompletedTimeStamp": xsd:dateTime "timeRemaining": xsd:string "transferSpeed": xsd:string "estTotalTransfer": xsd:unsignedLong "amountTransfered": xsd:unsignedLong "averageTransfer": xsd:unsignedLong }
osn:replicaReportSummary
Report containing the progress and status of a given replication run of a Replication Schedule.
Inherits From osn:object
Fields
{ "sourceStorageSystemId": xsd:string "targetProvisionableId": xsd:string "replicationScheduleId": xsd:string "pseudoParentTaskId": xsd:string "replicationState": xsd:unsignedInt "syncStartedTimeStamp": xsd:dateTime "syncCompletedTimeStamp": xsd:dateTime "taskCount": xsd:unsignedInt "tasksCompleted": xsd:unsignedInt "tasksFailed": xsd:unsignedInt "amountTransfered": xsd:unsignedLong "errorStatus": xsd:string "averageTransfer": xsd:unsignedLong "linkType": xsd:unsignedInt }
osn:replicatable
Base type for replicatable resources like #osn:storageVolumes and #osn:networkShares.
Inherits From osn:object
Fields
{ "storagePoolId": xsd:string "remoteReplicaFlags": xsd:unsignedInt "size": xsd:unsignedLong "isSnapshot": xsd:boolean "lazyCloneSnapshotPath": xsd:string "snapshotGroupId": xsd:string "snapshotParent": xsd:string "mountPath": xsd:string "originationPoolId": xsd:string "originationId": xsd:string "originationName": xsd:string "originationSnapshotParent": xsd:string "isActiveCheckpoint": xsd:boolean "createdBySchedule": xsd:string "compressionRatio": xsd:string "compressionType": xsd:string "retentionTags": xsd:unsignedInt "syncPolicy": xsd:unsignedInt "copies": xsd:unsignedInt "spaceUtilized": xsd:unsignedLong "logicalSpaceUtilized": xsd:unsignedLong "spaceUtilizedBySnapshots": xsd:unsignedLong "spaceReserved": xsd:unsignedLong "usedByRefReservation": xsd:unsignedLong "vvolType": xsd:unsignedInt "vvolParentId": xsd:string "snapshotReferenceId": xsd:string "replicaAssocList": osn:replicaAssoc }
osn:replicationSchedule
Represents a replication schedule used to replicate one or more #osn:networkShares and #osn:storageVolumes to a specific #osn:storagePool on a given Storage System within a grid of one or more #osn:storageSystems.
Inherits From osn:schedule
Fields
{ "storageCloudId": xsd:string "provisionableId": xsd:string "maxReplicas": xsd:unsignedInt "storageSystemLinkId": xsd:string "targetStorageCloudId": xsd:string "targetProvisionableId": xsd:string "scheduleStatus": xsd:string "priority": xsd:unsignedInt "reuseSourceSnapshot": xsd:boolean "reuseTargetChkpnt": xsd:boolean "storageVolumeList": osn:storageVolume "networkShareList": osn:networkShare }
osn:replicationScheduleAssocEx
Represents an association betwen a replication schedule and a #osn:networkShare or [[#osn:storageVolume]
Fields
{ "replicationScheduleId": xsd:string "replicatableId": xsd:string "replicatableType": xsd:unsignedInt }
osn:report
A report containing a series of #osn:reportEntry each identifying some issue to be reviewed and/or addressed.
Inherits From osn:object
Fields
{ "passedCount": xsd:unsignedInt "failedCount": xsd:unsignedInt "reportOutput": xsd:string "entryList": osn:reportEntry }
osn:reportEntry
A configuration analysis report is comprised of a set of these entries. Each one contains details about a specific issue to be addressed and a recommended action to address it.
Fields
{ "id": xsd:string "storageSystemId": xsd:string "objectId": xsd:string "objectType": xsd:unsignedInt "timeStamp": xsd:dateTime "title": xsd:string "description": xsd:string "recommendedAction": xsd:string "reportCategory": xsd:unsignedInt "reportImpact": xsd:unsignedInt "reportSeverity": xsd:unsignedInt }
osn:reportSchedule
Used to periodially scrub any bit-rot in #osn:storagePools
Inherits From osn:schedule
Fields
{ "reportTypes": xsd:unsignedInt - see osn__reportTypes "reportToEmail": xsd:string "reportToAlertEmails": xsd:boolean "outputFormat": xsd:unsignedInt "maxSubdirDepth": xsd:unsignedInt "maxSubdirsPerShare": xsd:unsignedInt "minSubdirUsedSpace": xsd:unsignedLong "lastReportStartTimeStamp": xsd:dateTime "assocList": osn:reportScheduleAssoc }
osn:reportScheduleAssoc
Fields
{ "reportScheduleId": xsd:string "reportableId": xsd:string "reportableType": xsd:unsignedInt }
osn:resourceDomain
A node is a resource domain hierarchy. This is used to ensure fault tolerance across racks and sites by providing QuantaStor with the information needed to build Ceph CRUSH maps and Storage Pools while maintaining physcial fault tolerance at a given level like site, rack, or host
Inherits From osn:object
Fields
{ "resourceDomainType": xsd:unsignedInt "resourceDomainParentId": xsd:string "description": xsd:string "resourceAssocList": osn:resourceDomainAssoc }
osn:resourceDomainAssoc
Each #osn:resourceDomain represents a site, datacenter, rack, host or other physical location entity. These are related to other resource domain instances via the #osn:resourceDomainAssoc such that a tree hierarchy is formed.
Inherits From osn:object
Fields
{ "resourceDomainId": xsd:string "resourceId": xsd:string "assocType": xsd:unsignedInt }
osn:resourceHealthCheck
Fields
{ "id": xsd:string "name": xsd:string "type": xsd:unsignedInt "state": xsd:unsignedInt "stateDetail": xsd:string }
osn:role
A security role for the management of QuantaStor systems. A role is associated with #osn:users and some set of permissions which scopes what operations they are allowed to do.
Inherits From osn:object
Fields
{ "description": xsd:string "wuiTabDisable": xsd:unsignedInt "wuiSectionDisable": xsd:unsignedInt "ldapGroup": xsd:string "permissionList": osn:rolePermissionAssignment "subjectAssocList": osn:roleSubjectAssoc }
osn:rolePermissionAssignment
A permission assignment to a role.
Inherits From osn:permissionAssignment
Fields
{ "roleId": xsd:string }
osn:roleSubjectAssoc
Represents a #osn:user assigned to a specific #osn:role
Fields
{ "roleId": xsd:string "subjectId": xsd:string }
osn:s3Proxy
Inherits From osn:object
Fields
{ "description": xsd:string "proxyServerName": xsd:string "proxyLocationEndpoint": xsd:string "sslCertificate": xsd:string "sslCertificateKey": xsd:string "portNums": xsd:string }
osn:s3Quota
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "bucketId": xsd:string "s3UserId": xsd:string "quotaScope": xsd:unsignedInt "maxObjectCountEnable": xsd:boolean "maxObjectCount": xsd:unsignedLong "maxSizeEnable": xsd:boolean "maxSize": xsd:unsignedLong }
osn:s3User
A user access key and secret key used to provide users with access to S3 object storage via a RADOS gateway.
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "displayName": xsd:string - eg: Sam Smith "emailAddress": xsd:string - eg: sam.smith@example.com "operationMask": xsd:unsignedInt - see osn__s3UserOpMask_t "accessSuspended": xsd:boolean - 'true' if user access is suspended. "tenant": xsd:string - optional - name of the tenant ResourceGroup this user is associtated with. "maxBuckets": xsd:unsignedInt "quotaList": osn:s3Quota "keyList": osn:s3UserAccessKey }
osn:s3UserAccessKey
Inherits From osn:object
Fields
{ "cephClusterId": xsd:string "s3UserId": xsd:string "user": xsd:string "accessKey": xsd:string "secretKey": xsd:string "accessKeyType": xsd:unsignedInt }
osn:schedule
Base type for snapshot schedules, replication schedules, and backup policies which is managed by the QuantaStor schedule manager in the core service.
Inherits From osn:object
Fields
{ "description": xsd:string "daysOfWeek": xsd:unsignedInt "hoursOfDay": xsd:unsignedInt "startDate": xsd:dateTime "isEnabled": xsd:boolean "reserved": xsd:unsignedInt "reservedData": xsd:string "scheduleType": xsd:unsignedInt "delayInterval": xsd:unsignedInt "offsetMinutes": xsd:unsignedInt "retentionCountHourlies": xsd:unsignedInt "retentionCountDailies": xsd:unsignedInt "retentionCountWeeklies": xsd:unsignedInt "retentionCountMonthlies": xsd:unsignedInt "retentionCountQuarterlies": xsd:unsignedInt }
osn:scrubSchedule
Used to periodially scrub any bit-rot in #osn:storagePools
Inherits From osn:schedule
Fields
{ "minDaysBetweenScrubs": xsd:unsignedInt "lastScrubStartTimeStamp": xsd:dateTime "assocList": osn:scrubScheduleAssoc }
osn:scrubScheduleAssoc
Fields
{ "scrubScheduleId": xsd:string "scrubableId": xsd:string "scrubableType": xsd:unsignedInt }
osn:serviceFirewallDef
Inherits From osn:object
Fields
{ "tcpPort": xsd:string "udpPort": xsd:string "protocolBitMask": xsd:unsignedInt "description": xsd:string }
osn:session
An iSCSI or FC session associated with a #osn:storageVolume.
Inherits From osn:object
Fields
{ "storageVolumeId": xsd:string "sessionNum": xsd:string "targetId": xsd:unsignedInt "connectionId": xsd:unsignedInt "lun": xsd:unsignedInt "targetIqn": xsd:string "initiatorIqn": xsd:string "reads": xsd:unsignedLong "writes": xsd:unsignedLong "readBytes": xsd:unsignedLong "writeBytes": xsd:unsignedLong "initiatorIpAddress": xsd:string "connectionState": xsd:string }
osn:singleSignOnPolicy
Inherits From osn:object
Fields
{ "isEnabled": xsd:boolean "ldapServer": xsd:string "ldapBaseDn": xsd:string }
osn:siteCluster
Site Clusters manage floating virtual network interfaces, also known as #osn:siteVifResources. When a system is taken offline all the of VIFs on that system will automatically move to another system within a given Site Cluster. When that happens it will trigger a #osn:storagePool HA failover if the VIF was associated with a Storage Pool.
Inherits From osn:object
Fields
{ "location": xsd:string "description": xsd:string "siteClusterAssocList": osn:siteClusterAssoc "ringList": osn:clusterRing "vifResources": osn:siteVifResource }
osn:siteClusterAssoc
Association between a system and a site cluster.
Inherits From osn:object
Fields
{ "siteClusterId": xsd:string "nodeSystemId": xsd:string "corosyncNodeId": xsd:string "version": xsd:string "currentDc": xsd:string "stack": xsd:string "nodesConfigured": xsd:unsignedInt "expectedVotes": xsd:unsignedInt "onlineNodes": xsd:unsignedInt "offlineNodes": xsd:unsignedInt "resourcesConfigured": xsd:unsignedInt }
osn:siteVifResource
Represents a virtual interface which can float between two or more systems in a #osn:siteCluster
Inherits From osn:object
Fields
{ "siteClusterId": xsd:string "parentInterfaceName": xsd:string "tag": xsd:string "ipAddress": xsd:string "subnetMask": xsd:string "mtu": xsd:unsignedInt "gateway": xsd:string "firewallMask": xsd:unsignedInt - Disable bit mask for protocols (NFS,SMB etc) based on qs_services_firewall.conf. "firewallForceAllowMask": xsd:unsignedInt }
osn:snapshotReference
Inherits From osn:object
Fields
{ "isProtected": xsd:boolean "parentId": xsd:string "imageId": xsd:string "snapType": xsd:unsignedInt "spaceUtilized": xsd:unsignedLong }
osn:snapshotSchedule
A snapshot #osn:schedule which runs periodially either on a set delay interval in minutes.
Inherits From osn:schedule
Fields
{ "storageCloudId": xsd:string "provisionableId": xsd:string "maxSnapshots": xsd:unsignedInt "storageVolumeList": osn:storageVolume "networkShareList": osn:networkShare }
osn:snapshotScheduleAssoc
Fields
{ "snapshotScheduleId": xsd:string "storageVolumeId": xsd:string "assocType": xsd:unsignedInt }
osn:storageCloud
A storageCloud is a Resource Group but is has this type name for backward compatibility. Resource Groups provide multi-tenancy functionality within a given Storage Grid.
Inherits From osn:object
Fields
{ "description": xsd:string "tier": xsd:string "organization": xsd:string "parentStorageCloudId": xsd:string "defaultChapUsername": xsd:string "defaultChapPassword": xsd:string "resourceAssocList": osn:storageCloudResourceAssoc "subjectAssocList": osn:storageCloudSubjectAssoc }
osn:storageCloudResourceAssoc
A resource like a Storage Volume associated with a Resource Group
Fields
{ "storageCloudId": xsd:string "objectId": xsd:string "objectType": xsd:unsignedInt "accessMode": xsd:unsignedInt }
osn:storageCloudSubjectAssoc
Fields
{ "storageCloudId": xsd:string "subjectId": xsd:string "subjectType": xsd:unsignedInt }
osn:storagePool
Represents a group of storage devices which have been combined together for fault-tolerance using RAID or Erasure-coding technology.
Inherits From osn:provisionable
Fields
{ "chunkSize": xsd:unsignedLong "description": xsd:string "devicePath": xsd:string "devicesActive": xsd:unsignedInt "devicesFailed": xsd:unsignedInt "devicesWorking": xsd:unsignedInt "devicesSpare": xsd:unsignedInt "devicesRaid": xsd:unsignedInt "devicesTotal": xsd:unsignedInt "intentBitmap": xsd:string "isDefault": xsd:boolean "enableCompression": xsd:boolean "enableDeduplication": xsd:boolean "enableSsd": xsd:boolean "enableAutoTrim": xsd:boolean "noBarriers": xsd:boolean "isActive": xsd:boolean "isMounted": xsd:boolean "isDegraded": xsd:boolean "isRecovering": xsd:boolean "isResyncing": xsd:boolean "isReshaping": xsd:boolean "metadataPath": xsd:string "metadataVersion": xsd:string "mountPath": xsd:string "legacyUuid": xsd:string "status": xsd:string "percentComplete": xsd:unsignedInt "scanStatus": xsd:string "scanSpeed": xsd:string "integrityStatus": xsd:string "recommendedAction": xsd:string "poolType": xsd:unsignedInt "raidType": xsd:unsignedInt "raidTypeInternal": xsd:unsignedInt "raidSetSize": xsd:unsignedInt "rawSize": xsd:unsignedLong "rawUtilizedSize": xsd:unsignedLong "rebuildEstimateInMin": xsd:unsignedInt "requiresFsGrow": xsd:boolean "percentProvisioned": xsd:unsignedInt "hotspareRepairPolicy": xsd:unsignedInt "hotspareRepairState": xsd:unsignedInt "lastRepairActionTimeStamp": xsd:dateTime "disableAutoStart": xsd:boolean "compressionRatio": xsd:string "compressionType": xsd:string "syncPolicy": xsd:unsignedInt "copies": xsd:unsignedInt "aclType": xsd:unsignedInt "cephClusterId": xsd:string "markedDisabled": xsd:boolean "profileId": xsd:string "isEncrypted": xsd:boolean "requiresKeyPassphrase": xsd:boolean "encryptionType": xsd:string "keyVaultType": xsd:unsignedInt "enclosureRedundancy": xsd:unsignedInt "keyVaultProfileId": xsd:string "encryptionRootKeyId": xsd:string "errCountReads": xsd:unsignedInt "errCountWrites": xsd:unsignedInt "errCountChecksums": xsd:unsignedInt "trimSupported": xsd:boolean "storagePoolDeviceList": osn:storagePoolDevice "storagePoolHaGroupList": osn:storagePoolHaFailoverGroup "storagePoolDeviceGroupList": osn:storagePoolDeviceGroup }
osn:storagePoolDevice
Represents a device within a #osn:storagePool. Each device is associated with a [[#osn:physicalDisk]. Devices may be used for data, metadata, write logging, and more.
Inherits From osn:object
Fields
{ "storagePoolId": xsd:string "physicalDiskId": xsd:string "physicalDiskSerialNumber": xsd:string "physicalDiskScsiId": xsd:string "devicePath": xsd:string "partitionNumber": xsd:unsignedInt "number": xsd:unsignedInt "majorNum": xsd:unsignedInt "minorNum": xsd:unsignedInt "raidDeviceNum": xsd:unsignedInt "isActive": xsd:boolean "isSync": xsd:boolean "isRebuilding": xsd:boolean "isRemoved": xsd:boolean "isFaulty": xsd:boolean "isSpare": xsd:boolean "isCache": xsd:boolean "cacheType": xsd:unsignedInt "raidGroupId": xsd:string "size": xsd:unsignedLong "enclosure": xsd:string "slot": xsd:string "cephClusterId": xsd:string "storagePoolDeviceGroupId": xsd:string "errCountReads": xsd:unsignedInt "errCountWrites": xsd:unsignedInt "errCountChecksums": xsd:unsignedInt "trimSupported": xsd:boolean "trimStatus": xsd:unsignedInt "physicalDiskObj": osn:physicalDisk }
osn:storagePoolDeviceGroup
Represents a group of devices in a #osn:storagePool which makes up a stripe set (VDEV in ZFS terminology)
Inherits From osn:object
Fields
{ "storagePoolId": xsd:string "groupType": xsd:unsignedInt "raidLevel": xsd:string "enclosureRedundant": xsd:boolean "errCountReads": xsd:unsignedInt "errCountWrites": xsd:unsignedInt "errCountChecksums": xsd:unsignedInt "storagePoolDeviceIdList": xsd:string }
osn:storagePoolHaFailoverGroup
Storage Pools can be made highly-available by creating a #osn:storagePoolHaFailoverGroup. The #osn:storagePool must be comprised of storage devices which are accessible by two QuantaStor servers which generally implies that the devices are SAS, FC, or dual-ported NVMe devices.
Inherits From osn:object
Fields
{ "description": xsd:string "storagePoolId": xsd:string "primaryStorageSystemId": xsd:string "secondaryStorageSystemId": xsd:string "tertiaryStorageSystemId": xsd:string "activeStorageSystemId": xsd:string "failoverModuleId": xsd:string "lastFailoverTimeStamp": xsd:dateTime "settleTimeInSec": xsd:unsignedInt "isActive": xsd:boolean "encryptionKeyData": xsd:string "encryptionKeyPath": xsd:string "verifyClientIps": xsd:string "deviceSerialNumbers": xsd:string "haClientFailoverPolicy": xsd:unsignedInt "haLinkStateFailoverPolicy": xsd:unsignedInt "haFcLinkStateFailoverPolicy": xsd:unsignedInt "exportTimeout": xsd:unsignedInt - maximum amount of time (in seconds) allocated for export of the pool as part of an HA failover sequence. If the timeout expires the aquiring system takes preemptive locks on the devices in order to start the pool import process and the exporting system will need a reboot. "interfaceList": osn:storagePoolHaFailoverInterface }
osn:storagePoolHaFailoverInterface
Represents a High-Availability Interface which is associated with a #osn:storagePool via a #osn:storagePoolHaFailoverGroup.
Inherits From osn:siteVifResource
Fields
{ "failoverGroupId": xsd:string "description": xsd:string "macAddress": xsd:string "iscsiEnabled": xsd:boolean }
osn:storagePoolProfile
Pool profiles provide a set of tunings to be applied to the disks within a given #osn:storagePool. These can be changed at any time via storagePoolModify.
Inherits From osn:object
Fields
{ "tag": xsd:string "description": xsd:string "nrRequests": xsd:unsignedInt "readAheadKb": xsd:unsignedInt "fifoBatch": xsd:unsignedInt "chunkSizeKb": xsd:unsignedInt "scheduler": xsd:string "nrRequestsMultiplier": xsd:unsignedInt "minTargetDriverThreads": xsd:unsignedInt "minTargetDriverTasklets": xsd:unsignedInt }
osn:storageQuota
Resource Groups (#osn:resourceGroup) provide multitenancy capabiliites. Within a Resource Group a provisioning quota may be added to allow its user members to provision a limited amount of storage from a specific #osn:storagePool. Each time a #osn:storageVolume or #osn:networkShare is provisioned it's associated with a storage provisioning quota [[#osn:storageQuota].
Inherits From osn:provisionable
Fields
{ "description": xsd:string "storagePoolId": xsd:string "storageCloudId": xsd:string "utilizationLimit": xsd:unsignedLong "utilizedSpace": xsd:unsignedLong "maxVolumes": xsd:unsignedInt "maxShares": xsd:unsignedInt "policyFlags": xsd:unsignedInt "volumeAssocList": osn:storageQuotaVolumeAssoc "shareAssocList": osn:storageQuotaShareAssoc }
Fields
{ "storageQuotaId": xsd:string "shareId": xsd:string }
osn:storageQuotaVolumeAssoc
Fields
{ "storageQuotaId": xsd:string "storageVolumeId": xsd:string }
osn:storageSystem
Represents a QuantaStor storage system which could be installed on physical or virtual server hardware.
Inherits From osn:object
Fields
{ "description": xsd:string "location": xsd:string "enclosureLayoutId": xsd:string "firmwareVersion": xsd:string "productId": xsd:string "serialNumber": xsd:string "serviceVersion": xsd:string "vendorId": xsd:string "startupTimeStamp": xsd:dateTime "kernelVersion": xsd:string "nfsdServiceStatus": xsd:string "smbdServiceStatus": xsd:string "nmbdServiceStatus": xsd:string "iscsiServiceStatus": xsd:string "hadoopServiceStatus": xsd:string "zfsServiceStatus": xsd:string "cephServiceStatus": xsd:string "searchSuffix": xsd:string "domainSuffix": xsd:string "dnsNameservers": xsd:string "externalHostName": xsd:string "gridPreferredPort": xsd:string "corosyncStartTimeStamp": xsd:dateTime "arpFilterStatus": xsd:unsignedInt "arpFilterMode": xsd:unsignedInt "bondMode": xsd:unsignedInt "storageSystemClusterId": xsd:string "clusterTargetPortId": xsd:string "isMaster": xsd:boolean "requiresReboot": xsd:boolean "siteClusterId": xsd:string "storageLinkId": xsd:string "packageVerService": xsd:string "packageVerManager": xsd:string "packageVerTomcat": xsd:string "packageVerTarget": xsd:string "packageVerRest": xsd:string "iscsiInitiatorIqn": xsd:string "ntpServers": xsd:string "timeZone": xsd:string "distroVersion": xsd:string "multipathConfigMode": xsd:unsignedInt "logCollectionMode": xsd:unsignedInt "hwAutoMaintenanceMode": xsd:unsignedInt "fipsState": xsd:unsignedInt "fipsStateDetail": xsd:string "libratoMetricsConfig": osn:libratoMetricsConfig "networkShareServiceConfig": osn:networkShareServiceConfig "hwConfig": osn:storageSystemHwConfig "firewallMask": xsd:unsignedInt - Disable bit mask for protocols (NFS,SMB etc) based on qs_services_firewall.conf. "targetPortList": osn:targetPort "fcTargetPortList": osn:fcTargetPort "ibTargetPortList": osn:ibTargetPort "dnsServerList": xsd:string }
osn:storageSystemCluster
Represents a Storage Grid but uses the name storageSystemCluster for legacy reasons. A Storage Grid is a group of QuantaStor storage systems which can span racks, sites, and clouds.
Inherits From osn:object
Fields
{ "description": xsd:string "masterNodeId": xsd:string "clusterPassword": xsd:string "virtualHostName": xsd:string "virtualHostIpAddress": xsd:string "virtualHostSubnetMask": xsd:string "virtualHostGateway": xsd:string "gridVifEnabled": xsd:boolean "gridAuthKey": xsd:string "gridBindAddress": xsd:string "gridIndex": xsd:unsignedInt "storageSystemIdList": xsd:string }
osn:storageSystemClusterAssoc
Inherits From osn:object
Fields
{ "storageSystemClusterId": xsd:string }
osn:storageSystemHwConfig
Contains all the hardware configuration information about a given #osn:storageSystem
Inherits From osn:object
Fields
{ "systemManufacturer": xsd:string "systemProduct": xsd:string "systemSerialNumber": xsd:string "systemManufacturerId": xsd:unsignedInt "systemProductId": xsd:unsignedInt "systemTemp": xsd:unsignedInt "systemMemoryTotal": xsd:unsignedLong "coreCount": xsd:unsignedInt "cpuCount": xsd:unsignedInt "cpuModel": xsd:string "cpuTopTemp": xsd:unsignedInt "cpuAvgTemp": xsd:unsignedInt "pchTemp": xsd:unsignedInt "powerSupplyCount": xsd:unsignedInt "powerSupplyHealth": xsd:unsignedInt "fanCount": xsd:unsignedInt "fanHealth": xsd:unsignedInt "ipmiFirmwareVersion": xsd:string "ipmiIpAddress": xsd:string "ipmiSubnetMask": xsd:string "ipmiMacAddress": xsd:string "ipmiGateway": xsd:string "memoryEccType": xsd:unsignedInt }
osn:storageSystemLink
Link between two [osn:storageSystem]s which contains information necessary for remote-replication of #osn:storageVolumes and #osn:networkShares.
Inherits From osn:object
Fields
{ "description": xsd:string "remoteStorageSystemId": xsd:string "remoteIpAddress": xsd:string "remoteAdminUser": xsd:string "remoteAdminPasswordToken": xsd:string "publicKey": xsd:string "localIpAddress": xsd:string "bandwidthLimit": xsd:unsignedInt "linkType": xsd:unsignedInt "linkStatus": xsd:unsignedInt "storageSystemLinkKeyId": xsd:string "replicaAssocList": osn:replicaAssoc }
osn:storageSystemLinkKey
Security key associated with a given remote replication #osn:storageSystemLink.
Inherits From osn:object
Fields
{ "storageSystemLinkId": xsd:string "publicKey": xsd:string "privateKey": xsd:string }
osn:storageSystemRecoveryPoint
QuantaStor automatically does a backup of its internal database #osn:storagePools on a system every hour. These provide recovery points in cases where the configuration database needs to be rolled back. This is usually done after a clean ISO installation of QuantaStor on a system that has one or more storage pools. QuantaStor's internal database is forward and backward compatible with newer/older versions of the QuantaStor service.
Inherits From osn:object
Fields
{ "filePath": xsd:string "fileName": xsd:string "fileSize": xsd:unsignedLong }
osn:storageSystemTunable
System wide configuration tunable, typically used to adjust ZFS filesystem parameters but more broadly includes other things like network queue sizes and more. Each tunable represents a different element of the system that may be adjusted.
Inherits From osn:object
Fields
{ "title": xsd:string "description": xsd:string "dataType": xsd:unsignedInt "dataValue": xsd:unsignedLong "dataValueMin": xsd:unsignedLong "dataValueMax": xsd:unsignedLong "dataValueDefault": xsd:unsignedLong }
osn:storageSystemTunableAssoc
Fields
{ "id": xsd:string "tunableProfileId": xsd:string "dataParam": xsd:string "dataValue": xsd:unsignedInt }
osn:storageSystemTunableProfile
Inherits From osn:object
Fields
{ "description": xsd:string "tunableAssocList": osn:storageSystemTunableAssoc }
osn:storageTier
In larger configurations with many #osn:storagePools it can be difficult to select the optimal #osn:storagePool without first looking at each one to determine which one has the most free space and has the right characteristics. Storage Provisioning Tiers provide a way to easily group together pools to simplify provisioning in large configurations. Each #osn:storageTier may be associated with one or more #osn:storagePools. When provisioning a new #osn:storageVolume or #osn:networkShare a Storage Tier ID may be specified instead of a specific #osn:storagePool. In such a case QuantaStor will automatically select the optimal pool for a given provisioning request.
Inherits From osn:object
Fields
{ "performanceLevel": xsd:unsignedInt "storageType": xsd:unsignedInt "storageClass": xsd:string "description": xsd:string "storageTierAssocList": osn:storageTierAssoc }
osn:storageTierAssoc
Fields
{ "storageTierId": xsd:string "storagePoolId": xsd:string }
osn:storageVolume
Represents a block storage device that can be presented to one or more hosts as a LUN. Storage Volumes must be assigned to a #osn:host before they are accessible via iSCSI and/or FC.
Inherits From osn:replicatable
Fields
{ "accessMode": xsd:unsignedInt "description": xsd:string "devicePath": xsd:string "iqn": xsd:string "isCloudBackup": xsd:boolean "isThin": xsd:boolean "useGuidIqn": xsd:boolean "lun": xsd:unsignedInt "cloudContainerId": xsd:string "target": xsd:unsignedInt "relativeTargetId": xsd:unsignedInt "volumeType": xsd:unsignedInt "chapPolicy": xsd:unsignedInt "blockSizeKb": xsd:unsignedInt "chapUsername": xsd:string "chapPassword": xsd:string "storageLinkId": xsd:string "deviceDescriptor": xsd:string "enableWriteCache": xsd:boolean "accessTimeStamp": xsd:dateTime "qosReadIops": xsd:unsignedLong "qosWriteIops": xsd:unsignedLong "qosReadBandwidth": xsd:unsignedLong "qosWriteBandwidth": xsd:unsignedLong "qosPolicyId": xsd:string "eui": xsd:string "lunAssignmentPolicy": xsd:unsignedInt "cephClusterId": xsd:string "profileId": xsd:string "stripeSizeKb": xsd:unsignedInt "stripeCount": xsd:unsignedInt "snapshotIdList": xsd:string }
osn:storageVolumeAcl
An access control assignment of a #osn:storageVolume to a #osn:host or #osn:hostGroup
Inherits From osn:object
Fields
{ "hostId": xsd:string "hostObjType": xsd:unsignedInt "storageVolumeId": xsd:string "storageVolumeObjType": xsd:unsignedInt }
osn:storageVolumeGroup
Represents a group of #osn:storageVolumes. Once grouped they can be snapshot as a set.
Inherits From osn:object
Fields
{ "description": xsd:string "volumeAssocList": osn:storageVolumeGroupAssoc }
osn:storageVolumeGroupAssoc
Fields
{ "storageVolumeGroupId": xsd:string "storageVolumeId": xsd:string }
osn:storageVolumeProfile
Pool profiles provide a set of tunings to be applied to the disks within a given #osn:storagePool. These can be changed at any time via storagePoolModify.
Inherits From osn:object
Fields
{ "tag": xsd:string "description": xsd:string "blockSizeKb": xsd:unsignedInt "iscsiQueuedCommands": xsd:unsignedInt "iscsiFirstBurstLength": xsd:unsignedInt "iscsiMaxBurstLength": xsd:unsignedInt "iscsiMaxRecvDataSegmentLength": xsd:unsignedInt "iscsiMaxXmitDataSegmentLength": xsd:unsignedInt }
osn:storageVolumeUtilization
Records daily information about #osn:storageVolume utilization over time which can then be used for charge-back accounting.
Inherits From osn:object
Fields
{ "storageVolumeId": xsd:string "size": xsd:unsignedLong "sizeUtilized": xsd:unsignedLong "ioTotal": xsd:unsignedLong "ioReadsTotal": xsd:unsignedLong "ioWritesTotal": xsd:unsignedLong "ioReads00": xsd:unsignedInt "ioReads01": xsd:unsignedInt "ioReads02": xsd:unsignedInt "ioReads03": xsd:unsignedInt "ioReads04": xsd:unsignedInt "ioReads05": xsd:unsignedInt "ioReads06": xsd:unsignedInt "ioReads07": xsd:unsignedInt "ioReads08": xsd:unsignedInt "ioReads09": xsd:unsignedInt "ioReads10": xsd:unsignedInt "ioReads11": xsd:unsignedInt "ioReads12": xsd:unsignedInt "ioReads13": xsd:unsignedInt "ioReads14": xsd:unsignedInt "ioReads15": xsd:unsignedInt "ioReads16": xsd:unsignedInt "ioReads17": xsd:unsignedInt "ioReads18": xsd:unsignedInt "ioReads19": xsd:unsignedInt "ioReads20": xsd:unsignedInt "ioReads21": xsd:unsignedInt "ioReads22": xsd:unsignedInt "ioReads23": xsd:unsignedInt "ioWrites00": xsd:unsignedInt "ioWrites01": xsd:unsignedInt "ioWrites02": xsd:unsignedInt "ioWrites03": xsd:unsignedInt "ioWrites04": xsd:unsignedInt "ioWrites05": xsd:unsignedInt "ioWrites06": xsd:unsignedInt "ioWrites07": xsd:unsignedInt "ioWrites08": xsd:unsignedInt "ioWrites09": xsd:unsignedInt "ioWrites10": xsd:unsignedInt "ioWrites11": xsd:unsignedInt "ioWrites12": xsd:unsignedInt "ioWrites13": xsd:unsignedInt "ioWrites14": xsd:unsignedInt "ioWrites15": xsd:unsignedInt "ioWrites16": xsd:unsignedInt "ioWrites17": xsd:unsignedInt "ioWrites18": xsd:unsignedInt "ioWrites19": xsd:unsignedInt "ioWrites20": xsd:unsignedInt "ioWrites21": xsd:unsignedInt "ioWrites22": xsd:unsignedInt "ioWrites23": xsd:unsignedInt }
osn:subject
A user or user group
Inherits From osn:object
Fields
{ "description": xsd:string "storageCloudAssocList": osn:storageCloudSubjectAssoc "userGroupAssocList": osn:userGroupAssoc }
osn:swController
Represents an iSCSI Software HBA used to connect to 3rd-party SANs or another QuantaStor SAN. This can be used to setup a QuantaStor HA configuration using VMs or physical servers connected to iSCSI block storage. In this way QuantaStor can be setup as a highly available NAS head for 3rd party SANs using physical or virtual servers.
Inherits From osn:object
Fields
{ "description": xsd:string "ipAddress": xsd:string "portNumber": xsd:unsignedInt "username": xsd:string "password": xsd:string "controllerType": xsd:unsignedInt "targetList": osn:swControllerTarget }
osn:swControllerGroup
Represents a group of one or more #osn:swController instances.
Inherits From osn:object
Fields
{ "vendor": xsd:string "apiVersion": xsd:string "controllerList": osn:swController }
osn:swControllerTarget
Represents a 3rd-party iSCSI SAN device which the QuantaStor is connected to via one or more #osn:swDiskSession instances.
Inherits From osn:object
Fields
{ "controllerId": xsd:string "sessionList": osn:swDiskSession }
osn:swDiskSession
Each iSCSI target connection to an external iSCSI SAN is represented a software disk session instance.
Inherits From osn:object
Fields
{ "controllerId": xsd:string "targetId": xsd:string "portalIpAddress": xsd:string "sid": xsd:unsignedInt "txData": xsd:unsignedLong "rxData": xsd:unsignedLong "digestErr": xsd:unsignedLong "timeoutErr": xsd:unsignedLong "connectionState": xsd:unsignedInt "sessionState": xsd:unsignedInt }
osn:targetPort
Represents a network port which could be a bonded port, VLAN, VIF, or physical port. (note, the term targetPort was used rather than networkPort due to QuantaStor's initial focus on the iSCSI protocol in early versions. The type name targetPort is retained for backward compatibility.)
Inherits From osn:object
Fields
{ "description": xsd:string "gateway": xsd:string "macAddress": xsd:string "ipAddress": xsd:string "configType": xsd:string "isVlan": xsd:boolean "vlanId": xsd:unsignedInt "vlanQos": xsd:unsignedInt "isVirtualPort": xsd:boolean "isVirtualInterface": xsd:boolean "iscsiEnabled": xsd:boolean "stopFloating": xsd:boolean "parentPort": xsd:string "model": xsd:string "subnetMask": xsd:string "vendor": xsd:string "linkState": xsd:unsignedInt "speedMbSec": xsd:unsignedInt "mtu": xsd:unsignedInt "bytesRx": xsd:unsignedLong "bytesTx": xsd:unsignedLong "bytesCounterOffsetRx": xsd:unsignedLong "bytesCounterOffsetTx": xsd:unsignedLong "errorsRx": xsd:unsignedLong "errorsTx": xsd:unsignedLong "droppedRx": xsd:unsignedLong "droppedTx": xsd:unsignedLong "overrunsRx": xsd:unsignedLong "overrunsTx": xsd:unsignedLong "collisions": xsd:unsignedLong "bondMode": xsd:unsignedInt "objectGatewayEnabled": xsd:boolean "onBootDisabled": xsd:boolean "firewallMask": xsd:unsignedInt - Disable bit mask for protocols (NFS,SMB etc) based on qs_services_firewall.conf. "firewallForceAllowMask": xsd:unsignedInt "bondStatus": xsd:string "permanentMacAddress": xsd:string "partnerMacAddress": xsd:string "childPortList": osn:targetPort "virtualInterfaceAssocList": osn:virtualInterfaceAssoc }
osn:task
task object contains information about the progress of a given task and may be monitored via #taskGet
Inherits From osn:object
Fields
{ "startTimeStamp": xsd:dateTime "finishTimeStamp": xsd:dateTime "progress": xsd:unsignedInt "taskState": xsd:unsignedInt "description": xsd:string - description of the Backup Policy "parentId": xsd:string "operation": xsd:string "objectType": xsd:string "clientIpAddress": xsd:string "i18nDescription": osn:i18nString "errorMessage": osn:errorMessage "retainState": xsd:unsignedInt }
osn:timeZone
Fields
{ "countryCode": xsd:string "tz": xsd:string "comments": xsd:string }
osn:traceLevel
Contains information about the debug tracing configuration of the QuantaStor service
Inherits From osn:object
Fields
{ "traceLevel": xsd:unsignedInt "stdOut": xsd:boolean "traceFilterList": xsd:string "traceOptionsList": xsd:string "eventVerboseFilterList": xsd:string }
osn:user
A management user account within a QuantaStor storage grid.
Inherits From osn:subject
Fields
{ "password": xsd:string "roleId": xsd:string "firstName": xsd:string "lastName": xsd:string "emailAddress": xsd:string "defaultChapUsername": xsd:string "defaultChapPassword": xsd:string "posixUid": xsd:unsignedInt "posixGid": xsd:unsignedInt "alertSubscriptions": xsd:unsignedInt "jwtToken": xsd:string "passwordToken": xsd:string "passwordModifiedTimeStamp": xsd:dateTime "isExpired": xsd:boolean "isLocked": xsd:boolean "recentlyUsedPasswordTokens": xsd:string "allowRootCliTokenAuth": xsd:boolean "accountType": xsd:unsignedInt "terminateTimeStamp": xsd:dateTime "failedLoginAttempts": xsd:unsignedInt "lastSuccessfulLoginTimeStamp": xsd:dateTime "wuiTabDisable": xsd:unsignedInt "wuiSectionDisable": xsd:unsignedInt "enableMultiFactorAuth": xsd:boolean "multiFactorAuthConfigId": xsd:string "passwordTokenAlg": xsd:unsignedInt "isLdapUser": xsd:boolean "customPermissionList": osn:userPermissionAssignment "userAppTokenIdList": xsd:string }
osn:userAppToken
Security token associated with a #osn:providerApp
Inherits From osn:object
Fields
{ "providerAppId": xsd:string "userId": xsd:string "appKey": xsd:string "appAccessToken": xsd:string "isReadOnly": xsd:boolean "tokenExpires": xsd:dateTime "tokenFileName": xsd:string "appAccessMode": xsd:unsignedInt "nodeSystemId": xsd:string }
osn:userGroup
A group of one or more users. Also maps to a posix group with the specified GID.
Inherits From osn:subject
Fields
{ "posixGid": xsd:unsignedInt }
osn:userGroupAssoc
Fields
{ "userGroupId": xsd:string "userId": xsd:string }
osn:virtualInterfaceAssoc
Inherits From osn:nodeAssoc
Fields
{ "virtualInterfacePortId": xsd:string "targetPortId": xsd:string }
Enum Definitions
enum:accessKeyType
Used by the osn__s3UserAccessKey type to indicate the type of the key
Enumeration Values
OSN_ACCESSKEY_TYPE_S3: 0 OSN_ACCESSKEY_TYPE_SWIFT: 1 OSN_ACCESSKEY_TYPE_MAX: 2
enum:accessType
Access mode for a given Storage Volume with read-write as the default
Enumeration Values
OSN_CMN_ACCESSTYPE_READWRITE: 0 OSN_CMN_ACCESSTYPE_READONLY: 1 OSN_CMN_ACCESSTYPE_NONE: 2
enum:aclType
Enumeration Values
OSN_ACL_TYPE_POSIX: 0 OSN_ACL_TYPE_OFF: 1
enum:activeDirSearchStatus
Enumeration Values
OSN_CMN_AD_STAT_SUCCESS: 0 OSN_CMN_AD_STAT_TOO_MANY_HITS: 1 OSN_CMN_AD_STAT_NOT_FOUND: 2
enum:alertHandlerWebhookType
Enumeration Values
OSN_ALERTHANDLER_WEBHOOK_SLACK: 0 OSN_ALERTHANDLER_WEBHOOK_MATTERMOST: 1
enum:alertSubscription
Enumeration Values
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
enum:arpFilterMode
Enumeration Values
OSN_ARP_FILTER_MODE_AUTO: 0 OSN_ARP_FILTER_MODE_ENABLED: 1 OSN_ARP_FILTER_MODE_DISABLED: 2 OSN_ARP_FILTER_MODE_MAX: 3
enum:arpFilterStatus
Enumeration Values
OSN_ARP_FILTERING_ENABLED: 0 OSN_ARP_FILTERING_DISABLED: 1
enum:backupJobStage
Enumeration Values
OSN_CMN_BACKUP_STAGE_INITIALIZING: 0 OSN_CMN_BACKUP_STAGE_SCANNING: 1 OSN_CMN_BACKUP_STAGE_COPYING: 2 OSN_CMN_BACKUP_STAGE_PURGING: 3 OSN_CMN_BACKUP_STAGE_COMPLETED: 4 OSN_CMN_BACKUP_STAGE_FAILED: 5
enum:backupPolicyMountType
Enumeration Values
OSN_CMN_BACKUP_POLICY_MOUNT_NFS: 0 OSN_CMN_BACKUP_POLICY_MOUNT_CEPHFS: 1 OSN_CMN_BACKUP_POLICY_MOUNT_OCFS2: 2 OSN_CMN_BACKUP_POLICY_MOUNT_CIFS: 3 OSN_CMN_BACKUP_POLICY_MOUNT_CLOUD_CONTAINER: 4
enum:backupPolicyRetentionCriteria
Enumeration Values
OSN_CMN_BACKUP_POLICY_RETENTION_ACCESS_TIME: 1 OSN_CMN_BACKUP_POLICY_RETENTION_MODIFY_TIME: 2 OSN_CMN_BACKUP_POLICY_RETENTION_CREATE_TIME: 4
enum:backupPolicyType
Enumeration Values
OSN_CMN_BACKUP_POLICY_TYPE_COPY_INBOUND: 0 OSN_CMN_BACKUP_POLICY_TYPE_COPY_OUTBOUND: 1 OSN_CMN_BACKUP_POLICY_TYPE_MOVE_INBOUND: 2 OSN_CMN_BACKUP_POLICY_TYPE_MOVE_OUTBOUND: 3 OSN_CMN_BACKUP_POLICY_TYPE_MAX: 4
enum:backupPurgePolicy
Enumeration Values
OSN_CMN_BACKUP_PURGE_POLICY_NEVER: 0 OSN_CMN_BACKUP_PURGE_POLICY_AFTER_BACKUP: 1 OSN_CMN_BACKUP_PURGE_POLICY_DAILY: 2 OSN_CMN_BACKUP_PURGE_POLICY_WEEKLY: 3 OSN_CMN_BACKUP_PURGE_POLICY_MAX: 4
enum:blinkReason
Reason for why a given storage media device beacon is ON.
Enumeration Values
OSN_CMN_BLINKREASON_UNKNOWN: 0 OSN_CMN_BLINKREASON_MANUAL: 1 OSN_CMN_BLINKREASON_SPD_FAULT: 2 OSN_CMN_BLINKREASON_PD_FAULT: 4 OSN_CMN_BLINKREASON_HWD_FAULT: 8 OSN_CMN_BLINKREASON_OSD_FAULT: 16 OSN_CMN_BLINKREASON_BRICK_FAULT: 32 OSN_CMN_BLINKREASON_OTHER: 64
enum:blinkType
Enumeration Values
OSN_CMN_BLINK_ON: 0 OSN_CMN_BLINK_OFF: 1
enum:bondMode
Enumeration Values
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_ALB: 6 OSN_BOND_MODE_LACP_LAYER34: 65540 OSN_BOND_MODE_ERROR: 65544 OSN_BOND_MODE_MAX: 65552
enum:bucketAclType
Enumeration Values
OSN_BUCKETACL_PRIVATE: 0 OSN_BUCKETACL_PUBLIC_READ: 1 OSN_BUCKETACL_PUBLIC_READ_WRITE: 2 OSN_BUCKETACL_AUTH_READ: 3
enum:bucketObjectLockMode
Enumeration Values
OSN_BUCKET_OBJECTLOCK_DISABLED: 0 OSN_BUCKET_OBJECTLOCK_NONE: 1 OSN_BUCKET_OBJECTLOCK_GOVERNANCE: 2 OSN_BUCKET_OBJECTLOCK_COMPLIANCE: 3
enum:bucketType
Enumeration Values
OSN_BUCKET_TYPE_CEPH: 0 OSN_BUCKET_TYPE_MINIO: 1 OSN_BUCKET_TYPE_AMAZON: 2 OSN_BUCKET_TYPE_AZURE: 3 OSN_BUCKET_TYPE_GOOGLE: 4 OSN_BUCKET_TYPE_IBM_CLOUD: 5 OSN_BUCKET_TYPE_MAX: 6
enum:cacheType
Cache type, typcially for hardware controlelrs (see hwController)
Enumeration Values
OSN_CMN_ACCESSTYPE_WRITETHRU: 0 OSN_CMN_ACCESSTYPE_WRITEBACK: 1
enum:capabilityValType
Enumeration Values
OSN_CAPABILITY_VAL_TYPE_SET: 0 OSN_CAPABILITY_VAL_TYPE_RANGE: 1
enum:cephClusterAuthMode
Enumeration Values
OSN_CEPH_AUTH_MODE_CEPHX: 0 OSN_CEPH_AUTH_MODE_NONE: 1
enum:cephCrushDeviceClass
Enumeration Values
OSN_CEPH_CRUSH_DEVICE_CLASS_HDD: 0 OSN_CEPH_CRUSH_DEVICE_CLASS_SSD: 1 OSN_CEPH_CRUSH_DEVICE_CLASS_NVME: 2
enum:cephCrushRuleType
Enumeration Values
OSN_CEPH_CRUSH_RULE_REPLICATED: 1 OSN_CEPH_CRUSH_RULE_ERASURE_CODED: 3
enum:cephECPlugin
Enumeration Values
OSN_CEPH_EC_PLUGIN_JERASURE: 0 OSN_CEPH_EC_PLUGIN_ISA: 1 OSN_CEPH_EC_PLUGIN_LRC: 2 OSN_CEPH_EC_PLUGIN_SHEC: 3
enum:cephECTechnique
Enumeration Values
OSN_CEPH_EC_TECHNIQUE_REED_SOL_VAN: 0 OSN_CEPH_EC_TECHNIQUE_REED_SOL_R6_OP: 1 OSN_CEPH_EC_TECHNIQUE_CAUCHY_ORIG: 2 OSN_CEPH_EC_TECHNIQUE_CAUCHY_GOOD: 3 OSN_CEPH_EC_TECHNIQUE_LIBERATION: 4 OSN_CEPH_EC_TECHNIQUE_BLAUM_ROTH: 5 OSN_CEPH_EC_TECHNIQUE_LIBER_8_TION: 6
enum:cephFailureDomain
Enumeration Values
OSN_CEPH_FAILURE_DOMAIN_OSD: 0 OSN_CEPH_FAILURE_DOMAIN_HOST: 1 OSN_CEPH_FAILURE_DOMAIN_RACK: 2 OSN_CEPH_FAILURE_DOMAIN_CHASSIS: 3 OSN_CEPH_FAILURE_DOMAIN_DATACENTER: 4
enum:cephJournalGroupType
Enumeration Values
OSN_CMN_CEPH_JOURNAL_DEVICE_PARTITION: 0 OSN_CMN_CEPH_JOURNAL_ENTIRE_DEVICE: 1 OSN_CMN_CEPH_JOURNAL_POOL_FILE: 2 OSN_CMN_CEPH_JOURNAL_LVM_VOLUME: 3
enum:cephJournalMode
Enumeration Values
OSN_CMN_CEPH_JOURNAL_MODE_UNUSED: 0 OSN_CMN_CEPH_JOURNAL_MODE_LEGACY_JOURNAL: 1 OSN_CMN_CEPH_JOURNAL_MODE_WAL: 2 OSN_CMN_CEPH_JOURNAL_MODE_DB: 4 OSN_CMN_CEPH_JOURNAL_MODE_UNKNOWN: 65535
enum:cephMonOsdSubtreeLimit
Enumeration Values
OSN_CEPH_MON_OSDSUBTREELIMIT_HOST: 0 OSN_CEPH_MON_OSDSUBTREELIMIT_RACK: 1 OSN_CEPH_MON_OSDSUBTREELIMIT_MAX: 2
enum:cephOsdType
Enumeration Values
OSN_CMN_FLAG_CEPH_OSD_LEGACY_FILESTORE: 0 OSN_CMN_FLAG_CEPH_OSD_BLUESTORE: 1 OSN_CMN_FLAG_CEPH_OSD_AUTO_SELECT: 15 OSN_CMN_FLAG_CEPH_OSD_UNKNOWN: 65535
enum:cephOsdWeightPolicy
Enumeration Values
OSN_CMN_CEPH_WEIGHT_POLICY_LEGACY: 0 OSN_CMN_CEPH_WEIGHT_POLICY_BY_SIZE: 1
enum:cephUseCase
Enumeration Values
OSN_CEPH_USE_CASE_RGW: 0 OSN_CEPH_USE_CASE_RGW_OPENSTACK: 1 OSN_CEPH_USE_CASE_FILESYSTEM: 2
enum:cephUserAccessOpMask
Enumeration Values
OSN_USER_ACCESS_OPMASK_NONE: 0 OSN_USER_ACCESS_OPMASK_READ: 1 OSN_USER_ACCESS_OPMASK_WRITE: 2 OSN_USER_ACCESS_OPMASK_DELETE: 4 OSN_USER_ACCESS_OPMASK_MAX: 8
enum:chapPolicy
Enumeration Values
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
enum:cifsUserAccessMode
Access mode for a given SMB/CIFS user or user group access entry.
Enumeration Values
OSN_CMN_CIFS_USER_ACCESS_NONE: 0 OSN_CMN_CIFS_USER_ACCESS_VALID: 1 OSN_CMN_CIFS_USER_ACCESS_ADMIN: 2 OSN_CMN_CIFS_USER_ACCESS_INVALID: 3
enum:cloudContainerCacheMode
Enumeration Values
OSN_CLOUD_CONTAINER_CACHE_MODE_DEFAULT: 0 OSN_CLOUD_CONTAINER_CACHE_MODE_OFF: 1 OSN_CLOUD_CONTAINER_CACHE_MODE_MIN: 2 OSN_CLOUD_CONTAINER_CACHE_MODE_WRITES: 3 OSN_CLOUD_CONTAINER_CACHE_MODE_FULL: 4
enum:cloudContainerType
Enumeration Values
OSN_CLOUD_CONTAINER_S3QL: 0 OSN_CLOUD_CONTAINER_S3FS: 1 OSN_CLOUD_CONTAINER_RCLONE: 2
enum:cloudProviderType
Enumeration Values
OSN_CLOUD_PROVIDER_AMAZON_S3: 0 OSN_CLOUD_PROVIDER_SFTP: 1 OSN_CLOUD_PROVIDER_GOOGLE: 2 OSN_CLOUD_PROVIDER_MICROSOFT_AZURE: 3 OSN_CLOUD_PROVIDER_OPENSTACK_SWIFT: 4 OSN_CLOUD_PROVIDER_DROPBOX: 5 OSN_CLOUD_PROVIDER_CEPH: 6 OSN_CLOUD_PROVIDER_IBMCOS: 7 OSN_CLOUD_PROVIDER_BACKBLAZE_B2: 8 OSN_CLOUD_PROVIDER_WASABI_S3: 9 OSN_CLOUD_PROVIDER_GOOGLE_DRIVE: 10
enum:consistencyCheck
Enumeration Values
OSN_CONSISTENCY_CHECK_NA: 0 OSN_CONSISTENCY_CHECK_UNVERIFIED: 1 OSN_CONSISTENCY_CHECK_VERIFIED: 2
enum:correlationDiskType
Enumeration Values
OSN_CORRELATIONDISKTYPE_UNKNOWN: 0 OSN_CORRELATIONDISKTYPE_HWUNIT: 1 OSN_CORRELATIONDISKTYPE_HWDISK: 2
enum:dataShredMode
Availble data shredding modes for format operations and pool destroy operations.
Enumeration Values
OSN_CMN_DATA_SHRED_MODE_DONT_SHRED: 0 OSN_CMN_DATA_SHRED_MODE_USARMY: 1 OSN_CMN_DATA_SHRED_MODE_DOD: 2 OSN_CMN_DATA_SHRED_MODE_NNSA: 3 OSN_CMN_DATA_SHRED_MODE_RANDOM: 4 OSN_CMN_DATA_SHRED_MODE_ZEROS: 5
enum:dataType
Enumeration Values
OSN_CMN_DATATYPE_STRING: 0 OSN_CMN_DATATYPE_INT: 1 OSN_CMN_DATATYPE_TIME: 2 OSN_CMN_DATATYPE_FLOAT: 3 OSN_CMN_DATATYPE_MAX: 4
enum:daysOfWeekMask
Enumeration Values
OSN_CMN_DAY_SUNDAY: 1 OSN_CMN_DAY_MONDAY: 2 OSN_CMN_DAY_TUESDAY: 4 OSN_CMN_DAY_WEDNESDAY: 8 OSN_CMN_DAY_THURSDAY: 16 OSN_CMN_DAY_FRIDAY: 32 OSN_CMN_DAY_SATURDAY: 64
enum:dfsNamespaceModeType
Indicates now Network Share Namespaces should present shares over CIFS/SMB where FLAT indicates no grouping and GROUPED indicates that the shares should be grouped under an export named after the Network Share Namespace.
Enumeration Values
OSN_CMN_DFS_NAMESPACE_MODE_GROUPED: 0 OSN_CMN_DFS_NAMESPACE_MODE_FLAT: 1 OSN_CMN_DFS_NAMESPACE_MODE_DISABLED: 2
enum:diskCategory
Enumeration Values
OSN_DISKCAT_ANY: 0 OSN_DISKCAT_HDD: 1 OSN_DISKCAT_SSD: 2
enum:diskSmrZoningType
Enumeration Values
OSN_DISKSMRZONINGTYPE_NONE: 0 OSN_DISKSMRZONINGTYPE_DEVICE_MANAGED: 1 OSN_DISKSMRZONINGTYPE_HOST_MANAGED: 2
enum:diskStateDetail
Enumeration Values
OSN_CMN_DISKSTATEDETAIL_UNKNOWN: 0 OSN_CMN_DISKSTATEDETAIL_SPD_FAULT: 1 OSN_CMN_DISKSTATEDETAIL_TEMPERATURE: 2 OSN_CMN_DISKSTATEDETAIL_HEALTH: 4 OSN_CMN_DISKSTATEDETAIL_PREDICTIVE_FAILURE: 8 OSN_CMN_DISKSTATEDETAIL_MEDIA_ERROR_COUNT: 16 OSN_CMN_DISKSTATEDETAIL_OTHER: 32
enum:diskType
Enumeration Values
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_SAS: 8 OSN_DISKTYPE_PMEM: 9 OSN_DISKTYPE_NVME: 10
enum:enterMaintenanceModeMask
Enumeration Values
OSN_MAINTENANCE_MODE_ENTER_ALL: 0 OSN_MAINTENANCE_MODE_CEPH_ENTER: 2 OSN_MAINTENANCE_MODE_COROSYNC_ENTER: 4
enum:errorLevel
Enumeration Values
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
enum:ethPortNaming
Ethernet port naming convention to be used for naming ethernet ports in a given system. Can be ethN based (eg eth0) or use the newer Linux predictable naming conventions (eg ens0).
Enumeration Values
OSN_CMN_ETHPORT_NAMING_NOCHANGE: 0 OSN_CMN_ETHPORT_NAMING_LEGACY_ETH: 1 OSN_CMN_ETHPORT_NAMING_PREDICTABLE: 2
enum:eventListenerMode
Enumeration Values
OSN_CMN_LISTENERMODE_ENQUEUE: 0 OSN_CMN_LISTENERMODE_PROCESS: 1 OSN_CMN_LISTENERMODE_FLUSH: 2
enum:eventListenerType
Enumeration Values
OSN_CMN_LISTENERTYPE_OBSERVER: 0 OSN_CMN_LISTENERTYPE_SECONDARY: 1 OSN_CMN_LISTENERTYPE_PRIMARY: 2
enum:eventType
Enumeration Values
OSN_CMN_EVENTTYPE_ADD: 0 OSN_CMN_EVENTTYPE_REMOVE: 1 OSN_CMN_EVENTTYPE_MODIFY: 2
enum:exitMaintenanceModeMask
Enumeration Values
OSN_MAINTENANCE_MODE_CEPH_EXIT: 1 OSN_MAINTENANCE_MODE_COROSYNC_EXIT: 3 OSN_MAINTENANCE_MODE_CLEAR_ALL: 65535
enum:failoverReason
Enumeration Values
OSN_CMN_FAILOVERREASON_UNKNOWN: 0 OSN_CMN_FAILOVERREASON_MANUAL: 1 OSN_CMN_FAILOVERREASON_AUTO: 2 OSN_CMN_FAILOVERREASON_OTHER: 3
enum:fipsState
Enumeration Values
OSN_FIPS_STATE_DISABLED: 0 OSN_FIPS_STATE_ENABLED_VERIFIED: 1 OSN_FIPS_STATE_ENABLED_NOT_COMPLIANT: 2
enum:flags
Enumeration Values
OSN_CMN_FLAG_NONE: 0 OSN_CMN_FLAG_ASYNC: 1 OSN_CMN_FLAG_FORCE: 2 OSN_CMN_FLAG_RESCAN: 4 OSN_CMN_FLAG_GENERATE_NAME: 8 OSN_CMN_FLAG_SYNC_PRIMARY: 16 OSN_CMN_FLAG_SYNC_SECONDARY: 32 OSN_CMN_FLAG_REDIRECT: 64 OSN_CMN_FLAG_SUPPRESS_ALARMS: 128 OSN_CMN_FLAG_STOP_VERIFY: 256 OSN_CMN_FLAG_USE_GUID_IQN: 512 OSN_CMN_FLAG_EXPORT: 1024 OSN_CMN_FLAG_RESCUE_MODE: 2048 OSN_CMN_FLAG_START_REPAIR: 4096 OSN_CMN_FLAG_SPARES_ONLY: 8192 OSN_CMN_FLAG_LAZY: 16384 OSN_CMN_FLAG_SW_CONTROLLER: 32768 OSN_CMN_FLAG_WAIT_FOR_SIGNAL: 65536 OSN_CMN_FLAG_MINIMAL: 131072 OSN_CMN_FLAG_RECURSIVE: 262144 OSN_CMN_FLAG_FREE_UNUSED_LUNS: 524288 OSN_CMN_FLAG_INSECURE: 1048576 OSN_CMN_FLAG_VASA_SUPPORT: 2097152 OSN_CMN_FLAG_METADATA: 4194304 OSN_CMN_FLAG_NORMALIZE: 8388608 OSN_CMN_FLAG_FORGET: 16777216 OSN_CMN_FLAG_MAX: 16777216
enum:haClientConnectivityPolicy
Storage Pool HA groups an be configured to check client connectivity. If enabled a pool may be moved/failover if a majority of the specified client IPs are not responding to ping from the current pool owher but is responding to the alternate/secondary node.
Enumeration Values
OSN_CMN_HA_CLIENT_FAILOVER_DISABLED: 0 OSN_CMN_HA_CLIENT_FAILOVER_IF_NO_MAJORITY: 1 OSN_CMN_HA_CLIENT_FAILOVER_IF_NO_RESPONSE: 2 OSN_CMN_HA_CLIENT_FAILOVER_MAX: 3
enum:haLinkStateFailoverPolicy
Policy for when to initiate an HA failover of a pool based ethernet port link state of the ports which have HA VIFs associated with the pool
Enumeration Values
OSN_CMN_HA_LINKSTATE_FAILOVER_IF_ALL_LINKDOWN: 0 OSN_CMN_HA_LINKSTATE_FAILOVER_IF_MAJORITY_LINKDOWN: 1 OSN_CMN_HA_LINKSTATE_FAILOVER_IF_ANY_LINKDOWN: 2 OSN_CMN_HA_LINKSTATE_FAILOVER_IGNORE_LINKDOWN: 3 OSN_CMN_HA_LINKSTATE_FAILOVER_FAILOVER_MAX: 4
enum:hostType
Enumeration Values
OSN_HOSTTYPE_UNKNOWN: 0 OSN_HOSTTYPE_AIX: 1 OSN_HOSTTYPE_HPUX: 2 OSN_HOSTTYPE_LINUX: 3 OSN_HOSTTYPE_SOLARIS: 4 OSN_HOSTTYPE_VMWARE: 5 OSN_HOSTTYPE_WINDOWS: 6 OSN_HOSTTYPE_XENSERVER: 7 OSN_HOSTTYPE_OTHER: 8 OSN_HOSTTYPE_MAC: 9 OSN_HOSTTYPE_MAX: 10
enum:hotsparePoolRepairPolicy
Enumeration Values
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
enum:hotsparePoolRepairState
Enumeration Values
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
enum:hwAutoMaintenanceMask
Enumeration Values
OSN_HW_AUTO_MAINTENANCE_NONE: 0 OSN_HW_AUTO_MAINTENANCE_ENABLED_POOL: 1 OSN_HW_AUTO_MAINTENANCE_ENABLED_OSD: 2 OSN_HW_AUTO_MAINTENANCE_ENABLED_MAX: 4
enum:hwCachePolicy
Caching mode options for hardware controlelrs (see hwController)
Enumeration Values
OSN_HWCACHE_UNKNOWN: 0 OSN_HWCACHE_READAHEAD: 1 OSN_HWCACHE_NOREADAHEAD: 2 OSN_HWCACHE_WRITEBACK: 4 OSN_HWCACHE_ALWAYSWRITEBACK: 8 OSN_HWCACHE_WRITETHROUGH: 16 OSN_HWCACHE_CACHED: 32 OSN_HWCACHE_DIRECT: 64
enum:hwControllerCapabilities
Enumeration Values
HW_CONTROLLER_API_NONE: 0 HW_CONTROLLER_API_RESCAN: 1 HW_CONTROLLER_API_CREATE_UNIT: 2 HW_CONTROLLER_API_GROW_UNIT: 4 HW_CONTROLLER_API_GROW_UNIT_ADV_STRIPE: 8 HW_CONTROLLER_API_GROW_UNIT_ADV_PRIORITY: 16 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 HW_CONTROLLER_API_DISK_PASSTHRU: 512 HW_CONTROLLER_API_SUPPORTS_RAID: 1024 HW_CONTROLLER_API_SUPPORTS_JBOD: 2048
enum:hwDiskCapabilities
Enumeration Values
HW_DISK_API_NONE: 0 HW_DISK_API_MARK_HOT_SPARE: 1 HW_DISK_API_IDENTIFY: 2 HW_DISK_API_REMOVE_DISK: 4 HW_DISK_API_SUPPORTS_ENCRYPTION: 8
enum:hwEnclosureLayoutFlow
Enumeration Values
OSN_ENCLOSURELAYOUT_FLOW_T2B_L2R: 0 OSN_ENCLOSURELAYOUT_FLOW_T2B_R2L: 1 OSN_ENCLOSURELAYOUT_FLOW_B2T_L2R: 2 OSN_ENCLOSURELAYOUT_FLOW_B2T_R2L: 3 OSN_ENCLOSURELAYOUT_FLOW_R2L_T2B: 4 OSN_ENCLOSURELAYOUT_FLOW_R2L_B2T: 5 OSN_ENCLOSURELAYOUT_FLOW_L2R_T2B: 6 OSN_ENCLOSURELAYOUT_FLOW_L2R_B2T: 7
enum:hwEnclosureLayoutType
Enumeration Values
OSN_ENCLOSURETYPE_JBOD: 0 OSN_ENCLOSURETYPE_SERVER: 1 OSN_ENCLOSURETYPE_CLUSTER: 2 OSN_ENCLOSURETYPE_INTERNAL: 3 OSN_ENCLOSURETYPE_MAX: 4
enum:hwUnitCapabilities
Enumeration Values
HW_UNIT_API_NONE: 0 HW_UNIT_API_IDENTIFY: 1 HW_UNIT_API_DELETE: 2 HW_UNIT_API_SUPPORTS_ENCRYPTION: 8
enum:imageFileType
what type of data conversion required for a physicalDiskCopy
Enumeration Values
OSN_CMN_IMAGE_FILE_TYPE_RAW: 0 OSN_CMN_IMAGE_FILE_TYPE_QCOW: 1 OSN_CMN_IMAGE_FILE_TYPE_VMDK: 2 OSN_CMN_IMAGE_FILE_TYPE_VHD: 3
enum:initPriorityType
Enumeration Values
OSN_INITPRIORITY_DEFAULT: 0 OSN_INITPRIORITY_LOW: 1 OSN_INITPRIORITY_MEDIUM: 2 OSN_INITPRIORITY_HIGH: 3
enum:initiatorType
Enumeration Values
OSN_CMN_INITIATOR_ISCSI: 0 OSN_CMN_INITIATOR_FCP: 1 OSN_CMN_INITIATOR_IB: 2
enum:ipmiHealthState
Enumeration Values
OSN_IPMI_STATE_OK: 0 OSN_IPMI_STATE_NO_SENSOR: 1 OSN_IPMI_STATE_NON_CRITICAL: 2 OSN_IPMI_STATE_CRITICAL: 3 OSN_IPMI_STATE_NON_RECOVERABLE: 4 OSN_IPMI_STATE_OK_NOT_REDUNDANT: 5 OSN_IPMI_STATE_OK_NOT_DETECTED: 6
enum:keyType
Enumeration Values
OSN_KEY_TYPE_ALL: 0 OSN_KEY_TYPE_ROOT: 1 OSN_KEY_TYPE_DEK: 2
enum:keyVaultType
Enumeration Values
OSN_KEYVAULT_TYPE_DEFAULT: 0 OSN_KEYVAULT_TYPE_IBM_KEYPROTECT: 1
enum:licenseCategory
Enumeration Values
OSN_LICENSE_CATEGORY_SYSTEM: 0 OSN_LICENSE_CATEGORY_FEATURE: 1 OSN_LICENSE_CATEGORY_FEATURE_TERABYTES: 2 OSN_LICENSE_CATEGORY_FEATURE_VOLUMES: 3 OSN_LICENSE_CATEGORY_FEATURE_SNAPSHOTS: 4 OSN_LICENSE_CATEGORY_FEATURE_CLOUDS: 5 OSN_LICENSE_CATEGORY_FEATURE_NODES: 6 OSN_LICENSE_CATEGORY_FEATURE_USERS: 7 OSN_LICENSE_CATEGORY_FEATURE_SSD: 8 OSN_LICENSE_CATEGORY_FEATURE_REPLICATION: 9 OSN_LICENSE_CATEGORY_SUPPORT: 10
enum:licenseDuration
Enumeration Values
OSN_LICENSE_DURATION_PERPETUAL: 0 OSN_LICENSE_DURATION_TIMELIMITED: 1
enum:licenseEdition
Enumeration Values
OSN_LICENSE_EDITION_FREE: 0 OSN_LICENSE_EDITION_TRIAL: 1 OSN_LICENSE_EDITION_STANDARD: 2 OSN_LICENSE_EDITION_ENTERPRISE: 3 OSN_LICENSE_EDITION_PLATINUM: 4 OSN_LICENSE_EDITION_CLOUD: 5 OSN_LICENSE_EDITION_MIGRATION: 6
enum:licenseState
Enumeration Values
OSN_CMN_LICSTATE_NORMAL: 0 OSN_CMN_LICSTATE_WARNING: 1 OSN_CMN_LICSTATE_BUSY: 2 OSN_CMN_LICSTATE_ERROR: 3 OSN_CMN_LICSTATE_INITALIZING: 4 OSN_CMN_LICSTATE_MISSING: 5 OSN_CMN_LICSTATE_OFFLINE: 6 OSN_CMN_LICSTATE_RETIRED: 7
enum:licenseType
Enumeration Values
OSN_LICENSE_TYPE_NODE: 0 OSN_LICENSE_TYPE_VOLUME: 1 OSN_LICENSE_TYPE_SITE: 2
enum:linkState
Enumeration Values
OSN_CMN_LINKSTATE_UP: 0 OSN_CMN_LINKSTATE_DOWN: 1 OSN_CMN_LINKSTATE_UNKNOWN: 2 OSN_CMN_LINKSTATE_DISABLED: 3
enum:lockType
Enumeration Values
OSN_LOCK_SHARED: 0 OSN_LOCK_PROTECTED: 1 OSN_LOCK_EXCLUSIVE: 2
enum:logCollectionMode
Enumeration Values
OSN_LOG_COLLECTION_NEVER: 0 OSN_LOG_COLLECTION_WEEKLY: 1 OSN_LOG_COLLECTION_BIWEEKLY: 2 OSN_LOG_COLLECTION_MONTHLY: 3 OSN_LOG_COLLECTION_MAX: 4
enum:lunAssignmentPolicy
LUN numbers for iSCSI are all 0 but for FC they're dynamically assigned unless the mode is set to static.
Enumeration Values
OSN_CMN_LUN_ASSIGN_DYNAMIC: 0 OSN_CMN_LUN_ASSIGN_STATIC: 1
enum:managerClass
Enumeration Values
OSN_MANAGERCLASS_NONE: 0 OSN_MANAGERCLASS_ALUACONFIG: 1 OSN_MANAGERCLASS_BLINK: 2 OSN_MANAGERCLASS_CEPH: 3 OSN_MANAGERCLASS_DISK: 4 OSN_MANAGERCLASS_FABRIC: 5 OSN_MANAGERCLASS_FIREWALL: 6 OSN_MANAGERCLASS_DEPRECATED_7: 7 OSN_MANAGERCLASS_GRIDSYNC: 8 OSN_MANAGERCLASS_HACONNECTIVITY: 9 OSN_MANAGERCLASS_HAFAILOVER: 10 OSN_MANAGERCLASS_HARDWARE: 11 OSN_MANAGERCLASS_HOTSPARE: 12 OSN_MANAGERCLASS_INFINIBAND: 13 OSN_MANAGERCLASS_LIBRATO: 14 OSN_MANAGERCLASS_POOL: 15 OSN_MANAGERCLASS_REPLICATION: 16 OSN_MANAGERCLASS_SHARENAMESPACE: 17 OSN_MANAGERCLASS_SMART: 18 OSN_MANAGERCLASS_STATS: 19 OSN_MANAGERCLASS_TARGETPORT: 20 OSN_MANAGERCLASS_MAX: 21
enum:memoryEccType
Enumeration Values
OSN_CMN_MEMORY_ECC_TYPE_UNKNOWN: 0 OSN_CMN_MEMORY_ECC_TYPE_SINGLEBIT: 1 OSN_CMN_MEMORY_ECC_TYPE_NONE: 2
enum:modifyType
Some APIs for adding and removing entries (ex: hostGroupAddRemove) have a mode specifier to indicate what should be done with the specified entries. Add and Remove modes add or remove the specified entries whereas the Set mode will add the specified entries if not already added and remove any not specified in the set.
Enumeration Values
OSN_CMN_MOD_OP_ADD: 0 OSN_CMN_MOD_OP_REMOVE: 1 OSN_CMN_MOD_OP_SET: 2
enum:multiFactorAuthMode
Selected mode for a given login to indicate MFA method
Enumeration Values
OSN_CMN_MFA_MODE_NONE: 0 OSN_CMN_MFA_MODE_PUSH: 1 OSN_CMN_MFA_MODE_SMS: 2 OSN_CMN_MFA_MODE_PHONE: 3 OSN_CMN_MFA_MODE_TOKEN: 4 OSN_CMN_MFA_MODE_PROMPT: 5 OSN_CMN_MFA_MODE_MAX: 6
enum:multiFactorAuthProvider
Supported multi-factor athentication providers
Enumeration Values
OSN_CMN_MFA_PROVIDER_NONE: 0 OSN_CMN_MFA_PROVIDER_DUO: 1 OSN_CMN_MFA_PROVIDER_GOOGLE: 2
enum:multiFactorAuthStatus
Status of a MFA login
Enumeration Values
OSN_CMN_MFA_STATUS_NONE: 0 OSN_CMN_MFA_STATUS_PENDING: 1 OSN_CMN_MFA_STATUS_RUNNING: 2 OSN_CMN_MFA_STATUS_SUCCESS: 3 OSN_CMN_MFA_STATUS_FAIL: 4 OSN_CMN_MFA_STATUS_DENY: 5 OSN_CMN_MFA_STATUS_ERR: 6 OSN_CMN_MFA_STATUS_ENROLL: 7 OSN_CMN_MFA_STATUS_SENT: 8
enum:multipathConfigMode
Enumeration Values
OSN_MULTIPATH_AUTOCONFIG_DISABLED: 0 OSN_MULTIPATH_AUTOCONFIG_ENABLED: 1 OSN_MULTIPATH_AUTOCONFIG_DISABLE_AND_CLEAR_CONFIG: 2 OSN_MULTIPATH_AUTOCONFIG_MAX: 3
Enumeration Values
OSN_CMN_FILE_ACCESS_TYPE_READONLY: 0 OSN_CMN_FILE_ACCESS_TYPE_READWRITE: 1
Enumeration Values
OSN_CMN_FILE_OPLOCK_TYPE_NONE: 0 OSN_CMN_FILE_OPLOCK_TYPE_LEVEL_II: 1 OSN_CMN_FILE_OPLOCK_TYPE_LEASE: 2 OSN_CMN_FILE_OPLOCK_TYPE_EXCLUSIVE: 3 OSN_CMN_FILE_OPLOCK_TYPE_UNKNOWN: 4
Network Share session type, either NFS or SMB (see networkShareSessionEnum)
Enumeration Values
OSN_CMN_SHARE_SESSION_SMB: 0 OSN_CMN_SHARE_SESSION_NFS: 1
Enumeration Values
OSN_NETWORKSHARETYPE_STANDARD: 0 OSN_NETWORKSHARETYPE_SUBVOL_BTRFS: 1 OSN_NETWORKSHARETYPE_CLOUD: 2 OSN_NETWORKSHARETYPE_SUBVOL_ZFS: 3 OSN_NETWORKSHARETYPE_DEPRECATED_4: 4 OSN_NETWORKSHARETYPE_ALIAS: 5 OSN_NETWORKSHARETYPE_SUBSHARE: 6 OSN_NETWORKSHARETYPE_CEPHFS: 7
enum:nfsKerberosMode
Indicates how export entries should be formatted to support kerberos when it is enabled.
Enumeration Values
OSN_CMN_NFS_KRB5I: 0 OSN_CMN_NFS_KRB5P: 1 OSN_CMN_NFS_KRB5: 2
enum:nfsNamespaceModeType
Indicates now Network Share Namespaces should present shares over NFS where FLAT indicates no grouping and GROUPED indicates that the shares should be grouped under an export named after the Network Share Namespace. For NFS only FLAT mode is currently supported.
Enumeration Values
OSN_CMN_NFS_NAMESPACE_MODE_FLAT: 0 OSN_CMN_NFS_NAMESPACE_MODE_GROUPED: 1 OSN_CMN_NFS_NAMESPACE_MODE_DISABLED: 2
enum:nfsServiceMode
NFSv3 mode actually supports bo th v3 and v4 at the same time whereas v4 mode makes v4 exclusive.
Enumeration Values
OSN_CMN_NFS_MODE_V3: 0 OSN_CMN_NFS_MODE_V4: 1 OSN_CMN_NFS_MODE_GANESHA: 2
enum:objectState
Enumeration Values
OSN_CMN_OBJSTATE_NORMAL: 0 OSN_CMN_OBJSTATE_WARNING: 1 OSN_CMN_OBJSTATE_BUSY: 2 OSN_CMN_OBJSTATE_ERROR: 3 OSN_CMN_OBJSTATE_INITIALIZING: 4 OSN_CMN_OBJSTATE_MISSING: 5 OSN_CMN_OBJSTATE_OFFLINE: 6 OSN_CMN_OBJSTATE_DISCONNECTED: 7 OSN_CMN_OBJSTATE_PAUSED: 8 OSN_CMN_OBJSTATE_READY: 9
enum:objectType
Enumeration Values
OSN_CMN_OBJECTTYPE_UNKNOWN: 0 OSN_CMN_OBJECTTYPE_SNAPSHOT_SCHEDULE: 1 OSN_CMN_OBJECTTYPE_SNAPSHOT_SCHEDULE_ASSOC: 2 OSN_CMN_OBJECTTYPE_STORAGE_VOLUME: 3 OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_UTILIZATION: 4 OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_GROUP: 5 OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_GROUP_ASSOC: 6 OSN_CMN_OBJECTTYPE_STORAGE_POOL: 7 OSN_CMN_OBJECTTYPE_STORAGE_POOL_DEVICE: 8 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM: 9 OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_ACL: 10 OSN_CMN_OBJECTTYPE_HOST: 11 OSN_CMN_OBJECTTYPE_HOST_GROUP: 12 OSN_CMN_OBJECTTYPE_INITIATOR_PORT: 13 OSN_CMN_OBJECTTYPE_TARGET_PORT: 14 OSN_CMN_OBJECTTYPE_PHYSICAL_DISK: 15 OSN_CMN_OBJECTTYPE_TASK: 16 OSN_CMN_OBJECTTYPE_AUDIT_ENTRY: 17 OSN_CMN_OBJECTTYPE_AUDIT_SETTINGS: 18 OSN_CMN_OBJECTTYPE_ALERT: 19 OSN_CMN_OBJECTTYPE_ALERT_CONFIG_SETTINGS: 20 OSN_CMN_OBJECTTYPE_LICENSE: 21 OSN_CMN_OBJECTTYPE_LICENSE_ACTIVATION: 22 OSN_CMN_OBJECTTYPE_USER: 23 OSN_CMN_OBJECTTYPE_USER_PERMISSION_ASSIGNMENT: 24 OSN_CMN_OBJECTTYPE_USER_GROUP: 25 OSN_CMN_OBJECTTYPE_USER_GROUP_ASSOC: 26 OSN_CMN_OBJECTTYPE_ROLE: 27 OSN_CMN_OBJECTTYPE_ROLE_PERMISSION_ASSIGNMENT: 28 OSN_CMN_OBJECTTYPE_ROLE_SUBJECT_ASSOC: 29 OSN_CMN_OBJECTTYPE_PERMISSION_DEFINITION: 30 OSN_CMN_OBJECTTYPE_STORAGE_CLOUD: 31 OSN_CMN_OBJECTTYPE_STORAGE_CLOUD_ASSOC: 32 OSN_CMN_OBJECTTYPE_STORAGE_CLOUD_SUBJECT_ASSOC: 33 OSN_CMN_OBJECTTYPE_SESSION: 34 OSN_CMN_OBJECTTYPE_STORAGE_TIER: 35 OSN_CMN_OBJECTTYPE_STORAGE_TIER_ASSOC: 36 OSN_CMN_OBJECTTYPE_STORAGE_QUOTA: 37 OSN_CMN_OBJECTTYPE_STORAGE_QUOTA_ASSOC: 38 OSN_CMN_OBJECTTYPE_ACL: 39 OSN_CMN_OBJECTTYPE_OBJECT_PROPERTY: 40 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_LINK: 41 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_GROUP: 42 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_GROUP_ASSOC: 43 OSN_CMN_OBJECTTYPE_REPLICA_ASSOC: 44 OSN_CMN_OBJECTTYPE_PHYSICAL_DISK_PATH_ASSOC: 45 OSN_CMN_OBJECTTYPE_HW_ALARM: 46 OSN_CMN_OBJECTTYPE_HW_BBU: 47 OSN_CMN_OBJECTTYPE_HW_DISK: 48 OSN_CMN_OBJECTTYPE_HW_UNIT: 49 OSN_CMN_OBJECTTYPE_HW_ENCLOSURE: 50 OSN_CMN_OBJECTTYPE_HW_CONTROLLER: 51 OSN_CMN_OBJECTTYPE_HW_CONTROLLER_GROUP: 52 OSN_CMN_OBJECTTYPE_NETWORK_SHARE: 53 OSN_CMN_OBJECTTYPE_NETWORK_SHARE_CLIENT: 54 OSN_CMN_OBJECTTYPE_REPLICATION_SCHEDULE: 55 OSN_CMN_OBJECTTYPE_REPLICATION_SCHEDULE_ASSOC: 56 OSN_CMN_OBJECTTYPE_HW_LOGICAL_DRIVE: 57 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_RECOVERY_POINT: 58 OSN_CMN_OBJECTTYPE_CLOUD_CONTAINER: 59 OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER: 60 OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER_CREDENTIALS: 61 OSN_CMN_OBJECTTYPE_CLOUD_BACKUP_SCHEDULE: 62 OSN_CMN_OBJECTTYPE_CLOUD_BACKUP_SCHEDULE_ASSOC: 63 OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER_LOCATION: 64 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_CLUSTER: 65 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_CLUSTER_ASSOC: 66 OSN_CMN_OBJECTTYPE_CLUSTER_FAILOVER_GROUP: 67 OSN_CMN_OBJECTTYPE_FC_TARGET_PORT: 68 OSN_CMN_OBJECTTYPE_NETWORK_SHARE_SERVICE_CONFIG: 69 OSN_CMN_OBJECTTYPE_WIDGET: 70 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_LINK_KEY: 71 OSN_CMN_OBJECTTYPE_STORAGE_POOL_PROFILE: 72 OSN_CMN_OBJECTTYPE_STORAGE_QUOTA_SHARE_ASSOC: 73 OSN_CMN_OBJECTTYPE_SITE_CLUSTER: 74 OSN_CMN_OBJECTTYPE_SITE_CLUSTER_ASSOC: 75 OSN_CMN_OBJECTTYPE_VIRTUAL_INTERFACE_ASSOC: 76 OSN_CMN_OBJECTTYPE_IB_TARGET_PORT: 77 OSN_CMN_OBJECTTYPE_HW_SWITCH_CREDENTIALS: 78 OSN_CMN_OBJECTTYPE_HW_SWITCH: 79 OSN_CMN_OBJECTTYPE_HW_SWITCH_ZONESET: 80 OSN_CMN_OBJECTTYPE_HW_SWITCH_ADAPTER: 81 OSN_CMN_OBJECTTYPE_HW_SWITCH_FAILOVER_GROUP: 82 OSN_CMN_OBJECTTYPE_HW_SWITCH_FAILOVER_GROUP_POOL_ASSOC: 83 OSN_CMN_OBJECTTYPE_HW_SWITCH_FAILOVER_GROUP_SYSTEM_ASSOC: 84 OSN_CMN_OBJECTTYPE_HW_SWITCH_CREDENTIALS_SYSTEM_ASSOC: 85 OSN_CMN_OBJECTTYPE_LIBRATO_METRICS_CONFIG: 86 OSN_CMN_OBJECTTYPE_STORAGE_POOL_REPLICATION_CONFIG: 87 OSN_CMN_OBJECTTYPE_DEPRECATED_88: 88 OSN_CMN_OBJECTTYPE_DEPRECATED_89: 89 OSN_CMN_OBJECTTYPE_DEPRECATED_90: 90 OSN_CMN_OBJECTTYPE_NETWORK_SHARE_USER_ACCESS: 91 OSN_CMN_OBJECTTYPE_NETWORK_SHARE_CIFS_OPTION: 92 OSN_CMN_OBJECTTYPE_ALERT_TRIGGER: 93 OSN_CMN_OBJECTTYPE_HW_ENCLOSURE_LAYOUT: 94 OSN_CMN_OBJECTTYPE_HW_UNIT_DISK_ASSOC: 95 OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_GROUP: 96 OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_INTERFACE: 97 OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_MODULE: 98 OSN_CMN_OBJECTTYPE_BACKUP_POLICY: 99 OSN_CMN_OBJECTTYPE_BACKUP_JOB: 100 OSN_CMN_OBJECTTYPE_DEPRECATED_91: 101 OSN_CMN_OBJECTTYPE_CEPH_POOL: 102 OSN_CMN_OBJECTTYPE_CEPH_OSD: 103 OSN_CMN_OBJECTTYPE_CEPH_POOL_OSD_ASSOC: 104 OSN_CMN_OBJECTTYPE_CEPH_CLUSTER: 105 OSN_CMN_OBJECTTYPE_CEPH_MONITOR: 106 OSN_CMN_OBJECTTYPE_CEPH_HA_FAILOVER_INTERFACE: 107 OSN_CMN_OBJECTTYPE_CEPH_BLOCK_DEVICE: 108 OSN_CMN_OBJECTTYPE_PHYSICAL_DISK_HOTSPARE_MARKER: 109 OSN_CMN_OBJECTTYPE_SITE_VIF_RESOURCE: 110 OSN_CMN_OBJECTTYPE_CLUSTER_RING: 111 OSN_CMN_OBJECTTYPE_CLUSTER_RING_MEMBER: 112 OSN_CMN_OBJECTTYPE_CEPH_CLUSTER_MEMBER: 113 OSN_CMN_OBJECTTYPE_SW_CONTROLLER: 114 OSN_CMN_OBJECTTYPE_SW_CONTROLLER_GROUP: 115 OSN_CMN_OBJECTTYPE_SW_CONTROLLER_TARGET: 116 OSN_CMN_OBJECTTYPE_SW_DISK_SESSION: 117 OSN_CMN_OBJECTTYPE_QOS_POLICY: 118 OSN_CMN_OBJECTTYPE_CEPH_PG_SET: 119 OSN_CMN_OBJECTTYPE_CEPH_JOURNAL_DEVICE: 120 OSN_CMN_OBJECTTYPE_RESOURCE_DOMAIN: 121 OSN_CMN_OBJECTTYPE_CEPH_OBJECT_POOL_GROUP: 122 OSN_CMN_OBJECTTYPE_S3_USER: 123 OSN_CMN_OBJECTTYPE_RESOURCE_DOMAIN_ASSOC: 124 OSN_CMN_OBJECTTYPE_NETWORK_SHARE_NAMESPACE: 125 OSN_CMN_OBJECTTYPE_NETWORK_SHARE_NAMESPACE_SYSTEM_ASSOC: 126 OSN_CMN_OBJECTTYPE_NETWORK_SHARE_NAMESPACE_SHARE_ASSOC: 127 OSN_CMN_OBJECTTYPE_CEPH_POOL_PROFILE: 128 OSN_CMN_OBJECTTYPE_NETWORK_SHARE_SESSION: 129 OSN_CMN_OBJECTTYPE_PASSWORD_POLICY: 130 OSN_CMN_OBJECTTYPE_MULTIPATH_CONFIG: 131 OSN_CMN_OBJECTTYPE_REPLICA_REPORT_ENTRY: 132 OSN_CMN_OBJECTTYPE_REPLICA_REPORT_SUMMARY: 133 OSN_CMN_OBJECTTYPE_STORAGE_POOL_DEVICE_GROUP: 134 OSN_CMN_OBJECTTYPE_NETWORK_SHARE_FILE_LOCK: 135 OSN_CMN_OBJECTTYPE_MULTIFACTORAUTH_CONFIG: 136 OSN_CMN_OBJECTTYPE_PROVIDER_APP: 137 OSN_CMN_OBJECTTYPE_USER_APP_TOKEN: 138 OSN_CMN_OBJECTTYPE_ALERT_TYPE: 139 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_HW_CONFIG: 140 OSN_CMN_OBJECTTYPE_MULTIFACTORAUTH_DEVICE: 141 OSN_CMN_OBJECTTYPE_CEPH_RADOS_GATEWAY: 142 OSN_CMN_OBJECTTYPE_CEPH_CRUSH_RULE: 143 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_TUNABLE: 144 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_TUNABLE_PROFILE: 145 OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_TUNABLE_ASSOC: 146 OSN_CMN_OBJECTTYPE_CEPH_FILESYSTEM: 147 OSN_CMN_OBJECTTYPE_CEPH_FILESYSTEM_POOL_ASSOC: 148 OSN_CMN_OBJECTTYPE_CEPH_METADATA_SERVER: 149 OSN_CMN_OBJECTTYPE_SERVICE_FIREWALL_DEF: 150 OSN_CMN_OBJECTTYPE_KEYVAULT_PROFILE: 151 OSN_CMN_OBJECTTYPE_KEYVAULT_MODULE: 152 OSN_CMN_OBJECTTYPE_KEYINFO: 153 OSN_CMN_OBJECTTYPE_BUCKET: 154 OSN_CMN_OBJECTTYPE_S3_QUOTA: 155 OSN_CMN_OBJECTTYPE_BUCKET_OBJECT: 156 OSN_CMN_OBJECTTYPE_BUCKET_USER_ASSOC: 157 OSN_CMN_OBJECTTYPE_SNAPSHOT_REFERENCE: 158 OSN_CMN_OBJECTTYPE_S3_USER_ACCESS_KEY: 159 OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_PROFILE: 160 OSN_CMN_OBJECTTYPE_S3_PROXY: 161 OSN_CMN_OBJECTTYPE_CEPH_JOURNAL_GROUP: 162 OSN_CMN_OBJECTTYPE_HW_ENCLOSURE_LAYOUT_VENDOR_GROUP: 163 OSN_CMN_OBJECTTYPE_SCRUB_SCHEDULE: 164 OSN_CMN_OBJECTTYPE_SCRUB_SCHEDULE_ASSOC: 165 OSN_CMN_OBJECTTYPE_SINGLE_SIGN_ON_POLICY: 166 OSN_CMN_OBJECTTYPE_REPORT_SCHEDULE: 167 OSN_CMN_OBJECTTYPE_REPORT_SCHEDULE_ASSOC: 168 OSN_CMN_OBJECTTYPE_REPORT: 169 OSN_CMN_OBJECTTYPE_CLOUD_CONTAINER_CACHE_SETTINGS: 170 OSN_CMN_OBJECTTYPE_MAX: 171
enum:passwordComplexityReq
Password complexity policy for management user accounts. Standard mode or higher is required for NIST compliance.
Enumeration Values
OSN_PW_COMPLEXITY_WEAK: 0 OSN_PW_COMPLEXITY_STANDARD: 1 OSN_PW_COMPLEXITY_STRONG: 2
enum:permissionScope
Enumeration Values
OSN_SCOPE_NONE: 0 OSN_SCOPE_USER: 1 OSN_SCOPE_STORAGE_CLOUD: 2 OSN_SCOPE_SYSTEM: 3 OSN_SCOPE_GRID: 4
enum:poolEnclosureRedundancy
Relationship between a storage pool and how the data is striped across disks based on which disk enclosure the disk resides in . Pool creation automatically analyzes this relationship and will select drives to ensure enclosure level reduncancy whenever possible.
Enumeration Values
OSN_CMN_POOL_ENCLOSURE_REDUNDANCY_UNKNOWN: 0 OSN_CMN_POOL_ENCLOSURE_REDUNDANCY_VERIFIED: 1 OSN_CMN_POOL_ENCLOSURE_NOT_REDUNDANT: 2 OSN_CMN_POOL_ENCLOSURE_REDUNDANCY_NA: 3 OSN_CMN_POOL_ENCLOSURE_REDUNDANCY_PARTIAL: 4
enum:protocolDisable
Enumeration Values
OSN_PROTOCOL_NONE_DISABLE: 0 OSN_PROTOCOL_NFS_DISABLE: 1 OSN_PROTOCOL_SMB_DISABLE: 2 OSN_PROTOCOL_GANESHA_DISABLE: 4 OSN_PROTOCOL_RESTAPI_DISABLE: 8 OSN_PROTOCOL_ISCSI_DISABLE: 16 OSN_PROTOCOL_CEPH_DISABLE: 32 OSN_PROTOCOL_WEBUI_DISABLE: 64
enum:providerRegistrationScope
Enumeration Values
OSN_REGISTRATION_SCOPE_LOCAL: 0 OSN_REGISTRATION_SCOPE_CLUSTER_WIDE: 1
enum:providerType
Enumeration Values
OSN_PROVIDER_TYPE_NONE: 0 OSN_PROVIDER_TYPE_VMWARE_VASA: 1
enum:quotaPolicy
Enumeration Values
OSN_CMN_QUOTA_POLICY_SOFT: 0 OSN_CMN_QUOTA_POLICY_HARD: 1
enum:quotaSubjectType
Enumeration Values
OSN_QUOTA_SUBJECT_POSIX_USER: 0 OSN_QUOTA_SUBJECT_POSIX_GROUP: 1 OSN_QUOTA_SUBJECT_AD_USER: 2 OSN_QUOTA_SUBJECT_AD_GROUP: 3
enum:raidType
Enumeration Values
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_MULTIPLE: 17 OSN_RAIDTYPE_ERASURECODING: 18 OSN_RAIDTYPE_REPLICA: 19 OSN_RAIDTYPE_MAX: 20
enum:remoteReplicaFlags
Enumeration Values
OSN_CMN_REPLICA_FLAG_NONE: 0 OSN_CMN_REPLICA_FLAG_SOURCE: 1 OSN_CMN_REPLICA_FLAG_TARGET: 2 OSN_CMN_REPLICA_FLAG_SOURCE_AND_TARGET: 3
enum:replicaAssocType
Enumeration Values
OSN_CMN_REPLICA_CHILD: 0 OSN_CMN_REPLICA_HEAD: 1
enum:replicaRetentionTag
Enumeration Values
OSN_CMN_REPLICATION_RETENTION_TAG_NONE: 0 OSN_CMN_REPLICATION_RETENTION_TAG_DELTA: 1 OSN_CMN_REPLICATION_RETENTION_TAG_DAILY: 2 OSN_CMN_REPLICATION_RETENTION_TAG_WEEKLY: 4 OSN_CMN_REPLICATION_RETENTION_TAG_BIWEEKLY: 8 OSN_CMN_REPLICATION_RETENTION_TAG_MONTHLY: 16 OSN_CMN_REPLICATION_RETENTION_TAG_BIMONTHLY: 32 OSN_CMN_REPLICATION_RETENTION_TAG_QUARTERLY: 64 OSN_CMN_REPLICATION_RETENTION_TAG_YEARLY: 128 OSN_CMN_REPLICATION_RETENTION_TAG_HOURLY: 256
enum:replicationActionType
Enumeration Values
OSN_CMN_REPLICATION_SETUP: 0 OSN_CMN_REPLICATION_CONNECT: 1 OSN_CMN_REPLICATION_DISCONNECT: 2 OSN_CMN_REPLICATION_RECONNECT: 3 OSN_CMN_REPLICATION_ADJUST: 4
enum:replicationCongestionPolicy
Enumeration Values
OSN_CMN_REPLICATION_CONGESTION_POLICY_SYNC: 0 OSN_CMN_REPLICATION_CONGESTION_POLICY_PULL_AHEAD: 1
enum:replicationState
Enumeration Values
OSN_CMN_REPLICATION_STATE_PREPARING: 0 OSN_CMN_REPLICATION_STATE_INITIALIZING: 1 OSN_CMN_REPLICATION_STATE_SYNCHRONIZING: 2 OSN_CMN_REPLICATION_STATE_SYNCHRONIZED: 3 OSN_CMN_REPLICATION_STATE_RESYNCHRONIZING: 4 OSN_CMN_REPLICATION_STATE_PAUSED: 5 OSN_CMN_REPLICATION_STATE_INIT_FAILED: 6 OSN_CMN_REPLICATION_STATE_SYNC_FAILED: 7 OSN_CMN_REPLICATION_STATE_RESYNC_FAILED: 8 OSN_CMN_REPLICATION_STATE_SKIPPED: 9
enum:reportCategory
Configuration analysis reports have each report entry marked with one or more categories via bitmask
Enumeration Values
OSN_CMN_REPORT_CATEGORY_ALL: 0 OSN_CMN_REPORT_CATEGORY_NETWORKING: 1 OSN_CMN_REPORT_CATEGORY_HIGH_AVAILABILITY: 2 OSN_CMN_REPORT_CATEGORY_REMOTE_REPLICATION: 4 OSN_CMN_REPORT_CATEGORY_SECURITY: 8 OSN_CMN_REPORT_CATEGORY_PLATFORM: 16 OSN_CMN_REPORT_CATEGORY_HARDWARE_MAINTENANCE: 32 OSN_CMN_REPORT_CATEGORY_MAX: 64
enum:reportImpact
type of impact the reported issue may have if not addressed
Enumeration Values
OSN_CMN_REPORT_IMPACT_ALL: 0 OSN_CMN_REPORT_IMPACT_STABILITY: 1 OSN_CMN_REPORT_IMPACT_PERFORMANCE: 2 OSN_CMN_REPORT_IMPACT_SECURITY: 4 OSN_CMN_REPORT_IMPACT_MAX: 8
enum:reportOutputFormat
Enumeration Values
OSN_CMN_REPORT_OUTPUT_FORMAT_TEXT: 0 OSN_CMN_REPORT_OUTPUT_FORMAT_HTML: 1 OSN_CMN_REPORT_OUTPUT_FORMAT_CSV: 2
enum:reportSeverity
Severity of the detected issue
Enumeration Values
OSN_CMN_REPORT_SEVERITY_INFORMATIONAL: 0 OSN_CMN_REPORT_SEVERITY_MINOR: 1 OSN_CMN_REPORT_SEVERITY_MAJOR: 2 OSN_CMN_REPORT_SEVERITY_CRITICAL: 4 OSN_CMN_REPORT_SEVERITY_MAX: 8
enum:reportTypes
Enumeration Values
OSN_REPORT_TYPE_NONE: 0 OSN_REPORT_TYPE_SYSTEM_HEALTH: 1 OSN_REPORT_TYPE_STORAGE_POOL_CAPACITY_PLANNING: 2 OSN_REPORT_TYPE_STORAGE_POOL_USAGE: 4 OSN_REPORT_TYPE_MAX: 8
enum:resourceAccessMode
Enumeration Values
OSN_CMN_RESOURCEACCESS_AUTO: 0 OSN_CMN_RESOURCEACCESS_MULTIGROUP_SHARED: 1 OSN_CMN_RESOURCEACCESS_GROUP_EXCLUSIVE: 2 OSN_CMN_RESOURCEACCESS_IMMUTABLE: 4 OSN_CMN_RESOURCEACCESS_MULTIGROUP_SHARED_IMMUTABLE: 5 OSN_CMN_RESOURCEACCESS_GROUP_EXCLUSIVE_IMMUTABLE: 6
enum:resourceAccessRequestType
Enumeration Values
OSN_CMN_REQUEST_VIEW: 0 OSN_CMN_REQUEST_UTILIZE: 1 OSN_CMN_REQUEST_MODIFY: 2
enum:resourceDomainTypes
Specifies the type of resource in a resource domain hierarchy
Enumeration Values
OSN_RESOURCE_DOMAIN_REGION: 0 OSN_RESOURCE_DOMAIN_SITE: 1 OSN_RESOURCE_DOMAIN_BUILDING: 2 OSN_RESOURCE_DOMAIN_RACK: 3 OSN_RESOURCE_DOMAIN_SERVER: 4 OSN_RESOURCE_DOMAIN_MAX: 5
enum:retentionTag
Enumeration Values
OSN_RETENTIONTAG_NONE: 0 OSN_RETENTIONTAG_DAY: 1 OSN_RETENTIONTAG_WEEK: 2 OSN_RETENTIONTAG_MONTH: 4 OSN_RETENTIONTAG_YEARLY: 8 OSN_RETENTIONTAG_MAX: 9
enum:s3QuotaScope
Enumeration Values
OSN_S3_QUOTA_SCOPE_ALL: 0 OSN_S3_QUOTA_SCOPE_BUCKET: 1 OSN_S3_QUOTA_SCOPE_USER: 2 OSN_S3_QUOTA_SCOPE_USER_BUCKET: 3
enum:sambaIdmapMode
Mode for how SMB user and group IDs should be managed.
Enumeration Values
OSN_CMN_SAMBA_IDMAP_TDB: 0 OSN_CMN_SAMBA_IDMAP_RID: 1 OSN_CMN_SAMBA_IDMAP_AD: 2 OSN_CMN_SAMBA_IDMAP_AUTORID: 4 OSN_CMN_SAMBA_IDMAP_AD_RFC2307: 8
enum:scheduleTimerType
Enumeration Values
OSN_SCHEDULE_TIMER_CALENDAR_BASED: 0 OSN_SCHEDULE_TIMER_INTERVAL_BASED: 1 OSN_SCHEDULE_TIMER_MAX: 2
enum:securityWebAccessMode
HTTP requests are redirected to HTTPS by default but his allows one to reconfigure that behavior.
Enumeration Values
OSN_CMN_WEBACCESSMODE_HTTP_ENABLED: 0 OSN_CMN_WEBACCESSMODE_HTTP_DISABLED: 1 OSN_CMN_WEBACCESSMODE_HTTP_REDIRECTED: 2
enum:serviceUpdateMode
Enumeration Values
OSN_SERVICE_OP_MODE_START: 0 OSN_SERVICE_OP_MODE_RESTART: 1 OSN_SERVICE_OP_MODE_STOP: 3
Enumeration Values
OSN_SHARE_INHERITS_NONE: 0 OSN_SHARE_INHERITS_CIFS_ACCESS: 1 OSN_SHARE_INHERITS_NFS_ACCESS: 2
enum:sourceType
type of source device for a physicalDiskCopy
Enumeration Values
OSN_CMN_SOURCETYPE_PHYSICAL_DISK: 0 OSN_CMN_SOURCETYPE_STORAGE_VOLUME: 1
enum:storagePoolCacheType
Enumeration Values
OSN_STORAGEPOOLCACHETYPE_READCACHE: 1 OSN_STORAGEPOOLCACHETYPE_WRITELOG: 2 OSN_STORAGEPOOLCACHETYPE_DEDUP: 3 OSN_STORAGEPOOLCACHETYPE_SPECIAL: 4 OSN_STORAGEPOOLCACHETYPE_MAX: 5
enum:storagePoolType
Enumeration Values
OSN_STORAGEPOOLTYPE_BTRFS: 0 OSN_STORAGEPOOLTYPE_EXT3: 1 OSN_STORAGEPOOLTYPE_EXT4: 2 OSN_STORAGEPOOLTYPE_XFS: 3 OSN_STORAGEPOOLTYPE_S3QL: 4 OSN_STORAGEPOOLTYPE_JFS: 5 OSN_STORAGEPOOLTYPE_ZFS: 6 OSN_STORAGEPOOLTYPE_CEPH: 7 OSN_STORAGEPOOLTYPE_SWAP: 8 OSN_STORAGEPOOLTYPE_PASSTHRU: 9 OSN_STORAGEPOOLTYPE_LOCAL: 10 OSN_STORAGEPOOLTYPE_UNKNOWN: 11 OSN_STORAGEPOOLTYPE_CEPHFS: 12 OSN_STORAGEPOOLTYPE_CEPHOBJ: 13 OSN_STORAGEPOOLTYPE_MAX: 14
enum:storageSystemLinkType
Indicates the mode which the storage replication link is operating in which can be with or without encryption and/or compression
Enumeration Values
OSN_LINK_TYPE_ENCRYPT_UNCOMP: 0 OSN_LINK_TYPE_UNENCRYPT_UNCOMP: 1 OSN_LINK_TYPE_ENCRYPT_COMP: 2 OSN_LINK_TYPE_UENCRYPT_COMP: 3
enum:storageVolumeType
Enumeration Values
OSN_STORAGEVOLUMETYPE_FILE: 0 OSN_STORAGEVOLUMETYPE_FILE_BTRFS: 1 OSN_STORAGEVOLUMETYPE_FILE_EXT3: 2 OSN_STORAGEVOLUMETYPE_FILE_EXT4: 3 OSN_STORAGEVOLUMETYPE_RAW_DEVICE: 4 OSN_STORAGEVOLUMETYPE_FILE_ZFS: 5 OSN_STORAGEVOLUMETYPE_FILE_XFS: 6 OSN_STORAGEVOLUMETYPE_FILE_S3QL: 7 OSN_STORAGEVOLUMETYPE_FILE_JFS: 8 OSN_STORAGEVOLUMETYPE_CEPH_RBD: 9
enum:swControllerConnectionState
Enumeration Values
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_UNKNOWN: 0 OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_FREE: 1 OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_TRANSPORT_WAIT: 2 OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_IN_LOGIN: 3 OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_LOGGED_IN: 4 OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_IN_LOGOUT: 5 OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_LOGOUT_REQUESTED: 6 OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_CLEANUP_WAIT: 7 OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_MAX: 8
enum:swControllerSessionState
Enumeration Values
OSN_CMN_SW_CONTROLLER_SESSION_STATE_UNKNOWN: 0 OSN_CMN_SW_CONTROLLER_SESSION_STATE_NO_CHANGE: 1 OSN_CMN_SW_CONTROLLER_SESSION_STATE_CLEANUP: 2 OSN_CMN_SW_CONTROLLER_SESSION_STATE_REOPEN: 3 OSN_CMN_SW_CONTROLLER_SESSION_STATE_REDIRECT: 4 OSN_CMN_SW_CONTROLLER_SESSION_STATE_MAX: 5
enum:swControllerType
type of protocol used by software controller connecting target device to initiator
Enumeration Values
OSN_CMN_SW_CONTROLLER_TYPE_ISCSI: 0 OSN_CMN_SW_CONTROLLER_TYPE_NVME_TCP: 1 OSN_CMN_SW_CONTROLLER_TYPE_NVME_RDMA: 2
enum:syncPolicy
Data synchronization mode for ZFS based Storage Pools, Network Shares, and Storage Volumes
Enumeration Values
OSN_CMN_SYNCTYPE_STANDARD: 0 OSN_CMN_SYNCTYPE_ALWAYS: 1 OSN_CMN_SYNCTYPE_DISABLED: 2 OSN_CMN_SYNCTYPE_AUTO: 3
enum:targetType
type of target device for a physicalDiskCopy
Enumeration Values
OSN_CMN_TARGETTYPE_PHYSICAL_DISK: 0 OSN_CMN_TARGETTYPE_STORAGE_VOLUME: 1 OSN_CMN_TARGETTYPE_NETWORK_SHARE: 2
enum:taskState
Enumeration Values
OSN_TASKSTATE_INITIALIZING: 0 OSN_TASKSTATE_QUEUED: 1 OSN_TASKSTATE_RUNNING: 2 OSN_TASKSTATE_FAILED: 3 OSN_TASKSTATE_CANCELLED: 4 OSN_TASKSTATE_COMPLETED: 5 OSN_TASKSTATE_WAITING: 6 OSN_TASKSTATE_RECOVERED: 7 OSN_TASKSTATE_STAGED: 8
enum:trimStatus
Enumeration Values
OSN_CMN_MEDIA_TRIM_UNSUPPORTED: 0 OSN_CMN_MEDIA_TRIM_UNTRIMMED: 1 OSN_CMN_MEDIA_TRIM_TRIMMING: 2 OSN_CMN_MEDIA_TRIM_TRIMMED: 3
enum:tunableDataType
storage system tunables are either a range, percentage or a boolean.
Enumeration Values
OSN_CMN_TUNABLE_RANGE: 0 OSN_CMN_TUNABLE_PERCENTAGE: 1 OSN_CMN_TUNABLE_BOOLEAN: 2
enum:tunableOption
applies to storageSystemTunable APIs
Enumeration Values
OSN_CMN_TUNABLE_NONE: 0 OSN_CMN_TUNABLE_RESET_TO_DEFAULTS: 1
enum:userAccountType
Enumeration Values
OSN_CMN_USER_ACCOUNT_STANDARD: 0 OSN_CMN_USER_ACCOUNT_EMERGENCY: 1 OSN_CMN_USER_ACCOUNT_TEMPORARY: 2
enum:userAppTokenAccessMode
Enumeration Values
OSN_APPTOKEN_DISABLED: 0 OSN_APPTOKEN_LOCAL_ONLY: 1 OSN_APPTOKEN_REMOTE_ONLY: 2 OSN_APPTOKEN_ALL: 3
enum:vdevType
Enumeration Values
OSN_VDEVTYPE_NA: 0 OSN_VDEVTYPE_DATA: 1 OSN_VDEVTYPE_LOGS: 2 OSN_VDEVTYPE_CACHE: 3 OSN_VDEVTYPE_SPARES: 4 OSN_VDEVTYPE_SPECIAL: 5 OSN_VDEVTYPE_DEDUP: 6 OSN_VDEVTYPE_CONFIG: 7 OSN_VDEVTYPE_MAX: 8
enum:vvolType
Enumeration Values
OSN_VVOL_TYPE_NONE: 0 OSN_VVOL_TYPE_SUBVOL_CONFIG: 1 OSN_VVOL_TYPE_SUBVOL_DATA: 2 OSN_VVOL_TYPE_SUBVOL_SWAP: 3 OSN_VVOL_TYPE_PE: 4
enum:wuiSectionDisable
Most expandable tree sections in the WUI may be disabled on a per user basis with the userModify method. This is helpful for simplifying the user experience for users with specific roles and job functions.
Enumeration Values
OSN_CMN_WUI_SECTION_DISABLE_NONE: 0 OSN_CMN_WUI_SECTION_DISABLE_INHERIT: 1 OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_PHYS_DISKS: 2 OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_HARDWARE: 4 OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_POOLS: 8 OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_SHARES: 16 OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_VOLUMES: 32 OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_SNAP_SCHED: 64 OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_HOSTS: 128 OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_BUCKETS: 256 OSN_CMN_WUI_SECTION_DISABLE_MAX: 512
enum:wuiTabDisable
Most tabs in the web management may be disabled on a per user basis using these options with the userModify method
Enumeration Values
OSN_CMN_WUI_TAB_DISABLE_NONE: 0 OSN_CMN_WUI_TAB_DISABLE_INHERIT: 1 OSN_CMN_WUI_TAB_DISABLE_STORAGE_MGMT: 2 OSN_CMN_WUI_TAB_DISABLE_USERS_GROUPS: 4 OSN_CMN_WUI_TAB_DISABLE_REMOTE_REPLICATION: 8 OSN_CMN_WUI_TAB_DISABLE_CLOUD_CONTAINERS: 16 OSN_CMN_WUI_TAB_DISABLE_CLUSTER_MGMT: 32 OSN_CMN_WUI_TAB_DISABLE_SCALE_OUT_NAS_MGMT: 64 OSN_CMN_WUI_TAB_DISABLE_SCALE_OUT_OBJ_MGMT: 128 OSN_CMN_WUI_TAB_DISABLE_MULTITENANCY: 256 OSN_CMN_WUI_TAB_DISABLE_GRID_DASHBOARD: 512 OSN_CMN_WUI_TAB_DISABLE_MAX: 1024