GET /osImages

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

The following example is returned if the request is successful 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\r\n
  </pre></div>
  <div className="p">
   The following example is returned if the request is successful for a base operating system image.
   <pre className="pre codeblock lang-json">

```json
{
   "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"
}

The following example is returned if the request is successful.

{
   "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."
   }]
}