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
Liste der Domänen

GET /api/subnets/:subnet_id/domains
Liste der Domänen pro Subnetz

GET /api/locations/:location_id/domains
Liste der Domänen pro Standort

GET /api/organizations/:organization_id/domains
Liste der Domänen pro Organisation

Parameter

Parametername Beschreibung
subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String

location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Ergebnisse sortieren

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


GET /api/domains/:id
Domäne anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

Numerische Kennung oder Domänenname

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/domains
Domäne erstellen

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

Parameter

Parametername Beschreibung
domain
verpflichtend

Validations:

  • Must be a Hash

domain[name]
verpflichtend

Der vollständige DNS-Domänenname

Validations:

  • Must be a String

domain[fullname]
optional , nil erlaubt

Beschreibung der Domäne

Validations:

  • Must be a String

domain[dns_id]
optional , nil erlaubt

DNS proxy ID to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
optional , nil erlaubt

Abfolge von Parametern (name, value)

Validations:

  • Must be an array of any type

domain[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

domain[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


PUT /api/domains/:id
Domain Aktualisieren

Parameter

Parametername Beschreibung
id
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

domain[name]
optional

Der vollständige DNS-Domänenname

Validations:

  • Must be a String

domain[fullname]
optional , nil erlaubt

Beschreibung der Domäne

Validations:

  • Must be a String

domain[dns_id]
optional , nil erlaubt

DNS proxy ID to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
optional , nil erlaubt

Abfolge von Parametern (name, value)

Validations:

  • Must be an array of any type

domain[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

domain[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


DELETE /api/domains/:id
Domäne löschen

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

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