User documentation for yang module rw-image-mgmt.yang

module rw-image-mgmt                                                         1
  rw-image-mgmt data                                                       1.1
    container rw-image-mgmt:upload-jobs                                  1.1.1
      list rw-image-mgmt:job                                           1.1.1.1
        list rw-image-mgmt:upload-tasks                              1.1.1.1.1
  rw-image-mgmt rpc input                                                  1.2
    rpc input rw-image-mgmt:create-upload-job                            1.2.1
      container rw-image-mgmt:onboarded-image                          1.2.1.1
      container rw-image-mgmt:external-url                             1.2.1.2
      leaf-list rw-image-mgmt:cloud-account                            1.2.1.3
    rpc input rw-image-mgmt:cancel-upload-job                            1.2.2
  rw-image-mgmt rpc output                                                 1.3
    rpc output rw-image-mgmt:create-upload-job                           1.3.1
    rpc output rw-image-mgmt:cancel-upload-job                           1.3.2


1  module rw-image-mgmt

1.1  rw-image-mgmt data

1.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
  JSON Sample
    {
      "job": [
        {
          "id": 0,
          "status": "QUEUED",
          "start-time": 0,
          "stop-time": 0,
          "upload-tasks": [ { ... }, { ... } ]
        }, {
          ...
        }
      ]
    }
  XML Sample
    <rw-image-mgmt:upload-jobs xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:job>
        <rw-image-mgmt:id>0</rw-image-mgmt:id>
        <rw-image-mgmt:status>QUEUED</rw-image-mgmt:status>
        <rw-image-mgmt:start-time>0</rw-image-mgmt:start-time>
        <rw-image-mgmt:stop-time>0</rw-image-mgmt:stop-time>
        <rw-image-mgmt:upload-tasks>...</rw-image-mgmt:upload-tasks>
      </rw-image-mgmt:job>
    </rw-image-mgmt:upload-jobs>

1.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
  JSON Sample
    [
      {
        "id": 0,
        "status": "QUEUED",
        "start-time": 0,
        "stop-time": 0,
        "upload-tasks": [
          {
            "cloud-account": "STRING",
            "image-id": "STRING",
            "image-name": "STRING",
            "image-checksum": "STRING",
            "status": "QUEUED",
            "detail": "STRING",
            "progress-percent": 0,
            "bytes_written": 0,
            "bytes_total": 0,
            "bytes_per_second": 0,
            "start-time": 0,
            "stop-time": 0
          }, {
            ...
          }
        ]
      }, {
        ...
      }
    ]
  XML Sample
    <rw-image-mgmt:job xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:id>0</rw-image-mgmt:id>
      <rw-image-mgmt:status>QUEUED</rw-image-mgmt:status>
      <rw-image-mgmt:start-time>0</rw-image-mgmt:start-time>
      <rw-image-mgmt:stop-time>0</rw-image-mgmt:stop-time>
      <rw-image-mgmt:upload-tasks>
        <rw-image-mgmt:cloud-account>STRING</rw-image-mgmt:cloud-account>
        <rw-image-mgmt:image-id>STRING</rw-image-mgmt:image-id>
        <rw-image-mgmt:image-name>STRING</rw-image-mgmt:image-name>
        <rw-image-mgmt:image-checksum>STRING</rw-image-mgmt:image-checksum>
        <rw-image-mgmt:status>QUEUED</rw-image-mgmt:status>
        <rw-image-mgmt:detail>STRING</rw-image-mgmt:detail>
        <rw-image-mgmt:progress-percent>0</rw-image-mgmt:progress-percent>
        <rw-image-mgmt:bytes_written>0</rw-image-mgmt:bytes_written>
        <rw-image-mgmt:bytes_total>0</rw-image-mgmt:bytes_total>
        <rw-image-mgmt:bytes_per_second>0</rw-image-mgmt:bytes_per_second>
        <rw-image-mgmt:start-time>0</rw-image-mgmt:start-time>
        <rw-image-mgmt:stop-time>0</rw-image-mgmt:stop-time>
      </rw-image-mgmt:upload-tasks>
    </rw-image-mgmt:job>

1.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
  JSON Sample
    [
      {
        "cloud-account": "STRING",
        "image-id": "STRING",
        "image-name": "STRING",
        "image-checksum": "STRING",
        "status": "QUEUED",
        "detail": "STRING",
        "progress-percent": 0,
        "bytes_written": 0,
        "bytes_total": 0,
        "bytes_per_second": 0,
        "start-time": 0,
        "stop-time": 0
      }, {
        ...
      }
    ]
  XML Sample
    <rw-image-mgmt:upload-tasks xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:cloud-account>STRING</rw-image-mgmt:cloud-account>
      <rw-image-mgmt:image-id>STRING</rw-image-mgmt:image-id>
      <rw-image-mgmt:image-name>STRING</rw-image-mgmt:image-name>
      <rw-image-mgmt:image-checksum>STRING</rw-image-mgmt:image-checksum>
      <rw-image-mgmt:status>QUEUED</rw-image-mgmt:status>
      <rw-image-mgmt:detail>STRING</rw-image-mgmt:detail>
      <rw-image-mgmt:progress-percent>0</rw-image-mgmt:progress-percent>
      <rw-image-mgmt:bytes_written>0</rw-image-mgmt:bytes_written>
      <rw-image-mgmt:bytes_total>0</rw-image-mgmt:bytes_total>
      <rw-image-mgmt:bytes_per_second>0</rw-image-mgmt:bytes_per_second>
      <rw-image-mgmt:start-time>0</rw-image-mgmt:start-time>
      <rw-image-mgmt:stop-time>0</rw-image-mgmt:stop-time>
    </rw-image-mgmt:upload-tasks>

1.2  rw-image-mgmt rpc input

1.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
  JSON Sample
    {
      "onboarded-image": {
        "image-id": "STRING",
        "image-name": "STRING",
        "image-checksum": "STRING"
      },
      "external-url": {
        "image-url": "STRING",
        "image-id": "STRING",
        "image-name": "STRING",
        "image-checksum": "STRING",
        "disk-format": "ami",
        "container-format": "bare"
      },
      "cloud-account": [ "STRING", ... ]
    }
  XML Sample
    <rw-image-mgmt:input xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:onboarded-image>
        <rw-image-mgmt:image-id>STRING</rw-image-mgmt:image-id>
        <rw-image-mgmt:image-name>STRING</rw-image-mgmt:image-name>
        <rw-image-mgmt:image-checksum>STRING</rw-image-mgmt:image-checksum>
      </rw-image-mgmt:onboarded-image>
      <rw-image-mgmt:external-url>
        <rw-image-mgmt:image-url>STRING</rw-image-mgmt:image-url>
        <rw-image-mgmt:image-id>STRING</rw-image-mgmt:image-id>
        <rw-image-mgmt:image-name>STRING</rw-image-mgmt:image-name>
        <rw-image-mgmt:image-checksum>STRING</rw-image-mgmt:image-checksum>
        <rw-image-mgmt:disk-format>ami</rw-image-mgmt:disk-format>
        <rw-image-mgmt:container-format>bare</rw-image-mgmt:container-format>
      </rw-image-mgmt:external-url>
      <rw-image-mgmt:cloud-account>STRING</rw-image-mgmt:cloud-account>
      <rw-image-mgmt:cloud-account>...</rw-image-mgmt:cloud-account>
    </rw-image-mgmt:input>

1.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
  JSON Config Sample
    {
      "image-id": "STRING",
      "image-name": "STRING",
      "image-checksum": "STRING"
    }
  JSON Sample
    {
      "image-id": "STRING",
      "image-name": "STRING",
      "image-checksum": "STRING"
    }
  XML Config Sample
    <rw-image-mgmt:onboarded-image xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:image-id>STRING</rw-image-mgmt:image-id>
      <rw-image-mgmt:image-name>STRING</rw-image-mgmt:image-name>
      <rw-image-mgmt:image-checksum>STRING</rw-image-mgmt:image-checksum>
    </rw-image-mgmt:onboarded-image>
  XML Sample
    <rw-image-mgmt:onboarded-image xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:image-id>STRING</rw-image-mgmt:image-id>
      <rw-image-mgmt:image-name>STRING</rw-image-mgmt:image-name>
      <rw-image-mgmt:image-checksum>STRING</rw-image-mgmt:image-checksum>
    </rw-image-mgmt:onboarded-image>

1.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
  JSON Config Sample
    {
      "image-url": "STRING",
      "image-id": "STRING",
      "image-name": "STRING",
      "image-checksum": "STRING",
      "disk-format": "ami",
      "container-format": "bare"
    }
  JSON Sample
    {
      "image-url": "STRING",
      "image-id": "STRING",
      "image-name": "STRING",
      "image-checksum": "STRING",
      "disk-format": "ami",
      "container-format": "bare"
    }
  XML Config Sample
    <rw-image-mgmt:external-url xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:image-url>STRING</rw-image-mgmt:image-url>
      <rw-image-mgmt:image-id>STRING</rw-image-mgmt:image-id>
      <rw-image-mgmt:image-name>STRING</rw-image-mgmt:image-name>
      <rw-image-mgmt:image-checksum>STRING</rw-image-mgmt:image-checksum>
      <rw-image-mgmt:disk-format>ami</rw-image-mgmt:disk-format>
      <rw-image-mgmt:container-format>bare</rw-image-mgmt:container-format>
    </rw-image-mgmt:external-url>
  XML Sample
    <rw-image-mgmt:external-url xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:image-url>STRING</rw-image-mgmt:image-url>
      <rw-image-mgmt:image-id>STRING</rw-image-mgmt:image-id>
      <rw-image-mgmt:image-name>STRING</rw-image-mgmt:image-name>
      <rw-image-mgmt:image-checksum>STRING</rw-image-mgmt:image-checksum>
      <rw-image-mgmt:disk-format>ami</rw-image-mgmt:disk-format>
      <rw-image-mgmt:container-format>bare</rw-image-mgmt:container-format>
    </rw-image-mgmt:external-url>

1.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
  JSON Config Sample
    [ "STRING", ... ]
  JSON Sample
    [ "STRING", ... ]
  XML Config Sample
    <rw-image-mgmt:cloud-account xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">STRING</rw-image-mgmt:cloud-account>
    <rw-image-mgmt:cloud-account xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">...</rw-image-mgmt:cloud-account>
  XML Sample
    <rw-image-mgmt:cloud-account xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">STRING</rw-image-mgmt:cloud-account>
    <rw-image-mgmt:cloud-account xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">...</rw-image-mgmt:cloud-account>

1.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
  JSON Sample
    {
      "job-id": 0
    }
  XML Sample
    <rw-image-mgmt:input xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:job-id>0</rw-image-mgmt:job-id>
    </rw-image-mgmt:input>

1.3  rw-image-mgmt rpc output

1.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
  JSON Sample
    {
      "job-id": 0
    }
  XML Sample
    <rw-image-mgmt:output xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt">
      <rw-image-mgmt:job-id>0</rw-image-mgmt:job-id>
    </rw-image-mgmt:output>

1.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
  JSON Sample
    {
    }
  XML Sample
    <rw-image-mgmt:output xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt"/>

