Operating systems

>>>

GET /api/operatingsystems
List all operating systems

GET /api/architectures/:architecture_id/operatingsystems
List all operating systems for nested architecture

GET /api/media/:medium_id/operatingsystems
List all operating systems for nested medium

GET /api/ptables/:ptable_id/operatingsystems
List all operating systems for nested partition table

GET /api/provisioning_templates/:provisioning_template_id/operatingsystems
List all operating systems for nested provisioning template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
architecture_id
optional

ID of architecture

Validations:

  • String
medium_id
optional

ID of medium

Validations:

  • String
ptable_id
optional

ID of partition table

Validations:

  • String
provisioning_template_id
optional

ID of template

Validations:

  • String
os_parameters_attributes
optional

Array of parameters

Validations:

  • Must be an Array of nested elements
os_parameters_attributes[name]
required

Name of the parameter

Validations:

  • String
os_parameters_attributes[value]
required

Parameter value

Validations:

  • String
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. ‘

Maruku could not parse this XML/HTML: 
<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

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/:id
Show an operating system

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
show_hidden_parameters
optional

Display hidden parameter values

Validations:

  • Must be one of: true, false, 1, 0.
>>>

POST /api/operatingsystems
Create an operating system

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
operatingsystem
required

Validations:

  • Hash
operatingsystem[name]
required

Validations:

  • Must match regular expression /\A(\S+)\Z/.
operatingsystem[major]
required

Validations:

  • String
operatingsystem[minor]
optional , nil allowed

Validations:

  • String
operatingsystem[description]
optional , nil allowed

Validations:

  • String
operatingsystem[family]
optional , nil allowed

Validations:

  • String
operatingsystem[release_name]
optional , nil allowed

Validations:

  • String
operatingsystem[os_parameters_attributes]
optional , nil allowed

Array of parameters

Validations:

  • Must be an Array of nested elements
operatingsystem[os_parameters_attributes][name]
required

Name of the parameter

Validations:

  • String
operatingsystem[os_parameters_attributes][value]
required

Parameter value

Validations:

  • 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
>>>

PUT /api/operatingsystems/:id
Update an operating system

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
operatingsystem
required

Validations:

  • Hash
operatingsystem[name]
optional

Validations:

  • Must match regular expression /\A(\S+)\Z/.
operatingsystem[major]
optional

Validations:

  • String
operatingsystem[minor]
optional , nil allowed

Validations:

  • String
operatingsystem[description]
optional , nil allowed

Validations:

  • String
operatingsystem[family]
optional , nil allowed

Validations:

  • String
operatingsystem[release_name]
optional , nil allowed

Validations:

  • 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:

  • String
operatingsystem[os_parameters_attributes][value]
optional

Parameter value

Validations:

  • 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
>>>

DELETE /api/operatingsystems/:id
Delete an operating system

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
>>>

GET /api/operatingsystems/:id/bootfiles
List boot files for an operating system

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
medium
optional

Validations:

  • String
architecture
optional

Validations:

  • String