APIs in Category: reallocate | API version 1.12

reallocate-delete-schedule reallocate-list-info reallocate-measure reallocate-off reallocate-on reallocate-quiesce reallocate-restart reallocate-set-schedule reallocate-start reallocate-stop | Reallocation jobs are started with reallocate-start, and later stopped with reallocate-stop. Reallocation jobs may be temporarily quiesced with reallocate-quiesce, and later restarted with reallocate-restart. Schedules for reallocation jobs may be set with reallocate-set-schedule, and deleted with reallocate-delete-schedule. Use reallocate-list-info to get information about reallocation jobs. For additional background information on reallocation please see the na_reallocate manual page.

NetApp Manage ONTAP

reallocate-delete-schedule | [top]

> Delete a schedule for a reallocation job

> Input Name | Range | Type | Description
> path |  | string | Path to large file or LUN whose reallocation schedule should be deleted. The path must start with /vol/

> Errno | Description
> EONTAPI_EINVAL |  |
> EREALLOCATE_BADPATH |  |
> EREALLOCATE_NOMEM |  |
> EREALLOCATE_NOSCAN |  |
> EREALLOCATE_BADVOL |  |
> EREALLOCATE_OFF |  |

reallocate-list-info | [top]

> Get status for WAFL reallocation jobs

> Input Name | Range | Type | Description
> path |  | string optional | Name of a path to get status on. If specified only status for that path is returned. If not specified, information for all reallocation jobs is returned. The path must start with /vol/.
> verbose |  | boolean optional | If true, verbose output is returned. Otherwise default output is returned.
> Output Name | Range | Type | Description
> global-status |  | string | The system-wide status of the reallocation system on the filer. The status is of the format: "Reallocation scans are on" or "Reallocation scans are off".
> reallocate-jobs |  | reallocate-job-info[] | Array of all or specified reallocation jobs.

> Errno | Description
> EREALLOCATE_BADPATH |  |
> EREALLOCATE_NOMEM |  |
> EREALLOCATE_NOSCAN |  |
> EREALLOCATE_BADVOL |  |
> EREALLOCATE_OFF |  |

reallocate-measure | [top]

> Starts a new measurement-only reallocate job.

> Input Name | Range | Type | Description
> interval |  | string optional | The interval between repeated scans. The format is numX, where X is m, h or d, indicating minutes, hours or days.
> measure-logfile |  | string optional | Path to a full name on the appliance where information about the most recent measurement made will be logged, e.g. "/vol/logvol/measurelog.txt"
> path |  | string | Path to large file, LUN or volume to measure optimization on, starting with /vol/.
> run-once |  | boolean optional | If true, run the scan once then exit. Interval and run-one are mutually exclusive
> threshold |  | integer optional | The allocation threshold before path is regarded as needing optimization. A larger value indicates the file or LUN can be more fragmented. Range: [3..10]

> Errno | Description
> EONTAPI_EINVAL |  |
> EREALLOCATE_EXISTS |  |
> EREALLOCATE_BADPATH |  |
> EREALLOCATE_NOMEM |  |
> EREALLOCATE_BADVOL |  |
> EREALLOCATE_READONLY |  |
> EREALLOCATE_OFF |  |

reallocate-off | [top]

> Globally disables WAFL reallocation jobs

> Output Name | Range | Type | Description
> detail-status |  | string | Detailed result status. If reallocation scans are already off the detailed status is "Reallocation scans are off". If reallocation scans will be disabled the detailed status is "Reallocation scans will be disabled."

> Errno | Description
> EONTAPI_EINVAL |  |

reallocate-on | [top]

> Globally enables WAFL reallocation jobs

> Output Name | Range | Type | Description
> detail-status |  | string | Detailed result status. If reallocation scans are already on the detailed status is "Reallocation scans are on". If reallocation scans will be enabled the detailed status is "Reallocation scans will be enabled."

> Errno | Description
> EONTAPI_EINVAL |  |

reallocate-quiesce | [top]

> Quiesce a reallocation job. When a reallocation job is quiesced it will not be run until restarted, however information about the job is preserved.

> Input Name | Range | Type | Description
> path |  | string | Path to large file or LUN to quiesce, starting with /vol/

> Errno | Description
> EONTAPI_EINVAL |  |
> EREALLOCATE_BADPATH |  |
> EREALLOCATE_NOMEM |  |
> EREALLOCATE_NOSCAN |  |

reallocate-restart | [top]

> Restart a reallocation job that is quiesced or idle.

> Input Name | Range | Type | Description
> ignore-checkpoint |  | boolean optional | Some long-running reallocate functions will checkpoint their progress so that if they are stopped (e.g., via quiesce or a reboot), they will continue from their previous position. This option, if true, ignores the checkpoint and restarts at the beginning.
> path |  | string | Path to large file or LUN to restart reallocation on, starting with /vol/

> Errno | Description
> EONTAPI_EINVAL |  |
> EREALLOCATE_BADPATH |  |
> EREALLOCATE_NOMEM |  |
> EREALLOCATE_NOSCAN |  |
> EREALLOCATE_OFF |  |

reallocate-set-schedule | [top]

> Set a schedule for a reallocation job.

> Input Name | Range | Type | Description
> path |  | string | Path to large file or LUN to reallocate, starting with /vol/
> schedule |  | string | Reallocation schedule, in format " ", where each field is either a number, a comma-separated range of numbers, or "*", indicating all values.

> Errno | Description
> EONTAPI_EINVAL |  |
> EREALLOCATE_BADPATH |  |
> EREALLOCATE_NOMEM |  |
> EREALLOCATE_NOSCAN |  |
> EREALLOCATE_BADVOL |  |
> EREALLOCATE_BADSCHED |  |
> EREALLOCATE_OFF |  |

reallocate-start | [top]

> Starts a new reallocation job

> Input Name | Range | Type | Description
> full |  | boolean optional | If true, perform a once-only full reallocate of the indicated file, LUN or volume (specified as /vol/VOLNAME). This option implies run-once and no-check are true.
> interval |  | string optional | The interval between repeated scans. The format is numX, where X is m, h or d, indicating minutes, hours or days.
> is-aggregate |  | boolean optional | If true, reallocate the aggregate indicated by the path. This performs block reallocation, not file reallocation.
> no-check |  | boolean optional | If true, do not check if the current layout optimization is above the threshold before reallocateing.
> path |  | string | Path to large file or LUN to reallocate, starting with /vol/. If the full option is true then an entire volume may also be specified, as /vol/VOLNAME. If an aggregate, just the aggregate name must be specified.
> preserve-logical-bno |  | boolean optional | If true, reallocate the physical block location in the aggregate, but do not change the logical block number in the flexible volume. This option may only be selected for flexible volumes or files/LUNs within flexible volumes.
> run-once |  | boolean optional | If true, run the scan once then exit.
> threshold |  | integer optional | The allocation threshold before reallocation occurs. A larger value indicates the file or LUN can be more fragmented. Range: [3..10]

> Errno | Description
> EONTAPI_EINVAL |  |
> EREALLOCATE_EXISTS |  |
> EREALLOCATE_BADPATH |  |
> EREALLOCATE_NOMEM |  |
> EREALLOCATE_BADVOL |  |
> EREALLOCATE_READONLY |  |
> EREALLOCATE_OFF |  |

reallocate-stop | [top]

> Stops a reallocation job.

> Input Name | Range | Type | Description
> path |  | string | Path to large file or LUN to stop reallocation on. The path must start with /vol/

> Errno | Description
> EONTAPI_EINVAL |  |
> EREALLOCATE_NOSCAN |  |
> EREALLOCATE_BADPATH |  |
> EREALLOCATE_NOMEM |  |
> EREALLOCATE_BADVOL |  |

Element definition: reallocate-job-info | [top]

> Information about a specific reallocation job.

> Name | Range | Type | Description
> flags |  | string optional | Flags associated with a reallocation job (verbose only). This is for internal use only.
> interval |  | string | Interval between reallocation jobs The format for this value is as described in reallocate-start, above.
> layout-factor |  | integer | Current allocation layout factor, if known. The range is from 1 (ideal layout) upwards. A value of -1 is returned if the current layout factor is unknown.
> measure-logfile |  | string optional | For a measure-only job the logfile, if any.
> measure-only |  | boolean | True if the reallocate job is measure-only, false otherwise.
> path |  | string | The path for the reallocation job.
> scan-detail |  | string | If a reallocation job is running, detail on the current scan, including the progress when known.
> schedule |  | string | Schedule for reallocation. The format for this value is as described in reallocate-schedule-set, above.
> state |  | string | The current state of the reallocation job. The states are Idle, Checking, Reallocating, Deleting or Quiesce.
> threshold |  | integer optional | The reallocation threshold (verbose only), as described above in reallocate-start, above.