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

Paramètres

Nom du paramètre Description
thin
optionel

Afficher uniquement l'ID et le nom des hôtes

Validations:

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

hostgroup_id
optionel

ID du groupe d'hôtes

Validations:

  • String

location_id
optionel

ID d'emplacement

Validations:

  • String

organization_id
optionel

ID de l'organisation

Validations:

  • String

environment_id
optionel

ID de l'environnement

Validations:

  • String

include
optionel

Tableau de types d'informations supplémentaires à ajouter

Validations:

  • Must be one of: parameters, all_parameters.

search
optionel

filtrer les résultats

Validations:

  • String

order
optionel

Champ et sens de tri, ex: 'id DESC'

Validations:

  • String

page
optionel

paginer les résultats

Validations:

  • String

per_page
optionel

nombre d'entrées par requête

Validations:

  • String

Rechercher les champs

Nom du champ Type Valeurs possibles
activation_key string
activation_key_id string
addon text
addons_status valid, invalid
applicable_errata string
applicable_rpms string
architecture string
autoheal boolean
build true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
content_source string
content_view string
content_view_id integer
domain string
domain_id integer
environment string
errata_status security_needed, errata_needed, updated, unknown
facts string
global_status ok, warning, error
has_ip string
has_mac string
host_collection string
host_collection_id integer
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
hypervisor boolean
hypervisor_host string
image string
installable_errata string
installed_at datetime
installed_package string
installed_package_name string
ip string
last_checkin datetime
last_report datetime
lifecycle_environment string
lifecycle_environment_id integer
location string
location_id integer
mac string
managed true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
purpose_status valid, invalid
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
role text
role_status valid, invalid
service_level string
sla_status valid, invalid
smart_proxy string
status.applied integer
status.enabled true, false
status.failed integer
status.failed_restarts integer
status.interesting true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
subscription_id string
subscription_name string
subscription_status valid, partial, invalid, unknown, unsubscribed_hypervisor
subscription_uuid string
trace_app string
trace_app_type string
trace_helper string
trace_status reboot_needed, process_restart_needed, updated
upgradable_rpms string
usage text
usage_status valid, invalid
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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
optionel

Afficher les valeurs de paramètre masquées

Validations:

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


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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

host
requis

Validations:

  • Hash

host[name]
requis

Validations:

  • String

host[location_id]
requis

requis si les emplacements sont activés

Validations:

  • Must be a number.

host[organization_id]
requis

requis si les organisations sont activées

Validations:

  • Must be a number.

host[environment_id]
optionel , nil autorisé

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

Validations:

  • String

host[ip]
optionel , nil autorisé

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

Validations:

  • String

host[mac]
optionel , nil autorisé

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

Validations:

  • String

host[architecture_id]
optionel , nil autorisé

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]
optionel , nil autorisé

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]
optionel , nil autorisé

Validations:

  • Must be a number.

host[puppet_proxy_id]
optionel , nil autorisé

ID du Proxy Puppet

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optionel , nil autorisé

ID du Proxy Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

host[config_group_ids]
optionel , nil autorisé

ID des groupes de configuration associés

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optionel , nil autorisé

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

Validations:

  • String

host[medium_id]
optionel , nil autorisé

requis si le provisioning 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

Validations:

  • String

host[pxe_loader]
optionel , nil autorisé

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

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

host[ptable_id]
optionel , nil autorisé

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]
optionel , nil autorisé

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]
optionel , nil autorisé

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

Validations:

  • Must be a number.

host[root_pass]
optionel , nil autorisé

requis si l'hôte est géré 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:

  • String

host[model_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[hostgroup_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[owner_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[owner_type]
optionel , nil autorisé

Type de propriétaire de l'hôte

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[host_parameters_attributes]
optionel , nil autorisé

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

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
requis

Nom du paramêtre

Validations:

  • String

host[host_parameters_attributes][value]
requis

Valeur du paramètre

Validations:

  • String

host[build]
optionel , nil autorisé

Validations:

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

host[enabled]
optionel , nil autorisé

Inclure cet hôte dans les rapports Foreman

Validations:

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

host[provision_method]
optionel , nil autorisé

Méthode utilisée pour mettre en service l'hôte.

Validations:

  • Must be one of: build, image.

host[managed]
optionel , nil autorisé

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 one of: true, false, 1, 0.

host[progress_report_id]
optionel , nil autorisé

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

Validations:

  • String

host[comment]
optionel , nil autorisé

Informations additionnelles sur cet hôte

Validations:

  • String

host[capabilities]
optionel , nil autorisé

Validations:

  • String

host[compute_profile_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[interfaces_attributes]
optionel , nil autorisé

Interfaces réseau de cet hôte

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][ip]
optionel , nil autorisé

interface de l'adresse IPv4

Validations:

  • String

host[interfaces_attributes][ip6]
optionel , nil autorisé

interface de l'adresse IPv6

Validations:

  • String

host[interfaces_attributes][type]
optionel , nil autorisé

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

Validations:

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

host[interfaces_attributes][name]
optionel , nil autorisé

Nom DNS de l'interface

Validations:

  • String

host[interfaces_attributes][subnet_id]
optionel , nil autorisé

ID du sous-réseau Foreman de l'interface IPv4

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optionel , nil autorisé

ID du sous-réseau Foreman de l'interface IPv6

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optionel , nil autorisé

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]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][managed]
optionel , nil autorisé

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 one of: true, false, 1, 0.

host[interfaces_attributes][primary]
optionel , nil autorisé

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 one of: true, false, 1, 0.

host[interfaces_attributes][provision]
optionel , nil autorisé

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 one of: true, false, 1, 0.

host[interfaces_attributes][username]
optionel , nil autorisé

Seulement pour les interfaces BMC.

Validations:

  • String

host[interfaces_attributes][password]
optionel , nil autorisé

Seulement pour les interfaces BMC.

Validations:

  • String

host[interfaces_attributes][provider]
optionel , nil autorisé

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

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optionel , nil autorisé

Périphérique Alias ou VLAN

Validations:

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

host[interfaces_attributes][tag]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][mtu]
optionel , nil autorisé

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Integer

host[interfaces_attributes][attached_to]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][mode]
optionel , nil autorisé

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]
optionel , nil autorisé

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]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][compute_attributes]
optionel , nil autorisé

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

Validations:

  • Hash

host[compute_attributes]
optionel , nil autorisé

Autres attributs spécifiques de la ressource de calcul.

Validations:

  • Hash

host[content_facet_attributes]
optionel , nil autorisé

Parameters for host's content_facet facet

Validations:

  • Hash

host[content_facet_attributes][content_view_id]
optionel , nil autorisé

Validations:

  • Integer

host[content_facet_attributes][lifecycle_environment_id]
optionel , nil autorisé

Validations:

  • Integer

host[content_facet_attributes][content_source_id]
optionel , nil autorisé

Validations:

  • Integer

host[content_facet_attributes][kickstart_repository_id]
optionel , nil autorisé

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer

host[subscription_facet_attributes]
optionel , nil autorisé

Parameters for host's subscription_facet facet

Validations:

  • Hash

host[subscription_facet_attributes][release_version]
optionel , nil autorisé

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String

host[subscription_facet_attributes][autoheal]
optionel , nil autorisé

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

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

host[subscription_facet_attributes][purpose_usage]
optionel , nil autorisé

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_role]
optionel , nil autorisé

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_addons]
optionel , nil autorisé

Sets the system add-ons

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][service_level]
optionel , nil autorisé

Service level to be used for autoheal

Validations:

  • Integer

host[subscription_facet_attributes][hypervisor_guest_uuids]
optionel , nil autorisé

List of hypervisor guest uuids

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][installed_products_attributes]
optionel , nil autorisé

List of products installed on the host

Validations:

  • Must be an Array of nested elements

host[subscription_facet_attributes][installed_products_attributes][product_id]
optionel , nil autorisé

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][product_name]
optionel , nil autorisé

Product name as listed from a host's installed products

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][arch]
optionel , nil autorisé

Product architecture

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][version]
optionel , nil autorisé

Product version

Validations:

  • String


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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host
requis

Validations:

  • Hash

host[name]
optionel

Validations:

  • String

host[location_id]
optionel

requis si les emplacements sont activés

Validations:

  • Must be a number.

host[organization_id]
optionel

requis si les organisations sont activées

Validations:

  • Must be a number.

host[environment_id]
optionel , nil autorisé

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

Validations:

  • String

host[ip]
optionel , nil autorisé

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

Validations:

  • String

host[mac]
optionel , nil autorisé

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

Validations:

  • String

host[architecture_id]
optionel , nil autorisé

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]
optionel , nil autorisé

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]
optionel , nil autorisé

Validations:

  • Must be a number.

host[puppet_proxy_id]
optionel , nil autorisé

ID du Proxy Puppet

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optionel , nil autorisé

ID du Proxy Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

host[config_group_ids]
optionel , nil autorisé

ID des groupes de configuration associés

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optionel , nil autorisé

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

Validations:

  • String

host[medium_id]
optionel , nil autorisé

requis si le provisioning 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

Validations:

  • String

host[pxe_loader]
optionel , nil autorisé

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

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

host[ptable_id]
optionel , nil autorisé

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]
optionel , nil autorisé

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]
optionel , nil autorisé

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

Validations:

  • Must be a number.

host[root_pass]
optionel , nil autorisé

requis si l'hôte est géré 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:

  • String

host[model_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[hostgroup_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[owner_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[owner_type]
optionel , nil autorisé

Type de propriétaire de l'hôte

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[host_parameters_attributes]
optionel , nil autorisé

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

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
optionel

Nom du paramêtre

Validations:

  • String

host[host_parameters_attributes][value]
optionel

Valeur du paramètre

Validations:

  • String

host[build]
optionel , nil autorisé

Validations:

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

host[enabled]
optionel , nil autorisé

Inclure cet hôte dans les rapports Foreman

Validations:

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

host[provision_method]
optionel , nil autorisé

Méthode utilisée pour mettre en service l'hôte.

Validations:

  • Must be one of: build, image.

host[managed]
optionel , nil autorisé

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 one of: true, false, 1, 0.

host[progress_report_id]
optionel , nil autorisé

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

Validations:

  • String

host[comment]
optionel , nil autorisé

Informations additionnelles sur cet hôte

Validations:

  • String

host[capabilities]
optionel , nil autorisé

Validations:

  • String

host[compute_profile_id]
optionel , nil autorisé

Validations:

  • Must be a number.

host[interfaces_attributes]
optionel , nil autorisé

Interfaces réseau de cet hôte

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][ip]
optionel , nil autorisé

interface de l'adresse IPv4

Validations:

  • String

host[interfaces_attributes][ip6]
optionel , nil autorisé

interface de l'adresse IPv6

Validations:

  • String

host[interfaces_attributes][type]
optionel , nil autorisé

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

Validations:

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

host[interfaces_attributes][name]
optionel , nil autorisé

Nom DNS de l'interface

Validations:

  • String

host[interfaces_attributes][subnet_id]
optionel , nil autorisé

ID du sous-réseau Foreman de l'interface IPv4

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optionel , nil autorisé

ID du sous-réseau Foreman de l'interface IPv6

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optionel , nil autorisé

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]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][managed]
optionel , nil autorisé

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 one of: true, false, 1, 0.

host[interfaces_attributes][primary]
optionel , nil autorisé

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 one of: true, false, 1, 0.

host[interfaces_attributes][provision]
optionel , nil autorisé

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 one of: true, false, 1, 0.

host[interfaces_attributes][username]
optionel , nil autorisé

Seulement pour les interfaces BMC.

Validations:

  • String

host[interfaces_attributes][password]
optionel , nil autorisé

Seulement pour les interfaces BMC.

Validations:

  • String

host[interfaces_attributes][provider]
optionel , nil autorisé

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

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optionel , nil autorisé

Périphérique Alias ou VLAN

Validations:

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

host[interfaces_attributes][tag]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][mtu]
optionel , nil autorisé

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Integer

host[interfaces_attributes][attached_to]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][mode]
optionel , nil autorisé

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]
optionel , nil autorisé

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]
optionel , nil autorisé

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

Validations:

  • String

host[interfaces_attributes][compute_attributes]
optionel , nil autorisé

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

Validations:

  • Hash

host[compute_attributes]
optionel , nil autorisé

Autres attributs spécifiques de la ressource de calcul.

Validations:

  • Hash

host[content_facet_attributes]
optionel , nil autorisé

Parameters for host's content_facet facet

Validations:

  • Hash

host[content_facet_attributes][content_view_id]
optionel , nil autorisé

Validations:

  • Integer

host[content_facet_attributes][lifecycle_environment_id]
optionel , nil autorisé

Validations:

  • Integer

host[content_facet_attributes][content_source_id]
optionel , nil autorisé

Validations:

  • Integer

host[content_facet_attributes][kickstart_repository_id]
optionel , nil autorisé

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer

host[subscription_facet_attributes]
optionel , nil autorisé

Parameters for host's subscription_facet facet

Validations:

  • Hash

host[subscription_facet_attributes][release_version]
optionel , nil autorisé

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String

host[subscription_facet_attributes][autoheal]
optionel , nil autorisé

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

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

host[subscription_facet_attributes][purpose_usage]
optionel , nil autorisé

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_role]
optionel , nil autorisé

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_addons]
optionel , nil autorisé

Sets the system add-ons

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][service_level]
optionel , nil autorisé

Service level to be used for autoheal

Validations:

  • Integer

host[subscription_facet_attributes][hypervisor_guest_uuids]
optionel , nil autorisé

List of hypervisor guest uuids

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][installed_products_attributes]
optionel , nil autorisé

List of products installed on the host

Validations:

  • Must be an Array of nested elements

host[subscription_facet_attributes][installed_products_attributes][product_id]
optionel , nil autorisé

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][product_name]
optionel , nil autorisé

Product name as listed from a host's installed products

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][arch]
optionel , nil autorisé

Product architecture

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][version]
optionel , nil autorisé

Product version

Validations:

  • String


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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


GET /api/hosts/:id/enc
Obtenir les valeurs ENC de l'hôte

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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
requis

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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
requis

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

Validations:

  • String


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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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
requis

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

Validations:

  • String


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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

name
requis

Nom d'hôte de l'hôte

Validations:

  • String

facts
requis

hachage contenant les facts de cet hôte

Validations:

  • Hash

certname
optionel

facultatif : nom de certificat de l'hôte

Validations:

  • String

type
optionel

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

Validations:

  • String


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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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
optionel

Limiter les étapes de reconstruction, les étapes valides sont 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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

id
requis

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
requis

Types de modèles, valeurs possibles :

Validations:

  • String


PUT /api/hosts/:host_id/host_collections
Alter a hosts host collections

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Integer

organization_id
optionel

Tri par organisation

Validations:

  • Integer

host_id
requis

The id of the host to alter

Validations:

  • Must be a number.

host_collection_ids
requis

List of host collection ids to update

Validations:

  • Must be an array of any type