Examples

PUT /api/operatingsystems/1073012828-RHEL%206-1
{
  "operatingsystem": {
    "architectures": [
      {
        "id": 501905019
      },
      {
        "id": 331892513
      }
    ]
  }
}
200
{
  "description": "RHEL 6.1",
  "major": "6",
  "minor": "1",
  "family": "Redhat",
  "release_name": null,
  "password_hash": "SHA256",
  "created_at": "2022-03-29 08:59:31 UTC",
  "updated_at": "2022-03-29 08:59:31 UTC",
  "id": 1073012828,
  "name": "Redhat",
  "title": "RHEL 6.1",
  "media": [
    {
      "id": 980190962,
      "name": "CentOS 5.4"
    }
  ],
  "architectures": [
    {
      "name": "x86_64",
      "id": 501905019
    },
    {
      "name": "sparc",
      "id": 331892513
    }
  ],
  "ptables": [],
  "provisioning_templates": [
    {
      "id": 1007981701,
      "name": "centos5_3_pxelinux",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    },
    {
      "id": 508279162,
      "name": "Linux host_init_config default",
      "template_kind_id": 508279162,
      "template_kind_name": "host_init_config"
    },
    {
      "id": 104314179,
      "name": "MyFinish",
      "template_kind_id": 550103832,
      "template_kind_name": "finish"
    },
    {
      "id": 981457253,
      "name": "MyScript",
      "template_kind_id": 478250810,
      "template_kind_name": "script"
    },
    {
      "id": 943779058,
      "name": "MyString",
      "template_kind_id": 698706415,
      "template_kind_name": "iPXE"
    },
    {
      "id": 269958254,
      "name": "MyString2",
      "template_kind_id": 983253650,
      "template_kind_name": "provision"
    },
    {
      "id": 554905648,
      "name": "PXEGrub2 global default",
      "template_kind_id": 701398793,
      "template_kind_name": "PXEGrub2"
    },
    {
      "id": 131565194,
      "name": "PXEGrub Dummy Menu",
      "template_kind_id": 131565194,
      "template_kind_name": "PXEGrub"
    },
    {
      "id": 824224502,
      "name": "PXEGrub global default",
      "template_kind_id": 131565194,
      "template_kind_name": "PXEGrub"
    },
    {
      "id": 821548108,
      "name": "PXELinux default local boot",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    },
    {
      "id": 352050261,
      "name": "PXELinux global default",
      "template_kind_id": 452984334,
      "template_kind_name": "PXELinux"
    }
  ],
  "os_default_templates": [
    {
      "id": 980190962,
      "provisioning_template_id": 943779058,
      "provisioning_template_name": "MyString",
      "template_kind_id": 698706415,
      "template_kind_name": "iPXE",
      "operatingsystem_id": 1073012828,
      "operatingsystem_name": "RHEL 6.1"
    },
    {
      "id": 298486374,
      "provisioning_template_id": 269958254,
      "provisioning_template_name": "MyString2",
      "template_kind_id": 983253650,
      "template_kind_name": "provision",
      "operatingsystem_id": 1073012828,
      "operatingsystem_name": "RHEL 6.1"
    },
    {
      "id": 113629430,
      "provisioning_template_id": 981457253,
      "provisioning_template_name": "MyScript",
      "template_kind_id": 478250810,
      "template_kind_name": "script",
      "operatingsystem_id": 1073012828,
      "operatingsystem_name": "RHEL 6.1"
    },
    {
      "id": 281110143,
      "provisioning_template_id": 1007981701,
      "provisioning_template_name": "centos5_3_pxelinux",
      "template_kind_id": 710512633,
      "template_kind_name": null,
      "operatingsystem_id": 1073012828,
      "operatingsystem_name": "RHEL 6.1"
    },
    {
      "id": 1018350795,
      "provisioning_template_id": 131565194,
      "provisioning_template_name": "PXEGrub Dummy Menu",
      "template_kind_id": 131565194,
      "template_kind_name": "PXEGrub",
      "operatingsystem_id": 1073012828,
      "operatingsystem_name": "RHEL 6.1"
    },
    {
      "id": 51848956,
      "provisioning_template_id": 698706415,
      "provisioning_template_name": "iPXE Dummy Menu",
      "template_kind_id": 698706415,
      "template_kind_name": "iPXE",
      "operatingsystem_id": 1073012828,
      "operatingsystem_name": "RHEL 6.1"
    },
    {
      "id": 457008489,
      "provisioning_template_id": 508279162,
      "provisioning_template_name": "Linux host_init_config default",
      "template_kind_id": 508279162,
      "template_kind_name": "host_init_config",
      "operatingsystem_id": 1073012828,
      "operatingsystem_name": "RHEL 6.1"
    }
  ],
  "images": [],
  "parameters": [
    {
      "priority": null,
      "created_at": "2022-03-29 08:59:31 UTC",
      "updated_at": "2022-03-29 08:59:31 UTC",
      "id": 716195090,
      "name": "os1",
      "parameter_type": "string",
      "value": "os1"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be a String

operatingsystem
required

Validations:

  • Must be a Hash

operatingsystem[name]
optional

Validations:

  • Must match regular expression /\A(\S+)\Z/.

operatingsystem[major]
optional

Validations:

  • Must be a String

operatingsystem[minor]
optional , nil allowed

Validations:

  • Must be a String

operatingsystem[description]
optional , nil allowed

Validations:

  • Must be a String

operatingsystem[family]
optional , nil allowed

Validations:

  • Must be a String

operatingsystem[release_name]
optional , nil allowed

Validations:

  • Must be a String

operatingsystem[os_parameters_attributes]
optional , nil allowed

Array of parameters

Validations:

  • Must be an Array of nested elements

operatingsystem[os_parameters_attributes][name]
optional

Name of the parameter

Validations:

  • Must be a String

operatingsystem[os_parameters_attributes][value]
optional

Parameter value

Validations:

  • Must be a String

operatingsystem[password_hash]
optional , nil allowed

Root password hash function to use

Validations:

  • Must be one of: SHA256, SHA512, Base64, Base64-Windows, MD5.

operatingsystem[architecture_ids]
optional , nil allowed

IDs of associated architectures

Validations:

  • Must be an array of any type

operatingsystem[provisioning_template_ids]
optional , nil allowed

IDs of associated provisioning templates

Validations:

  • Must be an array of any type

operatingsystem[medium_ids]
optional , nil allowed

IDs of associated media

Validations:

  • Must be an array of any type

operatingsystem[ptable_ids]
optional , nil allowed

IDs of associated partition tables

Validations:

  • Must be an array of any type