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.
Param Name | Description |
---|---|
subnet_id Optional |
ID of subnet Validations:
|
location_id Optional |
Scope by locations Validations:
|
organization_id Optional |
Scope by organisations Validations:
|
search Optional |
filter results Validations:
|
order Optional |
sort results Validations:
|
page Optional |
paginate results Validations:
|
per_page Optional |
number of entries per request Validations:
|
Param Name | Description |
---|---|
id Required |
Numerical ID or domain name Validations:
|
show_hidden_parameters Optional |
Display hidden parameter values Validations:
|
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
Param Name | Description |
---|---|
domain Required |
Validations:
|
domain[name] Required |
The full DNS domain name Validations:
|
domain[fullname] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Description of the domain Validations:
|
domain[dns_id] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
DNS proxy ID to use within this domain Validations:
|
domain[domain_parameters_attributes] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Array of parameters (name, value) Validations:
|
domain[location_ids] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
REPLACE locations with given ids Validations:
|
domain[organization_ids] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
REPLACE organisations with given ids. Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
domain Required |
Validations:
|
domain[name] Optional |
The full DNS domain name Validations:
|
domain[fullname] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Description of the domain Validations:
|
domain[dns_id] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
DNS proxy ID to use within this domain Validations:
|
domain[domain_parameters_attributes] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Array of parameters (name, value) Validations:
|
domain[location_ids] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
REPLACE locations with given ids Validations:
|
domain[organization_ids] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
REPLACE organisations with given ids. Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|