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
Llista dels dominis

GET /api/subnets/:subnet_id/domains
Llista dels dominis per subxarxa

GET /api/locations/:location_id/domains
Llista dels dominis per ubicació

GET /api/organizations/:organization_id/domains
Llista dels dominis per organització

Params

Param name Description
subnet_id
optional

Id. de subxarxa

Validations:

  • Must be a String
location_id
optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
optional

Abast per organitzacions

Validations:

  • Must be a Integer
search
optional

filtra els resultats

Validations:

  • Must be a String
order
optional

ordena els resultats

Validations:

  • Must be a String
page
optional

pagina els resultats

Validations:

  • Must be a String
per_page
optional

Nombre d'entrades per petició

Validations:

  • Must be a String
>>>

GET /api/domains/:id
Mostra un domini

Params

Param name Description
id
required

Id. numèric o nom de domini

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
Crea un domini

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

Params

Param name Description
domain
required

Validations:

  • Must be a Hash
domain[name]
required

Tot el nom de domini DNS

Validations:

  • Must be a String
domain[fullname]
optional , nil allowed

Descripció del domini

Validations:

  • Must be a String
domain[dns_id]
optional , nil allowed

DNS proxy ID to use within this domain

Validations:

  • Must be a number.
domain[domain_parameters_attributes]
optional , nil allowed

Array of parameters (name, value)

Validations:

  • Must be an array of any type
domain[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els id. donats

Validations:

  • Must be an array of any type
domain[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els id. donats.

Validations:

  • Must be an array of any type
>>>

PUT /api/domains/:id
Actualitza un domini

Params

Param name Description
id
required

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
required

Validations:

  • Must be a Hash
domain[name]
optional

Tot el nom de domini DNS

Validations:

  • Must be a String
domain[fullname]
optional , nil allowed

Descripció del domini

Validations:

  • Must be a String
domain[dns_id]
optional , nil allowed

DNS proxy ID to use within this domain

Validations:

  • Must be a number.
domain[domain_parameters_attributes]
optional , nil allowed

Array of parameters (name, value)

Validations:

  • Must be an array of any type
domain[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els id. donats

Validations:

  • Must be an array of any type
domain[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els id. donats.

Validations:

  • Must be an array of any type
>>>

DELETE /api/domains/:id
Suprimeix un domini

Params

Param name Description
id
required

Validations:

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