scanImage_getPlatformTools.rst

scanImage_getPlatformTools

.. function:: GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/platformtools/{tfid}

Summary

• Method: GET
• Response Code: 200 / 304
• Response Formats: application/xml application/json
• Since: UForge 3.8.3

Retrieves a list of software components (libs, drivers etc) for the scanned system that will be automatically injected when generating a machine image for this target environment.

A list of :ref:`softwarebundle-object` objects are returned.

Security Summary

• Requires Authentication: true
• Entitlements Required: image_generate

URI Parameters

• uid (required): the user name (login name) of the :ref:`user-object`
• siid (required): the id of the :ref:`scannedinstance-object`
• tfid (required): the format id of the :ref:`image-object`
• sid (required): the id of the :ref:`scan-object`

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/platformtools/{tfid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

.. seealso::

         * :ref:`applianceImage-publish`
         * :ref:`image-object`
         * :ref:`imagepkgs-object`
         * :ref:`machineImageFile-download`
         * :ref:`machineImageGeneration-cancel`
         * :ref:`machineImagePkg-getAll`
         * :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-getPlatformTools`
         * :ref:`machineImage-publish`
         * :ref:`machineImage-regenerate`
         * :ref:`platformTool-getSoftware`
         * :ref:`scan-object`