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

required if host is managed and value is not inherited from host group

Validations:

  • Must be a String

host[ip]
optional , nil allowed

no es requereix si s'està utilitzant una subxarxa amb servidor intermediari DHCP

Validations:

  • Must be a String

host[mac]
optional , nil allowed

required for managed host that is bare metal, not required if it's a virtual machine

Validations:

  • Must be a String

host[architecture_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.

host[domain_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.

host[realm_id]
optional , nil allowed

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional , nil allowed

ID de servidor intermediari de Puppet

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional , nil allowed

ID de servidor intermediari de l'AC de Puppet

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

Els ID dels grups de configuracions

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a String

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:

  • Must be a String

host[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

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

es requereix si l'amfitrió està gestionat i no s'ha definit la partició personalitzada

Validations:

  • Must be a number.

host[subnet_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.

host[compute_resource_id]
optional , nil allowed

nil means host is bare metal

Validations:

  • Must be a number.

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:

  • 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

Tipus de propietari de l'amfitrió

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's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
optional

Nom del paràmetre

Validations:

  • Must be a String

host[host_parameters_attributes][value]
optional

Valor del paràmetre

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

Inclou aquest amfitrió dins de l'enviament d'informes de Foreman

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

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

Validations:

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

host[progress_report_id]
optional , nil allowed

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
optional , nil allowed

Informació addicional quant a aquest amfitrió

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

Les interfícies de xarxa dels amfitrions.

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil allowed

MAC address of interface. Required for managed interfaces on bare metal.

Validations:

  • Must be a String

host[interfaces_attributes][ip]
optional , nil allowed

Adreça IPv4 de la interfície

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
optional , nil allowed

Adreça IPv6 de la interfície

Validations:

  • Must be a String

host[interfaces_attributes][type]
optional , nil allowed

Tipus d'interfície, p. ex. bmc. Per defecte és interface

Validations:

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

host[interfaces_attributes][name]
optional , nil allowed

Nom DNS de la interfície

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
optional , nil allowed

ID de la subxarxa de Foreman de la interfície IPv4

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optional , nil allowed

ID de la subxarxa de Foreman de la interfície IPv6

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optional , nil allowed

Foreman domain ID of interface. Required for primary interfaces on managed hosts.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
optional , nil allowed

L'identificador de dispositiu, p. ex. eth0 o eth1.1

Validations:

  • Must be a String

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:

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

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:

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

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:

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

host[interfaces_attributes][username]
optional , nil allowed

Només per a les interfícies BMC.

Validations:

  • Must be a String

host[interfaces_attributes][password]
optional , nil allowed

Només per a les interfícies BMC.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
optional , nil allowed

Proveïdor de la interfície, p. ex. IPMI. Únicament per a les interfícies BMC.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil allowed

Àlies o dispositiu VLAN

Validations:

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

host[interfaces_attributes][tag]
optional , nil allowed

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual 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 of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

Validations:

  • Must be a String

host[interfaces_attributes][mode]
optional , nil allowed

Bond mode of the interface, e.g. balance-rr. Only for bond 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 of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil allowed

Space separated options, e.g. miimon=100. Only for bond interfaces.

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
optional , nil allowed

Additional compute resource specific attributes for the interface.

Validations:

  • Must be a Hash

host[compute_attributes]
optional , nil allowed

Additional compute resource specific attributes.

Validations:

  • Must be a Hash