rw-image-mgmt - User documentation

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

Fields

Name	Type	Description
job	LIST

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>

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

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

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>

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

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)

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>

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

Fields

Name	Type	Description
onboarded-image	CONTAINER
external-url	CONTAINER
cloud-account	LEAF_LIST	List of cloud accounts to upload the image to

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>

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

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

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>

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

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

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>

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

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>

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

Fields

Name	Type	Description
job-id	UINT32

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>

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

Fields

Name	Type	Description
job-id	UINT32	The upload job-id to cancel

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>

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

JSON Sample

{
}

XML Sample

<rw-image-mgmt:output xmlns:rw-image-mgmt="http://riftio.com/ns/riftware-1.0/rw-image-mgmt"/>