GET /api/hosts
Afficher tous les hôtes

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

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

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

Validations:

  • Must be String

location_id
Optional

ID de l'emplacement

Validations:

  • Must be String

organization_id
Optional

ID de l'organisation

Validations:

  • Must be String

environment_id
Optional

ID de l'environnement

Validations:

  • Must be String

include
Optional

Array of extra information types to include

Validations:

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

search
Optional

filtrer les résultats

Validations:

  • Must be String

order
Optional

trier les resultats

Validations:

  • Must be String

page
Optional

paginer les résultats

Validations:

  • Must be String

per_page
Optional

nombre d'entier par requête

Validations:

  • Must be String


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

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.

show_hidden_parameters
Optional

Display hidden parameter values

Validations:

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


POST /api/hosts
Créer un hôte

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

Validations:

  • 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

Validations:

  • 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 physiques, non requis pour les machines virtuelles

Validations:

  • 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

Validations:

  • 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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

ID du Proxy Puppet

Validations:

  • Must be a number.

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

ID du Proxy Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
Optional , <span class="translation_missing" title="translation missing: fr.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: fr.apipie.nil_allowed">Nil Allowed</span>

IDs of associated config groups

Validations:

  • 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

Validations:

  • Must be String

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

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

option nom de fichier DHCP (Grub2/PXELinux par defaut)

Validations:

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

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

Validations:

  • 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

Validations:

  • 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

Validations:

  • 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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

host[owner_type]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Type de propriétaire de l'hôte

Validations:

  • Must be one of: User, Usergroup.

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

Validations:

  • Must be a number.

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

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

Validations:

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

host[enabled]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

host[provision_method]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

La méthode utilisée pour le provisioning de l'hôte. Les méthodes possibles peuvent être build (Basé sur le réseau), image (Depuis une image)

Validations:

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

Validations:

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

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

Validations:

  • 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

Validations:

  • Must be String

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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

host[interfaces_attributes]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Interfaces réseau de cet hôte

Validations:

  • Must be an Array of nested elements

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

Adresse MAC de l'interface. Requis pour les interfaces gérées des hôtes physiques.

Validations:

  • Must be String

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

interface de l'adresse IPv4

Validations:

  • Must be String

host[interfaces_attributes][ip6]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

interface de l'adresse IPv6

Validations:

  • Must be String

host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Type d'interface , p.e. bmc. Valeur par défaut interface

Validations:

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

host[interfaces_attributes][name]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Nom DNS de l'interface

Validations:

  • Must be String

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

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

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

Domaine ID Foreman de l'interface. Requis pour les interfaces primaires des hôtes gérés.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Identifiant du périphérique. Ex : eth0 ou eth1.1

Validations:

  • Must be String

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

Cette interface doit-elle être gérée par les smart proxies DHCP et DNS et être configurée pendant le provisioning ?

Validations:

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

host[interfaces_attributes][primary]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Cette interface doit-elle être utilisée pour choisir le FQDN de l'hôte ? Chaque hôte géré doit avoir une interface primaire.

Validations:

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

host[interfaces_attributes][provision]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Cette interface doit-elle être utilisée pour les communications TFTP et PXE (ou SSH pour les images d'hôtes) ? Chaque hôte géré doit avoir une interface de provisioning.

Validations:

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

host[interfaces_attributes][username]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Seulement pour les interfaces BMC.

Validations:

  • Must be String

host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Seulement pour les interfaces BMC.

Validations:

  • Must be String

host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Fournisseur de l'interface. Ex. IPMI. Seulement pour les interfaces BMC.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Périphérique Alias ou VLAN

Validations:

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

host[interfaces_attributes][tag]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Tag VLAN. Cet attribut a précédence sur l'ID VLAN du sous-réseau. Seulement pour les interfaces virtuelles.

Validations:

  • Must be String

host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Identifiant de l'interface auquel est rattachée cette interface. Ex. eth1. Seulement pour les interfaces virtuelles.

Validations:

  • Must be String

host[interfaces_attributes][mode]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Mode d'agrégat de l'interface. Par exemple balance-rr. Seulement pour les interfaces bond.

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: fr.apipie.nil_allowed">Nil Allowed</span>

Identifiants des interfaces rattachées. Par ex. ['eth0', 'eth1']. Pour les interfaces bond, il s'agit des esclaves. Seulement pour les interfaces de type bond ou bridge.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Options séparées par des espaces. Ex : miimon=100. Seulement pour les interfaces bond.

Validations:

  • Must be String

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

Autres attributs pour la ressource de calcul spécifiques à cet interface.

Validations:

  • Must be Hash

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

Autres attributs spécifiques de la ressource de calcul.

Validations:

  • Must be Hash


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

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

requis si les emplacements sont activés

Validations:

  • Must be a number.

host[organization_id]
Optional

requis si les organisations sont activées

Validations:

  • Must be a number.

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

Validations:

  • 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

Validations:

  • 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 physiques, non requis pour les machines virtuelles

Validations:

  • 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

Validations:

  • 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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

ID du Proxy Puppet

Validations:

  • Must be a number.

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

ID du Proxy Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
Optional , <span class="translation_missing" title="translation missing: fr.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: fr.apipie.nil_allowed">Nil Allowed</span>

IDs of associated config groups

Validations:

  • 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

Validations:

  • Must be String

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

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

option nom de fichier DHCP (Grub2/PXELinux par defaut)

Validations:

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

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

Validations:

  • 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

Validations:

  • 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

Validations:

  • 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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

host[owner_type]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Type de propriétaire de l'hôte

Validations:

  • Must be one of: User, Usergroup.

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
Optional

Nom du paramêtre

Validations:

  • Must be String

host[host_parameters_attributes][value]
Optional

Valeur du paramètre

Validations:

  • Must be String

host[build]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

host[enabled]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

host[provision_method]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

La méthode utilisée pour le provisioning de l'hôte. Les méthodes possibles peuvent être build (Basé sur le réseau), image (Depuis une image)

Validations:

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

Validations:

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

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

Validations:

  • 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

Validations:

  • Must be String

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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

host[interfaces_attributes]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Interfaces réseau de cet hôte

Validations:

  • Must be an Array of nested elements

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

Adresse MAC de l'interface. Requis pour les interfaces gérées des hôtes physiques.

Validations:

  • Must be String

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

interface de l'adresse IPv4

Validations:

  • Must be String

host[interfaces_attributes][ip6]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

interface de l'adresse IPv6

Validations:

  • Must be String

host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Type d'interface , p.e. bmc. Valeur par défaut interface

Validations:

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

host[interfaces_attributes][name]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Nom DNS de l'interface

Validations:

  • Must be String

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

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

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

Domaine ID Foreman de l'interface. Requis pour les interfaces primaires des hôtes gérés.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Identifiant du périphérique. Ex : eth0 ou eth1.1

Validations:

  • Must be String

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

Cette interface doit-elle être gérée par les smart proxies DHCP et DNS et être configurée pendant le provisioning ?

Validations:

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

host[interfaces_attributes][primary]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Cette interface doit-elle être utilisée pour choisir le FQDN de l'hôte ? Chaque hôte géré doit avoir une interface primaire.

Validations:

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

host[interfaces_attributes][provision]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Cette interface doit-elle être utilisée pour les communications TFTP et PXE (ou SSH pour les images d'hôtes) ? Chaque hôte géré doit avoir une interface de provisioning.

Validations:

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

host[interfaces_attributes][username]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Seulement pour les interfaces BMC.

Validations:

  • Must be String

host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Seulement pour les interfaces BMC.

Validations:

  • Must be String

host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Fournisseur de l'interface. Ex. IPMI. Seulement pour les interfaces BMC.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Périphérique Alias ou VLAN

Validations:

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

host[interfaces_attributes][tag]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Tag VLAN. Cet attribut a précédence sur l'ID VLAN du sous-réseau. Seulement pour les interfaces virtuelles.

Validations:

  • Must be String

host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Identifiant de l'interface auquel est rattachée cette interface. Ex. eth1. Seulement pour les interfaces virtuelles.

Validations:

  • Must be String

host[interfaces_attributes][mode]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Mode d'agrégat de l'interface. Par exemple balance-rr. Seulement pour les interfaces bond.

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: fr.apipie.nil_allowed">Nil Allowed</span>

Identifiants des interfaces rattachées. Par ex. ['eth0', 'eth1']. Pour les interfaces bond, il s'agit des esclaves. Seulement pour les interfaces de type bond ou bridge.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Options séparées par des espaces. Ex : miimon=100. Seulement pour les interfaces bond.

Validations:

  • Must be String

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

Autres attributs pour la ressource de calcul spécifiques à cet interface.

Validations:

  • Must be Hash

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

Autres attributs spécifiques de la ressource de calcul.

Validations:

  • Must be Hash


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

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/enc
Get ENC values of 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.


GET /api/hosts/:id/status
Statut de configuration 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.


GET /api/hosts/:id/status/:type
Voir le statut de l'hôte

Returns string representing a host status of a given type

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.

type
Required

le type de statut est l'un de ceux-ci :

  • global

  • configuration

  • build

Validations:

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


GET /api/hosts/:id/vm_compute_attributes
Voir les attributs VM de l'hôte

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

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.


PUT /api/hosts/:id/puppetrun
Forcer un Puppet agent à s'exécuter sur l'hôte

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.


PUT /api/hosts/:id/disassociate
Dissocier l'hôte d'une VM

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.


PUT /api/hosts/:id/power
Lancer une opération d'alimentation sur l'hôte

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.

power_action
Required

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

Validations:

  • Must be String


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

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.

device
Required

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

Validations:

  • 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

Validations:

  • Must be String

facts
Required

hash contenant les facts de cet hôte

Validations:

  • Must be Hash

certname
Optional

facultatif : nom de certificat de l'hôte

Validations:

  • Must be String

type
Optional

facultatif : le type STI de l'hôte à créer

Validations:

  • Must be String


PUT /api/hosts/:id/rebuild_config
Reconstruire la configuration d'orchestration

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.

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
Aperçu du rendu du contenu du modèle de provisioning

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.

kind
Required

Types de modèles, valeurs possibles : PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP

Validations:

  • Must be String