QuantaStor REST API Reference v4.2, v4.1

From OSNEXUS Wiki
Jump to: navigation, search

Contents

aclAdd API

Enables access to the specific volume for a specific user.

Argument List

   ownerId: <string>
   ownerType: <unsignedInt>
   objectId: <string>
   objectType: <unsignedInt>
   accessLevel: <unsignedInt>
   flags: <unsignedInt>

aclModify API

Modifies the current acl assignment.

Argument List

   ownerId: <string>
   ownerType: <unsignedInt>
   objectId: <string>
   objectType: <unsignedInt>
   accessLevel: <unsignedInt>
   flags: <unsignedInt>

aclRemove API

Removes the acl assignment.

Argument List

   ownerId: <string>
   ownerType: <unsignedInt>
   objectId: <string>
   objectType: <unsignedInt>
   flags: <unsignedInt>

activeDirectoryUserAndGroupEnum API

Argument List

   storageSystemId: <string>
   networkShareId: <string>
   groupFilter: <string>
   userFilter: <string>
   refreshCache: <boolean>
   flags: <unsignedInt>

alertClear API

Deletes the alert with the specified ID.

Argument List

   id: <string>
   flags: <unsignedInt>

alertClearAll API

Clears all the alerts.

Argument List

   flags: <unsignedInt>

alertConfigGet API

Alert configuration settings indicate where alert notifications should be sent.

Argument List

   flags: <unsignedInt>

alertConfigSet API

Sets the alert configuration settings such as the administrator email address.

Argument List

   senderEmailAddress: <string>
   smtpServerIpAddress: <string>
   smtpUsername: <string>
   smtpPassword: <string>
   smtpAuthType: <unsignedInt>
   customerSupportEmailAddress: <string>
   poolFreeSpaceWarningThreshold: <unsignedInt>
   poolFreeSpaceAlertThreshold: <unsignedInt>
   poolFreeSpaceCriticalAlertThreshold: <unsignedInt>
   pagerDutyServiceKey: <string>
   flags: <unsignedInt>

alertEnum API

Returns a list of all the alerts.

Argument List

   flags: <unsignedInt>

alertGet API

Gets information about a specific alert.

Argument List

   id: <string>
   flags: <unsignedInt>

alertRaise API

Allows one to raise a user generated alert for testing the SMTP server configuration settings.

Argument List

   message: <string>
   severity: <unsignedInt>
   flags: <unsignedInt>

auditLogClear API

Clears the audit log.

Argument List

   flags: <unsignedInt>

auditLogDisable API

Disables the audit log

Argument List

   flags: <unsignedInt>

auditLogEnable API

Enables the audit log.

Argument List

   flags: <unsignedInt>

auditLogGet API

Get an entry from the audit log.

Argument List

   user: <string>
   startDate: <dateTime>
   endDate: <dateTime>
   flags: <unsignedInt>

backupJobCancel API

Argument List

   backupJob: <string>
   flags: <unsignedInt>

backupJobEnum API

Argument List

   flags: <unsignedInt>

backupJobGet API

Argument List

   backupJob: <string>
   flags: <unsignedInt>

backupJobStart API

Argument List

   backupPolicy: <string>
   flags: <unsignedInt>

backupJobStatusUpdate API

Argument List

   statusXml: <string>
   flags: <unsignedInt>

backupPolicyCreate API

Argument List

   name: <string>
   description: <string>
   networkShareId: <string>
   remoteHostname: <string>
   remoteExportPath: <string>
   remoteMountType: <unsignedInt>
   daysOfWeek: <unsignedInt>
   hoursOfDay: <unsignedInt>
   retentionCriteria: <unsignedInt>
   startDate: <dateTime>
   policyType: <unsignedInt>
   scanThreads: <unsignedInt>
   retentionDays: <unsignedInt>
   purgePolicy: <unsignedInt>
   createBackupLogs: <boolean>
   backupToShareRoot: <boolean>
   setEnabled: <boolean>
   scheduleType: <unsignedInt>
   delayInterval: <unsignedInt>
   flags: <unsignedInt>

backupPolicyDelete API

Argument List

   backupPolicy: <string>
   flags: <unsignedInt>

backupPolicyDisable API

Argument List

   backupPolicy: <string>
   flags: <unsignedInt>

backupPolicyEnable API

Argument List

   backupPolicy: <string>
   flags: <unsignedInt>

backupPolicyEnum API

Argument List

   flags: <unsignedInt>

backupPolicyGet API

Argument List

   backupPolicy: <string>
   flags: <unsignedInt>

backupPolicyModify API

Argument List

   backupPolicy: <string>
   name: <string>
   description: <string>
   networkShareId: <string>
   remoteHostname: <string>
   remoteExportPath: <string>
   remoteMountType: <unsignedInt>
   daysOfWeek: <unsignedInt>
   hoursOfDay: <unsignedInt>
   retentionCriteria: <unsignedInt>
   startDate: <dateTime>
   policyType: <unsignedInt>
   scanThreads: <unsignedInt>
   retentionDays: <unsignedInt>
   purgePolicy: <unsignedInt>
   createBackupLogs: <boolean>
   backupToShareRoot: <boolean>
   setEnabled: <boolean>
   scheduleType: <unsignedInt>
   delayInterval: <unsignedInt>
   flags: <unsignedInt>

backupPolicyTrigger API

Argument List

   backupPolicy: <string>
   flags: <unsignedInt>

cephBlockDeviceCreate API

Argument List

   name: <string>
   description: <string>
   cephPoolId: <string>
   size: <unsignedLong>
   flags: <unsignedInt>

cephBlockDeviceDelete API

Argument List

   cephBlockDevice: <string>
   flags: <unsignedInt>

cephBlockDeviceEnum API

Argument List

   flags: <unsignedInt>

cephBlockDeviceGet API

Argument List

   cephBlockDevice: <string>
   flags: <unsignedInt>

cephBlockDeviceModify API

Argument List

   cephBlockDevice: <string>
   name: <string>
   description: <string>
   flags: <unsignedInt>

cephBlockDeviceResize API

Argument List

   cephBlockDevice: <string>
   size: <unsignedLong>
   flags: <unsignedInt>

cephBlockDeviceSnapshot API

Argument List

   cephBlockDevice: <string>
   snapshotName: <string>
   snapshotDescription: <string>
   flags: <unsignedInt>

cephClusterEnum API

Argument List

   flags: <unsignedInt>

cephClusterGet API

Argument List

   cephCluster: <string>
   flags: <unsignedInt>

cephHaFailoverInterfaceEnum API

Argument List

   flags: <unsignedInt>

cephHaFailoverInterfaceGet API

Argument List

   cephPoolId: <string>
   failoverInterfaceId: <string>
   flags: <unsignedInt>

cephMonitorEnum API

Argument List

   flags: <unsignedInt>

cephMonitorGet API

Argument List

   cephMonitor: <string>
   flags: <unsignedInt>

cephOsdCreate API

Argument List

   name: <string>
   description: <string>
   cephClusterId: <string>
   storagePoolId: <string>
   weight: <unsignedInt>
   flags: <unsignedInt>

cephOsdDelete API

Argument List

   cephOsd: <string>
   deleteData: <boolean>
   flags: <unsignedInt>

cephOsdEnum API

Argument List

   flags: <unsignedInt>

cephOsdGet API

Argument List

   cephOsd: <string>
   flags: <unsignedInt>

cephPoolCreate API

Argument List

   name: <string>
   description: <string>
   placementGroupCount: <unsignedInt>
   maxReplicaCount: <unsignedInt>
   minReplicaCount: <unsignedInt>
   cephPoolType: <string>
   storagePoolList: <string[]>
   flags: <unsignedInt>

cephPoolDelete API

Argument List

   cephPool: <string>
   flags: <unsignedInt>

cephPoolEnum API

Argument List

   flags: <unsignedInt>

cephPoolGet API

Argument List

   cephPool: <string>
   flags: <unsignedInt>

cephPoolModify API

Argument List

   cephPool: <string>
   name: <string>
   description: <string>
   flags: <unsignedInt>

cephPoolOsdAssocEnum API

Argument List

   cephPool: <string>
   flags: <unsignedInt>

cephPoolOsdAssocGet API

Argument List

   cephPool: <string>
   cephOsd: <string>
   flags: <unsignedInt>

cloudBackupScheduleAssocEnum API

List the cloud backup schedule associations.

Argument List

   schedule: <string>
   flags: <unsignedInt>

cloudBackupScheduleAssocGet API

Get a cloud backup schedule association.

Argument List

   scheduleId: <string>
   storageVolumeId: <string>

cloudBackupScheduleCreate API

Creates a new schedule to automate backups to a cloud backup container.

Argument List

   name: <string>
   description: <string>
   cloudContainerId: <string>
   priority: <unsignedInt>
   setEnabled: <unsignedInt>
   startDate: <dateTime>
   maxBackups: <unsignedInt>
   daysOfWeek: <unsignedInt>
   hoursOfDay: <unsignedInt>
   storageVolumeList: <string[]>
   scheduleType: <unsignedInt>
   delayInterval: <unsignedInt>
   flags: <unsignedInt>

cloudBackupScheduleDelete API

Deletes the specified cloud backup schedule.

Argument List

   schedule: <string>
   flags: <unsignedInt>

cloudBackupScheduleDisable API

Disables a cloud backup schedule so that it does not trigger backups.

Argument List

   schedule: <string>
   flags: <unsignedInt>

cloudBackupScheduleEnable API

Enables a cloud backup schedule that was previously disabled.

Argument List

   schedule: <string>
   flags: <unsignedInt>

cloudBackupScheduleEnum API

Lists all the cloud backup schedules in the system.

Argument List

   flags: <unsignedInt>

cloudBackupScheduleGet API

Gets detailed information about a specific cloud backup schedule.

Argument List

   schedule: <string>
   flags: <unsignedInt>

cloudBackupScheduleModify API

Modifies the settings for the specified cloud backup schedule.

Argument List

   schedule: <string>
   name: <string>
   description: <string>
   cloudContainerId: <string>
   setEnabled: <unsignedInt>
   startDate: <dateTime>
   maxBackups: <unsignedInt>
   daysOfWeek: <unsignedInt>
   hoursOfDay: <unsignedInt>
   scheduleType: <unsignedInt>
   delayInterval: <unsignedInt>
   flags: <unsignedInt>

cloudBackupScheduleTrigger API

Argument List

   schedule: <string>
   flags: <unsignedInt>

cloudBackupScheduleVolumeAddRemove API

Add/Remove storage volumes to an existing cloud backup schedule.

Argument List

   schedule: <string>
   modType: <unsignedInt>
   storageVolumeList: <string[]>
   flags: <unsignedInt>

cloudContainerAdd API

Recovers a cloud backup container that was previously removed or used with a prior installation.

Argument List

   credentialsId: <string>
   locationId: <string>
   encryptionKey: <string>
   storageUrl: <string>
   enableNfs: <boolean>
   flags: <unsignedInt>

cloudContainerCreate API

Creates a cloud backup container into which cloud backups of storage volumes can be made.

Argument List

   name: <string>
   description: <string>
   credentialsId: <string>
   locationId: <string>
   encryptionKey: <string>
   storageUrl: <string>
   enableNfs: <boolean>
   attachToStorageSystem: <string>
   flags: <unsignedInt>

cloudContainerDelete API

Deletes the specified cloud backup container. WARNING, all data in the container will be destroyed.

Argument List

   container: <string>
   flags: <unsignedInt>

cloudContainerDisable API

Disables access to the specified cloud container without having to remove it.

Argument List

   container: <string>
   flags: <unsignedInt>

cloudContainerEnable API

Enables a cloud container that was previously disabled or was inaccessible due to network connection issues.

Argument List

   container: <string>
   attachToStorageSystem: <string>
   flags: <unsignedInt>

cloudContainerEnum API

Returns a list of cloud backup containers in the system.

Argument List

   flags: <unsignedInt>

cloudContainerGet API

Returns detailed information on a specific cloud backup container.

Argument List

   container: <string>
   flags: <unsignedInt>

cloudContainerModify API

Modifies the specified cloud backup container settings.

Argument List

   container: <string>
   name: <string>
   description: <string>
   encryptionKey: <string>
   enableNfs: <boolean>
   flags: <unsignedInt>

cloudContainerRemove API

Removes the specified cloud backup container from the system but does not delete any backup data in the cloud.

Argument List

   container: <string>
   flags: <unsignedInt>

cloudContainerRepair API

Repairs the specified cloud backup container.

Argument List

   container: <string>
   flags: <unsignedInt>

cloudProviderCredentialsAdd API

Adds cloud provider credentials to enable cloud backup to cloud backup containers.

Argument List

   username: <string>
   password: <string>
   providerId: <string>
   machine: <string>
   flags: <unsignedInt>

cloudProviderCredentialsEnum API

Returns a list of all the cloud provider credentials in the system. Passwords are masked.

Argument List

   flags: <unsignedInt>

cloudProviderCredentialsGet API

Returns information about the specified cloud provider credential.

Argument List

   credentialId: <string>
   flags: <unsignedInt>

cloudProviderCredentialsRemove API

Removes the specified cloud provider credentials

Argument List

   credentialsId: <string>
   flags: <unsignedInt>

cloudProviderEnum API

Returns the list of supported cloud providers.

Argument List

   flags: <unsignedInt>

cloudProviderGet API

Returns detailed information about the specified cloud provider.

Argument List

   providerId: <string>
   flags: <unsignedInt>

cloudProviderLocationAdd API

Argument List

   providerId: <string>
   locationTag: <string>
   flags: <unsignedInt>

cloudProviderLocationEnum API

Argument List

   flags: <unsignedInt>

cloudProviderLocationGet API

Argument List

   locationId: <string>
   flags: <unsignedInt>

cloudProviderLocationRemove API

Argument List

   locationId: <string>
   flags: <unsignedInt>

clusterFailoverGroupActivate API

Activate the cluster fail over group.

Argument List

   clusterFailoverGroup: <string>
   storageSystemId: <string>
   flags: <unsignedInt>

clusterFailoverGroupCreate API

Creates a new management grid. A given storage system can only be a member of one grid at a time.

Argument List

   storageSystemCluster: <string>
   name: <string>
   description: <string>
   storagePool: <string>
   zoneConfig: <string>
   flags: <unsignedInt>

clusterFailoverGroupDelete API

Deletes the management grid. After the grid is deleted each node in the grid operates independently again.

Argument List

   clusterFailoverGroup: <string>
   flags: <unsignedInt>

clusterFailoverGroupEnum API

Returns a list of all the managed storage system nodes in the grid.

Argument List

   flags: <unsignedInt>

clusterFailoverGroupGet API

Get general information about the storage system management grid.

Argument List

   clusterFailoverGroup: <string>
   flags: <unsignedInt>

clusterFailoverGroupModify API

Modify the management grid properties.

Argument List

   clusterFailoverGroup: <string>
   name: <string>
   description: <string>
   storagePool: <string>
   zoneConfig: <string>
   flags: <unsignedInt>

customApi API

Argument List

   method: <string>
   params: <keyValuePair[]>
   flags: <unsignedInt>

echo API

Test method which pings the server with a simple string

Argument List

   inputMessage: <string>

eventEnum API

Returns a list of all the internal events in the event queue (used for service monitoring).

Argument List

   startingIndex: <unsignedInt>
   maxEvents: <unsignedInt>
   serviceTimeStamp: <dateTime>

eventListenerNotify API

Argument List

   storageSystemId: <string>
   list: <event[]>

eventListenerRegister API

Argument List

   eventListenerObj: <eventListener>

eventListenerUnregister API

Argument List

   listenerId: <string>

fcTargetPortDisable API

Disables the specified fiber channel port.

Argument List

   port: <string>
   flags: <unsignedInt>

fcTargetPortEnable API

Enables the specified fiber channel port.

Argument List

   port: <string>
   flags: <unsignedInt>

fcTargetPortEnum API

Returns a list of all the fiber channel target ports in the system.

Argument List

   flags: <unsignedInt>

fcTargetPortGet API

Returns information about the specified fiber channel target port.

Argument List

   port: <string>
   flags: <unsignedInt>

getHardwareConfig API

Argument List

   flags: <unsignedInt>

getLocalizedMessage API

Argument List

   locale: <string>
   i18nStr: <i18nString>
   flags: <unsignedInt>

getSecurityConfig API

Gets the complete security profile for the service.

Argument List

   storageSystemId: <string>
   flags: <unsignedInt>

getSystemConfig API

Gets the storage systems configuration.

Argument List

   storageSystemId: <string>
   flags: <unsignedInt>

glusterBrickCreate API

Argument List

   glusterVolume: <string>
   storagePool: <string>
   flags: <unsignedInt>

glusterBrickDelete API

Argument List

   glusterBrick: <string>
   deleteData: <boolean>
   flags: <unsignedInt>

glusterBrickEnum API

Argument List

   flags: <unsignedInt>

glusterBrickGet API

Argument List

   glusterBrick: <string>
   flags: <unsignedInt>

glusterHaFailoverInterfaceCreate API

Argument List

   glusterVolumeId: <string>
   primaryStorageSystemId: <string>
   secondaryStorageSystemId: <string>
   failoverPolicy: <unsignedInt>
   tag: <string>
   parentInterfaceName: <string>
   description: <string>
   ipAddress: <string>
   gateway: <string>
   subnetMask: <string>
   macAddress: <string>
   flags: <unsignedInt>

glusterHaFailoverInterfaceDelete API

Argument List

   glusterVolumeId: <string>
   failoverInterfaceId: <string>
   flags: <unsignedInt>

glusterHaFailoverInterfaceEnum API

Argument List

   flags: <unsignedInt>

glusterHaFailoverInterfaceGet API

Argument List

   glusterVolumeId: <string>
   failoverInterfaceId: <string>
   flags: <unsignedInt>

glusterHaFailoverInterfaceMove API

Argument List

   glusterVolumeId: <string>
   failoverInterfaceId: <string>
   moveToStorageSystemId: <string>
   flags: <unsignedInt>

glusterPeerDetach API

Argument List

   glusterPeer: <string>
   flags: <unsignedInt>

glusterPeerEnum API

Argument List

   flags: <unsignedInt>

glusterPeerGet API

Argument List

   glusterPeer: <string>
   flags: <unsignedInt>

glusterPeerProbe API

Argument List

   storageSystem: <string>
   hostname: <string>
   flags: <unsignedInt>

glusterServiceRestart API

Argument List

   storageSystem: <string>
   flags: <unsignedInt>

glusterVolumeAddBricks API

Argument List

   glusterVolume: <string>
   storagePoolList: <string[]>
   restripeVolume: <boolean>
   flags: <unsignedInt>

glusterVolumeCreate API

Argument List

   name: <string>
   description: <string>
   storagePoolList: <string[]>
   replicaCount: <unsignedInt>
   stripeVolume: <boolean>
   flags: <unsignedInt>

glusterVolumeDelete API

Argument List

   glusterVolume: <string>
   flags: <unsignedInt>

glusterVolumeEnum API

Argument List

   flags: <unsignedInt>

glusterVolumeGet API

Argument List

   glusterVolume: <string>
   flags: <unsignedInt>

glusterVolumeModify API

Argument List

   glusterVolume: <string>
   name: <string>
   description: <string>
   flags: <unsignedInt>

glusterVolumeRebalance API

Argument List

   glusterVolume: <string>
   option: <unsignedInt>
   flags: <unsignedInt>

glusterVolumeReplaceBrick API

Argument List

   glusterVolume: <string>
   oldBrick: <string>
   newBrick: <string>
   flags: <unsignedInt>

glusterVolumeStart API

Argument List

   glusterVolume: <string>
   flags: <unsignedInt>

glusterVolumeStop API

Argument List

   glusterVolume: <string>
   flags: <unsignedInt>

hostAdd API

Adds the specified host.

Argument List

   hostname: <string>
   ipAddress: <string>
   username: <string>
   password: <string>
   hostType: <unsignedInt>
   description: <string>
   iqn: <string>
   flags: <unsignedInt>

hostEnum API

Returns a list of all the hosts.

Argument List

   flags: <unsignedInt>

hostGet API

Gets information about a specific host.

Argument List

   host: <string>
   flags: <unsignedInt>

hostGroupCreate API

Creates a new host group with the specified name.

Argument List

   name: <string>
   description: <string>
   hostList: <string[]>
   flags: <unsignedInt>

hostGroupDelete API

Removes the specified host group.

Argument List

   host: <string>
   deleteAssociatedHosts: <boolean>
   flags: <unsignedInt>

hostGroupEnum API

Returns a list of all the host groups.

Argument List

   flags: <unsignedInt>

hostGroupGet API

Gets information about a specific host group.

Argument List

   hostGroup: <string>
   flags: <unsignedInt>

hostGroupHostAddRemove API

Adds/Removes a host to the specified host group.

Argument List

   hostGroup: <string>
   modType: <unsignedInt>
   hostList: <string[]>
   flags: <unsignedInt>

hostGroupModify API

Modifies the properties of a host group such as its name and/or description.

Argument List

   hostGroup: <string>
   newName: <string>
   newDescription: <string>
   flags: <unsignedInt>

hostInitiatorAdd API

Adds an additional iSCSI host initiator IQN to the specified host.

Argument List

   host: <string>
   iqn: <string>
   flags: <unsignedInt>

hostInitiatorEnum API

Returns a list of all the initiators (IQN) of the specified host.

Argument List

   host: <string>
   flags: <unsignedInt>

hostInitiatorGet API

Gets information about a specific host identified by its initiator IQN.

Argument List

   initiator: <string>
   flags: <unsignedInt>

hostInitiatorRemove API

Removes a iSCSI host initiator (IQN) from the specified host.

Argument List

   host: <string>
   iqn: <string>
   flags: <unsignedInt>

hostModify API

Modifies a host.

Argument List

   host: <string>
   newIpAddress: <string>
   newUsername: <string>
   newPassword: <string>
   newHostType: <unsignedInt>
   newDescription: <string>
   flags: <unsignedInt>

hostRemove API

Removes the specified host, *WARNING* host's active iSCSI sessions will be dropped.

Argument List

   host: <string>
   flags: <unsignedInt>

hwAlarmEnum API

Returns a list of all the current hardware alarms/alert messages generated from the controller.

Argument List

   hwController: <string>
   flags: <unsignedInt>

hwAlarmGet API

Returns information about a specific hardware alarm.

Argument List

   hwAlarm: <string>
   flags: <unsignedInt>

hwBatteryBackupUnitEnum API

Enumerates the battery backup information for the specified controller.

Argument List

   hwController: <string>
   flags: <unsignedInt>

hwBatteryBackupUnitGet API

Gets the battery backup unit information for the specified battery backup unit.

Argument List

   hwBatteryBackupUnit: <string>
   flags: <unsignedInt>

hwControllerChangeSecurityKey API

Argument List

   controllerId: <string>
   oldSecurityKey: <string>
   newSecurityKey: <string>
   flags: <unsignedInt>

hwControllerClearAlarms API

Clears all the hardware alarms that have been recorded for the specified hardware RAID controller.

Argument List

   controllerId: <string>
   flags: <unsignedInt>

hwControllerCreateSecurityKey API

Argument List

   controllerId: <string>
   securityKey: <string>
   flags: <unsignedInt>

hwControllerEnum API

Returns a list of all the hardware controllers.

Argument List

   hwControllerGroup: <string>
   flags: <unsignedInt>

hwControllerGet API

Returns information about a specific hardware RAID controller.

Argument List

   hwController: <string>
   flags: <unsignedInt>

hwControllerGroupEnum API

Returns a list of all the hardware controller groups.

Argument List

   flags: <unsignedInt>

hwControllerGroupGet API

Returns information about all the support hardware RAID controller group types.

Argument List

   hwControllerGroup: <string>
   flags: <unsignedInt>

hwControllerImportForeignUnits API

Argument List

   controllerId: <string>
   flags: <unsignedInt>

hwControllerModify API

Argument List

   controllerId: <string>
   altName: <string>
   description: <string>
   flags: <unsignedInt>

hwControllerRescan API

Rescans the hardware controller to look for new disks and RAID units.

Argument List

   controllerId: <string>
   flags: <unsignedInt>

hwControllerRescanAll API

Rescans all of the hardware controllers to look for new disks and RAID units.

Argument List

   storageSystemId: <string>
   flags: <unsignedInt>

hwControllerSilenceAlarms API

Silences the alarms for specified hardware controller.

Argument List

   controllerId: <string>
   flags: <unsignedInt>

hwDiskEnum API

Returns a list of all the disks managed by the specified hardware controller.

Argument List

   hwController: <string>
   flags: <unsignedInt>

hwDiskGet API

Returns information about a specific disk managed by a hardware RAID controller.

Argument List

   hwDisk: <string>
   flags: <unsignedInt>

hwDiskIdentify API

Flashes the LED indicator light on the specified disk so that it can be identified in the enclosure chassis.

Argument List

   diskId: <string>
   durationInSeconds: <unsignedInt>
   flags: <unsignedInt>

hwDiskMarkGood API

Argument List

   diskId: <string>
   flags: <unsignedInt>

hwDiskMarkHotSpare API

Marks the specified disk as a universal hot spare within the group of RAID units managed by the controller in which the disk is attached.

Argument List

   diskId: <string>
   clearMark: <boolean>
   flags: <unsignedInt>

hwDiskModify API

Argument List

   diskId: <string>
   altName: <string>
   description: <string>
   flags: <unsignedInt>

hwDiskRemove API

Marks the disk as removable (safe way to swap the drives).

Argument List

   diskId: <string>
   flags: <unsignedInt>

hwEnclosureEnum API

Returns a list of all the enclosures managed by the specified hardware RAID controller.

Argument List

   hwController: <string>
   flags: <unsignedInt>

hwEnclosureGet API

Returns information about a specific enclosure managed by the specified hardware RAID controller.

Argument List

   hwEnclosure: <string>
   flags: <unsignedInt>

hwEnclosureLayoutEnum API

Argument List

   flags: <unsignedInt>

hwEnclosureLayoutGet API

Argument List

   hwEnclosureLayout: <string>
   flags: <unsignedInt>

hwEnclosureModify API

Argument List

   diskId: <string>
   altName: <string>
   description: <string>
   enclosureLayout: <string>
   flags: <unsignedInt>

hwLogicalDriveEnum API

Argument List

   hwUnit: <string>
   flags: <unsignedInt>

hwLogicalDriveGet API

Argument List

   hwLogicalDrive: <string>
   flags: <unsignedInt>

hwSwitchAdapterEnum API

Returns a list of all the storage switch management adapters.

Argument List

   flags: <unsignedInt>

hwSwitchAdapterGet API

Returns information about the specified HW switch management module.

Argument List

   switchAdapterId: <string>
   flags: <unsignedInt>

hwSwitchCredentialsAdd API

Adds storage switch login credentials for a specific switch management adapter.

Argument List

   username: <string>
   password: <string>
   domainPassword: <string>
   ipAddress: <string>
   managementProtocol: <unsignedInt>
   switchType: <unsignedInt>
   switchAdapterId: <string>
   primaryStorageSystem: <string>
   secondaryStorageSystem: <string>
   flags: <unsignedInt>

hwSwitchCredentialsEnum API

Returns a list of all the storage switch login credentials.

Argument List

   switchAdapterId: <string>
   flags: <unsignedInt>

hwSwitchCredentialsGet API

Returns information about specific storage switch login credentials.

Argument List

   switchCredentials: <string>
   flags: <unsignedInt>

hwSwitchCredentialsModify API

Modifies the switch login credentials.

Argument List

   credentialsId: <string>
   password: <string>
   domainPassword: <string>
   primaryStorageSystem: <string>
   secondaryStorageSystem: <string>
   flags: <unsignedInt>

hwSwitchCredentialsRemove API

Removes storage switch login credentials.

Argument List

   credsId: <string>
   flags: <unsignedInt>

hwSwitchEnum API

Returns a list of all the discovered storage switches.

Argument List

   switchAdapterId: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupActivate API

Activates the pools in a switch failover group on the specified storage system.

Argument List

   hwSwitchFailoverGroup: <string>
   storageSystemId: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupCreate API

Creates a new switch failover group.

Argument List

   name: <string>
   description: <string>
   virtualHostIpAddress: <string>
   virtualHostSubnet: <string>
   virtualHostGateway: <string>
   storagePoolList: <string[]>
   primaryStorageSystemId: <string>
   primaryZonesetId: <string>
   secondaryStorageSystemId: <string>
   secondaryZonesetId: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupDelete API

Deletes a failover group.

Argument List

   hwSwitchFailoverGroup: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupEnum API

Returns a list of all the switch failover groups.

Argument List

   flags: <unsignedInt>

hwSwitchFailoverGroupGet API

Returns information about a specific switch failover group.

Argument List

   hwSwitchFailoverGroupId: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupModify API

Modifies the properties of a failover group.

Argument List

   hwSwitchFailoverGroup: <string>
   name: <string>
   description: <string>
   virtualHostIpAddress: <string>
   virtualHostSubnet: <string>
   virtualHostGateway: <string>
   storagePoolList: <string[]>
   primaryStorageSystemId: <string>
   primaryZonesetId: <string>
   secondaryStorageSystemId: <string>
   secondaryZonesetId: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupPoolAssocEnum API

Argument List

   hwSwitchFailoverGroup: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupPoolAssocGet API

Argument List

   hwSwitchFailoverGroupId: <string>
   storagePoolId: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupSetMode API

Argument List

   hwSwitchFailoverGroup: <string>
   failoverMode: <unsignedInt>
   flags: <unsignedInt>

hwSwitchFailoverGroupSystemAssocAdd API

Adds another storage system to which the failover group can failover to.

Argument List

   hwSwitchFailoverGroup: <string>
   storageSystemId: <string>
   zonesetId: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupSystemAssocEnum API

Argument List

   hwSwitchFailoverGroup: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupSystemAssocGet API

Argument List

   hwSwitchFailoverGroupId: <string>
   storageSystemId: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupSystemAssocRemove API

Removes a storage system from the failover group.

Argument List

   hwSwitchFailoverGroup: <string>
   storageSystemId: <string>
   flags: <unsignedInt>

hwSwitchGet API

Returns detailed information about a storage switch.

Argument List

   switchId: <string>
   flags: <unsignedInt>

hwSwitchRescan API

Rescans the hardware switch.

Argument List

   switchId: <string>
   flags: <unsignedInt>

hwSwitchZonesetActivate API

Activates a specific storage switch zonset.

Argument List

   switchCredentialsId: <string>
   zonesetId: <string>
   flags: <unsignedInt>

hwSwitchZonesetEnum API

Returns a list of all the discovered zonesets.

Argument List

   switchCredentialsId: <string>
   flags: <unsignedInt>

hwSwitchZonesetGet API

Returns information about a specific switch zoneset.

Argument List

   switchZoneset: <string>
   flags: <unsignedInt>

hwUnitCreate API

Creates a new hardware RAID unit using the specified controller.

Argument List

   controllerId: <string>
   raidType: <unsignedInt>
   legLength: <unsignedInt>
   blockSizeKb: <unsignedInt>
   diskList: <string[]>
   flags: <unsignedInt>

hwUnitDelete API

Deletes the specified RAID unit. Note that you must first delete the Storage Pool before you delete the RAID unit.

Argument List

   unitId: <string>
   flags: <unsignedInt>

hwUnitDiskAssocEnum API

Argument List

   hwUnit: <string>
   flags: <unsignedInt>

hwUnitDiskAssocGet API

Argument List

   hwUnit: <string>
   hwDisk: <string>
   flags: <unsignedInt>

hwUnitEnableEncryption API

Argument List

   unitId: <string>
   options: <unsignedInt>
   flags: <unsignedInt>

hwUnitEnum API

Returns a list of all the disks managed by the specified hardware controller.

Argument List

   hwController: <string>
   flags: <unsignedInt>

hwUnitGet API

Returns information about a specific disk managed by a hardware RAID controller.

Argument List

   hwUnit: <string>
   flags: <unsignedInt>

hwUnitGrow API

Grows the hardware unit by adding specified disks.

Argument List

   unitId: <string>
   diskList: <string[]>
   stripeSizeKb: <unsignedInt>
   initPriority: <unsignedInt>
   flags: <unsignedInt>

hwUnitIdentify API

Flashes the LED indicator light on all the disks in the RAID unit so that it can be identified in the enclosure.

Argument List

   unitId: <string>
   durationInSeconds: <unsignedInt>
   flags: <unsignedInt>

hwUnitModify API

Argument List

   unitId: <string>
   altName: <string>
   description: <string>
   flags: <unsignedInt>

hwUnitSsdCacheCreate API

Argument List

   controllerId: <string>
   raidType: <unsignedInt>
   ssdDiskList: <string[]>
   flags: <unsignedInt>

hwUnitSsdCacheDisable API

Argument List

   unitId: <string>
   flags: <unsignedInt>

hwUnitSsdCacheEnable API

Argument List

   unitId: <string>
   unitSsdCacheId: <string>
   flags: <unsignedInt>

ibTargetPortEnum API

Returns a list of all the infiniband ports in the system.

Argument List

   flags: <unsignedInt>

ibTargetPortGet API

Returns information about the specified infiniband port.

Argument List

   port: <string>
   flags: <unsignedInt>

libratoMetricsConfigGet API

Get the current username, token, and interval settings for Librato Metrics.

Argument List

   storageSystem: <string>
   flags: <unsignedInt>

libratoMetricsConfigSet API

Set the username, token, and interval for Librato Metrics posting.

Argument List

   storageSystem: <string>
   username: <string>
   token: <string>
   postIntervalSec: <unsignedInt>
   autoDashboardCreate: <boolean>
   enableAlertAnnotations: <boolean>
   enableConfigAnnotations: <boolean>
   flags: <unsignedInt>

licenseActivate API

Activates the system using a activation key received from customer support.

Argument List

   activationKey: <string>
   flags: <unsignedInt>

licenseActivateOnline API

Requests automatic activation via the online activation service.

Argument List

   licenseKey: <string>
   flags: <unsignedInt>

licenseAdd API

Adds a license key using a license key block.

Argument List

   storageSystem: <string>
   keyBlock: <string>
   flags: <unsignedInt>

licenseEnum API

Returns a list of all the registered license keys.

Argument List

   flags: <unsignedInt>

licenseGet API

Shows the current license key info, and any activation request code.

Argument List

   license: <string>
   flags: <unsignedInt>

licenseRemove API

Removes the specified license key.

Argument List

   license: <string>
   flags: <unsignedInt>

login API

Argument List

   reserved: <string>

networkShareCifsOptionEnum API

Argument List

   networkShare: <string>
   flags: <unsignedInt>

networkShareCifsOptionGet API

Argument List

   networkShareId: <string>
   key: <string>
   flags: <unsignedInt>

networkShareClientAdd API

Adds a client for the specified network share.

Argument List

   networkShareId: <string>
   clientFilter: <string>
   async: <boolean>
   secure: <boolean>
   subtreeCheck: <boolean>
   readOnly: <boolean>
   customOptions: <string>
   flags: <unsignedInt>

networkShareClientEnum API

Returns a list of clients for the specified network share.

Argument List

   networkShare: <string>
   flags: <unsignedInt>

networkShareClientGet API

Returns information about the specific network share client.

Argument List

   networkShareId: <string>
   networkShareClientId: <string>
   flags: <unsignedInt>

networkShareClientModify API

Modifies a client for the specified network share.

Argument List

   networkShareId: <string>
   networkShareClientId: <string>
   readOnly: <boolean>
   secure: <boolean>
   async: <boolean>
   subtreeCheck: <boolean>
   customOptions: <string>
   flags: <unsignedInt>

networkShareClientRemove API

Removes a client for the specified network share.

Argument List

   networkShareId: <string>
   networkShareClientId: <string>
   flags: <unsignedInt>

networkShareClone API

Clones the specified network share.

Argument List

   networkShare: <string>
   cloneName: <string>
   description: <string>
   provisionableId: <string>
   readOnly: <boolean>
   isActive: <boolean>
   flags: <unsignedInt>

networkShareCreate API

Creates a new NFSv3 network share.

Argument List

   name: <string>
   description: <string>
   provisionableId: <string>
   isPublic: <boolean>
   isActive: <boolean>
   flags: <unsignedInt>

networkShareCreateEx API

Argument List

   name: <string>
   description: <string>
   provisionableId: <string>
   isPublic: <boolean>
   isActive: <boolean>
   enableCifs: <boolean>
   userAccessList: <string[]>
   cifsOptions: <string[]>
   disableSnapBrowsing: <boolean>
   spaceQuota: <unsignedLong>
   flags: <unsignedInt>

networkShareDelete API

Deletes the specified network share.

Argument List

   networkShareId: <string>
   flags: <unsignedInt>

networkShareDeleteEx API

Argument List

   networkShareList: <string[]>
   flags: <unsignedInt>

networkShareDisable API

Disables the specified network share.

Argument List

   networkShare: <string>
   flags: <unsignedInt>

networkShareEnable API

Enables the specified network share.

Argument List

   networkShare: <string>
   flags: <unsignedInt>

networkShareEnum API

Returns a list of all the network shares in the system.

Argument List

   flags: <unsignedInt>

networkShareEnumQuotas API

Argument List

   networkShare: <string>
   flags: <unsignedInt>

networkShareGet API

Returns information about the specified network share.

Argument List

   networkShare: <string>
   flags: <unsignedInt>

networkShareJoinDomain API

Argument List

   storageSystemId: <string>
   domain: <string>
   realm: <string>
   kdc: <string>
   domainAdmin: <string>
   password: <string>
   flags: <unsignedInt>

networkShareLeaveDomain API

Argument List

   storageSystemId: <string>
   domainAdmin: <string>
   password: <string>
   flags: <unsignedInt>

networkShareModify API

Modifies a client for the specified network share.

Argument List

   networkShare: <string>
   name: <string>
   description: <string>
   isActive: <boolean>
   enableCifs: <boolean>
   userAccessList: <string[]>
   cifsOptions: <string[]>
   disableSnapBrowsing: <boolean>
   spaceQuota: <unsignedLong>
   syncPolicy: <unsignedInt>
   compressionType: <string>
   copies: <unsignedInt>
   flags: <unsignedInt>

networkShareNfsConfig API

Argument List

   storageSystem: <string>
   nfsMode: <unsignedInt>
   enableKerberos: <boolean>
   defaultOptions: <string>
   reserved: <string>
   flags: <unsignedInt>

networkShareRestore API

Restores the network share from a previous snapshot of the share.

Argument List

   networkShare: <string>
   snapshotShare: <string>
   flags: <unsignedInt>

networkShareRollback API

Argument List

   networkShare: <string>
   snapshotShare: <string>
   flags: <unsignedInt>

networkShareServicesRestart API

Restarts the network share service.

Argument List

   storageSystem: <string>
   restartNfs: <boolean>
   restartSamba: <boolean>
   flags: <unsignedInt>

networkShareSetQuotas API

Argument List

   networkShare: <string>
   list: <networkShareQuota[]>
   flags: <unsignedInt>

networkShareSnapshot API

Snapshots the specified network share.

Argument List

   networkShare: <string>
   snapshotName: <string>
   description: <string>
   provisionableId: <string>
   readOnly: <boolean>
   isActive: <boolean>
   flags: <unsignedInt>

networkShareUserAccessEnum API

Argument List

   networkShare: <string>
   flags: <unsignedInt>

networkShareUserAccessGet API

Argument List

   networkShareUserAccessId: <string>
   flags: <unsignedInt>

objectEnum API

Argument List

   propKey: <string>
   propValue: <string>
   propType: <unsignedInt>
   flags: <unsignedInt>

objectGet API

Gets the object based on the id provided.

Argument List

   id: <string>
   flags: <unsignedInt>

objectLock API

Locks the specified object.

Argument List

   id: <string>

objectPropertyGet API

Gets the specified property on an object.

Argument List

   objectId: <string>
   propKey: <string>
   flags: <unsignedInt>

objectPropertySet API

Sets the specified property on an object.

Argument List

   objectId: <string>
   propKey: <string>
   propValue: <string>
   propType: <unsignedInt>
   flags: <unsignedInt>

objectUnlock API

Unlocks an object.

Argument List

   id: <string>

permissionDefinitionEnum API

Argument List

   flags: <unsignedInt>

physicalDiskDataMigration API

Argument List

   physicalDriveId: <string>
   storageVolumeName: <string>
   provisionableId: <string>
   blockSizeKb: <unsignedInt>
   flags: <unsignedInt>

physicalDiskEnum API

Enumerates all physical disks.

Argument List

   physicalDiskList: <string[]>
   flags: <unsignedInt>

physicalDiskGet API

Gets information about a specific physical disk.

Argument List

   physicalDrive: <string>
   flags: <unsignedInt>

physicalDiskGlobalSpareAddRemove API

Argument List

   physicalDriveList: <string[]>
   modType: <unsignedInt>
   flags: <unsignedInt>

physicalDiskGlobalSpareEnum API

Argument List

   flags: <unsignedInt>

physicalDiskHotspareMarkerCleanup API

Argument List

   flags: <unsignedInt>

physicalDiskHotspareMarkerEnum API

Argument List

   flags: <unsignedInt>

physicalDiskHotspareMarkerGet API

Argument List

   markerId: <string>
   flags: <unsignedInt>

physicalDiskIdentify API

Pulses the disk activity light so that the specified disk can be identified in the chassis.

Argument List

   physicalDrive: <string>
   pattern: <string>
   duration: <unsignedInt>
   flags: <unsignedInt>

physicalDiskPathAssocEnum API

Argument List

   multipathDiskId: <string>
   flags: <unsignedInt>

physicalDiskPathAssocGet API

Argument List

   multipathDiskId: <string>
   physicalDiskId: <string>
   flags: <unsignedInt>

physicalDiskScan API

Scans for any new physical disks that may have been hot-plugged into the storage system.

Argument List

   storageSystemId: <string>
   flags: <unsignedInt>

registerSecurityToken API

Argument List

   token: <string>
   signedToken: <string>
   flags: <unsignedInt>

remoteNfsExportsEnum API

Argument List

   networkShare: <string>
   nfsHostname: <string>
   backupPolicy: <string>
   flags: <unsignedInt>

remoteStoragePoolEnum API

Returns a list of all the remote storage pools.

Argument List

   remoteStorageSystemId: <string>
   flags: <unsignedInt>

replicaAssocDelete API

Argument List

   assocId: <string>
   deleteSourceReplicatable: <boolean>
   deleteTargetReplicatable: <boolean>
   deleteReplicaAssocHead: <boolean>
   flags: <unsignedInt>

replicaAssocEnum API

Argument List

   replicatableId: <string>
   sourcesOnly: <boolean>
   targetsOnly: <boolean>
   flags: <unsignedInt>

replicaAssocGet API

Argument List

   assocId: <string>
   flags: <unsignedInt>

replicaAssocUpdate API

Argument List

   assocObj: <replicaAssoc>
   flags: <unsignedInt>

replicaCreate API

Argument List

   replicatableId: <string>
   storageSystemLinkId: <string>
   replicaName: <string>
   replicaDescription: <string>
   targetStoragePoolId: <string>
   replicationPriority: <unsignedInt>
   smartSync: <boolean>
   forcePrimary: <boolean>
   reserved: <string>
   flags: <unsignedInt>

replicaCreateNetworkShareTarget API

Argument List

   sourceShare: <networkShare>
   sourceShareParent: <networkShare>
   replicaName: <string>
   replicaDescription: <string>
   targetStoragePoolId: <string>
   replicationPriority: <unsignedInt>
   smartSync: <boolean>
   forcePrimary: <boolean>
   reserved: <string>
   flags: <unsignedInt>

replicaCreateVolumeTarget API

Argument List

   sourceVolume: <storageVolume>
   sourceVolumeParent: <storageVolume>
   replicaName: <string>
   replicaDescription: <string>
   targetStoragePoolId: <string>
   replicationPriority: <unsignedInt>
   smartSync: <boolean>
   forcePrimary: <boolean>
   reserved: <string>
   flags: <unsignedInt>

replicaRollback API

Argument List

   assocId: <string>
   flags: <unsignedInt>

replicaStatusUpdate API

Argument List

   replicationStatusXml: <string>
   flags: <unsignedInt>

replicaStop API

Argument List

   assocId: <string>
   flags: <unsignedInt>

replicaSync API

Argument List

   assocId: <string>
   flags: <unsignedInt>

replicationScheduleAddRemove API

Argument List

   schedule: <string>
   modType: <unsignedInt>
   storageVolumeList: <string[]>
   networkShareList: <string[]>
   flags: <unsignedInt>

replicationScheduleAssocEnum API

Argument List

   schedule: <string>
   flags: <unsignedInt>

replicationScheduleAssocGet API

Argument List

   scheduleId: <string>
   replicatableId: <string>

replicationScheduleCreate API

Argument List

   name: <string>
   description: <string>
   storageCloudId: <string>
   storageSystemLinkId: <string>
   targetStorageCloudId: <string>
   targetProvisionableId: <string>
   priority: <unsignedInt>
   setEnabled: <unsignedInt>
   startDate: <dateTime>
   maxReplicas: <unsignedInt>
   daysOfWeek: <unsignedInt>
   hoursOfDay: <unsignedInt>
   storageVolumeList: <string[]>
   networkShareList: <string[]>
   scheduleType: <unsignedInt>
   delayInterval: <unsignedInt>
   offsetMinutes: <unsignedInt>
   flags: <unsignedInt>

replicationScheduleDelete API

Argument List

   schedule: <string>
   flags: <unsignedInt>

replicationScheduleDisable API

Argument List

   schedule: <string>
   flags: <unsignedInt>

replicationScheduleEnable API

Argument List

   schedule: <string>
   flags: <unsignedInt>

replicationScheduleEnum API

Argument List

   flags: <unsignedInt>

replicationScheduleGet API

Argument List

   schedule: <string>
   flags: <unsignedInt>

replicationScheduleModify API

Argument List

   schedule: <string>
   name: <string>
   description: <string>
   storageCloudId: <string>
   setEnabled: <unsignedInt>
   startDate: <dateTime>
   maxReplicas: <unsignedInt>
   daysOfWeek: <unsignedInt>
   hoursOfDay: <unsignedInt>
   scheduleType: <unsignedInt>
   delayInterval: <unsignedInt>
   offsetMinutes: <unsignedInt>
   flags: <unsignedInt>

replicationScheduleTrigger API

Argument List

   schedule: <string>
   flags: <unsignedInt>

roleCreate API

Adds a new role to the role based access control (RBAC) system.

Argument List

   name: <string>
   description: <string>
   permissionList: <permissionAssignment[]>
   inheritsFrom: <string>
   flags: <unsignedInt>

roleDelete API

Removes the specified role identified by name or ID.

Argument List

   role: <string>
   flags: <unsignedInt>

roleEnum API

Returns a list of all the defined roles the RBAC system.

Argument List

   flags: <unsignedInt>

roleGet API

Gets information about the specified role.

Argument List

   role: <string>
   flags: <unsignedInt>

roleModify API

Modifies the name and/or description of a role.

Argument List

   role: <string>
   newName: <string>
   newDescription: <string>
   flags: <unsignedInt>

rolePermissionAssignmentEnum API

Lists all of the role permission assignments.

Argument List

   roleId: <string>
   flags: <unsignedInt>

rolePermissionAssignmentGet API

Gets the specified role permission assignment.

Argument List

   role: <string>
   objectType: <string>
   operation: <string>
   flags: <unsignedInt>

rolePermissionsAddRemove API

Adds/Removes one or more permissions and/or permission groups from the specified role.

Argument List

   role: <string>
   modType: <unsignedInt>
   permissionList: <permissionAssignment[]>
   flags: <unsignedInt>

roleSubjectAssocEnum API

Argument List

   role: <string>
   flags: <unsignedInt>

roleSubjectAssocGet API

Argument List

   role: <string>
   subject: <string>
   flags: <unsignedInt>

sessionClose API

Forcibly closes the specified iSCSI session; generally not recommended, use acl-remove instead.

Argument List

   sessionId: <string>
   flags: <unsignedInt>

sessionEnum API

Returns a list of all the active iSCSI sessions.

Argument List

   host: <string>
   storageVolume: <string>
   flags: <unsignedInt>

sessionGet API

Returns detailed information on a specific iSCSI session.

Argument List

   sessionId: <string>
   flags: <unsignedInt>

siteAssocEnum API

Argument List

   flags: <unsignedInt>

siteAssocGet API

Argument List

   siteId: <string>
   storageSystemId: <string>
   flags: <unsignedInt>

siteCreate API

Argument List

   name: <string>
   description: <string>
   location: <string>
   storageSystemList: <string[]>
   flags: <unsignedInt>

siteDelete API

Argument List

   site: <string>
   flags: <unsignedInt>

siteEnum API

Argument List

   flags: <unsignedInt>

siteGet API

Argument List

   site: <string>
   flags: <unsignedInt>

siteModify API

Argument List

   siteId: <string>
   name: <string>
   description: <string>
   location: <string>
   flags: <unsignedInt>

siteStorageSystemAddRemove API

Argument List

   site: <string>
   modType: <unsignedInt>
   storageSystemList: <string[]>
   flags: <unsignedInt>

snapshotScheduleAssocEnum API

Argument List

   schedule: <string>
   flags: <unsignedInt>

snapshotScheduleAssocGet API

Argument List

   scheduleId: <string>
   storageVolumeId: <string>

snapshotScheduleCreate API

Creates a new snapshot schedule comprised of the specified storage volumes.

Argument List

   name: <string>
   description: <string>
   storageCloudId: <string>
   setEnabled: <unsignedInt>
   startDate: <dateTime>
   maxSnapshots: <unsignedInt>
   daysOfWeek: <unsignedInt>
   hoursOfDay: <unsignedInt>
   storageVolumeList: <string[]>
   networkShareList: <string[]>
   scheduleType: <unsignedInt>
   delayInterval: <unsignedInt>
   flags: <unsignedInt>

snapshotScheduleDelete API

Deletes a snapshot schedule, snapshots associated with the schedule are not removed.

Argument List

   schedule: <string>
   flags: <unsignedInt>

snapshotScheduleDisable API

Disables the specified snapshot schedule.

Argument List

   schedule: <string>
   flags: <unsignedInt>

snapshotScheduleEnable API

Enables the specified snapshot schedule.

Argument List

   schedule: <string>
   flags: <unsignedInt>

snapshotScheduleEnum API

Returns a list of all the snapshot schedules.

Argument List

   flags: <unsignedInt>

snapshotScheduleGet API

Returns information about a specific snapshot schedule.

Argument List

   schedule: <string>
   flags: <unsignedInt>

snapshotScheduleModify API

Modifies the name, description or other properties of a snapshot schedule.

Argument List

   schedule: <string>
   name: <string>
   description: <string>
   storageCloudId: <string>
   setEnabled: <unsignedInt>
   startDate: <dateTime>
   maxSnapshots: <unsignedInt>
   daysOfWeek: <unsignedInt>
   hoursOfDay: <unsignedInt>
   scheduleType: <unsignedInt>
   delayInterval: <unsignedInt>
   flags: <unsignedInt>

snapshotScheduleTrigger API

Argument List

   schedule: <string>
   flags: <unsignedInt>

snapshotScheduleVolumeAddRemove API

Adds/Removes one or more volumes to the specified schedule.

Argument List

   schedule: <string>
   modType: <unsignedInt>
   storageVolumeList: <string[]>
   networkShareList: <string[]>
   flags: <unsignedInt>

storageCloudCreate API

Creates a new storage cloud comprised of the specified users, resources and chap information.

Argument List

   name: <string>
   description: <string>
   userList: <storageCloudSubjectAssoc[]>
   resourceList: <storageCloudResourceAssoc[]>
   parentStorageCloudId: <string>
   tier: <string>
   organization: <string>
   defaultChapUsername: <string>
   defaultChapPassword: <string>
   flags: <unsignedInt>

storageCloudDelete API

Deletes a storage cloud, the resources and users will not be deleted.

Argument List

   storageCloud: <string>
   flags: <unsignedInt>

storageCloudEnum API

Returns a list of all the storage clouds.

Argument List

   flags: <unsignedInt>

storageCloudGet API

Returns information of the specified storage clouds.

Argument List

   storageCloud: <string>
   flags: <unsignedInt>

storageCloudModify API

Modify the name, description, parent storage cloud, tier, organization, and chap information of a storage cloud.

Argument List

   storageCloud: <string>
   name: <string>
   description: <string>
   parentStorageCloudId: <string>
   tier: <string>
   organization: <string>
   defaultChapUsername: <string>
   defaultChapPassword: <string>
   flags: <unsignedInt>

storageCloudResourceAddRemove API

Add/Remove one or more resources to the specified storage cloud.

Argument List

   storageCloud: <string>
   modType: <unsignedInt>
   resourceList: <storageCloudResourceAssoc[]>
   flags: <unsignedInt>

storageCloudResourceAssocEnum API

Returns a list of associated resources of the specified storage cloud.

Argument List

   resource: <string>
   flags: <unsignedInt>

storageCloudResourceAssocGet API

Returns associated information of specified resource in the storage cloud.

Argument List

   storageCloud: <string>
   resource: <string>
   flags: <unsignedInt>

storageCloudResourceSetMode API

Set the mode of a specified resource in the storage cloud.

Argument List

   storageCloud: <string>
   resource: <string>
   accessMode: <unsignedInt>
   flags: <unsignedInt>

storageCloudSubjectAssocEnum API

Returns a list of associated storage clouds to the specified subject.

Argument List

   subject: <string>
   flags: <unsignedInt>

storageCloudSubjectAssocGet API

Returns associated information of a specified subject for a storage cloud.

Argument List

   storageCloud: <string>
   subject: <string>
   flags: <unsignedInt>

storageCloudUserAddRemove API

Add/Remove one or more users to the specified storage cloud.

Argument List

   storageCloud: <string>
   modType: <unsignedInt>
   userList: <storageCloudSubjectAssoc[]>
   flags: <unsignedInt>

storagePoolCacheAddRemove API

Argument List

   storagePool: <string>
   modType: <unsignedInt>
   readCacheDeviceList: <string[]>
   writeCacheDeviceList: <string[]>
   flags: <unsignedInt>

storagePoolCreate API

Creates a new storage pool from which storage volumes can be created.

Argument List

   name: <string>
   physicalDiskList: <string[]>
   description: <string>
   raidType: <unsignedInt>
   poolType: <unsignedInt>
   isDefault: <boolean>
   enableSsd: <boolean>
   enableCompression: <boolean>
   noBarriers: <boolean>
   profile: <string>
   raidSetSize: <unsignedInt>
   flags: <unsignedInt>

storagePoolDestroy API

Deletes a storage pool, *WARNING* any data in the pool will be lost.

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storagePoolDeviceEnum API

Returns a list of all the storage pool devices.

Argument List

   storagePoolId: <string>
   flags: <unsignedInt>

storagePoolDeviceGet API

Gets information about a specific storage pool device.

Argument List

   storagePoolDevice: <string>
   flags: <unsignedInt>

storagePoolEnum API

Returns a list of all the storage pools.

Argument List

   flags: <unsignedInt>

storagePoolExpand API

Expands a storage pool after the underlying hardware RAID unit has been grown underneath.

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storagePoolExport API

Deactivate and removes the storage pool from the storage system database so that it can be exported and used on another system.

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storagePoolGet API

Gets information about a specific storage pool.

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storagePoolGrow API

Grows the specified storage pool by adding an additional disk. You can only grow storage pools that are using the RAID5 or RAID6 layout.

Argument List

   storagePool: <string>
   physicalDiskList: <string[]>
   raidType: <unsignedInt>
   flags: <unsignedInt>

storagePoolHaFailoverGroupActivate API

Argument List

   failoverGroup: <string>
   flags: <unsignedInt>

storagePoolHaFailoverGroupCreate API

Argument List

   name: <string>
   description: <string>
   storagePoolId: <string>
   primaryStorageSystemId: <string>
   secondaryStorageSystemId: <string>
   failoverModuleId: <string>
   settleTimeInSec: <unsignedInt>
   flags: <unsignedInt>

storagePoolHaFailoverGroupDeactivate API

Argument List

   failoverGroup: <string>
   flags: <unsignedInt>

storagePoolHaFailoverGroupDelete API

Argument List

   failoverGroup: <string>
   flags: <unsignedInt>

storagePoolHaFailoverGroupEnum API

Argument List

   flags: <unsignedInt>

storagePoolHaFailoverGroupFailover API

Argument List

   failoverGroup: <string>
   targetStorageSystem: <string>
   flags: <unsignedInt>

storagePoolHaFailoverGroupGet API

Argument List

   failoverGroup: <string>
   flags: <unsignedInt>

storagePoolHaFailoverGroupModify API

Argument List

   failoverGroup: <string>
   name: <string>
   description: <string>
   secondaryStorageSystemId: <string>
   failoverModuleId: <string>
   settleTimeInSec: <unsignedInt>
   flags: <unsignedInt>

storagePoolHaFailoverInterfaceCreate API

Argument List

   failoverGroup: <string>
   tag: <string>
   parentInterfaceName: <string>
   description: <string>
   ipAddress: <string>
   gateway: <string>
   subnetMask: <string>
   macAddress: <string>
   iscsiEnabled: <boolean>
   flags: <unsignedInt>

storagePoolHaFailoverInterfaceDelete API

Argument List

   failoverGroup: <string>
   failoverInterface: <string>
   flags: <unsignedInt>

storagePoolHaFailoverInterfaceEnum API

Argument List

   flags: <unsignedInt>

storagePoolHaFailoverInterfaceGet API

Argument List

   failoverGroup: <string>
   failoverInterface: <string>
   flags: <unsignedInt>

storagePoolHaFailoverModuleEnum API

Argument List

   flags: <unsignedInt>

storagePoolHaFailoverModuleGet API

Argument List

   failoverModule: <string>
   flags: <unsignedInt>

storagePoolIdentify API

Pulses the disk activity lights for all disks in the pool so they can be identified in the chassis.

Argument List

   storagePool: <string>
   pattern: <string>
   duration: <unsignedInt>
   flags: <unsignedInt>

storagePoolModify API

Modifies the properties of the storage pool such as it's name and description.

Argument List

   storagePool: <string>
   newName: <string>
   newDescription: <string>
   isDefault: <boolean>
   enableSsd: <boolean>
   enableCompression: <boolean>
   noBarriers: <boolean>
   profile: <string>
   syncPolicy: <unsignedInt>
   compressionType: <string>
   hotspareRepairPolicy: <unsignedInt>
   copies: <unsignedInt>
   flags: <unsignedInt>

storagePoolProfileEnum API

Returns a list of all the storage pool profiles.

Argument List

   flags: <unsignedInt>

storagePoolProfileGet API

Gets information about a specific storage pool profile.

Argument List

   storagePoolProfile: <string>
   flags: <unsignedInt>

storagePoolRescan API

Rescans the specified storage system for storage pools.

Argument List

   storageSystem: <string>
   options: <string>
   flags: <unsignedInt>

storagePoolScrubStart API

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storagePoolScrubStop API

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storagePoolSpareAddRemove API

Adds/Removes a dedicated hot-spare to the specified storage pool.

Argument List

   storagePool: <string>
   modType: <unsignedInt>
   physicalDiskList: <string[]>
   flags: <unsignedInt>

storagePoolStart API

Starts up a previously stopped storage pool.

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storagePoolStop API

Stops all volume activity to the pool and disables it for maintenance.

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storagePoolUpdateRedirect API

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storageQuotaCreate API

Creates a new storage quota on a pool for the specified storage cloud.

Argument List

   name: <string>
   description: <string>
   storagePoolId: <string>
   storageCloudId: <string>
   provisionableSize: <unsignedLong>
   utilizableSpace: <unsignedLong>
   maxVolumes: <unsignedInt>
   maxShares: <unsignedInt>
   policyFlags: <unsignedInt>
   flags: <unsignedInt>

storageQuotaDelete API

Deletes a storage quota, the associated volumes are not deleted.

Argument List

   storageQuota: <string>
   flags: <unsignedInt>

storageQuotaEnum API

Returns a list of all the storage quotas.

Argument List

   flags: <unsignedInt>

storageQuotaGet API

Returns information about a specific storage quota.

Argument List

   storageQuota: <string>
   flags: <unsignedInt>

storageQuotaModify API

Modifies one to change the name and/or description of a storage quota.

Argument List

   storageQuota: <string>
   name: <string>
   description: <string>
   storageCloudId: <string>
   provisionableSize: <unsignedLong>
   utilizableSpace: <unsignedLong>
   maxVolumes: <unsignedInt>
   maxShares: <unsignedInt>
   policyFlags: <unsignedInt>
   flags: <unsignedInt>

storageQuotaShareAddRemove API

Adds/Removes one or more volumes to the specified quota.

Argument List

   storageQuota: <string>
   modType: <unsignedInt>
   storageShareList: <string[]>
   flags: <unsignedInt>

storageQuotaShareAssocEnum API

Returns a list of all the associated quotas of a specified share.

Argument List

   networkShare: <string>
   flags: <unsignedInt>

storageQuotaShareAssocGet API

Returns information about the associated quotas of a specified share.

Argument List

   storageQuotaId: <string>
   shareId: <string>

storageQuotaVolumeAddRemove API

Adds/Removes one or more volumes to the specified quota.

Argument List

   storageQuota: <string>
   modType: <unsignedInt>
   storageVolumeList: <string[]>
   flags: <unsignedInt>

storageQuotaVolumeAssocEnum API

Returns a list of all the associated quotas of a specified volume.

Argument List

   storageVolume: <string>
   flags: <unsignedInt>

storageQuotaVolumeAssocGet API

Return information about the associated quotas of a specified volume.

Argument List

   storageQuotaId: <string>
   storageVolumeId: <string>

storageSystemClusterAssocEnum API

Returns a list of the associated storage system nodes in the grid.

Argument List

   flags: <unsignedInt>

storageSystemClusterAssocGet API

Get general information about the associated storage system management grid.

Argument List

   storageSystemClusterId: <string>
   storageSystemId: <string>
   flags: <unsignedInt>

storageSystemClusterCreate API

Creates a new management grid. A given storage system can only be a member of one grid at a time.

Argument List

   name: <string>
   description: <string>
   virtualHostName: <string>
   virtualHostIpAddress: <string>
   virtualHostSubnetMask: <string>
   virtualHostGateway: <string>
   targetPort: <string>
   enableGridVif: <boolean>
   gridBindPortAddress: <string>
   gridIndex: <unsignedInt>
   flags: <unsignedInt>

storageSystemClusterDelete API

Deletes the management grid. After the grid is deleted each node in the grid operates independently again.

Argument List

   flags: <unsignedInt>

storageSystemClusterEnum API

Returns a list of all the managed storage system nodes in the grid.

Argument List

   flags: <unsignedInt>

storageSystemClusterGet API

Get general information about the storage system management grid.

Argument List

   storageSystemCluster: <string>
   flags: <unsignedInt>

storageSystemClusterGetHostsConfig API

Argument List

   storageSystem: <string>
   flags: <unsignedInt>

storageSystemClusterModify API

Modify the management grid properties.

Argument List

   name: <string>
   description: <string>
   virtualHostName: <string>
   virtualHostIpAddress: <string>
   virtualHostSubnetMask: <string>
   virtualHostGateway: <string>
   targetPort: <string>
   enableGridVif: <boolean>
   gridBindPortAddress: <string>
   gridIndex: <unsignedInt>
   flags: <unsignedInt>

storageSystemClusterNodeAdd API

Adds the specified storage system to the management grid.

Argument List

   nodeIpAddress: <string>
   nodeAdminUsername: <string>
   nodeAdminPassword: <string>
   flags: <unsignedInt>

storageSystemClusterNodeEject API

Ejects the specified storage system from the management grid.

Argument List

   storageSystemClusterObj: <storageSystemCluster>
   flags: <unsignedInt>

storageSystemClusterNodeJoin API

Joins the specified storage system to the management grid.

Argument List

   storageSystemClusterObj: <storageSystemCluster>
   masterNode: <storageSystem>
   flags: <unsignedInt>

storageSystemClusterNodeRemove API

Removes the specified storage system from the management grid.

Argument List

   storageSystemId: <string>
   flags: <unsignedInt>

storageSystemClusterNodeSetMaster API

Sets the master node for a storage system.

Argument List

   storageSystemId: <string>
   flags: <unsignedInt>

storageSystemClusterNodeSync API

Argument List

   storageSystemClusterObj: <storageSystemCluster>
   masterNode: <storageSystem>
   flags: <unsignedInt>

storageSystemClusterSetHostsConfig API

Argument List

   storageSystem: <string>
   targetPortIdList: <string[]>
   options: <unsignedInt>
   flags: <unsignedInt>

storageSystemEnum API

Returns a list of all the managed storage systems. This is always a single system unless the system is a member of a management grid.

Argument List

   flags: <unsignedInt>

storageSystemGet API

Get general information about the storage system.

Argument List

   storageSystem: <string>
   flags: <unsignedInt>

storageSystemGroupAddRemoveLinks API

Argument List

   groupId: <string>
   linkIdList: <string[]>
   modType: <unsignedInt>
   flags: <unsignedInt>

storageSystemGroupAssocEnum API

Argument List

   flags: <unsignedInt>

storageSystemGroupAssocGet API

Argument List

   groupId: <string>
   linkId: <string>
   flags: <unsignedInt>

storageSystemGroupCreate API

Argument List

   name: <string>
   description: <string>
   virtualIpAddress: <string>
   groupPassword: <string>
   flags: <unsignedInt>

storageSystemGroupDelete API

Argument List

   groupId: <string>
   deleteAssociatedLinks: <boolean>
   flags: <unsignedInt>

storageSystemGroupEnum API

Argument List

   flags: <unsignedInt>

storageSystemGroupGet API

Argument List

   groupId: <string>
   flags: <unsignedInt>

storageSystemGroupModify API

Argument List

   groupId: <string>
   name: <string>
   description: <string>
   virtualIpAddress: <string>
   flags: <unsignedInt>

storageSystemGroupSetPassword API

Argument List

   groupId: <string>
   groupPassword: <string>
   flags: <unsignedInt>

storageSystemLinkCreate API

Create a new storage system link so that storage volumes may be replicated between storage systems.

Argument List

   storageSystemId: <string>
   remoteSystemId: <string>
   localIpAddress: <string>
   remoteIpAddress: <string>
   bandwidthLimit: <unsignedInt>
   linkType: <unsignedInt>
   description: <string>
   flags: <unsignedInt>

storageSystemLinkDelete API

Delete an existing storage system link.

Argument List

   linkId: <string>
   flags: <unsignedInt>

storageSystemLinkDisconnect API

Disconnect a storage system link.

Argument List

   remoteStorageSystemId: <string>
   flags: <unsignedInt>

storageSystemLinkEnum API

List the existing storage system remote replication links.

Argument List

   flags: <unsignedInt>

storageSystemLinkEstablish API

Establishes a storage system remote replication link.

Argument List

   linkObj: <storageSystemLink>
   flags: <unsignedInt>

storageSystemLinkGet API

Get information about the storage system link.

Argument List

   linkId: <string>
   flags: <unsignedInt>

storageSystemLinkModify API

Modify the properties of the storage system link.

Argument List

   linkId: <string>
   remoteIpAddress: <string>
   localIpAddress: <string>
   bandwidthLimit: <unsignedInt>
   linkType: <unsignedInt>
   description: <string>
   flags: <unsignedInt>

storageSystemLinkRefresh API

Refreshes a storage system link.

Argument List

   linkId: <string>
   flags: <unsignedInt>

storageSystemLinkSetCredentials API

Change the credentials for an existing storage system link.

Argument List

   linkId: <string>
   remoteAdminUser: <string>
   remoteAdminPassword: <string>
   flags: <unsignedInt>

storageSystemLinkVerify API

Argument List

   linkObj: <storageSystemLink>
   flags: <unsignedInt>

storageSystemModify API

Modifies the name and/or description of the storage system.

Argument List

   storageSystem: <string>
   newName: <string>
   newDescription: <string>
   newLocation: <string>
   domainSuffix: <string>
   searchSuffix: <string>
   arpFilterMode: <unsignedInt>
   bondMode: <unsignedInt>
   newDnsServerList: <string[]>
   externalHostName: <string>
   gridPreferredPort: <string>
   flags: <unsignedInt>

storageSystemRecover API

Argument List

   storageSystem: <string>
   recoveryPoint: <string>
   recoverNetworkConfig: <boolean>
   flags: <unsignedInt>

storageSystemRecoveryPointEnum API

Returns a list of all the available system meta data recovery points. Recovery points allow you to restore system information such as network, host, users, and other system information from a prior automatic backup.

Argument List

   storageSystem: <string>
   flags: <unsignedInt>

storageSystemRestart API

Restarts the entire storage system.

Argument List

   storageSystem: <string>
   flags: <unsignedInt>

storageSystemSendLogs API

Argument List

   storageSystemId: <string>
   flags: <unsignedInt>

storageSystemServicesRestart API

Argument List

   storageSystem: <string>
   servicesList: <string>
   flags: <unsignedInt>

storageSystemShutdown API

Shutdown the storage system.

Argument List

   storageSystem: <string>
   flags: <unsignedInt>

storageSystemUpdateCheck API

Checks for updates for specified storage system.

Argument List

   storageSystem: <string>
   flags: <unsignedInt>

storageSystemUpgrade API

Upgrade to the latest version of the core packages.

Argument List

   storageSystem: <string>
   upgradeManager: <boolean>
   upgradeService: <boolean>
   upgradeTarget: <boolean>
   upgradeWebServer: <boolean>
   flags: <unsignedInt>

storageTierAssocEnum API

Argument List

   storagePool: <string>
   flags: <unsignedInt>

storageTierAssocGet API

Argument List

   storageTierId: <string>
   storagePoolId: <string>

storageTierCreate API

Argument List

   name: <string>
   description: <string>
   storageClass: <string>
   storageType: <unsignedInt>
   performanceLevel: <unsignedInt>
   poolList: <string[]>
   flags: <unsignedInt>

storageTierDelete API

Argument List

   storageTier: <string>
   flags: <unsignedInt>

storageTierEnum API

Argument List

   flags: <unsignedInt>

storageTierGet API

Argument List

   storageTier: <string>
   flags: <unsignedInt>

storageTierModify API

Argument List

   storageTier: <string>
   newName: <string>
   description: <string>
   storageClass: <string>
   storageType: <unsignedInt>
   performanceLevel: <unsignedInt>
   flags: <unsignedInt>

storageTierPoolAddRemove API

Argument List

   storageTier: <string>
   modType: <unsignedInt>
   poolList: <string[]>
   flags: <unsignedInt>

storageVolumeAclAddRemove API

Enables/Disables access to the specific volume from the specified host.

Argument List

   storageVolume: <string>
   modType: <unsignedInt>
   hostList: <string[]>
   flags: <unsignedInt>

storageVolumeAclAddRemoveEx API

Enables access to the specific volume from the specified host.

Argument List

   host: <string>
   modType: <unsignedInt>
   storageVolumeList: <string[]>
   flags: <unsignedInt>

storageVolumeAclEnum API

Returns a list of all the volume to host assignments, optionally filtered by host or storage volume.

Argument List

   host: <string>
   storageVolume: <string>
   flags: <unsignedInt>

storageVolumeAclGet API

Gets the assignment information for specified host or storage volume.

Argument List

   host: <string>
   storageVolume: <string>
   flags: <unsignedInt>

storageVolumeClone API

Creates a complete block copy of the source volume.

Argument List

   storageVolume: <string>
   cloneName: <string>
   description: <string>
   provisionableId: <string>
   accessMode: <unsignedInt>
   flags: <unsignedInt>

storageVolumeCloudBackupCreate API

Argument List

   sourceVolumeId: <string>
   cloudContainerId: <string>
   backupVolumeName: <string>
   backupVolumeDescription: <string>
   priority: <unsignedInt>
   reserved: <string>
   flags: <unsignedInt>

storageVolumeCloudBackupRestore API

Argument List

   sourceVolumeId: <string>
   storagePoolId: <string>
   recoveredVolumeName: <string>
   recoveredVolumeDescription: <string>
   priority: <unsignedInt>
   reserved: <string>
   flags: <unsignedInt>

storageVolumeCreate API

Creates a new storage volume in the specified storage pool.

Argument List

   name: <string>
   description: <string>
   provisionableId: <string>
   size: <unsignedLong>
   thinProvisioned: <boolean>
   accessMode: <unsignedInt>
   chapPolicy: <unsignedInt>
   chapUsername: <string>
   chapPassword: <string>
   count: <unsignedInt>
   flags: <unsignedInt>

storageVolumeCreateEx API

Argument List

   name: <string>
   description: <string>
   provisionableId: <string>
   size: <unsignedLong>
   percentReserved: <unsignedInt>
   accessMode: <unsignedInt>
   chapPolicy: <unsignedInt>
   chapUsername: <string>
   chapPassword: <string>
   count: <unsignedInt>
   blockSizeKb: <unsignedInt>
   flags: <unsignedInt>

storageVolumeDelete API

Deletes a storage volume, *WARNING* any data in the volume will be lost.

Argument List

   storageVolumeList: <string[]>
   recursivelyDeleteSnapshots: <boolean>
   flags: <unsignedInt>

storageVolumeDeleteEx API

Argument List

   storageVolume: <string>
   flags: <unsignedInt>

storageVolumeEnum API

Returns a list of all the storage volumes.

Argument List

   storageVolumeList: <string[]>
   flags: <unsignedInt>

storageVolumeGet API

Returns information about a specific storage volume.

Argument List

   storageVolume: <string>
   flags: <unsignedInt>

storageVolumeGroupAssocEnum API

Argument List

   storageVolume: <string>
   flags: <unsignedInt>

storageVolumeGroupAssocGet API

Argument List

   storageVolumeGroupId: <string>
   storageVolumeId: <string>

storageVolumeGroupClone API

Creates a complete block by block copy of all volumes in the group.

Argument List

   storageVolumeGroup: <string>
   cloneNamePrefix: <string>
   description: <string>
   provisionableId: <string>
   accessMode: <unsignedInt>
   flags: <unsignedInt>

storageVolumeGroupCreate API

Creates a new storage volume group comprised of the specified storage volumes.

Argument List

   name: <string>
   description: <string>
   storageVolumeList: <string[]>
   flags: <unsignedInt>

storageVolumeGroupDelete API

Deletes a storage volume group, the volumes are not deleted unless the delete-volumes flag is set.

Argument List

   storageVolumeGroup: <string>
   deleteAssociatedVolumes: <boolean>
   flags: <unsignedInt>

storageVolumeGroupEnum API

Returns a list of all the storage volume groups.

Argument List

   flags: <unsignedInt>

storageVolumeGroupGet API

Returns information about a specific storage volume group.

Argument List

   storageVolumeGroup: <string>
   flags: <unsignedInt>

storageVolumeGroupModify API

Modifies the name and/or description of a storage volume group.

Argument List

   storageVolumeGroup: <string>
   newName: <string>
   newDescription: <string>
   flags: <unsignedInt>

storageVolumeGroupSnapshot API

Creates a space efficient copy of all volumes in the group.

Argument List

   storageVolumeGroup: <string>
   snapshotNamePrefix: <string>
   description: <string>
   provisionableId: <string>
   count: <unsignedInt>
   accessMode: <unsignedInt>
   flags: <unsignedInt>

storageVolumeGroupVolumeAddRemove API

Adds/Removes one or more volumes to the specified volume group.

Argument List

   storageVolumeGroup: <string>
   modType: <unsignedInt>
   storageVolumeList: <string[]>
   flags: <unsignedInt>

storageVolumeImport API

Argument List

   storagePool: <string>
   importTypes: <unsignedInt>
   cleanupSnapshots: <boolean>
   replicationScheduleId: <string[]>
   flags: <unsignedInt>

storageVolumeModify API

Modifies a the name, description or other properties of the storage volume.

Argument List

   storageVolume: <string>
   newName: <string>
   newDescription: <string>
   newAccessMode: <unsignedInt>
   chapPolicy: <unsignedInt>
   chapUsername: <string>
   chapPassword: <string>
   clearSnapshotFlag: <boolean>
   enableCaching: <boolean>
   isActiveCheckpoint: <boolean>
   syncPolicy: <unsignedInt>
   compressionType: <string>
   copies: <unsignedInt>
   flags: <unsignedInt>

storageVolumeResize API

Resizes a storage volume to make it larger, volumes cannot be reduced in size.

Argument List

   storageVolume: <string>
   provisionableId: <string>
   newSizeInBytes: <unsignedLong>
   flags: <unsignedInt>

storageVolumeRestore API

Restores a storage volume to a previous point in time using a snapshot.

Argument List

   storageVolume: <string>
   snapshotVolume: <string>
   flags: <unsignedInt>

storageVolumeRollback API

Argument List

   storageVolume: <string>
   snapshotVolume: <string>
   flags: <unsignedInt>

storageVolumeSnapshot API

Creates a space efficient copy of the source volume.

Argument List

   storageVolume: <string>
   snapshotName: <string>
   description: <string>
   provisionableId: <string>
   accessMode: <unsignedInt>
   count: <unsignedInt>
   flags: <unsignedInt>

storageVolumeUtilizationEnum API

Returns volume utilization information for a specific storage volume or all storage volumes if no volume is specified.

Argument List

   storageVolume: <string>
   flags: <unsignedInt>

storageVolumeUtilizationGet API

Returns a specific volume utilization metrics for a single volume and specific date.

Argument List

   utilizationId: <string>
   flags: <unsignedInt>

storageVolumeUtilizationGetRetentionPeriod API

Argument List

   flags: <unsignedInt>

storageVolumeUtilizationSetRetentionPeriod API

Argument List

   daysToRetain: <unsignedInt>
   flags: <unsignedInt>

targetPortDisable API

Disables the specified target port.

Argument List

   port: <string>
   flags: <unsignedInt>

targetPortEnable API

Enables the specified target port.

Argument List

   port: <string>
   flags: <unsignedInt>

targetPortEnum API

Returns a list of all the target ports in the system.

Argument List

   flags: <unsignedInt>

targetPortGet API

Returns information about the specified target port.

Argument List

   port: <string>
   flags: <unsignedInt>

targetPortModify API

Modifies target port settings including IP address, gateway, mtu, etc.

Argument List

   port: <string>
   configType: <string>
   ipAddress: <string>
   netmask: <string>
   gateway: <string>
   mtu: <unsignedInt>
   iscsiEnabled: <boolean>
   description: <string>
   vportFloatList: <string[]>
   bondMode: <unsignedInt>
   flags: <unsignedInt>

targetPortRescan API

Discovers new target ports and/or any manual modifications made to the configuration of the target ports.

Argument List

   storageSystem: <string>
   flags: <unsignedInt>

targetPortRestart API

Restarts the specified target port.

Argument List

   port: <string>
   flags: <unsignedInt>

targetVirtualInterfaceCreate API

Creates a new virtual network interface which is linked to a physical network port.

Argument List

   storageSystemId: <string>
   parentPortId: <string>
   ipAddress: <string>
   netmask: <string>
   gateway: <string>
   macAddress: <string>
   portList: <string[]>
   mtu: <unsignedInt>
   description: <string>
   flags: <unsignedInt>

targetVirtualInterfaceMove API

Moves the specified virtual network interface to a different physical network port.

Argument List

   virtualInterfaceId: <string>
   targetPortId: <string>
   flags: <unsignedInt>

targetVirtualPortCreate API

Argument List

   storageSystemId: <string>
   ipAddress: <string>
   netmask: <string>
   gateway: <string>
   macAddress: <string>
   portList: <string[]>
   mtu: <unsignedInt>
   description: <string>
   bondMode: <unsignedInt>
   flags: <unsignedInt>

targetVirtualPortDelete API

Argument List

   port: <string>
   flags: <unsignedInt>

targetVlanInterfaceCreate API

Argument List

   storageSystemId: <string>
   parentPortId: <string>
   ipAddress: <string>
   netmask: <string>
   gateway: <string>
   vlanId: <unsignedInt>
   vlanQos: <unsignedInt>
   mtu: <unsignedInt>
   description: <string>
   flags: <unsignedInt>

taskCancel API

Cancels the specified task that is in the queue or is running.

Argument List

   id: <string>
   flags: <unsignedInt>

taskClearAll API

Clears all the completed and/or failed tasks.

Argument List

   flags: <unsignedInt>

taskEnum API

Returns a list of all the tasks including active, completed, and failed tasks.

Argument List

   taskIdlist: <string[]>
   flags: <unsignedInt>

taskGet API

Returns information about the specified task.

Argument List

   id: <string>
   flags: <unsignedInt>

taskUpdateProgress API

Argument List

   taskId: <string>
   description: <string>
   progress: <unsignedInt>
   state: <unsignedInt>
   flags: <unsignedInt>

traceLevelGet API

Argument List

   flags: <unsignedInt>

traceLevelModify API

Argument List

   traceLevel: <unsignedInt>
   stdOut: <boolean>
   traceFilter: <string[]>
   flags: <unsignedInt>

userAdd API

Adds a new user to the system. User accounts can access QuantaStor via the web management interface, remote scripting and via the qstorapi RESTful API.

Argument List

   username: <string>
   password: <string>
   role: <string>
   firstName: <string>
   lastName: <string>
   emailAddress: <string>
   description: <string>
   defaultChapUsername: <string>
   defaultChapPassword: <string>
   alertSubscriptions: <unsignedInt>
   flags: <unsignedInt>

userEnum API

Returns a list of all the users.

Argument List

   flags: <unsignedInt>

userGet API

Gets information about the specified user.

Argument List

   user: <string>
   flags: <unsignedInt>

userGroupAssocEnum API

Argument List

   user: <string>
   flags: <unsignedInt>

userGroupAssocGet API

Argument List

   userGroupId: <string>
   userId: <string>

userGroupCreate API

Creates a new storage user group comprised of the specified storage users.

Argument List

   name: <string>
   description: <string>
   userList: <string[]>
   flags: <unsignedInt>

userGroupDelete API

Deletes a storage user group, the users are not deleted unless the delete-users flag is set.

Argument List

   userGroup: <string>
   flags: <unsignedInt>

userGroupEnum API

Returns a list of all the storage user groups.

Argument List

   flags: <unsignedInt>

userGroupGet API

Returns information about a specific storage user group.

Argument List

   userGroup: <string>
   flags: <unsignedInt>

userGroupModify API

Modifies the name and/or description of a storage user group.

Argument List

   userGroup: <string>
   newName: <string>
   newDescription: <string>
   flags: <unsignedInt>

userGroupUserAddRemove API

Adds/Removes one or more users to the specified user group.

Argument List

   userGroup: <string>
   modType: <unsignedInt>
   userList: <string[]>
   flags: <unsignedInt>

userModify API

Modifies the name and/or description of a storage user group.

Argument List

   user: <string>
   newName: <string>
   newRole: <string>
   newFirstName: <string>
   newLastName: <string>
   newEmailAddress: <string>
   newDescription: <string>
   newDefaultChapUsername: <string>
   newDefaultChapPassword: <string>
   alertSubscriptions: <unsignedInt>
   flags: <unsignedInt>

userPasswordSet API

Sets a new password for specified user.

Argument List

   user: <string>
   oldPassword: <string>
   newPassword: <string>
   flags: <unsignedInt>

userRemove API

Removes specified user.

Argument List

   user: <string>
   flags: <unsignedInt>

virtualInterfaceAssocEnum API

Argument List

   flags: <unsignedInt>

virtualInterfaceAssocGet API

Argument List

   virtualInterfaceId: <string>
   targetPortId: <string>
   flags: <unsignedInt>

widgetCreate API

Argument List

   name: <string>
   flags: <unsignedInt>