GET /api/hostgroups
Llista tots els grups d'amfitrions

GET /api/puppetclasses/:puppetclass_id/hostgroups
Llista tots els grups d'amfitrions per a una classe de Puppet

GET /api/locations/:location_id/hostgroups
Llista tots els grups d'amfitrions per ubicació

GET /api/organizations/:organization_id/hostgroups
Llista tots els grups d'amfitrions per organització

Params

Param name Description
puppetclass_id
optional

ID de classe de Puppet

Validations:

  • String

location_id
optional

Abast per ubicacions

Validations:

  • Integer

organization_id
optional

Abast per organitzacions

Validations:

  • Integer

search
optional

filtra els resultats

Validations:

  • String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • String

page
optional

pagina els resultats

Validations:

  • String

per_page
optional

Nombre d'entrades per petició

Validations:

  • String

include
optional

Seqüència de tipus extres d'informació a incloure

Validations:

  • Must be an array of [“parameters”]

Search fields

Field name Tipus Possible values
architecture string
class string
config_group string
content_source string
content_view string
environment string
host string
id integer
label string
lifecycle_environment string
location string
location_id integer
medium string
name string
organization string
organization_id integer
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
params text
template string
title string

GET /api/hostgroups/:id
Mostra un grup d'amfitrions

Params

Param name Description
location_id
optional

Abast per ubicacions

Validations:

  • Integer

organization_id
optional

Abast per organitzacions

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

show_hidden_parameters
optional

Mostra els valors dels paràmetres ocults

Validations:

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


POST /api/hostgroups
Crea un grup d'amfitrions

Params

Param name Description
location_id
optional

Abast per ubicacions

Validations:

  • Integer

organization_id
optional

Abast per organitzacions

Validations:

  • Integer

hostgroup
required

Validations:

  • Hash

hostgroup[name]
required

Nom del grup d'amfitrions

Validations:

  • String

hostgroup[description]
optional , nil allowed

Descripció del grup d'amfitrions

Validations:

  • String

hostgroup[parent_id]
optional , nil allowed

ID de pare del grup d'amfitrions

Validations:

  • Must be a number.

hostgroup[environment_id]
optional , nil allowed

ID d'entorn

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
optional , nil allowed

ID de perfil computacional

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
optional , nil allowed

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional , nil allowed

ID de sistema operatiu

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional , nil allowed

ID d'arquitectura

Validations:

  • Must be a number.

hostgroup[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
optional , nil allowed

ID de mitjà

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional , nil allowed

ID de taula de particions

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional , nil allowed

ID de subxarxa

Validations:

  • Must be a number.

hostgroup[domain_id]
optional , nil allowed

ID de domini

Validations:

  • Must be a number.

hostgroup[realm_id]
optional , nil allowed

ID de reialme

Validations:

  • Must be a number.

hostgroup[config_group_ids]
optional , nil allowed

Els ID dels grups de configuracions

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil allowed

Seqüència de paràmetres

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
required

Nom del paràmetre

Validations:

  • String

hostgroup[group_parameters_attributes][value]
required

Valor del paràmetre

Validations:

  • String

hostgroup[puppet_proxy_id]
optional , nil allowed

ID de servidor intermediari de Puppet

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional , nil allowed

ID de servidor intermediari de l'AC de Puppet

Validations:

  • Must be a number.

hostgroup[root_pass]
optional , nil allowed

Contrasenya de root en els amfitrions aprovisionats

Validations:

  • String

hostgroup[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type

hostgroup[content_source_id]
optional

Content source ID

Validations:

  • Must be a number.

hostgroup[content_view_id]
optional

Content view ID

Validations:

  • Must be a number.

hostgroup[lifecycle_environment_id]
optional

Lifecycle environment ID

Validations:

  • Must be a number.

hostgroup[kickstart_repository_id]
optional

Kickstart repository ID

Validations:

  • Must be a number.


PUT /api/hostgroups/:id
Actualitza un grup d'amfitrions

Params

Param name Description
location_id
optional

Abast per ubicacions

Validations:

  • Integer

organization_id
optional

Abast per organitzacions

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

hostgroup
required

Validations:

  • Hash

hostgroup[name]
optional

Nom del grup d'amfitrions

Validations:

  • String

hostgroup[description]
optional , nil allowed

Descripció del grup d'amfitrions

Validations:

  • String

hostgroup[parent_id]
optional , nil allowed

ID de pare del grup d'amfitrions

Validations:

  • Must be a number.

hostgroup[environment_id]
optional , nil allowed

ID d'entorn

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
optional , nil allowed

ID de perfil computacional

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
optional , nil allowed

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional , nil allowed

ID de sistema operatiu

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional , nil allowed

ID d'arquitectura

Validations:

  • Must be a number.

hostgroup[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
optional , nil allowed

ID de mitjà

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional , nil allowed

ID de taula de particions

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional , nil allowed

ID de subxarxa

Validations:

  • Must be a number.

hostgroup[domain_id]
optional , nil allowed

ID de domini

Validations:

  • Must be a number.

hostgroup[realm_id]
optional , nil allowed

ID de reialme

Validations:

  • Must be a number.

hostgroup[config_group_ids]
optional , nil allowed

Els ID dels grups de configuracions

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil allowed

Seqüència de paràmetres

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
optional

Nom del paràmetre

Validations:

  • String

hostgroup[group_parameters_attributes][value]
optional

Valor del paràmetre

Validations:

  • String

hostgroup[puppet_proxy_id]
optional , nil allowed

ID de servidor intermediari de Puppet

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional , nil allowed

ID de servidor intermediari de l'AC de Puppet

Validations:

  • Must be a number.

hostgroup[root_pass]
optional , nil allowed

Contrasenya de root en els amfitrions aprovisionats

Validations:

  • String

hostgroup[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type

hostgroup[content_source_id]
optional

Content source ID

Validations:

  • Must be a number.

hostgroup[content_view_id]
optional

Content view ID

Validations:

  • Must be a number.

hostgroup[lifecycle_environment_id]
optional

Lifecycle environment ID

Validations:

  • Must be a number.

hostgroup[kickstart_repository_id]
optional

Kickstart repository ID

Validations:

  • Must be a number.


DELETE /api/hostgroups/:id
Suprimeix un grup d'amfitrions

Params

Param name Description
location_id
optional

Abast per ubicacions

Validations:

  • Integer

organization_id
optional

Abast per organitzacions

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


POST /api/hostgroups/:id/clone
Clona un grup d'amfitrions

Params

Param name Description
location_id
optional

Abast per ubicacions

Validations:

  • Integer

organization_id
optional

Abast per organitzacions

Validations:

  • Integer

name
required

Validations:

  • String


PUT /api/hostgroups/:id/rebuild_config
Rebuild orchestration config

Params

Param name Description
location_id
optional

Abast per ubicacions

Validations:

  • Integer

organization_id
optional

Abast per organitzacions

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

only
optional

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type

children_hosts
optional

Operate on child hostgroup hosts

Validations:

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