Param name | Description |
---|---|
thin optional |
Som alleen IDs en namen van hosts op. Validations:
|
hostgroup_id optional |
ID van de host groep Validations:
|
location_id optional |
ID van de locatie Validations:
|
organization_id optional |
ID van de organisatie Validations:
|
environment_id optional |
ID van de omgeving Validations:
|
include optional |
Array van extra informatie types om toe te voegen Validations:
|
search optional |
filter resultaten 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 Validations:
|
Field name | Type | Possible values |
---|---|---|
architecture | ||
boot_time | ||
build | true, false | |
class | string | |
comment | ||
compute_resource | ||
compute_resource_id | ||
config_group | string | |
created_at | ||
domain | ||
domain_id | ||
environment | ||
facts | string | |
global_status | ok, warning, error | |
has_ip | ||
has_mac | ||
hostgroup | ||
hostgroup_fullname | ||
hostgroup_id | ||
hostgroup_name | ||
hostgroup_title | ||
image | ||
installed_at | ||
ip | ||
last_report | ||
location | ||
location_id | ||
mac | ||
managed | true, false | |
model | ||
name | ||
organization | ||
organization_id | ||
origin | ||
os | ||
os_description | ||
os_id | ||
os_major | string | |
os_minor | string | |
os_title | ||
owner | string | |
owner_id | ||
owner_type | ||
params | string | |
params_name | ||
parent_hostgroup | string | |
puppet_ca | ||
puppet_proxy_id | ||
puppetmaster | ||
realm | ||
realm_id | ||
smart_proxy | string | |
status.applied | ||
status.enabled | true, false | |
status.failed | ||
status.failed_restarts | ||
status.interesting | true, false | |
status.pending | ||
status.restarted | ||
status.skipped | ||
subnet | ||
subnet.name | ||
subnet6 | ||
subnet6.name | ||
user.firstname | string | |
user.lastname | string | |
user.login | string | |
user.mail | string | |
usergroup | ||
usergroup.name | ||
uuid |
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:
|
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 |
verplicht als de host managed is en de waarde niet overerft van de host groep Validations:
|
host[ip] optional , nil allowed |
Niet verplicht als een subnet met DHCP proxy wordt gebruikt Validations:
|
host[mac] optional , nil allowed |
Verplicht voor een managed host die bare metal is, niet verplicht als het een virtuele machine is Validations:
|
host[architecture_id] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft van de host groep Validations:
|
host[domain_id] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft van de host groep 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 van geassocieerde configuratie groepen Validations:
|
host[operatingsystem_id] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft van de host groep Validations:
|
host[medium_id] optional , nil allowed |
Verplicht als de host managed, niet image based en niet overerft van de host groep is Validations:
|
host[pxe_loader] optional , nil allowed |
DHCP Filenaam optie (Grub2/PXELinux is standaard) Validations:
|
host[ptable_id] optional , nil allowed |
verplicht als de host managed is en custom partities niet gedefinieerd zijn Validations:
|
host[subnet_id] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft van de host groep Validations:
|
host[compute_resource_id] optional , nil allowed |
nil betekent dat de host bare metal is Validations:
|
host[root_pass] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft wordt van of de hostgroup of een default wachtwoord 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 zijn eigenaar type Validations:
|
host[image_id] optional , nil allowed |
Validations:
|
host[host_parameters_attributes] optional , nil allowed |
Host parameters (Array of index hash) Validations:
|
host[host_parameters_attributes][name] required |
Naam van de parameter Validations:
|
host[host_parameters_attributes][value] required |
Parameter waarde 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 |
Neem deze host binnen de Foreman rapportage op Validations:
|
host[provision_method] optional , nil allowed |
The method used to provision the host. Validations:
|
host[managed] optional , nil allowed |
Aan/Uit vlag die bepaalt of een host managed of unmanaged is. Note: Deze waarde bepaalt ook wanneer verschillende parameters verplicht zijn of niet. Validations:
|
host[progress_report_id] optional , nil allowed |
UUID om de orchestration taak status in de gaten te houden, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] optional , nil allowed |
Extra informatie over deze host Validations:
|
host[capabilities] optional , nil allowed |
Validations:
|
host[compute_profile_id] optional , nil allowed |
Validations:
|
host[interfaces_attributes] optional , nil allowed |
De host zijn netwerk interfaces Validations:
|
host[interfaces_attributes][mac] optional , nil allowed |
MAC adres van de interface. Verplicht voor managed interfaces op bare metal. Validations:
|
host[interfaces_attributes][ip] optional , nil allowed |
IPv4 adres van de interface Validations:
|
host[interfaces_attributes][ip6] optional , nil allowed |
IPv6 adres van de interface Validations:
|
host[interfaces_attributes][type] optional , nil allowed |
Interface type, bijvoorbeeld bmc. Standaard is interface Validations:
|
host[interfaces_attributes][name] optional , nil allowed |
Interface zijn DNS naam 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 domein ID of interface. Verplicht voor de primaire interface op managed hosts. Validations:
|
host[interfaces_attributes][identifier] optional , nil allowed |
Device identifier, bijvoorbeeld eth0 of eth1.1 Validations:
|
host[interfaces_attributes][managed] optional , nil allowed |
Moet deze interface gemanaged worden via DHCP en DNS smart proxy en moet hij geconfigureerd worden gedurende de uitrol? Validations:
|
host[interfaces_attributes][primary] optional , nil allowed |
Moet deze interface gebruikt worden voor het opbouwen van de FQDN van de host? elke managed host moet een primaire interface hebben. Validations:
|
host[interfaces_attributes][provision] optional , nil allowed |
Moet deze interface gebruikt worden voor TFTP of PXELinux (of SSH voor op image gebaseerde hosts)? Elke managed host moet verplicht een provision interface hebben. Validations:
|
host[interfaces_attributes][username] optional , nil allowed |
Alleen voor BMC interfaces Validations:
|
host[interfaces_attributes][password] optional , nil allowed |
Alleen voor BMC interfaces Validations:
|
host[interfaces_attributes][provider] optional , nil allowed |
Interface provider, bijvoorbeeld IPMI. Alleen voor BMC Interfaces Validations:
|
host[interfaces_attributes][virtual] optional , nil allowed |
Alias of VLAN device Validations:
|
host[interfaces_attributes][tag] optional , nil allowed |
VLAN Tag, dit attribuut heeft voorrang boven het subnet VLAN ID. Alleen voor virtuele 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 van de interface waar deze interface bij hoort. Bijv. eth1 Alleen voor virtuele interfaces Validations:
|
host[interfaces_attributes][mode] optional , nil allowed |
Bond mode van de interface, bijvoorbeeld balance-rr. Alleen voorbond interfaces Validations:
|
host[interfaces_attributes][attached_devices] optional , nil allowed |
Identifiers van de aangesloten interface, bijvoorbeeld `['eth1', 'eth2']`. Voor bond interfaces zijn dit de slaves. Alleen voor vond en bridged interfaces Validations:
|
host[interfaces_attributes][bond_options] optional , nil allowed |
Door spatie gescheiden opties, bijvoorbeeld miimon=100. Alleen voor bond interfaces. Validations:
|
host[interfaces_attributes][compute_attributes] optional , nil allowed |
Extra compute resource specifieke attributen voor de interface. Validations:
|
host[compute_attributes] optional , nil allowed |
Extra compute resource specifieke attributen. Validations:
|
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 |
verplicht als de host managed is en de waarde niet overerft van de host groep Validations:
|
host[ip] optional , nil allowed |
Niet verplicht als een subnet met DHCP proxy wordt gebruikt Validations:
|
host[mac] optional , nil allowed |
Verplicht voor een managed host die bare metal is, niet verplicht als het een virtuele machine is Validations:
|
host[architecture_id] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft van de host groep Validations:
|
host[domain_id] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft van de host groep 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 van geassocieerde configuratie groepen Validations:
|
host[operatingsystem_id] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft van de host groep Validations:
|
host[medium_id] optional , nil allowed |
Verplicht als de host managed, niet image based en niet overerft van de host groep is Validations:
|
host[pxe_loader] optional , nil allowed |
DHCP Filenaam optie (Grub2/PXELinux is standaard) Validations:
|
host[ptable_id] optional , nil allowed |
verplicht als de host managed is en custom partities niet gedefinieerd zijn Validations:
|
host[subnet_id] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft van de host groep Validations:
|
host[compute_resource_id] optional , nil allowed |
nil betekent dat de host bare metal is Validations:
|
host[root_pass] optional , nil allowed |
verplicht als de host managed is en de waarde niet overerft wordt van of de hostgroup of een default wachtwoord 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 zijn eigenaar type Validations:
|
host[image_id] optional , nil allowed |
Validations:
|
host[host_parameters_attributes] optional , nil allowed |
Host parameters (Array of index hash) Validations:
|
host[host_parameters_attributes][name] optional |
Naam van de parameter Validations:
|
host[host_parameters_attributes][value] optional |
Parameter waarde 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 |
Neem deze host binnen de Foreman rapportage op Validations:
|
host[provision_method] optional , nil allowed |
The method used to provision the host. Validations:
|
host[managed] optional , nil allowed |
Aan/Uit vlag die bepaalt of een host managed of unmanaged is. Note: Deze waarde bepaalt ook wanneer verschillende parameters verplicht zijn of niet. Validations:
|
host[progress_report_id] optional , nil allowed |
UUID om de orchestration taak status in de gaten te houden, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] optional , nil allowed |
Extra informatie over deze host Validations:
|
host[capabilities] optional , nil allowed |
Validations:
|
host[compute_profile_id] optional , nil allowed |
Validations:
|
host[interfaces_attributes] optional , nil allowed |
De host zijn netwerk interfaces Validations:
|
host[interfaces_attributes][mac] optional , nil allowed |
MAC adres van de interface. Verplicht voor managed interfaces op bare metal. Validations:
|
host[interfaces_attributes][ip] optional , nil allowed |
IPv4 adres van de interface Validations:
|
host[interfaces_attributes][ip6] optional , nil allowed |
IPv6 adres van de interface Validations:
|
host[interfaces_attributes][type] optional , nil allowed |
Interface type, bijvoorbeeld bmc. Standaard is interface Validations:
|
host[interfaces_attributes][name] optional , nil allowed |
Interface zijn DNS naam 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 domein ID of interface. Verplicht voor de primaire interface op managed hosts. Validations:
|
host[interfaces_attributes][identifier] optional , nil allowed |
Device identifier, bijvoorbeeld eth0 of eth1.1 Validations:
|
host[interfaces_attributes][managed] optional , nil allowed |
Moet deze interface gemanaged worden via DHCP en DNS smart proxy en moet hij geconfigureerd worden gedurende de uitrol? Validations:
|
host[interfaces_attributes][primary] optional , nil allowed |
Moet deze interface gebruikt worden voor het opbouwen van de FQDN van de host? elke managed host moet een primaire interface hebben. Validations:
|
host[interfaces_attributes][provision] optional , nil allowed |
Moet deze interface gebruikt worden voor TFTP of PXELinux (of SSH voor op image gebaseerde hosts)? Elke managed host moet verplicht een provision interface hebben. Validations:
|
host[interfaces_attributes][username] optional , nil allowed |
Alleen voor BMC interfaces Validations:
|
host[interfaces_attributes][password] optional , nil allowed |
Alleen voor BMC interfaces Validations:
|
host[interfaces_attributes][provider] optional , nil allowed |
Interface provider, bijvoorbeeld IPMI. Alleen voor BMC Interfaces Validations:
|
host[interfaces_attributes][virtual] optional , nil allowed |
Alias of VLAN device Validations:
|
host[interfaces_attributes][tag] optional , nil allowed |
VLAN Tag, dit attribuut heeft voorrang boven het subnet VLAN ID. Alleen voor virtuele 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 van de interface waar deze interface bij hoort. Bijv. eth1 Alleen voor virtuele interfaces Validations:
|
host[interfaces_attributes][mode] optional , nil allowed |
Bond mode van de interface, bijvoorbeeld balance-rr. Alleen voorbond interfaces Validations:
|
host[interfaces_attributes][attached_devices] optional , nil allowed |
Identifiers van de aangesloten interface, bijvoorbeeld `['eth1', 'eth2']`. Voor bond interfaces zijn dit de slaves. Alleen voor vond en bridged interfaces Validations:
|
host[interfaces_attributes][bond_options] optional , nil allowed |
Door spatie gescheiden opties, bijvoorbeeld miimon=100. Alleen voor bond interfaces. Validations:
|
host[interfaces_attributes][compute_attributes] optional , nil allowed |
Extra compute resource specifieke attributen voor de interface. Validations:
|
host[compute_attributes] optional , nil allowed |
Extra compute resource specifieke attributen. Validations:
|
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:
|
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
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, is er een van
Validations:
|
Clears a host sub-status of a given type
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
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:
|
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:
|
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 actie, geldige acties zijn (aan/start), (uit./stop), (soft/herstart), (cycle/reset), (staat/status) Validations:
|
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:
|
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 apparaat, beschikbare apparaten zijn disk, cdrom, pxe en bios Validations:
|
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 van de host Validations:
|
facts required |
Hash welke de feiten voor een host bevat Validations:
|
certname optional |
Optioneel: Certificaat naam van de host Validations:
|
type optional |
Optioneel: de STI type van de host die aangemaakt wordt. Validations:
|
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 |
Limiteer de herbouw stappen, valide stappen zijn DHCP, DNS, TFTP Validations:
|
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 soorten, beschikbare waarden zijn: Validations:
|