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 a String

location_id
Optional

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
Optional

組織別のスコープ

Validations:

  • Must be a Integer

search
Optional

結果のフィルター

Validations:

  • Must be a String

order
Optional

結果のソート

Validations:

  • Must be a String

page
Optional

結果のページネーション

Validations:

  • Must be a String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be a 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.

show_hidden_parameters
Optional

Display hidden parameter values

Validations:

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


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

Params

Param Name Description
subnet
Required

Validations:

  • Must be a Hash

subnet[name]
Required

サブネット名

Validations:

  • Must be a String

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

タイプまたはプロトコル、IPv4 または IPv6、デフォルト値は IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
Required

サブネットネットワーク

Validations:

  • Must be a String

subnet[mask]
Required

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

IP 自動補完の開始 IP アドレス

Validations:

  • Must be a String

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

IP 自動補完の終了 IP アドレス

Validations:

  • Must be a String

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

このサブネットの VLAN ID

Validations:

  • Must be a 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 プロキシー ID

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a String

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

パラメーター (名前、値) の配列

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

サブネットの数値 ID

Validations:

  • Must be a number.

subnet
Required

Validations:

  • Must be a Hash

subnet[name]
Optional

サブネット名

Validations:

  • Must be a String

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

タイプまたはプロトコル、IPv4 または IPv6、デフォルト値は IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
Optional

サブネットネットワーク

Validations:

  • Must be a String

subnet[mask]
Optional

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

IP 自動補完の開始 IP アドレス

Validations:

  • Must be a String

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

IP 自動補完の終了 IP アドレス

Validations:

  • Must be a String

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

このサブネットの VLAN ID

Validations:

  • Must be a 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 プロキシー ID

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a String

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

パラメーター (名前、値) の配列

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

サブネットの数値 ID

Validations:

  • Must be a number.


GET /api/subnets/:id/freeip
このサブネットの未使用の IP アドレスを提供

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.

mac
Optional

このホスト用の IP を再使用するための MAC アドレス

Validations:

  • Must be a String

excluded_ips
Optional

提案から除外する必要がある IP アドレス

Validations:

  • Must be an array of any type