GET /api/hosts
List all hosts.

Params

Param Name Description
search
Optional

Filter results

Validations:

  • Must be String

order
Optional

Sort results

Validations:

  • Must be String

page
Optional

paginazione risultati

Validations:

  • Must be String

per_page
Optional

numero di voci per richiesta

Validations:

  • Must be String


GET /api/hosts/:id
Show a host.

Params

Param Name Description
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.


POST /api/hosts
Create a host.

Params

Param Name Description
host
Required

Validations:

  • Must be a Hash

host[name]
Required

Validations:

  • Must be String

host[environment_id]
Optional

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

Validations:

  • Must be String

host[ip]
Optional

non necessario se si utilizza una sottorete con DHCP proxy

Validations:

  • Must be String

host[mac]
Optional

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

Validations:

  • Must be String

host[architecture_id]
Optional

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

Validations:

  • Must be a number.

host[domain_id]
Optional

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

Validations:

  • Must be a number.

host[realm_id]
Optional

Validations:

  • Must be a number.

host[puppet_proxy_id]
Optional

Validations:

  • Must be a number.

host[puppetclass_ids]
Optional

Validations:

  • Must be an array of any type

host[operatingsystem_id]
Optional

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

Validations:

  • Must be String

host[medium_id]
Optional

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

Validations:

  • Must be String

host[ptable_id]
Optional

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

Validations:

  • Must be a number.

host[subnet_id]
Optional

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]
Optional

nil indica che l'host è bare metal

Validations:

  • Must be a number.

host[root_pass]
Optional

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 String

host[model_id]
Optional

Validations:

  • Must be a number.

host[hostgroup_id]
Optional

Validations:

  • Must be a number.

host[owner_id]
Optional

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
Optional

Validations:

  • Must be a number.

host[image_id]
Optional

Validations:

  • Must be a number.

host[host_parameters_attributes]
Optional

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
Required

Name of the parameter

Validations:

  • Must be String

host[host_parameters_attributes][value]
Required

Parameter value

Validations:

  • Must be String

host[build]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[enabled]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[provision_method]
Optional

Validations:

  • Must be String

host[managed]
Optional

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[progress_report_id]
Optional

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

Validations:

  • Must be String

host[comment]
Optional

Informazioni aggiuntive su questo host

Validations:

  • Must be String

host[capabilities]
Optional

Validations:

  • Must be String

host[compute_profile_id]
Optional

Validations:

  • Must be a number.

host[compute_attributes]
Optional

Validations:

  • Must be a Hash


PUT /api/hosts/:id
Update a host.

Params

Param Name Description
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 String

host[environment_id]
Optional

Validations:

  • Must be String

host[ip]
Optional

not required if using a subnet with dhcp proxy

Validations:

  • Must be String

host[mac]
Optional

not required if its a virtual machine

Validations:

  • Must be String

host[architecture_id]
Optional

Validations:

  • Must be a number.

host[domain_id]
Optional

Validations:

  • Must be a number.

host[puppet_proxy_id]
Optional

Validations:

  • Must be a number.

host[operatingsystem_id]
Optional

Validations:

  • Must be String

host[puppetclass_ids]
Optional

Validations:

  • Must be an array of any type

host[medium_id]
Optional

Validations:

  • Must be a number.

host[ptable_id]
Optional

Validations:

  • Must be a number.

host[subnet_id]
Optional

Validations:

  • Must be a number.

host[compute_resource_id]
Optional

Validations:

  • Must be a number.

host[sp_subnet_id]
Optional

Validations:

  • Must be a number.

host[model_id]
Optional

Validations:

  • Must be a number.

host[hostgroup_id]
Optional

Validations:

  • Must be a number.

host[owner_id]
Optional

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
Optional

Validations:

  • Must be a number.

host[image_id]
Optional

Validations:

  • Must be a number.

host[host_parameters_attributes]
Optional

Validations:

  • Must be an array of any type

host[build]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[enabled]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[provision_method]
Optional

Validations:

  • Must be String

host[managed]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[progress_report_id]
Optional

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

Validations:

  • Must be String

host[capabilities]
Optional

Validations:

  • Must be String

host[compute_attributes]
Optional

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
Delete an host.

Params

Param Name Description
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/status
Acquisisci stato dell'host

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

Params

Param Name Description
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.