Os default templates

>>>

GET /api/operatingsystems/:operatingsystem_id/os_default_templates
List default templates combinations for an operating system

GET /api/provisioning_templates/:provisioning_template_id/os_default_templates
List operating systems where this template is set as a default

Examples

GET /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates
200
{
  "total": 6,
  "subtotal": 6,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "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"
    }
  ]
}

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
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String
provisioning_template_id
optional

ID of provisioning template

Validations:

  • Must be a 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$/.
>>>

GET /api/operatingsystems/:operatingsystem_id/os_default_templates/:id
Show a default template combination for an operating system

Examples

GET /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates/980190962
200
{
  "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"
}

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
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String
id
required

Validations:

  • Must be a number.
>>>

POST /api/operatingsystems/:operatingsystem_id/os_default_templates
Create a default template combination for an operating system

Examples

POST /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates
{
  "os_default_template": {
    "provisioning_template_id": 943779058,
    "template_kind_id": 698706415
  }
}
201
{
  "id": 1018350796,
  "provisioning_template_id": 943779058,
  "provisioning_template_name": "MyString",
  "template_kind_id": 698706415,
  "template_kind_name": "iPXE",
  "operatingsystem_id": 1073012828,
  "operatingsystem_name": "RHEL 6.1"
}

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
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String
os_default_template
required

Validations:

  • Must be a Hash
os_default_template[template_kind_id]
optional , nil allowed

Validations:

  • Must be a number.
os_default_template[provisioning_template_id]
optional , nil allowed

ID of provisioning template

Validations:

  • Must be a number.
>>>

PUT /api/operatingsystems/:operatingsystem_id/os_default_templates/:id
Update a default template combination for an operating system

Examples

PUT /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates/980190962
{
  "os_default_template": {
    "provisioning_template_id": 821548108,
    "template_kind_id": 452984334
  }
}
200
{
  "id": 980190962,
  "provisioning_template_id": 821548108,
  "provisioning_template_name": "PXELinux default local boot",
  "template_kind_id": 452984334,
  "template_kind_name": "PXELinux",
  "operatingsystem_id": 1073012828,
  "operatingsystem_name": "RHEL 6.1"
}

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
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String
id
required

Validations:

  • Must be a String
os_default_template
required

Validations:

  • Must be a Hash
os_default_template[template_kind_id]
optional , nil allowed

Validations:

  • Must be a number.
os_default_template[provisioning_template_id]
optional , nil allowed

ID of provisioning template

Validations:

  • Must be a number.
>>>

DELETE /api/operatingsystems/:operatingsystem_id/os_default_templates/:id
Delete a default template combination for an operating system

Examples

DELETE /api/operatingsystems/1073012828-RHEL%206-1/os_default_templates/980190962
{
  "os_default_template": {}
}
200
{
  "id": 980190962,
  "provisioning_template_id": 943779058,
  "template_kind_id": 698706415,
  "operatingsystem_id": 1073012828,
  "created_at": "2020-11-04T13:51:50.393Z",
  "updated_at": "2020-11-04T13:51:50.393Z"
}

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
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String
id
required

Validations:

  • Must be a String