Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

host
required

Validations:

  • Must be a Hash

host[name]
optional

Validations:

  • Must be a String

host[location_id]
optional

Validations:

  • Must be a number.

host[organization_id]
optional

Validations:

  • Must be a number.

host[environment_id]
optional , nil allowed

verplicht als de host managed is en de waarde niet overerft van de host groep

Validations:

  • Must be a String

host[ip]
optional , nil allowed

Niet verplicht als een subnet met DHCP proxy wordt gebruikt

Validations:

  • Must be a String

host[mac]
optional , nil allowed

Verplicht voor een managed host die bare metal is, niet verplicht als het een virtuele machine is

Validations:

  • Must be a String

host[architecture_id]
optional , nil allowed

verplicht als de host managed is en de waarde niet overerft van de host groep

Validations:

  • Must be a number.

host[domain_id]
optional , nil allowed

verplicht als de host managed is en de waarde niet overerft van de host groep

Validations:

  • Must be a number.

host[realm_id]
optional , nil allowed

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • Must be a number.

host[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

host[config_group_ids]
optional , nil allowed

IDs van geassocieerde configuratie groepen

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional , nil allowed

verplicht als de host managed is en de waarde niet overerft van de host groep

Validations:

  • Must be a String

host[medium_id]
optional , nil allowed

Verplicht als de host managed, niet image based en niet overerft van de host groep is

Validations:

  • Must be a String

host[pxe_loader]
optional , nil allowed

DHCP Filenaam optie (Grub2/PXELinux is standaard)

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.

host[ptable_id]
optional , nil allowed

verplicht als de host managed is en custom partities niet gedefinieerd zijn

Validations:

  • Must be a number.

host[subnet_id]
optional , nil allowed

verplicht als de host managed is en de waarde niet overerft van de host groep

Validations:

  • Must be a number.

host[compute_resource_id]
optional , nil allowed

nil betekent dat de host bare metal is

Validations:

  • Must be a number.

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:

  • Must be a String

host[model_id]
optional , nil allowed

Validations:

  • Must be a number.

host[hostgroup_id]
optional , nil allowed

Validations:

  • Must be a number.

host[owner_id]
optional , nil allowed

Validations:

  • Must be a number.

host[owner_type]
optional , nil allowed

Host zijn eigenaar type

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optional , nil allowed

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional , nil allowed

Host parameters (Array of index hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
optional

Naam van de parameter

Validations:

  • Must be a String

host[host_parameters_attributes][value]
optional

Parameter waarde

Validations:

  • Must be a String

host[host_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

host[host_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

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

host[build]
optional , nil allowed

Validations:

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

host[enabled]
optional , nil allowed

Neem deze host binnen de Foreman rapportage op

Validations:

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

host[provision_method]
optional , nil allowed

The method used to provision the host.

Validations:

  • Must be one of: build, image.

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:

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

host[progress_report_id]
optional , nil allowed

UUID om de orchestration taak status in de gaten te houden, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
optional , nil allowed

Extra informatie over deze host

Validations:

  • Must be a String

host[capabilities]
optional , nil allowed

Validations:

  • Must be a String

host[compute_profile_id]
optional , nil allowed

Validations:

  • Must be a number.

host[interfaces_attributes]
optional , nil allowed

De host zijn netwerk interfaces

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil allowed

MAC adres van de interface. Verplicht voor managed interfaces op bare metal.

Validations:

  • Must be a String

host[interfaces_attributes][ip]
optional , nil allowed

IPv4 adres van de interface

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
optional , nil allowed

IPv6 adres van de interface

Validations:

  • Must be a String

host[interfaces_attributes][type]
optional , nil allowed

Interface type, bijvoorbeeld bmc. Standaard is interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
optional , nil allowed

Interface zijn DNS naam

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
optional , nil allowed

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optional , nil allowed

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optional , nil allowed

Foreman domein ID of interface. Verplicht voor de primaire interface op managed hosts.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
optional , nil allowed

Device identifier, bijvoorbeeld eth0 of eth1.1

Validations:

  • Must be a String

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:

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

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:

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

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:

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

host[interfaces_attributes][username]
optional , nil allowed

Alleen voor BMC interfaces

Validations:

  • Must be a String

host[interfaces_attributes][password]
optional , nil allowed

Alleen voor BMC interfaces

Validations:

  • Must be a String

host[interfaces_attributes][provider]
optional , nil allowed

Interface provider, bijvoorbeeld IPMI. Alleen voor BMC Interfaces

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil allowed

Alias of VLAN device

Validations:

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

host[interfaces_attributes][tag]
optional , nil allowed

VLAN Tag, dit attribuut heeft voorrang boven het subnet VLAN ID. Alleen voor virtuele interfaces.

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
optional , nil allowed

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
optional , nil allowed

Identifier van de interface waar deze interface bij hoort. Bijv. eth1 Alleen voor virtuele interfaces

Validations:

  • Must be a String

host[interfaces_attributes][mode]
optional , nil allowed

Bond mode van de interface, bijvoorbeeld balance-rr. Alleen voorbond interfaces

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

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:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil allowed

Door spatie gescheiden opties, bijvoorbeeld miimon=100. Alleen voor bond interfaces.

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
optional , nil allowed

Extra compute resource specifieke attributen voor de interface.

Validations:

  • Must be a Hash

host[compute_attributes]
optional , nil allowed

Extra compute resource specifieke attributen.

Validations:

  • Must be a Hash