GET /osImages

Use the GET method to retrieve information about the OS images and OS-image profiles, including the associated device drivers, boot-options files, and custom files (such as configuration settings, installation scripts, software, and unattend files), that are loaded in the Lenovo XClarity Administrator OS-images repository.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/osImages

Query parameters

Parameters Required / Optional Description
imageType=OSPROFILE Optional Returns information for specific OS-image profiles
id=<id_list> Optional Returns information for specific OS-image profiles, specified by ID. Separate multiple IDs using a comma.

To obtain the ID, use the GET /osImages method.

The following example returns information for all OS-image profiles.
GET https://192.0.2.0/osImages
The following example returns information only for the OS-image profile with the specified ID.
GET https://192.0.2.0/osImages
?imageType=OSPROFILE&id=win2012r2|win2012r2-x86_64-install-Datacenter_Virtualization

Response codes

Code Description
200 OK. The request completed successfully.
500 Internal server error. A descriptive error message is returned in the response body.

Response body

Attention: The drivers response attribute and its child attributes are not supported in Lenovo XClarity Administrator v1.3.0 and later.
Attributes Type Description
bootFiles Array of object List of boot-option files that are imported and available to the OS image profiles
  bundleId String ID of the OS bundle from which the boot file was imported
  description String Boot-option file description
  id String Boot-option file identifier
  name String Boot-option file name
  os String The operating system that is associated with the boot-options file. This can be one of the following values.
  • win

  osrelease String Operating system release that supports the device driver.
  size Integer Size, in KB, of the boot-options file
  type String Type of boot-options file. This can be one of the following values.
  • custom. The file was manually imported and added to a customized OS-images profile.
  • predefined. The file was preloaded by XClarity Administrator.
  version String Boot-options file version (for example, v1 or v2)
bundleFiles Array of object List of bundle files that are imported and available to the OS image profiles
  description String Description of the bundle file
  id String ID of the bundle file
  name String Name of the bundle file
  os String The operating system that is associated with the bundle file. This can be one of the following values.
  • win

  osrelease String Operating system release that supports the bundle file
  releasedate String Release date of the bundle file
  size String Size, in MB, of the bundle file
  version String Version of the bundle file (for example, v1 or v2)
customConfigFiles Array of objects List of configuration-settings files that are imported and available to the OS image profiles
  associatedFileId String ID of the unattend file that was optionally associated with the configuration-settings file
  content String Contents of the configuration-settings file
  customMacros Array of objects List of custom macros that are derived from the configuration-settings file
    macroName String Name of the macro
  description String Description of the configuration-settings file
  id String ID of the configuration-settings file
  name String Name of the configuration-settings file
  os String Operating system that is associated with the configuration-settings file. This can be one of the following values.
  • esxi

  • rhel

  • sles

  • win

  osrelease String Operating system release
  type String Type of boot-options file. This can be one of the following values.
  • custom. The file was manually imported and added to a customized OS-images profile.
  • predefined. The file was preloaded by Lenovo XClarity Administrator.
  version String Version of the configuration-settings file
diskUsage Object Information about disk usage
  bootFileDiskUsage Long Disk space that is used by the boot-options files (such as WinPE)
  configFileDiskUsage Long Disk space that is used by the configuration-settings files
  deviceDriverDiskUsage Long Disk space that is used by the disk drivers
  osImageDiskUsage Long Disk space that is used by only the operating-system image.
  scriptFileDiskUsage Long Disk space that is used by the installation-script file
  softwareFileDiskUsage Long Disk space that is used by the software files
  totalDiskUsage Long Total amount of disk space used.
  unattendFileDiskUsage Long Disk space that is used by the unattend files
driverFiles Array of object List of device drivers that are imported and available to the OS image profiles
  bundleId String ID of the OS bundle from which the boot file was imported
  description String Device driver description
  devicetype String Device driver adapter type. This can be one of the following values.
  • nic. Network interface adapter

  • storage. Storage adapter, such as SAS or RAID

  • hba. Fibre Channel adapter

  • other. Other adapters, such as chipset device adapters

  id String Device driver identifier
  name String Device driver name
  os String Operating system that is associated with the boot-options file. This can be one of the following values.
  • esxi

  • rhel

  • sles

  • win

  osrelease String Operating system release that supports the device driver
  type String Type of device driver. This can be one of the following values.
  • custom. The file was manually imported and added to a customized OS-images profile.
  • predefined. The file was preloaded by Lenovo XClarity Administrator.
  version String Device driver version (for example, v1, v2, etc.)
installScriptFiles Array of objects List of installation-script files that are imported and available to the OS-image profile

Currently, only post-installation scripts are supported.

  description String Installation-script description
  id String Installation-script identifier
  name String Installation-script file name
  os String Operating system that is associated with the installation-script file. This can be one of the following values.
  • esxi

  • rhel

  • sles

  • win

  type String Type of installation-script file. This can be one of the following values.
  • custom. The file was manually imported and added to a customized OS-images profile.
  • predefined. The file was preloaded by Lenovo XClarity Administrator.
  version String Version of the installation-script
isAuthorized Boolean Indicates whether the user is assigned a role that can manage and deploy an operating system. This can be one of the following values.
  • true. The user is authorized.

  • false. The user is not authorized

items Array of objects Information about each operating-system image
  description String Description for the operating system image
  deployStatus String Deployment status of the operating system image. This can be one of the following values.
  • ready. The operating system can be deployed. A matching WinPE image is in the OS-images repository, and all Windows profiles are using a custom WinPE image.

  • warning. The operating system can be deployed; however, there is a potential issue with the OS image.

    • An unsupported WinPE file is in the OS-images repository, and one or more profiles are using the unsupported WinPE file. The predefined WinPE file that was migrated from in Lenovo XClarity Administrator v1.4.x or earlier is no longer supported.

    • The operating system is not incompatible with Thinksystem servers.

  • notReady. The operating system cannot be deployed because a matching WinPE image is not in the OS-images repository.

    Note:
    • The deployStatus for placeholder profiles is always set to "Not Ready."
    • If the deployStatus is "Not Ready," use the readyCheck attribute to get information to help resolve the problem.
  id String ID of the OS image
  isCustomizedISO Boolean Indicates whether the OS image is customized. This can be one of the following values.
  • true. This is a custom image.
  • false. This is a base image.
  name String Name of the OS image
  osBuildId String Build number of the operating-system image
  osrelease String Release for the operating system
  profiles Array of objects Information about one or more OS profiles
    attributes Array of strings  
    customizationOptions Object Information about all options that can be customized in this operating system

If the base operating system for the profile does not support customization, this attribute is null.

If the base operating system for the profile supports customization but does support certain child attributes, the unsupported chile attributes are returned as empty strings.

      bootOptions Object Information about predefined and imported boot-options files that are associated with this customized OS image profile
        bootFileIds Array of strings Boot-options file IDs that correlate to the imported boot-options files

Use POST /osImages to import the boot-options file, and then use POST /files/osImages?jobId=<job_id> to import the boot-options file into the OS images repository.

      customConfigOptions Object Information about the custom configuration settings that are associated with this customized OS-image profile
        customConfigFileIds Array of strings List of IDs for each configuration-settings file that is associated with the OS-image profile
      customSoftwareOptions Object Information about custom software payloads that are associated with this customized OS image profile
        customSoftwareIds Array of strings List of IDs for each software payload that is associated with the OS-image profile
      customType Integer Customization type. This can be one of the following values.
  • 1. Custom unattend file and associated custom config file.

  • 2. Custom unattend file only.

  • 3. Custom unattend file and custom config file.

  • 4. Custom config file only.

  • 5. No custom unattend or config file.

      deployDataAndSoftwareLocation String Path to the extracted software payload, custom files, and deployment data (such as certificates and logs) on the deployment host. The following directories are used by default.
  • Linux: /home/lxca

  • Windows: c:\lxca

      driverOptions Object Information about predefined and imported device drivers that are associated with this customized OS image profile
        driverFileIds Array of strings Device driver file IDs that is associated with the OS-image profile

Use POST /osImages to import the device drivers, and then use POST /files/osImages?jobId=<job_id> to import the device drivers into the OS images repository.

      installScriptOptions Object Information about installation-script files associated with this customized OS image profile
        scriptFileIds Array of strings List of IDs for each installation-script file that is associated with the OS-image profile

Use POST /osImages to import the Installation-script files, and then use POST /files/osImages?jobId=<job_id> to import the installation-script files into the OS-images repository.

      unattendOptions Array of objects Information about unattend files that are associated with this customized OS-image profile
        unattendFileIds Array of strings List of IDs for each unattend file that is associated with the OS-image profile
    deployStatus String Deployment status of the operating system image. This can be one of the following values.
  • ready. The operating system can be deployed. A matching WinPE image is in the OS-images repository, and all Windows profiles are using a custom WinPE image.

  • warning. The operating system can be deployed; however, there is a potential issue with the OS image.

    • An unsupported WinPE file is in the OS-images repository, and one or more profiles are using the unsupported WinPE file. The predefined WinPE file that was migrated from in Lenovo XClarity Administrator v1.4.x or earlier is no longer supported.

    • The operating system is not incompatible with Thinksystem servers.

  • notReady. The operating system cannot be deployed because a matching WinPE image is not in the OS-images repository.

    Note:
    • The deployStatus for placeholder profiles is always set to "Not Ready."
    • If the deployStatus is "Not Ready," use the readyCheck attribute to get information to help resolve the problem.
    description String A description for the OS profile
    id String The operating-system image profile ID. This ID is made up of the OS-image name and image-profile name separated by a bar (for example, sles12.2|sles12.2-x86_64-install-Basic).
    isAllowedInCurrentSecurityMode Boolean
Note: This attribute will be deprecated in a future release. Use items.readyCheck.isNotAllowedInCurrentSecurityMode instead
    isCustomizedISO Boolean Indicates whether the OS image is customized. This can be one of the following values.
  • true. This is a custom image.
  • false. This is a base image.
    name String Name of the OS profile
    osBuildId String  
    osrelease String  
    readyCheck Object Information about the whether the OS-image profile is ready for deployment
      incompatibleWithThinksystem Boolean Indicates whether the OS-image profile is not compatible with ThinkSystem servers. This can be one of the following values.
  • true. The profile is not compatible with ThinkSystem servers

  • false. The profile is compatible with ThinkSystem servers

      isPlaceholder Boolean Indicates whether the OS-image profile is a placeholder. This can be one of the following values.
  • true. The profile is a placeholder

  • false. The profile is not a placeholder

      noPackages Boolean Indicates whether the SLES 15 installer image has corresponding packages file imported for deployment. If the profile is not for SLES 15, you can ignore this attribute. This can be one of the following values.
  • true. The packages image does not exist.

  • false. The packages image exists.

      noWinpe Boolean Indicates whether the OS-image profile does not use a WinPE boot file. If the profile is not Windows, you can ignore this attribute. This can be one of the following values.
  • true. The profile does not use a WinPE boot file

  • false. The profile uses a WinPE boot file.

      preloadedWinpe Boolean Indicates whether the OS-image profile uses a preloaded WinPE boot file. If the profile is not for Windows, you can ignore this attribute. This can be one of the following values.
  • true. The profile does not use a preloaded WinPE bootoptions file

  • false. The profile uses a preloaded WinPE boot file.

      requiresThinksystemKiso Boolean Indicates whether the SLES image requires a kISO image to be compatible with ThinkSystem servers. This can be one of the following values. If the profile is not for SLES, you can ignore this attribute.
  • true. A kISO image is required.

  • false. A kISO image is not required.

    supportedOsRelease String Operating-system release that is supported by the OS profile
    type String The type of OS profile. This can be one of the following values.
  • custom. The profile was created when a boot file or device driver was manually uploaded and added to an operating system.
  • predefined. The profile was preloaded by Lenovo XClarity Administrator.
  readyCheck Object Information about the whether the OS image is ready for deployment
    isNotAllowedInCurrentSecurityMode Boolean Indicates whether the OS profile is supported in the current security mode. For customized OS image profiles, this indicates the security mode of the base operating system. This can be one of the following values.
  • true. The OS profile is not supported in the current security mode

  • false. The OS profile is supported in the current security mode

    incompatibleWithThinksystem Boolean Indicates whether the OS image is not compatible with ThinkSystem servers. This can be one of the following values.
  • true. The OS image is not compatible with ThinkSystem servers

  • false. The OS image is compatible with ThinkSystem servers

  size Integer Size, in KB, of the OS-image file
  supportedOsRelease String Operating-system release that is supported by the OS profile
  type String Type of OS image. This can be one of the following values.
  • custom. The OS image does not contain predefined profiles. Custom profiles must be used to deploy this image.

  • base. The OS image contains only predefined profiles. Custom and predefined profiles can be used to deploy this image.

lastRefreshed String Timestamp of the last predefined OS-image repository refresh
number Integer Number of OS images
predefinedMacros Array of objects List of predefined macros (configurable settings) that are provided by XClarity Administrator
  macroName String Name of the macro
softwareFiles Array of objects List of custom software payloads that are imported and available to the OS image profiles
  description String Description of the software payload
  id String ID of the software payload
  name String Name of the software payload
  os String Operating system that is associated with the software payload. This can be one of the following values.
  • esxi

  • rhel

  • sles

  • win

  osrelease String Operating system release
  size Integer Size, in KB, of the software-payload file
  type String Type of software payload. This can be one of the following values.
  • custom. The file was manually imported and added to a customized OS-images profile.
  • predefined. The file was created by Lenovo.
  version String Version of the software payload
supportedImages Array of objects Information about each supported operation system image
  allowCustomBootFile String Indicates whether the specified image supports custom boot files. This can be one of the following values.
  • true. Customizing boot files is supported.

  • false. Customizing boot files is not supported.

  allowCustomConfigFile String Indicates whether the specified image supports custom configuration settings. This can be one of the following values.
  • true. Custom configuration settings are supported.

  • false. Custom configuration settings are not supported.

Note: If name is rhels, this value must be false.
  allowCustomDriver String Indicates whether the specified image supports custom device drivers. This can be one of the following values.
  • true. Customizing device drivers is supported.

  • false. Customizing device drivers is not supported.

  allowCustomInstallScriptFile String Indicates whether the specified image supports custom installation script files. This can be one of the following values.
  • true. Customizing installation script files is supported.

  • false. Customizing installation script files is not supported.

  allowCustomPath String Indicates whether the specified image supports a custom data and files path. This can be one of the following values.
  • true. Customizing the data and files path is supported.

  • false. Customizing the data and files path is not supported.

  allowCustomSoftwareFile String Indicates whether the specified image supports custom software files. This can be one of the following values.
  • true. Custom software files are supported.

  • false. Custom software files are not supported.

  allowCustomUnattendFile String Indicates whether the specified image supports custom unattend files. This can be one of the following values.
  • true. Custom unattend files are supported.

  • false. Custom unattend files are not supported.

Note: If name is rhels, this value must be false.
  allowedBootFileExtension Array of strings List of file extensions that are permitted for custom boot files. This can be one or more of the following values.
  • zip

  allowedBundleFileExtension Array of strings List of file extensions that are permitted for bundle files. This can be one or more of the following values.
  • zip

  allowedConfigFileExtension Array of strings List of file extensions that are permitted for custom configuration settings files. This can be one or more of the following values.
  • json

  allowedDriverFileExtension Array of strings List of file extensions that are permitted for custom device drivers. This can be one or more of the following values.
  • iso

  • rpm

  • vib

  • zip

  allowedScriptFileExtension Array of strings List of file extensions that are permitted for custom installation scripts. This can be one or more of the following values.
  • cmd

  • pl

  • pm

  • ps1

  • psm1

  • py

  • sh

  allowedSoftwareFileExtension Array of strings List of file extensions that are permitted for custom software. This can be one or more of the following values.
  • tar.gz

  • zip

  allowedUnattendFileExtension Array of strings List of file extensions that are permitted for custom unattend files. This can be one or more of the following values.
  • cfg

  • xml

  customBootReleases Array of strings List of specific OS releases that are supported for custom boot files
Note: If allowCustomBootFile is false, this value is empty.
  customConfigReleases Array of strings List of specific OS releases that are supported for custom configuration settings
Note: If allowCustomConfigFile is false, this value is empty.
  customDriverReleases Array of strings List of specific OS releases that are supported for custom device drivers
Note: If allowCustomDriver is false, this value is empty.
  customInstallScriptReleases Array of strings List of specific OS releases that are supported for custom installation script files
Note: If allowCustomInstallScriptFile is false, this value is empty.
  customSoftwareReleases Array of strings List of specific OS releases that are supported for custom software files
Note: If allowCustomSoftware is false, this value is empty.
  customUnattendReleases Array of strings List of specific OS releases that are supported for custom unattend files
Note: If allowCustomUnattendFile is false, this value is empty.
  displayName String Display name for the specified image, in English only
  name String OS image name. This can be one of the following values.
  • esxi

  • rhels

  • sles

  • win

  releases Array of objects List of specific releases that are supported for the specified image
unattendFiles Array of objects List of unattend files that are imported and available to the OS image profiles. A custom unattend file can only be associated with 1 profile.
  associatedFileId String ID of the custom schema file that was optionally associated with the unattend file
  content String Content of the unattend file
  description String Description of the unattend file
  id String ID of the unattend file
  name String Name of the unattend file
  os String Operating system that is associated with the unattend file. This can be one of the following values.
  • esxi

  • rhel

  • sles

  • win

  osrelease String Operating system release
  type String Type of unattend file. This can be one of the following values.
  • custom. The file was manually uploaded and added to an operating system.

  • predefined. The file was preloaded by XClarity Administrator.

  version String Version of the unattend file
result String Result of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
messages Object Information about one or more messages

If the result is successful, an empty array is returned.

  explanation String Additional information to clarify the reason for the message
  id String Message identifier of a returned message
  recovery Array Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available
  text String Message text associated with the message identifier

Response example

When the request is successful (response code of 200), a message body similar to the following is returned for a base operating system image.

{
   "bootdFiles": [{
      "description": "Predefined WinPE wim file for Windows Server 2012 and 2016",
      "failedToLoad": false,
      "id": "winpe-64-base",
      "name": "WinPE_64",
      "os": "win",
      "osrelease": "2012,2012r2,2016,2016v1709",
      "size": 480224,
      "type": "Predefined",
      "version": "1"
   }],
"bundleFiles": [{
      "description": "LXCA-provided WinPE and drivers for Windows Server 2016",
      "id": "win2016-bundle",
      "minlxcarelease": "210",
      "name": "Windows Server 2016 Driver and Boot File Bundle",
      "os": "win",
      "osrelease": "2016",
      "releasedate": "2018-01-16",
      "size": "454 MB",
      "version": "1"
   }],
   "customConfigFiles": [{
      "associatedFileId": "",
      "content": "{\"category\": \"dynamic\",\r\n \"content\": [{\r\n \"category\": \"dynamic\",\r\n ...}"
      "customMacros": [
         { "macroName": "server-settings.node.fileserver" },
         { "macroName": "server-settings.node.lampserver" },
         { "macroName": "server-settings.node.mailserver" },
         { "macroName": "timezone"}
      ],
      "description": "",
      "id": "2018012943821_SLES_customConfigInstallPackages.json",
      "name": "SLES_customConfigInstallPackages",
      "os": "sles",
      "osrelease": "",
      "type": "Custom",
      "version": ""
   },
   {
      "associatedFileId": "",
      "content": "{\"category\": \"dynamic\",\r\n \"content\": [{\r\n \"category\": \"dynamic\",\r\n ...}"
      "customMacros": [
         { "macroName": "server-settings.node.keyboardLocale" },
          { "macroName": "server-settings.node.locale" }
      ],
      "description": "",
      "id": "2018012943854_SLES_customConfigLocale.json",
      "name": "SLES_customConfigLocale",
      "os": "win",
      "osrelease": "",
      "type": "Custom",
      "version": ""
   }],
   "diskUsage": {
      "bootFileDiskUsage": 436856,
      "configFileDiskUsage": 36,
      "deviceDriverDiskUsage": 420723,
      "osImageDiskUsage": 5974153,
      "scriptFileDiskUsage": 20
      "softwareFileDiskUsage": 224284,
      "totalDiskUsage": 7056100,
      "unattendFileDiskUsage": 28,
   },
   "driverFiles": [{
      "description": "LSI MPT3 SAS v8.00.00.00_k3.12.28-4-4 storage driver for SLES 12",
      "devicetype": "storage",
      "failedToLoad": false,
      "hwplatform": "immv2,thinkserver",
      "id": "storage-broadcom-mpt3sas-sles12",
      "name": "lsi-mpt3sas-kmp-default-8.00.00.00_k3.12.28_4-4.x86_64",
      "os": "sles",
      "osrelease": "12",
      "type": "Predefined",
      "version": "1",
   },
   ...,
   {
      "description": "Matrox Video v4.11.0 for RHEL 7.3",
      "devicetype": "other",
      "failedToLoad": false,
      "hwplatform": "immv3",
      "id": "other-matrox-rhel73",
      "name": "dd-mgag200-4.11.0_dup7.3-5.el7_3",
      "os": "rhels",
      "osrelease": "7.3",
      "type": "Predefined",
      "version": "1",
   }],
   "installScriptFiles": [{
      "description": "",
      "id": "2018012943624_install_custom_sw.sh",
      "name": "install_custom_sw",
      "os": "sles",
      "type": "Custom",
      "version": ""
   },
   {
      "description": "",
      "id": "2018012943641_Windows_sw-installScript.ps1",
      "name": "Windows_sw-installScript",
      "os": "win",
      "type": "Custom",
      "version": ""
   }],
   "isAuthorized": true,
   "items": [{
      "description": "",
      "deployStatus": "ready",
      "id": "win2016|",
      "isCustomizedISO": false,
      "name": "win2016",
      "osBuildId": "",
      "osrelease": "2016",
      "profiles": [{
         "attributes": [],
         "customizationOptions": {
            "bootOptions": {
               "bootFileIds": ["winpe-64-base"]
            },
            "deployDataAndSoftwareLocation": "C:\\lxca"
            "driverOptions": {
               "driverFileIds": [
                  "nic-broadcom-bnxtnd-win2016",
                  "storage-broadcom-megasas35-win2016",
                  ...,
                  "storage-brdcm-dd-megaraid5-win2016",
                  "other-mrvl-utl-dd-win2016"
               ]
            }
         },
         "description": "",
         "deployStatus": "ready",
         "id": "win2016|win2016-x86_64-install-Datacenter",
         "isAllowedInCurrentSecurityMode": true,
         "isCustomizedISO": false,
         "name": "win2016-x86_64-install-Datacenter",
         "osBuildId": "",
         "osrelease": "",
         "readyCheck": [{
            "incompatibleWithThinksystem": true,
            "isPlaceholder": true,
            "noWinpe": true,
            "preloadedWinpe": true
         }]
         "type": "predefined"
      },
      ...,
      ],
      "readyCheck": [{
         "isAllowedInCurrentSecurityMode": true,
         "incompatibleWithThinksystem": true,
         "requiresThinksystemKiso": true
      }]
      "size": 7624844,
      "type": "base"
   }],
   "lastRefreshed": "",
   "number": 1,
   "predefinedMacros": [
      { "macroName": "predefined.hostPlatforms" },
      { "macroName": "predefined.hostPlatforms.licenseKey" },
      ...,
      { "macroName": "predefined.unattendSettings.postinstallConfig" },
      { "macroName": "predefined.unattendSettings.reportWorkloadNotComplete" }
   ],
   "softwareFiles": [{
      "description": "",
      "id": "2018012943447_jre-8u151-linux-x64.tar.gz",
      "name": "jre-8u151-linux-x64",
      "os": "sles",
      "osrelease": "",
      "size": 8596,
      "type": "Custom",
      "version": ""
   },
   {
      "description": "",
      "id": "2018012943535_eclipse-4.6.3-3.1.x86_64.tar.gz",
      "name": "eclipse-4.6.3-3.1.x86_64",
      "os": "sles",
      "osrelease": "",
      "size": 8789,
      "type": "Custom",
      "version": ""
   }],
   "supportedImages": [{
      "allowCustomBootFile": "false",
      "allowCustomConfigFile": "false",
      "allowCustomDriver": "true",
      "allowCustomInstallScriptFile": "false",
      "allowCustomSoftwareFile": "false",
      "allowCustomUnattendFile": "false",
      "customBootReleases": [],
      "customConfigReleases": [],
      "customDriverReleases": ["6.2", "6.3", "6.4", "6.5", "6.6", ... "7.5"],
      "customInstallScriptReleases": [],
      "customSoftwareReleases": [],
      "customUnattendReleases": [],
      "displayName": "Red Hat Enterprise Linux",
      "name": "rhels",
      "releases": [
         { "6.2": ["IMM2", "thinkserver"] },
         { "6.3": ["IMM2", "thinkserver"] },
         ...,
         { "7.4": ["IMM2", "thinkserver",   "IMM3v1"] },
         { "7.5": ["IMM2", "thinkserver",   "IMM3v1"] }
      ]
   },
   ...,
   {
      "allowCustomBootFile": "false",
      "allowCustomConfigFile": "false",
      "allowCustomDriver": "false",
      "allowCustomInstallScriptFile": "false",
      "allowCustomSoftwareFile": "false",
      "allowCustomUnattendFile": "false",
      "customBootReleases": [],
      "customConfigReleases": [],
      "customDriverReleases": [],
      "customInstallScriptReleases": [],
      "customSoftwareReleases": [],
      "customUnattendReleases": [],
      "displayName": "VMWare ESXi",
      "name": "esxi",
      "releases": [
         { "5.1": ["IMM2", "thinkserver"] },
         { "5.1U1": ["IMM2", "thinkserver"] },
         ...,
         { "6.5U1": ["IMM2", "thinkserver", "IMM3v1"] },
         { "6.7": ["IMM2", "thinkserver", "IMM3v1"] }
      ]
   }],
   "unattendFiles": [{
      "associatedFileId": "",
      "content": "<?xml version=\"1.0\"?>\r\n\r\n<!DOCTYPE profile SYSTEM \"\/usr\/share\/YaST2\    ",
      "description": "",
      "id": "2018012943724_Windows_customUnattendInstallFeatures.xml",
      "name": "Windows_customUnattendInstallFeatures",
      "os": "win",
      "osrelease": "",
      "type": "Custom",
      "version": "",
   },
   {
      "associatedFileId": "",
      "content": "<?xml version=\"1.0\"?>\r\n<!DOCTYPE profile SYSTEM \"\/usr\/share\/YaST2\ ...",
      "description": "",
      "id": "2018012943748_SLES_customUnattendInstallPackage.xml",
      "name": "SLES_customUnattendInstallPackage",
      "os": "sles",
      "osrelease": "",
      "type": "Custom",
      "version": "",
   }],
   "result": "success",
   "messages": [],
}
When the request is successful (response code of 200), a message body similar to the following is returned for a base operating system image.
{
   "description": "",
   "deployStatus": "ready",
   "id": "win2019|",
   "isCustomizedISO": true,
   "name": "win2019",
   "osBuildId": "",
   "osrelease": "2019",
   "profiles": [{
      "attributes": [],
      "customizationOptions": null,
      "deployStatus": "ready",
      "description": "",
      "id": "win2019|win2019-x86_64-install-Datacenter_customized",
      "isAllowedInCurrentSecurityMode": true,
      "isCustomizedISO": true,
      "name": "win2019-x86_64-install-Datacenter_customized",
      "osBuildId": "",
      "osrelease": "",
      "readyCheck": {
         "isPlaceholder": false,
         "incompatibleWithThinksystem": false,
         "missingThinksystemKiso": false,
         "preloadedWinpe": false,
         "requiresThinksystemKiso": false,
         "noPackages": false,
         "noWinpe": false
      },
      "supportedOsRelease": "",
      "type": "predefined"
   }],
   "readyCheck": {
      "incompatibleWithThinksystem": false,
      "isNotAllowedInCurrentSecurityMode": false
   },
   "size": 4941784,
   "supportedOsRelease": "2019",
   "type": "base"
}

When the request is not successful (such as a response code of 404), a message body similar to the following is returned:

{
   "result": "failed",
   "messages": [{
      "explanation": "", 
      "id": "FQXHMFC0003M", 
      "recovery": {
          "text": "Restart the management server and attempt the operation again. If 
                 the problem persists, contact Support."
         "URL": "", 
      },
      "text": "The imported operating systems could not be retrieved from the image 
             repository."
   }]
}