GET /api/hosts
Elenca tutti gli host

GET /api/hostgroups/:hostgroup_id/hosts
Elenca tutti gli host per un gruppo

GET /api/locations/:location_id/hosts
Elenca host per posizione

GET /api/organizations/:organization_id/hosts
Elenca host per organizzazione

GET /api/environments/:environment_id/hosts
Elenca host per ambiente

Parametri

Nome parametro Descrizione
thin
opzionale

Only list ID and name of hosts

Validations:

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

hostgroup_id
opzionale

ID gruppo di host

Validations:

  • Must be a String

location_id
opzionale

ID posizione

Validations:

  • Must be a String

organization_id
opzionale

ID organizzazione

Validations:

  • Must be a String

environment_id
opzionale

ID dell'ambiente

Validations:

  • Must be a String

include
opzionale

Array of extra information types to include

Validations:

  • Must be an array of [“parameters”, “all_parameters”]

search
opzionale

filtra i risultati

Validations:

  • Must be a String

order
opzionale

ordina risultati

Validations:

  • Must be a String

page
opzionale

paginazione risultati

Validations:

  • Must be a String

per_page
opzionale

numero di voci per richiesta

Validations:

  • Must be a String


GET /api/hosts/:id
Mostra un host

Parametri

Nome parametro Descrizione
id
richiesto

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
opzionale

Display hidden parameter values

Validations:

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


POST /api/hosts
Crea un host

Parametri

Nome parametro Descrizione
host
richiesto

Validations:

  • Must be a Hash

host[name]
richiesto

Validations:

  • Must be a String

host[location_id]
richiesto

necessario se le località sono abilitate

Validations:

  • Must be a number.

host[organization_id]
richiesto

necessario se le organizzazioni sono abilitate

Validations:

  • Must be a number.

host[environment_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a String

host[ip]
opzionale , consentito nil

non necessario se si utilizza una sottorete con DHCP proxy

Validations:

  • Must be a String

host[mac]
opzionale , consentito nil

necessario per gli host gestiti di tipo bare metal, non richiesto se è una macchina virtuale

Validations:

  • Must be a String

host[architecture_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a number.

host[domain_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a number.

host[realm_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[puppet_proxy_id]
opzionale , consentito nil

Puppet proxy ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opzionale , consentito nil

Puppet CA proxy ID

Validations:

  • Must be a number.

host[puppetclass_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

host[config_group_ids]
opzionale , consentito nil

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a String

host[medium_id]
opzionale , consentito nil

necessario se non è disponibile imaged based provisioning e l'host è gestito ed il valore non è stato ereditato dal gruppo di host

Validations:

  • Must be a String

host[pxe_loader]
opzionale , consentito nil

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

host[ptable_id]
opzionale , consentito nil

necessario se l'host è gestito e la partizione personalizzata non è stata definita

Validations:

  • Must be a number.

host[subnet_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a number.

host[compute_resource_id]
opzionale , consentito nil

nil indica che l'host è bare metal

Validations:

  • Must be a number.

host[root_pass]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host oppure se password predefinita nelle impostazioni

Validations:

  • Must be a String

host[model_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[hostgroup_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[owner_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[owner_type]
opzionale , consentito nil

Tipo di proprietario dell'host

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[host_parameters_attributes]
opzionale , consentito nil

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
richiesto

Name of the parameter

Validations:

  • Must be a String

host[host_parameters_attributes][value]
richiesto

Parameter value

Validations:

  • Must be a String

host[build]
opzionale , consentito nil

Validations:

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

host[enabled]
opzionale , consentito nil

Includi questo host all'interno del riporto di Foreman

Validations:

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

host[provision_method]
opzionale , consentito nil

The method used to provision the host. Possible provision_methods may be build (Basato sulla rete), image (Immagine basata)

Validations:

  • Must be a String

host[managed]
opzionale , consentito nil

Flag True/False se l'host è gestito o non gestito. Nota: questo valore indica anche se è necessario usare alcuni parametri

Validations:

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

host[progress_report_id]
opzionale , consentito nil

UUID per controllare gli stati dei compiti d'orchestrazione, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
opzionale , consentito nil

Informazioni aggiuntive su questo host

Validations:

  • Must be a String

host[capabilities]
opzionale , consentito nil

Validations:

  • Must be a String

host[compute_profile_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[interfaces_attributes]
opzionale , consentito nil

Host's network interfaces.

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opzionale , consentito nil

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

Validations:

  • Must be a String

host[interfaces_attributes][ip]
opzionale , consentito nil

IPv4 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
opzionale , consentito nil

IPv6 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][type]
opzionale , consentito nil

Interface type, e.g. bmc. Default is interface

Validations:

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

host[interfaces_attributes][name]
opzionale , consentito nil

Interface's DNS name

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
opzionale , consentito nil

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opzionale , consentito nil

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
opzionale , consentito nil

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

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
opzionale , consentito nil

Identificatore del dispositivo, es. eth0 o eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
opzionale , consentito nil

L'interfaccia deve essere gestita tramite DHCP e DNS smart proxy e può essere configurarta durante il provisioning?

Validations:

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

host[interfaces_attributes][primary]
opzionale , consentito nil

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]
opzionale , consentito nil

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]
opzionale , consentito nil

Solo per interfacce BMC.

Validations:

  • Must be a String

host[interfaces_attributes][password]
opzionale , consentito nil

Solo per interfacce BMC.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
opzionale , consentito nil

Provider dell'interfaccia, es IPMI. Solo per le interfacce BMC.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opzionale , consentito nil

Dispositivo VLAN o Alias

Validations:

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

host[interfaces_attributes][tag]
opzionale , consentito nil

VLAN tag, questo attributo ha la precedenza rispetto a VLAN ID. Solo per interfacce virtuali.

Validations:

  • Must be a String

host[interfaces_attributes][attached_to]
opzionale , consentito nil

Identificatore dell'interfaccia alla quale appartiene questa interfaccia, es. eth1. Solo per interfacce virtuali.

Validations:

  • Must be a String

host[interfaces_attributes][mode]
opzionale , consentito nil

Modalità associazione dell'interfaccia, es balance-rr. Solo per interfacce di aggregazione.

Validations:

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

host[interfaces_attributes][attached_devices]
opzionale , consentito nil

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]
opzionale , consentito nil

Opzioni separate da spazi, es. miimon=100. Solo per interfacce di aggregazione.

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
opzionale , consentito nil

Additional compute resource specific attributes for the interface.

Validations:

  • Must be a Hash

host[compute_attributes]
opzionale , consentito nil

Additional compute resource specific attributes.

Validations:

  • Must be a Hash


PUT /api/hosts/:id
Aggiorna un host

Parametri

Nome parametro Descrizione
id
richiesto

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
richiesto

Validations:

  • Must be a Hash

host[name]
opzionale

Validations:

  • Must be a String

host[location_id]
opzionale

necessario se le località sono abilitate

Validations:

  • Must be a number.

host[organization_id]
opzionale

necessario se le organizzazioni sono abilitate

Validations:

  • Must be a number.

host[environment_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a String

host[ip]
opzionale , consentito nil

non necessario se si utilizza una sottorete con DHCP proxy

Validations:

  • Must be a String

host[mac]
opzionale , consentito nil

necessario per gli host gestiti di tipo bare metal, non richiesto se è una macchina virtuale

Validations:

  • Must be a String

host[architecture_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a number.

host[domain_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a number.

host[realm_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[puppet_proxy_id]
opzionale , consentito nil

Puppet proxy ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opzionale , consentito nil

Puppet CA proxy ID

Validations:

  • Must be a number.

host[puppetclass_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

host[config_group_ids]
opzionale , consentito nil

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a String

host[medium_id]
opzionale , consentito nil

necessario se non è disponibile imaged based provisioning e l'host è gestito ed il valore non è stato ereditato dal gruppo di host

Validations:

  • Must be a String

host[pxe_loader]
opzionale , consentito nil

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

host[ptable_id]
opzionale , consentito nil

necessario se l'host è gestito e la partizione personalizzata non è stata definita

Validations:

  • Must be a number.

host[subnet_id]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a number.

host[compute_resource_id]
opzionale , consentito nil

nil indica che l'host è bare metal

Validations:

  • Must be a number.

host[root_pass]
opzionale , consentito nil

necessario se l'host è gestito ed il valore non è stato ereditato da un gruppo di host oppure se password predefinita nelle impostazioni

Validations:

  • Must be a String

host[model_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[hostgroup_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[owner_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[owner_type]
opzionale , consentito nil

Tipo di proprietario dell'host

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[host_parameters_attributes]
opzionale , consentito nil

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
opzionale

Name of the parameter

Validations:

  • Must be a String

host[host_parameters_attributes][value]
opzionale

Parameter value

Validations:

  • Must be a String

host[build]
opzionale , consentito nil

Validations:

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

host[enabled]
opzionale , consentito nil

Includi questo host all'interno del riporto di Foreman

Validations:

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

host[provision_method]
opzionale , consentito nil

The method used to provision the host. Possible provision_methods may be build (Basato sulla rete), image (Immagine basata)

Validations:

  • Must be a String

host[managed]
opzionale , consentito nil

Flag True/False se l'host è gestito o non gestito. Nota: questo valore indica anche se è necessario usare alcuni parametri

Validations:

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

host[progress_report_id]
opzionale , consentito nil

UUID per controllare gli stati dei compiti d'orchestrazione, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
opzionale , consentito nil

Informazioni aggiuntive su questo host

Validations:

  • Must be a String

host[capabilities]
opzionale , consentito nil

Validations:

  • Must be a String

host[compute_profile_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[interfaces_attributes]
opzionale , consentito nil

Host's network interfaces.

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opzionale , consentito nil

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

Validations:

  • Must be a String

host[interfaces_attributes][ip]
opzionale , consentito nil

IPv4 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
opzionale , consentito nil

IPv6 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][type]
opzionale , consentito nil

Interface type, e.g. bmc. Default is interface

Validations:

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

host[interfaces_attributes][name]
opzionale , consentito nil

Interface's DNS name

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
opzionale , consentito nil

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opzionale , consentito nil

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
opzionale , consentito nil

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

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
opzionale , consentito nil

Identificatore del dispositivo, es. eth0 o eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
opzionale , consentito nil

L'interfaccia deve essere gestita tramite DHCP e DNS smart proxy e può essere configurarta durante il provisioning?

Validations:

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

host[interfaces_attributes][primary]
opzionale , consentito nil

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]
opzionale , consentito nil

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]
opzionale , consentito nil

Solo per interfacce BMC.

Validations:

  • Must be a String

host[interfaces_attributes][password]
opzionale , consentito nil

Solo per interfacce BMC.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
opzionale , consentito nil

Provider dell'interfaccia, es IPMI. Solo per le interfacce BMC.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opzionale , consentito nil

Dispositivo VLAN o Alias

Validations:

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

host[interfaces_attributes][tag]
opzionale , consentito nil

VLAN tag, questo attributo ha la precedenza rispetto a VLAN ID. Solo per interfacce virtuali.

Validations:

  • Must be a String

host[interfaces_attributes][attached_to]
opzionale , consentito nil

Identificatore dell'interfaccia alla quale appartiene questa interfaccia, es. eth1. Solo per interfacce virtuali.

Validations:

  • Must be a String

host[interfaces_attributes][mode]
opzionale , consentito nil

Modalità associazione dell'interfaccia, es balance-rr. Solo per interfacce di aggregazione.

Validations:

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

host[interfaces_attributes][attached_devices]
opzionale , consentito nil

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]
opzionale , consentito nil

Opzioni separate da spazi, es. miimon=100. Solo per interfacce di aggregazione.

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
opzionale , consentito nil

Additional compute resource specific attributes for the interface.

Validations:

  • Must be a Hash

host[compute_attributes]
opzionale , consentito nil

Additional compute resource specific attributes.

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
Cancella un host

Parametri

Nome parametro Descrizione
id
richiesto

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
Get ENC values of host

Parametri

Nome parametro Descrizione
id
richiesto

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
Get configuration status of host

Return value may either be one of the following:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

Parametri

Nome parametro Descrizione
id
richiesto

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
Acquisisci stato dell'host

Returns string representing a host status of a given type

Parametri

Nome parametro Descrizione
id
richiesto

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
richiesto

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
Get vm attributes of host

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

Parametri

Nome parametro Descrizione
id
richiesto

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
Rimuovi associazione host da una VM

Parametri

Nome parametro Descrizione
id
richiesto

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
Eseguire una operazione di gestione dell'alimentazione sull'host

Parametri

Nome parametro Descrizione
id
richiesto

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
richiesto

azione di gestione dell'alimentazione, le azioni valide sono (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

Validations:

  • Must be a String


PUT /api/hosts/:id/boot
Avvia host dal dispositivo specificato

Parametri

Nome parametro Descrizione
id
richiesto

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
richiesto

dispositivo d'avvio, i dispositivi validi sono dischi, cdrom, pxe, bios

Validations:

  • Must be a String


POST /api/hosts/facts
Carica gli eventi per un host creando, se necessario, un host

Parametri

Nome parametro Descrizione
name
richiesto

hostname dell'host

Validations:

  • Must be a String

facts
richiesto

hash contenente gli eventi per l'host

Validations:

  • Must be a Hash

certname
opzionale

facoltativo: certname dell'host

Validations:

  • Must be a String

type
opzionale

facoltativo: tipo STI dell'host da creare

Validations:

  • Must be a String


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

Parametri

Nome parametro Descrizione
id
richiesto

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
opzionale

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

Parametri

Nome parametro Descrizione
id
richiesto

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
richiesto

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

Validations:

  • Must be a String