Foreman considers a domain and a DNS zone as the same thing. That is, if you are planning to manage a site where all the machines are of the form hostname.somewhere.com then the domain is somewhere.com. This allows Foreman to associate a puppet variable with a domain/site and automatically append this variable to all external node requests made by machines at that site.


GET /api/domains
ドメインの一覧

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

GET /api/locations/:location_id/domains
ロケーションごとのドメインの一覧

GET /api/organizations/:organization_id/domains
組織ごとのドメインの一覧

パラメーター

パラメーター名 記述
subnet_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/domains/:id
ドメインの表示

パラメーター

パラメーター名 記述
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/domains
ドメインの作成

The fullname field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter

パラメーター

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

Validations:

  • Must be a Hash

domain[name]
必須

完全 DNS ドメイン名

Validations:

  • Must be a String

domain[fullname]
任意 , nil可

ドメインの説明

Validations:

  • Must be a String

domain[dns_id]
任意 , nil可

このドメイン内で使用する DNS プロキシー ID

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
任意 , nil可

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

Validations:

  • Must be an array of any type

domain[location_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

domain[organization_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type


PUT /api/domains/: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.

domain
必須

Validations:

  • Must be a Hash

domain[name]
任意

完全 DNS ドメイン名

Validations:

  • Must be a String

domain[fullname]
任意 , nil可

ドメインの説明

Validations:

  • Must be a String

domain[dns_id]
任意 , nil可

このドメイン内で使用する DNS プロキシー ID

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
任意 , nil可

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

Validations:

  • Must be an array of any type

domain[location_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

domain[organization_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type


DELETE /api/domains/: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.