GET /api/hosts/:host_id/interfaces
List all interfaces for host

GET /api/domains/:domain_id/interfaces
List all interfaces for domain

GET /api/subnets/:subnet_id/interfaces
List all interfaces for subnet

Params

Param Name Description
host_id
Required

ID or name of host


Value: Must be String
domain_id
Optional

ID or name of domain


Value: Must be String
subnet_id
Optional

ID or name of subnet


Value: Must be String
page
Optional

페이지네이션 결과


Value: Must be String
per_page
Optional

요청 당 항목 수


Value: Must be String

GET /api/hosts/:host_id/interfaces/:id
Show an interface for host

Params

Param Name Description
host_id
Required

ID or name of host


Value: Must be String
id
Required

ID or name of interface


Value: Must be String

POST /api/hosts/:host_id/interfaces
Create an interface on a host

Params

Param Name Description
host_id
Required

ID or name of host


Value: Must be String
interface
Required

interface information


Value: Must be a Hash
interface[mac]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
interface[ip]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

IP address of interface


Value: Must be String
interface[type]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be one of: interface, bmc, bond.
interface[name]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Interface's DNS name


Value: Must be String
interface[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of interface


Value: Must be Fixnum
interface[domain_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be Fixnum
interface[identifier]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Device identifier, e.g. eth0 or eth1.1


Value: Must be String
interface[managed]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Only for BMC interfaces.


Value: Must be String
interface[password]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Only for BMC interfaces.


Value: Must be String
interface[provider]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be one of: IPMI.
interface[virtual]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Alias or VLAN device


Value: Must be 'true' or 'false'
interface[tag]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
interface[attached_to]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
interface[mode]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


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: ko.apipie.nil_allowed">Nil Allowed</span>

Identifiers of slave interfaces, e.g. `['eth1', 'eth2']`. Only for bond interfaces.


Value: Must be an array of any type
interface[bond_options]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
interface[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes for the interface.


Value: Must be Hash

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

Params

Param Name Description
host_id
Required

ID or name of host


Value: Must be String
id
Required

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
Required

interface information


Value: Must be a Hash
interface[mac]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
interface[ip]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

IP address of interface


Value: Must be String
interface[type]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be one of: interface, bmc, bond.
interface[name]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Interface's DNS name


Value: Must be String
interface[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of interface


Value: Must be Fixnum
interface[domain_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be Fixnum
interface[identifier]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Device identifier, e.g. eth0 or eth1.1


Value: Must be String
interface[managed]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Only for BMC interfaces.


Value: Must be String
interface[password]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Only for BMC interfaces.


Value: Must be String
interface[provider]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be one of: IPMI.
interface[virtual]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Alias or VLAN device


Value: Must be 'true' or 'false'
interface[tag]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
interface[attached_to]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
interface[mode]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


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: ko.apipie.nil_allowed">Nil Allowed</span>

Identifiers of slave interfaces, e.g. `['eth1', 'eth2']`. Only for bond interfaces.


Value: Must be an array of any type
interface[bond_options]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
interface[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes for the interface.


Value: Must be Hash

DELETE /api/hosts/:host_id/interfaces/:id
Delete a host's interface

Params

Param Name Description
host_id
Required

ID or name of host


Value: Must be String
id
Required

ID of interface


Value: Must be String