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..200]	integer optional	The maximum number of records to return in this call. Default: 100
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..200]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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..200]	integer optional	The maximum number of records to return in this call. Default: 100
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..200]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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..200]	integer optional	The maximum number of records to return in this call. Default: 100
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..200]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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..200]	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..200]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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..200]	integer optional	The maximum number of job objects to be operated in this call. Default: 100
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..200]	integer optional	The number of job objects that matched the query, but were not operated on due some error.
num-succeeded	[0..200]	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

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..200]	integer optional	The maximum number of records to return in this call. Default: 100
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..200]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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..200]	integer optional	The maximum number of records to return in this call. Default: 100
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..200]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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..200]	integer optional	The maximum number of private job objects to be operated in this call. Default: 100
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..200]	integer optional	The number of private job objects that matched the query, but were not operated on due some error.
num-succeeded	[0..200]	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

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..200]	integer optional	The maximum number of private job objects to be operated in this call. Default: 100
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..200]	integer optional	The number of private job objects that matched the query, but were not operated on due some error.
num-succeeded	[0..200]	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

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..200]	integer optional	The maximum number of private job objects to be operated in this call. Default: 100
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..200]	integer optional	The number of private job objects that matched the query, but were not operated on due some error.
num-succeeded	[0..200]	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

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..200]	integer optional	The maximum number of private job objects to be operated in this call. Default: 100
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..200]	integer optional	The number of private job objects that matched the query, but were not operated on due some error.
num-succeeded	[0..200]	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

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..200]	integer optional	The maximum number of job objects to be operated in this call. Default: 100
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..200]	integer optional	The number of job objects that matched the query, but were not operated on due some error.
num-succeeded	[0..200]	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

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

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

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..200]	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..200]	integer optional	Number of job-schedule-cron objects that matched the query, but were not deleted due to some error.
num-succeeded	[0..200]	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

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

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..200]	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..200]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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

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

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..100]	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..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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

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

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..200]	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..200]	integer optional	Number of job-schedule-interval objects that matched the query, but were not deleted due to some error.
num-succeeded	[0..200]	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

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

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..200]	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..200]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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

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..200]	integer optional	The maximum number of job objects to be operated in this call. Default: 100
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..200]	integer optional	The number of job objects that matched the query, but were not operated on due some error.
num-succeeded	[0..200]	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

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..200]	integer optional	The maximum number of job objects to be operated in this call. Default: 100
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..200]	integer optional	The number of job objects that matched the query, but were not operated on due some error.
num-succeeded	[0..200]	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

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]

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]

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

[none]

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

[none]

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

[none]

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 instance of this job by Job Manager. This is only unique within the context of a single process on a single node. 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		string 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

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

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.

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.

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.

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.

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.

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.

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.

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

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"

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.

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

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.

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.

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]

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]

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

[none]

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

[none]

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

[none]

Filer UUID

[none]

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]

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]

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

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]

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]

The node's name

[none]

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]

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

[none]

The name of the Vserver.

[none]

Filer UUID

[none]

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]