Skip to content

Latest commit

 

History

History
98 lines (75 loc) · 2.9 KB

machineImage_publish.rst

File metadata and controls

98 lines (75 loc) · 2.9 KB
Raw

machineImage_publish

.. function:: POST /users/{uid}/appliances/{aid}/pimages

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 2.0

Request to publish (register) a generated machine image to a target cloud environment.

The response body is a publish image ticket that provides the meta-data of the published machine image. The actual publication is done asynchronously. To poll the status of this publication, use :ref:`machineImagePublishedStatus-getAll`.

This request is similar to :ref:`applianceImage-publish`

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_publish

URI Parameters

HTTP Request Body Parameters

A :ref:`publishImage-object` object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/pimages" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:publishImage xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <applianceUri>users/root/appliances/4</applianceUri>
        <credAccount>
                <xsi:type></xsi:type>
                <targetPlatform>
                        <name>openstack</name>
                </targetPlatform>
                <glanceUrl>http://ip:9292</glanceUrl>
                <keystoneUrl>http://ip:5000</keystoneUrl>
                <login>username</login>
                <password>password</password>
                <keystoneVersion>v2.0</keystoneVersion>
        </credAccount>
        <imageUri>users/root/appliances/4/images/7</imageUri>
        <instances></instances>
        <displayName>Machine Image Name Example</displayName>
        <publicImage>false</publicImage>
        <tenantName>mytenantname</tenantName>
</ns0:publishImage>
.. seealso::

         * :ref:`appliance-object`
         * :ref:`machineImageGeneration-cancel`
         * :ref:`machineImagePublish-cancel`
         * :ref:`machineImagePublishedStatus-get`
         * :ref:`machineImagePublishedStatus-getAll`
         * :ref:`machineImagePublished-delete`
         * :ref:`machineImagePublished-deleteAll`
         * :ref:`machineImagePublished-download`
         * :ref:`machineImagePublished-get`
         * :ref:`machineImagePublished-getAll`
         * :ref:`machineImageStatus-get`
         * :ref:`machineImageStatus-getAll`
         * :ref:`machineImage-delete`
         * :ref:`machineImage-deleteAll`
         * :ref:`machineImage-download`
         * :ref:`machineImage-downloadFile`
         * :ref:`machineImage-generate`
         * :ref:`machineImage-get`
         * :ref:`machineImage-getAll`
         * :ref:`machineImage-publish`
         * :ref:`machineImage-publish`
         * :ref:`machineImage-regenerate`
         * :ref:`publishimage-object`