GET /api/hosts/:host_id/interfaces
Lister toutes les interfaces d'un hôte

GET /api/domains/:domain_id/interfaces
Liste de toutes les interfaces par domaine

GET /api/subnets/:subnet_id/interfaces
Liste de toutes les interfaces par sous réseau

Params

Param Name Description
host_id
Required

ID ou nom d'hôte


Value:

Must be String

domain_id
Optional

ID du nom de domaine


Value:

Must be String

subnet_id
Optional

ID ou nom du sous réseau


Value:

Must be String

page
Optional

paginer les resultats


Value:

Must be String

per_page
Optional

nombre d'entier par requête


Value:

Must be String


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

Params

Param Name Description
host_id
Required

ID ou nom d'hôte


Value:

Must be String

id
Required

ID ou nom de l'interface


Value:

Must be String


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

Params

Param Name Description
host_id
Required

ID ou nom d'hôte


Value:

Must be String

interface
Required

information de l'interface


Value:

Must be a Hash

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


Value:

Must be String

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

Adresse IP de l'interface


Value:

Must be String

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


Value:

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

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

Nom DNS de l'interface


Value:

Must be String

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

ID du sous réseau Foreman de cette interface


Value:

Must be Fixnum

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


Value:

Must be Fixnum

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


Value:

Must be String

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

Est ce que cette interface est gérée par les smart proxies DHCP et DNS et doit être configurée pendant le provisionnement ?


Value:

Must be 'true' or 'false'

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


Value:

Must be 'true' or 'false'

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


Value:

Must be 'true' or 'false'

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

Seulement pour les interfaces BMC.


Value:

Must be String

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

Seulement pour les interfaces BMC.


Value:

Must be String

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


Value:

Must be one of: IPMI.

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

Périphérique Alias ou VLAN


Value:

Must be 'true' or 'false'

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


Value:

Must be String

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


Value:

Must be String

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

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


Value:

Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

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

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.


Value:

Must be an array of any type

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


Value:

Must be String

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

Autres attributs pour la ressource d'ordinateur spécifiques à cet interface.


Value:

Must be Hash


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

Params

Param Name Description
host_id
Required

ID ou nom d'hôte


Value:

Must be String

id
Required

ID de l'interface


Value:

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

interface
Required

information de l'interface


Value:

Must be a Hash

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


Value:

Must be String

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

Adresse IP de l'interface


Value:

Must be String

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


Value:

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

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

Nom DNS de l'interface


Value:

Must be String

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

ID du sous réseau Foreman de cette interface


Value:

Must be Fixnum

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


Value:

Must be Fixnum

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


Value:

Must be String

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

Est ce que cette interface est gérée par les smart proxies DHCP et DNS et doit être configurée pendant le provisionnement ?


Value:

Must be 'true' or 'false'

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


Value:

Must be 'true' or 'false'

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


Value:

Must be 'true' or 'false'

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

Seulement pour les interfaces BMC.


Value:

Must be String

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

Seulement pour les interfaces BMC.


Value:

Must be String

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


Value:

Must be one of: IPMI.

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

Périphérique Alias ou VLAN


Value:

Must be 'true' or 'false'

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


Value:

Must be String

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


Value:

Must be String

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

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


Value:

Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

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

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.


Value:

Must be an array of any type

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


Value:

Must be String

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

Autres attributs pour la ressource d'ordinateur spécifiques à cet interface.


Value:

Must be Hash


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

Params

Param Name Description
host_id
Required

ID ou nom d'hôte


Value:

Must be String

id
Required

ID de l'interface


Value:

Must be String