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

paginer les resultats

Validations:

  • Must be String

per_page
Optional

nombre d'entier par requête

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[location_id]
Required

requis si les emplacements sont activés

Validations:

  • Must be a number.

host[organization_id]
Required

requis si les organisations sont activées

Validations:

  • Must be a number.

host[environment_id]
Optional

requis si l'hôte est géré et la valeur n'est pas héritée d'un groupe d'hôtes

Validations:

  • Must be String

host[ip]
Optional

n'est pas requis si il s'agit d'un sous-réseau avec proxy DHCP

Validations:

  • Must be String

host[mac]
Optional

requis pour les hôtes gérés qui sont des serveurs physiques, non requis pour les machines virtuelles

Validations:

  • Must be String

host[architecture_id]
Optional

requis si l'hôte est géré et la valeur n'est pas héritée d'un groupe d'hôtes

Validations:

  • Must be a number.

host[domain_id]
Optional

requis si l'hôte est géré et la valeur n'est pas héritée d'un groupe d'hôtes

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

requis si l'hôte est géré et la valeur n'est pas héritée d'un groupe d'hôtes

Validations:

  • Must be String

host[medium_id]
Optional

requis si le provisioningn'est pas basé sur une image que l'hôte est géré et que la valeur n'est pas héritée d'un groupe d'hôtes

Validations:

  • Must be String

host[ptable_id]
Optional

requis si l'hôte est géré et possède une partition spécifique qui n'a pas été définie

Validations:

  • Must be a number.

host[subnet_id]
Optional

requis si l'hôte est géré et la valeur n'est pas héritée d'un groupe d'hôtes

Validations:

  • Must be a number.

host[compute_resource_id]
Optional

nil signifie que l'hôte est un serveur physique

Validations:

  • Must be a number.

host[root_pass]
Optional

requis si l'hôte est gérer et la valeur n'est pas héritée d'un groupe d'hôtes ou du mot de passe par défaut défini dans les paramètres généraux

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

Paramètres de l'hôte (tableau ou hash indexé)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
Required

Nom du paramêtre

Validations:

  • Must be String

host[host_parameters_attributes][value]
Required

Valeur du paramètre

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

Drapeau True/False pour déterminer si un hôte est géré ou non géré. Note : Cette valeur détermine aussi si certains paramètres sont obligatoires.

Validations:

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

host[progress_report_id]
Optional

UUID pour surveiller l'état des tâches d'orchestration : GET /api/orchestration/:UUID/tasks

Validations:

  • Must be String

host[comment]
Optional

Informations additionnelles sur cet hôte

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 pour surveiller l'état des tâches d'orchestration : 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
Voir le statut de l'hôte

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.