GET /api/config_templates 200 { "total": 14, "subtotal": 14, "page": 1, "per_page": 20, "search": null, "sort": { "by": null, "order": null }, "results": [ { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 1007981701, "name": "centos5_3_pxelinux", "template_kind_id": 452984334, "template_kind_name": "PXELinux" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 698706415, "name": "iPXE Dummy Menu", "template_kind_id": 698706415, "template_kind_name": "iPXE" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 718456980, "name": "Locked Template", "template_kind_id": 983253650, "template_kind_name": "provision" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 104314179, "name": "MyFinish", "template_kind_id": 550103832, "template_kind_name": "finish" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 981457253, "name": "MyScript", "template_kind_id": 478250810, "template_kind_name": "script" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 943779058, "name": "MyString", "template_kind_id": 698706415, "template_kind_name": "iPXE" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 269958254, "name": "MyString2", "template_kind_id": 983253650, "template_kind_name": "provision" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 684651467, "name": "PXE Default Menu", "template_kind_id": 710512633, "template_kind_name": null }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 554905648, "name": "PXEGrub2 global default", "template_kind_id": 701398793, "template_kind_name": "PXEGrub2" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 131565194, "name": "PXEGrub Dummy Menu", "template_kind_id": 131565194, "template_kind_name": "PXEGrub" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 824224502, "name": "PXEGrub global default", "template_kind_id": 131565194, "template_kind_name": "PXEGrub" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 821548108, "name": "PXELinux default local boot", "template_kind_id": 452984334, "template_kind_name": "PXELinux" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 352050261, "name": "PXELinux global default", "template_kind_id": 452984334, "template_kind_name": "PXELinux" }, { "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 56083308, "name": "suse_pxelinux", "template_kind_id": 452984334, "template_kind_name": "PXELinux" } ] }
Param name | Description |
---|---|
operatingsystem_id optional |
ID of operating system Validations:
|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
search optional |
filter results Validations:
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return Validations:
|
Field name | Type | Possible values |
---|---|---|
default_template | true, false | |
environment | string | |
hostgroup | string | |
kind | string | |
location | string | |
location_id | integer | |
locked | true, false | |
name | string | |
operatingsystem | string | |
organization | string | |
organization_id | integer | |
snippet | true, false | |
template | text | |
vendor | string |
GET /api/config_templates/1007981701-centos5_3_pxelinux 200 { "template": "default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\"kickstart\")%> ksdevice=bootif network kssendmac", "locked": false, "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 1007981701, "name": "centos5_3_pxelinux", "template_kind_id": 452984334, "template_kind_name": "PXELinux", "template_combinations": [], "operatingsystems": [ { "id": 309172073, "name": "centos", "title": "centos 5.3" }, { "id": 1073012828, "name": "Redhat", "title": "RHEL 6.1" }, { "id": 331303656, "name": "Ubuntu", "title": "Ubuntu 10.10" } ], "os_default_templates": [ { "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", "config_template_id": 1007981701, "config_template_name": "centos5_3_pxelinux" }, { "id": 638205575, "provisioning_template_id": 1007981701, "provisioning_template_name": "centos5_3_pxelinux", "template_kind_id": 710512633, "template_kind_name": null, "operatingsystem_id": 331303656, "operatingsystem_name": "Ubuntu 10.10", "config_template_id": 1007981701, "config_template_name": "centos5_3_pxelinux" } ], "locations": [], "organizations": [] }
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:
|
POST /api/config_templates { "config_template": {} } 422 { "error": { "id": null, "errors": { "name": [ "can't be blank" ], "template": [ "can't be blank" ], "template_kind_id": [ "can't be blank" ] }, "full_messages": [ "Name can't be blank", "Template can't be blank", "Template kind can't be blank" ] } }
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:
|
config_template required |
Validations:
|
config_template[name] required |
template name Validations:
|
config_template[description] optional , nil allowed |
Validations:
|
config_template[template] required |
Validations:
|
config_template[snippet] optional , nil allowed |
Validations:
|
config_template[audit_comment] optional , nil allowed |
Validations:
|
config_template[template_kind_id] optional , nil allowed |
not relevant for snippet Validations:
|
config_template[template_combinations_attributes] optional , nil allowed |
Array of template combinations (hostgroup_id, environment_id) Validations:
|
config_template[operatingsystem_ids] optional , nil allowed |
Array of operating system IDs to associate with the template Validations:
|
config_template[locked] optional , nil allowed |
Whether or not the template is locked for editing Validations:
|
config_template[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
config_template[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
PUT /api/config_templates/1007981701-centos5_3_pxelinux { "operatingsystem_ids": [ "442321401-Solaris 5-10" ], "config_template": { "operatingsystem_ids": [ "442321401-Solaris 5-10" ] } } 200 { "template": "default linux~label linux~kernel <%= @kernel %>~append initrd=<%= @initrd %> ks=<%= foreman_url(\"kickstart\")%> ksdevice=bootif network kssendmac", "locked": false, "snippet": false, "audit_comment": null, "created_at": "2019-11-07 08:35:49 UTC", "updated_at": "2019-11-07 08:35:49 UTC", "id": 1007981701, "name": "centos5_3_pxelinux", "template_kind_id": 452984334, "template_kind_name": "PXELinux", "template_combinations": [], "operatingsystems": [ { "id": 442321401, "name": "Solaris", "title": "Solaris 5.10" } ], "os_default_templates": [ { "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", "config_template_id": 1007981701, "config_template_name": "centos5_3_pxelinux" }, { "id": 638205575, "provisioning_template_id": 1007981701, "provisioning_template_name": "centos5_3_pxelinux", "template_kind_id": 710512633, "template_kind_name": null, "operatingsystem_id": 331303656, "operatingsystem_name": "Ubuntu 10.10", "config_template_id": 1007981701, "config_template_name": "centos5_3_pxelinux" } ], "locations": [], "organizations": [] }
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:
|
config_template required |
Validations:
|
config_template[name] optional |
template name Validations:
|
config_template[description] optional , nil allowed |
Validations:
|
config_template[template] optional |
Validations:
|
config_template[snippet] optional , nil allowed |
Validations:
|
config_template[audit_comment] optional , nil allowed |
Validations:
|
config_template[template_kind_id] optional , nil allowed |
not relevant for snippet Validations:
|
config_template[template_combinations_attributes] optional , nil allowed |
Array of template combinations (hostgroup_id, environment_id) Validations:
|
config_template[operatingsystem_ids] optional , nil allowed |
Array of operating system IDs to associate with the template Validations:
|
config_template[locked] optional , nil allowed |
Whether or not the template is locked for editing Validations:
|
config_template[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
config_template[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. 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:
|
version optional |
template version Validations:
|
DELETE /api/config_templates/1007981701-centos5_3_pxelinux { "config_template": {} } 422 { "error": { "id": 1007981701, "errors": { "base": [ "centos5_3_pxelinux is used by Redhat 6.1 - ", "centos5_3_pxelinux is used by Ubuntu 10.10 - " ] }, "full_messages": [ "centos5_3_pxelinux is used by Redhat 6.1 - ", "centos5_3_pxelinux is used by Ubuntu 10.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:
|
id required |
Validations:
|
POST /api/config_templates/build_pxe_default { "config_template": {} } 200 { "message": "PXE files for templates PXEGrub2 global default, PXELinux global default, and PXEGrub global default have been deployed to all Smart Proxies" }
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:
|
POST /api/config_templates/1007981701-centos5_3_pxelinux/clone { "config_template": { "name": "" } } 422 { "error": { "id": null, "errors": { "name": [ "can't be blank" ], "operatingsystems": [ "is invalid" ] }, "full_messages": [ "Name can't be blank", "Operatingsystems is invalid" ] } }
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:
|
config_template required |
Validations:
|
config_template[name] required |
template name Validations:
|