rw-image-mgmt - Programmers API Reference
Schema Globals
| Global Schema Type | rw_ypbc_RwImageMgmt_RwImageMgmt_t_schema |
| Global Schema Pointer | rw_ypbc_RwImageMgmt_RwImageMgmt_g_schema |
rw-image-mgmt data
rw-image-mgmt:upload-jobs
Image upload jobs
Key Identifiers:| XPath Path | /rw-image-mgmt:upload-jobs |
| XPath Keyed Path | /rw-image-mgmt:upload-jobs |
| RW.REST URI Path | /rw-image-mgmt:upload-jobs |
| RW Keyspec XPath Path | D,/rw-image-mgmt:upload-jobs |
| RW Keyspec XPath Keyed Path | D,/rw-image-mgmt:upload-jobs |
| Protobuf Type | .rw_image_mgmt.YangData.RwImageMgmt.UploadJobs |
| Python Proto-GI Type | RwImageMgmtYang.UploadJobs |
| C Protobuf-C Struct Type | RwImageMgmt__YangData__RwImageMgmt__UploadJobs |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_data_UploadJobs RwImageMgmt_data_UploadJobs RwImageMgmt_UploadJobs |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_data_UploadJobs |
Fields
| Name | Type | Description |
|---|---|---|
| job | LIST |
rw-image-mgmt:job
Key Identifiers:| XPath Path | /rw-image-mgmt:upload-jobs/rw-image-mgmt:job |
| XPath Keyed Path | /rw-image-mgmt:upload-jobs/rw-image-mgmt:job[rw-image-mgmt:id='0'] |
| RW.REST URI Path | /rw-image-mgmt:upload-jobs/job/0 |
| RW Keyspec XPath Path | D,/rw-image-mgmt:upload-jobs/rw-image-mgmt:job |
| RW Keyspec XPath Keyed Path | D,/rw-image-mgmt:upload-jobs/rw-image-mgmt:job[rw-image-mgmt:id='0'] |
| Protobuf Type | .rw_image_mgmt.YangData.RwImageMgmt.UploadJobs.Job |
| Python Proto-GI Type | RwImageMgmtYang.UploadJob |
| C Protobuf-C Struct Type | RwImageMgmt__YangData__RwImageMgmt__UploadJobs__Job |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_data_UploadJobs_Job RwImageMgmt_data_UploadJobs_Job RwImageMgmt_UploadJob |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_data_UploadJobs_Job |
Fields
| Name | Type | Description |
|---|---|---|
| id | UINT32 | Unique image upload job-id |
| status | ENUM | Current job status |
| start-time | UINT32 | The job start time (unix epoch) |
| stop-time | UINT32 | The job stop time (unix epoch) |
| upload-tasks | LIST | The upload tasks that are part of this job |
rw-image-mgmt:upload-tasks
The upload tasks that are part of this job
Key Identifiers:| XPath Path | /rw-image-mgmt:upload-jobs/rw-image-mgmt:job/rw-image-mgmt:upload-tasks |
| XPath Keyed Path | /rw-image-mgmt:upload-jobs/rw-image-mgmt:job[rw-image-mgmt:id='0']/rw-image-mgmt:upload-tasks |
| RW.REST URI Path | /rw-image-mgmt:upload-jobs/job/0/upload-tasks |
| RW Keyspec XPath Path | D,/rw-image-mgmt:upload-jobs/rw-image-mgmt:job/rw-image-mgmt:upload-tasks |
| RW Keyspec XPath Keyed Path | D,/rw-image-mgmt:upload-jobs/rw-image-mgmt:job[rw-image-mgmt:id='0']/rw-image-mgmt:upload-tasks |
| Protobuf Type | .rw_image_mgmt.YangData.RwImageMgmt.UploadJobs.Job.UploadTasks |
| Python Proto-GI Type | RwImageMgmtYang.UploadTask |
| C Protobuf-C Struct Type | RwImageMgmt__YangData__RwImageMgmt__UploadJobs__Job__UploadTasks |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_data_UploadJobs_Job_UploadTasks RwImageMgmt_data_UploadJobs_Job_UploadTasks RwImageMgmt_UploadTask |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_data_UploadJobs_Job_UploadTasks |
Fields
| Name | Type | Description |
|---|---|---|
| cloud-account | LEAFREF | The cloud account to upload the image to |
| image-id | STRING | The image id that exists in the image catalog |
| image-name | STRING | The image name that exists in the image catalog |
| image-checksum | STRING | The image md5 checksum |
| status | ENUM | The status of the upload task |
| detail | STRING | Detailed upload status message |
| progress-percent | UINT8 | The image upload progress percentage (0-100) |
| bytes_written | UINT64 | The number of bytes written |
| bytes_total | UINT64 | The total number of bytes to write |
| bytes_per_second | UINT32 | The total number of bytes written per second |
| start-time | UINT32 | The image upload start time (unix epoch) |
| stop-time | UINT32 | The image upload stop time (unix epoch) |
rw-image-mgmt rpc input
rw-image-mgmt:create-upload-job
Key Identifiers:| XPath Path | /rw-image-mgmt:create-upload-job |
| XPath Keyed Path | /rw-image-mgmt:create-upload-job |
| RW.REST URI Path | /input |
| RW Keyspec XPath Path | I,/rw-image-mgmt:create-upload-job |
| RW Keyspec XPath Keyed Path | I,/rw-image-mgmt:create-upload-job |
| Protobuf Type | .rw_image_mgmt.YangInput.RwImageMgmt.CreateUploadJob |
| Python Proto-GI Type | RwImageMgmtYang.CreateUploadJob |
| C Protobuf-C Struct Type | RwImageMgmt__YangInput__RwImageMgmt__CreateUploadJob |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_input_CreateUploadJob RwImageMgmt_input_CreateUploadJob RwImageMgmt_CreateUploadJob |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_input_CreateUploadJob |
Fields
| Name | Type | Description |
|---|---|---|
| onboarded-image | CONTAINER | |
| external-url | CONTAINER | |
| cloud-account | LEAF_LIST | List of cloud accounts to upload the image to |
rw-image-mgmt:onboarded-image
Key Identifiers:| XPath Path | /rw-image-mgmt:create-upload-job/rw-image-mgmt:onboarded-image |
| XPath Keyed Path | /rw-image-mgmt:create-upload-job/rw-image-mgmt:onboarded-image |
| RW.REST URI Path | /input/onboarded-image |
| RW Keyspec XPath Path | I,/rw-image-mgmt:create-upload-job/rw-image-mgmt:onboarded-image |
| RW Keyspec XPath Keyed Path | I,/rw-image-mgmt:create-upload-job/rw-image-mgmt:onboarded-image |
| Protobuf Type | .rw_image_mgmt.YangInput.RwImageMgmt.CreateUploadJob.OnboardedImage |
| Python Proto-GI Type | RwImageMgmtYang.CreateUploadJob_OnboardedImage |
| C Protobuf-C Struct Type | RwImageMgmt__YangInput__RwImageMgmt__CreateUploadJob__OnboardedImage |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_input_CreateUploadJob_OnboardedImage RwImageMgmt_input_CreateUploadJob_OnboardedImage RwImageMgmt_CreateUploadJob_OnboardedImage |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_input_CreateUploadJob_OnboardedImage |
Fields
| Name | Type | Description |
|---|---|---|
| image-id | STRING | The image id that exists in the image catalog |
| image-name | STRING | The image name that exists in the image catalog |
| image-checksum | STRING | The image md5 checksum |
rw-image-mgmt:external-url
Key Identifiers:| XPath Path | /rw-image-mgmt:create-upload-job/rw-image-mgmt:external-url |
| XPath Keyed Path | /rw-image-mgmt:create-upload-job/rw-image-mgmt:external-url |
| RW.REST URI Path | /input/external-url |
| RW Keyspec XPath Path | I,/rw-image-mgmt:create-upload-job/rw-image-mgmt:external-url |
| RW Keyspec XPath Keyed Path | I,/rw-image-mgmt:create-upload-job/rw-image-mgmt:external-url |
| Protobuf Type | .rw_image_mgmt.YangInput.RwImageMgmt.CreateUploadJob.ExternalUrl |
| Python Proto-GI Type | RwImageMgmtYang.CreateUploadJob_ExternalUrl |
| C Protobuf-C Struct Type | RwImageMgmt__YangInput__RwImageMgmt__CreateUploadJob__ExternalUrl |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_input_CreateUploadJob_ExternalUrl RwImageMgmt_input_CreateUploadJob_ExternalUrl RwImageMgmt_CreateUploadJob_ExternalUrl |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_input_CreateUploadJob_ExternalUrl |
Fields
| Name | Type | Description |
|---|---|---|
| image-url | STRING | The image HTTP URL to pull the image from |
| image-id | STRING | The image id that exists in the image catalog |
| image-name | STRING | The image name that exists in the image catalog |
| image-checksum | STRING | The image md5 checksum |
| disk-format | ENUM | Format of the Disk |
| container-format | ENUM | Format of the container |
rw-image-mgmt:cloud-account
List of cloud accounts to upload the image to
Key Identifiers:| XPath Path | /rw-image-mgmt:create-upload-job/rw-image-mgmt:cloud-account |
| XPath Keyed Path | /rw-image-mgmt:create-upload-job/rw-image-mgmt:cloud-account |
| RW.REST URI Path | /input/cloud-account |
| RW Keyspec XPath Path | I,/rw-image-mgmt:create-upload-job/rw-image-mgmt:cloud-account |
| RW Keyspec XPath Keyed Path | I,/rw-image-mgmt:create-upload-job/rw-image-mgmt:cloud-account |
| Protobuf Type | .rw_image_mgmt.YangInput.RwImageMgmt.CreateUploadJob.CloudAccount |
| Python Proto-GI Type | RwImageMgmtYang.CreateUploadJob_CloudAccount |
| C Protobuf-C Struct Type | RwImageMgmt__YangInput__RwImageMgmt__CreateUploadJob__CloudAccount |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_input_CreateUploadJob_CloudAccount RwImageMgmt_input_CreateUploadJob_CloudAccount RwImageMgmt_CreateUploadJob_CloudAccount |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_input_CreateUploadJob_CloudAccount |
rw-image-mgmt:cancel-upload-job
Key Identifiers:| XPath Path | /rw-image-mgmt:cancel-upload-job |
| XPath Keyed Path | /rw-image-mgmt:cancel-upload-job |
| RW.REST URI Path | /input |
| RW Keyspec XPath Path | I,/rw-image-mgmt:cancel-upload-job |
| RW Keyspec XPath Keyed Path | I,/rw-image-mgmt:cancel-upload-job |
| Protobuf Type | .rw_image_mgmt.YangInput.RwImageMgmt.CancelUploadJob |
| Python Proto-GI Type | RwImageMgmtYang.CancelUploadJob |
| C Protobuf-C Struct Type | RwImageMgmt__YangInput__RwImageMgmt__CancelUploadJob |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_input_CancelUploadJob RwImageMgmt_input_CancelUploadJob RwImageMgmt_CancelUploadJob |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_input_CancelUploadJob |
Fields
| Name | Type | Description |
|---|---|---|
| job-id | UINT32 |
rw-image-mgmt rpc output
rw-image-mgmt:create-upload-job
Key Identifiers:| XPath Path | /rw-image-mgmt:create-upload-job |
| XPath Keyed Path | /rw-image-mgmt:create-upload-job |
| RW.REST URI Path | /output |
| RW Keyspec XPath Path | O,/rw-image-mgmt:create-upload-job |
| RW Keyspec XPath Keyed Path | O,/rw-image-mgmt:create-upload-job |
| Protobuf Type | .rw_image_mgmt.YangOutput.RwImageMgmt.CreateUploadJob |
| Python Proto-GI Type | RwImageMgmtYang.CreateUploadJobOutput |
| C Protobuf-C Struct Type | RwImageMgmt__YangOutput__RwImageMgmt__CreateUploadJob |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_output_CreateUploadJob RwImageMgmt_output_CreateUploadJob RwImageMgmt_CreateUploadJobOutput |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_output_CreateUploadJob |
Fields
| Name | Type | Description |
|---|---|---|
| job-id | UINT32 | The upload job-id to cancel |
rw-image-mgmt:cancel-upload-job
Key Identifiers:| XPath Path | /rw-image-mgmt:cancel-upload-job |
| XPath Keyed Path | /rw-image-mgmt:cancel-upload-job |
| RW.REST URI Path | /output |
| RW Keyspec XPath Path | O,/rw-image-mgmt:cancel-upload-job |
| RW Keyspec XPath Keyed Path | O,/rw-image-mgmt:cancel-upload-job |
| Protobuf Type | .rw_image_mgmt.YangOutput.RwImageMgmt.CancelUploadJob |
| Python Proto-GI Type | RwImageMgmtYang.YangOutput_RwImageMgmt_CancelUploadJob |
| C Protobuf-C Struct Type | RwImageMgmt__YangOutput__RwImageMgmt__CancelUploadJob |
| C RWPB Identifiers | RwImageMgmt_RwImageMgmt_output_CancelUploadJob RwImageMgmt_output_CancelUploadJob |
| YPBC Base Identifier | rw_ypbc_RwImageMgmt_RwImageMgmt_output_CancelUploadJob |