GET /api/operatingsystems 200 { "total": 8, "subtotal": 8, "page": 1, "per_page": 20, "search": null, "sort": { "by": null, "order": null }, "results": [ { "description": null, "major": "5", "minor": "3", "family": "Redhat", "release_name": null, "password_hash": "SHA256", "created_at": "2022-03-29 08:27:00 UTC", "updated_at": "2022-03-29 08:27:00 UTC", "id": 309172073, "name": "centos", "title": "centos 5.3" }, { "description": null, "major": "5", "minor": "17", "family": "VRP", "release_name": null, "password_hash": "SHA256", "created_at": "2022-03-29 08:27:00 UTC", "updated_at": "2022-03-29 08:27:00 UTC", "id": 32055736, "name": "Huawei_VRP", "title": "Huawei VRP 5" }, { "description": null, "major": "1", "minor": "1", "family": "Redhat", "release_name": null, "password_hash": "SHA256", "created_at": "2022-03-29 08:27:00 UTC", "updated_at": "2022-03-29 08:27:00 UTC", "id": 775246587, "name": "NoHosts", "title": "NoHosts 1.1" }, { "description": null, "major": "12", "minor": "3", "family": "Suse", "release_name": null, "password_hash": "SHA256", "created_at": "2022-03-29 08:27:00 UTC", "updated_at": "2022-03-29 08:27:00 UTC", "id": 750842046, "name": "OpenSuse", "title": "OpenSuSE 12.3" }, { "description": "RHEL 6.1", "major": "6", "minor": "1", "family": "Redhat", "release_name": null, "password_hash": "SHA256", "created_at": "2022-03-29 08:27:00 UTC", "updated_at": "2022-03-29 08:27:00 UTC", "id": 1073012828, "name": "Redhat", "title": "RHEL 6.1" }, { "description": null, "major": "5", "minor": "10", "family": "Solaris", "release_name": "hw0910", "password_hash": "SHA256", "created_at": "2022-03-29 08:27:00 UTC", "updated_at": "2022-03-29 08:27:00 UTC", "id": 442321401, "name": "Solaris", "title": "Solaris 5.10" }, { "description": null, "major": "10", "minor": "10", "family": "Debian", "release_name": "rn10", "password_hash": "SHA256", "created_at": "2022-03-29 08:27:00 UTC", "updated_at": "2022-03-29 08:27:00 UTC", "id": 331303656, "name": "Ubuntu", "title": "Ubuntu 10.10" }, { "description": null, "major": "12", "minor": "10", "family": "Debian", "release_name": "rn10", "password_hash": "SHA256", "created_at": "2022-03-29 08:27:00 UTC", "updated_at": "2022-03-29 08:27:00 UTC", "id": 272342666, "name": "Ubuntu", "title": "Ubuntu 12.10" } ] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
architecture_id optional |
ID of architecture Validations:
|
medium_id optional |
ID of medium Validations:
|
ptable_id optional |
ID of partition table Validations:
|
provisioning_template_id optional |
ID of template Validations:
|
os_parameters_attributes optional |
Array of parameters Validations:
|
os_parameters_attributes[name] required |
Name of the parameter Validations:
|
os_parameters_attributes[value] required |
Parameter value Validations:
|
search optional |
filter results Validations:
|
order optional |
Sort and order by a searchable field, e.g. '<field> DESC' Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return, 'all' to return all results Validations:
|
Field name | Type | Possible values |
---|---|---|
architecture | string | |
description | string | |
family | string | |
id | integer | |
major | string | |
medium | string | |
minor | string | |
name | string | |
params | string | |
template | string | |
title | string |
GET /api/operatingsystems/1073012830 200 { "description": null, "major": "341", "minor": "", "family": null, "release_name": null, "password_hash": "SHA256", "created_at": "2022-03-29 08:43:26 UTC", "updated_at": "2022-03-29 08:43:26 UTC", "id": 1073012830, "name": "operatingsystem349", "title": "operatingsystem349 341", "media": [], "architectures": [], "ptables": [], "provisioning_templates": [ { "id": 508279162, "name": "Linux host_init_config default", "template_kind_id": 508279162, "template_kind_name": "host_init_config" } ], "os_default_templates": [ { "id": 1018350797, "provisioning_template_id": 508279162, "provisioning_template_name": "Linux host_init_config default", "template_kind_id": 508279162, "template_kind_name": "host_init_config", "operatingsystem_id": 1073012830, "operatingsystem_name": "operatingsystem349 341" } ], "images": [], "parameters": [ { "priority": 50, "created_at": "2022-03-29 08:43:26 UTC", "updated_at": "2022-03-29 08:43:26 UTC", "id": 767575241, "name": "foo", "parameter_type": "string", "value": "*****" } ] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
show_hidden_parameters optional |
Display hidden parameter values Validations:
|
POST /api/operatingsystems { "operatingsystem": { "name": "awsome_os", "major": "1", "minor": "2" } } 201 { "description": null, "major": "1", "minor": "2", "family": null, "release_name": null, "password_hash": "SHA256", "created_at": "2022-03-29 08:59:43 UTC", "updated_at": "2022-03-29 08:59:43 UTC", "id": 1073012846, "name": "awsome_os", "title": "awsome_os 1.2", "media": [], "architectures": [], "ptables": [], "provisioning_templates": [ { "id": 508279162, "name": "Linux host_init_config default", "template_kind_id": 508279162, "template_kind_name": "host_init_config" } ], "os_default_templates": [ { "id": 1018350813, "provisioning_template_id": 508279162, "provisioning_template_name": "Linux host_init_config default", "template_kind_id": 508279162, "template_kind_name": "host_init_config", "operatingsystem_id": 1073012846, "operatingsystem_name": "awsome_os 1.2" } ], "images": [], "parameters": [] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
operatingsystem required |
Validations:
|
operatingsystem[name] required |
Validations:
|
operatingsystem[major] required |
Validations:
|
operatingsystem[minor] optional , nil allowed |
Validations:
|
operatingsystem[description] optional , nil allowed |
Validations:
|
operatingsystem[family] optional , nil allowed |
Validations:
|
operatingsystem[release_name] optional , nil allowed |
Validations:
|
operatingsystem[os_parameters_attributes] optional , nil allowed |
Array of parameters Validations:
|
operatingsystem[os_parameters_attributes][name] required |
Name of the parameter Validations:
|
operatingsystem[os_parameters_attributes][value] required |
Parameter value Validations:
|
operatingsystem[password_hash] optional , nil allowed |
Root password hash function to use Validations:
|
operatingsystem[architecture_ids] optional , nil allowed |
IDs of associated architectures Validations:
|
operatingsystem[provisioning_template_ids] optional , nil allowed |
IDs of associated provisioning templates Validations:
|
operatingsystem[medium_ids] optional , nil allowed |
IDs of associated media Validations:
|
operatingsystem[ptable_ids] optional , nil allowed |
IDs of associated partition tables Validations:
|
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" } ] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
operatingsystem required |
Validations:
|
operatingsystem[name] optional |
Validations:
|
operatingsystem[major] optional |
Validations:
|
operatingsystem[minor] optional , nil allowed |
Validations:
|
operatingsystem[description] optional , nil allowed |
Validations:
|
operatingsystem[family] optional , nil allowed |
Validations:
|
operatingsystem[release_name] optional , nil allowed |
Validations:
|
operatingsystem[os_parameters_attributes] optional , nil allowed |
Array of parameters Validations:
|
operatingsystem[os_parameters_attributes][name] optional |
Name of the parameter Validations:
|
operatingsystem[os_parameters_attributes][value] optional |
Parameter value Validations:
|
operatingsystem[password_hash] optional , nil allowed |
Root password hash function to use Validations:
|
operatingsystem[architecture_ids] optional , nil allowed |
IDs of associated architectures Validations:
|
operatingsystem[provisioning_template_ids] optional , nil allowed |
IDs of associated provisioning templates Validations:
|
operatingsystem[medium_ids] optional , nil allowed |
IDs of associated media Validations:
|
operatingsystem[ptable_ids] optional , nil allowed |
IDs of associated partition tables Validations:
|
DELETE /api/operatingsystems/775246587-NoHosts%201-1 { "operatingsystem": {} } 200 { "id": 775246587, "major": "1", "name": "NoHosts", "minor": "1", "nameindicator": null, "created_at": "2022-03-29T08:59:31.133Z", "updated_at": "2022-03-29T08:59:31.133Z", "release_name": null, "description": null, "password_hash": "SHA256", "title": "NoHosts 1.1" }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
medium optional |
Validations:
|
architecture optional |
Validations:
|