Exemples

PUT /api/hosts/host20
{
  "host": {
    "name": "testhost11",
    "environment_id": 334344675,
    "domain_id": 22495316,
    "ptable_id": 1007981717,
    "medium_id": 980190962,
    "architecture_id": 501905019,
    "operatingsystem_id": 1073012828,
    "puppet_proxy_id": 182953976,
    "compute_resource_id": 980190962,
    "root_pass": "xybxa6JUkz63w",
    "location_id": 255093256,
    "organization_id": 447626438,
    "ip": "10.0.0.20",
    "mac": "52:53:00:1e:85:93",
    "compute_attributes": {
      "cpus": 4,
      "memory": 1024
    }
  }
}
200
{
  "ip": "10.0.0.20",
  "ip6": null,
  "environment_id": 334344675,
  "environment_name": "production",
  "last_report": null,
  "mac": "52:53:00:1e:85:93",
  "realm_id": null,
  "realm_name": null,
  "sp_mac": null,
  "sp_ip": null,
  "sp_name": null,
  "domain_id": 22495316,
  "domain_name": "mydomain.net",
  "architecture_id": 501905019,
  "architecture_name": "x86_64",
  "operatingsystem_id": 1073012828,
  "operatingsystem_name": "RHEL 6.1",
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": 1007981717,
  "ptable_name": "ptable14",
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "enabled": true,
  "managed": false,
  "use_image": null,
  "image_file": "",
  "uuid": null,
  "compute_resource_id": 980190962,
  "compute_resource_name": "bigcompute",
  "compute_profile_id": null,
  "compute_profile_name": null,
  "capabilities": [
    "build",
    "image",
    "new_volume"
  ],
  "provision_method": "build",
  "certname": "testhost11.mydomain.net",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-09-11 14:31:59 UTC",
  "updated_at": "2019-09-11 14:31:59 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "Warning",
  "uptime_seconds": null,
  "organization_id": 447626438,
  "organization_name": "Organization 1",
  "location_id": 255093256,
  "location_name": "Location 1",
  "puppet_status": 0,
  "model_name": null,
  "configuration_status": 0,
  "configuration_status_label": "No reports",
  "name": "testhost11.mydomain.net",
  "id": 104,
  "puppet_proxy_id": 182953976,
  "puppet_proxy_name": "Puppetmaster Proxy",
  "puppet_ca_proxy_id": 182953976,
  "puppet_ca_proxy_name": "Puppetmaster Proxy",
  "puppet_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "puppet_ca_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "hostgroup_name": null,
  "hostgroup_title": null,
  "parameters": [],
  "all_parameters": [
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 716195090,
      "name": "os1",
      "parameter_type": null,
      "value": "os1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 665394701,
      "name": "parameter",
      "parameter_type": null,
      "value": "value1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": null,
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": null,
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": null,
      "value": "myvalue"
    }
  ],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": 22495316,
      "domain_name": "mydomain.net",
      "created_at": "2019-09-11 14:31:59 UTC",
      "updated_at": "2019-09-11 14:31:59 UTC",
      "managed": true,
      "identifier": null,
      "id": 113,
      "name": "testhost11.mydomain.net",
      "ip": "10.0.0.20",
      "ip6": null,
      "mac": "52:53:00:1e:85:93",
      "mtu": null,
      "fqdn": "testhost11.mydomain.net",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    }
  ],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "permissions": {
    "view_hosts": true,
    "create_hosts": true,
    "edit_hosts": true,
    "destroy_hosts": true,
    "build_hosts": true,
    "power_hosts": true,
    "console_hosts": true,
    "ipmi_boot_hosts": true,
    "puppetrun_hosts": true
  }
}

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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
requis

Validations:

  • Must be a Hash

host[name]
optionel

Validations:

  • Must be a String

host[location_id]
optionel

Validations:

  • Must be a number.

host[organization_id]
optionel

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:

  • Must be a String

host[ip]
optionel , nil autorisé

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

Validations:

  • Must be a 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:

  • Must be a 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:

  • Must be a 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:

  • Must be a 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 BIOS, Grub2 ELF, 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:

  • Must be a 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:

  • Must be a String

host[host_parameters_attributes][value]
optionel

Valeur du paramètre

Validations:

  • Must be a 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:

  • Must be a String

host[comment]
optionel , nil autorisé

Informations additionnelles sur cet hôte

Validations:

  • Must be a String

host[capabilities]
optionel , nil autorisé

Validations:

  • Must be a 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:

  • Must be a String

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

interface de l’adresse IPv4

Validations:

  • Must be a String

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

interface de l’adresse IPv6

Validations:

  • Must be a 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:

  • Must be a 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:

  • Must be a 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:

  • Must be a String

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

Seulement pour les interfaces BMC.

Validations:

  • Must be a 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:

  • Must be a String

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

MTU, cet attribut a précédence sur la MTU du sous réseau.

Validations:

  • Must be a 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:

  • Must be a 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:

  • Must be a String

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

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

Validations:

  • Must be a Hash

host[compute_attributes]
optionel , nil autorisé

Autres attributs spécifiques de la ressource de calcul.

Validations:

  • Must be a Hash