lsm_job_status_ss_get(3) | Libstoragemgmt C API Manual | lsm_job_status_ss_get(3) |
NAME¶
lsm_job_status_ss_get - Check on the status of a job with lsm_fs_ss returned.
SYNOPSIS¶
int lsm_job_status_ss_get (lsm_connect *conn, const char *job, lsm_job_status *status, uint8_t *percent_complete, lsm_fs_ss **ss, lsm_flag flags);
ARGUMENTS¶
- conn
- Valid connection pointer
- job
- String. Job id to check
- status
- Output pointer of lsm_job_status. Possible values are: * LSM_JOB_COMPLETE
Job complete with no error. * LSM_JOB_ERROR
Job complete with error. * LSM_JOB_INPROGRESS
Job is still in progress. - percent_complete
- Output pointer of uint8_t. Percent job complete. Domain 0..100.
- ss
- Output pointer of lsm_fs_ss for completed operation. Returned value must be freed with a call to lsm_fs_ss_record_free.
- flags
- Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
VERSION¶
1.0
DESCRIPTION¶
Check on the status of a job and return the snapshot information when compete.
RETURN¶
Error code as enumerated by 'lsm_error_number'.
* LSM_ERR_OK
On success.
* LSM_ERR_INVALID_ARGUMENT
When any argument is NULL or not a valid lsm_connect pointer
or invalid flags.
* LSM_ERR_NOT_FOUND_JOB
When job not found.
lsm_job_status_ss_get | April 2023 |