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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Descripció del grup d'amfitrions

Validations:

  • String

hostgroup[parent_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de pare del grup d'amfitrions

Validations:

  • Must be a number.

hostgroup[environment_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID d'entorn

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de perfil computacional

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de sistema operatiu

Validations:

  • Must be a number.

hostgroup[architecture_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID d'arquitectura

Validations:

  • Must be a number.

hostgroup[pxe_loader]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

hostgroup[medium_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de mitjà

Validations:

  • Must be a number.

hostgroup[ptable_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de taula de particions

Validations:

  • Must be a number.

hostgroup[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de subxarxa

Validations:

  • Must be a number.

hostgroup[subnet6_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de domini

Validations:

  • Must be a number.

hostgroup[realm_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de reialme

Validations:

  • Must be a number.

hostgroup[config_group_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Els ID dels grups de configuracions

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de servidor intermediari de Puppet

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de servidor intermediari de l'AC de Puppet

Validations:

  • Must be a number.

hostgroup[root_pass]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Contrasenya de root en els amfitrions aprovisionats

Validations:

  • String

hostgroup[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Descripció del grup d'amfitrions

Validations:

  • String

hostgroup[parent_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de pare del grup d'amfitrions

Validations:

  • Must be a number.

hostgroup[environment_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID d'entorn

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de perfil computacional

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de sistema operatiu

Validations:

  • Must be a number.

hostgroup[architecture_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID d'arquitectura

Validations:

  • Must be a number.

hostgroup[pxe_loader]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

hostgroup[medium_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de mitjà

Validations:

  • Must be a number.

hostgroup[ptable_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de taula de particions

Validations:

  • Must be a number.

hostgroup[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de subxarxa

Validations:

  • Must be a number.

hostgroup[subnet6_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de domini

Validations:

  • Must be a number.

hostgroup[realm_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de reialme

Validations:

  • Must be a number.

hostgroup[config_group_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Els ID dels grups de configuracions

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de servidor intermediari de Puppet

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de servidor intermediari de l'AC de Puppet

Validations:

  • Must be a number.

hostgroup[root_pass]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Contrasenya de root en els amfitrions aprovisionats

Validations:

  • String

hostgroup[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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.