Skip to main content

Operating-system deployment

The following resources are available for performing operating-system deployment functions.

  • /files/osImages?jobId={job_id}
    Use this REST API to import an OS image, OS image profile, device driver, boot file, or custom file (such as configuration settings, installation script, software, and unattend file), to the Lenovo XClarity Administrator OS images repository. Only the user that created the job has the permission to import image using the job ID that was returned from that method.
  • /hostPlatforms
    Use this REST API to retrieve information about the host platforms and deploy operating-system images to the host platforms as a job. Host platforms include all managed servers for which an operating system can be deployed from the Lenovo XClarity Administrator server.
  • /osdeployment/globalSettings
    Use this REST API to retrieve or modify global operating-system deployment settings. Global settings serve as defaults settings when operating systems are deployed.
  • /osdeployment/hostSettings
    Use this REST API to retrieve information about the network and storage settings for all servers, and create or modify the network and storage settings for one or more servers.
  • /osdeployment/hostSettings/{uuid}
    Use this REST API to retrieve information about, modify, or delete the network and storage settings for a specific server.
  • /osdeployment/osInfo
    Use this REST API to retrieve the information about the operating system that was deployed successfully by this Lenovo XClarity Administrator instance for each managed server.
  • /osdeployment/osInfo/{uuid_list}
    Use this REST API to retrieve the information about the operating system that was deployed successfully by this Lenovo XClarity Administrator instance for a specific managed server.
  • /osImages
    Use this REST API to retrieve information about and create a job to import OS images, OS-image profiles, device driver, boot files, and custom files (such as configuration settings, installation scripts, software, and unattend files) , or to customize an OS-image profile.
  • /osImages/{file_name}
    Use this REST API to export a customized OS image profile to a remote file server or local system.
  • /osImages/{id}
    Use this REST API to remove one or more OS images, OS-image profiles, device driver, boot files, and custom files (such as configuration settings, installation scripts, software, and unattend files) from the Lenovo XClarity Administrator OS images repository, create a customized OS-image profile from a base operating system and add custom files, modify, or create a downloadable tar.gz file that contains a customized OS-image profile, or modify an existing device driver or boot file.
  • /osImages/customSettings
    Use this REST API to validate a custom configuration-settings file (in JSON format).
  • /osImages/remoteFileServers
    Use this REST API to retrieve information about all remote file-server profiles or to create or modify a remote file-server profile.
  • /osImages/remoteFileServers/{id}
    Use this REST API to retrieve information about or to delete a specific remote file-server profile.