machineImagePublished_deploy.rst

machineImagePublished_deploy

.. function:: POST /users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/deploys

Summary

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

Deploy a new machine from an image published to a target environment.

Security Summary

• Requires Authentication: true
• Entitlements Required: deployments_access

URI Parameters

• uid (required): the user name (login name) of the :ref:`user-object`
• itid (required): the id of the :ref:`image-object`
• aid (required): the id of the :ref:`appliance-object`
• pitid (required): the id of the :ref:`publishimage-object`

HTTP Request Body Parameters

A :ref:`deployment-object` object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/deploys" -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:deployment xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <name>My Deployment</name>
        <instances>
                <instance>
                        <cores>1</cores>
                        <memory>1024</memory>
                </instance>
        </instances>
</ns0:deployment>

.. seealso::

         * :ref:`appliance-object`
         * :ref:`applianceImage-publish`
         * :ref:`deployment-object`
         * :ref:`machineImageGeneration-cancel`
         * :ref:`machineImagePublish-cancel`
         * :ref:`machineImagePublishedStatus-get`
         * :ref:`machineImagePublishedStatus-getAll`
         * :ref:`machineImagePublished-delete`
         * :ref:`machineImagePublished-deleteAll`
         * :ref:`machineImagePublished-deploy`
         * :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-regenerate`
         * :ref:`publishimage-object`