GET /api/hosts/:host_id/interfaces
ホストのインターフェイス一覧

GET /api/domains/:domain_id/interfaces
ドメインのインターフェイス一覧

GET /api/subnets/:subnet_id/interfaces
サブネットのインターフェイス一覧

Params

Param Name Description
host_id
Required

ホストの ID または名前


Value: Must be String
domain_id
Optional

ドメインの ID または名前


Value: Must be String
subnet_id
Optional

サブネットの ID または名前


Value: Must be String
page
Optional

結果をページ分割


Value: Must be String
per_page
Optional

リクエストあたりのエントリ数


Value: Must be String

GET /api/hosts/:host_id/interfaces/:id
ホストのインターフェイスを表示

Params

Param Name Description
host_id
Required

ホストの ID または名前


Value: Must be String
id
Required

インターフェイスの ID または名前


Value: Must be String

POST /api/hosts/:host_id/interfaces
ホストにインターフェイスを作成

Params

Param Name Description
host_id
Required

ホストの ID または名前


Value: Must be String
interface
Required

インターフェイス情報


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

インターフェイスの MAC アドレス


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

インターフェイスの IP アドレス


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

インターフェイス種別 例: bmc


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

インターフェイスの DNS 名


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

インターフェイスの Foreman サブネット ID


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

インターフェイスの Foreman ドメイン ID


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

デバイス識別子 例: eth0 or eth1.1


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

このインタフェースは、 DHCP と DNS スマートプロキシ経由で管理する必要があり、それは、プロビジョニング中に設定する必要がありますか?


Value: Must be 'true' or 'false'
interface[primary]
Optional , <span class="translation_missing" title="translation missing: ja.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: ja.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: ja.apipie.nil_allowed">Nil Allowed</span>

BMCインタフェースの場合のみ。


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

BMCインタフェースの場合のみ。


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

インタフェースプロバイダ 例: IPMI. BMCインタフェースの場合のみ。


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

エイリアスもしくは VLAN デバイス


Value: Must be 'true' or 'false'
interface[tag]
Optional , <span class="translation_missing" title="translation missing: ja.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: ja.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: ja.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: ja.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: ja.apipie.nil_allowed">Nil Allowed</span>

空白で区切られたオプション(例 : miimon=100 )。 bond インタフェースのみ.


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

インタフェースのための追加のコンピュートリソース固有の属性。


Value: Must be Hash

PUT /api/hosts/:host_id/interfaces/:id
ホストのインターフェイスを更新

Params

Param Name Description
host_id
Required

ホストの ID または名前


Value: Must be String
id
Required

インターフェイスの ID


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

インターフェイス情報


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

インターフェイスの MAC アドレス


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

インターフェイスの IP アドレス


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

インターフェイス種別 例: bmc


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

インターフェイスの DNS 名


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

インターフェイスの Foreman サブネット ID


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

インターフェイスの Foreman ドメイン ID


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

デバイス識別子 例: eth0 or eth1.1


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

このインタフェースは、 DHCP と DNS スマートプロキシ経由で管理する必要があり、それは、プロビジョニング中に設定する必要がありますか?


Value: Must be 'true' or 'false'
interface[primary]
Optional , <span class="translation_missing" title="translation missing: ja.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: ja.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: ja.apipie.nil_allowed">Nil Allowed</span>

BMCインタフェースの場合のみ。


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

BMCインタフェースの場合のみ。


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

インタフェースプロバイダ 例: IPMI. BMCインタフェースの場合のみ。


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

エイリアスもしくは VLAN デバイス


Value: Must be 'true' or 'false'
interface[tag]
Optional , <span class="translation_missing" title="translation missing: ja.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: ja.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: ja.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: ja.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: ja.apipie.nil_allowed">Nil Allowed</span>

空白で区切られたオプション(例 : miimon=100 )。 bond インタフェースのみ.


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

インタフェースのための追加のコンピュートリソース固有の属性。


Value: Must be Hash

DELETE /api/hosts/:host_id/interfaces/:id
ホストのインタフェースを削除する

Params

Param Name Description
host_id
Required

ホストの ID または名前


Value: Must be String
id
Required

インターフェイスの ID


Value: Must be String