Difference between revisions of "+ Developer Guide Overview"

Revision as of 16:16, 18 September 2012 (view source) Qadmin (Talk | contribs) m (→‎Example) ← Older edit		Revision as of 17:24, 18 September 2012 (view source) Qadmin (Talk | contribs) m (→‎API List) Newer edit →
Line 155:		Line 155:
	== API List ==		== 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.		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 ===
		+	<code> curl -U username:password -k https://hostname:8153/qstorapi/aclAdd?objectId=<id>&ownerType=<int>&ownerId=<id>&accessLevel=<int>&objectType=<int> </code>
	__TOC__		__TOC__
Line 160:		Line 163:
	=== aclAdd API ===		=== aclAdd API ===
	Enables access to the specific volume for a specific user.		Enables access to the specific volume for a specific user.
−
−	==== Example ====
−	<code> curl -U username:password -k https://hostname:8153/qstorapi/aclAdd?objectId=<id>&ownerType=<int>&ownerId=<id>&accessLevel=<int>&objectType=<int> </code>
	==== Argument List ====		==== Argument List ====
Line 176:		Line 176:
	=== aclModify API ===		=== aclModify API ===
	Modifies the current acl assignment.		Modifies the current acl assignment.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 192:		Line 189:
	=== aclRemove API ===		=== aclRemove API ===
	Removes the acl assignment.		Removes the acl assignment.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 207:		Line 201:
	=== alertClear API ===		=== alertClear API ===
	Deletes the alert with the specified ID.		Deletes the alert with the specified ID.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 219:		Line 210:
	=== alertClearAll API ===		=== alertClearAll API ===
	Clears all the alerts.		Clears all the alerts.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 230:		Line 218:
	=== alertConfigGet API ===		=== alertConfigGet API ===
	Alert configuration settings indicate where alert notifications should be sent.		Alert configuration settings indicate where alert notifications should be sent.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 241:		Line 226:
	=== alertConfigSet API ===		=== alertConfigSet API ===
	Sets the alert configuration settings such as the administrator email address.		Sets the alert configuration settings such as the administrator email address.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 262:		Line 244:
	=== alertEnum API ===		=== alertEnum API ===
	Returns a list of all the alerts.		Returns a list of all the alerts.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 273:		Line 252:
	=== alertGet API ===		=== alertGet API ===
	Gets information about a specific alert.		Gets information about a specific alert.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 285:		Line 261:
	=== alertRaise API ===		=== alertRaise API ===
	Allows one to raise a user generated alert for testing the SMTP server configuration settings.		Allows one to raise a user generated alert for testing the SMTP server configuration settings.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 298:		Line 271:
	=== auditLogClear API ===		=== auditLogClear API ===
	Clears the audit log.		Clears the audit log.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 309:		Line 279:
	=== auditLogDisable API ===		=== auditLogDisable API ===
	Disables the audit log		Disables the audit log
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 320:		Line 287:
	=== auditLogEnable API ===		=== auditLogEnable API ===
	Enables the audit log.		Enables the audit log.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 331:		Line 295:
	=== auditLogGet API ===		=== auditLogGet API ===
	Get an entry from the audit log.		Get an entry from the audit log.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 345:		Line 306:
	=== cloudBackupScheduleAssocEnum API ===		=== cloudBackupScheduleAssocEnum API ===
	List the cloud backup schedule associations.		List the cloud backup schedule associations.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 357:		Line 315:
	=== cloudBackupScheduleAssocGet API ===		=== cloudBackupScheduleAssocGet API ===
	Get a cloud backup schedule association.		Get a cloud backup schedule association.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 369:		Line 324:
	=== cloudBackupScheduleCreate API ===		=== cloudBackupScheduleCreate API ===
	Creates a new schedule to automate backups to a cloud backup container.		Creates a new schedule to automate backups to a cloud backup container.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 390:		Line 342:
	=== cloudBackupScheduleDelete API ===		=== cloudBackupScheduleDelete API ===
	Deletes the specified cloud backup schedule.		Deletes the specified cloud backup schedule.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 402:		Line 351:
	=== cloudBackupScheduleDisable API ===		=== cloudBackupScheduleDisable API ===
	Disables a cloud backup schedule so that it does not trigger backups.		Disables a cloud backup schedule so that it does not trigger backups.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 414:		Line 360:
	=== cloudBackupScheduleEnable API ===		=== cloudBackupScheduleEnable API ===
	Enables a cloud backup schedule that was previously disabled.		Enables a cloud backup schedule that was previously disabled.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 426:		Line 369:
	=== cloudBackupScheduleEnum API ===		=== cloudBackupScheduleEnum API ===
	Lists all the cloud backup schedules in the system.		Lists all the cloud backup schedules in the system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 437:		Line 377:
	=== cloudBackupScheduleGet API ===		=== cloudBackupScheduleGet API ===
	Gets detailed information about a specific cloud backup schedule.		Gets detailed information about a specific cloud backup schedule.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 449:		Line 386:
	=== cloudBackupScheduleModify API ===		=== cloudBackupScheduleModify API ===
	Modifies the settings for the specified cloud backup schedule.		Modifies the settings for the specified cloud backup schedule.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 469:		Line 403:
	=== cloudBackupScheduleVolumeAddRemove API ===		=== cloudBackupScheduleVolumeAddRemove API ===
	Add/Remove storage volumes to an existing cloud backup schedule.		Add/Remove storage volumes to an existing cloud backup schedule.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 483:		Line 414:
	=== cloudContainerAdd API ===		=== cloudContainerAdd API ===
	Recovers a cloud backup container that was previously removed or used with a prior installation.		Recovers a cloud backup container that was previously removed or used with a prior installation.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 499:		Line 427:
	=== cloudContainerCreate API ===		=== cloudContainerCreate API ===
	Creates a cloud backup container into which cloud backups of storage volumes can be made.		Creates a cloud backup container into which cloud backups of storage volumes can be made.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 517:		Line 442:
	=== cloudContainerDelete API ===		=== cloudContainerDelete API ===
	Deletes the specified cloud backup container. WARNING, all data in the container will be destroyed.		Deletes the specified cloud backup container. WARNING, all data in the container will be destroyed.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 529:		Line 451:
	=== cloudContainerDisable API ===		=== cloudContainerDisable API ===
	Disables access to the specified cloud container without having to remove it.		Disables access to the specified cloud container without having to remove it.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 541:		Line 460:
	=== cloudContainerEnable API ===		=== cloudContainerEnable API ===
	Enables a cloud container that was previously disabled or was inaccessible due to network connection issues.		Enables a cloud container that was previously disabled or was inaccessible due to network connection issues.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 553:		Line 469:
	=== cloudContainerEnum API ===		=== cloudContainerEnum API ===
	Returns a list of cloud backup containers in the system.		Returns a list of cloud backup containers in the system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 564:		Line 477:
	=== cloudContainerGet API ===		=== cloudContainerGet API ===
	Retruns detailed information on a specific cloud backup container.		Retruns detailed information on a specific cloud backup container.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 576:		Line 486:
	=== cloudContainerModify API ===		=== cloudContainerModify API ===
	Modifies the specified cloud backup container settings.		Modifies the specified cloud backup container settings.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 592:		Line 499:
	=== cloudContainerRemove API ===		=== cloudContainerRemove API ===
	Removes the specified cloud backup container from the system but does not delete any backup data in the cloud.		Removes the specified cloud backup container from the system but does not delete any backup data in the cloud.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 604:		Line 508:
	=== cloudContainerRepair API ===		=== cloudContainerRepair API ===
	Repairs the specificed cloud backup container.		Repairs the specificed cloud backup container.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 616:		Line 517:
	=== cloudProviderCredentialsAdd API ===		=== cloudProviderCredentialsAdd API ===
	Adds cloud provider credentials to enable cloud backup to cloud backup containers.		Adds cloud provider credentials to enable cloud backup to cloud backup containers.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 631:		Line 529:
	=== cloudProviderCredentialsEnum API ===		=== cloudProviderCredentialsEnum API ===
	Returns a list of all the cloud provider credentials in the system. Passwords are masked.		Returns a list of all the cloud provider credentials in the system. Passwords are masked.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 642:		Line 537:
	=== cloudProviderCredentialsGet API ===		=== cloudProviderCredentialsGet API ===
	Returns information about the specified cloud provider credential.		Returns information about the specified cloud provider credential.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 654:		Line 546:
	=== cloudProviderCredentialsRemove API ===		=== cloudProviderCredentialsRemove API ===
	Removes the specified cloud provider credentials		Removes the specified cloud provider credentials
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 666:		Line 555:
	=== cloudProviderEnum API ===		=== cloudProviderEnum API ===
	Returns the list of supported cloud providers.		Returns the list of supported cloud providers.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 677:		Line 563:
	=== cloudProviderGet API ===		=== cloudProviderGet API ===
	Returns detailed information about the specified cloud provider.		Returns detailed information about the specified cloud provider.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 689:		Line 572:
	=== cloudProviderLocationAdd API ===		=== cloudProviderLocationAdd API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 702:		Line 582:
	=== cloudProviderLocationEnum API ===		=== cloudProviderLocationEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 713:		Line 590:
	=== cloudProviderLocationGet API ===		=== cloudProviderLocationGet API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 724:		Line 599:
	=== cloudProviderLocationRemove API ===		=== cloudProviderLocationRemove API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 736:		Line 609:
	Activate the cluster fail over group.		Activate the cluster fail over group.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 748:		Line 619:
	=== clusterFailoverGroupCreate API ===		=== clusterFailoverGroupCreate API ===
	Creates a new management grid.  A given storage system can only be a member of one grid at a time.		Creates a new management grid.  A given storage system can only be a member of one grid at a time.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 764:		Line 632:
	=== clusterFailoverGroupDelete API ===		=== clusterFailoverGroupDelete API ===
	Deletes the management grid.  After the grid is deleted each node in the grid operates independently again.		Deletes the management grid.  After the grid is deleted each node in the grid operates independently again.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 776:		Line 641:
	=== clusterFailoverGroupEnum API ===		=== clusterFailoverGroupEnum API ===
	Returns a list of all the managed storage system nodes in the grid.		Returns a list of all the managed storage system nodes in the grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 787:		Line 649:
	=== clusterFailoverGroupGet API ===		=== clusterFailoverGroupGet API ===
	Get general information about the storage system management grid.		Get general information about the storage system management grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 799:		Line 658:
	=== clusterFailoverGroupModify API ===		=== clusterFailoverGroupModify API ===
	Modify the management grid properties.		Modify the management grid properties.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 815:		Line 671:
	=== echo API ===		=== echo API ===
	Test method which pings the server with a simple string		Test method which pings the server with a simple string
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 826:		Line 679:
	=== eventEnum API ===		=== eventEnum API ===
	Returns a list of all the internal events in the event queue (used for service monitoring).		Returns a list of all the internal events in the event queue (used for service monitoring).
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 839:		Line 689:
	=== eventListenerNotify API ===		=== eventListenerNotify API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 851:		Line 698:
	=== eventListenerRegister API ===		=== eventListenerRegister API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 862:		Line 706:
	=== eventListenerUnregister API ===		=== eventListenerUnregister API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 872:		Line 714:
	=== fcTargetPortDisable API ===		=== fcTargetPortDisable API ===
	Disables the specified fiber channel port.		Disables the specified fiber channel port.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 884:		Line 723:
	=== fcTargetPortEnable API ===		=== fcTargetPortEnable API ===
	Enables the specified fiber channel port.		Enables the specified fiber channel port.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 896:		Line 732:
	=== fcTargetPortEnum API ===		=== fcTargetPortEnum API ===
	Returns a list of all the fiber channel target ports in the system.		Returns a list of all the fiber channel target ports in the system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 907:		Line 740:
	=== fcTargetPortGet API ===		=== fcTargetPortGet API ===
	Returns information about the specified fiber channel target port.		Returns information about the specified fiber channel target port.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 919:		Line 749:
	=== getHardwareConfig API ===		=== getHardwareConfig API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 930:		Line 757:
	=== getLocalizedMessage API ===		=== getLocalizedMessage API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 942:		Line 767:
	=== getSecurityConfig API ===		=== getSecurityConfig API ===
	Gets the complete security profile for the service.		Gets the complete security profile for the service.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 954:		Line 776:
	=== getSystemConfig API ===		=== getSystemConfig API ===
	Gets the storage systems configuration.		Gets the storage systems configuration.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 966:		Line 785:
	=== hostAdd API ===		=== hostAdd API ===
	Adds the specified host.		Adds the specified host.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 984:		Line 800:
	=== hostEnum API ===		=== hostEnum API ===
	Returns a list of all the hosts.		Returns a list of all the hosts.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 995:		Line 808:
	=== hostGet API ===		=== hostGet API ===
	Gets information about a specific host.		Gets information about a specific host.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,007:		Line 817:
	=== hostGroupCreate API ===		=== hostGroupCreate API ===
	Creates a new host group with the specified name.		Creates a new host group with the specified name.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,021:		Line 828:
	=== hostGroupDelete API ===		=== hostGroupDelete API ===
	Removes the specified host group.		Removes the specified host group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,034:		Line 838:
	=== hostGroupEnum API ===		=== hostGroupEnum API ===
	Returns a list of all the host groups.		Returns a list of all the host groups.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,045:		Line 846:
	=== hostGroupGet API ===		=== hostGroupGet API ===
	Gets information about a specific host group.		Gets information about a specific host group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,057:		Line 855:
	=== hostGroupHostAddRemove API ===		=== hostGroupHostAddRemove API ===
	Adds/Removes a host to the specified host group.		Adds/Removes a host to the specified host group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,071:		Line 866:
	=== hostGroupModify API ===		=== hostGroupModify API ===
	Modifies the properties of a host group such as its name and/or description.		Modifies the properties of a host group such as its name and/or description.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,085:		Line 877:
	=== hostInitiatorAdd API ===		=== hostInitiatorAdd API ===
	Adds an additional iSCSI host initiator IQN to the specified host.		Adds an additional iSCSI host initiator IQN to the specified host.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,098:		Line 887:
	=== hostInitiatorEnum API ===		=== hostInitiatorEnum API ===
	Returns a list of all the initiators (IQN) of the specified host.		Returns a list of all the initiators (IQN) of the specified host.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,110:		Line 896:
	=== hostInitiatorGet API ===		=== hostInitiatorGet API ===
	Gets information about a specific host identified by its initiator IQN.		Gets information about a specific host identified by its initiator IQN.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,122:		Line 905:
	=== hostInitiatorRemove API ===		=== hostInitiatorRemove API ===
	Removes a iSCSI host initiator (IQN) from the specified host.		Removes a iSCSI host initiator (IQN) from the specified host.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,135:		Line 915:
	=== hostModify API ===		=== hostModify API ===
	Modifies a host.		Modifies a host.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,152:		Line 929:
	=== hostRemove API ===		=== hostRemove API ===
	Removes the specified host, *WARNING* host's active iSCSI sessions will be dropped.		Removes the specified host, *WARNING* host's active iSCSI sessions will be dropped.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,164:		Line 938:
	=== hwAlarmEnum API ===		=== hwAlarmEnum API ===
	Returns a list of all the current hardware alarms/alert messages generated from the controller.		Returns a list of all the current hardware alarms/alert messages generated from the controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,176:		Line 947:
	=== hwAlarmGet API ===		=== hwAlarmGet API ===
	Returns information about a specific hardware alarm.		Returns information about a specific hardware alarm.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,188:		Line 956:
	=== hwBatteryBackupUnitEnum API ===		=== hwBatteryBackupUnitEnum API ===
	Enumerates the battery backup information for the specified controller.		Enumerates the battery backup information for the specified controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,200:		Line 965:
	=== hwBatteryBackupUnitGet API ===		=== hwBatteryBackupUnitGet API ===
	Gets the battery backup unit information for the specified battery backup unit.		Gets the battery backup unit information for the specified battery backup unit.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,212:		Line 974:
	=== hwControllerClearAlarms API ===		=== hwControllerClearAlarms API ===
	Clears all the hardware alarms that have been recorded for the specified hardware RAID controller.		Clears all the hardware alarms that have been recorded for the specified hardware RAID controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,224:		Line 983:
	=== hwControllerEnum API ===		=== hwControllerEnum API ===
	Returns a list of all the hardware controllers.		Returns a list of all the hardware controllers.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,236:		Line 992:
	=== hwControllerGet API ===		=== hwControllerGet API ===
	Returns information about a specific hardware RAID controller.		Returns information about a specific hardware RAID controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,248:		Line 1,001:
	=== hwControllerGroupEnum API ===		=== hwControllerGroupEnum API ===
	Returns a list of all the hardware controller groups.		Returns a list of all the hardware controller groups.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,259:		Line 1,009:
	=== hwControllerGroupGet API ===		=== hwControllerGroupGet API ===
	Returns information about all the support hardware RAID controller group types.		Returns information about all the support hardware RAID controller group types.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,271:		Line 1,018:
	=== hwControllerImportForeignUnits API ===		=== hwControllerImportForeignUnits API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,283:		Line 1,027:
	=== hwControllerRescan API ===		=== hwControllerRescan API ===
	Rescans the hardware controller to look for new disks and RAID units.		Rescans the hardware controller to look for new disks and RAID units.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,295:		Line 1,036:
	=== hwControllerRescanAll API ===		=== hwControllerRescanAll API ===
	Rescans all of the hardware controllers to look for new disks and RAID units.		Rescans all of the hardware controllers to look for new disks and RAID units.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,307:		Line 1,045:
	=== hwControllerSilenceAlarms API ===		=== hwControllerSilenceAlarms API ===
	Silences the alarms for specified hardware controller.		Silences the alarms for specified hardware controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,319:		Line 1,054:
	=== hwDiskEnum API ===		=== hwDiskEnum API ===
	Returns a list of all the disks managed by the specified hardware controller.		Returns a list of all the disks managed by the specified hardware controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,331:		Line 1,063:
	=== hwDiskGet API ===		=== hwDiskGet API ===
	Returns information about a specific disk managed by a hardware RAID controller.		Returns information about a specific disk managed by a hardware RAID controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,343:		Line 1,072:
	=== hwDiskIdentify API ===		=== hwDiskIdentify API ===
	Flashes the LED indicator light on the specified disk so that it can be identified in the enclosure chassis.		Flashes the LED indicator light on the specified disk so that it can be identified in the enclosure chassis.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,356:		Line 1,082:
	=== hwDiskMarkHotSpare API ===		=== 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.		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.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,369:		Line 1,092:
	=== hwDiskRemove API ===		=== hwDiskRemove API ===
	Marks the disk as removable (safe way to swap the drives).		Marks the disk as removable (safe way to swap the drives).
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,381:		Line 1,101:
	=== hwEnclosureEnum API ===		=== hwEnclosureEnum API ===
	Returns a list of all the enclosures managed by the specified hardware RAID controller.		Returns a list of all the enclosures managed by the specified hardware RAID controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,393:		Line 1,110:
	=== hwEnclosureGet API ===		=== hwEnclosureGet API ===
	Returns information about a specific enclosure managed by the specified hardware RAID controller.		Returns information about a specific enclosure managed by the specified hardware RAID controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,404:		Line 1,118:
	=== hwLogicalDriveEnum API ===		=== hwLogicalDriveEnum API ===
−
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,417:		Line 1,127:
	=== hwLogicalDriveGet API ===		=== hwLogicalDriveGet API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,429:		Line 1,136:
	=== hwSwitchAdapterEnum API ===		=== hwSwitchAdapterEnum API ===
	Returns a list of all the storage switch management adapters.		Returns a list of all the storage switch management adapters.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,440:		Line 1,144:
	=== hwSwitchAdapterGet API ===		=== hwSwitchAdapterGet API ===
	Returns information about the specified HW switch management module.		Returns information about the specified HW switch management module.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,452:		Line 1,153:
	=== hwSwitchCredentialsAdd API ===		=== hwSwitchCredentialsAdd API ===
	Adds storage switch login credentials for a specific switch management adapter.		Adds storage switch login credentials for a specific switch management adapter.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,472:		Line 1,170:
	=== hwSwitchCredentialsEnum API ===		=== hwSwitchCredentialsEnum API ===
	Returns a list of all the storage switch login credentials.		Returns a list of all the storage switch login credentials.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,484:		Line 1,179:
	=== hwSwitchCredentialsGet API ===		=== hwSwitchCredentialsGet API ===
	Returns information about pecific storage switch login credentials.		Returns information about pecific storage switch login credentials.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,496:		Line 1,188:
	=== hwSwitchCredentialsModify API ===		=== hwSwitchCredentialsModify API ===
	Modifies the switch login credentials.		Modifies the switch login credentials.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,512:		Line 1,201:
	=== hwSwitchCredentialsRemove API ===		=== hwSwitchCredentialsRemove API ===
	Removes storage switch login credentials.		Removes storage switch login credentials.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,524:		Line 1,210:
	=== hwSwitchEnum API ===		=== hwSwitchEnum API ===
	Returns a list of all the discovered storage switches.		Returns a list of all the discovered storage switches.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,536:		Line 1,219:
	=== hwSwitchFailoverGroupActivate API ===		=== hwSwitchFailoverGroupActivate API ===
	Activates the pools in a switch failover group on the specified storage system.		Activates the pools in a switch failover group on the specified storage system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,549:		Line 1,229:
	=== hwSwitchFailoverGroupCreate API ===		=== hwSwitchFailoverGroupCreate API ===
	Creates a new switch failover group.		Creates a new switch failover group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,570:		Line 1,247:
	=== hwSwitchFailoverGroupDelete API ===		=== hwSwitchFailoverGroupDelete API ===
	Deletes a failover group.		Deletes a failover group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,582:		Line 1,256:
	=== hwSwitchFailoverGroupEnum API ===		=== hwSwitchFailoverGroupEnum API ===
	Returns a list of all the switch failover groups.		Returns a list of all the switch failover groups.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,593:		Line 1,264:
	=== hwSwitchFailoverGroupGet API ===		=== hwSwitchFailoverGroupGet API ===
	Returns information about a specific switch failover group.		Returns information about a specific switch failover group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,605:		Line 1,273:
	=== hwSwitchFailoverGroupModify API ===		=== hwSwitchFailoverGroupModify API ===
	Modifies the properties of a failover group.		Modifies the properties of a failover group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,627:		Line 1,292:
	=== hwSwitchFailoverGroupPoolAssocEnum API ===		=== hwSwitchFailoverGroupPoolAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,639:		Line 1,301:
	=== hwSwitchFailoverGroupPoolAssocGet API ===		=== hwSwitchFailoverGroupPoolAssocGet API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,651:		Line 1,311:
	=== hwSwitchFailoverGroupSetMode API ===		=== hwSwitchFailoverGroupSetMode API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,665:		Line 1,322:
	Adds another storage system to which the failover group can failover to.		Adds another storage system to which the failover group can failover to.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,678:		Line 1,333:
	=== hwSwitchFailoverGroupSystemAssocEnum API ===		=== hwSwitchFailoverGroupSystemAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,690:		Line 1,342:
	=== hwSwitchFailoverGroupSystemAssocGet API ===		=== hwSwitchFailoverGroupSystemAssocGet API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,703:		Line 1,352:
	=== hwSwitchFailoverGroupSystemAssocRemove API ===		=== hwSwitchFailoverGroupSystemAssocRemove API ===
	Removes a storage system from the failover group.		Removes a storage system from the failover group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,716:		Line 1,362:
	=== hwSwitchGet API ===		=== hwSwitchGet API ===
	Returns detailed information about a storage switch.		Returns detailed information about a storage switch.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,728:		Line 1,371:
	=== hwSwitchRescan API ===		=== hwSwitchRescan API ===
	Rescans the hardware switch.		Rescans the hardware switch.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,740:		Line 1,380:
	=== hwSwitchZonesetActivate API ===		=== hwSwitchZonesetActivate API ===
	Activates a specific storage switch zonset.		Activates a specific storage switch zonset.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,753:		Line 1,390:
	=== hwSwitchZonesetEnum API ===		=== hwSwitchZonesetEnum API ===
	Returns a list of all the discovered zonesets.		Returns a list of all the discovered zonesets.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,765:		Line 1,399:
	=== hwSwitchZonesetGet API ===		=== hwSwitchZonesetGet API ===
	Returns information about a specific switch zoneset.		Returns information about a specific switch zoneset.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,777:		Line 1,408:
	=== hwUnitCreate API ===		=== hwUnitCreate API ===
	Creates a new hardware RAID unit using the specified controller.		Creates a new hardware RAID unit using the specified controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,791:		Line 1,419:
	=== hwUnitDelete API ===		=== hwUnitDelete API ===
	Deletes the specified RAID unit.  Note that you must first delete the Storage Pool before you delete the RAID unit.		Deletes the specified RAID unit.  Note that you must first delete the Storage Pool before you delete the RAID unit.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,803:		Line 1,428:
	=== hwUnitEnum API ===		=== hwUnitEnum API ===
	Returns a list of all the disks managed by the specified hardware controller.		Returns a list of all the disks managed by the specified hardware controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,815:		Line 1,437:
	=== hwUnitGet API ===		=== hwUnitGet API ===
	Returns information about a specific disk managed by a hardware RAID controller.		Returns information about a specific disk managed by a hardware RAID controller.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,827:		Line 1,446:
	=== hwUnitGrow API ===		=== hwUnitGrow API ===
	Grows the hardware unit by adding specified disks.		Grows the hardware unit by adding specified disks.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,842:		Line 1,458:
	=== hwUnitIdentify API ===		=== hwUnitIdentify API ===
	Flashes the LED indicator light on all the disks in the RAID unit so that it can be identified in the enclosure.		Flashes the LED indicator light on all the disks in the RAID unit so that it can be identified in the enclosure.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,855:		Line 1,468:
	=== hwUnitSsdCacheCreate API ===		=== hwUnitSsdCacheCreate API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,869:		Line 1,479:
	=== hwUnitSsdCacheDisable API ===		=== hwUnitSsdCacheDisable API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,880:		Line 1,488:
	=== hwUnitSsdCacheEnable API ===		=== hwUnitSsdCacheEnable API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,893:		Line 1,499:
	Returns a list of all the infiniband ports in the system.		Returns a list of all the infiniband ports in the system.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,904:		Line 1,508:
	Returns information about the specified infiniband port.		Returns information about the specified infiniband port.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,916:		Line 1,518:
	Get the current username, token, and interval settings for Librato Metrics.		Get the current username, token, and interval settings for Librato Metrics.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,928:		Line 1,528:
	Set the username, token, and interval for Librato Metrics posting.		Set the username, token, and interval for Librato Metrics posting.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,946:		Line 1,544:
	Activates the system using a activation key received from customer support.		Activates the system using a activation key received from customer support.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,958:		Line 1,554:
	Requests automatic activation via the online activation service.		Requests automatic activation via the online activation service.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,970:		Line 1,564:
	Adds a license key using a license key block.		Adds a license key using a license key block.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,983:		Line 1,575:
	Returns a list of all the registered license keys.		Returns a list of all the registered license keys.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 1,994:		Line 1,584:
	Shows the current license key info, and any activation request code.		Shows the current license key info, and any activation request code.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,006:		Line 1,594:
	Removes the specified license key.		Removes the specified license key.
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,017:		Line 1,603:
	=== login API ===		=== login API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,028:		Line 1,611:
	=== networkShareClientAdd API ===		=== networkShareClientAdd API ===
	Adds a client for the specified network share.		Adds a client for the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,046:		Line 1,626:
	=== networkShareClientEnum API ===		=== networkShareClientEnum API ===
	Returns a list of clients for the specified network share.		Returns a list of clients for the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,058:		Line 1,635:
	=== networkShareClientGet API ===		=== networkShareClientGet API ===
	Returns information about the specific network share client.		Returns information about the specific network share client.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,071:		Line 1,645:
	=== networkShareClientModify API ===		=== networkShareClientModify API ===
	Modifies a client for the specified network share.		Modifies a client for the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,089:		Line 1,660:
	=== networkShareClientRemove API ===		=== networkShareClientRemove API ===
	Removes a client for the specified network share.		Removes a client for the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,102:		Line 1,670:
	=== networkShareClone API ===		=== networkShareClone API ===
	Clones the specified network share.		Clones the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,119:		Line 1,684:
	=== networkShareCreate API ===		=== networkShareCreate API ===
	Creates a new NFSv3 network share.		Creates a new NFSv3 network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,135:		Line 1,697:
	=== networkShareDelete API ===		=== networkShareDelete API ===
	Deletes the specified network share.		Deletes the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,147:		Line 1,706:
	=== networkShareDisable API ===		=== networkShareDisable API ===
	Disables the specified network share.		Disables the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,159:		Line 1,715:
	=== networkShareEnable API ===		=== networkShareEnable API ===
	Enables the specified network share.		Enables the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,171:		Line 1,724:
	=== networkShareEnum API ===		=== networkShareEnum API ===
	Returns a list of all the network shares in the system.		Returns a list of all the network shares in the system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,182:		Line 1,732:
	=== networkShareGet API ===		=== networkShareGet API ===
	Returns information about the specified network share.		Returns information about the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,194:		Line 1,741:
	=== networkShareModify API ===		=== networkShareModify API ===
	Modifies a client for the specified network share.		Modifies a client for the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,209:		Line 1,753:
	=== networkShareNfsConfig API ===		=== networkShareNfsConfig API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,225:		Line 1,766:
	=== networkShareRestore API ===		=== networkShareRestore API ===
	Restores the network share from a previous snapshot of the share.		Restores the network share from a previous snapshot of the share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,238:		Line 1,776:
	=== networkShareServicesRestart API ===		=== networkShareServicesRestart API ===
	Restarts the network share service.		Restarts the network share service.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,250:		Line 1,785:
	=== networkShareSnapshot API ===		=== networkShareSnapshot API ===
	Snapshots the specified network share.		Snapshots the specified network share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,267:		Line 1,799:
	=== objectEnum API ===		=== objectEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,281:		Line 1,810:
	=== objectGet API ===		=== objectGet API ===
	Gets the object based on the id provided.		Gets the object based on the id provided.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,293:		Line 1,819:
	=== objectLock API ===		=== objectLock API ===
	Locks the specified object.		Locks the specified object.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,304:		Line 1,827:
	=== objectPropertyGet API ===		=== objectPropertyGet API ===
	Gets the specified property on an object.		Gets the specified property on an object.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,317:		Line 1,837:
	=== objectPropertySet API ===		=== objectPropertySet API ===
	Sets the specified property on an object.		Sets the specified property on an object.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,332:		Line 1,849:
	=== objectUnlock API ===		=== objectUnlock API ===
	Unlocks an object.		Unlocks an object.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,343:		Line 1,857:
	=== permissionDefinitionEnum API ===		=== permissionDefinitionEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,354:		Line 1,865:
	=== physicalDiskEnum API ===		=== physicalDiskEnum API ===
	Enumerates all physical disks.		Enumerates all physical disks.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,366:		Line 1,874:
	=== physicalDiskGet API ===		=== physicalDiskGet API ===
	Gets information about a specific physical disk.		Gets information about a specific physical disk.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,378:		Line 1,883:
	=== physicalDiskIdentify API ===		=== physicalDiskIdentify API ===
	Pulses the disk activity light so that the specified disk can be identified in the cassis.		Pulses the disk activity light so that the specified disk can be identified in the cassis.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,392:		Line 1,894:
	=== physicalDiskPathAssocEnum API ===		=== physicalDiskPathAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,403:		Line 1,902:
	=== physicalDiskPathAssocGet API ===		=== physicalDiskPathAssocGet API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,416:		Line 1,912:
	=== physicalDiskScan API ===		=== physicalDiskScan API ===
	Scans for any new physical disks that may have been hot-plugged into the storage system.		Scans for any new physical disks that may have been hot-plugged into the storage system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,428:		Line 1,921:
	=== registerSecurityToken API ===		=== registerSecurityToken API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,441:		Line 1,931:
	=== remoteStoragePoolEnum API ===		=== remoteStoragePoolEnum API ===
	Returns a list of all the remote storage pools.		Returns a list of all the remote storage pools.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,452:		Line 1,939:
	=== replicaAssocDelete API ===		=== replicaAssocDelete API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,467:		Line 1,951:
	=== replicaAssocEnum API ===		=== replicaAssocEnum API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,480:		Line 1,962:
	=== replicaAssocGet API ===		=== replicaAssocGet API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,491:		Line 1,971:
	=== replicaAssocUpdate API ===		=== replicaAssocUpdate API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,502:		Line 1,980:
	=== replicaCreate API ===		=== replicaCreate API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,521:		Line 1,997:
	=== replicaCreateNetworkShareTarget API ===		=== replicaCreateNetworkShareTarget API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,541:		Line 2,014:
	=== replicaCreateVolumeTarget API ===		=== replicaCreateVolumeTarget API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,560:		Line 2,031:
	=== replicaStop API ===		=== replicaStop API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,571:		Line 2,040:
	=== replicaSync API ===		=== replicaSync API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,582:		Line 2,049:
	=== replicationScheduleAddRemove API ===		=== replicationScheduleAddRemove API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,596:		Line 2,061:
	=== replicationScheduleAssocEnum API ===		=== replicationScheduleAssocEnum API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,607:		Line 2,070:
	=== replicationScheduleAssocGet API ===		=== replicationScheduleAssocGet API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,618:		Line 2,079:
	=== replicationScheduleCreate API ===		=== replicationScheduleCreate API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,642:		Line 2,101:
	=== replicationScheduleDelete API ===		=== replicationScheduleDelete API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,653:		Line 2,110:
	=== replicationScheduleDisable API ===		=== replicationScheduleDisable API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,664:		Line 2,119:
	=== replicationScheduleEnable API ===		=== replicationScheduleEnable API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,675:		Line 2,128:
	=== replicationScheduleEnum API ===		=== replicationScheduleEnum API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,685:		Line 2,136:
	=== replicationScheduleGet API ===		=== replicationScheduleGet API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,696:		Line 2,145:
	=== replicationScheduleModify API ===		=== replicationScheduleModify API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,715:		Line 2,162:
	=== roleCreate API ===		=== roleCreate API ===
	Adds a new role to the role based access control (RBAC) system.		Adds a new role to the role based access control (RBAC) system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,730:		Line 2,174:
	=== roleDelete API ===		=== roleDelete API ===
	Removes the specified role identified by name or ID.		Removes the specified role identified by name or ID.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,742:		Line 2,183:
	=== roleEnum API ===		=== roleEnum API ===
	Returns a list of all the defined roles the RBAC system.		Returns a list of all the defined roles the RBAC system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,753:		Line 2,191:
	=== roleGet API ===		=== roleGet API ===
	Gets information about the specified role.		Gets information about the specified role.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,765:		Line 2,200:
	=== roleModify API ===		=== roleModify API ===
	Modifies the name and/or description of a role.		Modifies the name and/or description of a role.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,779:		Line 2,211:
	=== rolePermissionAssignmentEnum API ===		=== rolePermissionAssignmentEnum API ===
	Lists all of the role permission assignments.		Lists all of the role permission assignments.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,791:		Line 2,220:
	=== rolePermissionAssignmentGet API ===		=== rolePermissionAssignmentGet API ===
	Gets the specified role permission assignment.		Gets the specified role permission assignment.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,805:		Line 2,231:
	=== rolePermissionsAddRemove API ===		=== rolePermissionsAddRemove API ===
	Adds/Removes one or more permissions and/or permission groups from the specified role.		Adds/Removes one or more permissions and/or permission groups from the specified role.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,819:		Line 2,242:
	=== roleSubjectAssocEnum API ===		=== roleSubjectAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,830:		Line 2,250:
	=== roleSubjectAssocGet API ===		=== roleSubjectAssocGet API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,843:		Line 2,260:
	=== sessionClose API ===		=== sessionClose API ===
	Forcably closes the specified iSCSI session; generally not recommended, use acl-remove instead.		Forcably closes the specified iSCSI session; generally not recommended, use acl-remove instead.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,855:		Line 2,269:
	=== sessionEnum API ===		=== sessionEnum API ===
	Returns a list of all the active iSCSI sessions.		Returns a list of all the active iSCSI sessions.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,868:		Line 2,279:
	=== sessionGet API ===		=== sessionGet API ===
	Returns detailed information on a specific iSCSI session.		Returns detailed information on a specific iSCSI session.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,880:		Line 2,288:
	=== siteAssocEnum API ===		=== siteAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,891:		Line 2,296:
	=== siteAssocGet API ===		=== siteAssocGet API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,904:		Line 2,306:
	=== siteCreate API ===		=== siteCreate API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,919:		Line 2,318:
	=== siteDelete API ===		=== siteDelete API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,931:		Line 2,327:
	=== siteEnum API ===		=== siteEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,942:		Line 2,335:
	=== siteGet API ===		=== siteGet API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,954:		Line 2,344:
	=== siteModify API ===		=== siteModify API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,969:		Line 2,356:
	=== siteStorageSystemAddRemove API ===		=== siteStorageSystemAddRemove API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,983:		Line 2,367:
	=== snapshotScheduleAssocEnum API ===		=== snapshotScheduleAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 2,995:		Line 2,376:
	=== snapshotScheduleAssocGet API ===		=== snapshotScheduleAssocGet API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,007:		Line 2,385:
	=== snapshotScheduleCreate API ===		=== snapshotScheduleCreate API ===
	Creates a new snapshot schedule comprised of the specified storage volumes.		Creates a new snapshot schedule comprised of the specified storage volumes.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,028:		Line 2,403:
	=== snapshotScheduleDelete API ===		=== snapshotScheduleDelete API ===
	Deletes a snapshot schedule, snapshots associated with the schedule are not removed.		Deletes a snapshot schedule, snapshots associated with the schedule are not removed.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,040:		Line 2,412:
	=== snapshotScheduleDisable API ===		=== snapshotScheduleDisable API ===
	Disables the specified snapshot schedule.		Disables the specified snapshot schedule.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,052:		Line 2,421:
	=== snapshotScheduleEnable API ===		=== snapshotScheduleEnable API ===
	Enables the specified snapshot schedule.		Enables the specified snapshot schedule.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,064:		Line 2,430:
	=== snapshotScheduleEnum API ===		=== snapshotScheduleEnum API ===
	Returns a list of all the snapshot schedules.		Returns a list of all the snapshot schedules.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,075:		Line 2,438:
	=== snapshotScheduleGet API ===		=== snapshotScheduleGet API ===
	Returns information about a specific snapshot schedule.		Returns information about a specific snapshot schedule.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,087:		Line 2,447:
	=== snapshotScheduleModify API ===		=== snapshotScheduleModify API ===
	Modifies the name, description or other properties of a snapshot schedule.		Modifies the name, description or other properties of a snapshot schedule.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,107:		Line 2,464:
	=== snapshotScheduleVolumeAddRemove API ===		=== snapshotScheduleVolumeAddRemove API ===
	Adds/Removes one or more volumes to the specified schedule.		Adds/Removes one or more volumes to the specified schedule.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,122:		Line 2,476:
	=== storageCloudCreate API ===		=== storageCloudCreate API ===
	Creates a new storage cloud compiresed of the specifed users, resources and chap information.		Creates a new storage cloud compiresed of the specifed users, resources and chap information.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,142:		Line 2,493:
	=== storageCloudDelete API ===		=== storageCloudDelete API ===
	Deletes a storage cloud, the resources and users will not be deleted.		Deletes a storage cloud, the resources and users will not be deleted.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,154:		Line 2,502:
	=== storageCloudEnum API ===		=== storageCloudEnum API ===
	Returns a list of all the storage clouds.		Returns a list of all the storage clouds.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,165:		Line 2,510:
	=== storageCloudGet API ===		=== storageCloudGet API ===
	Returns information of the specified storage clouds.		Returns information of the specified storage clouds.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,177:		Line 2,519:
	=== storageCloudModify API ===		=== storageCloudModify API ===
	Modifys the name, description, parent storage cloud, tier, organization, and chap information of a storage cloud.		Modifys the name, description, parent storage cloud, tier, organization, and chap information of a storage cloud.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,196:		Line 2,535:
	=== storageCloudResourceAddRemove API ===		=== storageCloudResourceAddRemove API ===
	Add/Remove one or more resources to the specified storage cloud.		Add/Remove one or more resources to the specified storage cloud.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,210:		Line 2,546:
	=== storageCloudResourceAssocEnum API ===		=== storageCloudResourceAssocEnum API ===
	Returns a list of associated resources of the specified storage cloud.		Returns a list of associated resources of the specified storage cloud.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,222:		Line 2,555:
	=== storageCloudResourceAssocGet API ===		=== storageCloudResourceAssocGet API ===
	Returns associated information of specified resource in the storage cloud.		Returns associated information of specified resource in the storage cloud.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,235:		Line 2,565:
	=== storageCloudResourceSetMode API ===		=== storageCloudResourceSetMode API ===
	Set the mode of a specified resource in the storage cloud.		Set the mode of a specified resource in the storage cloud.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,248:		Line 2,575:
	=== storageCloudSubjectAssocEnum API ===		=== storageCloudSubjectAssocEnum API ===
	Returns a list of associated storage clouds to the specified subject.		Returns a list of associated storage clouds to the specified subject.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,260:		Line 2,584:
	=== storageCloudSubjectAssocGet API ===		=== storageCloudSubjectAssocGet API ===
	Returns associated information of a specified subject in a storager cloud.		Returns associated information of a specified subject in a storager cloud.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,273:		Line 2,594:
	=== storageCloudUserAddRemove API ===		=== storageCloudUserAddRemove API ===
	Add/Remove one or more users to the specified storage cloud.		Add/Remove one or more users to the specified storage cloud.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,287:		Line 2,605:
	=== storagePoolCreate API ===		=== storagePoolCreate API ===
	Creates a new storage pool from which storage volumes can be created.		Creates a new storage pool from which storage volumes can be created.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,308:		Line 2,623:
	=== storagePoolDestroy API ===		=== storagePoolDestroy API ===
	Deletes a storage pool, *WARNING* any data in the pool will be lost.		Deletes a storage pool, *WARNING* any data in the pool will be lost.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,320:		Line 2,632:
	=== storagePoolDeviceEnum API ===		=== storagePoolDeviceEnum API ===
	Returns a list of all the storage pool devices.		Returns a list of all the storage pool devices.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,332:		Line 2,641:
	=== storagePoolDeviceGet API ===		=== storagePoolDeviceGet API ===
	Gets information about a specific storage pool device.		Gets information about a specific storage pool device.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,344:		Line 2,650:
	=== storagePoolEnum API ===		=== storagePoolEnum API ===
	Returns a list of all the storage pools.		Returns a list of all the storage pools.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,355:		Line 2,658:
	=== storagePoolExpand API ===		=== storagePoolExpand API ===
	Expands a storage pool after the underlying hardware RAID unit has been grown underneath.		Expands a storage pool after the underlying hardware RAID unit has been grown underneath.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,367:		Line 2,667:
	=== storagePoolExport API ===		=== storagePoolExport API ===
	Deactivate and removes the storage pool from the storage system database so that it can be exported and used on another system.		Deactivate and removes the storage pool from the storage system database so that it can be exported and used on another system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,379:		Line 2,676:
	=== storagePoolGet API ===		=== storagePoolGet API ===
	Gets information about a specific storage pool.		Gets information about a specific storage pool.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,391:		Line 2,685:
	=== storagePoolGrow API ===		=== 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.		Grows the specified storage pool by adding an additional disk.  You can only grow storage pools that are using the RAID5 or RAID6 layout.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,405:		Line 2,696:
	=== storagePoolIdentify API ===		=== storagePoolIdentify API ===
	Pulses the disk activity lights for all disks in the pool so they can be identified in the chassis.		Pulses the disk activity lights for all disks in the pool so they can be identified in the chassis.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,419:		Line 2,707:
	=== storagePoolModify API ===		=== storagePoolModify API ===
	Modifies the properties of the storage pool such as it's name and decription.		Modifies the properties of the storage pool such as it's name and decription.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,438:		Line 2,723:
	=== storagePoolProfileEnum API ===		=== storagePoolProfileEnum API ===
	Returns a list of all the storage pool profiles.		Returns a list of all the storage pool profiles.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,449:		Line 2,731:
	=== storagePoolProfileGet API ===		=== storagePoolProfileGet API ===
	Gets information about a specific storage pool profile.		Gets information about a specific storage pool profile.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,461:		Line 2,740:
	=== storagePoolReplicationConfigCreate API ===		=== storagePoolReplicationConfigCreate API ===
	Create a async remote replicaiton link between two storage pools.		Create a async remote replicaiton link between two storage pools.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,480:		Line 2,756:
	=== storagePoolReplicationConfigDelete API ===		=== storagePoolReplicationConfigDelete API ===
	Delete the remote replication link between two storage pools.		Delete the remote replication link between two storage pools.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,493:		Line 2,766:
	=== storagePoolReplicationConfigEnum API ===		=== storagePoolReplicationConfigEnum API ===
	List the remote replication linkes between pools.		List the remote replication linkes between pools.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,504:		Line 2,774:
	=== storagePoolReplicationConfigGet API ===		=== storagePoolReplicationConfigGet API ===
	Get info about a specific remote replication link between two pools.		Get info about a specific remote replication link between two pools.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,516:		Line 2,783:
	=== storagePoolReplicationConfigModify API ===		=== storagePoolReplicationConfigModify API ===
	Modify the async remote replication link between pools.		Modify the async remote replication link between pools.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,534:		Line 2,798:
	=== storagePoolRescan API ===		=== storagePoolRescan API ===
	Rescans the specified storage system for storage pools.		Rescans the specified storage system for storage pools.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,547:		Line 2,808:
	=== storagePoolSpareAddRemove API ===		=== storagePoolSpareAddRemove API ===
	Adds/Removes a dedicated hot-spare to the specified storage pool.		Adds/Removes a dedicated hot-spare to the specified storage pool.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,561:		Line 2,819:
	=== storagePoolStart API ===		=== storagePoolStart API ===
	Starts up a previously stopped storage pool.		Starts up a previously stopped storage pool.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,573:		Line 2,828:
	=== storagePoolStop API ===		=== storagePoolStop API ===
	Stops all volume activity to the pool and disables it for maintenance.		Stops all volume activity to the pool and disables it for maintenance.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,585:		Line 2,837:
	=== storagePoolUpdateRedirect API ===		=== storagePoolUpdateRedirect API ===
−
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,598:		Line 2,846:
	=== storageQuotaCreate API ===		=== storageQuotaCreate API ===
	Creates a new storage quota on a pool for the specified storage cloud.		Creates a new storage quota on a pool for the specified storage cloud.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,618:		Line 2,863:
	=== storageQuotaDelete API ===		=== storageQuotaDelete API ===
	Deletes a storage quota, the associated volumes are not deleted.		Deletes a storage quota, the associated volumes are not deleted.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,630:		Line 2,872:
	=== storageQuotaEnum API ===		=== storageQuotaEnum API ===
	Returns a list of all the storage quotas.		Returns a list of all the storage quotas.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,641:		Line 2,880:
	=== storageQuotaGet API ===		=== storageQuotaGet API ===
	Returns information about a specific storage quota.		Returns information about a specific storage quota.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,653:		Line 2,889:
	=== storageQuotaModify API ===		=== storageQuotaModify API ===
	Modifies one to change the name and/or description of a storage quota.		Modifies one to change the name and/or description of a storage quota.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,673:		Line 2,906:
	=== storageQuotaShareAddRemove API ===		=== storageQuotaShareAddRemove API ===
	Adds/Removes one or more volumes to the specified quota.		Adds/Removes one or more volumes to the specified quota.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,687:		Line 2,917:
	=== storageQuotaShareAssocEnum API ===		=== storageQuotaShareAssocEnum API ===
	Returns a list of all the associated quotas of a specified share.		Returns a list of all the associated quotas of a specified share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,699:		Line 2,926:
	=== storageQuotaShareAssocGet API ===		=== storageQuotaShareAssocGet API ===
	Returns information about the associated quotas of a specified share.		Returns information about the associated quotas of a specified share.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,711:		Line 2,935:
	=== storageQuotaVolumeAddRemove API ===		=== storageQuotaVolumeAddRemove API ===
	Adds/Removes one or more volumes to the specified quota.		Adds/Removes one or more volumes to the specified quota.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,725:		Line 2,946:
	=== storageQuotaVolumeAssocEnum API ===		=== storageQuotaVolumeAssocEnum API ===
	Returns a list of all the associated quotas of a specified volume.		Returns a list of all the associated quotas of a specified volume.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,737:		Line 2,955:
	=== storageQuotaVolumeAssocGet API ===		=== storageQuotaVolumeAssocGet API ===
	Return information about the associated quotas of a specified volume.		Return information about the associated quotas of a specified volume.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,749:		Line 2,964:
	=== storageSystemClusterAssocEnum API ===		=== storageSystemClusterAssocEnum API ===
	Returns a list of the associated storage system nodes in the grid.		Returns a list of the associated storage system nodes in the grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,760:		Line 2,972:
	=== storageSystemClusterAssocGet API ===		=== storageSystemClusterAssocGet API ===
	Get general information about the associated storage system management grid.		Get general information about the associated storage system management grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,773:		Line 2,982:
	=== storageSystemClusterCreate API ===		=== storageSystemClusterCreate API ===
	Creates a new management grid.  A given storage system can only be a member of one grid at a time.		Creates a new management grid.  A given storage system can only be a member of one grid at a time.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,791:		Line 2,997:
	=== storageSystemClusterDelete API ===		=== storageSystemClusterDelete API ===
	Deletes the management grid.  After the grid is deleted each node in the grid operates independently again.		Deletes the management grid.  After the grid is deleted each node in the grid operates independently again.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,802:		Line 3,005:
	=== storageSystemClusterEnum API ===		=== storageSystemClusterEnum API ===
	Returns a list of all the managed storage system nodes in the grid.		Returns a list of all the managed storage system nodes in the grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,813:		Line 3,013:
	=== storageSystemClusterGet API ===		=== storageSystemClusterGet API ===
	Get general information about the storage system management grid.		Get general information about the storage system management grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,825:		Line 3,022:
	=== storageSystemClusterModify API ===		=== storageSystemClusterModify API ===
	Modify the management grid properties.		Modify the management grid properties.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,843:		Line 3,037:
	=== storageSystemClusterNodeAdd API ===		=== storageSystemClusterNodeAdd API ===
	Adds the specified storage system to the management grid.		Adds the specified storage system to the management grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,857:		Line 3,048:
	=== storageSystemClusterNodeEject API ===		=== storageSystemClusterNodeEject API ===
	Ejects the specified storage system from the management grid.		Ejects the specified storage system from the management grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,869:		Line 3,057:
	=== storageSystemClusterNodeJoin API ===		=== storageSystemClusterNodeJoin API ===
	Joins the specified storage system to the management grid.		Joins the specified storage system to the management grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,882:		Line 3,067:
	=== storageSystemClusterNodeRemove API ===		=== storageSystemClusterNodeRemove API ===
	Removes the specified storage system from the management grid.		Removes the specified storage system from the management grid.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,894:		Line 3,076:
	=== storageSystemClusterNodeSetMaster API ===		=== storageSystemClusterNodeSetMaster API ===
	Sets the master node for a storage system.		Sets the master node for a storage system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,906:		Line 3,085:
	=== storageSystemClusterNodeSync API ===		=== storageSystemClusterNodeSync API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,919:		Line 3,095:
	=== storageSystemEnum API ===		=== 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.		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.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,930:		Line 3,103:
	=== storageSystemGet API ===		=== storageSystemGet API ===
	Get general information about the storage system.		Get general information about the storage system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,942:		Line 3,112:
	=== storageSystemGroupAddRemoveLinks API ===		=== storageSystemGroupAddRemoveLinks API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,956:		Line 3,123:
	=== storageSystemGroupAssocEnum API ===		=== storageSystemGroupAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,967:		Line 3,131:
	=== storageSystemGroupAssocGet API ===		=== storageSystemGroupAssocGet API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,979:		Line 3,141:
	=== storageSystemGroupCreate API ===		=== storageSystemGroupCreate API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 3,993:		Line 3,153:
	=== storageSystemGroupDelete API ===		=== storageSystemGroupDelete API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,005:		Line 3,163:
	=== storageSystemGroupEnum API ===		=== storageSystemGroupEnum API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,015:		Line 3,171:
	=== storageSystemGroupGet API ===		=== storageSystemGroupGet API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,026:		Line 3,180:
	=== storageSystemGroupModify API ===		=== storageSystemGroupModify API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,040:		Line 3,192:
	=== storageSystemGroupSetPassword API ===		=== storageSystemGroupSetPassword API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,052:		Line 3,202:
	=== storageSystemLinkCreate API ===		=== storageSystemLinkCreate API ===
	Create a new storage system link so that storage volumes may be replicated between storage systems.		Create a new storage system link so that storage volumes may be replicated between storage systems.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,071:		Line 3,218:
	=== storageSystemLinkDelete API ===		=== storageSystemLinkDelete API ===
	Delete an existing storage system link.		Delete an existing storage system link.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,083:		Line 3,227:
	=== storageSystemLinkDisconnect API ===		=== storageSystemLinkDisconnect API ===
	Disconnect a storage system link.		Disconnect a storage system link.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,095:		Line 3,236:
	=== storageSystemLinkEnum API ===		=== storageSystemLinkEnum API ===
	List the existing storage system remote replication links.		List the existing storage system remote replication links.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,106:		Line 3,244:
	=== storageSystemLinkEstablish API ===		=== storageSystemLinkEstablish API ===
	Establishes a storage system remote replication link.		Establishes a storage system remote replication link.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,118:		Line 3,253:
	=== storageSystemLinkGet API ===		=== storageSystemLinkGet API ===
	Get information about the storage system link.		Get information about the storage system link.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,130:		Line 3,262:
	=== storageSystemLinkModify API ===		=== storageSystemLinkModify API ===
	Modify the properties of the storage system link.		Modify the properties of the storage system link.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,147:		Line 3,276:
	=== storageSystemLinkRefresh API ===		=== storageSystemLinkRefresh API ===
	Refreshes a storage system link.		Refreshes a storage system link.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,159:		Line 3,285:
	=== storageSystemLinkSetCredentials API ===		=== storageSystemLinkSetCredentials API ===
	Change the credentials for an existing storage system link.		Change the credentials for an existing storage system link.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,173:		Line 3,296:
	=== storageSystemLinkVerify API ===		=== storageSystemLinkVerify API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,185:		Line 3,305:
	=== storageSystemModify API ===		=== storageSystemModify API ===
	Modifies the name and/or description of the storage system.		Modifies the name and/or description of the storage system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,205:		Line 3,322:
	=== storageSystemRecover API ===		=== storageSystemRecover API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,219:		Line 3,333:
	=== storageSystemRecoveryPointEnum API ===		=== 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.		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.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,231:		Line 3,342:
	=== storageSystemRestart API ===		=== storageSystemRestart API ===
	Restarts the entire storage system.		Restarts the entire storage system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,243:		Line 3,351:
	=== storageSystemSendLogs API ===		=== storageSystemSendLogs API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,255:		Line 3,360:
	=== storageSystemShutdown API ===		=== storageSystemShutdown API ===
	Shutdown the storage system.		Shutdown the storage system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,267:		Line 3,369:
	=== storageSystemUpdateCheck API ===		=== storageSystemUpdateCheck API ===
	Checks for updates for specified storage system.		Checks for updates for specified storage system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,279:		Line 3,378:
	=== storageSystemUpgrade API ===		=== storageSystemUpgrade API ===
	Upgrade to the latest version of the core packages.		Upgrade to the latest version of the core packages.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,296:		Line 3,392:
	Enables/Disables access to the specific volume from the specified host.		Enables/Disables access to the specific volume from the specified host.
	(List of hosts for specified volume)		(List of hosts for specified volume)
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,311:		Line 3,404:
	Enables access to the specific volume from the specified host.		Enables access to the specific volume from the specified host.
	(List of volumes for specified host)		(List of volumes for specified host)
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,325:		Line 3,415:
	=== storageVolumeAclEnum API ===		=== storageVolumeAclEnum API ===
	Returns a list of all the volume to host assignments, optionally filtered by host or storage volume.		Returns a list of all the volume to host assignments, optionally filtered by host or storage volume.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,339:		Line 3,426:
	Gets the assignment information for specified host or storage volume.		Gets the assignment information for specified host or storage volume.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,352:		Line 3,436:
	=== storageVolumeClone API ===		=== storageVolumeClone API ===
	Creates a complete block copy of the source volume.		Creates a complete block copy of the source volume.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,368:		Line 3,449:
	=== storageVolumeCloudBackupCreate API ===		=== storageVolumeCloudBackupCreate API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,385:		Line 3,463:
	=== storageVolumeCloudBackupRestore API ===		=== storageVolumeCloudBackupRestore API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,402:		Line 3,477:
	=== storageVolumeCreate API ===		=== storageVolumeCreate API ===
	Creates a new storage volume in the specified storage pool.		Creates a new storage volume in the specified storage pool.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,423:		Line 3,495:
	=== storageVolumeCreateEx API ===		=== storageVolumeCreateEx API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,444:		Line 3,513:
	=== storageVolumeDelete API ===		=== storageVolumeDelete API ===
	Deletes a storage volume, *WARNING* any data in the volume will be lost.		Deletes a storage volume, *WARNING* any data in the volume will be lost.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,457:		Line 3,523:
	=== storageVolumeEnum API ===		=== storageVolumeEnum API ===
	Returns a list of all the storage volumes.		Returns a list of all the storage volumes.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,469:		Line 3,532:
	=== storageVolumeGet API ===		=== storageVolumeGet API ===
	Returns information about a specific storage volume.		Returns information about a specific storage volume.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,481:		Line 3,541:
	=== storageVolumeGroupAssocEnum API ===		=== storageVolumeGroupAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,492:		Line 3,549:
	=== storageVolumeGroupAssocGet API ===		=== storageVolumeGroupAssocGet API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,504:		Line 3,558:
	=== storageVolumeGroupClone API ===		=== storageVolumeGroupClone API ===
	Creates a complete block by block copy of all volumes in the group.		Creates a complete block by block copy of all volumes in the group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,520:		Line 3,571:
	=== storageVolumeGroupCreate API ===		=== storageVolumeGroupCreate API ===
	Creates a new storage volume group comprised of the specified storage volumes.		Creates a new storage volume group comprised of the specified storage volumes.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,534:		Line 3,582:
	=== storageVolumeGroupDelete API ===		=== storageVolumeGroupDelete API ===
	Deletes a storage volume group, the volumes are not deleted unless the delete-volumes flag is set.		Deletes a storage volume group, the volumes are not deleted unless the delete-volumes flag is set.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,547:		Line 3,592:
	=== storageVolumeGroupEnum API ===		=== storageVolumeGroupEnum API ===
	Returns a list of all the storage volume groups.		Returns a list of all the storage volume groups.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,558:		Line 3,600:
	=== storageVolumeGroupGet API ===		=== storageVolumeGroupGet API ===
	Returns information about a specific storage volume group.		Returns information about a specific storage volume group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,570:		Line 3,609:
	=== storageVolumeGroupModify API ===		=== storageVolumeGroupModify API ===
	Modifies the name and/or description of a storage volume group.		Modifies the name and/or description of a storage volume group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,584:		Line 3,620:
	=== storageVolumeGroupSnapshot API ===		=== storageVolumeGroupSnapshot API ===
	Creates a space efficient copy of all volumes in the group.		Creates a space efficient copy of all volumes in the group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,601:		Line 3,634:
	=== storageVolumeGroupVolumeAddRemove API ===		=== storageVolumeGroupVolumeAddRemove API ===
	Adds/Removes one or more volumes to the specified volume group.		Adds/Removes one or more volumes to the specified volume group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,615:		Line 3,645:
	=== storageVolumeModify API ===		=== storageVolumeModify API ===
	Modifies a the name, description or other properties of the storage volume.		Modifies a the name, description or other properties of the storage volume.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,634:		Line 3,661:
	=== storageVolumeResize API ===		=== storageVolumeResize API ===
	Resizes a storage volume to make it larger, volumes cannot be reduced in size.		Resizes a storage volume to make it larger, volumes cannot be reduced in size.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,648:		Line 3,672:
	=== storageVolumeRestore API ===		=== storageVolumeRestore API ===
	Restores a storage volume to a previous point in time using a snapshot.		Restores a storage volume to a previous point in time using a snapshot.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,661:		Line 3,682:
	=== storageVolumeSnapshot API ===		=== storageVolumeSnapshot API ===
	Creates a space efficient copy of the source volume.		Creates a space efficient copy of the source volume.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,678:		Line 3,696:
	=== storageVolumeUtilizationEnum API ===		=== storageVolumeUtilizationEnum API ===
	Returns volume utilization information for a specific storage volume or all storage volumes if no volume is specified.		Returns volume utilization information for a specific storage volume or all storage volumes if no volume is specified.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,690:		Line 3,705:
	=== storageVolumeUtilizationGet API ===		=== storageVolumeUtilizationGet API ===
	Returns a specific volume utilization metrics for a single volume and specific date.		Returns a specific volume utilization metrics for a single volume and specific date.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,702:		Line 3,714:
	=== storageVolumeUtilizationGetRetentionPeriod API ===		=== storageVolumeUtilizationGetRetentionPeriod API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,712:		Line 3,722:
	=== storageVolumeUtilizationSetRetentionPeriod API ===		=== storageVolumeUtilizationSetRetentionPeriod API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,723:		Line 3,731:
	=== targetPortDisable API ===		=== targetPortDisable API ===
	Disables the specified target port.		Disables the specified target port.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,735:		Line 3,740:
	=== targetPortEnable API ===		=== targetPortEnable API ===
	Enables the specified target port.		Enables the specified target port.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,747:		Line 3,749:
	=== targetPortEnum API ===		=== targetPortEnum API ===
	Returns a list of all the target ports in the system.		Returns a list of all the target ports in the system.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,758:		Line 3,757:
	=== targetPortGet API ===		=== targetPortGet API ===
	Returns information about the specified target port.		Returns information about the specified target port.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,770:		Line 3,766:
	=== targetPortModify API ===		=== targetPortModify API ===
	Modifies target port settings including IP address, gateway, mtu, etc.		Modifies target port settings including IP address, gateway, mtu, etc.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,790:		Line 3,783:
	=== targetPortRescan API ===		=== targetPortRescan API ===
	Discovers new target ports and/or any manual modifiations made to the configuration of the target ports.		Discovers new target ports and/or any manual modifiations made to the configuration of the target ports.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,802:		Line 3,792:
	=== targetPortRestart API ===		=== targetPortRestart API ===
	Restarts the specified target port.		Restarts the specified target port.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,814:		Line 3,801:
	=== targetVirtualInterfaceCreate API ===		=== targetVirtualInterfaceCreate API ===
	Creates a new virtual network interface which is linked to a physical network port.		Creates a new virtual network interface which is linked to a physical network port.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,834:		Line 3,818:
	=== targetVirtualInterfaceMove API ===		=== targetVirtualInterfaceMove API ===
	Moves the specified virtual network interface to a different physical network port.		Moves the specified virtual network interface to a different physical network port.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,847:		Line 3,828:
	=== targetVirtualPortCreate API ===		=== targetVirtualPortCreate API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,866:		Line 3,844:
	=== targetVirtualPortDelete API ===		=== targetVirtualPortDelete API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,877:		Line 3,853:
	=== taskCancel API ===		=== taskCancel API ===
	Cancels the specified task that is in the queue or is running.		Cancels the specified task that is in the queue or is running.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,889:		Line 3,862:
	=== taskClearAll API ===		=== taskClearAll API ===
	Clears all the completed and/or failed tasks.		Clears all the completed and/or failed tasks.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,900:		Line 3,870:
	=== taskEnum API ===		=== taskEnum API ===
	Returns a list of all the tasks including active, completed, and failed tasks.		Returns a list of all the tasks including active, completed, and failed tasks.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,912:		Line 3,879:
	=== taskGet API ===		=== taskGet API ===
	Returns information about the specified task.		Returns information about the specified task.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,924:		Line 3,888:
	=== userAdd API ===		=== 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.		Adds a new user to the system. User accounts can access QuantaStor via the web management interface, remote scripting and via the qstorapi RESTful API.
−
−	==== Example ====
−	<code> curl -U username:password -k https://hostname:8153/qstorapi/userAdd?username=tiger&password=passWORD1&firstName=Tiger&lastName=Woods&role=Administrator </code>
	==== Argument List ====		==== Argument List ====
Line 4,943:		Line 3,904:
	=== userEnum API ===		=== userEnum API ===
	Returns a list of all the users.		Returns a list of all the users.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,954:		Line 3,912:
	=== userGet API ===		=== userGet API ===
	Gets information about the specified user.		Gets information about the specified user.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,966:		Line 3,921:
	=== userGroupAssocEnum API ===		=== userGroupAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,978:		Line 3,930:
	=== userGroupAssocGet API ===		=== userGroupAssocGet API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 4,989:		Line 3,939:
	=== userGroupCreate API ===		=== userGroupCreate API ===
	Creates a new storage user group comprised of the specified storage users.		Creates a new storage user group comprised of the specified storage users.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,003:		Line 3,950:
	=== userGroupDelete API ===		=== userGroupDelete API ===
	Deletes a storage user group, the users are not deleted unless the delete-users flag is set.		Deletes a storage user group, the users are not deleted unless the delete-users flag is set.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,015:		Line 3,959:
	=== userGroupEnum API ===		=== userGroupEnum API ===
	Returns a list of all the storage user groups.		Returns a list of all the storage user groups.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,026:		Line 3,967:
	=== userGroupGet API ===		=== userGroupGet API ===
	Returns information about a specific storage user group.		Returns information about a specific storage user group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,038:		Line 3,976:
	=== userGroupModify API ===		=== userGroupModify API ===
	Modifies the name and/or description of a storage user group.		Modifies the name and/or description of a storage user group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,052:		Line 3,987:
	=== userGroupUserAddRemove API ===		=== userGroupUserAddRemove API ===
	Adds/Removes one or more users to the specified user group.		Adds/Removes one or more users to the specified user group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,066:		Line 3,998:
	=== userModify API ===		=== userModify API ===
	Modifies the name and/or description of a storage user group.		Modifies the name and/or description of a storage user group.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,087:		Line 4,016:
	=== userPasswordSet API ===		=== userPasswordSet API ===
	Sets a new password for specified user.		Sets a new password for specified user.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,101:		Line 4,027:
	=== userRemove API ===		=== userRemove API ===
	Removes specified user.		Removes specified user.
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,113:		Line 4,036:
	=== virtualInterfaceAssocEnum API ===		=== virtualInterfaceAssocEnum API ===
−
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====
Line 5,124:		Line 4,044:
	=== virtualInterfaceAssocGet API ===		=== virtualInterfaceAssocGet API ===
−	==== Example ====
−	<code> </code>
	==== Argument List ====		==== Argument List ====

---

Revision as of 17:24, 18 September 2012

QuantaStor was designed from the ground up so that you can develop your own applications to remotely manage your 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

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

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>

aclAdd API

Enables access to the specific volume for a specific user.

Argument List

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

aclModify API

Modifies the current acl assignment.

Argument List

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

aclRemove API

Removes the acl assignment.

Argument List

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

alertClear API

Deletes the alert with the specified ID.

Argument List

   flags: <xs:unsignedInt>
   id: <xs:string>

alertClearAll API

Clears all the alerts.

Argument List

   flags: <xs:unsignedInt>

alertConfigGet API

Alert configuration settings indicate where alert notifications should be sent.

Argument List

   flags: <xs:unsignedInt>

alertConfigSet API

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

Argument List

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

alertEnum API

Returns a list of all the alerts.

Argument List

   flags: <xs:unsignedInt>

alertGet API

Gets information about a specific alert.

Argument List

   flags: <xs:unsignedInt>
   id: <xs:string>

alertRaise API

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

Argument List

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

auditLogClear API

Clears the audit log.

Argument List

   flags: <xs:unsignedInt>

auditLogDisable API

Disables the audit log

Argument List

   flags: <xs:unsignedInt>

auditLogEnable API

Enables the audit log.

Argument List

   flags: <xs:unsignedInt>

auditLogGet API

Get an entry from the audit log.

Argument List

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

cloudBackupScheduleAssocEnum API

List the cloud backup schedule associations.

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

cloudBackupScheduleAssocGet API

Get a cloud backup schedule association.

Argument List

   scheduleId: <xs:string>
   storageVolumeId: <xs:string>

cloudBackupScheduleCreate API

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

Argument List

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

cloudBackupScheduleDelete API

Deletes the specified cloud backup schedule.

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

cloudBackupScheduleDisable API

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

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

cloudBackupScheduleEnable API

Enables a cloud backup schedule that was previously disabled.

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

cloudBackupScheduleEnum API

Lists all the cloud backup schedules in the system.

Argument List

   flags: <xs:unsignedInt>

cloudBackupScheduleGet API

Gets detailed information about a specific cloud backup schedule.

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

cloudBackupScheduleModify API

Modifies the settings for the specified cloud backup schedule.

Argument List

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

cloudBackupScheduleVolumeAddRemove API

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

Argument List

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

cloudContainerAdd API

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

Argument List

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

cloudContainerCreate API

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

Argument List

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

cloudContainerDelete API

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

Argument List

   flags: <xs:unsignedInt>
   container: <xs:string>

cloudContainerDisable API

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

Argument List

   flags: <xs:unsignedInt>
   container: <xs:string>

cloudContainerEnable API

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

Argument List

   flags: <xs:unsignedInt>
   container: <xs:string>

cloudContainerEnum API

Returns a list of cloud backup containers in the system.

Argument List

   flags: <xs:unsignedInt>

cloudContainerGet API

Retruns detailed information on a specific cloud backup container.

Argument List

   flags: <xs:unsignedInt>
   container: <xs:string>

cloudContainerModify API

Modifies the specified cloud backup container settings.

Argument List

   container: <xs:string>
   name: <xs:string>
   flags: <xs:unsignedInt>
   enableNfs: <xs:boolean>
   encryptionKey: <xs:string>
   description: <xs: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: <xs:unsignedInt>
   container: <xs:string>

cloudContainerRepair API

Repairs the specificed cloud backup container.

Argument List

   flags: <xs:unsignedInt>
   container: <xs:string>

cloudProviderCredentialsAdd API

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

Argument List

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

cloudProviderCredentialsEnum API

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

Argument List

   flags: <xs:unsignedInt>

cloudProviderCredentialsGet API

Returns information about the specified cloud provider credential.

Argument List

   credentialId: <xs:string>
   flags: <xs:unsignedInt>

cloudProviderCredentialsRemove API

Removes the specified cloud provider credentials

Argument List

   flags: <xs:unsignedInt>
   credentialsId: <xs:string>

cloudProviderEnum API

Returns the list of supported cloud providers.

Argument List

   flags: <xs:unsignedInt>

cloudProviderGet API

Returns detailed information about the specified cloud provider.

Argument List

   providerId: <xs:string>
   flags: <xs:unsignedInt>

cloudProviderLocationAdd API

Argument List

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

cloudProviderLocationEnum API

Argument List

   flags: <xs:unsignedInt>

cloudProviderLocationGet API

Argument List

   flags: <xs:unsignedInt>
   locationId: <xs:string>

cloudProviderLocationRemove API

Argument List

   flags: <xs:unsignedInt>
   locationId: <xs:string>

clusterFailoverGroupActivate API

Activate the cluster fail over group.

Argument List

   storageSystemId: <xs:string>
   flags: <xs:unsignedInt>
   clusterFailoverGroup: <xs: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: <xs:string>
   name: <xs:string>
   zoneConfig: <xs:string>
   flags: <xs:unsignedInt>
   storagePool: <xs:string>
   description: <xs:string>

clusterFailoverGroupDelete API

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

Argument List

   flags: <xs:unsignedInt>
   clusterFailoverGroup: <xs:string>

clusterFailoverGroupEnum API

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

Argument List

   flags: <xs:unsignedInt>

clusterFailoverGroupGet API

Get general information about the storage system management grid.

Argument List

   flags: <xs:unsignedInt>
   clusterFailoverGroup: <xs:string>

clusterFailoverGroupModify API

Modify the management grid properties.

Argument List

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

echo API

Test method which pings the server with a simple string

Argument List

   inputMessage: <xs:string>

eventEnum API

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

Argument List

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

eventListenerNotify API

Argument List

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

eventListenerRegister API

Argument List

   eventListenerObj: <ns0:eventListener>

eventListenerUnregister API

Argument List

   listenerId: <xs:string>

fcTargetPortDisable API

Disables the specified fiber channel port.

Argument List

   flags: <xs:unsignedInt>
   port: <xs:string>

fcTargetPortEnable API

Enables the specified fiber channel port.

Argument List

   flags: <xs:unsignedInt>
   port: <xs:string>

fcTargetPortEnum API

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

Argument List

   flags: <xs:unsignedInt>

fcTargetPortGet API

Returns information about the specified fiber channel target port.

Argument List

   flags: <xs:unsignedInt>
   port: <xs:string>

getHardwareConfig API

Argument List

   flags: <xs:unsignedInt>

getLocalizedMessage API

Argument List

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

getSecurityConfig API

Gets the complete security profile for the service.

Argument List

   storageSystemId: <xs:string>
   flags: <xs:unsignedInt>

getSystemConfig API

Gets the storage systems configuration.

Argument List

   storageSystemId: <xs:string>
   flags: <xs:unsignedInt>

hostAdd API

Adds the specified host.

Argument List

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

hostEnum API

Returns a list of all the hosts.

Argument List

   flags: <xs:unsignedInt>

hostGet API

Gets information about a specific host.

Argument List

   host: <xs:string>
   flags: <xs:unsignedInt>

hostGroupCreate API

Creates a new host group with the specified name.

Argument List

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

hostGroupDelete API

Removes the specified host group.

Argument List

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

hostGroupEnum API

Returns a list of all the host groups.

Argument List

   flags: <xs:unsignedInt>

hostGroupGet API

Gets information about a specific host group.

Argument List

   flags: <xs:unsignedInt>
   hostGroup: <xs:string>

hostGroupHostAddRemove API

Adds/Removes a host to the specified host group.

Argument List

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

hostGroupModify API

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

Argument List

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

hostInitiatorAdd API

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

Argument List

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

hostInitiatorEnum API

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

Argument List

   host: <xs:string>
   flags: <xs:unsignedInt>

hostInitiatorGet API

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

Argument List

   initiator: <xs:string>
   flags: <xs:unsignedInt>

hostInitiatorRemove API

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

Argument List

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

hostModify API

Modifies a host.

Argument List

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

hostRemove API

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

Argument List

   host: <xs:string>
   flags: <xs:unsignedInt>

hwAlarmEnum API

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

Argument List

   flags: <xs:unsignedInt>
   hwController: <xs:string>

hwAlarmGet API

Returns information about a specific hardware alarm.

Argument List

   hwAlarm: <xs:string>
   flags: <xs:unsignedInt>

hwBatteryBackupUnitEnum API

Enumerates the battery backup information for the specified controller.

Argument List

   flags: <xs:unsignedInt>
   hwController: <xs:string>

hwBatteryBackupUnitGet API

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

Argument List

   hwBatteryBackupUnit: <xs:string>
   flags: <xs:unsignedInt>

hwControllerClearAlarms API

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

Argument List

   controllerId: <xs:string>
   flags: <xs:unsignedInt>

hwControllerEnum API

Returns a list of all the hardware controllers.

Argument List

   hwControllerGroup: <xs:string>
   flags: <xs:unsignedInt>

hwControllerGet API

Returns information about a specific hardware RAID controller.

Argument List

   flags: <xs:unsignedInt>
   hwController: <xs:string>

hwControllerGroupEnum API

Returns a list of all the hardware controller groups.

Argument List

   flags: <xs:unsignedInt>

hwControllerGroupGet API

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

Argument List

   hwControllerGroup: <xs:string>
   flags: <xs:unsignedInt>

hwControllerImportForeignUnits API

Argument List

   controllerId: <xs:string>
   flags: <xs:unsignedInt>

hwControllerRescan API

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

Argument List

   controllerId: <xs:string>
   flags: <xs:unsignedInt>

hwControllerRescanAll API

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

Argument List

   storageSystemId: <xs:string>
   flags: <xs:unsignedInt>

hwControllerSilenceAlarms API

Silences the alarms for specified hardware controller.

Argument List

   controllerId: <xs:string>
   flags: <xs:unsignedInt>

hwDiskEnum API

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

Argument List

   flags: <xs:unsignedInt>
   hwController: <xs:string>

hwDiskGet API

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

Argument List

   hwDisk: <xs:string>
   flags: <xs: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: <xs:unsignedInt>
   durationInSeconds: <xs:unsignedInt>
   diskId: <xs: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: <xs:boolean>
   flags: <xs:unsignedInt>
   diskId: <xs:string>

hwDiskRemove API

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

Argument List

   flags: <xs:unsignedInt>
   diskId: <xs:string>

hwEnclosureEnum API

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

Argument List

   flags: <xs:unsignedInt>
   hwController: <xs:string>

hwEnclosureGet API

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

Argument List

   hwEnclosure: <xs:string>
   flags: <xs:unsignedInt>

hwLogicalDriveEnum API

Argument List

   hwUnit: <xs:string>
   flags: <xs:unsignedInt>

hwLogicalDriveGet API

Argument List

   hwLogicalDrive: <xs:string>
   flags: <xs:unsignedInt>

hwSwitchAdapterEnum API

Returns a list of all the storage switch management adapters.

Argument List

   flags: <xs:unsignedInt>

hwSwitchAdapterGet API

Returns information about the specified HW switch management module.

Argument List

   flags: <xs:unsignedInt>
   switchAdapterId: <xs:string>

hwSwitchCredentialsAdd API

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

Argument List

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

hwSwitchCredentialsEnum API

Returns a list of all the storage switch login credentials.

Argument List

   flags: <xs:unsignedInt>
   switchAdapterId: <xs:string>

hwSwitchCredentialsGet API

Returns information about pecific storage switch login credentials.

Argument List

   flags: <xs:unsignedInt>
   switchCredentials: <xs:string>

hwSwitchCredentialsModify API

Modifies the switch login credentials.

Argument List

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

hwSwitchCredentialsRemove API

Removes storage switch login credentials.

Argument List

   credsId: <xs:string>
   flags: <xs:unsignedInt>

hwSwitchEnum API

Returns a list of all the discovered storage switches.

Argument List

   flags: <xs:unsignedInt>
   switchAdapterId: <xs:string>

hwSwitchFailoverGroupActivate API

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

Argument List

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

hwSwitchFailoverGroupCreate API

Creates a new switch failover group.

Argument List

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

hwSwitchFailoverGroupDelete API

Deletes a failover group.

Argument List

   hwSwitchFailoverGroup: <xs:string>
   flags: <xs:unsignedInt>

hwSwitchFailoverGroupEnum API

Returns a list of all the switch failover groups.

Argument List

   flags: <xs:unsignedInt>

hwSwitchFailoverGroupGet API

Returns information about a specific switch failover group.

Argument List

   hwSwitchFailoverGroupId: <xs:string>
   flags: <xs:unsignedInt>

hwSwitchFailoverGroupModify API

Modifies the properties of a failover group.

Argument List

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

hwSwitchFailoverGroupPoolAssocEnum API

Argument List

   hwSwitchFailoverGroup: <xs:string>
   flags: <xs:unsignedInt>

hwSwitchFailoverGroupPoolAssocGet API

Argument List

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

hwSwitchFailoverGroupSetMode API

Argument List

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

hwSwitchFailoverGroupSystemAssocAdd API

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

Argument List

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

hwSwitchFailoverGroupSystemAssocEnum API

Argument List

   hwSwitchFailoverGroup: <xs:string>
   flags: <xs:unsignedInt>

hwSwitchFailoverGroupSystemAssocGet API

Argument List

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

hwSwitchFailoverGroupSystemAssocRemove API

Removes a storage system from the failover group.

Argument List

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

hwSwitchGet API

Returns detailed information about a storage switch.

Argument List

   switchId: <xs:string>
   flags: <xs:unsignedInt>

hwSwitchRescan API

Rescans the hardware switch.

Argument List

   switchId: <xs:string>
   flags: <xs:unsignedInt>

hwSwitchZonesetActivate API

Activates a specific storage switch zonset.

Argument List

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

hwSwitchZonesetEnum API

Returns a list of all the discovered zonesets.

Argument List

   flags: <xs:unsignedInt>
   switchCredentialsId: <xs:string>

hwSwitchZonesetGet API

Returns information about a specific switch zoneset.

Argument List

   switchZoneset: <xs:string>
   flags: <xs:unsignedInt>

hwUnitCreate API

Creates a new hardware RAID unit using the specified controller.

Argument List

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

hwUnitEnum API

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

Argument List

   flags: <xs:unsignedInt>
   hwController: <xs:string>

hwUnitGet API

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

Argument List

   hwUnit: <xs:string>
   flags: <xs:unsignedInt>

hwUnitGrow API

Grows the hardware unit by adding specified disks.

Argument List

   diskList: <xs:string[]>
   flags: <xs:unsignedInt>
   stripeSizeKb: <xs:unsignedInt>
   initPriority: <xs:unsignedInt>
   unitId: <xs: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: <xs:unsignedInt>
   durationInSeconds: <xs:unsignedInt>
   unitId: <xs:string>

hwUnitSsdCacheCreate API

Argument List

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

hwUnitSsdCacheDisable API

Argument List

   flags: <xs:unsignedInt>
   unitId: <xs:string>

hwUnitSsdCacheEnable API

Argument List

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

ibTargetPortEnum API

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

Argument List

   flags: <xs:unsignedInt>

ibTargetPortGet API

Returns information about the specified infiniband port.

Argument List

   flags: <xs:unsignedInt>
   port: <xs:string>

libratoMetricsConfigGet API

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

Argument List

   flags: <xs:unsignedInt>
   storageSystem: <xs:string>

libratoMetricsConfigSet API

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

Argument List

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

licenseActivate API

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

Argument List

   activationKey: <xs:string>
   flags: <xs:unsignedInt>

licenseActivateOnline API

Requests automatic activation via the online activation service.

Argument List

   flags: <xs:unsignedInt>
   licenseKey: <xs:string>

licenseAdd API

Adds a license key using a license key block.

Argument List

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

licenseEnum API

Returns a list of all the registered license keys.

Argument List

   flags: <xs:unsignedInt>

licenseGet API

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

Argument List

   flags: <xs:unsignedInt>
   license: <xs:string>

licenseRemove API

Removes the specified license key.

Argument List

   flags: <xs:unsignedInt>
   license: <xs:string>

login API

Argument List

   reserved: <xs:string>

networkShareClientAdd API

Adds a client for the specified network share.

Argument List

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

networkShareClientEnum API

Returns a list of clients for the specified network share.

Argument List

   networkShare: <xs:string>
   flags: <xs:unsignedInt>

networkShareClientGet API

Returns information about the specific network share client.

Argument List

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

networkShareClientModify API

Modifies a client for the specified network share.

Argument List

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

networkShareClientRemove API

Removes a client for the specified network share.

Argument List

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

networkShareClone API

Clones the specified network share.

Argument List

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

networkShareCreate API

Creates a new NFSv3 network share.

Argument List

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

networkShareDelete API

Deletes the specified network share.

Argument List

   flags: <xs:unsignedInt>
   networkShareId: <xs:string>

networkShareDisable API

Disables the specified network share.

Argument List

   networkShare: <xs:string>
   flags: <xs:unsignedInt>

networkShareEnable API

Enables the specified network share.

Argument List

   networkShare: <xs:string>
   flags: <xs:unsignedInt>

networkShareEnum API

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

Argument List

   flags: <xs:unsignedInt>

networkShareGet API

Returns information about the specified network share.

Argument List

   networkShare: <xs:string>
   flags: <xs:unsignedInt>

networkShareModify API

Modifies a client for the specified network share.

Argument List

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

networkShareNfsConfig API

Argument List

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

networkShareRestore API

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

Argument List

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

networkShareServicesRestart API

Restarts the network share service.

Argument List

   flags: <xs:unsignedInt>
   storageSystem: <xs:string>

networkShareSnapshot API

Snapshots the specified network share.

Argument List

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

objectEnum API

Argument List

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

objectGet API

Gets the object based on the id provided.

Argument List

   flags: <xs:unsignedInt>
   id: <xs:string>

objectLock API

Locks the specified object.

Argument List

   id: <xs:string>

objectPropertyGet API

Gets the specified property on an object.

Argument List

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

objectPropertySet API

Sets the specified property on an object.

Argument List

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

objectUnlock API

Unlocks an object.

Argument List

   id: <xs:string>

permissionDefinitionEnum API

Argument List

   flags: <xs:unsignedInt>

physicalDiskEnum API

Enumerates all physical disks.

Argument List

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

physicalDiskGet API

Gets information about a specific physical disk.

Argument List

   physicalDrive: <xs:string>
   flags: <xs:unsignedInt>

physicalDiskIdentify API

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

Argument List

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

physicalDiskPathAssocEnum API

Argument List

   flags: <xs:unsignedInt>
   multipathDiskId: <xs:string>

physicalDiskPathAssocGet API

Argument List

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

physicalDiskScan API

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

Argument List

   storageSystemId: <xs:string>
   flags: <xs:unsignedInt>

registerSecurityToken API

Argument List

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

remoteStoragePoolEnum API

Returns a list of all the remote storage pools.

Argument List

   remoteStorageSystemId: <xs:string>
   flags: <xs:unsignedInt>

replicaAssocDelete API

Argument List

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

replicaAssocEnum API

Argument List

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

replicaAssocGet API

Argument List

   flags: <xs:unsignedInt>
   assocId: <xs:string>

replicaAssocUpdate API

Argument List

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

replicaCreate API

Argument List

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

replicaCreateNetworkShareTarget API

Argument List

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

replicaCreateVolumeTarget API

Argument List

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

replicaStop API

Argument List

   flags: <xs:unsignedInt>
   assocId: <xs:string>

replicaSync API

Argument List

   flags: <xs:unsignedInt>
   assocId: <xs:string>

replicationScheduleAddRemove API

Argument List

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

replicationScheduleAssocEnum API

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

replicationScheduleAssocGet API

Argument List

   replicatableId: <xs:string>
   scheduleId: <xs:string>

replicationScheduleCreate API

Argument List

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

replicationScheduleDelete API

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

replicationScheduleDisable API

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

replicationScheduleEnable API

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

replicationScheduleEnum API

Argument List

   flags: <xs:unsignedInt>

replicationScheduleGet API

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

replicationScheduleModify API

Argument List

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

roleCreate API

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

Argument List

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

roleDelete API

Removes the specified role identified by name or ID.

Argument List

   flags: <xs:unsignedInt>
   role: <xs:string>

roleEnum API

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

Argument List

   flags: <xs:unsignedInt>

roleGet API

Gets information about the specified role.

Argument List

   flags: <xs:unsignedInt>
   role: <xs:string>

roleModify API

Modifies the name and/or description of a role.

Argument List

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

rolePermissionAssignmentEnum API

Lists all of the role permission assignments.

Argument List

   roleId: <xs:string>
   flags: <xs:unsignedInt>

rolePermissionAssignmentGet API

Gets the specified role permission assignment.

Argument List

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

rolePermissionsAddRemove API

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

Argument List

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

roleSubjectAssocEnum API

Argument List

   flags: <xs:unsignedInt>
   role: <xs:string>

roleSubjectAssocGet API

Argument List

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

sessionClose API

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

Argument List

   sessionId: <xs:string>
   flags: <xs:unsignedInt>

sessionEnum API

Returns a list of all the active iSCSI sessions.

Argument List

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

sessionGet API

Returns detailed information on a specific iSCSI session.

Argument List

   sessionId: <xs:string>
   flags: <xs:unsignedInt>

siteAssocEnum API

Argument List

   flags: <xs:unsignedInt>

siteAssocGet API

Argument List

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

siteCreate API

Argument List

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

siteDelete API

Argument List

   flags: <xs:unsignedInt>
   site: <xs:string>

siteEnum API

Argument List

   flags: <xs:unsignedInt>

siteGet API

Argument List

   flags: <xs:unsignedInt>
   site: <xs:string>

siteModify API

Argument List

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

siteStorageSystemAddRemove API

Argument List

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

snapshotScheduleAssocEnum API

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

snapshotScheduleAssocGet API

Argument List

   scheduleId: <xs:string>
   storageVolumeId: <xs:string>

snapshotScheduleCreate API

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

Argument List

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

snapshotScheduleDelete API

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

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

snapshotScheduleDisable API

Disables the specified snapshot schedule.

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

snapshotScheduleEnable API

Enables the specified snapshot schedule.

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

snapshotScheduleEnum API

Returns a list of all the snapshot schedules.

Argument List

   flags: <xs:unsignedInt>

snapshotScheduleGet API

Returns information about a specific snapshot schedule.

Argument List

   flags: <xs:unsignedInt>
   schedule: <xs:string>

snapshotScheduleModify API

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

Argument List

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

snapshotScheduleVolumeAddRemove API

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

Argument List

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

storageCloudCreate API

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

Argument List

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

storageCloudDelete API

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

Argument List

   storageCloud: <xs:string>
   flags: <xs:unsignedInt>

storageCloudEnum API

Returns a list of all the storage clouds.

Argument List

   flags: <xs:unsignedInt>

storageCloudGet API

Returns information of the specified storage clouds.

Argument List

   storageCloud: <xs:string>
   flags: <xs:unsignedInt>

storageCloudModify API

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

Argument List

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

storageCloudResourceAddRemove API

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

Argument List

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

storageCloudResourceAssocEnum API

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

Argument List

   flags: <xs:unsignedInt>
   resource: <xs:string>

storageCloudResourceAssocGet API

Returns associated information of specified resource in the storage cloud.

Argument List

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

storageCloudResourceSetMode API

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

Argument List

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

storageCloudSubjectAssocEnum API

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

Argument List

   flags: <xs:unsignedInt>
   subject: <xs:string>

storageCloudSubjectAssocGet API

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

Argument List

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

storageCloudUserAddRemove API

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

Argument List

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

storagePoolCreate API

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

Argument List

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

storagePoolDestroy API

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

Argument List

   flags: <xs:unsignedInt>
   storagePool: <xs:string>

storagePoolDeviceEnum API

Returns a list of all the storage pool devices.

Argument List

   storagePoolId: <xs:string>
   flags: <xs:unsignedInt>

storagePoolDeviceGet API

Gets information about a specific storage pool device.

Argument List

   flags: <xs:unsignedInt>
   storagePoolDevice: <xs:string>

storagePoolEnum API

Returns a list of all the storage pools.

Argument List

   flags: <xs:unsignedInt>

storagePoolExpand API

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

Argument List

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

storagePoolGet API

Gets information about a specific storage pool.

Argument List

   flags: <xs:unsignedInt>
   storagePool: <xs: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: <xs:unsignedInt>
   flags: <xs:unsignedInt>
   physicalDiskList: <xs:string[]>
   storagePool: <xs: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: <xs:unsignedInt>
   pattern: <xs:string>
   flags: <xs:unsignedInt>
   storagePool: <xs:string>

storagePoolModify API

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

Argument List

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

storagePoolProfileEnum API

Returns a list of all the storage pool profiles.

Argument List

   flags: <xs:unsignedInt>

storagePoolProfileGet API

Gets information about a specific storage pool profile.

Argument List

   storagePoolProfile: <xs:string>
   flags: <xs:unsignedInt>

storagePoolReplicationConfigCreate API

Create a async remote replicaiton link between two storage pools.

Argument List

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

storagePoolReplicationConfigDelete API

Delete the remote replication link between two storage pools.

Argument List

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

storagePoolReplicationConfigEnum API

List the remote replication linkes between pools.

Argument List

   flags: <xs:unsignedInt>

storagePoolReplicationConfigGet API

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

Argument List

   storagePoolReplicationConfig: <xs:string>
   flags: <xs:unsignedInt>

storagePoolReplicationConfigModify API

Modify the async remote replication link between pools.

Argument List

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

storagePoolRescan API

Rescans the specified storage system for storage pools.

Argument List

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

storagePoolSpareAddRemove API

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

Argument List

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

storagePoolStart API

Starts up a previously stopped storage pool.

Argument List

   flags: <xs:unsignedInt>
   storagePool: <xs:string>

storagePoolStop API

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

Argument List

   flags: <xs:unsignedInt>
   storagePool: <xs:string>

storagePoolUpdateRedirect API

Argument List

   flags: <xs:unsignedInt>
   storagePool: <xs:string>

storageQuotaCreate API

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

Argument List

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

storageQuotaDelete API

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

Argument List

   storageQuota: <xs:string>
   flags: <xs:unsignedInt>

storageQuotaEnum API

Returns a list of all the storage quotas.

Argument List

   flags: <xs:unsignedInt>

storageQuotaGet API

Returns information about a specific storage quota.

Argument List

   storageQuota: <xs:string>
   flags: <xs:unsignedInt>

storageQuotaModify API

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

Argument List

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

storageQuotaShareAddRemove API

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

Argument List

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

storageQuotaShareAssocEnum API

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

Argument List

   networkShare: <xs:string>
   flags: <xs:unsignedInt>

storageQuotaShareAssocGet API

Returns information about the associated quotas of a specified share.

Argument List

   storageQuotaId: <xs:string>
   shareId: <xs:string>

storageQuotaVolumeAddRemove API

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

Argument List

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

storageQuotaVolumeAssocEnum API

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

Argument List

   flags: <xs:unsignedInt>
   storageVolume: <xs:string>

storageQuotaVolumeAssocGet API

Return information about the associated quotas of a specified volume.

Argument List

   storageQuotaId: <xs:string>
   storageVolumeId: <xs:string>

storageSystemClusterAssocEnum API

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

Argument List

   flags: <xs:unsignedInt>

storageSystemClusterAssocGet API

Get general information about the associated storage system management grid.

Argument List

   storageSystemId: <xs:string>
   storageSystemClusterId: <xs:string>
   flags: <xs: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: <xs:string>
   name: <xs:string>
   virtualHostIpAddress: <xs:string>
   virtualHostGateway: <xs:string>
   flags: <xs:unsignedInt>
   virtualHostSubnetMask: <xs:string>
   virtualHostName: <xs:string>
   description: <xs:string>

storageSystemClusterDelete API

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

Argument List

   flags: <xs:unsignedInt>

storageSystemClusterEnum API

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

Argument List

   flags: <xs:unsignedInt>

storageSystemClusterGet API

Get general information about the storage system management grid.

Argument List

   storageSystemCluster: <xs:string>
   flags: <xs:unsignedInt>

storageSystemClusterModify API

Modify the management grid properties.

Argument List

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

storageSystemClusterNodeAdd API

Adds the specified storage system to the management grid.

Argument List

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

storageSystemClusterNodeEject API

Ejects the specified storage system from the management grid.

Argument List

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

storageSystemClusterNodeJoin API

Joins the specified storage system to the management grid.

Argument List

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

storageSystemClusterNodeRemove API

Removes the specified storage system from the management grid.

Argument List

   storageSystemId: <xs:string>
   flags: <xs:unsignedInt>

storageSystemClusterNodeSetMaster API

Sets the master node for a storage system.

Argument List

   storageSystemId: <xs:string>
   flags: <xs:unsignedInt>

storageSystemClusterNodeSync API

Argument List

   flags: <xs: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: <xs:unsignedInt>

storageSystemGet API

Get general information about the storage system.

Argument List

   flags: <xs:unsignedInt>
   storageSystem: <xs:string>

storageSystemGroupAddRemoveLinks API

Argument List

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

storageSystemGroupAssocEnum API

Argument List

   flags: <xs:unsignedInt>

storageSystemGroupAssocGet API

Argument List

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

storageSystemGroupCreate API

Argument List

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

storageSystemGroupDelete API

Argument List

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

storageSystemGroupEnum API

Argument List

   flags: <xs:unsignedInt>

storageSystemGroupGet API

Argument List

   flags: <xs:unsignedInt>
   groupId: <xs:string>

storageSystemGroupModify API

Argument List

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

storageSystemGroupSetPassword API

Argument List

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

storageSystemLinkCreate API

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

Argument List

   linkType: <xs:unsignedInt>
   localIpAddress: <xs:string>
   description: <xs:string>
   remoteAdminPassword: <xs:string>
   storageSystemId: <xs:string>
   flags: <xs:unsignedInt>
   remoteIpAddress: <xs:string>
   remoteAdminUser: <xs:string>
   bandwidthLimit: <xs:unsignedInt>

storageSystemLinkDelete API

Delete an existing storage system link.

Argument List

   linkId: <xs:string>
   flags: <xs:unsignedInt>

storageSystemLinkDisconnect API

Disconnect a storage system link.

Argument List

   remoteStorageSystemId: <xs:string>
   flags: <xs:unsignedInt>

storageSystemLinkEnum API

List the existing storage system remote replication links.

Argument List

   flags: <xs:unsignedInt>

storageSystemLinkEstablish API

Establishes a storage system remote replication link.

Argument List

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

storageSystemLinkGet API

Get information about the storage system link.

Argument List

   linkId: <xs:string>
   flags: <xs:unsignedInt>

storageSystemLinkModify API

Modify the properties of the storage system link.

Argument List

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

storageSystemLinkRefresh API

Refreshes a storage system link.

Argument List

   linkId: <xs:string>
   flags: <xs:unsignedInt>

storageSystemLinkSetCredentials API

Change the credentials for an existing storage system link.

Argument List

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

storageSystemLinkVerify API

Argument List

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

storageSystemModify API

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

Argument List

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

storageSystemRecover API

Argument List

   recoveryPoint: <xs:string>
   recoverNetworkConfig: <xs:boolean>
   flags: <xs:unsignedInt>
   storageSystem: <xs: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: <xs:unsignedInt>
   storageSystem: <xs:string>

storageSystemRestart API

Restarts the entire storage system.

Argument List

   flags: <xs:unsignedInt>
   storageSystem: <xs:string>

storageSystemSendLogs API

Argument List

   storageSystemId: <xs:string>
   flags: <xs:unsignedInt>

storageSystemShutdown API

Shutdown the storage system.

Argument List

   flags: <xs:unsignedInt>
   storageSystem: <xs:string>

storageSystemUpdateCheck API

Checks for updates for specified storage system.

Argument List

   flags: <xs:unsignedInt>
   storageSystem: <xs:string>

storageSystemUpgrade API

Upgrade to the latest version of the core packages.

Argument List

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

storageVolumeAclAddRemove API

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

Argument List

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

storageVolumeAclAddRemoveEx API

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

Argument List

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

storageVolumeAclEnum API

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

Argument List

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

storageVolumeAclGet API

Gets the assignment information for specified host or storage volume.

Argument List

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

storageVolumeClone API

Creates a complete block copy of the source volume.

Argument List

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

storageVolumeCloudBackupCreate API

Argument List

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

storageVolumeCloudBackupRestore API

Argument List

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

storageVolumeCreate API

Creates a new storage volume in the specified storage pool.

Argument List

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

storageVolumeCreateEx API

Argument List

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

storageVolumeDelete API

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

Argument List

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

storageVolumeEnum API

Returns a list of all the storage volumes.

Argument List

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

storageVolumeGet API

Returns information about a specific storage volume.

Argument List

   flags: <xs:unsignedInt>
   storageVolume: <xs:string>

storageVolumeGroupAssocEnum API

Argument List

   flags: <xs:unsignedInt>
   storageVolume: <xs:string>

storageVolumeGroupAssocGet API

Argument List

   storageVolumeGroupId: <xs:string>
   storageVolumeId: <xs:string>

storageVolumeGroupClone API

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

Argument List

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

storageVolumeGroupCreate API

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

Argument List

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

storageVolumeGroupDelete API

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

Argument List

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

storageVolumeGroupEnum API

Returns a list of all the storage volume groups.

Argument List

   flags: <xs:unsignedInt>

storageVolumeGroupGet API

Returns information about a specific storage volume group.

Argument List

   flags: <xs:unsignedInt>
   storageVolumeGroup: <xs:string>

storageVolumeGroupModify API

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

Argument List

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

storageVolumeGroupSnapshot API

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

Argument List

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

storageVolumeGroupVolumeAddRemove API

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

Argument List

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

storageVolumeModify API

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

Argument List

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

storageVolumeResize API

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

Argument List

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

storageVolumeRestore API

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

Argument List

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

storageVolumeSnapshot API

Creates a space efficient copy of the source volume.

Argument List

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

storageVolumeUtilizationEnum API

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

Argument List

   flags: <xs:unsignedInt>
   storageVolume: <xs:string>

storageVolumeUtilizationGet API

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

Argument List

   flags: <xs:unsignedInt>
   utilizationId: <xs:string>

storageVolumeUtilizationGetRetentionPeriod API

Argument List

   flags: <xs:unsignedInt>

storageVolumeUtilizationSetRetentionPeriod API

Argument List

   flags: <xs:unsignedInt>
   daysToRetain: <xs:unsignedInt>

targetPortDisable API

Disables the specified target port.

Argument List

   flags: <xs:unsignedInt>
   port: <xs:string>

targetPortEnable API

Enables the specified target port.

Argument List

   flags: <xs:unsignedInt>
   port: <xs:string>

targetPortEnum API

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

Argument List

   flags: <xs:unsignedInt>

targetPortGet API

Returns information about the specified target port.

Argument List

   flags: <xs:unsignedInt>
   port: <xs:string>

targetPortModify API

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

Argument List

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

targetPortRescan API

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

Argument List

   flags: <xs:unsignedInt>
   storageSystem: <xs:string>

targetPortRestart API

Restarts the specified target port.

Argument List

   flags: <xs:unsignedInt>
   port: <xs:string>

targetVirtualInterfaceCreate API

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

Argument List

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

targetVirtualInterfaceMove API

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

Argument List

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

targetVirtualPortCreate API

Argument List

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

targetVirtualPortDelete API

Argument List

   flags: <xs:unsignedInt>
   port: <xs:string>

taskCancel API

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

Argument List

   flags: <xs:unsignedInt>
   id: <xs:string>

taskClearAll API

Clears all the completed and/or failed tasks.

Argument List

   flags: <xs:unsignedInt>

taskEnum API

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

Argument List

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

taskGet API

Returns information about the specified task.

Argument List

   flags: <xs:unsignedInt>
   id: <xs:string>

userAdd API

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

Argument List

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

userEnum API

Returns a list of all the users.

Argument List

   flags: <xs:unsignedInt>

userGet API

Gets information about the specified user.

Argument List

   flags: <xs:unsignedInt>
   user: <xs:string>

userGroupAssocEnum API

Argument List

   flags: <xs:unsignedInt>
   user: <xs:string>

userGroupAssocGet API

Argument List

   userId: <xs:string>
   userGroupId: <xs:string>

userGroupCreate API

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

Argument List

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

userGroupDelete API

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

Argument List

   flags: <xs:unsignedInt>
   userGroup: <xs:string>

userGroupEnum API

Returns a list of all the storage user groups.

Argument List

   flags: <xs:unsignedInt>

userGroupGet API

Returns information about a specific storage user group.

Argument List

   flags: <xs:unsignedInt>
   userGroup: <xs:string>

userGroupModify API

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

Argument List

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

userGroupUserAddRemove API

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

Argument List

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

userModify API

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

Argument List

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

userPasswordSet API

Sets a new password for specified user.

Argument List

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

userRemove API

Removes specified user.

Argument List

   flags: <xs:unsignedInt>
   user: <xs:string>

virtualInterfaceAssocEnum API

Argument List

   flags: <xs:unsignedInt>

virtualInterfaceAssocGet API

Argument List

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