GET /api/hostgroups 200 { "total": 6, "subtotal": 6, "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", "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": "2021-09-01 12:55:45 UTC", "updated_at": "2021-09-01 12:55:45 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, "inherited_compute_profile_id": null, "inherited_domain_id": null, "inherited_puppet_proxy_id": null, "inherited_puppet_ca_proxy_id": null, "inherited_compute_resource_id": null, "inherited_operatingsystem_id": null, "inherited_architecture_id": null, "inherited_medium_id": null, "inherited_ptable_id": null, "inherited_subnet_id": null, "inherited_subnet6_id": null, "inherited_realm_id": null, "inherited_pxe_loader": null, "facet_param": "bar" }, { "subnet_id": null, "subnet_name": null, "operatingsystem_id": 309172073, "operatingsystem_name": "centos 5.3", "domain_id": null, "domain_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": 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": "2021-09-01 12:55:45 UTC", "updated_at": "2021-09-01 12:55:45 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, "inherited_compute_profile_id": null, "inherited_domain_id": null, "inherited_puppet_proxy_id": null, "inherited_puppet_ca_proxy_id": null, "inherited_compute_resource_id": null, "inherited_operatingsystem_id": null, "inherited_architecture_id": null, "inherited_medium_id": null, "inherited_ptable_id": null, "inherited_subnet_id": null, "inherited_subnet6_id": null, "inherited_realm_id": null, "inherited_pxe_loader": null, "facet_param": "bar" }, { "subnet_id": null, "subnet_name": null, "operatingsystem_id": null, "operatingsystem_name": null, "domain_id": null, "domain_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": "2021-09-01 12:55:52 UTC", "updated_at": "2021-09-01 12:55:52 UTC", "id": 928644291, "name": "hostgroup172", "title": "hostgroup172", "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, "inherited_compute_profile_id": null, "inherited_domain_id": null, "inherited_puppet_proxy_id": null, "inherited_puppet_ca_proxy_id": null, "inherited_compute_resource_id": null, "inherited_operatingsystem_id": null, "inherited_architecture_id": null, "inherited_medium_id": null, "inherited_ptable_id": null, "inherited_subnet_id": null, "inherited_subnet6_id": null, "inherited_realm_id": null, "inherited_pxe_loader": null, "facet_param": "bar" }, { "subnet_id": 1018350795, "subnet_name": "five", "operatingsystem_id": 309172073, "operatingsystem_name": "centos 5.3", "domain_id": 22495316, "domain_name": "mydomain.net", "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": "2021-09-01 12:55:45 UTC", "updated_at": "2021-09-01 12:55:45 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" }, "inherited_compute_profile_id": null, "inherited_domain_id": null, "inherited_puppet_proxy_id": null, "inherited_puppet_ca_proxy_id": null, "inherited_compute_resource_id": null, "inherited_operatingsystem_id": null, "inherited_architecture_id": null, "inherited_medium_id": null, "inherited_ptable_id": null, "inherited_subnet_id": null, "inherited_subnet6_id": null, "inherited_realm_id": null, "inherited_pxe_loader": null, "facet_param": "bar" }, { "subnet_id": null, "subnet_name": "five", "operatingsystem_id": null, "operatingsystem_name": "centos 5.3", "domain_id": null, "domain_name": "mydomain.net", "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": "2021-09-01 12:55:45 UTC", "updated_at": "2021-09-01 12:55:45 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" }, "inherited_compute_profile_id": 980190962, "inherited_domain_id": 22495316, "inherited_puppet_proxy_id": 182953976, "inherited_puppet_ca_proxy_id": 182953976, "inherited_compute_resource_id": null, "inherited_operatingsystem_id": 309172073, "inherited_architecture_id": 501905019, "inherited_medium_id": 980190962, "inherited_ptable_id": 615088209, "inherited_subnet_id": 1018350795, "inherited_subnet6_id": 51848956, "inherited_realm_id": null, "inherited_pxe_loader": "PXELinux BIOS", "facet_param": "bar" }, { "subnet_id": null, "subnet_name": null, "operatingsystem_id": null, "operatingsystem_name": null, "domain_id": null, "domain_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": "2021-09-01 12:55:45 UTC", "updated_at": "2021-09-01 12:55:45 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, "inherited_compute_profile_id": null, "inherited_domain_id": null, "inherited_puppet_proxy_id": null, "inherited_puppet_ca_proxy_id": null, "inherited_compute_resource_id": null, "inherited_operatingsystem_id": null, "inherited_architecture_id": null, "inherited_medium_id": null, "inherited_ptable_id": null, "inherited_subnet_id": null, "inherited_subnet6_id": null, "inherited_realm_id": null, "inherited_pxe_loader": null, "facet_param": "bar" } ] }
Param name | Description |
---|---|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
search optional |
filter results Validations:
|
order optional |
Sort and order by a searchable field, e.g. ‘id DESC’ Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return, ‘all’ to return all results Validations:
|
include optional |
Array of extra information types to include Validations:
|
Field name | Type | Possible values |
---|---|---|
architecture | 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 | string | |
template | string | |
title | string |
GET /api/hostgroups/928644287 200 { "subnet_id": null, "subnet_name": null, "operatingsystem_id": null, "operatingsystem_name": null, "domain_id": null, "domain_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": "2021-09-01 12:39:41 UTC", "updated_at": "2021-09-01 12:39:41 UTC", "id": 928644287, "name": "hostgroup165", "title": "hostgroup165", "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, "inherited_compute_profile_id": null, "inherited_domain_id": null, "inherited_puppet_proxy_id": null, "inherited_puppet_ca_proxy_id": null, "inherited_compute_resource_id": null, "inherited_operatingsystem_id": null, "inherited_architecture_id": null, "inherited_medium_id": null, "inherited_ptable_id": null, "inherited_subnet_id": null, "inherited_subnet6_id": null, "inherited_realm_id": null, "inherited_pxe_loader": null, "parameters": [ { "priority": 60, "created_at": "2021-09-01 12:39:41 UTC", "updated_at": "2021-09-01 12:39:41 UTC", "id": 767575239, "name": "foo", "parameter_type": "integer", "value": 42 } ], "template_combinations": [], "locations": [ { "id": 255093256, "name": "Location 1", "title": "Location 1", "description": null } ], "organizations": [ { "id": 447626438, "name": "Organization 1", "title": "Organization 1", "description": null } ] }
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:
|
show_hidden_parameters optional |
Display hidden parameter values Validations:
|
POST /api/hostgroups { "hostgroup": { "name": "TestHostgroup", "parameters": [ { "name": "foo", "value": 42, "parameter_type": "integer" } ] } } 201 { "subnet_id": null, "subnet_name": null, "operatingsystem_id": null, "operatingsystem_name": null, "domain_id": null, "domain_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": "2021-09-01 12:39:41 UTC", "updated_at": "2021-09-01 12:39:41 UTC", "id": 928644286, "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, "inherited_compute_profile_id": null, "inherited_domain_id": null, "inherited_puppet_proxy_id": null, "inherited_puppet_ca_proxy_id": null, "inherited_compute_resource_id": null, "inherited_operatingsystem_id": null, "inherited_architecture_id": null, "inherited_medium_id": null, "inherited_ptable_id": null, "inherited_subnet_id": null, "inherited_subnet6_id": null, "inherited_realm_id": null, "inherited_pxe_loader": null, "parameters": [], "template_combinations": [], "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:
|
hostgroup required |
Validations:
|
hostgroup[name] required |
Name of the host group Validations:
|
hostgroup[description] optional , nil allowed |
Host group description Validations:
|
hostgroup[parent_id] optional , nil allowed |
Parent ID of the host group Validations:
|
hostgroup[compute_profile_id] optional , nil allowed |
Compute profile ID Validations:
|
hostgroup[compute_resource_id] optional , nil allowed |
Compute resource ID Validations:
|
hostgroup[operatingsystem_id] optional , nil allowed |
Operating system ID Validations:
|
hostgroup[architecture_id] optional , nil allowed |
Architecture ID Validations:
|
hostgroup[pxe_loader] optional , nil allowed |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
hostgroup[medium_id] optional , nil allowed |
Media ID Validations:
|
hostgroup[ptable_id] optional , nil allowed |
Partition table ID Validations:
|
hostgroup[subnet_id] optional , nil allowed |
Subnet ID Validations:
|
hostgroup[subnet6_id] optional , nil allowed |
Subnet IPv6 ID Validations:
|
hostgroup[domain_id] optional , nil allowed |
Domain ID Validations:
|
hostgroup[realm_id] optional , nil allowed |
Realm ID Validations:
|
hostgroup[group_parameters_attributes] optional , nil allowed |
Array of parameters Validations:
|
hostgroup[group_parameters_attributes][name] required |
Name of the parameter Validations:
|
hostgroup[group_parameters_attributes][value] required |
Parameter value Validations:
|
hostgroup[group_parameters_attributes][parameter_type] optional , nil allowed |
Type of value Validations:
|
hostgroup[group_parameters_attributes][hidden_value] optional , nil allowed |
Validations:
|
hostgroup[puppet_proxy_id] optional , nil allowed |
Puppet proxy ID Validations:
|
hostgroup[puppet_ca_proxy_id] optional , nil allowed |
Puppet CA proxy ID Validations:
|
hostgroup[root_pass] optional , nil allowed |
Root password on provisioned hosts Validations:
|
hostgroup[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
hostgroup[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
PUT /api/hostgroups/928644286 { "hostgroup": { "group_parameters_attributes": [ { "name": "foo", "value": "new_value" } ] } } 200 { "subnet_id": null, "subnet_name": null, "operatingsystem_id": null, "operatingsystem_name": null, "domain_id": null, "domain_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": "2021-09-01 13:14:38 UTC", "updated_at": "2021-09-01 13:14:38 UTC", "id": 928644286, "name": "hostgroup179", "title": "hostgroup179", "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, "inherited_compute_profile_id": null, "inherited_domain_id": null, "inherited_puppet_proxy_id": null, "inherited_puppet_ca_proxy_id": null, "inherited_compute_resource_id": null, "inherited_operatingsystem_id": null, "inherited_architecture_id": null, "inherited_medium_id": null, "inherited_ptable_id": null, "inherited_subnet_id": null, "inherited_subnet6_id": null, "inherited_realm_id": null, "inherited_pxe_loader": null, "parameters": [ { "priority": 60, "created_at": "2021-09-01 13:14:39 UTC", "updated_at": "2021-09-01 13:14:39 UTC", "id": 767575239, "name": "foo", "parameter_type": "string", "value": "new_value" } ], "template_combinations": [], "locations": [ { "id": 255093256, "name": "Location 1", "title": "Location 1", "description": null } ], "organizations": [ { "id": 447626438, "name": "Organization 1", "title": "Organization 1", "description": null } ] }
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:
|
hostgroup required |
Validations:
|
hostgroup[name] optional |
Name of the host group Validations:
|
hostgroup[description] optional , nil allowed |
Host group description Validations:
|
hostgroup[parent_id] optional , nil allowed |
Parent ID of the host group Validations:
|
hostgroup[compute_profile_id] optional , nil allowed |
Compute profile ID Validations:
|
hostgroup[compute_resource_id] optional , nil allowed |
Compute resource ID Validations:
|
hostgroup[operatingsystem_id] optional , nil allowed |
Operating system ID Validations:
|
hostgroup[architecture_id] optional , nil allowed |
Architecture ID Validations:
|
hostgroup[pxe_loader] optional , nil allowed |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
hostgroup[medium_id] optional , nil allowed |
Media ID Validations:
|
hostgroup[ptable_id] optional , nil allowed |
Partition table ID Validations:
|
hostgroup[subnet_id] optional , nil allowed |
Subnet ID Validations:
|
hostgroup[subnet6_id] optional , nil allowed |
Subnet IPv6 ID Validations:
|
hostgroup[domain_id] optional , nil allowed |
Domain ID Validations:
|
hostgroup[realm_id] optional , nil allowed |
Realm ID Validations:
|
hostgroup[group_parameters_attributes] optional , nil allowed |
Array of parameters Validations:
|
hostgroup[group_parameters_attributes][name] optional |
Name of the parameter Validations:
|
hostgroup[group_parameters_attributes][value] optional |
Parameter value Validations:
|
hostgroup[group_parameters_attributes][parameter_type] optional , nil allowed |
Type of value Validations:
|
hostgroup[group_parameters_attributes][hidden_value] optional , nil allowed |
Validations:
|
hostgroup[puppet_proxy_id] optional , nil allowed |
Puppet proxy ID Validations:
|
hostgroup[puppet_ca_proxy_id] optional , nil allowed |
Puppet CA proxy ID Validations:
|
hostgroup[root_pass] optional , nil allowed |
Root password on provisioned hosts Validations:
|
hostgroup[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
hostgroup[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
DELETE /api/hostgroups/866317115-Unusual { "hostgroup": {} } 200 { "id": 866317115, "name": "Unusual", "created_at": "2021-09-01T13:14:37.063Z", "updated_at": "2021-09-01T13:14:37.063Z", "environment_id": null, "operatingsystem_id": null, "architecture_id": null, "medium_id": null, "ptable_id": null, "root_pass": null, "puppet_ca_proxy_id": null, "use_image": null, "image_file": "", "ancestry": null, "vm_defaults": null, "subnet_id": null, "domain_id": null, "puppet_proxy_id": 182953976, "title": "Unusual", "realm_id": null, "compute_profile_id": null, "grub_pass": "", "lookup_value_matcher": "hostgroup=Unusual", "subnet6_id": null, "pxe_loader": null, "description": null, "compute_resource_id": null }
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/hostgroups/636252244/clone { "name": "GaeUjaFeKw", "hostgroup": { "name": "GaeUjaFeKw" } } 201 { "id": 928644294, "name": "GaeUjaFeKw", "created_at": "2021-09-01T13:14:45.323Z", "updated_at": "2021-09-01T13:14:45.323Z", "environment_id": null, "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": "GaeUjaFeKw", "realm_id": null, "compute_profile_id": 980190962, "grub_pass": "$1$foreman$NW1XVtbk4/XkJqmKNrFWV0", "lookup_value_matcher": "hostgroup=GaeUjaFeKw", "subnet6_id": null, "pxe_loader": null, "description": null, "compute_resource_id": null }
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:
|
name required |
Validations:
|
POST /api/hostgroups/928644293-hostgroup183/rebuild_config { "only": [ "TFTP" ], "hostgroup": {} } 200 { "message": "Configuration successfully rebuilt." }
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:
|
only optional |
Limit rebuild steps, valid steps are DHCP, DNS, TFTP Validations:
|
children_hosts optional |
Operate on child hostgroup hosts Validations:
|