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
Lista de domínios

GET /api/subnets/:subnet_id/domains
Lista de domínios por subrede

GET /api/locations/:location_id/domains
Lista de domínios por localização

GET /api/organizations/:organization_id/domains
Lista de domínios por organização

Parâmentros

Nome parâmetro Descrição
subnet_id
opcional

ID da subrede

Validations:

  • Must be a String

location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

ordenar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be a String


GET /api/domains/:id
Mostrar um domínio

Parâmentros

Nome parâmetro Descrição
id
requerido

ID númerico ou nome do domínio

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
opcional

Display hidden parameter values

Validations:

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


POST /api/domains
Criar um domínio

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

Parâmentros

Nome parâmetro Descrição
domain
requerido

Validations:

  • Must be a Hash

domain[name]
requerido

Nome de domínio DNS completo

Validations:

  • Must be a String

domain[fullname]
opcional , nulo permitido

Descrição para o domínio

Validations:

  • Must be a String

domain[dns_id]
opcional , nulo permitido

ID do proxy DNS a ser usado neste domínio

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
opcional , nulo permitido

Array de parâmetros(name, value)

Validations:

  • Must be an array of any type

domain[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

domain[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


PUT /api/domains/:id
Atualizar um domínio

Parâmentros

Nome parâmetro Descrição
id
requerido

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
requerido

Validations:

  • Must be a Hash

domain[name]
opcional

Nome de domínio DNS completo

Validations:

  • Must be a String

domain[fullname]
opcional , nulo permitido

Descrição para o domínio

Validations:

  • Must be a String

domain[dns_id]
opcional , nulo permitido

ID do proxy DNS a ser usado neste domínio

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
opcional , nulo permitido

Array de parâmetros(name, value)

Validations:

  • Must be an array of any type

domain[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

domain[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


DELETE /api/domains/:id
Apagar um domínio

Parâmentros

Nome parâmetro Descrição
id
requerido

Validations:

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