GET /api/hostgroups
列出所有主機群組

GET /api/puppetclasses/:puppetclass_id/hostgroups
列出 Puppet 類別的所有主機群組

GET /api/locations/:location_id/hostgroups
列出各個位置上的所有主機群組

GET /api/organizations/:organization_id/hostgroups
列出各個組織中的所有主機群組

參數

參數名字 描述
puppetclass_id
選填

Puppet 類別的 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
選填

排序結果

Validations:

  • Must be a String

page
選填

編頁結果

Validations:

  • Must be a String

per_page
選填

每個請求的項目數量

Validations:

  • Must be a String

include
選填

Array of extra information types to include

Validations:

  • Must be an array of [“parameters”]


GET /api/hostgroups/:id
顯示主機群組

參數

參數名字 描述
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.

show_hidden_parameters
選填

Display hidden parameter values

Validations:

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


POST /api/hostgroups
建立主機群組

參數

參數名字 描述
hostgroup
必填

Validations:

  • Must be a Hash

hostgroup[name]
必填

主機群組的名稱

Validations:

  • Must be a String

hostgroup[description]
選填 , 允許空值

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
選填 , 允許空值

主機群組的父 ID

Validations:

  • Must be a number.

hostgroup[environment_id]
選填 , 允許空值

環境 ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
選填 , 允許空值

運算設定檔 ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
選填 , 允許空值

作業系統 ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
選填 , 允許空值

架構 ID

Validations:

  • Must be a number.

hostgroup[pxe_loader]
選填 , 允許空值

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
選填 , 允許空值

媒體 ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
選填 , 允許空值

分割表 ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
選填 , 允許空值

子網路 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
選填 , 允許空值

網域 ID

Validations:

  • Must be a number.

hostgroup[realm_id]
選填 , 允許空值

領域類型

Validations:

  • Must be a number.

hostgroup[config_group_ids]
選填 , 允許空值

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
選填 , 允許空值

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
必填

參數名稱

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
必填

參數值

Validations:

  • Must be a String

hostgroup[puppet_proxy_id]
選填 , 允許空值

Puppet 代理 ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
選填 , 允許空值

Puppet CA 代理 ID

Validations:

  • Must be a number.

hostgroup[root_pass]
選填 , 允許空值

在已佈建主機上的 root 密碼

Validations:

  • Must be a String

hostgroup[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


PUT /api/hostgroups/:id
更新主機群組

參數

參數名字 描述
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.

hostgroup
必填

Validations:

  • Must be a Hash

hostgroup[name]
選填

主機群組的名稱

Validations:

  • Must be a String

hostgroup[description]
選填 , 允許空值

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
選填 , 允許空值

主機群組的父 ID

Validations:

  • Must be a number.

hostgroup[environment_id]
選填 , 允許空值

環境 ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
選填 , 允許空值

運算設定檔 ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
選填 , 允許空值

作業系統 ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
選填 , 允許空值

架構 ID

Validations:

  • Must be a number.

hostgroup[pxe_loader]
選填 , 允許空值

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
選填 , 允許空值

媒體 ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
選填 , 允許空值

分割表 ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
選填 , 允許空值

子網路 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
選填 , 允許空值

網域 ID

Validations:

  • Must be a number.

hostgroup[realm_id]
選填 , 允許空值

領域類型

Validations:

  • Must be a number.

hostgroup[config_group_ids]
選填 , 允許空值

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
選填 , 允許空值

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
選填

參數名稱

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
選填

參數值

Validations:

  • Must be a String

hostgroup[puppet_proxy_id]
選填 , 允許空值

Puppet 代理 ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
選填 , 允許空值

Puppet CA 代理 ID

Validations:

  • Must be a number.

hostgroup[root_pass]
選填 , 允許空值

在已佈建主機上的 root 密碼

Validations:

  • Must be a String

hostgroup[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


DELETE /api/hostgroups/:id
刪除主機群組

參數

參數名字 描述
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/hostgroups/:id/clone
複製主機群組

參數

參數名字 描述
name
必填

Validations:

  • Must be a String


PUT /api/hostgroups/:id/rebuild_config
重建協調配置

參數

參數名字 描述
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.

only
選填

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type

children_hosts
選填

Operate on child hostgroup hosts

Validations:

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