GET /api/hostgroups
Listar todos os grupos de host

GET /api/puppetclasses/:puppetclass_id/hostgroups
Listar todos os grupos de host para uma classe Puppet

GET /api/locations/:location_id/hostgroups
Listar todos os grupos de host por localização

GET /api/organizations/:organization_id/hostgroups
Listar todos os grupos de host por organização

Params

Param Name Description
puppetclass_id
Optional

ID da classe puppet


Value: Must be String
search
Optional

filtrar resultados


Value: Must be String
order
Optional

ordenar resultados


Value: Must be String
page
Optional

paginar resultados


Value: Must be String
per_page
Optional

número de entradas por requisições


Value: Must be String

GET /api/hostgroups/:id
Mostrar um grupo de host

Params

Param Name Description
id
Required

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

POST /api/hostgroups
Criar um grupo de host

Params

Param Name Description
hostgroup
Required

Value: Must be a Hash
hostgroup[name]
Required

Nome do grupo de hosts


Value: Must be String
hostgroup[parent_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Parent ID of the host group


Value: Must be a number.
hostgroup[environment_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Environment ID


Value: Must be a number.
hostgroup[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Compute profile ID


Value: Must be a number.
hostgroup[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Operating system ID


Value: Must be a number.
hostgroup[architecture_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Architecture ID


Value: Must be a number.
hostgroup[medium_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Media ID


Value: Must be a number.
hostgroup[ptable_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Partition table ID


Value: Must be a number.
hostgroup[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Puppet CA proxy ID


Value: Must be a number.
hostgroup[subnet_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Subnet ID


Value: Must be a number.
hostgroup[domain_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Domain ID


Value: Must be a number.
hostgroup[realm_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Realm ID


Value: Must be a number.
hostgroup[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Puppet proxy ID


Value: Must be a number.
hostgroup[root_pass]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Root password on provisioned hosts


Value: Must be String

PUT /api/hostgroups/:id
Atualizar um grupo de host

Params

Param Name Description
id
Required

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

Value: Must be a Hash
hostgroup[name]
Optional

Nome do grupo de hosts


Value: Must be String
hostgroup[parent_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Parent ID of the host group


Value: Must be a number.
hostgroup[environment_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Environment ID


Value: Must be a number.
hostgroup[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Compute profile ID


Value: Must be a number.
hostgroup[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Operating system ID


Value: Must be a number.
hostgroup[architecture_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Architecture ID


Value: Must be a number.
hostgroup[medium_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Media ID


Value: Must be a number.
hostgroup[ptable_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Partition table ID


Value: Must be a number.
hostgroup[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Puppet CA proxy ID


Value: Must be a number.
hostgroup[subnet_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Subnet ID


Value: Must be a number.
hostgroup[domain_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Domain ID


Value: Must be a number.
hostgroup[realm_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Realm ID


Value: Must be a number.
hostgroup[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Puppet proxy ID


Value: Must be a number.
hostgroup[root_pass]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Root password on provisioned hosts


Value: Must be String

DELETE /api/hostgroups/:id
Apagar um grupo de host

Params

Param Name Description
id
Required

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

POST /api/hostgroups/:id/clone
Escolha um grupo de host

Params

Param Name Description
name
Required

Value: Must be String