Domains

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 des domaines

GET /api/subnets/:subnet_id/domains
Liste des domaines par sous-réseau

GET /api/locations/:location_id/domains
Liste des domaines par emplacement

GET /api/organizations/:organization_id/domains
Liste des domaines par organisation

Paramètres

Nom du paramètre Description
subnet_id
optionel

ID du sous-réseau

Validations:

  • Must be a String
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer
organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer
search
optionel

filtrer les résultats

Validations:

  • Must be a String
order
optionel

trier les resultats

Validations:

  • Must be a String
page
optionel

paginer les résultats

Validations:

  • Must be a String
per_page
optionel

nombre d'entier par requête

Validations:

  • Must be a String
>>>

GET /api/domains/:id
Afficher un domaine

Paramètres

Nom du paramètre Description
id
requis

ID numérique ou nom de domaine

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
optionel

Afficher les valeurs des paramètres cachés

Validations:

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

POST /api/domains
Créer un domaine

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ètres

Nom du paramètre Description
domain
requis

Validations:

  • Must be a Hash
domain[name]
requis

Le nom DNS complet

Validations:

  • Must be a String
domain[fullname]
optionel , nil autorisé

Description du domaine

Validations:

  • Must be a String
domain[dns_id]
optionel , nil autorisé

ID proxy DNS à utiliser dans ce domaine

Validations:

  • Must be a number.
domain[domain_parameters_attributes]
optionel , nil autorisé

Tableau de paramètres (nom, valeur)

Validations:

  • Must be an array of any type
domain[location_ids]
optionel , nil autorisé

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type
domain[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type
>>>

PUT /api/domains/:id
Mise à jour d'un domaine

Paramètres

Nom du paramètre Description
id
requis

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
requis

Validations:

  • Must be a Hash
domain[name]
optionel

Le nom DNS complet

Validations:

  • Must be a String
domain[fullname]
optionel , nil autorisé

Description du domaine

Validations:

  • Must be a String
domain[dns_id]
optionel , nil autorisé

ID proxy DNS à utiliser dans ce domaine

Validations:

  • Must be a number.
domain[domain_parameters_attributes]
optionel , nil autorisé

Tableau de paramètres (nom, valeur)

Validations:

  • Must be an array of any type
domain[location_ids]
optionel , nil autorisé

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type
domain[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type
>>>

DELETE /api/domains/:id
Supprimer un domaine

Paramètres

Nom du paramètre Description
id
requis

Validations:

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