Input Name	Range	Type	Description
policy-name		string	User visible name of QoS policy.
Output Name	Range	Type	Description
policy-uuid		uuid	Universally unique identifier for the QoS policy.

Errno	Description
EINTERNALERROR

Delete single policy. The policy may not be attached to any workloads. Only user defined policies may be deleted.

Input Name	Range	Type	Description
policy-uuid		uuid	Universally unique identifier for the QoS policy.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Delete multiple policies. The policies may not be attached to any workloads. Only user defined policies may be deleted.

Input Name	Range	Type	Description
continue-on-failure		boolean optional	This input element is useful when multiple qos-policy objects match a given query. If set to true, the API will continue deleting the next matching qos-policy even when the deletion of a previous qos-policy fails. If set to false, the API will return on the first failure. Default: false
max-failure-count	[1..2^32-1]	integer optional	When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-policy even when the deletion of a previous matching qos-policy fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
max-records	[1..100]	integer optional	The maximum number of qos-policy objects to delete in this call. Default: 20
query		qos-policy-info	If deleting a specific qos-policy, this input element must specify all keys. If deleting multiple qos-policy objects based on query, this input element must specify a query.
return-failure-list		boolean optional	If set to true, the API will return the list of qos-policy objects (just keys) that were not deleted due to some error. If set to false, the list of qos-policy objects not deleted will not be returned. Default: true
return-success-list		boolean optional	If set to true, the API will return the list of qos-policy objects (just keys) that were successfully deleted. If set to false, the list of qos-policy objects deleted will not be returned. Default: true
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
Output Name	Range	Type	Description
failure-list		qos-policy-destroy-iter-info[] optional	Information about qos-policy objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
next-tag		string optional	Tag for the next call. Not present when there are no more matching qos-policy objects to be deleted.
num-failed	[0..100]	integer optional	Number of qos-policy objects that matched the query, but were not deleted due to some error.
num-succeeded	[0..100]	integer optional	The number of qos-policy objects that matched the query and were successfully deleted.
success-list		qos-policy-destroy-iter-info[] optional	The qos-policy objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

Errno	Description
EINTERNALERROR

Get the attributes of a policy.

Input Name	Range	Type	Description
desired-attributes		qos-policy-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
policy-uuid		uuid	Universally unique identifier for the QoS policy.
Output Name	Range	Type	Description
attributes		qos-policy-info	The attributes of the qos-policy.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over list of policies.

Input Name	Range	Type	Description
desired-attributes		qos-policy-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		qos-policy-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the qos-policy object. All qos-policy objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		qos-policy-info[] optional	The list of attributes of qos-policy objects.
next-tag		string optional	Tag for the next call. Not present when there are no more qos-policy objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify an existing policy.

Input Name	Range	Type	Description
cache-policy-name		string optional	Name of an entry in the cache policy table. Identifies cache settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default cache policies will be used. Modifying this field is not recommended.
policy-name		string optional	User visible name of QoS policy.
policy-uuid		uuid	Universally unique identifier for the QoS policy.
read-ahead-policy-name		string optional	Name of an entry in the read-ahead policy table. Identifies read-ahead settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default read-ahead policies will be used. Modifying this field is not recommended.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Modify multiple policies

Input Name	Range	Type	Description
attributes		qos-policy-info	Specify at least one modifiable element. Do not specify any other element.
continue-on-failure		boolean optional	This input element is useful when multiple qos-policy objects match a given query. If set to true, the API will continue modifying the next matching qos-policy even when modification of a previous qos-policy fails. If set to false, the API will return on the first failure. Default: false
max-failure-count	[1..2^32-1]	integer optional	When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching qos-policy even when the modification of a previous matching qos-policy fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
max-records	[1..100]	integer optional	The maximum number of objects to be modified in this call. Default: 20
query		qos-policy-info	If modifying a specific qos-policy, this input element must specify all keys. If modifying qos-policy objects based on query, this input element must specify a query.
return-failure-list		boolean optional	If set to true, the API will return the list of qos-policy objects (just keys) that were not modified due to some error. If set to false, the list of qos-policy objects not modified will not be returned. Default: true
return-success-list		boolean optional	If set to true, the API will return the list of qos-policy objects (just keys) that were successfully updated. If set to false, the list of qos-policy objects modified will not be returned. Default: true
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
failure-list		qos-policy-modify-iter-info[] optional	Information about qos-policy objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
next-tag		string optional	Tag for the next call. Not present when there are no more matching qos-policy objects to be modified.
num-failed	[0..100]	integer optional	Number of qos-policy objects that matched the query, but were not modified due to some error.
num-succeeded	[0..100]	integer optional	The number of qos-policy objects that matched the query and were successfully updated.
success-list		qos-policy-modify-iter-info[] optional	The qos-policy objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true

Errno	Description
EINTERNALERROR

Create a new read-ahead policy. A unique name must be provided for the new read-ahead policy. If the 'default' field is set to true, these become the default read-ahead settings for policies that don't otherwise name read-ahead settings. Unless creating a new default, creating read-ahead policies should usually be assigned to an existing QoS policy.

Input Name	Range	Type	Description
align-blocks	[8..256]	integer optional	Block Alignment
default		boolean optional	Default
disk-response-factor	[1..10]	integer optional	Disk Response Time Factor
disk-response-weight	[0..100]	integer optional	Weight for Disk Response Time Aging (%)
early-count	[0..1024]	integer optional	Number of IO Operations Cautiously Predicted
force-dump		boolean optional	Force DUMP-Style Readahead
force-full		boolean optional	Force Full-File Readahead
force-none		boolean optional	Disable Readahead
interarrival-weight	[0..100]	integer optional	Weight for Interarrival Time Aging (%)
jitter	[0..100]	integer optional	Threshold for Detecting Jitter (%)
max-blocks	[64..1024]	integer optional	Maximum Blocks to Speculate
max-deadline	[100000..5000000]	integer optional	Maximum Deadline Offset (ms)
max-disk-response-time	[100..50000]	integer optional	Maximum Disk Response Time (ms)
max-gap	[512..4096]	integer optional	Maximum Speculative Blocks Outstanding
max-range	[1024..40960]	integer optional	Maximum Range Used When Aging Streams (Blocks)
metadata-blocks	[0..2048]	integer optional	Minimum Blocks for Which Metadata is Predicted
min-blocks	[64..1024]	integer optional	Minimum Blocks to Speculate
min-disk-response-time	[100..50000]	integer optional	Minimum Disk Response Time (ms)
min-range	[1024..40960]	integer optional	Minimum Range Used When Aging Streams (Blocks)
overshoot	[0..500]	integer optional	Allowable Overshoot (%)
read-ahead-class		qos-class optional	Readahead Policy Class Possible values: "preset" - Preset, "user_defined" - User Defined
read-ahead-policy-name		string	Name of QoS Readahead Policy.
return-record		boolean optional	If set to true, returns the qos-policy-read-ahead on successful creation. Default: false
smallfile-blocks	[0..128]	integer optional	Maximum Blocks for Small-File Handling
use-async		boolean optional	Use Asynchronous Speculation
use-feedback		boolean optional	Provide Cache-Miss Feedback
use-timing		boolean optional	Use Timing Algorithms
Output Name	Range	Type	Description
result		qos-policy-read-ahead-info optional	The qos-policy-read-ahead created (keys or the entire object if requested)

Errno	Description
EINTERNALERROR

Delete single read-ahead policy. The default policy may not be deleted. The policy may not be attached to any workloads. Only user defined policies may be deleted.

Input Name	Range	Type	Description
read-ahead-policy-name		string	Name of QoS Readahead Policy.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Delete multiple read-ahead policies.

Input Name	Range	Type	Description
continue-on-failure		boolean optional	This input element is useful when multiple qos-policy-read-ahead objects match a given query. If set to true, the API will continue deleting the next matching qos-policy-read-ahead even when the deletion of a previous qos-policy-read-ahead fails. If set to false, the API will return on the first failure. Default: false
max-failure-count	[1..2^32-1]	integer optional	When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-policy-read-ahead even when the deletion of a previous matching qos-policy-read-ahead fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
max-records	[1..100]	integer optional	The maximum number of qos-policy-read-ahead objects to delete in this call. Default: 20
query		qos-policy-read-ahead-info	If deleting a specific qos-policy-read-ahead, this input element must specify all keys. If deleting multiple qos-policy-read-ahead objects based on query, this input element must specify a query.
return-failure-list		boolean optional	If set to true, the API will return the list of qos-policy-read-ahead objects (just keys) that were not deleted due to some error. If set to false, the list of qos-policy-read-ahead objects not deleted will not be returned. Default: true
return-success-list		boolean optional	If set to true, the API will return the list of qos-policy-read-ahead objects (just keys) that were successfully deleted. If set to false, the list of qos-policy-read-ahead objects deleted will not be returned. Default: true
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
Output Name	Range	Type	Description
failure-list		qos-policy-read-ahead-destroy-iter-info[] optional	Information about qos-policy-read-ahead objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
next-tag		string optional	Tag for the next call. Not present when there are no more matching qos-policy-read-ahead objects to be deleted.
num-failed	[0..100]	integer optional	Number of qos-policy-read-ahead objects that matched the query, but were not deleted due to some error.
num-succeeded	[0..100]	integer optional	The number of qos-policy-read-ahead objects that matched the query and were successfully deleted.
success-list		qos-policy-read-ahead-destroy-iter-info[] optional	The qos-policy-read-ahead objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

Errno	Description
EINTERNALERROR

Get the attributes of a read-ahead policy.

Input Name	Range	Type	Description
desired-attributes		qos-policy-read-ahead-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
read-ahead-policy-name		string	Name of QoS Readahead Policy.
Output Name	Range	Type	Description
attributes		qos-policy-read-ahead-info	The attributes of the qos-policy-read-ahead.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over list of read-ahead policies.

Input Name	Range	Type	Description
desired-attributes		qos-policy-read-ahead-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		qos-policy-read-ahead-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the qos-policy-read-ahead object. All qos-policy-read-ahead objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		qos-policy-read-ahead-info[] optional	The list of attributes of qos-policy-read-ahead objects.
next-tag		string optional	Tag for the next call. Not present when there are no more qos-policy-read-ahead objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify an existing read-ahead policy.

Input Name	Range	Type	Description
align-blocks	[8..256]	integer optional	Block Alignment
default		boolean optional	Default
disk-response-factor	[1..10]	integer optional	Disk Response Time Factor
disk-response-weight	[0..100]	integer optional	Weight for Disk Response Time Aging (%)
early-count	[0..1024]	integer optional	Number of IO Operations Cautiously Predicted
force-dump		boolean optional	Force DUMP-Style Readahead
force-full		boolean optional	Force Full-File Readahead
force-none		boolean optional	Disable Readahead
interarrival-weight	[0..100]	integer optional	Weight for Interarrival Time Aging (%)
jitter	[0..100]	integer optional	Threshold for Detecting Jitter (%)
max-blocks	[64..1024]	integer optional	Maximum Blocks to Speculate
max-deadline	[100000..5000000]	integer optional	Maximum Deadline Offset (ms)
max-disk-response-time	[100..50000]	integer optional	Maximum Disk Response Time (ms)
max-gap	[512..4096]	integer optional	Maximum Speculative Blocks Outstanding
max-range	[1024..40960]	integer optional	Maximum Range Used When Aging Streams (Blocks)
metadata-blocks	[0..2048]	integer optional	Minimum Blocks for Which Metadata is Predicted
min-blocks	[64..1024]	integer optional	Minimum Blocks to Speculate
min-disk-response-time	[100..50000]	integer optional	Minimum Disk Response Time (ms)
min-range	[1024..40960]	integer optional	Minimum Range Used When Aging Streams (Blocks)
overshoot	[0..500]	integer optional	Allowable Overshoot (%)
read-ahead-policy-name		string	Name of QoS Readahead Policy.
smallfile-blocks	[0..128]	integer optional	Maximum Blocks for Small-File Handling
use-async		boolean optional	Use Asynchronous Speculation
use-feedback		boolean optional	Provide Cache-Miss Feedback
use-timing		boolean optional	Use Timing Algorithms

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Modify multiple read-ahead policies

Input Name	Range	Type	Description
attributes		qos-policy-read-ahead-info	Specify at least one modifiable element. Do not specify any other element.
continue-on-failure		boolean optional	This input element is useful when multiple qos-policy-read-ahead objects match a given query. If set to true, the API will continue modifying the next matching qos-policy-read-ahead even when modification of a previous qos-policy-read-ahead fails. If set to false, the API will return on the first failure. Default: false
max-failure-count	[1..2^32-1]	integer optional	When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching qos-policy-read-ahead even when the modification of a previous matching qos-policy-read-ahead fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
max-records	[1..100]	integer optional	The maximum number of objects to be modified in this call. Default: 20
query		qos-policy-read-ahead-info	If modifying a specific qos-policy-read-ahead, this input element must specify all keys. If modifying qos-policy-read-ahead objects based on query, this input element must specify a query.
return-failure-list		boolean optional	If set to true, the API will return the list of qos-policy-read-ahead objects (just keys) that were not modified due to some error. If set to false, the list of qos-policy-read-ahead objects not modified will not be returned. Default: true
return-success-list		boolean optional	If set to true, the API will return the list of qos-policy-read-ahead objects (just keys) that were successfully updated. If set to false, the list of qos-policy-read-ahead objects modified will not be returned. Default: true
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
failure-list		qos-policy-read-ahead-modify-iter-info[] optional	Information about qos-policy-read-ahead objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
next-tag		string optional	Tag for the next call. Not present when there are no more matching qos-policy-read-ahead objects to be modified.
num-failed	[0..100]	integer optional	Number of qos-policy-read-ahead objects that matched the query, but were not modified due to some error.
num-succeeded	[0..100]	integer optional	The number of qos-policy-read-ahead objects that matched the query and were successfully updated.
success-list		qos-policy-read-ahead-modify-iter-info[] optional	The qos-policy-read-ahead objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true

Errno	Description
EINTERNALERROR

Create a new stream. A workload uuid and stream properties must be provided, and a new stream-id is returned.

Input Name	Range	Type	Description
characteristics		qos-stream-characteristics	QoS stream characteristics. The set of parameters that defines this stream.
workload-uuid		uuid	Universally unique identifier for the workload to which the stream is attached.
Output Name	Range	Type	Description
stream-id		integer	Identifier for this stream. Together with the workload-uuid, uniquely identifies the stream.

Errno	Description
EINTERNALERROR

Delete single stream.

Input Name	Range	Type	Description
stream-id	[0..2^32-1]	integer	Identifier for this stream. Together with the workload-uuid, uniquely identifies the stream.
workload-uuid		uuid	Universally unique identifier for the workload to which the stream is attached.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Delete multiple streams.

Input Name	Range	Type	Description
continue-on-failure		boolean optional	This input element is useful when multiple qos-stream objects match a given query. If set to true, the API will continue deleting the next matching qos-stream even when the deletion of a previous qos-stream fails. If set to false, the API will return on the first failure. Default: false
max-failure-count	[1..2^32-1]	integer optional	When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-stream even when the deletion of a previous matching qos-stream fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
max-records	[1..100]	integer optional	The maximum number of qos-stream objects to delete in this call. Default: 20
query		qos-stream-info	If deleting a specific qos-stream, this input element must specify all keys. If deleting multiple qos-stream objects based on query, this input element must specify a query.
return-failure-list		boolean optional	If set to true, the API will return the list of qos-stream objects (just keys) that were not deleted due to some error. If set to false, the list of qos-stream objects not deleted will not be returned. Default: true
return-success-list		boolean optional	If set to true, the API will return the list of qos-stream objects (just keys) that were successfully deleted. If set to false, the list of qos-stream objects deleted will not be returned. Default: true
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
Output Name	Range	Type	Description
failure-list		qos-stream-destroy-iter-info[] optional	Information about qos-stream objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
next-tag		string optional	Tag for the next call. Not present when there are no more matching qos-stream objects to be deleted.
num-failed	[0..100]	integer optional	Number of qos-stream objects that matched the query, but were not deleted due to some error.
num-succeeded	[0..100]	integer optional	The number of qos-stream objects that matched the query and were successfully deleted.
success-list		qos-stream-destroy-iter-info[] optional	The qos-stream objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

Errno	Description
EINTERNALERROR

Get the attributes of a stream.

Input Name	Range	Type	Description
desired-attributes		qos-stream-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
stream-id	[0..2^32-1]	integer	Identifier for this stream. Together with the workload-uuid, uniquely identifies the stream.
workload-uuid		uuid	Universally unique identifier for the workload to which the stream is attached.
Output Name	Range	Type	Description
attributes		qos-stream-info	The attributes of the qos-stream.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over list of streams.

Input Name	Range	Type	Description
desired-attributes		qos-stream-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		qos-stream-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the qos-stream object. All qos-stream objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		qos-stream-info[] optional	The list of attributes of qos-stream objects.
next-tag		string optional	Tag for the next call. Not present when there are no more qos-stream objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Create a new workload. A unique name must be provided for the new workload, and a uuid is returned. Subsequent management operations should index workloads by uuid as the name may be modified. No work will be classified to a workload unless the workload has at least one stream. Therefore at least one stream should usually be created along with a workload. If the performance of the workload is to be controlled by QoS, a policy must also be defined and attached to the workload.

Input Name	Range	Type	Description
workload-name		string	User visible name of QoS workload.
Output Name	Range	Type	Description
workload-uuid		uuid	Universally unique identifier for the QoS workload.

Errno	Description
EINTERNALERROR

Delete single workload. This also deletes any streams attached to the workload. Only user defined workloads may be deleted.

Input Name	Range	Type	Description
workload-uuid		uuid	Universally unique identifier for the QoS workload.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Delete multiple workloads. This also deletes any streams attached to the workloads. Only user defined workloads may be deleted.

Input Name	Range	Type	Description
continue-on-failure		boolean optional	This input element is useful when multiple qos-workload objects match a given query. If set to true, the API will continue deleting the next matching qos-workload even when the deletion of a previous qos-workload fails. If set to false, the API will return on the first failure. Default: false
max-failure-count	[1..2^32-1]	integer optional	When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-workload even when the deletion of a previous matching qos-workload fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
max-records	[1..100]	integer optional	The maximum number of qos-workload objects to delete in this call. Default: 20
query		qos-workload-info	If deleting a specific qos-workload, this input element must specify all keys. If deleting multiple qos-workload objects based on query, this input element must specify a query.
return-failure-list		boolean optional	If set to true, the API will return the list of qos-workload objects (just keys) that were not deleted due to some error. If set to false, the list of qos-workload objects not deleted will not be returned. Default: true
return-success-list		boolean optional	If set to true, the API will return the list of qos-workload objects (just keys) that were successfully deleted. If set to false, the list of qos-workload objects deleted will not be returned. Default: true
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
Output Name	Range	Type	Description
failure-list		qos-workload-destroy-iter-info[] optional	Information about qos-workload objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
next-tag		string optional	Tag for the next call. Not present when there are no more matching qos-workload objects to be deleted.
num-failed	[0..100]	integer optional	Number of qos-workload objects that matched the query, but were not deleted due to some error.
num-succeeded	[0..100]	integer optional	The number of qos-workload objects that matched the query and were successfully deleted.
success-list		qos-workload-destroy-iter-info[] optional	The qos-workload objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

Errno	Description
EINTERNALERROR

Get the attributes of a workload.

Input Name	Range	Type	Description
desired-attributes		qos-workload-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
workload-uuid		uuid	Universally unique identifier for the QoS workload.
Output Name	Range	Type	Description
attributes		qos-workload-info	The attributes of the qos-workload.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over list of workloads.

Input Name	Range	Type	Description
desired-attributes		qos-workload-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		qos-workload-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the qos-workload object. All qos-workload objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		qos-workload-info[] optional	The list of attributes of qos-workload objects.
next-tag		string optional	Tag for the next call. Not present when there are no more qos-workload objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify an existing workload. This may be used to attach/detach policies, rename the workload, of modify the workload's policy-priority.

Input Name	Range	Type	Description
match-priority	[0..2^32-1]	integer optional	Priority of workload if a request can be classified into multiple workloads. The request will be classified to the workload with the highest match-priority. If the workloads have the same match priority then default matching rules are used. Modifying this field is not recommended.
policy-uuid		uuid optional	Universally unique identifier of the policy that the workload is using. If not set, the 'Default' policy will be used.
workload-name		string optional	User visible name of QoS workload.
workload-uuid		uuid	Universally unique identifier for the QoS workload.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Modify multiple workloads

Input Name	Range	Type	Description
attributes		qos-workload-info	Specify at least one modifiable element. Do not specify any other element.
continue-on-failure		boolean optional	This input element is useful when multiple qos-workload objects match a given query. If set to true, the API will continue modifying the next matching qos-workload even when modification of a previous qos-workload fails. If set to false, the API will return on the first failure. Default: false
max-failure-count	[1..2^32-1]	integer optional	When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching qos-workload even when the modification of a previous matching qos-workload fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
max-records	[1..100]	integer optional	The maximum number of objects to be modified in this call. Default: 20
query		qos-workload-info	If modifying a specific qos-workload, this input element must specify all keys. If modifying qos-workload objects based on query, this input element must specify a query.
return-failure-list		boolean optional	If set to true, the API will return the list of qos-workload objects (just keys) that were not modified due to some error. If set to false, the list of qos-workload objects not modified will not be returned. Default: true
return-success-list		boolean optional	If set to true, the API will return the list of qos-workload objects (just keys) that were successfully updated. If set to false, the list of qos-workload objects modified will not be returned. Default: true
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
failure-list		qos-workload-modify-iter-info[] optional	Information about qos-workload objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
next-tag		string optional	Tag for the next call. Not present when there are no more matching qos-workload objects to be modified.
num-failed	[0..100]	integer optional	Number of qos-workload objects that matched the query, but were not modified due to some error.
num-succeeded	[0..100]	integer optional	The number of qos-workload objects that matched the query and were successfully updated.
success-list		qos-workload-modify-iter-info[] optional	The qos-workload objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true

Errno	Description
EINTERNALERROR

preset|user-defined Possible values: "preset" - Preset, "user_defined" - User Defined

[none]

Information about the deletion operation that was attempted/performed against qos-policy object.

Name	Range	Type	Description
error-code	[0..2^32-1]	integer optional	Error code, if the deletion operation caused an error.
error-message		string optional	Error description, if the operation caused an error.
qos-policy-key		qos-policy-info	The keys for the qos-policy object to which the deletion applies.

QoS policy typedef When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
cache-policy-name		string optional	Name of an entry in the cache policy table. Identifies cache settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default cache policies will be used. Modifying this field is not recommended. Attributes: optional-for-create, modifiable
policy-class		qos-class optional	Identifies how policy was created. Preset polices may not be modified or destroyed. Attributes: optional-for-create, non-modifiable Possible values: "preset" - Preset, "user_defined" - User Defined
policy-name		string optional	User visible name of QoS policy. Attributes: required-for-create, modifiable
policy-uuid		uuid optional	Universally unique identifier for the QoS policy. Attributes: key, required-for-create, non-modifiable
read-ahead-policy-name		string optional	Name of an entry in the read-ahead policy table. Identifies read-ahead settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default read-ahead policies will be used. Modifying this field is not recommended. Attributes: optional-for-create, modifiable

Information about the modify operation that was attempted/performed against qos-policy object.

Name	Range	Type	Description
error-code	[0..2^32-1]	integer optional	Error code, if the modify operation caused an error.
error-message		string optional	Error description, if the modify operation caused an error.
qos-policy-key		qos-policy-info	The keys for the qos-policy object to which the modify operation applies.

Information about the deletion operation that was attempted/performed against qos-policy-read-ahead object.

Name	Range	Type	Description
error-code	[0..2^32-1]	integer optional	Error code, if the deletion operation caused an error.
error-message		string optional	Error description, if the operation caused an error.
qos-policy-read-ahead-key		qos-policy-read-ahead-info	The keys for the qos-policy-read-ahead object to which the deletion applies.

QoS read-ahead policy typedef When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
align-blocks	[8..256]	integer optional	Block Alignment Attributes: optional-for-create, modifiable
default		boolean optional	Default Attributes: optional-for-create, modifiable
disk-response-factor	[1..10]	integer optional	Disk Response Time Factor Attributes: optional-for-create, modifiable
disk-response-weight	[0..100]	integer optional	Weight for Disk Response Time Aging (%) Attributes: optional-for-create, modifiable
early-count	[0..1024]	integer optional	Number of IO Operations Cautiously Predicted Attributes: optional-for-create, modifiable
force-dump		boolean optional	Force DUMP-Style Readahead Attributes: optional-for-create, modifiable
force-full		boolean optional	Force Full-File Readahead Attributes: optional-for-create, modifiable
force-none		boolean optional	Disable Readahead Attributes: optional-for-create, modifiable
interarrival-weight	[0..100]	integer optional	Weight for Interarrival Time Aging (%) Attributes: optional-for-create, modifiable
jitter	[0..100]	integer optional	Threshold for Detecting Jitter (%) Attributes: optional-for-create, modifiable
max-blocks	[64..1024]	integer optional	Maximum Blocks to Speculate Attributes: optional-for-create, modifiable
max-deadline	[100000..5000000]	integer optional	Maximum Deadline Offset (ms) Attributes: optional-for-create, modifiable
max-disk-response-time	[100..50000]	integer optional	Maximum Disk Response Time (ms) Attributes: optional-for-create, modifiable
max-gap	[512..4096]	integer optional	Maximum Speculative Blocks Outstanding Attributes: optional-for-create, modifiable
max-range	[1024..40960]	integer optional	Maximum Range Used When Aging Streams (Blocks) Attributes: optional-for-create, modifiable
metadata-blocks	[0..2048]	integer optional	Minimum Blocks for Which Metadata is Predicted Attributes: optional-for-create, modifiable
min-blocks	[64..1024]	integer optional	Minimum Blocks to Speculate Attributes: optional-for-create, modifiable
min-disk-response-time	[100..50000]	integer optional	Minimum Disk Response Time (ms) Attributes: optional-for-create, modifiable
min-range	[1024..40960]	integer optional	Minimum Range Used When Aging Streams (Blocks) Attributes: optional-for-create, modifiable
overshoot	[0..500]	integer optional	Allowable Overshoot (%) Attributes: optional-for-create, modifiable
read-ahead-class		qos-class optional	Readahead Policy Class Attributes: optional-for-create, non-modifiable Possible values: "preset" - Preset, "user_defined" - User Defined
read-ahead-policy-name		string optional	Name of QoS Readahead Policy. Attributes: key, required-for-create, non-modifiable
smallfile-blocks	[0..128]	integer optional	Maximum Blocks for Small-File Handling Attributes: optional-for-create, modifiable
use-async		boolean optional	Use Asynchronous Speculation Attributes: optional-for-create, modifiable
use-feedback		boolean optional	Provide Cache-Miss Feedback Attributes: optional-for-create, modifiable
use-timing		boolean optional	Use Timing Algorithms Attributes: optional-for-create, modifiable

Information about the modify operation that was attempted/performed against qos-policy-read-ahead object.

Name	Range	Type	Description
error-code	[0..2^32-1]	integer optional	Error code, if the modify operation caused an error.
error-message		string optional	Error description, if the modify operation caused an error.
qos-policy-read-ahead-key		qos-policy-read-ahead-info	The keys for the qos-policy-read-ahead object to which the modify operation applies.

QoS stream characteristics. The set of parameters that defines this stream.

Name	Range	Type	Description
lun		string optional	Lun Attributes: optional-for-create, non-modifiable
qtree		string optional	Qtree Attributes: optional-for-create, non-modifiable
volume		volume-name optional	Volume Attributes: optional-for-create, non-modifiable
vserver		vserver-name optional	Vserver Attributes: optional-for-create, non-modifiable

Information about the deletion operation that was attempted/performed against qos-stream object.

Name	Range	Type	Description
error-code	[0..2^32-1]	integer optional	Error code, if the deletion operation caused an error.
error-message		string optional	Error description, if the operation caused an error.
qos-stream-key		qos-stream-info	The keys for the qos-stream object to which the deletion applies.

QoS stream typedef When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
characteristics		qos-stream-characteristics optional	QoS stream characteristics. The set of parameters that defines this stream.
stream-id	[0..2^32-1]	integer optional	Identifier for this stream. Together with the workload-uuid, uniquely identifies the stream. Attributes: key, required-for-create, non-modifiable
workload-uuid		uuid optional	Universally unique identifier for the workload to which the stream is attached. Attributes: key, required-for-create, non-modifiable

Information about the deletion operation that was attempted/performed against qos-workload object.

Name	Range	Type	Description
error-code	[0..2^32-1]	integer optional	Error code, if the deletion operation caused an error.
error-message		string optional	Error description, if the operation caused an error.
qos-workload-key		qos-workload-info	The keys for the qos-workload object to which the deletion applies.

QoS workload typedef When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
match-priority	[0..2^32-1]	integer optional	Priority of workload if a request can be classified into multiple workloads. The request will be classified to the workload with the highest match-priority. If the workloads have the same match priority then default matching rules are used. Modifying this field is not recommended. Attributes: optional-for-create, modifiable
policy-uuid		uuid optional	Universally unique identifier of the policy that the workload is using. If not set, the 'Default' policy will be used. Attributes: optional-for-create, modifiable
workload-class		qos-class optional	Identifies how workload was created. Streams may only be attached to user-defined workloads. Preset workloads may not be modified or destroyed. Attributes: optional-for-create, non-modifiable Possible values: "preset" - Preset, "user_defined" - User Defined
workload-name		string optional	User visible name of QoS workload. Attributes: optional-for-create, modifiable
workload-uuid		uuid optional	Universally unique identifier for the QoS workload. Attributes: key, required-for-create, non-modifiable

Information about the modify operation that was attempted/performed against qos-workload object.

Name	Range	Type	Description
error-code	[0..2^32-1]	integer optional	Error code, if the modify operation caused an error.
error-message		string optional	Error description, if the modify operation caused an error.
qos-workload-key		qos-workload-info	The keys for the qos-workload object to which the modify operation applies.

The 128-bit universally-unique identifier (UUID). UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.

[none]

preset|user-defined Possible values: "preset" - Preset, "user_defined" - User Defined

[none]

QoS policy typedef When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
cache-policy-name		string optional	Name of an entry in the cache policy table. Identifies cache settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default cache policies will be used. Modifying this field is not recommended. Attributes: optional-for-create, modifiable
policy-class		qos-class optional	Identifies how policy was created. Preset polices may not be modified or destroyed. Attributes: optional-for-create, non-modifiable Possible values: "preset" - Preset, "user_defined" - User Defined
policy-name		string optional	User visible name of QoS policy. Attributes: required-for-create, modifiable
policy-uuid		uuid optional	Universally unique identifier for the QoS policy. Attributes: key, required-for-create, non-modifiable
read-ahead-policy-name		string optional	Name of an entry in the read-ahead policy table. Identifies read-ahead settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default read-ahead policies will be used. Modifying this field is not recommended. Attributes: optional-for-create, modifiable

QoS read-ahead policy typedef When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
align-blocks	[8..256]	integer optional	Block Alignment Attributes: optional-for-create, modifiable
default		boolean optional	Default Attributes: optional-for-create, modifiable
disk-response-factor	[1..10]	integer optional	Disk Response Time Factor Attributes: optional-for-create, modifiable
disk-response-weight	[0..100]	integer optional	Weight for Disk Response Time Aging (%) Attributes: optional-for-create, modifiable
early-count	[0..1024]	integer optional	Number of IO Operations Cautiously Predicted Attributes: optional-for-create, modifiable
force-dump		boolean optional	Force DUMP-Style Readahead Attributes: optional-for-create, modifiable
force-full		boolean optional	Force Full-File Readahead Attributes: optional-for-create, modifiable
force-none		boolean optional	Disable Readahead Attributes: optional-for-create, modifiable
interarrival-weight	[0..100]	integer optional	Weight for Interarrival Time Aging (%) Attributes: optional-for-create, modifiable
jitter	[0..100]	integer optional	Threshold for Detecting Jitter (%) Attributes: optional-for-create, modifiable
max-blocks	[64..1024]	integer optional	Maximum Blocks to Speculate Attributes: optional-for-create, modifiable
max-deadline	[100000..5000000]	integer optional	Maximum Deadline Offset (ms) Attributes: optional-for-create, modifiable
max-disk-response-time	[100..50000]	integer optional	Maximum Disk Response Time (ms) Attributes: optional-for-create, modifiable
max-gap	[512..4096]	integer optional	Maximum Speculative Blocks Outstanding Attributes: optional-for-create, modifiable
max-range	[1024..40960]	integer optional	Maximum Range Used When Aging Streams (Blocks) Attributes: optional-for-create, modifiable
metadata-blocks	[0..2048]	integer optional	Minimum Blocks for Which Metadata is Predicted Attributes: optional-for-create, modifiable
min-blocks	[64..1024]	integer optional	Minimum Blocks to Speculate Attributes: optional-for-create, modifiable
min-disk-response-time	[100..50000]	integer optional	Minimum Disk Response Time (ms) Attributes: optional-for-create, modifiable
min-range	[1024..40960]	integer optional	Minimum Range Used When Aging Streams (Blocks) Attributes: optional-for-create, modifiable
overshoot	[0..500]	integer optional	Allowable Overshoot (%) Attributes: optional-for-create, modifiable
read-ahead-class		qos-class optional	Readahead Policy Class Attributes: optional-for-create, non-modifiable Possible values: "preset" - Preset, "user_defined" - User Defined
read-ahead-policy-name		string optional	Name of QoS Readahead Policy. Attributes: key, required-for-create, non-modifiable
smallfile-blocks	[0..128]	integer optional	Maximum Blocks for Small-File Handling Attributes: optional-for-create, modifiable
use-async		boolean optional	Use Asynchronous Speculation Attributes: optional-for-create, modifiable
use-feedback		boolean optional	Provide Cache-Miss Feedback Attributes: optional-for-create, modifiable
use-timing		boolean optional	Use Timing Algorithms Attributes: optional-for-create, modifiable

QoS stream characteristics. The set of parameters that defines this stream.

Name	Range	Type	Description
lun		string optional	Lun Attributes: optional-for-create, non-modifiable
qtree		string optional	Qtree Attributes: optional-for-create, non-modifiable
volume		volume-name optional	Volume Attributes: optional-for-create, non-modifiable
vserver		vserver-name optional	Vserver Attributes: optional-for-create, non-modifiable

QoS workload typedef When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
match-priority	[0..2^32-1]	integer optional	Priority of workload if a request can be classified into multiple workloads. The request will be classified to the workload with the highest match-priority. If the workloads have the same match priority then default matching rules are used. Modifying this field is not recommended. Attributes: optional-for-create, modifiable
policy-uuid		uuid optional	Universally unique identifier of the policy that the workload is using. If not set, the 'Default' policy will be used. Attributes: optional-for-create, modifiable
workload-class		qos-class optional	Identifies how workload was created. Streams may only be attached to user-defined workloads. Preset workloads may not be modified or destroyed. Attributes: optional-for-create, non-modifiable Possible values: "preset" - Preset, "user_defined" - User Defined
workload-name		string optional	User visible name of QoS workload. Attributes: optional-for-create, modifiable
workload-uuid		uuid optional	Universally unique identifier for the QoS workload. Attributes: key, required-for-create, non-modifiable

The 128-bit universally-unique identifier (UUID). UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.

[none]

The name of the volume. Volume names can contain letters, numbers, and the underscore character (_). The first character must be a letter or an underscore. When creating a Cluster-Mode volume, the user can specify at most 203 characters. If the prefix '/vol/' appears in the volume name, it is striped out and the characters that follow the prefix constitute the actual volume name. Volume names are scoped by their owning Vserver in a cluster, with each Vserver's volume namespace being totally independent. Thus, any Vserver 'S' in a cluster cannot have two volumes with the same name 'V'. However, two different Vservers in the same cluster can each have a volume named 'V'. For example, any given Vserver in a cluster can only have at most one volume named 'vol0'. However, two different Vservers S1 and S2 in the cluster may each have a volume named 'vol0'.

[none]

The name of the Vserver.

[none]

preset|user-defined Possible values: "preset" - Preset, "user_defined" - User Defined

[none]