+ Developer Guide Overview

QuantaStor REST API

QuantaStor was designed from the start with REST APIs to enable development of applications and extensions to remotely manage QuantaStor storage systems.

Supported Languages

You can use just about any programming language you like to communicate with QuantaStor via our RESTful API. Recommended tools:

• C/C++ - libcurl
• Python - PyCurl
• Unix/Linux/VMware/XenServer scripting - curl
• PHP - curl

Browser Tools

We highly recommend installing a tool like JSONView or other similar browser tool so that you can view the JSON output from the various API calls in an easy to read format. When experimenting with various APIs you can then use your browser to call the API, see the results, and plan for how to integrate it into your script or application.

Examples

Here's are some examples of how to enumerate various objects using the RESTful API and the curl utility:

curl -u admin:password https://192.168.0.116:8153/qstorapi/hostEnum -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/storageVolumeEnum -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/storageSystemGet -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/storagePoolEnum -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/userEnum -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/networkShareEnum -k

One quick way to test is to just enter one of these URLs (https://192.168.0.116:8153/qstorapi/hostEnum) into your web browser which will work as long as your system admin account is still using the default password. Pretty much every known language has a curl type library/module for it so the above technique will work everywhere, you just need to get up to speed with your preferred language's curl API mechanism.

Note you can even access APIs using wget which in this example will store the results into a file called hostEnum:

wget --no-check-certificate https://192.168.0.135:8153/qstorapi/hostEnum

Passing Args as a File

You can also call one of our RESTful APIs by passing a file instead of command line arguments. To do this your command will look something like this:

curl -k -u admin:password -d @file.json  https://192.168.0.116:8153/qstorapi/jsonrpc

An example of how the file should be formatted looks like this:

{
    "method": "echo",
    "params": {
        "inputMessage": "Message"
    }
}

The format being used is JSON. You specify the command you would like to call using the key "method". Then the parameters are passed in using the key "params". If more than one parameter is specified, separate them with a comma.

{
    "method": "command",
    "params": {
        "param1": "<value1>",
        "param2": "<value2>",
        "param3": "<value3>"
    }
}

Reflection

The RESTful API has basic support for reflection, meaning that you can learn about all the arguments for a given API just by calling it with the 'help' parameter like so:

curl -k -u admin:password https://192.168.0.116:8153/qstorapi/hostAdd?help

Calling APIs with Parameters

To call an API with parameters you'll need to add a & between each parameter you specify and a ? between the API name and the start of the parameters like so:

curl -k -u admin:password "https://192.168.0.116:8153/qstorapi/hostAdd?iqn=iqn.1991-05.com.microsoft:osn-mediaserver3&hostname=mediaserver3&flags=0"

Which will return JSON output like this (note the quotes so that the ampersand is not interpreted by the shell). Also note that sometimes it can be hard to read the JSON output so we recommend using a JSON Formatter when you're developing your integration code.

{
   "task":{
      "i18nDescription":{
         "messageText":null,
         "messageId":null
      },
      "operation":"add",
      "id":"ca54a531-6386-a4f7-b9de-30f505329bb1",
      "objectType":"Host",
      "finishTimeStamp":"1969-12-31 16:00:00",
      "isRemote":false,
      "createdTimeStamp":"2012-08-23 21:53:40",
      "state":0,
      "acls":[
         {
            "reserved":0,
            "objectId":"ca54a531-6386-a4f7-b9de-30f505329bb1",
            "ownerType":23,
            "ownerId":"252d4786-b19f-ae43-1ff6-453bee8a652e",
            "accessLevel":2,
            "objectType":16
         }
      ],
      "clientIpAddress":"127.0.0.1",
      "parentId":null,
      "modifiedByUserId":null,
      "progress":0,
      "customId":null,
      "type":16,
      "description":"Adding host 'mediaserver3' to service with iSCSI initiator IQN 'iqn.1991-05.com.microsoft:osn-mediaserver3'.",
      "errorMessage":{
         "function":null,
         "severity":0,
         "errorCode":0,
         "file":null,
         "message":{
            "messageText":null,
            "messageId":null
         },
         "line":0
      },
      "modifiedTimeStamp":"1969-12-31 16:00:00",
      "storageSystemId":"50ce62e6-6846-c5b3-d8a1-27061a696604",
      "createdByUserId":"252d4786-b19f-ae43-1ff6-453bee8a652e",
      "name":"Add Host",
      "startTimeStamp":"2012-08-23 21:53:40",
      "taskState":2
   },
   "obj":{
      "username":null,
      "storageSystemId":"50ce62e6-6846-c5b3-d8a1-27061a696604",
      "isRemote":false,
      "hostGroupId":null,
      "name":"mediaserver3",
      "ipAddress":null,
      "createdByUserId":"252d4786-b19f-ae43-1ff6-453bee8a652e",
      "modifiedTimeStamp":"1969-12-31 16:00:00",
      "createdTimeStamp":"2012-08-23 21:53:40",
      "state":0,
      "hostOsType":0,
      "initiatorPortList":[
         {
            "storageSystemId":"50ce62e6-6846-c5b3-d8a1-27061a696604",
            "isRemote":false,
            "hostId":"4fb8c2da-235a-18f9-2620-1d8aa5da89c5",
            "name":"iqn.1991-05.com.microsoft:osn-mediaserver3",
            "ipAddress":null,
            "createdByUserId":"252d4786-b19f-ae43-1ff6-453bee8a652e",
            "modifiedTimeStamp":"1969-12-31 16:00:00",
            "createdTimeStamp":"2012-08-23 21:53:40",
            "wwpn":null,
            "state":0,
            "iqn":"iqn.1991-05.com.microsoft:osn-mediaserver3",
            "initiatorType":0,
            "modifiedByUserId":null,
            "customId":null,
            "type":13,
            "id":"535abed2-830a-a437-d6fd-5af7c5b5c263"
         }
      ],
      "modifiedByUserId":null,
      "customId":null,
      "password":"********",
      "type":11,
      "id":"4fb8c2da-235a-18f9-2620-1d8aa5da89c5",
      "description":"None"
   }
}

Async vs. Sync (blocking vs non-blocking) API calls

All of the APIs for QuantaStor that modify the configuration in any way will start a task in the system. If you call any API with the flags parameter set to 0 it'll be treated as a blocking call which wait for the task to complete before returning. If you want to call the function and have it return immediately you can pass a 1 as the flags parameter which indicates to the server that the caller wants this to be an asynchronous non-blocking call. With asynchronous calls you'll get the task object back so that you can use the taskGet API to monitor the progress of the operation. When the task completes it will populate the customId property of the task to contain the ID(s) of the objects which were created/deleted/modified by the task.

Task Monitoring

As indicated above, sometimes you'll want to call an API asynchronously so that you can monitor the progress of the task and/or because you want to queue up multiple operations to run simultaneously. In such cases where you call an API asynchronously (flags=1) you can monitor the progress of the task using the tastGet API or the tastEnum API if you want to see all running tasks. When the task is completed you can check the customId property to see the ID(s) of the objects created/modified.

Security

QuantaStor REST interface always uses SSL via HTTPS. You can change the pem keys on your system by replacing the qstorapi_server.pem file located in /opt/osnexus/quantastor/restsrv/ with your own. If you want to use plain HTTP without SSL you can rename or remove the qstorapi_server.pem and the RESTful service will automatically fall back to using HTTP. After removing the file just restart the RESTful service interface with:

service restsrv restart

If you want to block access to the restful interface you can stop the service and/or you can remove access to port 8153 by removing the entry associated with that port number from the /etc/init.d/iptables configuration file and then restart iptables like so:

service iptables restart

In a similar manner you can block access to the web management interface on port 80/8080.

Supported SOAP / WebServices Implementations

• gSOAP (C++, all platforms)
• Apache Axis (Java, all platforms)
• .NET (C# & Visual Basic, Windows)

API List

The following represents the full API list for every API in QuantaStor. Nothing is left out, if you can do it from the web management interface or the CLI, it's here.

Examples

 
curl -u username:password -k https://hostname:8153/qstorapi/aclAdd?objectId=<id>&ownerType=<int>&ownerId=<id>&accessLevel=<int>&objectType=<int> 

curl -u username:password -k https://hostname:8153/userAdd?username=tiger&password=passWORD1&firstName=Tiger&lastName=Woods&role=Administrator

curl -u username:password -k -d @data.json https://hostname:8153/qstorapi/jsonrpc

Example Script

Here is an example script in python. To use this example replace the ip address with your QuantaStor boxes ip.

import json
import subprocess

print "I am getting the storage system info..."
#To get the data make an http request (such as a curl call)

proc = subprocess.Popen(["curl", "-k", "-u", "admin:password",
         "https://192.168.0.142:8153/qstorapi/storageSystemGet?"], stdout=subprocess.PIPE)

(out, err) = proc.communicate()

print
print "Here is what the returned data looks like when I get it:"
print
print str(out)
print

#call json.loads to turn it into a python dictionary
out = json.loads(out)
print "Here is how to get a single field from the output:"
print
storageSystemId = out["id"]
print storageSystemId

aclAdd API

Enables access to the specific volume for a specific user.

Argument List

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

aclModify API

Modifies the current acl assignment.

Argument List

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

aclRemove API

Removes the acl assignment.

Argument List

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

alertClear API

Deletes the alert with the specified ID.

Argument List

   flags: <unsignedInt>
   id: <string>

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

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

alertEnum API

Returns a list of all the alerts.

Argument List

   flags: <unsignedInt>

alertGet API

Gets information about a specific alert.

Argument List

   flags: <unsignedInt>
   id: <string>

alertRaise API

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

Argument List

   message: <string>
   flags: <unsignedInt>
   severity: <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

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

cloudBackupScheduleAssocEnum API

List the cloud backup schedule associations.

Argument List

   flags: <unsignedInt>
   schedule: <string>

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

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

cloudBackupScheduleDelete API

Deletes the specified cloud backup schedule.

Argument List

   flags: <unsignedInt>
   schedule: <string>

cloudBackupScheduleDisable API

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

Argument List

   flags: <unsignedInt>
   schedule: <string>

cloudBackupScheduleEnable API

Enables a cloud backup schedule that was previously disabled.

Argument List

   flags: <unsignedInt>
   schedule: <string>

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

   flags: <unsignedInt>
   schedule: <string>

cloudBackupScheduleModify API

Modifies the settings for the specified cloud backup schedule.

Argument List

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

cloudBackupScheduleVolumeAddRemove API

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

Argument List

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

cloudContainerAdd API

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

Argument List

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

cloudContainerCreate API

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

Argument List

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

cloudContainerDelete API

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

Argument List

   flags: <unsignedInt>
   container: <string>

cloudContainerDisable API

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

Argument List

   flags: <unsignedInt>
   container: <string>

cloudContainerEnable API

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

Argument List

   flags: <unsignedInt>
   container: <string>

cloudContainerEnum API

Returns a list of cloud backup containers in the system.

Argument List

   flags: <unsignedInt>

cloudContainerGet API

Retruns detailed information on a specific cloud backup container.

Argument List

   flags: <unsignedInt>
   container: <string>

cloudContainerModify API

Modifies the specified cloud backup container settings.

Argument List

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

cloudContainerRemove API

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

Argument List

   flags: <unsignedInt>
   container: <string>

cloudContainerRepair API

Repairs the specificed cloud backup container.

Argument List

   flags: <unsignedInt>
   container: <string>

cloudProviderCredentialsAdd API

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

Argument List

   username: <string>
   machine: <string>
   providerId: <string>
   password: <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

   flags: <unsignedInt>
   credentialsId: <string>

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

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

cloudProviderLocationEnum API

Argument List

   flags: <unsignedInt>

cloudProviderLocationGet API

Argument List

   flags: <unsignedInt>
   locationId: <string>

cloudProviderLocationRemove API

Argument List

   flags: <unsignedInt>
   locationId: <string>

clusterFailoverGroupActivate API

Activate the cluster fail over group.

Argument List

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

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>
   zoneConfig: <string>
   flags: <unsignedInt>
   storagePool: <string>
   description: <string>

clusterFailoverGroupDelete API

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

Argument List

   flags: <unsignedInt>
   clusterFailoverGroup: <string>

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

   flags: <unsignedInt>
   clusterFailoverGroup: <string>

clusterFailoverGroupModify API

Modify the management grid properties.

Argument List

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

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

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

eventListenerNotify API

Argument List

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

eventListenerRegister API

Argument List

   eventListenerObj: <ns0:eventListener>

eventListenerUnregister API

Argument List

   listenerId: <string>

fcTargetPortDisable API

Disables the specified fiber channel port.

Argument List

   flags: <unsignedInt>
   port: <string>

fcTargetPortEnable API

Enables the specified fiber channel port.

Argument List

   flags: <unsignedInt>
   port: <string>

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

   flags: <unsignedInt>
   port: <string>

getHardwareConfig API

Argument List

   flags: <unsignedInt>

getLocalizedMessage API

Argument List

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

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>

hostAdd API

Adds the specified host.

Argument List

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

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

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

hostGroupDelete API

Removes the specified host group.

Argument List

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

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

   flags: <unsignedInt>
   hostGroup: <string>

hostGroupHostAddRemove API

Adds/Removes a host to the specified host group.

Argument List

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

hostGroupModify API

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

Argument List

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

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

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

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

   flags: <unsignedInt>
   hwController: <string>

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

   flags: <unsignedInt>
   hwController: <string>

hwBatteryBackupUnitGet API

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

Argument List

   hwBatteryBackupUnit: <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>

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

   flags: <unsignedInt>
   hwController: <string>

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>

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

   flags: <unsignedInt>
   hwController: <string>

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

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

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

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

hwDiskRemove API

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

Argument List

   flags: <unsignedInt>
   diskId: <string>

hwEnclosureEnum API

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

Argument List

   flags: <unsignedInt>
   hwController: <string>

hwEnclosureGet API

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

Argument List

   hwEnclosure: <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

   flags: <unsignedInt>
   switchAdapterId: <string>

hwSwitchCredentialsAdd API

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

Argument List

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

hwSwitchCredentialsEnum API

Returns a list of all the storage switch login credentials.

Argument List

   flags: <unsignedInt>
   switchAdapterId: <string>

hwSwitchCredentialsGet API

Returns information about pecific storage switch login credentials.

Argument List

   flags: <unsignedInt>
   switchCredentials: <string>

hwSwitchCredentialsModify API

Modifies the switch login credentials.

Argument List

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

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

   flags: <unsignedInt>
   switchAdapterId: <string>

hwSwitchFailoverGroupActivate API

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

Argument List

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

hwSwitchFailoverGroupCreate API

Creates a new switch failover group.

Argument List

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

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

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

hwSwitchFailoverGroupPoolAssocEnum API

Argument List

   hwSwitchFailoverGroup: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupPoolAssocGet API

Argument List

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

hwSwitchFailoverGroupSetMode API

Argument List

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

hwSwitchFailoverGroupSystemAssocAdd API

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

Argument List

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

hwSwitchFailoverGroupSystemAssocEnum API

Argument List

   hwSwitchFailoverGroup: <string>
   flags: <unsignedInt>

hwSwitchFailoverGroupSystemAssocGet API

Argument List

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

hwSwitchFailoverGroupSystemAssocRemove API

Removes a storage system from the failover group.

Argument List

   storageSystemId: <string>
   hwSwitchFailoverGroup: <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

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

hwSwitchZonesetEnum API

Returns a list of all the discovered zonesets.

Argument List

   flags: <unsignedInt>
   switchCredentialsId: <string>

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

   raidType: <unsignedInt>
   diskList: <string[]>
   controllerId: <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

   flags: <unsignedInt>
   unitId: <string>

hwUnitEnum API

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

Argument List

   flags: <unsignedInt>
   hwController: <string>

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

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

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

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

hwUnitSsdCacheCreate API

Argument List

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

hwUnitSsdCacheDisable API

Argument List

   flags: <unsignedInt>
   unitId: <string>

hwUnitSsdCacheEnable API

Argument List

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

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

   flags: <unsignedInt>
   port: <string>

libratoMetricsConfigGet API

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

Argument List

   flags: <unsignedInt>
   storageSystem: <string>

libratoMetricsConfigSet API

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

Argument List

   username: <string>
   enableAlertAnnotations: <boolean>
   storageSystem: <string>
   postIntervalSec: <unsignedInt>
   token: <string>
   enableConfigAnnotations: <boolean>
   autoDashboardCreate: <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

   flags: <unsignedInt>
   licenseKey: <string>

licenseAdd API

Adds a license key using a license key block.

Argument List

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

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

   flags: <unsignedInt>
   license: <string>

licenseRemove API

Removes the specified license key.

Argument List

   flags: <unsignedInt>
   license: <string>

login API

Argument List

   reserved: <string>

networkShareClientAdd API

Adds a client for the specified network share.

Argument List

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

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

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

networkShareClientModify API

Modifies a client for the specified network share.

Argument List

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

networkShareClientRemove API

Removes a client for the specified network share.

Argument List

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

networkShareClone API

Clones the specified network share.

Argument List

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

networkShareCreate API

Creates a new NFSv3 network share.

Argument List

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

networkShareDelete API

Deletes the specified network share.

Argument List

   flags: <unsignedInt>
   networkShareId: <string>

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>

networkShareGet API

Returns information about the specified network share.

Argument List

   networkShare: <string>
   flags: <unsignedInt>

networkShareModify API

Modifies a client for the specified network share.

Argument List

   networkShare: <string>
   flags: <unsignedInt>
   name: <string>
   isActive: <boolean>
   description: <string>

networkShareNfsConfig API

Argument List

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

networkShareRestore API

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

Argument List

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

networkShareServicesRestart API

Restarts the network share service.

Argument List

   flags: <unsignedInt>
   storageSystem: <string>

networkShareSnapshot API

Snapshots the specified network share.

Argument List

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

objectEnum API

Argument List

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

objectGet API

Gets the object based on the id provided.

Argument List

   flags: <unsignedInt>
   id: <string>

objectLock API

Locks the specified object.

Argument List

   id: <string>

objectPropertyGet API

Gets the specified property on an object.

Argument List

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

objectPropertySet API

Sets the specified property on an object.

Argument List

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

objectUnlock API

Unlocks an object.

Argument List

   id: <string>

permissionDefinitionEnum API

Argument List

   flags: <unsignedInt>

physicalDiskEnum API

Enumerates all physical disks.

Argument List

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

physicalDiskGet API

Gets information about a specific physical disk.

Argument List

   physicalDrive: <string>
   flags: <unsignedInt>

physicalDiskIdentify API

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

Argument List

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

physicalDiskPathAssocEnum API

Argument List

   flags: <unsignedInt>
   multipathDiskId: <string>

physicalDiskPathAssocGet API

Argument List

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

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

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

remoteStoragePoolEnum API

Returns a list of all the remote storage pools.

Argument List

   remoteStorageSystemId: <string>
   flags: <unsignedInt>

replicaAssocDelete API

Argument List

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

replicaAssocEnum API

Argument List

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

replicaAssocGet API

Argument List

   flags: <unsignedInt>
   assocId: <string>

replicaAssocUpdate API

Argument List

   assocObj: <ns0:replicaAssoc>
   flags: <unsignedInt>

replicaCreate API

Argument List

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

replicaCreateNetworkShareTarget API

Argument List

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

replicaCreateVolumeTarget API

Argument List

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

replicaStop API

Argument List

   flags: <unsignedInt>
   assocId: <string>

replicaSync API

Argument List

   flags: <unsignedInt>
   assocId: <string>

replicationScheduleAddRemove API

Argument List

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

replicationScheduleAssocEnum API

Argument List

   flags: <unsignedInt>
   schedule: <string>

replicationScheduleAssocGet API

Argument List

   replicatableId: <string>
   scheduleId: <string>

replicationScheduleCreate API

Argument List

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

replicationScheduleDelete API

Argument List

   flags: <unsignedInt>
   schedule: <string>

replicationScheduleDisable API

Argument List

   flags: <unsignedInt>
   schedule: <string>

replicationScheduleEnable API

Argument List

   flags: <unsignedInt>
   schedule: <string>

replicationScheduleEnum API

Argument List

   flags: <unsignedInt>

replicationScheduleGet API

Argument List

   flags: <unsignedInt>
   schedule: <string>

replicationScheduleModify API

Argument List

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

roleCreate API

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

Argument List

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

roleDelete API

Removes the specified role identified by name or ID.

Argument List

   flags: <unsignedInt>
   role: <string>

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

   flags: <unsignedInt>
   role: <string>

roleModify API

Modifies the name and/or description of a role.

Argument List

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

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

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

rolePermissionsAddRemove API

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

Argument List

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

roleSubjectAssocEnum API

Argument List

   flags: <unsignedInt>
   role: <string>

roleSubjectAssocGet API

Argument List

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

sessionClose API

Forcably 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

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

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

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

siteCreate API

Argument List

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

siteDelete API

Argument List

   flags: <unsignedInt>
   site: <string>

siteEnum API

Argument List

   flags: <unsignedInt>

siteGet API

Argument List

   flags: <unsignedInt>
   site: <string>

siteModify API

Argument List

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

siteStorageSystemAddRemove API

Argument List

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

snapshotScheduleAssocEnum API

Argument List

   flags: <unsignedInt>
   schedule: <string>

snapshotScheduleAssocGet API

Argument List

   scheduleId: <string>
   storageVolumeId: <string>

snapshotScheduleCreate API

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

Argument List

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

snapshotScheduleDelete API

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

Argument List

   flags: <unsignedInt>
   schedule: <string>

snapshotScheduleDisable API

Disables the specified snapshot schedule.

Argument List

   flags: <unsignedInt>
   schedule: <string>

snapshotScheduleEnable API

Enables the specified snapshot schedule.

Argument List

   flags: <unsignedInt>
   schedule: <string>

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

   flags: <unsignedInt>
   schedule: <string>

snapshotScheduleModify API

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

Argument List

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

snapshotScheduleVolumeAddRemove API

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

Argument List

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

storageCloudCreate API

Creates a new storage cloud compiresed of the specifed users, resources and chap information.

Argument List

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

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

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

Argument List

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

storageCloudResourceAddRemove API

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

Argument List

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

storageCloudResourceAssocEnum API

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

Argument List

   flags: <unsignedInt>
   resource: <string>

storageCloudResourceAssocGet API

Returns associated information of specified resource in the storage cloud.

Argument List

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

storageCloudResourceSetMode API

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

Argument List

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

storageCloudSubjectAssocEnum API

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

Argument List

   flags: <unsignedInt>
   subject: <string>

storageCloudSubjectAssocGet API

Returns associated information of a specified subject in a storager cloud.

Argument List

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

storageCloudUserAddRemove API

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

Argument List

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

storagePoolCreate API

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

Argument List

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

storagePoolDestroy API

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

Argument List

   flags: <unsignedInt>
   storagePool: <string>

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

   flags: <unsignedInt>
   storagePoolDevice: <string>

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

   flags: <unsignedInt>
   storagePool: <string>

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

   flags: <unsignedInt>
   storagePool: <string>

storagePoolGet API

Gets information about a specific storage pool.

Argument List

   flags: <unsignedInt>
   storagePool: <string>

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

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

storagePoolIdentify API

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

Argument List

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

storagePoolModify API

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

Argument List

   profile: <string>
   newName: <string>
   enableCompression: <boolean>
   isDefault: <boolean>
   storagePool: <string>
   noBarriers: <boolean>
   enableSsd: <boolean>
   flags: <unsignedInt>
   newDescription: <string>

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>

storagePoolReplicationConfigCreate API

Create a async remote replicaiton link between two storage pools.

Argument List

   primaryStoragePoolId: <string>
   diskBarrier: <boolean>
   protocolType: <string>
   replicationPort: <unsignedInt>
   secondaryStoragePoolId: <string>
   flags: <unsignedInt>
   resyncRate: <unsignedLong>
   diskFlushes: <boolean>
   storageSystemLinkId: <string>

storagePoolReplicationConfigDelete API

Delete the remote replication link between two storage pools.

Argument List

   scrubMetadataDevice: <boolean>
   flags: <unsignedInt>
   storagePoolReplicationConfigId: <string>

storagePoolReplicationConfigEnum API

List the remote replication linkes between pools.

Argument List

   flags: <unsignedInt>

storagePoolReplicationConfigGet API

Get info about a specific remote replication link between two pools.

Argument List

   storagePoolReplicationConfig: <string>
   flags: <unsignedInt>

storagePoolReplicationConfigModify API

Modify the async remote replication link between pools.

Argument List

   diskBarrier: <boolean>
   protocolType: <string>
   replicationPort: <unsignedInt>
   flags: <unsignedInt>
   resyncRate: <unsignedLong>
   diskFlushes: <boolean>
   storageSystemLinkId: <string>
   storagePoolReplicationConfigId: <string>

storagePoolRescan API

Rescans the specified storage system for storage pools.

Argument List

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

storagePoolSpareAddRemove API

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

Argument List

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

storagePoolStart API

Starts up a previously stopped storage pool.

Argument List

   flags: <unsignedInt>
   storagePool: <string>

storagePoolStop API

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

Argument List

   flags: <unsignedInt>
   storagePool: <string>

storagePoolUpdateRedirect API

Argument List

   flags: <unsignedInt>
   storagePool: <string>

storageQuotaCreate API

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

Argument List

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

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

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

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

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

storageQuotaVolumeAssocEnum API

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

Argument List

   flags: <unsignedInt>
   storageVolume: <string>

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

   storageSystemId: <string>
   storageSystemClusterId: <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

   targetPort: <string>
   name: <string>
   virtualHostIpAddress: <string>
   virtualHostGateway: <string>
   flags: <unsignedInt>
   virtualHostSubnetMask: <string>
   virtualHostName: <string>
   description: <string>

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>

storageSystemClusterModify API

Modify the management grid properties.

Argument List

   targetPort: <string>
   name: <string>
   virtualHostIpAddress: <string>
   virtualHostGateway: <string>
   flags: <unsignedInt>
   virtualHostSubnetMask: <string>
   virtualHostName: <string>
   description: <string>

storageSystemClusterNodeAdd API

Adds the specified storage system to the management grid.

Argument List

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

storageSystemClusterNodeEject API

Ejects the specified storage system from the management grid.

Argument List

   storageSystemClusterObj: <ns0:storageSystemCluster>
   flags: <unsignedInt>

storageSystemClusterNodeJoin API

Joins the specified storage system to the management grid.

Argument List

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

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

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

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 managment grid.

Argument List

   flags: <unsignedInt>

storageSystemGet API

Get general information about the storage system.

Argument List

   flags: <unsignedInt>
   storageSystem: <string>

storageSystemGroupAddRemoveLinks API

Argument List

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

storageSystemGroupAssocEnum API

Argument List

   flags: <unsignedInt>

storageSystemGroupAssocGet API

Argument List

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

storageSystemGroupCreate API

Argument List

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

storageSystemGroupDelete API

Argument List

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

storageSystemGroupEnum API

Argument List

   flags: <unsignedInt>

storageSystemGroupGet API

Argument List

   flags: <unsignedInt>
   groupId: <string>

storageSystemGroupModify API

Argument List

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

storageSystemGroupSetPassword API

Argument List

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

storageSystemLinkCreate API

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

Argument List

   linkType: <unsignedInt>
   localIpAddress: <string>
   description: <string>
   remoteAdminPassword: <string>
   storageSystemId: <string>
   flags: <unsignedInt>
   remoteIpAddress: <string>
   remoteAdminUser: <string>
   bandwidthLimit: <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: <ns0: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

   linkType: <unsignedInt>
   description: <string>
   linkId: <string>
   localIpAddress: <string>
   flags: <unsignedInt>
   remoteIpAddress: <string>
   bandwidthLimit: <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>
   remoteAdminPassword: <string>
   flags: <unsignedInt>
   remoteAdminUser: <string>

storageSystemLinkVerify API

Argument List

   linkObj: <ns0:storageSystemLink>
   flags: <unsignedInt>

storageSystemModify API

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

Argument List

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

storageSystemRecover API

Argument List

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

storageSystemRecoveryPointEnum API

Returns a list of all the available system metadata 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

   flags: <unsignedInt>
   storageSystem: <string>

storageSystemRestart API

Restarts the entire storage system.

Argument List

   flags: <unsignedInt>
   storageSystem: <string>

storageSystemSendLogs API

Argument List

   storageSystemId: <string>
   flags: <unsignedInt>

storageSystemShutdown API

Shutdown the storage system.

Argument List

   flags: <unsignedInt>
   storageSystem: <string>

storageSystemUpdateCheck API

Checks for updates for specified storage system.

Argument List

   flags: <unsignedInt>
   storageSystem: <string>

storageSystemUpgrade API

Upgrade to the latest version of the core packages.

Argument List

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

storageVolumeAclAddRemove API

Enables/Disables access to the specific volume from the specified host. (List of hosts for specified volume)

Argument List

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

storageVolumeAclAddRemoveEx API

Enables access to the specific volume from the specified host. (List of volumes for specified host)

Argument List

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

storageVolumeAclEnum API

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

Argument List

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

storageVolumeAclGet API

Gets the assignment information for specified host or storage volume.

Argument List

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

storageVolumeClone API

Creates a complete block copy of the source volume.

Argument List

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

storageVolumeCloudBackupCreate API

Argument List

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

storageVolumeCloudBackupRestore API

Argument List

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

storageVolumeCreate API

Creates a new storage volume in the specified storage pool.

Argument List

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

storageVolumeCreateEx API

Argument List

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

storageVolumeDelete API

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

Argument List

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

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

   flags: <unsignedInt>
   storageVolume: <string>

storageVolumeGroupAssocEnum API

Argument List

   flags: <unsignedInt>
   storageVolume: <string>

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>
   description: <string>
   accessMode: <unsignedInt>
   flags: <unsignedInt>
   cloneNamePrefix: <string>
   provisionableId: <string>

storageVolumeGroupCreate API

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

Argument List

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

storageVolumeGroupDelete API

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

Argument List

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

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

   flags: <unsignedInt>
   storageVolumeGroup: <string>

storageVolumeGroupModify API

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

Argument List

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

storageVolumeGroupSnapshot API

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

Argument List

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

storageVolumeGroupVolumeAddRemove API

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

Argument List

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

storageVolumeModify API

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

Argument List

   storageVolume: <string>
   newName: <string>
   flags: <unsignedInt>
   newAccessMode: <unsignedInt>
   chapUsername: <string>
   chapPolicy: <unsignedInt>
   chapPassword: <string>
   clearSnapshotFlag: <boolean>
   newDescription: <string>

storageVolumeResize API

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

Argument List

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

storageVolumeRestore API

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

Argument List

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

storageVolumeSnapshot API

Creates a space efficient copy of the source volume.

Argument List

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

storageVolumeUtilizationEnum API

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

Argument List

   flags: <unsignedInt>
   storageVolume: <string>

storageVolumeUtilizationGet API

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

Argument List

   flags: <unsignedInt>
   utilizationId: <string>

storageVolumeUtilizationGetRetentionPeriod API

Argument List

   flags: <unsignedInt>

storageVolumeUtilizationSetRetentionPeriod API

Argument List

   flags: <unsignedInt>
   daysToRetain: <unsignedInt>

targetPortDisable API

Disables the specified target port.

Argument List

   flags: <unsignedInt>
   port: <string>

targetPortEnable API

Enables the specified target port.

Argument List

   flags: <unsignedInt>
   port: <string>

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

   flags: <unsignedInt>
   port: <string>

targetPortModify API

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

Argument List

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

targetPortRescan API

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

Argument List

   flags: <unsignedInt>
   storageSystem: <string>

targetPortRestart API

Restarts the specified target port.

Argument List

   flags: <unsignedInt>
   port: <string>

targetVirtualInterfaceCreate API

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

Argument List

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

targetVirtualInterfaceMove API

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

Argument List

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

targetVirtualPortCreate API

Argument List

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

targetVirtualPortDelete API

Argument List

   flags: <unsignedInt>
   port: <string>

taskCancel API

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

Argument List

   flags: <unsignedInt>
   id: <string>

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

   flags: <unsignedInt>
   id: <string>

userAdd API

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

Argument List

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

userEnum API

Returns a list of all the users.

Argument List

   flags: <unsignedInt>

userGet API

Gets information about the specified user.

Argument List

   flags: <unsignedInt>
   user: <string>

userGroupAssocEnum API

Argument List

   flags: <unsignedInt>
   user: <string>

userGroupAssocGet API

Argument List

   userId: <string>
   userGroupId: <string>

userGroupCreate API

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

Argument List

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

userGroupDelete API

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

Argument List

   flags: <unsignedInt>
   userGroup: <string>

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

   flags: <unsignedInt>
   userGroup: <string>

userGroupModify API

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

Argument List

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

userGroupUserAddRemove API

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

Argument List

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

userModify API

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

Argument List

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

userPasswordSet API

Sets a new password for specified user.

Argument List

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

userRemove API

Removes specified user.

Argument List

   flags: <unsignedInt>
   user: <string>

virtualInterfaceAssocEnum API

Argument List

   flags: <unsignedInt>

virtualInterfaceAssocGet API

Argument List

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

Enumeration Types

The enumeration types listed below are used with APIs noted above. Many of the enumerations have assigned values like "OSN_CMN_FLAG_ASYNC = 0x0001" but for those that do not have assigned values note that they are 0 indexed. For example, OSN_CMN_ACCESSTYPE_READWRITE should be specified as 0 and OSN_CMN_ACCESSTYPE_READONLY specified as a 1 to the storageVolumeModify API as the accessMode for changing the configuration of a storage volume.

Enumeration Definitions

typedef enum osn__flags
{
    OSN_CMN_FLAG_NONE             = 0x0000,
    OSN_CMN_FLAG_ASYNC            = 0x0001,
    OSN_CMN_FLAG_FORCE            = 0x0002,
    OSN_CMN_FLAG_ASYNC_FORCE      = 0x0003,
    OSN_CMN_FLAG_RESCAN           = 0x0004,
    OSN_CMN_FLAG_ASYNC_RESCAN     = 0x0005, 
    OSN_CMN_FLAG_FORCE_RESCAN     = 0x0006, 
    OSN_CMN_FLAG_FORCE_ASYNC_RESCAN = 0x0007, 
    OSN_CMN_FLAG_GENERATE_NAME    = 0x0008, 
    OSN_CMN_FLAG_SYNC_PRIMARY     = 0x0010,
    OSN_CMN_FLAG_SYNC_SECONDARY   = 0x0020,
    OSN_CMN_FLAG_REDIRECT         = 0x0040,
    OSN_CMN_FLAG_SUPPRESS_ALARMS  = 0x0080,
    OSN_CMN_FLAG_STOP_VERIFY      = 0x0100,
    OSN_CMN_FLAG_USE_GUID_IQN     = 0x0200, 
    OSN_CMN_FLAG_EXPORT           = 0x0400,
    OSN_CMN_FLAG_RESCUE_MODE      = 0x0800,
    OSN_CMN_FLAG_START_REPAIR     = 0x1000,
    OSN_CMN_FLAG_SPARES_ONLY      = 0x2000,
    OSN_CMN_FLAG_LAZY             = 0x4000,
    OSN_CMN_FLAG_MAX              = 0x8000
} osn__flags_t;

//--spares-only   args.hasArg("spares-only") ? flags | OSN_CMN_FLAG_SPARES_ONLY : flags

typedef enum osn__modifyType
{
    OSN_CMN_MOD_OP_ADD = 0,
    OSN_CMN_MOD_OP_REMOVE = 1,
    OSN_CMN_MOD_OP_SET = 2
} osn__modifyType_t;

typedef enum osn__nfsServiceMode
{
    OSN_CMN_NFS_MODE_V3 = 0,
    OSN_CMN_NFS_MODE_V4 = 1,
    OSN_CMN_NFS_MODE_GLUSTER = 2
} osn__nfsServiceMode_t;

typedef enum osn__accessType
{
    OSN_CMN_ACCESSTYPE_READWRITE,
    OSN_CMN_ACCESSTYPE_READONLY,
    OSN_CMN_ACCESSTYPE_NONE
} osn__accessType_t;

typedef enum osn__cifsUserAccessMode
{
    OSN_CMN_CIFS_USER_ACCESS_NONE,
    OSN_CMN_CIFS_USER_ACCESS_VALID,
    OSN_CMN_CIFS_USER_ACCESS_ADMIN,
    OSN_CMN_CIFS_USER_ACCESS_INVALID
} osn__cifsUserAccessMode_t;

typedef enum osn__cacheType
{
    OSN_CMN_ACCESSTYPE_WRITETHRU,
    OSN_CMN_ACCESSTYPE_WRITEBACK
} osn__cacheType_t;

typedef enum osn__syncPolicy
{
    OSN_CMN_SYNCTYPE_STANDARD,
    OSN_CMN_SYNCTYPE_ALWAYS,
    OSN_CMN_SYNCTYPE_DISABLED,
    OSN_CMN_SYNCTYPE_AUTO
} osn__syncPolicy_t;

typedef enum osn__chapPolicy
{
    OSN_CHAP_DISABLED=0,
    OSN_CHAP_USE_TARGET_CHAP=1,
    OSN_CHAP_USE_USER_CHAP_DEFAULTS=2,
    OSN_CHAP_USE_TARGET_AND_USER_CHAP=3,
    OSN_CHAP_USE_STORAGE_CLOUD_CHAP_DEFAULTS=4
} osn__chapPolicy_t;

typedef enum osn__alertTriggerDataType
{
    OSN_CMN_ALERT_DATATYPE_UNKNOWN,
    OSN_CMN_ALERT_DATATYPE_DURATION_IN_SEC,
    OSN_CMN_ALERT_DATATYPE_PERCENTAGE,
    OSN_CMN_ALERT_DATATYPE_BOOL_ON_OFF,
    OSN_CMN_ALERT_DATATYPE_COUNT,
    OSN_CMN_ALERT_DATATYPE_MAX
} osn__alertTriggerDataType_t;

typedef enum osn__quotaPolicy
{
    OSN_CMN_QUOTA_POLICY_SOFT,
    OSN_CMN_QUOTA_POLICY_HARD
} osn__quotaPolicy_t;

typedef enum osn__initiatorType
{
    OSN_CMN_INITIATOR_ISCSI=0,
    OSN_CMN_INITIATOR_FCP=1,
    OSN_CMN_INITIATOR_IB=2
} osn__initiatorType_t;

typedef enum osn__linkState
{
    OSN_CMN_LINKSTATE_UP,
    OSN_CMN_LINKSTATE_DOWN,
    OSN_CMN_LINKSTATE_UNKNOWN
} osn__linkState_t;

typedef enum osn__objectState
{
    OSN_CMN_OBJSTATE_NORMAL,
    OSN_CMN_OBJSTATE_WARNING,
    OSN_CMN_OBJSTATE_BUSY,
    OSN_CMN_OBJSTATE_ERROR,
    OSN_CMN_OBJSTATE_INITIALIZING,
    OSN_CMN_OBJSTATE_MISSING,
    OSN_CMN_OBJSTATE_OFFLINE,
    OSN_CMN_OBJSTATE_DISCONNECTED
} osn__objectState_t;

typedef enum osn__dataType
{
    OSN_CMN_DATATYPE_STRING,
    OSN_CMN_DATATYPE_INT,
    OSN_CMN_DATATYPE_TIME,
    OSN_CMN_DATATYPE_FLOAT
} osn__dataType_t;

typedef enum osn__eventType
{
    OSN_CMN_EVENTTYPE_ADD,
    OSN_CMN_EVENTTYPE_REMOVE,
    OSN_CMN_EVENTTYPE_MODIFY
} osn__eventType_t;

typedef enum osn__eventListenerType
{
    OSN_CMN_LISTENERTYPE_OBSERVER=0,
    OSN_CMN_LISTENERTYPE_SECONDARY=1,
    OSN_CMN_LISTENERTYPE_PRIMARY=2
} osn__eventListenerType_t;

typedef enum osn__eventListenerMode
{
    OSN_CMN_LISTENERMODE_ENQUEUE=0,
    OSN_CMN_LISTENERMODE_PROCESS=1,
    OSN_CMN_LISTENERMODE_FLUSH=2
} osn__eventListenerMode_t;

typedef enum osn__replicaAssocType
{
    OSN_CMN_REPLICA_CHILD,
    OSN_CMN_REPLICA_HEAD
} osn__replicaAssocType_t;

typedef enum osn__replicationActionType
{
    OSN_CMN_REPLICATION_SETUP,
    OSN_CMN_REPLICATION_CONNECT,
    OSN_CMN_REPLICATION_DISCONNECT,
    OSN_CMN_REPLICATION_RECONNECT,
    OSN_CMN_REPLICATION_ADJUST
} osn__replicationActionType_t;

typedef enum osn__replicationCongestionPolicy
{
    OSN_CMN_REPLICATION_CONGESTION_POLICY_SYNC,
    OSN_CMN_REPLICATION_CONGESTION_POLICY_PULL_AHEAD
} osn__replicationCongestionPolicy_t;

typedef enum osn__initPriorityType
{
    OSN_INITPRIORITY_DEFAULT,
    OSN_INITPRIORITY_LOW,
    OSN_INITPRIORITY_MEDIUM,
    OSN_INITPRIORITY_HIGH
} osn__initPriorityType_t;

typedef enum osn__objectType
{
    OSN_CMN_OBJECTTYPE_UNKNOWN,
    OSN_CMN_OBJECTTYPE_SNAPSHOT_SCHEDULE,
    OSN_CMN_OBJECTTYPE_SNAPSHOT_SCHEDULE_ASSOC,
    OSN_CMN_OBJECTTYPE_STORAGE_VOLUME,
    OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_UTILIZATION,
    OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_GROUP,
    OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_GROUP_ASSOC,
    OSN_CMN_OBJECTTYPE_STORAGE_POOL,
    OSN_CMN_OBJECTTYPE_STORAGE_POOL_DEVICE,
    OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM,
    OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_ACL,
    OSN_CMN_OBJECTTYPE_HOST,
    OSN_CMN_OBJECTTYPE_HOST_GROUP,
    OSN_CMN_OBJECTTYPE_INITIATOR_PORT,
    OSN_CMN_OBJECTTYPE_TARGET_PORT,
    OSN_CMN_OBJECTTYPE_PHYSICAL_DISK,
    OSN_CMN_OBJECTTYPE_TASK,
    OSN_CMN_OBJECTTYPE_AUDIT_ENTRY,
    OSN_CMN_OBJECTTYPE_AUDIT_SETTINGS,
    OSN_CMN_OBJECTTYPE_ALERT,
    OSN_CMN_OBJECTTYPE_ALERT_CONFIG_SETTINGS,
    OSN_CMN_OBJECTTYPE_LICENSE,
    OSN_CMN_OBJECTTYPE_LICENSE_ACTIVATION,
    OSN_CMN_OBJECTTYPE_USER,
    OSN_CMN_OBJECTTYPE_USER_PERMISSION_ASSIGNMENT,
    OSN_CMN_OBJECTTYPE_USER_GROUP,
    OSN_CMN_OBJECTTYPE_USER_GROUP_ASSOC,
    OSN_CMN_OBJECTTYPE_ROLE,
    OSN_CMN_OBJECTTYPE_ROLE_PERMISSION_ASSIGNMENT,
    OSN_CMN_OBJECTTYPE_ROLE_SUBJECT_ASSOC,
    OSN_CMN_OBJECTTYPE_PERMISSION_DEFINITION,
    OSN_CMN_OBJECTTYPE_STORAGE_CLOUD,
    OSN_CMN_OBJECTTYPE_STORAGE_CLOUD_ASSOC,
    OSN_CMN_OBJECTTYPE_STORAGE_CLOUD_SUBJECT_ASSOC,
    OSN_CMN_OBJECTTYPE_SESSION,
    OSN_CMN_OBJECTTYPE_STORAGE_TIER,
    OSN_CMN_OBJECTTYPE_STORAGE_TIER_ASSOC,
    OSN_CMN_OBJECTTYPE_STORAGE_QUOTA,
    OSN_CMN_OBJECTTYPE_STORAGE_QUOTA_ASSOC,
    OSN_CMN_OBJECTTYPE_ACL,
    OSN_CMN_OBJECTTYPE_OBJECT_PROPERTY,
    OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_LINK,
    OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_GROUP,
    OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_GROUP_ASSOC,
    OSN_CMN_OBJECTTYPE_REPLICA_ASSOC,
    OSN_CMN_OBJECTTYPE_PHYSICAL_DISK_PATH_ASSOC,
    OSN_CMN_OBJECTTYPE_HW_ALARM,
    OSN_CMN_OBJECTTYPE_HW_BBU,
    OSN_CMN_OBJECTTYPE_HW_DISK,
    OSN_CMN_OBJECTTYPE_HW_UNIT,
    OSN_CMN_OBJECTTYPE_HW_ENCLOSURE,
    OSN_CMN_OBJECTTYPE_HW_CONTROLLER,
    OSN_CMN_OBJECTTYPE_HW_CONTROLLER_GROUP,
    OSN_CMN_OBJECTTYPE_NETWORK_SHARE,
    OSN_CMN_OBJECTTYPE_NETWORK_SHARE_CLIENT,
    OSN_CMN_OBJECTTYPE_REPLICATION_SCHEDULE,
    OSN_CMN_OBJECTTYPE_REPLICATION_SCHEDULE_ASSOC,
    OSN_CMN_OBJECTTYPE_HW_LOGICAL_DRIVE,
    OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_RECOVERY_POINT,
    OSN_CMN_OBJECTTYPE_CLOUD_CONTAINER,
    OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER,
    OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER_CREDENTIALS,
    OSN_CMN_OBJECTTYPE_CLOUD_BACKUP_SCHEDULE,
    OSN_CMN_OBJECTTYPE_CLOUD_BACKUP_SCHEDULE_ASSOC,
    OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER_LOCATION,
    OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_CLUSTER,
    OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_CLUSTER_ASSOC,
    OSN_CMN_OBJECTTYPE_CLUSTER_FAILOVER_GROUP,
    OSN_CMN_OBJECTTYPE_FC_TARGET_PORT,
    OSN_CMN_OBJECTTYPE_NETWORK_SHARE_SERVICE_CONFIG,
    OSN_CMN_OBJECTTYPE_WIDGET,
    OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_LINK_KEY,
    OSN_CMN_OBJECTTYPE_STORAGE_POOL_PROFILE,
    OSN_CMN_OBJECTTYPE_STORAGE_QUOTA_SHARE_ASSOC,
    OSN_CMN_OBJECTTYPE_SITE,
    OSN_CMN_OBJECTTYPE_SITE_ASSOC,
    OSN_CMN_OBJECTTYPE_VIRTUAL_INTERFACE_ASSOC,
    OSN_CMN_OBJECTTYPE_IB_TARGET_PORT,
    OSN_CMN_OBJECTTYPE_HW_SWITCH_CREDENTIALS,
    OSN_CMN_OBJECTTYPE_HW_SWITCH,
    OSN_CMN_OBJECTTYPE_HW_SWITCH_ZONESET,
    OSN_CMN_OBJECTTYPE_HW_SWITCH_ADAPTER,
    OSN_CMN_OBJECTTYPE_HW_SWITCH_FAILOVER_GROUP,
    OSN_CMN_OBJECTTYPE_HW_SWITCH_FAILOVER_GROUP_POOL_ASSOC,
    OSN_CMN_OBJECTTYPE_HW_SWITCH_FAILOVER_GROUP_SYSTEM_ASSOC,
    OSN_CMN_OBJECTTYPE_HW_SWITCH_CREDENTIALS_SYSTEM_ASSOC,
    OSN_CMN_OBJECTTYPE_LIBRATO_METRICS_CONFIG,
    OSN_CMN_OBJECTTYPE_STORAGE_POOL_REPLICATION_CONFIG,
    OSN_CMN_OBJECTTYPE_GLUSTER_VOLUME,
    OSN_CMN_OBJECTTYPE_GLUSTER_BRICK,
    OSN_CMN_OBJECTTYPE_GLUSTER_PEER,
    OSN_CMN_OBJECTTYPE_NETWORK_SHARE_USER_ACCESS,
    OSN_CMN_OBJECTTYPE_NETWORK_SHARE_CIFS_OPTION,
    OSN_CMN_OBJECTTYPE_ALERT_TRIGGER,
    OSN_CMN_OBJECTTYPE_HW_ENCLOSURE_LAYOUT,
    OSN_CMN_OBJECTTYPE_HW_UNIT_DISK_ASSOC,
    OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_GROUP,
    OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_INTERFACE,
    OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_MODULE,
    OSN_CMN_OBJECTTYPE_BACKUP_POLICY,
    OSN_CMN_OBJECTTYPE_BACKUP_JOB,
    OSN_CMN_OBJECTTYPE_GLUSTER_HA_FAILOVER_INTERFACE,
    OSN_CMN_OBJECTTYPE_CEPH_POOL,
    OSN_CMN_OBJECTTYPE_CEPH_OSD,
    OSN_CMN_OBJECTTYPE_CEPH_POOL_OSD_ASSOC,
    OSN_CMN_OBJECTTYPE_CEPH_CLUSTER,
    OSN_CMN_OBJECTTYPE_CEPH_MONITOR,
    OSN_CMN_OBJECTTYPE_CEPH_HA_FAILOVER_INTERFACE,
    OSN_CMN_OBJECTTYPE_CEPH_BLOCK_DEVICE,
    OSN_CMN_OBJECTTYPE_PHYSICAL_DISK_HOTSPARE_MARKER,
    OSN_CMN_OBJECTTYPE_MAX
} osn__objectType_t;

typedef enum osn__backupJobStage {
    OSN_CMN_BACKUP_STAGE_INITIALIZING = 0x0000,
    OSN_CMN_BACKUP_STAGE_SCANNING = 0x0001,
    OSN_CMN_BACKUP_STAGE_COPYING = 0x0002,
    OSN_CMN_BACKUP_STAGE_PURGING = 0x0003,
    OSN_CMN_BACKUP_STAGE_COMPLETED = 0x0004,
    OSN_CMN_BACKUP_STAGE_FAILED = 0x0005,
} osn__backupJobStage_t;

typedef enum osn__backupPurgePolicy {
    OSN_CMN_BACKUP_PURGE_POLICY_NEVER = 0x0000,
    OSN_CMN_BACKUP_PURGE_POLICY_AFTER_BACKUP = 0x0001,
    OSN_CMN_BACKUP_PURGE_POLICY_DAILY = 0x0002,
    OSN_CMN_BACKUP_PURGE_POLICY_WEEKLY = 0x0003,
} osn__backupPurgePolicy_t;

typedef enum osn__backupPolicyType {
    OSN_CMN_BACKUP_POLICY_TYPE_INBOUND = 0x0000,
    OSN_CMN_BACKUP_POLICY_TYPE_OUTBOUND = 0x0001,
} osn__backupPolicyType_t;

typedef enum osn__backupPolicyMountType {
    OSN_CMN_BACKUP_POLICY_MOUNT_NFS = 0x0000,
    OSN_CMN_BACKUP_POLICY_MOUNT_GLUSTER = 0x0001,
    OSN_CMN_BACKUP_POLICY_MOUNT_OCFS2 = 0x0002,
    OSN_CMN_BACKUP_POLICY_MOUNT_CIFS = 0x0003,
} osn__backupPolicyMountType_t;

typedef enum osn__backupPolicyRetentionCriteria {
    OSN_CMN_BACKUP_POLICY_RETENTION_ACCESS_TIME = 0x0001,
    OSN_CMN_BACKUP_POLICY_RETENTION_MODIFY_TIME = 0x0002,
    OSN_CMN_BACKUP_POLICY_RETENTION_CREATE_TIME = 0x0004,
} osn__backupPolicyRetentionCriteria_t;

typedef enum osn__alertSubscription
{
    OSN_CMN_ALERT_SUBSCRIPTION_NONE       = 0,
    OSN_CMN_ALERT_SUBSCRIPTION_CRITICAL   = 1,
    OSN_CMN_ALERT_SUBSCRIPTION_ERROR      = 2,
    OSN_CMN_ALERT_SUBSCRIPTION_WARNING    = 4,
    OSN_CMN_ALERT_SUBSCRIPTION_INFO       = 8
} osn__alertSubscription_t;

typedef enum osn__errorLevel
{
    OSN_CMN_SEVERITY_ALWAYS   = 0,
    OSN_CMN_SEVERITY_CRITICAL = 1,
    OSN_CMN_SEVERITY_ERROR    = 2,
    OSN_CMN_SEVERITY_WARNING  = 3,
    OSN_CMN_SEVERITY_INFO     = 4,
    OSN_CMN_SEVERITY_DEBUG    = 5,
    OSN_CMN_SEVERITY_VERBOSE  = 6,
    OSN_CMN_SEVERITY_DEBUG2   = 7
} osn__errorLevel_t;

typedef enum osn__taskState
{
    OSN_TASKSTATE_INITIALIZING,
    OSN_TASKSTATE_QUEUED,
    OSN_TASKSTATE_RUNNING,
    OSN_TASKSTATE_FAILED,
    OSN_TASKSTATE_CANCELLED,
    OSN_TASKSTATE_COMPLETED
} osn__taskState_t;

typedef enum osn__hostType
{
    OSN_HOSTTYPE_UNKNOWN,
    OSN_HOSTTYPE_AIX,
    OSN_HOSTTYPE_HPUX,
    OSN_HOSTTYPE_LINUX,
    OSN_HOSTTYPE_SOLARIS,
    OSN_HOSTTYPE_VMWARE,
    OSN_HOSTTYPE_WINDOWS,
    OSN_HOSTTYPE_XENSERVER,
    OSN_HOSTTYPE_OTHER,
    OSN_HOSTTYPE_MAC,
    OSN_HOSTTYPE_MAX
} osn__hostType_t;

typedef enum osn__retentionTag
{
    OSN_RETENTIONTAG_NONE=0,
    OSN_RETENTIONTAG_DAY=1,
    OSN_RETENTIONTAG_WEEK=2,
    OSN_RETENTIONTAG_MONTH=4,
    OSN_RETENTIONTAG_YEARLY=8,
    OSN_RETENTIONTAG_MAX=9
} osn__retentionTag_t;

typedef enum osn__networkShareType
{
    OSN_NETWORKSHARETYPE_STANDARD,
    OSN_NETWORKSHARETYPE_SUBVOL_BTRFS,
    OSN_NETWORKSHARETYPE_S3QL,
    OSN_NETWORKSHARETYPE_SUBVOL_ZFS,
    OSN_NETWORKSHARETYPE_GLUSTER_VOLUME
} osn__networkShareType_t;

typedef enum osn__storageVolumeType
{
    OSN_STORAGEVOLUMETYPE_FILE,
    OSN_STORAGEVOLUMETYPE_FILE_BTRFS,
    OSN_STORAGEVOLUMETYPE_FILE_EXT3,
    OSN_STORAGEVOLUMETYPE_FILE_EXT4,
    OSN_STORAGEVOLUMETYPE_RAW_DEVICE,
    OSN_STORAGEVOLUMETYPE_FILE_ZFS,
    OSN_STORAGEVOLUMETYPE_FILE_XFS,
    OSN_STORAGEVOLUMETYPE_FILE_S3QL,
    OSN_STORAGEVOLUMETYPE_FILE_JFS,
    OSN_STORAGEVOLUMETYPE_CEPH_RBD
} osn__storageVolumeType_t;

typedef enum osn__hwEnclosureLayoutFlow
{
    OSN_ENCLOSURELAYOUT_FLOW_T2B_L2R,
    OSN_ENCLOSURELAYOUT_FLOW_T2B_R2L,
    OSN_ENCLOSURELAYOUT_FLOW_B2T_L2R,
    OSN_ENCLOSURELAYOUT_FLOW_B2T_R2L,
    OSN_ENCLOSURELAYOUT_FLOW_R2L_T2B,
    OSN_ENCLOSURELAYOUT_FLOW_R2L_B2T,
    OSN_ENCLOSURELAYOUT_FLOW_L2R_T2B,
    OSN_ENCLOSURELAYOUT_FLOW_L2R_B2T
} osn__hwEnclosureLayoutFlow_t;

typedef enum osn__replicationState
{
    OSN_CMN_REPLICATION_STATE_PREPARING,
    OSN_CMN_REPLICATION_STATE_INITIALIZING,
    OSN_CMN_REPLICATION_STATE_SYNCHRONIZING,
    OSN_CMN_REPLICATION_STATE_SYNCHRONIZED,
    OSN_CMN_REPLICATION_STATE_RESYNCHRONIZING,
    OSN_CMN_REPLICATION_STATE_PAUSED,
    OSN_CMN_REPLICATION_STATE_INIT_FAILED,
    OSN_CMN_REPLICATION_STATE_SYNC_FAILED,
    OSN_CMN_REPLICATION_STATE_RESYNC_FAILED
} osn__replicationState_t;

typedef enum osn__remoteReplicaFlags
{
    OSN_CMN_REPLICA_FLAG_NONE,
    OSN_CMN_REPLICA_FLAG_SOURCE,
    OSN_CMN_REPLICA_FLAG_TARGET,
    OSN_CMN_REPLICA_FLAG_SOURCE_AND_TARGET
} osn__remoteReplicaFlags_t;

typedef enum osn__raidType
{
    OSN_RAIDTYPE_RAID0=0,
    OSN_RAIDTYPE_RAID1=1,
    OSN_RAIDTYPE_RAID2=2,
    OSN_RAIDTYPE_RAID3=3,
    OSN_RAIDTYPE_RAID4=4,
    OSN_RAIDTYPE_RAID5=5,
    OSN_RAIDTYPE_RAID6=6,
    OSN_RAIDTYPE_RAID7=7,
    OSN_RAIDTYPE_RAID8=8,
    OSN_RAIDTYPE_RAID9=9,
    OSN_RAIDTYPE_RAID10=10,
    OSN_RAIDTYPE_RAID_AUTO=11,
    OSN_RAIDTYPE_SINGLE=12,
    OSN_RAIDTYPE_JBOD=13,
    OSN_RAIDTYPE_RAID50=14,
    OSN_RAIDTYPE_RAID60=15,
    OSN_RAIDTYPE_RAID70=16,
    OSN_RAIDTYPE_MAX=17
} osn__raidType_t;

typedef enum osn__storagePoolType
{
    OSN_STORAGEPOOLTYPE_BTRFS,
    OSN_STORAGEPOOLTYPE_EXT3,
    OSN_STORAGEPOOLTYPE_EXT4,
    OSN_STORAGEPOOLTYPE_XFS,
    OSN_STORAGEPOOLTYPE_S3QL,
    OSN_STORAGEPOOLTYPE_JFS,
    OSN_STORAGEPOOLTYPE_ZFS,
    OSN_STORAGEPOOLTYPE_CEPH
} osn__storagePoolType_t;

typedef enum osn__hotsparePoolRepairPolicy {
    OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_ASSIGNED_AND_GLOBAL = 0,
    OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_ASSIGNED_ONLY = 1,
    OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_EXACTMATCH = 2,
    OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_ASSIGNED_ONLY_EXACTMATCH = 3,
    OSN_HOTSPARE_POOL_REPAIR_POLICY_MANUAL_REPAIR = 4,
    OSN_HOTSPARE_POOL_REPAIR_POLICY_MAX = 5
} osn__hotsparePoolRepairPolicy_t;

typedef enum osn__hotsparePoolRepairState {
    OSN_HOTSPARE_POOL_REPAIR_STATE_HEALTHY = 0,
    OSN_HOTSPARE_POOL_REPAIR_STATE_REPAIR_NEEDED = 1,
    OSN_HOTSPARE_POOL_REPAIR_STATE_REPAIR_NEEDED_OPERATOR_APPROVAL_REQUIRED = 2,
    OSN_HOTSPARE_POOL_REPAIR_STATE_AUTO_REPAIR_IN_PROGRESS = 3,
    OSN_HOTSPARE_POOL_REPAIR_STATE_MAX = 4
} osn__hotsparePoolRepairState_t;

typedef enum osn__arpFilterStatus
{
    OSN_ARP_FILTERING_ENABLED,
    OSN_ARP_FILTERING_DISABLED
} osn__arpFilterStatus_t;

typedef enum osn__arpFilterMode
{
    OSN_ARP_FILTER_MODE_AUTO,
    OSN_ARP_FILTER_MODE_ENABLED,
    OSN_ARP_FILTER_MODE_DISABLED
} osn__arpFilterMode_t;

typedef enum osn__bondMode
{
    OSN_BOND_MODE_ROUND_ROBIN=0,
    OSN_BOND_MODE_ACTIVE_BACKUP=1,
    OSN_BOND_MODE_BALANCE_XOR=2,
    OSN_BOND_MODE_BROADCAST=3,
    OSN_BOND_MODE_LACP=4,
    OSN_BOND_MODE_BALANCE_TLB=5,
    OSN_BOND_MODE_BALANCE_TRLB=6
} osn__bondMode_t;

typedef enum osn__permissionScope
{
    OSN_SCOPE_NONE=0,
    OSN_SCOPE_USER=1,
    OSN_SCOPE_STORAGE_CLOUD=2,
    OSN_SCOPE_SYSTEM=3,
    OSN_SCOPE_GRID=4
} osn__permissionScope_t;

typedef enum osn__resourceAccessRequestType
{
    OSN_CMN_REQUEST_VIEW,
    OSN_CMN_REQUEST_UTILIZE,
    OSN_CMN_REQUEST_MODIFY
} osn__resourceRequestType_t;

//todo: needs to be refactored
typedef enum osn__resourceAccessMode
{
    OSN_CMN_RESOURCEACCESS_AUTO                         =0x0000,
    OSN_CMN_RESOURCEACCESS_MULTIGROUP_SHARED            =0x0001,
    OSN_CMN_RESOURCEACCESS_GROUP_EXCLUSIVE              =0x0002,
    OSN_CMN_RESOURCEACCESS_IMMUTABLE                    =0x0004,
    OSN_CMN_RESOURCEACCESS_MULTIGROUP_SHARED_IMMUTABLE  =0x0005,
    OSN_CMN_RESOURCEACCESS_GROUP_EXCLUSIVE_IMMUTABLE    =0x0006,
} osn__resourceAccessMode_t;

typedef enum osn__diskType 
{
    OSN_DISKTYPE_UNKNOWN=0,
    OSN_DISKTYPE_IDE=1,
    OSN_DISKTYPE_SATA=2,
    OSN_DISKTYPE_SCSI=3,
    OSN_DISKTYPE_SSD=4,
    OSN_DISKTYPE_SSHD=5,
    OSN_DISKTYPE_AOE=6,
    OSN_DISKTYPE_MULTI=7,
} osn__diskType_t;

typedef enum osn__licenseEdition
{
    OSN_LICENSE_EDITION_FREE,
    OSN_LICENSE_EDITION_TRIAL,
    OSN_LICENSE_EDITION_STANDARD,
    OSN_LICENSE_EDITION_ENTERPRISE,
    OSN_LICENSE_EDITION_PLATINUM,
    OSN_LICENSE_EDITION_CLOUD
} osn__licenseEdition_t;

typedef enum osn__licenseDuration
{
    OSN_LICENSE_DURATION_PERPETUAL,
    OSN_LICENSE_DURATION_TIMELIMITED
} osn__licenseDuration_t;

typedef enum osn__licenseCategory
{
    OSN_LICENSE_CATEGORY_SYSTEM,
    OSN_LICENSE_CATEGORY_FEATURE,
    OSN_LICENSE_CATEGORY_FEATURE_TERABYTES,
    OSN_LICENSE_CATEGORY_FEATURE_VOLUMES,
    OSN_LICENSE_CATEGORY_FEATURE_SNAPSHOTS,
    OSN_LICENSE_CATEGORY_FEATURE_CLOUDS,
    OSN_LICENSE_CATEGORY_FEATURE_NODES,
    OSN_LICENSE_CATEGORY_FEATURE_USERS,
    OSN_LICENSE_CATEGORY_FEATURE_SSD,
    OSN_LICENSE_CATEGORY_FEATURE_REPLICATION
} osn__licenseCategory_t;

typedef enum osn__licenseType
{
    OSN_LICENSE_TYPE_NODE,
    OSN_LICENSE_TYPE_VOLUME,
    OSN_LICENSE_TYPE_SITE
} osn__licenseType_t;

typedef enum osn__lockType
{
    OSN_LOCK_SHARED,
    OSN_LOCK_PROTECTED,
    OSN_LOCK_EXCLUSIVE
} osn__lockType_t;

typedef enum osn__cloudProviderType
{
    OSN_CLOUD_PROVIDER_AMAZON_S3,
    OSN_CLOUD_PROVIDER_SFTP,
    OSN_CLOUD_PROVIDER_GOOGLE,
    OSN_CLOUD_PROVIDER_MICROSOFT_AZURE,
    OSN_CLOUD_PROVIDER_OPENSTACK_SWIFT
} osn__cloudProviderType_t;

typedef enum osn__hwControllerCapabilities
{
    HW_CONTROLLER_API_NONE=0,
    HW_CONTROLLER_API_RESCAN=1,
    HW_CONTROLLER_API_CREATE_UNIT=2,
    HW_CONTROLLER_API_NA3=3,
    HW_CONTROLLER_API_GROW_UNIT=4,
    HW_CONTROLLER_API_NA5=5,
    HW_CONTROLLER_API_NA6=6,
    HW_CONTROLLER_API_NA7=7,
    HW_CONTROLLER_API_GROW_UNIT_ADV_STRIPE=8,
    HW_CONTROLLER_API_NA9=9,
    HW_CONTROLLER_API_NA10=10,
    HW_CONTROLLER_API_NA11=11,
    HW_CONTROLLER_API_NA12=12,
    HW_CONTROLLER_API_NA13=13,
    HW_CONTROLLER_API_NA14=14,
    HW_CONTROLLER_API_NA15=15,
    HW_CONTROLLER_API_GROW_UNIT_ADV_PRIORITY=16,
    HW_CONTROLLER_API_NA17=17,
    HW_CONTROLLER_API_NA18=18,
    HW_CONTROLLER_API_NA19=19,
    HW_CONTROLLER_API_NA20=20,
    HW_CONTROLLER_API_NA21=21,
    HW_CONTROLLER_API_NA22=22,
    HW_CONTROLLER_API_NA23=23,
    HW_CONTROLLER_API_NA24=24,
    HW_CONTROLLER_API_NA25=25,
    HW_CONTROLLER_API_NA26=26,
    HW_CONTROLLER_API_NA27=27,
    HW_CONTROLLER_API_NA28=28,
    HW_CONTROLLER_API_NA29=29,
    HW_CONTROLLER_API_NA30=30,
    HW_CONTROLLER_API_NA31=31,
    HW_CONTROLLER_API_CREATE_SSD_CACHE=32,
    HW_CONTROLLER_API_SUPPORTS_SSD_CACHE_RAID=64,
    HW_CONTROLLER_API_SUPPORTS_UNIT_DISK_CORRELATION=128,
    HW_CONTROLLER_API_SUPPORTS_ENCRYPTION=256
} osn__hwControllerCapabilities_t;

typedef enum osn__hwDiskCapabilities
{
    HW_DISK_API_NONE=0,
    HW_DISK_API_MARK_HOT_SPARE=1,
    HW_DISK_API_IDENTIFY=2,
    HW_DISK_API_NA3=3,
    HW_DISK_API_REMOVE_DISK=4,
    HW_DISK_API_NA5=5,
    HW_DISK_API_NA6=6,
    HW_DISK_API_NA7=7,
    HW_DISK_API_SUPPORTS_ENCRYPTION=8
} osn__hwDiskCapabilities_t;

typedef enum osn__hwUnitCapabilities
{
    HW_UNIT_API_NONE=0,
    HW_UNIT_API_IDENTIFY=1,
    HW_UNIT_API_DELETE=2,
    HW_UNIT_API_NA3=3,
    HW_UNIT_API_NA4=4,
    HW_UNIT_API_NA5=5,
    HW_UNIT_API_NA6=6,
    HW_UNIT_API_NA7=7,
    HW_UNIT_API_SUPPORTS_ENCRYPTION=8
} osn__hwUnitCapabilities_t;