GET /api/config_templates
列出佈建範本

GET /api/operatingsystems/:operatingsystem_id/config_templates
列出各個作業系統的佈建範本

GET /api/locations/:location_id/config_templates
列出各個位置上的佈建範本

GET /api/organizations/:organization_id/config_templates
列出各個組織的佈建範本

示例

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"
    }
  ]
}

參數

參數名字 描述
operatingsystem_id
選填

作業系統 ID

Validations:

  • Must be a String

location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

search
選填

篩選結果

Validations:

  • Must be a String

order
選填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
選填

頁數,從 1 開始

Validations:

  • Must be a number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

Search fields

Field name 類型 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/:id
顯示佈建範本的詳情

示例

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": []
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/config_templates
建立佈建範本

示例

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"
    ]
  }
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

config_template
必填

Validations:

  • Must be a Hash

config_template[name]
必填

範本名稱

Validations:

  • Must be a String

config_template[description]
選填 , 允許空值

Validations:

  • Must be a String

config_template[template]
必填

Validations:

  • Must be a String

config_template[snippet]
選填 , 允許空值

Validations:

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

config_template[audit_comment]
選填 , 允許空值

Validations:

  • Must be a String

config_template[template_kind_id]
選填 , 允許空值

與程式碼片段不相關

Validations:

  • Must be a number.

config_template[template_combinations_attributes]
選填 , 允許空值

範本組合陣列(hostgroup_id、environment_id)

Validations:

  • Must be an array of any type

config_template[operatingsystem_ids]
選填 , 允許空值

與範本相關連的作業系統 ID 之陣列

Validations:

  • Must be an array of any type

config_template[locked]
選填 , 允許空值

範本是否鎖定並禁止進行編輯

Validations:

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

config_template[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

config_template[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


PUT /api/config_templates/:id
更新佈建範本

示例

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": []
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

config_template
必填

Validations:

  • Must be a Hash

config_template[name]
選填

範本名稱

Validations:

  • Must be a String

config_template[description]
選填 , 允許空值

Validations:

  • Must be a String

config_template[template]
選填

Validations:

  • Must be a String

config_template[snippet]
選填 , 允許空值

Validations:

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

config_template[audit_comment]
選填 , 允許空值

Validations:

  • Must be a String

config_template[template_kind_id]
選填 , 允許空值

與程式碼片段不相關

Validations:

  • Must be a number.

config_template[template_combinations_attributes]
選填 , 允許空值

範本組合陣列(hostgroup_id、environment_id)

Validations:

  • Must be an array of any type

config_template[operatingsystem_ids]
選填 , 允許空值

與範本相關連的作業系統 ID 之陣列

Validations:

  • Must be an array of any type

config_template[locked]
選填 , 允許空值

範本是否鎖定並禁止進行編輯

Validations:

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

config_template[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

config_template[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


GET /api/config_templates/revision

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

version
選填

範本版本

Validations:

  • Must be a String


DELETE /api/config_templates/:id
刪除佈建範本

示例

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 - "
    ]
  }
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/config_templates/build_pxe_default
更新所有經過配置的 TFTP 伺服器上的預設 PXE 選單

示例

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"
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer


POST /api/config_templates/:id/clone
複製佈建範本

示例

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"
    ]
  }
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

config_template
必填

Validations:

  • Must be a Hash

config_template[name]
必填

範本名稱

Validations:

  • Must be a String