GET /api/hosts/:host_id/interfaces
Llista totes les interfícies per a l'amfitrió

GET /api/domains/:domain_id/interfaces
Llista totes les interfícies per al domini

GET /api/subnets/:subnet_id/interfaces
Llista totes les interfícies per a la subxarxa

Params

Param name Description
host_id
required

Id. o nom de l'amfitrió

Validations:

  • Must be a String

domain_id
optional

Id. o nom del domini

Validations:

  • Must be a String

subnet_id
optional

Id. o nom de la subxarxa

Validations:

  • Must be a String

page
optional

pagina els resultats

Validations:

  • Must be a String

per_page
optional

Nombre d'entrades per petició

Validations:

  • Must be a String


GET /api/hosts/:host_id/interfaces/:id
Mostra una interfície per a l'amfitrió

Params

Param name Description
host_id
required

Id. o nom de l'amfitrió

Validations:

  • Must be a String

id
required

Id. o nom de la interfície

Validations:

  • Must be a String


POST /api/hosts/:host_id/interfaces
Crea una interfície en un amfitrió

Params

Param name Description
host_id
required

Id. o nom de l'amfitrió

Validations:

  • Must be a String

interface
required

informació de la interfície

Validations:

  • Must be a Hash

interface[mac]
optional , nil allowed

MAC address of interface. Required for managed interfaces on bare metal.

Validations:

  • Must be a String

interface[ip]
optional , nil allowed

IPv4 address of interface

Validations:

  • Must be a String

interface[ip6]
optional , nil allowed

IPv6 address of interface

Validations:

  • Must be a String

interface[type]
optional , nil allowed

Interface type, e.g. bmc. Default is interface

Validations:

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

interface[name]
optional , nil allowed

Nom DNS de la interfície

Validations:

  • Must be a String

interface[subnet_id]
optional , nil allowed

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

interface[subnet6_id]
optional , nil allowed

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

interface[domain_id]
optional , nil allowed

Foreman domain ID of interface. Required for primary interfaces on managed hosts.

Validations:

  • Must be a number.

interface[identifier]
optional , nil allowed

L'identificador de dispositiu, p. ex. eth0 o eth1.1

Validations:

  • Must be a String

interface[managed]
optional , nil allowed

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

Validations:

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

interface[primary]
optional , nil allowed

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

Validations:

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

interface[provision]
optional , nil allowed

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

Validations:

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

interface[username]
optional , nil allowed

Només per a les interfícies BMC.

Validations:

  • Must be a String

interface[password]
optional , nil allowed

Només per a les interfícies BMC.

Validations:

  • Must be a String

interface[provider]
optional , nil allowed

Proveïdor de la interfície, p. ex. IPMI. Únicament per a les interfícies BMC.

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
optional , nil allowed

Àlies o dispositiu VLAN

Validations:

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

interface[tag]
optional , nil allowed

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

Validations:

  • Must be a String

interface[attached_to]
optional , nil allowed

Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

Validations:

  • Must be a String

interface[mode]
optional , nil allowed

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

Validations:

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

interface[attached_devices]
optional , nil allowed

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

Validations:

  • Must be an array of any type

interface[bond_options]
optional , nil allowed

Space separated options, e.g. miimon=100. Only for bond interfaces.

Validations:

  • Must be a String

interface[compute_attributes]
optional , nil allowed

Additional compute resource specific attributes for the interface.

Validations:

  • Must be a Hash


PUT /api/hosts/:host_id/interfaces/:id
Actualitza la interfície d'un amfitrió

Params

Param name Description
host_id
required

Id. o nom de l'amfitrió

Validations:

  • Must be a String

id
required

Id. de la interfície

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
required

informació de la interfície

Validations:

  • Must be a Hash

interface[mac]
optional , nil allowed

MAC address of interface. Required for managed interfaces on bare metal.

Validations:

  • Must be a String

interface[ip]
optional , nil allowed

IPv4 address of interface

Validations:

  • Must be a String

interface[ip6]
optional , nil allowed

IPv6 address of interface

Validations:

  • Must be a String

interface[type]
optional , nil allowed

Interface type, e.g. bmc. Default is interface

Validations:

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

interface[name]
optional , nil allowed

Nom DNS de la interfície

Validations:

  • Must be a String

interface[subnet_id]
optional , nil allowed

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

interface[subnet6_id]
optional , nil allowed

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

interface[domain_id]
optional , nil allowed

Foreman domain ID of interface. Required for primary interfaces on managed hosts.

Validations:

  • Must be a number.

interface[identifier]
optional , nil allowed

L'identificador de dispositiu, p. ex. eth0 o eth1.1

Validations:

  • Must be a String

interface[managed]
optional , nil allowed

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

Validations:

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

interface[primary]
optional , nil allowed

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

Validations:

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

interface[provision]
optional , nil allowed

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

Validations:

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

interface[username]
optional , nil allowed

Només per a les interfícies BMC.

Validations:

  • Must be a String

interface[password]
optional , nil allowed

Només per a les interfícies BMC.

Validations:

  • Must be a String

interface[provider]
optional , nil allowed

Proveïdor de la interfície, p. ex. IPMI. Únicament per a les interfícies BMC.

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
optional , nil allowed

Àlies o dispositiu VLAN

Validations:

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

interface[tag]
optional , nil allowed

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

Validations:

  • Must be a String

interface[attached_to]
optional , nil allowed

Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

Validations:

  • Must be a String

interface[mode]
optional , nil allowed

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

Validations:

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

interface[attached_devices]
optional , nil allowed

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

Validations:

  • Must be an array of any type

interface[bond_options]
optional , nil allowed

Space separated options, e.g. miimon=100. Only for bond interfaces.

Validations:

  • Must be a String

interface[compute_attributes]
optional , nil allowed

Additional compute resource specific attributes for the interface.

Validations:

  • Must be a Hash


DELETE /api/hosts/:host_id/interfaces/:id
Suprimeix una interfície de l'amfitrió

Params

Param name Description
host_id
required

Id. o nom de l'amfitrió

Validations:

  • Must be a String

id
required

Id. de la interfície

Validations:

  • Must be a String