GET /api/hosts
Lister tous les hôtes

GET /api/hostgroups/:hostgroup_id/hosts
Liste de tous les hôtes d'un groupe d'hôtes

GET /api/locations/:location_id/hosts
Liste des hôtes par localisation

GET /api/organizations/:organization_id/hosts
Liste des hôtes par organisation

GET /api/environments/:environment_id/hosts
Liste des hôtes par environnement

Params

Param Name Description
hostgroup_id
Optional

ID du groupe d’hôtes


Value: Must be String
location_id
Optional

ID de la localisation


Value: Must be String
organization_id
Optional

ID de l’organisation


Value: Must be String
environment_id
Optional

ID de l’environnement


Value: Must be String
search
Optional

filtrer les résultats


Value: Must be String
order
Optional

trier les resultats


Value: Must be String
page
Optional

paginer les resultats


Value: Must be String
per_page
Optional

nombre d’entier par requête


Value: Must be String

GET /api/hosts/:id
Afficher un hôte

Params

Param Name Description
id
Required

Value: 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
Créer un hôte

Params

Param Name Description
host
Required

Value: Must be a Hash
host[name]
Required

Value: Must be String
host[environment_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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


Value: Must be String
host[architecture_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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

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

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

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


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

requis si le provisionnement n’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


Value: Must be String
host[ptable_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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


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

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


Value: Must be String
host[model_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

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

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

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

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

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

Value: Must be 'true' or 'false'
host[enabled]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

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.


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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


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

Informations additionnelles sur cet hôte


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

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

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

Value: Must be a Hash

PUT /api/hosts/:id
Mise à jour d'un hôte

Params

Param Name Description
id
Required

Value: 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

Value: Must be a Hash
host[name]
Optional

Value: Must be String
host[environment_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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


Value: Must be String
host[architecture_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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

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

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

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


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

requis si le provisionnement n’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


Value: Must be String
host[ptable_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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


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

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


Value: Must be String
host[model_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

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

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

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

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

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

Value: Must be 'true' or 'false'
host[enabled]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

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.


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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


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

Informations additionnelles sur cet hôte


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

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

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

Value: Must be a Hash

DELETE /api/hosts/:id
Supprimer un hôte

Params

Param Name Description
id
Required

Value: 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

Value: 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/puppetrun
Forcer un Puppet agent run sur l'hôte

Params

Param Name Description
id
Required

Value: 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
Dissocier l'hôte d'une VM

Params

Param Name Description
id
Required

Value: 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
Lancer une opération d'alimentation sur l'hôte

Params

Param Name Description
id
Required

Value: 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

Action sur l’alimentation. Les actions valides sont : (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status).


Value: Must be String

PUT /api/hosts/:id/boot
Serveur de boot du périphérique spécifié

Params

Param Name Description
id
Required

Value: 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

périphérique de démarrage. Les périphériques valides sont : disk, cdrom, pxe, bios


Value: Must be String

POST /api/hosts/facts
Télécharge les facts d'un hôte, créé l'hôte si besoin

Params

Param Name Description
name
Required

Nom d’hôte de l’hôte


Value: Must be String
facts
Required

hash contenant les facts de cet hôte


Value: Must be Hash
certname
Optional

optionnel : nom de certificat ou nom d’hôte


Value: Must be String
type
Optional

optionnel : le type STI de l’hôte à créer


Value: Must be String