GET /api/hosts/:host_id/interfaces
Listar todas as interfaces para host

GET /api/domains/:domain_id/interfaces
Listar todas as interfaces para domínio

GET /api/subnets/:subnet_id/interfaces
Listar todas as interfaces para subrede

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host


Value:

Must be String

domain_id
opcional

ID ou nome do domínio


Value:

Must be String

subnet_id
opcional

ID ou nome da subrede


Value:

Must be String

page
opcional

paginar resultados


Value:

Must be String

per_page
opcional

número de entradas por requisições


Value:

Must be String


GET /api/hosts/:host_id/interfaces/:id
Exibir uma interface para host

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host


Value:

Must be String

id
requerido

ID ou nome da interface


Value:

Must be String


POST /api/hosts/:host_id/interfaces
Criar uma interface no host

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host


Value:

Must be String

interface
requerido

interface information


Value:

Must be a Hash

interface[mac]
opcional , nulo permitido

Mac address da interface. Necessário para gerenciar interfaces em bare metal.


Value:

Must be String

interface[ip]
opcional , nulo permitido

Endereço IP da interface


Value:

Must be String

interface[type]
opcional , nulo permitido

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


Value:

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

interface[name]
opcional , nulo permitido

Interface's DNS name


Value:

Must be String

interface[subnet_id]
opcional , nulo permitido

Foreman subnet ID of interface


Value:

Must be Fixnum

interface[domain_id]
opcional , nulo permitido

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


Value:

Must be Fixnum

interface[identifier]
opcional , nulo permitido

Identificador do dispositivo, ex.: eth0 ou eth1.1


Value:

Must be String

interface[managed]
opcional , nulo permitido

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


Value:

Must be 'true' or 'false'

interface[primary]
opcional , nulo permitido

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


Value:

Must be 'true' or 'false'

interface[provision]
opcional , nulo permitido

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


Value:

Must be 'true' or 'false'

interface[username]
opcional , nulo permitido

Only for BMC interfaces.


Value:

Must be String

interface[password]
opcional , nulo permitido

Only for BMC interfaces.


Value:

Must be String

interface[provider]
opcional , nulo permitido

Interface provider, e.g. IPMI. Only for BMC interfaces.


Value:

Must be one of: IPMI.

interface[virtual]
opcional , nulo permitido

Alias ou VLAN


Value:

Must be 'true' or 'false'

interface[tag]
opcional , nulo permitido

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


Value:

Must be String

interface[attached_to]
opcional , nulo permitido

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


Value:

Must be String

interface[mode]
opcional , nulo permitido

Modo do bond da interface, ex.: balance-rr. Somente para interfaces em bond.


Value:

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

interface[attached_devices]
opcional , nulo permitido

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]
opcional , nulo permitido

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


Value:

Must be String

interface[compute_attributes]
opcional , nulo permitido

Additional compute resource specific attributes for the interface.


Value:

Must be Hash


PUT /api/hosts/:host_id/interfaces/:id
Update a host's interface

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host


Value:

Must be String

id
requerido

ID of 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
requerido

interface information


Value:

Must be a Hash

interface[mac]
opcional , nulo permitido

Mac address da interface. Necessário para gerenciar interfaces em bare metal.


Value:

Must be String

interface[ip]
opcional , nulo permitido

Endereço IP da interface


Value:

Must be String

interface[type]
opcional , nulo permitido

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


Value:

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

interface[name]
opcional , nulo permitido

Interface's DNS name


Value:

Must be String

interface[subnet_id]
opcional , nulo permitido

Foreman subnet ID of interface


Value:

Must be Fixnum

interface[domain_id]
opcional , nulo permitido

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


Value:

Must be Fixnum

interface[identifier]
opcional , nulo permitido

Identificador do dispositivo, ex.: eth0 ou eth1.1


Value:

Must be String

interface[managed]
opcional , nulo permitido

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


Value:

Must be 'true' or 'false'

interface[primary]
opcional , nulo permitido

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


Value:

Must be 'true' or 'false'

interface[provision]
opcional , nulo permitido

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


Value:

Must be 'true' or 'false'

interface[username]
opcional , nulo permitido

Only for BMC interfaces.


Value:

Must be String

interface[password]
opcional , nulo permitido

Only for BMC interfaces.


Value:

Must be String

interface[provider]
opcional , nulo permitido

Interface provider, e.g. IPMI. Only for BMC interfaces.


Value:

Must be one of: IPMI.

interface[virtual]
opcional , nulo permitido

Alias ou VLAN


Value:

Must be 'true' or 'false'

interface[tag]
opcional , nulo permitido

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


Value:

Must be String

interface[attached_to]
opcional , nulo permitido

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


Value:

Must be String

interface[mode]
opcional , nulo permitido

Modo do bond da interface, ex.: balance-rr. Somente para interfaces em bond.


Value:

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

interface[attached_devices]
opcional , nulo permitido

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]
opcional , nulo permitido

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


Value:

Must be String

interface[compute_attributes]
opcional , nulo permitido

Additional compute resource specific attributes for the interface.


Value:

Must be Hash


DELETE /api/hosts/:host_id/interfaces/:id
Apagar um interface do host

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host


Value:

Must be String

id
requerido

ID of interface


Value:

Must be String