GET /api/hosts/:host_id/interfaces
Afficher toutes les interfaces de l'hôte

GET /api/domains/:domain_id/interfaces
Afficher toutes les interfaces du domaine

GET /api/subnets/:subnet_id/interfaces
Afficher toutes les interfaces du sous-réseau

Exemples

GET /api/hosts/host368/interfaces
200
{
  "total": 3,
  "subtotal": 3,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-11-07 08:37:16 UTC",
      "updated_at": "2019-11-07 08:37:16 UTC",
      "managed": true,
      "identifier": null,
      "id": 53,
      "name": "host368",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host368",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-11-07 08:37:16 UTC",
      "updated_at": "2019-11-07 08:37:16 UTC",
      "managed": true,
      "identifier": "eth184",
      "id": 54,
      "name": null,
      "ip": "0.0.0.38",
      "ip6": null,
      "mac": "00:33:45:ab:00:4e",
      "mtu": null,
      "fqdn": null,
      "primary": false,
      "provision": false,
      "type": "interface",
      "virtual": false
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-11-07 08:37:16 UTC",
      "updated_at": "2019-11-07 08:37:16 UTC",
      "managed": true,
      "identifier": "eth185",
      "id": 55,
      "name": null,
      "ip": "0.0.0.39",
      "ip6": null,
      "mac": "00:33:45:ab:00:4f",
      "mtu": null,
      "fqdn": null,
      "primary": false,
      "provision": false,
      "type": "bond",
      "mode": "balance-rr",
      "attached_devices": "",
      "bond_options": "",
      "virtual": true
    }
  ]
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
requis

ID ou nom d’hôte

Validations:

  • Must be a String

domain_id
optionel

ID du nom de domaine

Validations:

  • Must be a String

subnet_id
optionel

ID ou nom du sous réseau

Validations:

  • Must be a String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.


GET /api/hosts/:host_id/interfaces/:id
Afficher une interface d'un hôte

Exemples

GET /api/hosts/host369/interfaces/57
200
{
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "domain_id": null,
  "domain_name": null,
  "created_at": "2019-11-07 08:37:16 UTC",
  "updated_at": "2019-11-07 08:37:16 UTC",
  "managed": true,
  "identifier": "eth186",
  "id": 57,
  "name": null,
  "ip": "0.0.0.40",
  "ip6": null,
  "mac": "00:33:45:ab:00:50",
  "mtu": null,
  "fqdn": null,
  "primary": false,
  "provision": false,
  "type": "interface",
  "virtual": false
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
requis

ID ou nom d’hôte

Validations:

  • Must be a String

id
requis

ID ou nom de l’interface

Validations:

  • Must be a String


POST /api/hosts/:host_id/interfaces
Créer une interface sur un hôte

Exemples

POST /api/hosts/26/interfaces
{
  "interface": {
    "name": "谚喪駏篬庿濱麢鐨耼孞",
    "ip": "10.0.1.1",
    "mac": "AA:AA:AA:AA:AA:AA",
    "username": "foo",
    "password": "bar",
    "provider": "IPMI",
    "type": "bmc",
    "ip6": "2001:db8::1"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "hostname can contain only lowercase letters, numbers, dashes and dots according to RFC921, RFC952 and RFC1123"
      ]
    },
    "full_messages": [
      "Name hostname can contain only lowercase letters, numbers, dashes and dots according to RFC921, RFC952 and RFC1123"
    ]
  }
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
requis

ID ou nom d’hôte

Validations:

  • Must be a String

interface
requis

information de l’interface

Validations:

  • Must be a Hash

interface[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

interface[ip]
optionel , nil autorisé

interface de l’adresse IPv4

Validations:

  • Must be a String

interface[ip6]
optionel , nil autorisé

interface de l’adresse IPv6

Validations:

  • Must be a String

interface[type]
optionel , nil autorisé

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

Validations:

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

interface[name]
optionel , nil autorisé

Nom DNS de l’interface

Validations:

  • Must be a String

interface[subnet_id]
optionel , nil autorisé

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

Validations:

  • Must be a number.

interface[subnet6_id]
optionel , nil autorisé

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

Validations:

  • Must be a number.

interface[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.

interface[identifier]
optionel , nil autorisé

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

Validations:

  • Must be a String

interface[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.

interface[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.

interface[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.

interface[username]
optionel , nil autorisé

Seulement pour les interfaces BMC.

Validations:

  • Must be a String

interface[password]
optionel , nil autorisé

Seulement pour les interfaces BMC.

Validations:

  • Must be a String

interface[provider]
optionel , nil autorisé

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

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
optionel , nil autorisé

Périphérique Alias ou VLAN

Validations:

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

interface[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

interface[mtu]
optionel , nil autorisé

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

Validations:

  • Must be a Integer

interface[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

interface[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.

interface[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

interface[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

interface[compute_attributes]
optionel , nil autorisé

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

Validations:

  • Must be a Hash


PUT /api/hosts/:host_id/interfaces/:id
Mise à jour d'une interface d'un hôte

Exemples

PUT /api/hosts/host360/interfaces/30
{
  "interface": {
    "name": "test.foreman.com",
    "ip": "10.0.1.1",
    "mac": "AA:AA:AA:AA:AA:AA",
    "username": "foo",
    "password": "bar",
    "provider": "IPMI",
    "ip6": "2001:db8::1"
  }
}
200
{
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "domain_id": null,
  "domain_name": null,
  "created_at": "2019-11-07 08:37:15 UTC",
  "updated_at": "2019-11-07 08:37:15 UTC",
  "managed": true,
  "identifier": "eth169",
  "id": 30,
  "name": "test.foreman.com",
  "ip": "10.0.1.1",
  "ip6": "2001:db8::1",
  "mac": "aa:aa:aa:aa:aa:aa",
  "mtu": null,
  "fqdn": "test.foreman.com",
  "primary": false,
  "provision": false,
  "type": "interface",
  "virtual": false
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
requis

ID ou nom d’hôte

Validations:

  • Must be a String

id
requis

ID de l’interface

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

interface
requis

information de l’interface

Validations:

  • Must be a Hash

interface[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

interface[ip]
optionel , nil autorisé

interface de l’adresse IPv4

Validations:

  • Must be a String

interface[ip6]
optionel , nil autorisé

interface de l’adresse IPv6

Validations:

  • Must be a String

interface[type]
optionel , nil autorisé

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

Validations:

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

interface[name]
optionel , nil autorisé

Nom DNS de l’interface

Validations:

  • Must be a String

interface[subnet_id]
optionel , nil autorisé

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

Validations:

  • Must be a number.

interface[subnet6_id]
optionel , nil autorisé

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

Validations:

  • Must be a number.

interface[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.

interface[identifier]
optionel , nil autorisé

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

Validations:

  • Must be a String

interface[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.

interface[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.

interface[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.

interface[username]
optionel , nil autorisé

Seulement pour les interfaces BMC.

Validations:

  • Must be a String

interface[password]
optionel , nil autorisé

Seulement pour les interfaces BMC.

Validations:

  • Must be a String

interface[provider]
optionel , nil autorisé

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

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
optionel , nil autorisé

Périphérique Alias ou VLAN

Validations:

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

interface[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

interface[mtu]
optionel , nil autorisé

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

Validations:

  • Must be a Integer

interface[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

interface[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.

interface[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

interface[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

interface[compute_attributes]
optionel , nil autorisé

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

Validations:

  • Must be a Hash


DELETE /api/hosts/:host_id/interfaces/:id
Supprimer une interface d'hôte

Exemples

DELETE /api/hosts/32/interfaces/45
{
  "interface": {}
}
422
{
  "error": {
    "id": 45,
    "errors": {
      "primary": [
        "can't delete primary interface of managed host"
      ],
      "provision": [
        "can't delete provision interface of managed host"
      ]
    },
    "full_messages": [
      "Primary can't delete primary interface of managed host",
      "Provision can't delete provision interface of managed host"
    ]
  }
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
requis

ID ou nom d’hôte

Validations:

  • Must be a String

id
requis

ID de l’interface

Validations:

  • Must be a String