GET /api/hostgroups
すべてのホストグループを一覧表示

GET /api/puppetclasses/:puppetclass_id/hostgroups
Puppet クラスのすべてのホストグループを一覧表示

GET /api/locations/:location_id/hostgroups
ロケーションごとにすべてのホストグループを一覧表示

GET /api/organizations/:organization_id/hostgroups
組織ごとにすべてのホストグループを一覧表示

GET /api/hostgroups
200
{
  "total": 5,
  "subtotal": 5,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "operatingsystem_id": 309172073,
      "operatingsystem_name": "centos 5.3",
      "domain_id": 22495316,
      "domain_name": "mydomain.net",
      "environment_id": 334344675,
      "environment_name": "production",
      "compute_profile_id": 980190962,
      "compute_profile_name": "1-Small",
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "ptable_id": null,
      "ptable_name": null,
      "medium_id": 980190962,
      "medium_name": "CentOS 5.4",
      "pxe_loader": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": 501905019,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-09-11 14:32:19 UTC",
      "updated_at": "2019-09-11 14:32:19 UTC",
      "id": 636252244,
      "name": "Common",
      "title": "Common",
      "description": null,
      "puppet_proxy_id": 182953976,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": null,
      "puppet_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "puppet_ca_proxy": null,
      "parameters": [
        {
          "priority": null,
          "created_at": "2019-09-11 14:32:19 UTC",
          "updated_at": "2019-09-11 14:32:19 UTC",
          "id": 767575238,
          "name": "group1",
          "parameter_type": null,
          "value": "group1"
        }
      ]
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "operatingsystem_id": 309172073,
      "operatingsystem_name": "centos 5.3",
      "domain_id": null,
      "domain_name": null,
      "environment_id": 334344675,
      "environment_name": "production",
      "compute_profile_id": null,
      "compute_profile_name": null,
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "ptable_id": null,
      "ptable_name": null,
      "medium_id": 980190962,
      "medium_name": "CentOS 5.4",
      "pxe_loader": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": 501905019,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-09-11 14:32:19 UTC",
      "updated_at": "2019-09-11 14:32:19 UTC",
      "id": 603241515,
      "name": "db",
      "title": "db",
      "description": null,
      "puppet_proxy_id": 182953976,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": null,
      "puppet_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "puppet_ca_proxy": null,
      "parameters": []
    },
    {
      "subnet_id": 1018350795,
      "subnet_name": "five",
      "operatingsystem_id": 309172073,
      "operatingsystem_name": "centos 5.3",
      "domain_id": 22495316,
      "domain_name": "mydomain.net",
      "environment_id": 153855663,
      "environment_name": "global_puppetmaster",
      "compute_profile_id": 980190962,
      "compute_profile_name": "1-Small",
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "ptable_id": 615088209,
      "ptable_name": "Example partition table",
      "medium_id": 980190962,
      "medium_name": "CentOS 5.4",
      "pxe_loader": "PXELinux BIOS",
      "subnet6_id": 51848956,
      "subnet6_name": "six",
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": 501905019,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-09-11 14:32:19 UTC",
      "updated_at": "2019-09-11 14:32:19 UTC",
      "id": 1,
      "name": "Parent",
      "title": "Parent",
      "description": null,
      "puppet_proxy_id": 182953976,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": 182953976,
      "puppet_ca_proxy_name": "Puppetmaster Proxy",
      "puppet_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "puppet_ca_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "parameters": []
    },
    {
      "subnet_id": null,
      "subnet_name": "five",
      "operatingsystem_id": null,
      "operatingsystem_name": "centos 5.3",
      "domain_id": null,
      "domain_name": "mydomain.net",
      "environment_id": 334344675,
      "environment_name": "production",
      "compute_profile_id": null,
      "compute_profile_name": "1-Small",
      "ancestry": "1",
      "parent_id": 1,
      "parent_name": "Parent",
      "ptable_id": null,
      "ptable_name": "Example partition table",
      "medium_id": null,
      "medium_name": "CentOS 5.4",
      "pxe_loader": "PXELinux BIOS",
      "subnet6_id": null,
      "subnet6_name": "six",
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": null,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-09-11 14:32:19 UTC",
      "updated_at": "2019-09-11 14:32:19 UTC",
      "id": 928644285,
      "name": "inherited",
      "title": "Parent/inherited",
      "description": null,
      "puppet_proxy_id": null,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": "Puppetmaster Proxy",
      "puppet_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "puppet_ca_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "parameters": []
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "operatingsystem_id": null,
      "operatingsystem_name": null,
      "domain_id": null,
      "domain_name": null,
      "environment_id": null,
      "environment_name": null,
      "compute_profile_id": null,
      "compute_profile_name": null,
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "ptable_id": null,
      "ptable_name": null,
      "medium_id": null,
      "medium_name": null,
      "pxe_loader": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": null,
      "architecture_name": null,
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-09-11 14:32:19 UTC",
      "updated_at": "2019-09-11 14:32:19 UTC",
      "id": 866317115,
      "name": "Unusual",
      "title": "Unusual",
      "description": null,
      "puppet_proxy_id": 182953976,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": null,
      "puppet_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "puppet_ca_proxy": null,
      "parameters": []
    }
  ]
}

パラメーター

パラメーター名 記述
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
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

include
任意

含める追加の情報タイプの配列

Validations:

  • Must be an array of [parameters]

検索フィールド

フィールド名 タイプ 設定可能な値
architecture string
class string
config_group string
environment string
host string
id integer
label string
location string
location_id integer
medium string
name string
organization string
organization_id integer
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
params text
template string
title string

GET /api/hostgroups/:id
ホストグループの表示

GET /api/hostgroups/928644287-hostgroup5
200
{
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "domain_id": null,
  "domain_name": null,
  "environment_id": null,
  "environment_name": null,
  "compute_profile_id": null,
  "compute_profile_name": null,
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "pxe_loader": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "realm_id": null,
  "realm_name": null,
  "created_at": "2019-09-11 14:32:23 UTC",
  "updated_at": "2019-09-11 14:32:23 UTC",
  "id": 928644287,
  "name": "hostgroup5",
  "title": "hostgroup5",
  "description": null,
  "puppet_proxy_id": null,
  "puppet_proxy_name": null,
  "puppet_ca_proxy_id": null,
  "puppet_ca_proxy_name": null,
  "puppet_proxy": null,
  "puppet_ca_proxy": null,
  "parameters": [
    {
      "priority": 60,
      "created_at": "2019-09-11 14:32:23 UTC",
      "updated_at": "2019-09-11 14:32:23 UTC",
      "id": 767575240,
      "name": "parameter5",
      "parameter_type": null,
      "value": "parameter value 5"
    }
  ],
  "template_combinations": [],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

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.

show_hidden_parameters
任意

非表示のパラメーター値の表示

Validations:

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


POST /api/hostgroups
ホストグループの作成

POST /api/hostgroups
{
  "hostgroup": {
    "name": "TestHostgroup"
  }
}
201
{
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "domain_id": null,
  "domain_name": null,
  "environment_id": null,
  "environment_name": null,
  "compute_profile_id": null,
  "compute_profile_name": null,
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "pxe_loader": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "realm_id": null,
  "realm_name": null,
  "created_at": "2019-09-11 14:32:24 UTC",
  "updated_at": "2019-09-11 14:32:24 UTC",
  "id": 928644288,
  "name": "TestHostgroup",
  "title": "TestHostgroup",
  "description": null,
  "puppet_proxy_id": null,
  "puppet_proxy_name": null,
  "puppet_ca_proxy_id": null,
  "puppet_ca_proxy_name": null,
  "puppet_proxy": null,
  "puppet_ca_proxy": null,
  "parameters": [],
  "template_combinations": [],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "locations": [],
  "organizations": []
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

hostgroup
必須

Validations:

  • Must be a Hash

hostgroup[name]
必須

ホストグループの名前

Validations:

  • Must be a String

hostgroup[description]
任意 , nil可

ホストグループの説明

Validations:

  • Must be a String

hostgroup[parent_id]
任意 , nil可

ホストグループの親 ID

Validations:

  • Must be a number.

hostgroup[environment_id]
任意 , nil可

環境 ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
任意 , nil可

コンピュートプロファイル ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
任意 , nil可

コンピュートリソース ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
任意 , nil可

オペレーティングシステム ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
任意 , nil可

アーキテクチャー ID

Validations:

  • Must be a number.

hostgroup[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

hostgroup[medium_id]
任意 , nil可

メディア ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
任意 , nil可

パーティションテーブル ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
任意 , nil可

サブネット ID

Validations:

  • Must be a number.

hostgroup[subnet6_id]
任意 , nil可

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
任意 , nil可

ドメイン ID

Validations:

  • Must be a number.

hostgroup[realm_id]
任意 , nil可

レルム ID

Validations:

  • Must be a number.

hostgroup[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
任意 , nil可

パラメーターの配列

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]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

hostgroup[root_pass]
任意 , nil可

プロビジョニングされたホストの root パスワード

Validations:

  • Must be a String

hostgroup[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


PUT /api/hostgroups/:id
ホストグループの更新

PUT /api/hostgroups/636252244
{
  "hostgroup": {
    "name": ""
  }
}
422
{
  "error": {
    "id": 636252244,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

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.

hostgroup
必須

Validations:

  • Must be a Hash

hostgroup[name]
任意

ホストグループの名前

Validations:

  • Must be a String

hostgroup[description]
任意 , nil可

ホストグループの説明

Validations:

  • Must be a String

hostgroup[parent_id]
任意 , nil可

ホストグループの親 ID

Validations:

  • Must be a number.

hostgroup[environment_id]
任意 , nil可

環境 ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
任意 , nil可

コンピュートプロファイル ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
任意 , nil可

コンピュートリソース ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
任意 , nil可

オペレーティングシステム ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
任意 , nil可

アーキテクチャー ID

Validations:

  • Must be a number.

hostgroup[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

hostgroup[medium_id]
任意 , nil可

メディア ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
任意 , nil可

パーティションテーブル ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
任意 , nil可

サブネット ID

Validations:

  • Must be a number.

hostgroup[subnet6_id]
任意 , nil可

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
任意 , nil可

ドメイン ID

Validations:

  • Must be a number.

hostgroup[realm_id]
任意 , nil可

レルム ID

Validations:

  • Must be a number.

hostgroup[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
任意 , nil可

パラメーターの配列

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]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

hostgroup[root_pass]
任意 , nil可

プロビジョニングされたホストの root パスワード

Validations:

  • Must be a String

hostgroup[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


DELETE /api/hostgroups/:id
ホストグループの削除

DELETE /api/hostgroups/1-Parent
{
  "hostgroup": {}
}
409
{
  "message": "Cannot delete group Parent because it has nested host groups."
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

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/hostgroups/:id/clone
ホストグループのクローン作成

POST /api/hostgroups/636252244/clone
{
  "name": "sdpYHEctpz",
  "hostgroup": {
    "name": "sdpYHEctpz"
  }
}
201
{
  "id": 928644299,
  "name": "sdpYHEctpz",
  "created_at": "2019-09-11T14:32:26.077Z",
  "updated_at": "2019-09-11T14:32:26.077Z",
  "environment_id": 334344675,
  "operatingsystem_id": 309172073,
  "architecture_id": 501905019,
  "medium_id": 980190962,
  "ptable_id": null,
  "root_pass": "$1$foreman$NW1XVtbk4/XkJqmKNrFWV0",
  "puppet_ca_proxy_id": 182953976,
  "use_image": null,
  "image_file": "",
  "ancestry": null,
  "vm_defaults": null,
  "subnet_id": null,
  "domain_id": 22495316,
  "puppet_proxy_id": 182953976,
  "title": "sdpYHEctpz",
  "realm_id": null,
  "compute_profile_id": 980190962,
  "grub_pass": "$1$foreman$NW1XVtbk4/XkJqmKNrFWV0",
  "lookup_value_matcher": "hostgroup=sdpYHEctpz",
  "subnet6_id": null,
  "pxe_loader": null,
  "description": null,
  "compute_resource_id": null
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

name
必須

Validations:

  • Must be a String


PUT /api/hostgroups/:id/rebuild_config
オーケストレーション設定の再ビルド

POST /api/hostgroups/928644292-hostgroup7/rebuild_config
{
  "only": [
    "TFTP"
  ],
  "hostgroup": {}
}
200
{
  "message": "Configuration successfully rebuilt."
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

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.

only
任意

再ビルドのステップの制限。有効なステップは DHCP, DNS, TFTP です。

Validations:

  • Must be an array of any type

children_hosts
任意

子ホストグループのホストでの操作

Validations:

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