Programmer's API documentation for yang module rw-image-mgmt.yang



Schema Globals                                                               1

module rw-image-mgmt                                                         2
  rw-image-mgmt data                                                       2.1
    container rw-image-mgmt:upload-jobs                                  2.1.1
      list rw-image-mgmt:job                                           2.1.1.1
        list rw-image-mgmt:upload-tasks                              2.1.1.1.1
  rw-image-mgmt rpc input                                                  2.2
    rpc input rw-image-mgmt:create-upload-job                            2.2.1
      container rw-image-mgmt:onboarded-image                          2.2.1.1
      container rw-image-mgmt:external-url                             2.2.1.2
      leaf-list rw-image-mgmt:cloud-account                            2.2.1.3
    rpc input rw-image-mgmt:cancel-upload-job                            2.2.2
  rw-image-mgmt rpc output                                                 2.3
    rpc output rw-image-mgmt:create-upload-job                           2.3.1
    rpc output rw-image-mgmt:cancel-upload-job                           2.3.2


1  Schema Globals
  Global Schema Type
    rw_ypbc_RwImageMgmt_t_schema
  Global Schema Pointer
    rw_ypbc_RwImageMgmt_g_schema
2  module rw-image-mgmt

2.1  rw-image-mgmt data

2.1.1  container rw-image-mgmt:upload-jobs
  Description
    Image upload jobs
  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

2.1.1.1  list rw-image-mgmt:job
  Leaves
    name: id, type: UINT32, description: Unique image upload job-id
    name: status, type: ENUM, description: Current job status
    name: start-time, type: UINT32, description: The job start time (unix epoch)
    name: stop-time, type: UINT32, description: The job stop time (unix epoch)
  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

2.1.1.1.1  list rw-image-mgmt:upload-tasks
  Description
    The upload tasks that are part of this job
  Leaves
    name: cloud-account, type: LEAFREF, description: The cloud account to upload the image to
    name: image-id, type: STRING, description: The image id that exists in the image catalog
    name: image-name, type: STRING, description: The image name that exists in the image catalog
    name: image-checksum, type: STRING, description: The image md5 checksum
    name: status, type: ENUM, description: The status of the upload task
    name: detail, type: STRING, description: Detailed upload status message
    name: progress-percent, type: UINT8, description: The image upload progress percentage (0-100)
    name: bytes_written, type: UINT64, description: The number of bytes written
    name: bytes_total, type: UINT64, description: The total number of bytes to write
    name: bytes_per_second, type: UINT32, description: The total number of bytes written per second
    name: start-time, type: UINT32, description: The image upload start time (unix epoch)
    name: stop-time, type: UINT32, description: The image upload stop time (unix epoch)
  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

2.2  rw-image-mgmt rpc input

2.2.1  rpc input rw-image-mgmt:create-upload-job
  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

2.2.1.1  container rw-image-mgmt:onboarded-image
  Leaves
    name: image-id, type: STRING, description: The image id that exists in the image catalog
    name: image-name, type: STRING, description: The image name that exists in the image catalog
    name: image-checksum, type: STRING, description: The image md5 checksum
  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

2.2.1.2  container rw-image-mgmt:external-url
  Leaves
    name: image-url, type: STRING, description: The image HTTP URL to pull the image from
    name: image-id, type: STRING, description: The image id that exists in the image catalog
    name: image-name, type: STRING, description: The image name that exists in the image catalog
    name: image-checksum, type: STRING, description: The image md5 checksum
    name: disk-format, type: ENUM, description: Format of the Disk
    name: container-format, type: ENUM, description: Format of the container
  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

2.2.1.3  leaf-list rw-image-mgmt:cloud-account
  Description
    List of cloud accounts to upload the image to
  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

2.2.2  rpc input rw-image-mgmt:cancel-upload-job
  Leaves
    name: job-id, type: UINT32
  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

2.3  rw-image-mgmt rpc output

2.3.1  rpc output rw-image-mgmt:create-upload-job
  Leaves
    name: job-id, type: UINT32, description: The upload job-id to cancel
  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

2.3.2  rpc output rw-image-mgmt:cancel-upload-job
  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

