Hosts

>>>

GET /api/hosts
Llista tots els amfitrions

GET /api/hostgroups/:hostgroup_id/hosts
Llista tots els amfitrions per a un grup d'amfitrions

GET /api/locations/:location_id/hosts
Llista els amfitrions per ubicació

GET /api/organizations/:organization_id/hosts
Llista els amfitrions per organització

GET /api/environments/:environment_id/hosts
Llista els entorns per entorn

Params

Param Name Description
thin
Optional

Only list ID and name of hosts

Validations:

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

ID de grup d'amfitrions

Validations:

  • Must be a String
location_id
Optional

ID d'ubicació

Validations:

  • Must be a String
organization_id
Optional

ID d'organització

Validations:

  • Must be a String
environment_id
Optional

ID d'entorn

Validations:

  • Must be a String
include
Optional

Seqüència de tipus extres d'informació a incloure

Validations:

  • Must be one of: parameters, all_parameters.
search
Optional

filtra els resultats

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
Optional

Nombre de resultats per pàgina a retornar

Validations:

  • Must be a number.

Search fields

Field name Tipus Possible values
architecture string
boot_time
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
expires date
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/:id
Mosta un amfitrió

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
show_hidden_parameters
Optional

Mostra els valors dels paràmetres ocults

Validations:

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

POST /api/hosts
Crea un amfitrió

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
host
Required

Validations:

  • Must be a Hash
host[name]
Required

Validations:

  • Must be a String
host[location_id]
Required

Validations:

  • Must be a number.
host[organization_id]
Required

Validations:

  • Must be a number.
host[environment_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[ip]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[mac]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[domain_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[realm_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de servidor intermediari de Puppet

Validations:

  • Must be a number.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de servidor intermediari de l'AC de Puppet

Validations:

  • Must be a number.
host[puppetclass_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
host[config_group_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Els ID dels grups de configuracions

Validations:

  • Must be an array of any type
host[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[medium_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

nil means host is bare metal

Validations:

  • Must be a number.
host[root_pass]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[hostgroup_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[owner_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[owner_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Tipus de propietari de l'amfitrió

Validations:

  • Must be one of: User, Usergroup.
host[image_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[host_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements
host[host_parameters_attributes][name]
Required

Nom del paràmetre

Validations:

  • Must be a String
host[host_parameters_attributes][value]
Required

Valor del paràmetre

Validations:

  • Must be a String
host[host_parameters_attributes][parameter_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
host[host_parameters_attributes][hidden_value]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0.
host[build]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0.
host[enabled]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be one of: true, false, 1, 0.
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

The method used to provision the host.

Validations:

  • Must be one of: build, image.
host[managed]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[comment]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Informació addicional quant a aquest amfitrió

Validations:

  • Must be a String
host[capabilities]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
host[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[interfaces_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Les interfícies de xarxa dels amfitrions.

Validations:

  • Must be an Array of nested elements
host[interfaces_attributes][mac]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[interfaces_attributes][ip]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Adreça IPv4 de la interfície

Validations:

  • Must be a String
host[interfaces_attributes][ip6]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Adreça IPv6 de la interfície

Validations:

  • Must be a String
host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Nom DNS de la interfície

Validations:

  • Must be a String
host[interfaces_attributes][subnet_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[interfaces_attributes][subnet6_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[interfaces_attributes][domain_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[interfaces_attributes][managed]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Només per a les interfícies BMC.

Validations:

  • Must be a String
host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Només per a les interfícies BMC.

Validations:

  • Must be a String
host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Àlies o dispositiu VLAN

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][tag]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer
host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[interfaces_attributes][compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes for the interface.

Validations:

  • Must be a Hash
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes.

Validations:

  • Must be a Hash
host[expired_on]
Optional

Expiry date

Validations:

  • Must be a String
>>>

PUT /api/hosts/:id
Actualitza un amfitrió

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[ip]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[mac]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[domain_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[realm_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de servidor intermediari de Puppet

Validations:

  • Must be a number.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de servidor intermediari de l'AC de Puppet

Validations:

  • Must be a number.
host[puppetclass_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
host[config_group_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Els ID dels grups de configuracions

Validations:

  • Must be an array of any type
host[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[medium_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

nil means host is bare metal

Validations:

  • Must be a number.
host[root_pass]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[hostgroup_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[owner_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[owner_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Tipus de propietari de l'amfitrió

Validations:

  • Must be one of: User, Usergroup.
host[image_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[host_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
host[host_parameters_attributes][hidden_value]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0.
host[build]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0.
host[enabled]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be one of: true, false, 1, 0.
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

The method used to provision the host.

Validations:

  • Must be one of: build, image.
host[managed]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[comment]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Informació addicional quant a aquest amfitrió

Validations:

  • Must be a String
host[capabilities]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
host[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
host[interfaces_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Les interfícies de xarxa dels amfitrions.

Validations:

  • Must be an Array of nested elements
host[interfaces_attributes][mac]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[interfaces_attributes][ip]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Adreça IPv4 de la interfície

Validations:

  • Must be a String
host[interfaces_attributes][ip6]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Adreça IPv6 de la interfície

Validations:

  • Must be a String
host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Nom DNS de la interfície

Validations:

  • Must be a String
host[interfaces_attributes][subnet_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[interfaces_attributes][subnet6_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[interfaces_attributes][domain_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.
host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[interfaces_attributes][managed]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Només per a les interfícies BMC.

Validations:

  • Must be a String
host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Només per a les interfícies BMC.

Validations:

  • Must be a String
host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Àlies o dispositiu VLAN

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][tag]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer
host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String
host[interfaces_attributes][compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes for the interface.

Validations:

  • Must be a Hash
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes.

Validations:

  • Must be a Hash
host[expired_on]
Optional

Expiry date

Validations:

  • Must be a String
>>>

DELETE /api/hosts/:id
Suprimeix un amfitrió

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.
>>>

GET /api/hosts/:id/enc
Obté els valors ENC de l'amfitrió

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/hosts/:id/status
Obté l'estat de configuració de l'amfitrió

Return value may either be one of the following:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/hosts/:id/status/:type
Obté l'estat de l'amfitrió

Returns string representing a host status of a given type

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
type
Required

status type, can be one of

  • global

  • configuration

  • build

Validations:

  • Must be one of: HostStatus::Global, configuration, build.
>>>

GET /api/hosts/:id/vm_compute_attributes
Obté els atributs de la MV de l'amfitrió

Return the host's compute attributes that can be used to create a clone of this VM

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
>>>

PUT /api/hosts/:id/disassociate
Desassocia l'amfitrió des d'una MV

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
>>>

PUT /api/hosts/:id/power
Executa una operació energètica a l'amfitrió

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
power_action
Required

power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

Validations:

  • Must be a String
>>>

GET /api/hosts/:id/power
Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
>>>

PUT /api/hosts/:id/boot
Boot host from specified device

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
device
Required

boot device, valid devices are disk, cdrom, pxe, bios

Validations:

  • Must be a String
>>>

POST /api/hosts/facts
Puja els objectes d'interès per a un amfitrió, creant el nou amfitrió si fos necessari

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
name
Required

nom d'amfitrió de l'amfitrió

Validations:

  • Must be a String
facts
Required

el hash que conté els objectes d'interès per a l'amfitrió

Validations:

  • Must be a Hash
certname
Optional

optional: certname of the host

Validations:

  • Must be a String
type
Optional

optional: the STI type of host to create

Validations:

  • Must be a String
>>>

PUT /api/hosts/:id/rebuild_config
Rebuild orchestration config

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
only
Optional

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type
>>>

GET /api/hosts/:id/template/:kind
Preview rendered provisioning template content

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, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
kind
Required

Template kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP, cloud-init

Validations:

  • Must be a String