Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 2.07 KB

applianceBootScript_update.rst

File metadata and controls

71 lines (47 loc) · 2.07 KB
Raw

applianceBootScript_update

PUT /users/{uid}/appliances/{aid}/bootscripts/{bsid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 2.1.06

Updates a boot script that is attached to an appliance.

This only updates the meta-data associated with any uploaded boot script file.

Refer to bootscript-object for more information on the boot script attributes.

Warning

If the new boot script data contains a md5sum and if this md5sum is not equal to the existing boot script meta-data, then any uploaded boot script file is deleted and a new boot script file will need to be uploaded using applianceBootScript-upload

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user-object
  • bsid (required): the id of the bootscript-object
  • aid (required): the id of the appliance-object

HTTP Request Body Parameters

A bootScript-object object

Example Request

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

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

<ns0:bootScript xmlns:ns0="http://www.usharesoft.com/uforge">
    <bootType>everyboot</bootType>
</ns0:bootScript>
  • appliance-object
  • applianceBootScript-create
  • applianceBootScript-delete
  • applianceBootScript-deleteAll
  • applianceBootScript-download
  • applianceBootScript-downloadFile
  • applianceBootScript-get
  • applianceBootScript-getAll
  • applianceBootScript-upload
  • bootscript-object