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

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

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

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

パラメーター

パラメーター名 記述
domain_id
任意

ドメインの ID

Validations:

  • Must be a String

location_id
任意

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

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


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

パラメーター

パラメーター名 記述
id
必須

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
任意

非表示のパラメーター値の表示

Validations:

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


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

パラメーター

パラメーター名 記述
subnet
必須

Validations:

  • Must be a Hash

subnet[name]
必須

サブネット名

Validations:

  • Must be a String

subnet[description]
任意 , nil可

Subnet description

Validations:

  • Must be a String

subnet[network_type]
任意 , nil可

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

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
必須

サブネットネットワーク

Validations:

  • Must be a String

subnet[mask]
必須

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

Validations:

  • Must be a String

subnet[gateway]
任意 , nil可

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

Validations:

  • Must be a String

subnet[dns_primary]
任意 , nil可

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

Validations:

  • Must be a String

subnet[dns_secondary]
任意 , nil可

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

Validations:

  • Must be a String

subnet[ipam]
任意 , nil可

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

Validations:

  • Must be a String

subnet[from]
任意 , nil可

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

Validations:

  • Must be a String

subnet[to]
任意 , nil可

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

Validations:

  • Must be a String

subnet[vlanid]
任意 , nil可

このサブネットの VLAN ID

Validations:

  • Must be a String

subnet[domain_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

subnet[dhcp_id]
任意 , nil可

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

Validations:

  • Must be a number.

subnet[tftp_id]
任意 , nil可

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

Validations:

  • Must be a number.

subnet[dns_id]
任意 , nil可

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

Validations:

  • Must be a number.

subnet[boot_mode]
任意 , nil可

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

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
任意 , nil可

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

Validations:

  • Must be an array of any type

subnet[location_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

subnet[organization_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type


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

パラメーター

パラメーター名 記述
id
必須

サブネットの数値 ID

Validations:

  • Must be a number.

subnet
必須

Validations:

  • Must be a Hash

subnet[name]
任意

サブネット名

Validations:

  • Must be a String

subnet[description]
任意 , nil可

Subnet description

Validations:

  • Must be a String

subnet[network_type]
任意 , nil可

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

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
任意

サブネットネットワーク

Validations:

  • Must be a String

subnet[mask]
任意

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

Validations:

  • Must be a String

subnet[gateway]
任意 , nil可

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

Validations:

  • Must be a String

subnet[dns_primary]
任意 , nil可

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

Validations:

  • Must be a String

subnet[dns_secondary]
任意 , nil可

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

Validations:

  • Must be a String

subnet[ipam]
任意 , nil可

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

Validations:

  • Must be a String

subnet[from]
任意 , nil可

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

Validations:

  • Must be a String

subnet[to]
任意 , nil可

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

Validations:

  • Must be a String

subnet[vlanid]
任意 , nil可

このサブネットの VLAN ID

Validations:

  • Must be a String

subnet[domain_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

subnet[dhcp_id]
任意 , nil可

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

Validations:

  • Must be a number.

subnet[tftp_id]
任意 , nil可

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

Validations:

  • Must be a number.

subnet[dns_id]
任意 , nil可

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

Validations:

  • Must be a number.

subnet[boot_mode]
任意 , nil可

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

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
任意 , nil可

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

Validations:

  • Must be an array of any type

subnet[location_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

subnet[organization_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type


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

パラメーター

パラメーター名 記述
id
必須

サブネットの数値 ID

Validations:

  • Must be a number.


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

パラメーター

パラメーター名 記述
id
必須

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
任意

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

Validations:

  • Must be a String

excluded_ips
任意

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

Validations:

  • Must be an array of any type