APIs in Category: job | Cluster-Mode API version 1.21

job-by-node-get-iter job-completed-get-iter job-get-iter job-history-get-iter job-pause-iter job-private-completed-get-iter job-private-get-iter job-private-pause-iter job-private-resume-iter job-private-soft-pause-iter job-private-stop-iter job-resume-iter job-schedule-cron-create job-schedule-cron-destroy job-schedule-cron-destroy-iter job-schedule-cron-get job-schedule-cron-get-iter job-schedule-cron-modify job-schedule-get job-schedule-get-iter job-schedule-interval-create job-schedule-interval-destroy job-schedule-interval-destroy-iter job-schedule-interval-get job-schedule-interval-get-iter job-schedule-interval-modify job-soft-pause-iter job-stop-iter | Cluster management requires that certain operations run reliably, asynchronously and on particular schedules. These 'jobs' offer these benefits to the work they manage: Guaranteed execution, even in the face of node failure or reboot. Cluster-wide or node-specific scheduling. This permits jobs to execute where it makes the most sense. Flexible scheduling as a one time event, on regular intervals or coordinated to specific calendar dates. On their exterior, jobs are a fundamentally simple concept. A job is a task that executes at a specific time. Around this idea, there are extended attributes that control if the job will be automatically re-scheduled upon completion, survive major system failures, run under which priority and so on. But in a healthy cluster with little activity, all jobs appear very similarly. The job APIs are generally comprised of those that enumerate and act upon jobs in the system and those that allow schedule customization. It should be noted that there are no APIs that allow one to explicitly create jobs. This is intentional as jobs are used to manage internal system workload. Jobs are responsible for activities like moving a volume, scanning for viruses or automatically taking snapshots as opposed to being a generic administrative process scheduler. Every job is described specifically by its type, id, affinity, visibility and schedule. Both the job type and id are represented by unique universal identifiers (UUIDs). All jobs of a given type will perform the same task, usually with different runtime data. For instance a volume move operation is one type of job, but can be used for many different volumes. Job id is a specific instance of a job type. In the example above three different volume move jobs would have the same type but three different job ids. Jobs are also sometimes identified by a monotonically increasing numeric value, although this is often just a shorthand notation for the UUID. Affinity describes whether a job may be scheduled for execution on any node in the cluster (cluster) or must be tied to a specific compute instance (node). Visibility dictates whether a job's state is stored in the cluster-wide replicated database (public) or only on the node on which it is scheduled for execution (private). Finally a job schedun abstract concept like when the system starts up or based upon a calendar date or interval between executions of the same job. Jobs always execute as small state machines with a definitive current state as well as a specific list of states the job may enter at any point in time. A job can be in one of the following states: Initial - job has been created but not queued yet Queued - job is in the queue; it could be ready to run immediately or it may be scheduled to run at a later time Running - the job has been picked by an instance of the Job Manager and is running Waiting - the job is waiting for another job to complete Pausing - the job is in the process of pausing after being requested to pause Paused - the job is indefinitely paused Quitting - the job has been requested to terminate and it is shutting down Success - the job has successfully completed and the results are available Failure - the job has failed Reschedule - the job is being re-scheduled Error - internal error occurred Quit - the job has been requested to terminate Dead - the job exceeded the drop dead time and is being removed from the queue Unknown - the state of the job is unknown Restart - the job is restartable Dormant - the job is inactive while waiting on some external event Internally, the job execution engine organizes jobs of similar states into common queues. Queues are processed according to the rules of the state. For example, jobs in the wait queue are only periodically checked to determine if their waiting condition is met, whereas jobs in the running queue are actively processed as CPU capacity permits. These APIs allow for job enumeration, schedule creation and low-level management. The most common enumeration APIs are job-get, job-private-get and job-history-get, while the more specific APIs like job-by-node-get act on a subset of the job-get result set once it has been suitable filtered and/or sorted. Schedules may either occur at well-defined calendar dates or on a given interval between job executions. Use of the low-level APIs should be attempted with care as they can cause the jobs to behave abnormally or fail.

NetApp Manage ONTAP

job-by-node-get-iter | [top]

> Get multiple job records organized by node. This is just a performance optimization for job-get-iter that only searches for the job among the ones currently owned by the given node.

> Input Name | Range | Type | Description
> desired-attributes |  | job-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | job-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the job-by-node entry object. All job-by-node entry 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 |  | job-info[] optional | The list of attributes of job-by-node entry objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more job-by-node entry objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

job-completed-get-iter | [top]

> Get multiple completed job records. This is just a performance optimization for job-get-iter.

> Input Name | Range | Type | Description
> desired-attributes |  | job-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | job-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the job completed object. All job completed 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 |  | job-info[] optional | The list of attributes of job completed objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more job completed objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

job-get-iter | [top]

> Get multiple job records.

> Input Name | Range | Type | Description
> desired-attributes |  | job-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | job-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the job object. All job 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 |  | job-info[] optional | The list of attributes of job objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more job objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

job-history-get-iter | [top]

> Get multiple job history records.

> Input Name | Range | Type | Description
> desired-attributes |  | job-history-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 100
> query |  | job-history-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the job history event object. All job history event 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 |  | job-history-info[] optional | The list of attributes of job history event objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more job history event objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

job-pause-iter | [top]

> Pause a collection of jobs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple job objects match a given query. If set to true, the API will continue with the next matching job even when the operation fails for the job. 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 operations before the server gives up and returns. If set, the API will continue with the next matching job even when the operation on a previous matching job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of job objects to be operated in this call. Default: 20
> query |  | job-info | If operating on a specific job, this input element must specify all keys. If operating on job 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 job objects (just keys) that were not operated on due to some error. If set to false, the list of job objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of job objects (just keys) that were successfully operated on. If set to false, the list of job objects operated on 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 |  | job-pause-iter-info[] optional | Information about job objects that were not operated on 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 job objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of job objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of job objects that matched the query and were successfully processed.
> success-list |  | job-pause-iter-info[] optional | The job objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

job-private-completed-get-iter | [top]

> Get multiple completed, private job records. This is just a performance optimization for job-private-get-iter.

> Input Name | Range | Type | Description
> desired-attributes |  | job-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | job-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the private job completion entry object. All private job completion entry 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 |  | job-info[] optional | The list of attributes of private job completion entry objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more private job completion entry objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

job-private-get-iter | [top]

> Get multiple private job records.

> Input Name | Range | Type | Description
> desired-attributes |  | job-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | job-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the private job object. All private job 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 |  | job-info[] optional | The list of attributes of private job objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more private job objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

job-private-pause-iter | [top]

> Pause a collection of private jobs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple private job objects match a given query. If set to true, the API will continue with the next matching private job even when the operation fails for the private job. 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 operations before the server gives up and returns. If set, the API will continue with the next matching private job even when the operation on a previous matching private job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of private job objects to be operated in this call. Default: 20
> query |  | job-info | If operating on a specific private job, this input element must specify all keys. If operating on private job 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 private job objects (just keys) that were not operated on due to some error. If set to false, the list of private job objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of private job objects (just keys) that were successfully operated on. If set to false, the list of private job objects operated on 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 |  | job-private-pause-iter-info[] optional | Information about private job objects that were not operated on 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 private job objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of private job objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of private job objects that matched the query and were successfully processed.
> success-list |  | job-private-pause-iter-info[] optional | The private job objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

job-private-resume-iter | [top]

> Resume a collection of jobs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple private job objects match a given query. If set to true, the API will continue with the next matching private job even when the operation fails for the private job. 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 operations before the server gives up and returns. If set, the API will continue with the next matching private job even when the operation on a previous matching private job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of private job objects to be operated in this call. Default: 20
> query |  | job-info | If operating on a specific private job, this input element must specify all keys. If operating on private job 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 private job objects (just keys) that were not operated on due to some error. If set to false, the list of private job objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of private job objects (just keys) that were successfully operated on. If set to false, the list of private job objects operated on 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 |  | job-private-resume-iter-info[] optional | Information about private job objects that were not operated on 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 private job objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of private job objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of private job objects that matched the query and were successfully processed.
> success-list |  | job-private-resume-iter-info[] optional | The private job objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

job-private-soft-pause-iter | [top]

> Soft pause a collection of private jobs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple private job objects match a given query. If set to true, the API will continue with the next matching private job even when the operation fails for the private job. 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 operations before the server gives up and returns. If set, the API will continue with the next matching private job even when the operation on a previous matching private job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of private job objects to be operated in this call. Default: 20
> query |  | job-info | If operating on a specific private job, this input element must specify all keys. If operating on private job 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 private job objects (just keys) that were not operated on due to some error. If set to false, the list of private job objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of private job objects (just keys) that were successfully operated on. If set to false, the list of private job objects operated on 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 |  | job-private-soft-pause-iter-info[] optional | Information about private job objects that were not operated on 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 private job objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of private job objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of private job objects that matched the query and were successfully processed.
> success-list |  | job-private-soft-pause-iter-info[] optional | The private job objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

job-private-stop-iter | [top]

> Stop a collection of jobs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple private job objects match a given query. If set to true, the API will continue with the next matching private job even when the operation fails for the private job. 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 operations before the server gives up and returns. If set, the API will continue with the next matching private job even when the operation on a previous matching private job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of private job objects to be operated in this call. Default: 20
> query |  | job-info | If operating on a specific private job, this input element must specify all keys. If operating on private job 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 private job objects (just keys) that were not operated on due to some error. If set to false, the list of private job objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of private job objects (just keys) that were successfully operated on. If set to false, the list of private job objects operated on 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 |  | job-private-stop-iter-info[] optional | Information about private job objects that were not operated on 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 private job objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of private job objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of private job objects that matched the query and were successfully processed.
> success-list |  | job-private-stop-iter-info[] optional | The private job objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

job-resume-iter | [top]

> Resume a collection of jobs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple job objects match a given query. If set to true, the API will continue with the next matching job even when the operation fails for the job. 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 operations before the server gives up and returns. If set, the API will continue with the next matching job even when the operation on a previous matching job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of job objects to be operated in this call. Default: 20
> query |  | job-info | If operating on a specific job, this input element must specify all keys. If operating on job 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 job objects (just keys) that were not operated on due to some error. If set to false, the list of job objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of job objects (just keys) that were successfully operated on. If set to false, the list of job objects operated on 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 |  | job-resume-iter-info[] optional | Information about job objects that were not operated on 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 job objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of job objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of job objects that matched the query and were successfully processed.
> success-list |  | job-resume-iter-info[] optional | The job objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

job-schedule-cron-create | [top]

> Create a new cron job schedule entry.

> Input Name | Range | Type | Description
> job-schedule-cron-day |  | cron-day-of-month[] optional | The day(s) of the month when the job should be run.
> job-schedule-cron-day-of-week |  | cron-day-of-week[] optional | The day(s) in the week when the job should be run.
> job-schedule-cron-hour |  | cron-hour[] optional | The hour(s) of the day when the job should be run.
> job-schedule-cron-minute |  | cron-minute[] | The minute(s) of each hour when the job should be run.
> job-schedule-cron-month |  | cron-month[] optional | The month(s) when the job should be run.
> job-schedule-name |  | string | The name of the job schedule.
> return-record |  | boolean optional | If set to true, returns the job-schedule-cron on successful creation. Default: false
> Output Name | Range | Type | Description
> result |  | job-schedule-cron-info optional | The job-schedule-cron created (keys or the entire object if requested)

> Errno | Description
> EINTERNALERROR |  |

job-schedule-cron-destroy | [top]

> Delete a single cron job schedule entry. The entry must not be in use.

> Input Name | Range | Type | Description
> job-schedule-name |  | string | The name of the job schedule.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

job-schedule-cron-destroy-iter | [top]

> Delete multiple cron job schedule entries. The entries must not be in use.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple job-schedule-cron objects match a given query. If set to true, the API will continue deleting the next matching job-schedule-cron even when the deletion of a previous job-schedule-cron 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 job-schedule-cron even when the deletion of a previous matching job-schedule-cron 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..2^32-1] | integer optional | The maximum number of job-schedule-cron objects to delete in this call. Default: 100
> query |  | job-schedule-cron-info | If deleting a specific job-schedule-cron, this input element must specify all keys. If deleting multiple job-schedule-cron 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 job-schedule-cron objects (just keys) that were not deleted due to some error. If set to false, the list of job-schedule-cron 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 job-schedule-cron objects (just keys) that were successfully deleted. If set to false, the list of job-schedule-cron 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 |  | job-schedule-cron-destroy-iter-info[] optional | Information about job-schedule-cron 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 job-schedule-cron objects to be deleted.
> num-failed | [0..2^32-1] | integer optional | Number of job-schedule-cron objects that matched the query, but were not deleted due to some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of job-schedule-cron objects that matched the query and were successfully deleted.
> success-list |  | job-schedule-cron-destroy-iter-info[] optional | The job-schedule-cron objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |

job-schedule-cron-get | [top]

> Get a single cron job schedule entry.

> Input Name | Range | Type | Description
> desired-attributes |  | job-schedule-cron-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.
> job-schedule-name |  | string | The name of the job schedule.
> Output Name | Range | Type | Description
> attributes |  | job-schedule-cron-info | The attributes of the job-schedule-cron.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

job-schedule-cron-get-iter | [top]

> Get multiple cron job schedule entries.

> Input Name | Range | Type | Description
> desired-attributes |  | job-schedule-cron-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 100
> query |  | job-schedule-cron-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the job-schedule-cron object. All job-schedule-cron 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 |  | job-schedule-cron-info[] optional | The list of attributes of job-schedule-cron objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more job-schedule-cron objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

job-schedule-cron-modify | [top]

> Modify an existing cron job schedule entry.

> Input Name | Range | Type | Description
> job-schedule-cron-day |  | cron-day-of-month[] optional | The day(s) of the month when the job should be run.
> job-schedule-cron-day-of-week |  | cron-day-of-week[] optional | The day(s) in the week when the job should be run.
> job-schedule-cron-hour |  | cron-hour[] optional | The hour(s) of the day when the job should be run.
> job-schedule-cron-minute |  | cron-minute[] optional | The minute(s) of each hour when the job should be run.
> job-schedule-cron-month |  | cron-month[] optional | The month(s) when the job should be run.
> job-schedule-name |  | string | The name of the job schedule.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

job-schedule-get | [top]

> Get a single job schedule entry.

> Input Name | Range | Type | Description
> desired-attributes |  | job-schedule-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.
> job-schedule-name |  | string | The name of the job schedule.
> Output Name | Range | Type | Description
> attributes |  | job-schedule-info | The attributes of the job-schedule.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

job-schedule-get-iter | [top]

> Get multiple job schedule entries.

> Input Name | Range | Type | Description
> desired-attributes |  | job-schedule-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | job-schedule-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the job-schedule object. All job-schedule 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 |  | job-schedule-info[] optional | The list of attributes of job-schedule objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more job-schedule objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

job-schedule-interval-create | [top]

> Create a new interval job schedule entry.

> Input Name | Range | Type | Description
> job-schedule-interval-days | [0..2^32-1] | integer optional | The number of days between jobs.
> job-schedule-interval-hours | [0..2^32-1] | integer optional | The number of hours between jobs.
> job-schedule-interval-minutes | [0..2^32-1] | integer optional | The number of minutes between jobs.
> job-schedule-interval-seconds | [0..2^32-1] | integer optional | The number of seconds between jobs.
> job-schedule-name |  | string | The name of the job schedule.
> return-record |  | boolean optional | If set to true, returns the job-schedule-interval on successful creation. Default: false
> Output Name | Range | Type | Description
> result |  | job-schedule-interval-info optional | The job-schedule-interval created (keys or the entire object if requested)

> Errno | Description
> EINTERNALERROR |  |

job-schedule-interval-destroy | [top]

> Delete a single interval job schedule entry. The entry must not be in use.

> Input Name | Range | Type | Description
> job-schedule-name |  | string | The name of the job schedule.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

job-schedule-interval-destroy-iter | [top]

> Delete multiple interval job schedule entries. The entries must not be in use.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple job-schedule-interval objects match a given query. If set to true, the API will continue deleting the next matching job-schedule-interval even when the deletion of a previous job-schedule-interval 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 job-schedule-interval even when the deletion of a previous matching job-schedule-interval 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..2^32-1] | integer optional | The maximum number of job-schedule-interval objects to delete in this call. Default: 100
> query |  | job-schedule-interval-info | If deleting a specific job-schedule-interval, this input element must specify all keys. If deleting multiple job-schedule-interval 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 job-schedule-interval objects (just keys) that were not deleted due to some error. If set to false, the list of job-schedule-interval 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 job-schedule-interval objects (just keys) that were successfully deleted. If set to false, the list of job-schedule-interval 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 |  | job-schedule-interval-destroy-iter-info[] optional | Information about job-schedule-interval 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 job-schedule-interval objects to be deleted.
> num-failed | [0..2^32-1] | integer optional | Number of job-schedule-interval objects that matched the query, but were not deleted due to some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of job-schedule-interval objects that matched the query and were successfully deleted.
> success-list |  | job-schedule-interval-destroy-iter-info[] optional | The job-schedule-interval objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |

job-schedule-interval-get | [top]

> Get a single interval job schedule entry.

> Input Name | Range | Type | Description
> desired-attributes |  | job-schedule-interval-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.
> job-schedule-name |  | string | The name of the job schedule.
> Output Name | Range | Type | Description
> attributes |  | job-schedule-interval-info | The attributes of the job-schedule-interval.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

job-schedule-interval-get-iter | [top]

> Get multiple interval job schedule entries.

> Input Name | Range | Type | Description
> desired-attributes |  | job-schedule-interval-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 100
> query |  | job-schedule-interval-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the job-schedule-interval object. All job-schedule-interval 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 |  | job-schedule-interval-info[] optional | The list of attributes of job-schedule-interval objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more job-schedule-interval objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

job-schedule-interval-modify | [top]

> Modify an existing interval job schedule entry.

> Input Name | Range | Type | Description
> job-schedule-interval-days | [0..2^32-1] | integer optional | The number of days between jobs.
> job-schedule-interval-hours | [0..2^32-1] | integer optional | The number of hours between jobs.
> job-schedule-interval-minutes | [0..2^32-1] | integer optional | The number of minutes between jobs.
> job-schedule-interval-seconds | [0..2^32-1] | integer optional | The number of seconds between jobs.
> job-schedule-name |  | string | The name of the job schedule.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

job-soft-pause-iter | [top]

> Soft pause a collection of jobs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple job objects match a given query. If set to true, the API will continue with the next matching job even when the operation fails for the job. 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 operations before the server gives up and returns. If set, the API will continue with the next matching job even when the operation on a previous matching job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of job objects to be operated in this call. Default: 20
> query |  | job-info | If operating on a specific job, this input element must specify all keys. If operating on job 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 job objects (just keys) that were not operated on due to some error. If set to false, the list of job objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of job objects (just keys) that were successfully operated on. If set to false, the list of job objects operated on 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 |  | job-soft-pause-iter-info[] optional | Information about job objects that were not operated on 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 job objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of job objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of job objects that matched the query and were successfully processed.
> success-list |  | job-soft-pause-iter-info[] optional | The job objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

job-stop-iter | [top]

> Stop a collection of jobs.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple job objects match a given query. If set to true, the API will continue with the next matching job even when the operation fails for the job. 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 operations before the server gives up and returns. If set, the API will continue with the next matching job even when the operation on a previous matching job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of job objects to be operated in this call. Default: 20
> query |  | job-info | If operating on a specific job, this input element must specify all keys. If operating on job 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 job objects (just keys) that were not operated on due to some error. If set to false, the list of job objects not operated on will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of job objects (just keys) that were successfully operated on. If set to false, the list of job objects operated on 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 |  | job-stop-iter-info[] optional | Information about job objects that were not operated on 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 job objects to be operated on.
> num-failed | [0..2^32-1] | integer optional | The number of job objects that matched the query, but were not operated on due some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of job objects that matched the query and were successfully processed.
> success-list |  | job-stop-iter-info[] optional | The job objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.

> Errno | Description
> EINTERNALERROR |  |

Element definition: cron-day-of-month | [top]

> Job Manager cron scheduling day of month. -1 represents all days of a month from 1 to 31, and only supported for cron schedule create and modify. Range : [-1..31].

> [none]

Element definition: cron-day-of-week | [top]

> Job Manager cron scheduling day of week. Zero represents Sunday. -1 represents all days of a week and only supported for cron schedule create and modify. Range : [-1..6].

> [none]

Element definition: cron-hour | [top]

> Job Manager cron scheduling hour. -1 represents all hours and only supported for cron schedule create and modify. Range : [-1..23].

> [none]

Element definition: cron-minute | [top]

> Job Manager cron scheduling minute. -1 represents all minutes and only supported for cron schedule create and modify. Range : [-1..59].

> [none]

Element definition: cron-month | [top]

> Job Manager cron scheduling month. -1 represents all months and only supported for cron schedule create and modify. Range : [-1..11].

> [none]

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

> Job history log event 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
> job-completion |  | string optional | Human-readable job completion message. Attributes: non-creatable, non-modifiable
> job-description |  | string optional | Job description. Attributes: non-creatable, non-modifiable
> job-end-time | [0..2^31-1] | integer optional | When the job last completed. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-event-time | [0..2^31-1] | integer optional | The time when this event was logged. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-event-type |  | job-event-type optional | The type of this history event. Attributes: non-creatable, non-modifiable Possible values: "idle" - The job has become idle, "running" - The job has started running, "succeeded" - The job has completed successfully, "failed" - The job has completed with a failure, "paused" - The job has been paused, "stopped" - The job has been stopped, "deleted" - The job has been deleted, "error" - Job Manager experienced an error while processing the job
> job-id | [0..2^64-1] | integer optional | The identifier associated with this job by the Job Manager. This identifier is unique within a cluster. The 'job-history-get-iter' API can return multiple records for a given job identifier because it logs the state transitions that the job has been through. Records in the 'job-history-get-iter' API are returned in reverse chronological order. Attributes: non-creatable, non-modifiable
> job-manager-error-code | [0..2^64-1] | integer optional | The error code, if any, that the Job Manager associated with this event. If set, 'job-error-text' will contain human-readable information about the error. Attributes: non-creatable, non-modifiable
> job-manager-error-text |  | string optional | The human-readable text for the error code, if any, that the Job Manager associated with this event. Attributes: non-creatable, non-modifiable
> job-name |  | string optional | Name of the job. Attributes: non-creatable, non-modifiable
> job-node |  | node-name optional | The name of the node where the job ran, or the node that changed the job's state. Attributes: key, non-creatable, non-modifiable
> job-progress |  | string optional | Human-readable job progress message. Attributes: non-creatable, non-modifiable
> job-start-time | [0..2^31-1] | integer optional | When the job last started. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-status-code | [0..2^64-1] | integer optional | Status code. Value other than 0 indicates an error in the job execution, in which case 'job-completion' will contain human-readable information about the error. Attributes: non-creatable, non-modifiable
> job-username |  | string optional | The name of the user that created the job. Attributes: non-creatable, non-modifiable
> job-uuid |  | uuid optional | Job's universally unique identifier (UUID). Attributes: non-creatable, non-modifiable
> job-vserver |  | job-history-vserver-name optional | Vserver from which the job was created. Attributes: key, non-creatable, non-modifiable
> log-id | [0..2^64-1] | integer optional | The internal identifier of this job history event. Attributes: key, non-creatable, non-modifiable

Element definition: job-info | [top]

> Contains information about a specific job. 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
> is-restarted |  | boolean optional | Whether the job has been re-started. Attributes: non-creatable, non-modifiable
> job-affinity |  | job-affinity optional | Job affinity indicates whether this job is tied to a specific node or not. Attributes: non-creatable, non-modifiable Possible values: "cluster" - Cluster Affinity, "node" - Node Affinity
> job-category |  | string optional | Job category. For example, 'Aggregate', 'VOPL'. Attributes: non-creatable, non-modifiable
> job-completion |  | string optional | Human-readable job completion text. Attributes: non-creatable, non-modifiable
> job-description |  | string optional | Job description. Attributes: non-creatable, non-modifiable
> job-dropdead-time | [0..2^31-1] | integer optional | Discard the job if not started by this time. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-end-time | [0..2^31-1] | integer optional | When the job finished running. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-id | [0..2^64-1] | integer optional | The job id. Attributes: key, non-creatable, non-modifiable
> job-name |  | string optional | Name of the job. Attributes: non-creatable, non-modifiable
> job-node |  | filer-id optional | The id of the node where the job is run. Attributes: non-creatable, non-modifiable
> job-priority |  | job-priority optional | Job priority. Attributes: non-creatable, non-modifiable Possible values: "low" , "medium" , "high" , "exclusive"
> job-process |  | string optional | The name of the process responsible for running the job. Attributes: non-creatable, non-modifiable
> job-progress |  | string optional | Information about the progress of this job. Attributes: non-creatable, non-modifiable
> job-queue-time | [0..2^31-1] | integer optional | When the job was queued. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-schedule |  | string optional | The name of the job schedule. Attributes: non-creatable, non-modifiable
> job-start-time | [0..2^31-1] | integer optional | When the job started running. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-state |  | job-state optional | Job state. See the category discussion section for a detailed description of job states. Attributes: non-creatable, non-modifiable Possible values: "initial" - Initializing, "queued" - Queued, "running" - Running, "waiting" - Waiting For Another Job, "pausing" - Entering Paused State, "paused" - Paused, "quitting" - Entering Quit State, "success" - Succeeded, "failure" - Failed, "reschedule" - Forcing Reschedule, "error" - Internal Error, "quit" - Quit, "dead" - Died, "unknown" - Unknown, "restart" - Forcing Restart, "dormant" - Waiting For External Event
> job-status-code | [0..2^64-1] | integer optional | Status code. Value other than 0 indicates an error in the job execution, in which case 'job-completion' will contain human-readable information about the error. Attributes: non-creatable, non-modifiable
> job-type |  | string optional | Job type. For example, 'AggrCreate', 'VOL_CREATE'. Attributes: non-creatable, non-modifiable
> job-username |  | string optional | The name of the user that created the job. Attributes: non-creatable, non-modifiable
> job-uuid |  | uuid optional | Job's universally unique identifier (UUID). Attributes: non-creatable, non-modifiable
> job-vserver |  | vserver-name optional | Vserver from which the job was created. Attributes: key, non-creatable, non-modifiable

Element definition: job-pause-iter-info | [top]

> Information about the operation that was attempted/performed against job object.

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

Element definition: job-private-pause-iter-info | [top]

> Information about the operation that was attempted/performed against private job object.

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

Element definition: job-private-resume-iter-info | [top]

> Information about the operation that was attempted/performed against private job object.

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

Element definition: job-private-soft-pause-iter-info | [top]

> Information about the operation that was attempted/performed against private job object.

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

Element definition: job-private-stop-iter-info | [top]

> Information about the operation that was attempted/performed against private job object.

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

Element definition: job-resume-iter-info | [top]

> Information about the operation that was attempted/performed against job object.

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

Element definition: job-schedule-cron-destroy-iter-info | [top]

> Information about the deletion operation that was attempted/performed against job-schedule-cron 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.
> job-schedule-cron-key |  | job-schedule-cron-info | The keys for the job-schedule-cron object to which the deletion applies.

Element definition: job-schedule-cron-info | [top]

> Contains detail information about cron job schedules. 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
> job-schedule-cron-day |  | cron-day-of-month[] optional | The day(s) of the month when the job should be run. Attributes: optional-for-create, modifiable
> job-schedule-cron-day-of-week |  | cron-day-of-week[] optional | The day(s) in the week when the job should be run. Attributes: optional-for-create, modifiable
> job-schedule-cron-hour |  | cron-hour[] optional | The hour(s) of the day when the job should be run. Attributes: optional-for-create, modifiable
> job-schedule-cron-minute |  | cron-minute[] optional | The minute(s) of each hour when the job should be run. Attributes: required-for-create, modifiable
> job-schedule-cron-month |  | cron-month[] optional | The month(s) when the job should be run. Attributes: optional-for-create, modifiable
> job-schedule-description |  | string optional | The description of the job schedule. Attributes: non-creatable, non-modifiable
> job-schedule-name |  | string optional | The name of the job schedule. Attributes: key, required-for-create, non-modifiable

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

> Contains overview information about a single job schedule. 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
> job-schedule-description |  | string optional | The description of the job schedule. Attributes: non-creatable, non-modifiable
> job-schedule-name |  | string optional | The name of the job schedule. Attributes: key, required-for-create, non-modifiable
> job-schedule-type |  | schedule-type optional | The type of job schedule. Attributes: non-creatable, non-modifiable Possible values: "cron" , "interval" , "builtin" , "unknown"

Element definition: job-schedule-interval-destroy-iter-info | [top]

> Information about the deletion operation that was attempted/performed against job-schedule-interval 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.
> job-schedule-interval-key |  | job-schedule-interval-info | The keys for the job-schedule-interval object to which the deletion applies.

Element definition: job-schedule-interval-info | [top]

> Contains detail information about interval job schedules. 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
> job-schedule-description |  | string optional | The description of the job schedule. Attributes: non-creatable, non-modifiable
> job-schedule-interval-days | [0..2^32-1] | integer optional | The number of days between jobs. Attributes: optional-for-create, modifiable
> job-schedule-interval-hours | [0..2^32-1] | integer optional | The number of hours between jobs. Attributes: optional-for-create, modifiable
> job-schedule-interval-minutes | [0..2^32-1] | integer optional | The number of minutes between jobs. Attributes: optional-for-create, modifiable
> job-schedule-interval-seconds | [0..2^32-1] | integer optional | The number of seconds between jobs. Attributes: optional-for-create, modifiable
> job-schedule-name |  | string optional | The name of the job schedule. Attributes: key, required-for-create, non-modifiable

Element definition: job-soft-pause-iter-info | [top]

> Information about the operation that was attempted/performed against job object.

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

Element definition: job-stop-iter-info | [top]

> Information about the operation that was attempted/performed against job object.

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

Element definition: cron-day-of-month | [top]

> Job Manager cron scheduling day of month. -1 represents all days of a month from 1 to 31, and only supported for cron schedule create and modify. Range : [-1..31].

> [none]

Element definition: cron-day-of-week | [top]

> Job Manager cron scheduling day of week. Zero represents Sunday. -1 represents all days of a week and only supported for cron schedule create and modify. Range : [-1..6].

> [none]

Element definition: cron-hour | [top]

> Job Manager cron scheduling hour. -1 represents all hours and only supported for cron schedule create and modify. Range : [-1..23].

> [none]

Element definition: cron-minute | [top]

> Job Manager cron scheduling minute. -1 represents all minutes and only supported for cron schedule create and modify. Range : [-1..59].

> [none]

Element definition: cron-month | [top]

> Job Manager cron scheduling month. -1 represents all months and only supported for cron schedule create and modify. Range : [-1..11].

> [none]

Element definition: filer-id | [top]

> Filer UUID

> [none]

Element definition: job-affinity | [top]

> All jobs are scheduled with direction as to where they should execute. This affinity may either be node-specific or apply to all nodes (cluster). The affinity of the job is specific to the type of operations the job performs and is not user configurable. Possible values: "cluster" - Cluster Affinity, "node" - Node Affinity

> [none]

Element definition: job-event-type | [top]

> Jobs will trigger history events at certain stages of their life cycle. These events are of the types described herein. Possible values: "idle" - The job has become idle, "running" - The job has started running, "succeeded" - The job has completed successfully, "failed" - The job has completed with a failure, "paused" - The job has been paused, "stopped" - The job has been stopped, "deleted" - The job has been deleted, "error" - Job Manager experienced an error while processing the job

> [none]

Element definition: job-history-vserver-name | [top]

> The name of the Vserver.

> [none]

Element definition: job-info | [top]

> Contains information about a specific job. 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
> is-restarted |  | boolean optional | Whether the job has been re-started. Attributes: non-creatable, non-modifiable
> job-affinity |  | job-affinity optional | Job affinity indicates whether this job is tied to a specific node or not. Attributes: non-creatable, non-modifiable Possible values: "cluster" - Cluster Affinity, "node" - Node Affinity
> job-category |  | string optional | Job category. For example, 'Aggregate', 'VOPL'. Attributes: non-creatable, non-modifiable
> job-completion |  | string optional | Human-readable job completion text. Attributes: non-creatable, non-modifiable
> job-description |  | string optional | Job description. Attributes: non-creatable, non-modifiable
> job-dropdead-time | [0..2^31-1] | integer optional | Discard the job if not started by this time. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-end-time | [0..2^31-1] | integer optional | When the job finished running. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-id | [0..2^64-1] | integer optional | The job id. Attributes: key, non-creatable, non-modifiable
> job-name |  | string optional | Name of the job. Attributes: non-creatable, non-modifiable
> job-node |  | filer-id optional | The id of the node where the job is run. Attributes: non-creatable, non-modifiable
> job-priority |  | job-priority optional | Job priority. Attributes: non-creatable, non-modifiable Possible values: "low" , "medium" , "high" , "exclusive"
> job-process |  | string optional | The name of the process responsible for running the job. Attributes: non-creatable, non-modifiable
> job-progress |  | string optional | Information about the progress of this job. Attributes: non-creatable, non-modifiable
> job-queue-time | [0..2^31-1] | integer optional | When the job was queued. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-schedule |  | string optional | The name of the job schedule. Attributes: non-creatable, non-modifiable
> job-start-time | [0..2^31-1] | integer optional | When the job started running. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
> job-state |  | job-state optional | Job state. See the category discussion section for a detailed description of job states. Attributes: non-creatable, non-modifiable Possible values: "initial" - Initializing, "queued" - Queued, "running" - Running, "waiting" - Waiting For Another Job, "pausing" - Entering Paused State, "paused" - Paused, "quitting" - Entering Quit State, "success" - Succeeded, "failure" - Failed, "reschedule" - Forcing Reschedule, "error" - Internal Error, "quit" - Quit, "dead" - Died, "unknown" - Unknown, "restart" - Forcing Restart, "dormant" - Waiting For External Event
> job-status-code | [0..2^64-1] | integer optional | Status code. Value other than 0 indicates an error in the job execution, in which case 'job-completion' will contain human-readable information about the error. Attributes: non-creatable, non-modifiable
> job-type |  | string optional | Job type. For example, 'AggrCreate', 'VOL_CREATE'. Attributes: non-creatable, non-modifiable
> job-username |  | string optional | The name of the user that created the job. Attributes: non-creatable, non-modifiable
> job-uuid |  | uuid optional | Job's universally unique identifier (UUID). Attributes: non-creatable, non-modifiable
> job-vserver |  | vserver-name optional | Vserver from which the job was created. Attributes: key, non-creatable, non-modifiable

Element definition: job-priority | [top]

> Execution priority of a job. There are thread pools for each priority level. Higher priority jobs may run in the pools of lower priorities. So High-priority jobs may run in the High, Medium or Low thread pools, Medium-priority jobs may run in the Medium or Low thread pools and Low-priority jobs may only run in the Low thread pool. The exception to this is Exclusive jobs: Exclusive-priority jobs will only run in the Exclusive thread pool and only Exclusive-priority jobs will be run in the Exclusive thread pool. Possible values: "low" , "medium" , "high" , "exclusive"

> [none]

Element definition: job-state | [top]

> Jobs execute as self-contained state machines. They follow a series of careful steps from creation to destruction. These steps are dictated by the states that they find themselves in as well as the allowable list of states they may transition into. The state can be an indicator of whether a job is executing and if not, why that is the case. Possible values: "initial" - Initializing, "queued" - Queued, "running" - Running, "waiting" - Waiting For Another Job, "pausing" - Entering Paused State, "paused" - Paused, "quitting" - Entering Quit State, "success" - Succeeded, "failure" - Failed, "reschedule" - Forcing Reschedule, "error" - Internal Error, "quit" - Quit, "dead" - Died, "unknown" - Unknown, "restart" - Forcing Restart, "dormant" - Waiting For External Event

> [none]

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: schedule-type | [top]

> Jobs may be scheduled according to one of three major styles: 'cron' is for jobs that should be run at a specific time or well-defined calendar date; 'interval' is for jobs that should be run on a regular period; 'builtin' is for jobs that should be run according to internal rules. Of these 'cron' and 'interval' may be customized. Possible values: "cron" , "interval" , "builtin" , "unknown"

> [none]

Element definition: uuid | [top]

> 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]

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]

Element definition: filer-id | [top]

> Filer UUID

> [none]

Element definition: job-affinity | [top]

> All jobs are scheduled with direction as to where they should execute. This affinity may either be node-specific or apply to all nodes (cluster). The affinity of the job is specific to the type of operations the job performs and is not user configurable. Possible values: "cluster" - Cluster Affinity, "node" - Node Affinity

> [none]