GET /api/hostgroups/928644289/hosts 200 { "total": 0, "subtotal": 0, "page": 1, "per_page": 20, "search": null, "sort": { "by": null, "order": null }, "results": [] }
Param name | Description |
---|---|
thin optional |
Only list ID and name of hosts Validations:
|
hostgroup_id optional |
ID of host group Validations:
|
location_id optional |
ID of location Validations:
|
organization_id optional |
ID of organization Validations:
|
environment_id optional |
ID of environment Validations:
|
include optional |
Array of extra information types to include 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, ‘all’ to return all results Validations:
|
Field name | Type | Possible values |
---|---|---|
architecture | string | |
boot_time | datetime | |
build | true, false | |
class | string | |
comment | text | |
compute_resource | string | |
compute_resource_id | integer | |
config_group | string | |
created_at | datetime | |
domain | string | |
domain_id | integer | |
environment | string | |
facts | string | |
global_status | ok, warning, error | |
has_ip | string | |
has_mac | string | |
hostgroup | string | |
hostgroup_fullname | string | |
hostgroup_id | integer | |
hostgroup_name | string | |
hostgroup_title | string | |
image | string | |
installed_at | datetime | |
ip | string | |
last_report | datetime | |
location | string | |
location_id | integer | |
mac | string | |
managed | true, false | |
model | string | |
name | string | |
organization | string | |
organization_id | integer | |
origin | string | |
os | string | |
os_description | string | |
os_id | integer | |
os_major | string | |
os_minor | string | |
os_title | string | |
owner | string | |
owner_id | integer | |
owner_type | string | |
params | string | |
params_name | string | |
parent_hostgroup | string | |
puppet_ca | string | |
puppet_proxy_id | integer | |
puppetmaster | string | |
realm | string | |
realm_id | integer | |
smart_proxy | string | |
status.applied | integer | |
status.enabled | true, false | |
status.failed | integer | |
status.failed_restarts | integer | |
status.interesting | true, false | |
status.pending | integer | |
status.restarted | integer | |
status.skipped | integer | |
subnet | string | |
subnet.name | text | |
subnet6 | string | |
subnet6.name | text | |
user.firstname | string | |
user.lastname | string | |
user.login | string | |
user.mail | string | |
usergroup | string | |
usergroup.name | string | |
uuid | string |
GET /api/hosts/41 200 { "ip": null, "ip6": null, "environment_id": null, "environment_name": null, "last_report": null, "mac": null, "realm_id": null, "realm_name": null, "sp_mac": null, "sp_ip": null, "sp_name": null, "domain_id": null, "domain_name": null, "architecture_id": null, "architecture_name": null, "operatingsystem_id": null, "operatingsystem_name": null, "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "sp_subnet_id": null, "ptable_id": null, "ptable_name": null, "medium_id": null, "medium_name": null, "pxe_loader": null, "build": false, "comment": null, "disk": null, "installed_at": null, "model_id": null, "hostgroup_id": null, "owner_id": 135138680, "owner_name": "Admin User", "owner_type": "User", "enabled": true, "managed": false, "use_image": null, "image_file": "", "uuid": null, "compute_resource_id": null, "compute_resource_name": null, "compute_profile_id": null, "compute_profile_name": null, "capabilities": [ "build" ], "provision_method": "build", "certname": "host2146", "image_id": null, "image_name": null, "created_at": "2020-05-20 13:40:11 UTC", "updated_at": "2020-05-20 13:40:11 UTC", "last_compile": null, "global_status": 0, "global_status_label": "OK", "uptime_seconds": null, "organization_id": 447626438, "organization_name": "Organization 1", "location_id": 255093256, "location_name": "Location 1", "puppet_status": 0, "model_name": null, "name": "host2146", "id": 41, "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, "hostgroup_name": null, "hostgroup_title": null, "parameters": [ { "priority": 70, "created_at": "2020-05-20 13:40:12 UTC", "updated_at": "2020-05-20 13:40:12 UTC", "id": 767575239, "name": "foo", "parameter_type": "string", "value": "*****" } ], "all_parameters": [ { "priority": 70, "created_at": "2020-05-20 13:40:12 UTC", "updated_at": "2020-05-20 13:40:12 UTC", "id": 767575239, "name": "foo", "parameter_type": "string", "value": "*****" }, { "priority": null, "created_at": "2020-05-20 13:40:06 UTC", "updated_at": "2020-05-20 13:40:06 UTC", "id": 513706444, "name": "loc_param", "parameter_type": "string", "value": "abc" }, { "priority": null, "created_at": "2020-05-20 13:40:06 UTC", "updated_at": "2020-05-20 13:40:06 UTC", "id": 32400255, "name": "org_param", "parameter_type": "string", "value": "xyz" }, { "priority": null, "created_at": "2020-05-20 13:40:06 UTC", "updated_at": "2020-05-20 13:40:06 UTC", "id": 636252244, "name": "test", "parameter_type": "string", "value": "myvalue" } ], "interfaces": [ { "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "domain_id": null, "domain_name": null, "created_at": "2020-05-20 13:40:11 UTC", "updated_at": "2020-05-20 13:40:11 UTC", "managed": true, "identifier": null, "id": 46, "name": "host2146", "ip": null, "ip6": null, "mac": null, "mtu": null, "fqdn": "host2146", "primary": true, "provision": true, "type": "interface", "virtual": false } ], "puppetclasses": [], "config_groups": [], "all_puppetclasses": [], "permissions": { "view_hosts": true, "create_hosts": true, "edit_hosts": true, "destroy_hosts": true, "build_hosts": true, "power_hosts": true, "console_hosts": true, "ipmi_boot_hosts": true, "puppetrun_hosts": true } }
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/hosts { "host": { "name": "testhost11", "environment_id": 334344675, "domain_id": 22495316, "ptable_id": 1007981702, "medium_id": 980190962, "architecture_id": 501905019, "operatingsystem_id": 1073012828, "puppet_proxy_id": 182953976, "compute_resource_id": 980190962, "root_pass": "xybxa6JUkz63w", "ip": "10.0.0.20", "mac": "52:53:00:1e:85:93", "compute_attributes": { "cpus": 4, "memory": 1024 } } } 201 { "ip": "10.0.0.20", "ip6": null, "environment_id": 334344675, "environment_name": "production", "last_report": null, "mac": "52:53:00:1e:85:93", "realm_id": null, "realm_name": null, "sp_mac": null, "sp_ip": null, "sp_name": null, "domain_id": 22495316, "domain_name": "mydomain.net", "architecture_id": 501905019, "architecture_name": "x86_64", "operatingsystem_id": 1073012828, "operatingsystem_name": "RHEL 6.1", "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "sp_subnet_id": null, "ptable_id": 1007981702, "ptable_name": "ptable27", "medium_id": 980190962, "medium_name": "CentOS 5.4", "pxe_loader": "Grub UEFI", "build": false, "comment": null, "disk": null, "installed_at": null, "model_id": null, "hostgroup_id": null, "owner_id": 135138680, "owner_name": "Admin User", "owner_type": "User", "enabled": true, "managed": true, "use_image": null, "image_file": "", "uuid": null, "compute_resource_id": 980190962, "compute_resource_name": "bigcompute", "compute_profile_id": null, "compute_profile_name": null, "capabilities": [ "build", "image", "new_volume" ], "provision_method": "build", "certname": "testhost11.mydomain.net", "image_id": null, "image_name": null, "created_at": "2020-05-20 13:13:49 UTC", "updated_at": "2020-05-20 13:13:49 UTC", "last_compile": null, "global_status": 0, "global_status_label": "Warning", "uptime_seconds": null, "organization_id": 447626438, "organization_name": "Organization 1", "location_id": 255093256, "location_name": "Location 1", "puppet_status": 0, "model_name": null, "configuration_status": 0, "configuration_status_label": "No reports", "build_status": 0, "build_status_label": "Installed", "name": "testhost11.mydomain.net", "id": 2, "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" }, "hostgroup_name": null, "hostgroup_title": null, "parameters": [], "all_parameters": [ { "priority": null, "created_at": "2020-05-20 13:13:49 UTC", "updated_at": "2020-05-20 13:13:49 UTC", "id": 716195090, "name": "os1", "parameter_type": "string", "value": "os1" }, { "priority": null, "created_at": "2020-05-20 13:13:49 UTC", "updated_at": "2020-05-20 13:13:49 UTC", "id": 665394701, "name": "parameter", "parameter_type": "string", "value": "value1" }, { "priority": null, "created_at": "2020-05-20 13:13:49 UTC", "updated_at": "2020-05-20 13:13:49 UTC", "id": 513706444, "name": "loc_param", "parameter_type": "string", "value": "abc" }, { "priority": null, "created_at": "2020-05-20 13:13:49 UTC", "updated_at": "2020-05-20 13:13:49 UTC", "id": 32400255, "name": "org_param", "parameter_type": "string", "value": "xyz" }, { "priority": null, "created_at": "2020-05-20 13:13:49 UTC", "updated_at": "2020-05-20 13:13:49 UTC", "id": 636252244, "name": "test", "parameter_type": "string", "value": "myvalue" } ], "interfaces": [ { "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "domain_id": 22495316, "domain_name": "mydomain.net", "created_at": "2020-05-20 13:13:49 UTC", "updated_at": "2020-05-20 13:13:49 UTC", "managed": true, "identifier": null, "id": 2, "name": "testhost11.mydomain.net", "ip": "10.0.0.20", "ip6": null, "mac": "52:53:00:1e:85:93", "mtu": null, "fqdn": "testhost11.mydomain.net", "primary": true, "provision": true, "type": "interface", "virtual": false } ], "puppetclasses": [], "config_groups": [], "all_puppetclasses": [], "permissions": { "view_hosts": true, "create_hosts": true, "edit_hosts": true, "destroy_hosts": true, "build_hosts": true, "power_hosts": true, "console_hosts": true, "ipmi_boot_hosts": true, "puppetrun_hosts": true } }
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:
|
host required |
Validations:
|
host[name] required |
Validations:
|
host[location_id] required |
Validations:
|
host[organization_id] required |
Validations:
|
host[environment_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[ip] optional , nil allowed |
not required if using a subnet with DHCP proxy Validations:
|
host[mac] optional , nil allowed |
required for managed host that is bare metal, not required if it’s a virtual machine Validations:
|
host[architecture_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[domain_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[realm_id] optional , nil allowed |
Validations:
|
host[puppet_proxy_id] optional , nil allowed |
Puppet proxy ID Validations:
|
host[puppet_ca_proxy_id] optional , nil allowed |
Puppet CA proxy ID Validations:
|
host[puppetclass_ids] optional , nil allowed |
Validations:
|
host[config_group_ids] optional , nil allowed |
IDs of associated config groups Validations:
|
host[operatingsystem_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[medium_id] optional , nil allowed |
required if not imaged based provisioning and host is managed and value is not inherited from host group Validations:
|
host[pxe_loader] optional , nil allowed |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
host[ptable_id] optional , nil allowed |
required if host is managed and custom partition has not been defined Validations:
|
host[subnet_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[compute_resource_id] optional , nil allowed |
nil means host is bare metal Validations:
|
host[root_pass] optional , nil allowed |
required if host is managed and value is not inherited from host group or default password in settings Validations:
|
host[model_id] optional , nil allowed |
Validations:
|
host[hostgroup_id] optional , nil allowed |
Validations:
|
host[owner_id] optional , nil allowed |
Validations:
|
host[owner_type] optional , nil allowed |
Host’s owner type Validations:
|
host[image_id] optional , nil allowed |
Validations:
|
host[host_parameters_attributes] optional , nil allowed |
Host’s parameters (array or indexed hash) Validations:
|
host[host_parameters_attributes][name] required |
Name of the parameter Validations:
|
host[host_parameters_attributes][value] required |
Parameter value Validations:
|
host[host_parameters_attributes][parameter_type] optional , nil allowed |
Type of value Validations:
|
host[host_parameters_attributes][hidden_value] optional , nil allowed |
Validations:
|
host[build] optional , nil allowed |
Validations:
|
host[enabled] optional , nil allowed |
Include this host within Foreman reporting Validations:
|
host[provision_method] optional , nil allowed |
The method used to provision the host. Validations:
|
host[managed] optional , nil allowed |
True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not Validations:
|
host[progress_report_id] optional , nil allowed |
UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] optional , nil allowed |
Additional information about this host Validations:
|
host[capabilities] optional , nil allowed |
Validations:
|
host[compute_profile_id] optional , nil allowed |
Validations:
|
host[interfaces_attributes] optional , nil allowed |
Host’s network interfaces. Validations:
|
host[interfaces_attributes][mac] optional , nil allowed |
MAC address of interface. Required for managed interfaces on bare metal. Validations:
|
host[interfaces_attributes][ip] optional , nil allowed |
IPv4 address of interface Validations:
|
host[interfaces_attributes][ip6] optional , nil allowed |
IPv6 address of interface Validations:
|
host[interfaces_attributes][type] optional , nil allowed |
Interface type, e.g. bmc. Default is interface Validations:
|
host[interfaces_attributes][name] optional , nil allowed |
Interface’s DNS name Validations:
|
host[interfaces_attributes][subnet_id] optional , nil allowed |
Foreman subnet ID of IPv4 interface Validations:
|
host[interfaces_attributes][subnet6_id] optional , nil allowed |
Foreman subnet ID of IPv6 interface Validations:
|
host[interfaces_attributes][domain_id] optional , nil allowed |
Foreman domain ID of interface. Required for primary interfaces on managed hosts. Validations:
|
host[interfaces_attributes][identifier] optional , nil allowed |
Device identifier, e.g. eth0 or eth1.1 Validations:
|
host[interfaces_attributes][managed] optional , nil allowed |
Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning? Validations:
|
host[interfaces_attributes][primary] optional , nil allowed |
Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface. Validations:
|
host[interfaces_attributes][provision] optional , nil allowed |
Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface. Validations:
|
host[interfaces_attributes][username] optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][password] optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][provider] optional , nil allowed |
Interface provider, e.g. IPMI. Only for BMC interfaces. Validations:
|
host[interfaces_attributes][virtual] optional , nil allowed |
Alias or VLAN device Validations:
|
host[interfaces_attributes][tag] optional , nil allowed |
VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][mtu] optional , nil allowed |
MTU, this attribute has precedence over the subnet MTU. Validations:
|
host[interfaces_attributes][attached_to] optional , nil allowed |
Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][mode] optional , nil allowed |
Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Validations:
|
host[interfaces_attributes][attached_devices] optional , nil allowed |
Identifiers of attached interfaces, e.g. Validations:
|
host[interfaces_attributes][bond_options] optional , nil allowed |
Space separated options, e.g. miimon=100. Only for bond interfaces. Validations:
|
host[interfaces_attributes][compute_attributes] optional , nil allowed |
Additional compute resource specific attributes for the interface. Validations:
|
host[compute_attributes] optional , nil allowed |
Additional compute resource specific attributes. Validations:
|
PUT /api/hosts/host2669 { "host": { "name": "testhost11", "environment_id": 334344675, "domain_id": 22495316, "ptable_id": 1007981829, "medium_id": 980190962, "architecture_id": 501905019, "operatingsystem_id": 1073012828, "puppet_proxy_id": 182953976, "compute_resource_id": 980190962, "root_pass": "xybxa6JUkz63w", "location_id": 255093256, "organization_id": 447626438, "ip": "10.0.0.20", "mac": "52:53:00:1e:85:93", "compute_attributes": { "cpus": 4, "memory": 1024 } } } 200 { "ip": "10.0.0.20", "ip6": null, "environment_id": 334344675, "environment_name": "production", "last_report": null, "mac": "52:53:00:1e:85:93", "realm_id": null, "realm_name": null, "sp_mac": null, "sp_ip": null, "sp_name": null, "domain_id": 22495316, "domain_name": "mydomain.net", "architecture_id": 501905019, "architecture_name": "x86_64", "operatingsystem_id": 1073012828, "operatingsystem_name": "RHEL 6.1", "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "sp_subnet_id": null, "ptable_id": 1007981829, "ptable_name": "ptable881", "medium_id": 980190962, "medium_name": "CentOS 5.4", "pxe_loader": null, "build": false, "comment": null, "disk": null, "installed_at": null, "model_id": null, "hostgroup_id": null, "owner_id": 135138680, "owner_name": "Admin User", "owner_type": "User", "enabled": true, "managed": false, "use_image": null, "image_file": "", "uuid": null, "compute_resource_id": 980190962, "compute_resource_name": "bigcompute", "compute_profile_id": null, "compute_profile_name": null, "capabilities": [ "build", "image", "new_volume" ], "provision_method": "build", "certname": "testhost11.mydomain.net", "image_id": null, "image_name": null, "created_at": "2020-05-20 13:45:41 UTC", "updated_at": "2020-05-20 13:45:41 UTC", "last_compile": null, "global_status": 0, "global_status_label": "Warning", "uptime_seconds": null, "organization_id": 447626438, "organization_name": "Organization 1", "location_id": 255093256, "location_name": "Location 1", "puppet_status": 0, "model_name": null, "configuration_status": 0, "configuration_status_label": "No reports", "name": "testhost11.mydomain.net", "id": 37, "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" }, "hostgroup_name": null, "hostgroup_title": null, "parameters": [], "all_parameters": [ { "priority": null, "created_at": "2020-05-20 13:44:29 UTC", "updated_at": "2020-05-20 13:44:29 UTC", "id": 716195090, "name": "os1", "parameter_type": "string", "value": "os1" }, { "priority": null, "created_at": "2020-05-20 13:44:29 UTC", "updated_at": "2020-05-20 13:44:29 UTC", "id": 665394701, "name": "parameter", "parameter_type": "string", "value": "value1" }, { "priority": null, "created_at": "2020-05-20 13:44:29 UTC", "updated_at": "2020-05-20 13:44:29 UTC", "id": 513706444, "name": "loc_param", "parameter_type": "string", "value": "abc" }, { "priority": null, "created_at": "2020-05-20 13:44:29 UTC", "updated_at": "2020-05-20 13:44:29 UTC", "id": 32400255, "name": "org_param", "parameter_type": "string", "value": "xyz" }, { "priority": null, "created_at": "2020-05-20 13:44:29 UTC", "updated_at": "2020-05-20 13:44:29 UTC", "id": 636252244, "name": "test", "parameter_type": "string", "value": "myvalue" } ], "interfaces": [ { "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "domain_id": 22495316, "domain_name": "mydomain.net", "created_at": "2020-05-20 13:45:41 UTC", "updated_at": "2020-05-20 13:45:41 UTC", "managed": true, "identifier": null, "id": 39, "name": "testhost11.mydomain.net", "ip": "10.0.0.20", "ip6": null, "mac": "52:53:00:1e:85:93", "mtu": null, "fqdn": "testhost11.mydomain.net", "primary": true, "provision": true, "type": "interface", "virtual": false } ], "puppetclasses": [], "config_groups": [], "all_puppetclasses": [], "permissions": { "view_hosts": true, "create_hosts": true, "edit_hosts": true, "destroy_hosts": true, "build_hosts": true, "power_hosts": true, "console_hosts": true, "ipmi_boot_hosts": true, "puppetrun_hosts": true } }
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:
|
host required |
Validations:
|
host[name] optional |
Validations:
|
host[location_id] optional |
Validations:
|
host[organization_id] optional |
Validations:
|
host[environment_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[ip] optional , nil allowed |
not required if using a subnet with DHCP proxy Validations:
|
host[mac] optional , nil allowed |
required for managed host that is bare metal, not required if it’s a virtual machine Validations:
|
host[architecture_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[domain_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[realm_id] optional , nil allowed |
Validations:
|
host[puppet_proxy_id] optional , nil allowed |
Puppet proxy ID Validations:
|
host[puppet_ca_proxy_id] optional , nil allowed |
Puppet CA proxy ID Validations:
|
host[puppetclass_ids] optional , nil allowed |
Validations:
|
host[config_group_ids] optional , nil allowed |
IDs of associated config groups Validations:
|
host[operatingsystem_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[medium_id] optional , nil allowed |
required if not imaged based provisioning and host is managed and value is not inherited from host group Validations:
|
host[pxe_loader] optional , nil allowed |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
host[ptable_id] optional , nil allowed |
required if host is managed and custom partition has not been defined Validations:
|
host[subnet_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[compute_resource_id] optional , nil allowed |
nil means host is bare metal Validations:
|
host[root_pass] optional , nil allowed |
required if host is managed and value is not inherited from host group or default password in settings Validations:
|
host[model_id] optional , nil allowed |
Validations:
|
host[hostgroup_id] optional , nil allowed |
Validations:
|
host[owner_id] optional , nil allowed |
Validations:
|
host[owner_type] optional , nil allowed |
Host’s owner type Validations:
|
host[image_id] optional , nil allowed |
Validations:
|
host[host_parameters_attributes] optional , nil allowed |
Host’s parameters (array or indexed hash) Validations:
|
host[host_parameters_attributes][name] optional |
Name of the parameter Validations:
|
host[host_parameters_attributes][value] optional |
Parameter value Validations:
|
host[host_parameters_attributes][parameter_type] optional , nil allowed |
Type of value Validations:
|
host[host_parameters_attributes][hidden_value] optional , nil allowed |
Validations:
|
host[build] optional , nil allowed |
Validations:
|
host[enabled] optional , nil allowed |
Include this host within Foreman reporting Validations:
|
host[provision_method] optional , nil allowed |
The method used to provision the host. Validations:
|
host[managed] optional , nil allowed |
True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not Validations:
|
host[progress_report_id] optional , nil allowed |
UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] optional , nil allowed |
Additional information about this host Validations:
|
host[capabilities] optional , nil allowed |
Validations:
|
host[compute_profile_id] optional , nil allowed |
Validations:
|
host[interfaces_attributes] optional , nil allowed |
Host’s network interfaces. Validations:
|
host[interfaces_attributes][mac] optional , nil allowed |
MAC address of interface. Required for managed interfaces on bare metal. Validations:
|
host[interfaces_attributes][ip] optional , nil allowed |
IPv4 address of interface Validations:
|
host[interfaces_attributes][ip6] optional , nil allowed |
IPv6 address of interface Validations:
|
host[interfaces_attributes][type] optional , nil allowed |
Interface type, e.g. bmc. Default is interface Validations:
|
host[interfaces_attributes][name] optional , nil allowed |
Interface’s DNS name Validations:
|
host[interfaces_attributes][subnet_id] optional , nil allowed |
Foreman subnet ID of IPv4 interface Validations:
|
host[interfaces_attributes][subnet6_id] optional , nil allowed |
Foreman subnet ID of IPv6 interface Validations:
|
host[interfaces_attributes][domain_id] optional , nil allowed |
Foreman domain ID of interface. Required for primary interfaces on managed hosts. Validations:
|
host[interfaces_attributes][identifier] optional , nil allowed |
Device identifier, e.g. eth0 or eth1.1 Validations:
|
host[interfaces_attributes][managed] optional , nil allowed |
Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning? Validations:
|
host[interfaces_attributes][primary] optional , nil allowed |
Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface. Validations:
|
host[interfaces_attributes][provision] optional , nil allowed |
Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface. Validations:
|
host[interfaces_attributes][username] optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][password] optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][provider] optional , nil allowed |
Interface provider, e.g. IPMI. Only for BMC interfaces. Validations:
|
host[interfaces_attributes][virtual] optional , nil allowed |
Alias or VLAN device Validations:
|
host[interfaces_attributes][tag] optional , nil allowed |
VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][mtu] optional , nil allowed |
MTU, this attribute has precedence over the subnet MTU. Validations:
|
host[interfaces_attributes][attached_to] optional , nil allowed |
Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][mode] optional , nil allowed |
Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Validations:
|
host[interfaces_attributes][attached_devices] optional , nil allowed |
Identifiers of attached interfaces, e.g. Validations:
|
host[interfaces_attributes][bond_options] optional , nil allowed |
Space separated options, e.g. miimon=100. Only for bond interfaces. Validations:
|
host[interfaces_attributes][compute_attributes] optional , nil allowed |
Additional compute resource specific attributes for the interface. Validations:
|
host[compute_attributes] optional , nil allowed |
Additional compute resource specific attributes. Validations:
|
DELETE /api/hosts/host2678 { "host": {} } 404 { "error": { "message": "Resource host not found by id 'host2678'" } }
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:
|
GET /api/hosts/host2775/enc 200 { "data": { "parameters": { "foreman_subnets": [], "foreman_interfaces": [ { "ip": null, "ip6": null, "mac": null, "name": "host2775", "attrs": {}, "virtual": false, "link": true, "identifier": null, "managed": true, "primary": true, "provision": true, "subnet": null, "subnet6": null, "tag": null, "attached_to": null, "type": "Interface" } ], "location": "Location 1", "location_title": "Location 1", "organization": "Organization 1", "organization_title": "Organization 1", "owner_name": "Admin User", "owner_email": "admin@someware.com", "ssh_authorized_keys": [], "foreman_users": { "secret_admin": { "firstname": "Admin", "lastname": "User", "mail": "admin@someware.com", "description": null, "fullname": "Admin User", "name": "secret_admin", "ssh_authorized_keys": [] } }, "root_pw": "$5$AZf7P0l0K5NV9iIp$aZLVSx6TsAfUwXAraeUd5i1FKG3hAdAeER8lUbkbqD7", "foreman_config_groups": [], "puppetmaster": "", "foreman_env": "environment358", "test": "myvalue", "org_param": "xyz", "loc_param": "abc" }, "classes": { "class389": null }, "environment": "environment358" } }
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:
|
Returns string representing a host status of a given type
GET /api/hosts/host2704/status/global 200 { "status_label": "OK", "status": 0 }
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:
|
type required |
status type, can be one of * global * configuration * build Validations:
|
Clears a host sub-status of a given type
DELETE /api/hosts/host2682/status/doesnt_exist { "host": {} } 422 { "error": "Status doesnt_exist does not exist." }
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:
|
type required |
status type Validations:
|
Return the host’s compute attributes that can be used to create a clone of this VM
GET /api/hosts/host2787/vm_compute_attributes 200 { "cpus": 4, "memory": 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:
|
PUT /api/hosts/host2789/disassociate { "host": {} } 200 { "ip": null, "ip6": null, "environment_id": null, "environment_name": null, "last_report": null, "mac": null, "realm_id": null, "realm_name": null, "sp_mac": null, "sp_ip": null, "sp_name": null, "domain_id": null, "domain_name": null, "architecture_id": null, "architecture_name": null, "operatingsystem_id": null, "operatingsystem_name": null, "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "sp_subnet_id": null, "ptable_id": null, "ptable_name": null, "medium_id": null, "medium_name": null, "pxe_loader": null, "build": false, "comment": null, "disk": null, "installed_at": null, "model_id": null, "hostgroup_id": null, "owner_id": 135138680, "owner_name": "Admin User", "owner_type": "User", "enabled": true, "managed": false, "use_image": null, "image_file": "", "uuid": null, "compute_resource_id": null, "compute_resource_name": null, "compute_profile_id": null, "compute_profile_name": null, "capabilities": [ "build" ], "provision_method": "build", "certname": "host2789", "image_id": null, "image_name": null, "created_at": "2020-05-20 13:46:10 UTC", "updated_at": "2020-05-20 13:46:10 UTC", "last_compile": null, "global_status": 0, "global_status_label": "OK", "uptime_seconds": null, "organization_id": 447626438, "organization_name": "Organization 1", "location_id": 255093256, "location_name": "Location 1", "puppet_status": 0, "model_name": null, "name": "host2789", "id": 175, "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, "hostgroup_name": null, "hostgroup_title": null, "interfaces": [ { "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "domain_id": null, "domain_name": null, "created_at": "2020-05-20 13:46:10 UTC", "updated_at": "2020-05-20 13:46:10 UTC", "managed": true, "identifier": null, "id": 183, "name": "host2789", "ip": null, "ip6": null, "mac": null, "mtu": null, "fqdn": "host2789", "primary": true, "provision": true, "type": "interface", "virtual": false } ], "puppetclasses": [], "config_groups": [], "all_puppetclasses": [], "permissions": { "view_hosts": true, "create_hosts": true, "edit_hosts": true, "destroy_hosts": true, "build_hosts": true, "power_hosts": true, "console_hosts": true, "ipmi_boot_hosts": true, "puppetrun_hosts": true } }
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:
|
PUT /api/hosts/host2114.example1041.com/power { "power_action": "status", "host": {} } 200 { "power": "on" }
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:
|
power_action required |
power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status) Validations:
|
GET /api/hosts/233/power 200 { "id": 233, "state": "off", "title": "Off" }
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:
|
PUT /api/hosts/host565/boot { "device": "bios", "host": {} } 422 { "message": "ERF42-8529 [Foreman::Exception]: No BMC NIC available for host host565" }
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:
|
device required |
boot device, valid devices are disk, cdrom, pxe, bios Validations:
|
POST /api/hosts/facts { "name": "brslc022.brs.infineon.com", "facts": { "is_virtual": "true", "processorcount": "2", "serialnumber": "VMware-56 4d 15 06 72 86 a9 d3-8a 09 fc 27 5a cf 00 45", "kernel": "Linux", "virtual": "vmware", "_timestamp": "2010-02-16 12:52:38.163833 +01:00", "network_eth0": "172.29.205.0", "operatingsystemrelease": "4", "uniqueid": "1dac16cd", "hardwaremodel": "i686", "rubysitedir": "/usr/lib/site_ruby/1.8", "platform": "Linux_2.6_i386_all", "uptime_seconds": "3756", "lsbrelease": ":core-3.0-ia32:core-3.0-noarch:graphics-3.0-ia32:graphics-3.0-noarch", "memorysize": "1.45 GB", "gi": "4", "netmask_eth0": "255.255.255.128", "ipaddress": "172.29.205.22", "physicalprocessorcount": "0", "swapfree": "1.95 GB", "vmware": "virtual", "netmask": "255.255.255.128", "clientversion": "0.24.8", "fqdn": "brslc022.brs.infineon.com", "timezone": "GMT", "ps": "ps -ef", "kernelrelease": "2.6.9-89.0.16.ELsmp", "hardwareisa": "i686", "domain": "brs.infineon.com", "type": "Other", "kernelversion": "2.6.9", "id": "root", "lsbdistdescription": "Red Hat Enterprise Linux AS release 4 (Nahant Update 8)", "uptime_hours": "1", "lsbdistrelease": "4", "macaddress_eth0": "00:0C:29:CF:00:45", "manufacturer": "VMware, Inc.", "memoryfree": "1.39 GB", "selinux": "false", "gateway_if": "eth0", "lsbdistcodename": "NahantUpdate8", "sshrsakey": "AAAAB3NzaC1yc2EAAAABIwAAAIEAyj0XAKzx4WlNE8Vzj0ABBEHxqHr2H4AZZnabnQkYTOfz5kObXL+BvYqPONg2EqeUYCTNaFtQQPpJ4H+TM+GCJDNvFEKJTRd+cFoOuramf9LunWN/+ETreQ5V8KhKvdYTNw5blPBKiQz/XxSxcm7beo5QiBVr/lOM0u8YhGTLawk=", "uptime_days": "0", "interfaces": "eth0", "hostname": "brslc022", "graphcard": "VMware", "uptime": "1:02 hours", "processor0": "Intel(R) Xeon(R) CPU X5460 @ 3.16GHz", "puppetversion": "0.24.8", "productname": "VMware Virtual Platform", "architecture": "i386", "gateway": "172.29.205.1", "rubyversion": "1.8.1", "environment": "brs_test", "path": "/usr/bin:/sbin:/bin:/usr/sbin:/opt/csw/bin", "swapsize": "1.95 GB", "ipaddress_eth0": "172.29.205.22", "facterversion": "1.5.7", "kernelmajversion": "2.6", "operatingsystem": "RedHat", "macaddress": "00:0C:29:CF:00:45", "processor1": "Intel(R) Xeon(R) CPU X5460 @ 3.16GHz", "lsbmajdistrelease": "4", "sshdsakey": "AAAAB3NzaC1kc3MAAACBAIUasO2eEvlRHfcO8wMPfbo98YfgVsJj0qhUDSSoSa6xmYI8QWBDMoxf1h8INiDfrNQ5e4VreLQjt4/2Ex7OXoeB7C9Cg18/TlfZU+RTNMdsL85W5hQrrKoBm+ksMnxidkDC66ROq+pmxBTGDwwxg3ugF8eZnVSzCZ1FE605AsStAAAAFQCrr3s1cLQFRc6oZJAx3EZDxDraCQAAAIBqIqIvY7KtRsI+8y8E5MSZXpRRZxf0zqbraDxASwzImUr6ysEmpJsHbHyi6UePnF55tG/iZNM4bSNg/3qExK8So040byV71qN4HNT48nIh3cCS0z8oKLqvlCRJ+dOY1QMkE8ZLfOyF4A6ZOTuE8TTsGpvUIR0HyXkpoiIR9XcgzgAAAIA4nkedBQi+VA01NvWx27GGz5P3TTQ36yDODZdLmXoepQM1rPfKWvPFFd5MxgJumSU5BKhYUiQTOImcRlQcY5DA3dGbog1dOAKlWyeJn4WRHbYr+VNgR/HwBzHLMW4TXLt38ThmPv9TiLS1RvTdHuDm2oRTadNZOrmQz619kZejmw==", "lsbdistid": "RedHatEnterpriseAS", "foreman_hostgroup": "hostgroup69" }, "host": { "name": "brslc022.brs.infineon.com" } } 201 { "id": 2, "name": "brslc022.brs.infineon.com", "last_compile": "2010-02-16T11:52:38.163Z", "last_report": null, "updated_at": "2020-05-20T13:21:33.506Z", "created_at": "2020-05-20T13:21:33.172Z", "root_pass": "$5$mIv6cW0HB0sNbPZf$54WKOHQspNZCkhJvCr71SId/TevZPRMhKprJBDFkU7C", "architecture_id": 922134522, "operatingsystem_id": 1073012829, "environment_id": 687036938, "ptable_id": null, "medium_id": null, "build": false, "comment": null, "disk": null, "installed_at": null, "model_id": 980190964, "hostgroup_id": 928644286, "owner_id": null, "owner_type": null, "enabled": true, "puppet_ca_proxy_id": null, "managed": false, "use_image": null, "image_file": "", "uuid": null, "compute_resource_id": null, "puppet_proxy_id": null, "certname": "brslc022.brs.infineon.com", "image_id": null, "organization_id": 447626438, "location_id": 255093256, "otp": null, "realm_id": null, "compute_profile_id": null, "provision_method": "build", "grub_pass": "$5$mIv6cW0HB0sNbPZf$54WKOHQspNZCkhJvCr71SId/TevZPRMhKprJBDFkU7C", "global_status": 0, "lookup_value_matcher": "fqdn=brslc022.brs.infineon.com", "pxe_loader": null, "initiated_at": null, "build_errors": null, "reported_data_attributes": { "id": 1, "host_id": 2, "boot_time": "2020-05-20T12:18:57.000Z", "created_at": "2020-05-20T13:21:33.470Z", "updated_at": "2020-05-20T13:21:33.470Z", "virtual": true, "sockets": 0, "cores": 2, "ram": 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 |
hostname of the host Validations:
|
facts required |
hash containing the facts for the host Validations:
|
certname optional |
optional: certname of the host Validations:
|
type optional |
optional: the STI type of host to create Validations:
|
POST /api/hosts/host64/rebuild_config { "host": {} } 422 { "message": "Configuration rebuild failed for: TFTP, DNS, and DHCP." }
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:
|
GET /api/hosts/host2699.example1294.com/template/provision 200 { "template": "template content 206" }
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:
|
kind required |
Template kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP, cloud-init, registration Validations:
|