GET /api/subnets
サブネット一覧

GET /api/domains/:domain_id/subnets
ドメインのサブネット一覧

GET /api/locations/:location_id/subnets
ロケーションごとのサブネット一覧

GET /api/organizations/:organization_id/subnets
組織ごとのサブネット一覧

Params

Param Name Description
domain_id
Optional

ドメインの ID

Validations:

  • Must be String

location_id
Optional

ロケーションのスコープ

Validations:

  • Must be Integer

organization_id
Optional

組織のスコープ

Validations:

  • Must be Integer

search
Optional

結果をフィルタ

Validations:

  • Must be String

order
Optional

結果をソート

Validations:

  • Must be String

page
Optional

結果をページ分割

Validations:

  • Must be String

per_page
Optional

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

Validations:

  • Must be String


GET /api/subnets/:id
サブネットの表示

Params

Param Name Description
id
Required

Validations:

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


POST /api/subnets
サブネットの作成

Params

Param Name Description
subnet
Required

Validations:

  • Must be a Hash

subnet[name]
Required

サブネット名

Validations:

  • Must be String

subnet[network]
Required

サブネットネットワーク

Validations:

  • Must be String

subnet[mask]
Required

このサブネットのネットマスク

Validations:

  • Must be String

subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットのプライマリDNS

Validations:

  • Must be String

subnet[dns_primary]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットのプライマリDNS

Validations:

  • Must be String

subnet[dns_secondary]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットのセカンダリDNS

Validations:

  • Must be String

subnet[ipam]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットの IP アドレス自動補完モードです。有効な値は「DHCP」、「内部 DB」、「なし」です。

Validations:

  • Must be String

subnet[from]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

IP アドレスの自動提案のための起点 IP アドレス

Validations:

  • Must be String

subnet[to]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

IP アドレスの自動提案のための終点 IP アドレス

Validations:

  • Must be String

subnet[vlanid]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

サブネットの VLAN ID

Validations:

  • Must be String

subnet[domain_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットが含まれるドメイン

Validations:

  • Must be an array of any type

subnet[dhcp_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネット内で使用する DHCP プロキシ

Validations:

  • Must be a number.

subnet[tftp_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネット内で使用する TFTP プロキシー

Validations:

  • Must be a number.

subnet[dns_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネット内で使用する DNS プロキシ

Validations:

  • Must be a number.

subnet[boot_mode]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットに割り当てられたインターフェイスのデフォルトブートモード、有効な値は、「Static」、「DHCP」 です

Validations:

  • Must be String

subnet[subnet_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

パラメータの配列 (name, value)

Validations:

  • Must be an array of any type

subnet[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

subnet[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


PUT /api/subnets/:id
サブネットの更新

Params

Param Name Description
id
Required

サブネット数値識別子

Validations:

  • Must be a number.

subnet
Required

Validations:

  • Must be a Hash

subnet[name]
Optional

サブネット名

Validations:

  • Must be String

subnet[network]
Optional

サブネットネットワーク

Validations:

  • Must be String

subnet[mask]
Optional

このサブネットのネットマスク

Validations:

  • Must be String

subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットのプライマリDNS

Validations:

  • Must be String

subnet[dns_primary]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットのプライマリDNS

Validations:

  • Must be String

subnet[dns_secondary]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットのセカンダリDNS

Validations:

  • Must be String

subnet[ipam]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットの IP アドレス自動補完モードです。有効な値は「DHCP」、「内部 DB」、「なし」です。

Validations:

  • Must be String

subnet[from]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

IP アドレスの自動提案のための起点 IP アドレス

Validations:

  • Must be String

subnet[to]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

IP アドレスの自動提案のための終点 IP アドレス

Validations:

  • Must be String

subnet[vlanid]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

サブネットの VLAN ID

Validations:

  • Must be String

subnet[domain_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットが含まれるドメイン

Validations:

  • Must be an array of any type

subnet[dhcp_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネット内で使用する DHCP プロキシ

Validations:

  • Must be a number.

subnet[tftp_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネット内で使用する TFTP プロキシー

Validations:

  • Must be a number.

subnet[dns_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネット内で使用する DNS プロキシ

Validations:

  • Must be a number.

subnet[boot_mode]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

このサブネットに割り当てられたインターフェイスのデフォルトブートモード、有効な値は、「Static」、「DHCP」 です

Validations:

  • Must be String

subnet[subnet_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

パラメータの配列 (name, value)

Validations:

  • Must be an array of any type

subnet[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

subnet[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


DELETE /api/subnets/:id
サブネットの削除

Params

Param Name Description
id
Required

サブネット数値識別子

Validations:

  • Must be a number.