Community Wiki

From (mt) Community Wiki

osType Object

JSON representation

{
  "osType":{
    "id":16,
    "templateName":"ubuntu-9.10-x86_64",
    "osName":"Ubuntu 9.10",
    "osDescription":"Ubuntu 9.10 Karmic",
    "primarySortOrder":10,
    "secondarySortOrder":10,
    "defaultSelection":1
  }
}

XML representation

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<osType>
  <id>16</id>
  <templateName>ubuntu-9.10-x86_64</templateName>
  <osName>Ubuntu 9.10</osName>
  <osDescription>Ubuntu 9.10 Karmic</osDescription>
  <primarySortOrder>10</primarySortOrder>
  <secondarySortOrder>10</secondarySortOrder>
  <defaultSelection>1</defaultSelection>
</osType>

Fields

id

This is the value that is used for the operatingSystem parameter of the Add service method call.

templateName

Used by (mt) when building the OS.

osName

Human-readable name of the OS - suitable for inclusion into selection lists.

osDescription

Human-readable description of the OS.

primarySortOrder

Used in conjunction with secondarySortOrder when displaying a listing of available OS's.

Internally, when the '.../types/os' method is called, the items are sorted upon return based on:
((primarySortOrder * 1000000) + secondarySortOrder)

secondarySortOrder

Used in conjunction with primarySortOrder when displaying a listing of available OS's.

defaultSelection

If set to 1 this should be the default selection, when listed. If an operatingSystem is not specified for a (ve) Server, then this is the OS that will be installed.

Notes

Following is a list of Operating Systems that are available, as of 1/28/2011, to be installed on a new (ve) Server.

The actual list may change, so it is wise to consult the output of the List available operating systems method to get the most up-to-date list.