APIs in Category: priority | 7-Mode API version 1.21

priority-disable priority-enable priority-hybridcache-get priority-hybridcache-set priority-list-info priority-list-info-default priority-list-info-volume priority-set priority-set-default priority-set-volume | Priority scheduling is used to control usage of resources within an appliance. The primary element of control is the flexible or traditional volume. Volumes are either assigned their own scheduling policy, or use the system default scheduling policy when priority scheduling is enabled. The main priority controls are: o The relative priority of operations against a volume when an appliance is under load (the "level") o The balancing of user vs system operations for a specific volume when an appliance is under load. These settings indirectly set other priority controls, which may be overridden if necessary: o The buffer cache policy to apply. o The maximum number of outstanding user read disk operations (by volume) o The maximum number of outstanding system read disk operations (by volume) o The percentage of appliance NVRAM that may be consumed during a WAFL consistency point.

NetApp Manage ONTAP

priority-disable | [top]

> Globally disable priority scheduling

priority-enable | [top]

> Globally enable priority scheduling

priority-hybridcache-get | [top]

> Sets caching policies for a volume

> Input Name | Range | Type | Description
> volume |  | string | The volume for which the caching polcies are requested.
> Output Name | Range | Type | Description
> is-hybrid-cache-enabled |  | boolean | This field shows if hybrid caching is enabled on the volume Possible values are "enabled" or "disabled".
> read-cache |  | string | Current read caching policies on the volume. The possible values are - "meta" - insert only volume metadata buffers into the SSD tier. "random_read" - inserts randomly accessed buffers into the SSD SSD tier. "random_read_write" - inserts buffers as defined by "random-read". In addition, buffers involved in random write operations are cached.
> write-cache |  | string optional | Current write caching policies on the volume. The possible values are - "random_write" - randomly accessed buffers are write cached. "none" - no buffers will be write cached. "not_supported" - write caching cannot be configured on this volume.

> Errno | Description
> EVOLUMEDOESNOTEXIST |  |
> EAGGR_NOT_HYBRID |  |
> EONTAPI_EOFFLINE |  |
> EVOLUMEREADONLY |  |
> EONTAPI_EINVAL |  |

priority-hybridcache-set | [top]

> Sets caching policies for a volume

> Input Name | Range | Type | Description
> read-cache |  | string optional | Sets the volume policies for insertion into the SSD tier. The possible values are - "meta" - insert only volume metadata buffers into the SSD tier. "random_read" - inserts randomly accessed buffers into the SSD SSD tier. "random_read_write" - inserts buffers as defined by "random-read". In addition, buffers involved in random write operations are cached. Note: either read-cache and/or write-cache must be provided as inputs
> volume |  | string | The volume on which the hybrid caching policy is to be set.
> write-cache |  | string optional | Sets the volume policies for write caching into SSD tier. The possible values are - "random_write" - randomly accessed buffers are write cached. "none" - no buffers will be write cached.

> Errno | Description
> EVOLUMEDOESNOTEXIST |  |
> EAGGR_NOT_HYBRID |  |
> EONTAPI_EOFFLINE |  |
> EVOLUMEREADONLY |  |
> EONTAPI_EINVAL |  |
> EVOLUMEBUSY |  |
> EVOL_CANT_WRITE_CACHE |  |

priority-list-info | [top]

> Get status information for priority scheduler

> Output Name | Range | Type | Description
> enabled-components |  | string | A list of enabled priority components, or "all" if all components are enabled.
> io-concurrency |  | integer | The value for IO concurrency, as described in priority-set
> nvlog-cp-completion |  | string | The method for consistency point (CP) completion when NVLOG limiting is being enforced, as described in priority-set.
> nvlog-cp-threshold |  | integer | The threshold for NVLOG limiting during a consistency point (CP), as described in priority-set. Range: [1..100]
> status |  | string | Whether priority scheduling is enabled, possible values are 'on' or 'off'

> Errno | Description
> EONTAPI_ENOENT |  |

priority-list-info-default | [top]

> Get information for the default scheduling policy in the priority scheduler. The default scheduling policy is applied to volumes that do not have an explicit policy set.

> Output Name | Range | Type | Description
> level |  | integer optional | The priority level, from 1-10
> nvlog-limit |  | integer | The limit on nvlog consumption during a consistency point. 0 means a system-created default is being applied.
> system |  | integer | The system/user priority, from 1-10
> system-read-limit |  | integer | The limit on system reads, as described in priority-set-default. A value of 0 means a system-created default is used.
> user-read-limit |  | integer | The limit on user reads, as described in priority-set-default. A value of 0 means a system-created default is used.

priority-list-info-volume | [top]

> Get volume-related priority schedule information.

> Input Name | Range | Type | Description
> volume |  | string optional | If specified, a specific volume whose priority schedule should be returned. If ommitted, all priority schedules for volumes are returned.
> Output Name | Range | Type | Description
> priority-volume |  | priority-volume-info[] | Array of all or specified volume-related priority schedule information.

> Errno | Description
> EONTAPI_ENOENT |  |

priority-set | [top]

> Sets priority options

> Input Name | Range | Type | Description
> io-concurrency |  | integer optional | Sets the io-concurrency value for the appliance. The io-concurrency specifies the average number of concurrent io operations to a disk.
> nvlog-cp-completion |  | string optional | Sets the nvlog-cp-completion value for the appliance The nvlog-cp-completion defines the method of consistency point (CP) completion when one or more volumes are limited by NVLOG usage. Possible values are: "fast", "paced" or "default". A fast CP completion will finish the CP as soon as possible, so allowed resources blocked on NVLOG to be continue. A paced CP completion (the default when no NVLOG limiting occurs) controls the speed of the CP to reduce system impact overall, but may cause resources blocks on NVLOG to delay longer. The default mode is fast.
> nvlog-cp-threshold |  | integer optional | Sets the nvlog-cp-threshold value for the appliance as a percentage. The nvlog-cp-threshold defines the percentage of the system NVLOG that must be used before NVLOG limits are applied during a system consistency point (CP). The default value is 50%. Range: [1..100]

> Errno | Description
> EONTAPI_EINVAL |  |

priority-set-default | [top]

> Sets priority options for default scheduling. Default scheduling is applied to all volumes that do not have a specific scheduling policy defined.

> Input Name | Range | Type | Description
> level |  | integer optional | Sets the priority schedule level for the volume. The possible values are 1 through 10, where 1 means lowest relative priority, and 10 means highest relative priority.
> nvlog-limit |  | integer optional | The maximum number percentage of system NVLOG resources that may be consumed during a consistency point.
> system |  | integer optional | Sets the relative priority system/user scheduling for the volume. The possible value are 1 through 10, where 1 means heavily favor user operations and 10 means heavily favor system operations.
> system-read-limit |  | integer optional | The maximum number of system read operations outstanding, before further operations are queued.
> user-read-limit |  | integer optional | The maximum number of user read operations outstanding, before further operations are queued.

> Errno | Description
> EONTAPI_EINVAL |  |

priority-set-volume | [top]

> Sets priority scheduling for a volume

> Input Name | Range | Type | Description
> cache-policy |  | string optional | The buffer cache policy to use for the volume. Possible values are: 'keep' - Try to keep data in the buffer cache. 'reuse' - Reuse blocks, do not try to cache. 'default' - Apply the default policy
> level |  | integer optional | Sets the priority schedule level for the volume. The possible values are 1 through 10, where 1 means lowest relative priority, and 10 means highest relative priority.
> nvlog-limit |  | integer optional | The maximum number percentage of system NVLOG resources that may be consumed. A value of 0 means restore the system-defined limit.
> service |  | string optional | Sets the priority service type for the volume. The possible values are 'on', 'off' or 'default'. 'off' temporarily disables specific priority scheduling for the volume, but preserves the priority schedule so that it can later be enabled. 'default' removes the specific priority scheduling for the volume, which will revert to using the default priority schedule.
> system |  | integer optional | Sets the relative priority system/user scheduling for the volume. The possible value are 1 through 10, where 1 means heavily favor user operations and 10 means heavily favor system operations.
> system-read-limit |  | integer optional | The maximum number of system read operations outstanding, before further operations are queued. A value of 0 means restore the system-defined limit.
> user-read-limit |  | integer optional | The maximum number of user read operations outstanding, before further operations are queued. A value of 0 means restore the system-defined limit.
> volume |  | string | The volume whose priority scheduling is to be set.

> Errno | Description
> EONTAPI_EINVAL |  |

Element definition: priority-volume-info | [top]

> Information about a priority schedule for a volume.

> Name | Range | Type | Description
> cache-policy |  | string | The cache policy, as described in priority-set-volume.
> level |  | integer | The priority level, as described in priority-set-volume.
> nvlog-limit |  | integer | The limit on nvlog consumption during a consistency point. 0 means a system-created default is being applied.
> service |  | string | The priority service state for the volume, "on" or "off"
> system |  | integer | The system/user priority, as described in priority-set-volume.
> system-read-limit |  | integer | The limit on system reads, 0 means an automatic system default is being applied.
> user-read-limit |  | integer | The limit on user reads, 0 means an automatic system default is being applied.
> volume |  | string | Name of the volume.