GET /api/hostgroups
Listar todos los grupos de hosts

GET /api/puppetclasses/:puppetclass_id/hostgroups
Listarr los grupos de hosts para una clase Puppet

GET /api/locations/:location_id/hostgroups
Listar los grupos de hosts por ubicación

GET /api/organizations/:organization_id/hostgroups
Listar todos los grupos de hosts por organización

Parámetros

Nombre del parámetro Descripción
puppetclass_id
opcional

ID de la clase Puppet

Validations:

  • String

location_id
opcional

Alcance por ubicación

Validations:

  • Integer

organization_id
opcional

Alcance por organización

Validations:

  • Integer

search
opcional

filtrar resultados

Validations:

  • String

order
opcional

Sort field and order, eg. ‘id DESC’

Validations:

  • String

page
opcional

paginar resultados

Validations:

  • String

per_page
opcional

número de entradas por solicitud

Validations:

  • String

include
opcional

Serie de tipos de información adicionales para incluir

Validations:

  • Must be an array of [“parameters”]

Campos de búsqueda

Nombre del campo Tipo Valores posibles
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
Mostrar un grupo de hosts

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Integer

organization_id
opcional

Alcance por organización

Validations:

  • Integer

id
requerido

Validations:

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

show_hidden_parameters
opcional

Mostrar valores de parámetros ocultos

Validations:

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


POST /api/hostgroups
Crear un grupo de hosts

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Integer

organization_id
opcional

Alcance por organización

Validations:

  • Integer

hostgroup
requerido

Validations:

  • Hash

hostgroup[name]
requerido

Nombre del grupo de hosts

Validations:

  • String

hostgroup[description]
opcional , nil permitido

Descripción del grupo de hosts

Validations:

  • String

hostgroup[parent_id]
opcional , nil permitido

ID padre del grupo de hosts

Validations:

  • Must be a number.

hostgroup[environment_id]
opcional , nil permitido

ID de entorno

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
opcional , nil permitido

ID del perfil de computación

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
opcional , nil permitido

ID de recurso de cómputo

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
opcional , nil permitido

ID del sistema operativo

Validations:

  • Must be a number.

hostgroup[architecture_id]
opcional , nil permitido

ID de arquitectura

Validations:

  • Must be a number.

hostgroup[pxe_loader]
opcional , nil permitido

Opción de nombre de archivo DHCP (Grub2/PXELinux por defecto)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, 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]
opcional , nil permitido

ID de medios

Validations:

  • Must be a number.

hostgroup[ptable_id]
opcional , nil permitido

ID de la tabla de particiones

Validations:

  • Must be a number.

hostgroup[subnet_id]
opcional , nil permitido

ID de subred

Validations:

  • Must be a number.

hostgroup[domain_id]
opcional , nil permitido

ID de dominio

Validations:

  • Must be a number.

hostgroup[realm_id]
opcional , nil permitido

ID de reino

Validations:

  • Must be a number.

hostgroup[config_group_ids]
opcional , nil permitido

ID de grupos de configuración asociados

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
opcional , nil permitido

Conjunto de parámetros

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
requerido

Nombre del parámetro

Validations:

  • String

hostgroup[group_parameters_attributes][value]
requerido

Valor del parámetro

Validations:

  • String

hostgroup[puppet_proxy_id]
opcional , nil permitido

ID del Proxy Puppet

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
opcional , nil permitido

ID del Proxy Puppet CA

Validations:

  • Must be a number.

hostgroup[root_pass]
opcional , nil permitido

Contraseña raíz en hosts aprovisionados

Validations:

  • String

hostgroup[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type

hostgroup[content_source_id]
opcional

Content source ID

Validations:

  • Must be a number.

hostgroup[content_view_id]
opcional

Content view ID

Validations:

  • Must be a number.

hostgroup[lifecycle_environment_id]
opcional

Lifecycle environment ID

Validations:

  • Must be a number.

hostgroup[kickstart_repository_id]
opcional

Kickstart repository ID

Validations:

  • Must be a number.


PUT /api/hostgroups/:id
Actualizar un grupo de hosts

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Integer

organization_id
opcional

Alcance por organización

Validations:

  • Integer

id
requerido

Validations:

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

hostgroup
requerido

Validations:

  • Hash

hostgroup[name]
opcional

Nombre del grupo de hosts

Validations:

  • String

hostgroup[description]
opcional , nil permitido

Descripción del grupo de hosts

Validations:

  • String

hostgroup[parent_id]
opcional , nil permitido

ID padre del grupo de hosts

Validations:

  • Must be a number.

hostgroup[environment_id]
opcional , nil permitido

ID de entorno

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
opcional , nil permitido

ID del perfil de computación

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
opcional , nil permitido

ID de recurso de cómputo

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
opcional , nil permitido

ID del sistema operativo

Validations:

  • Must be a number.

hostgroup[architecture_id]
opcional , nil permitido

ID de arquitectura

Validations:

  • Must be a number.

hostgroup[pxe_loader]
opcional , nil permitido

Opción de nombre de archivo DHCP (Grub2/PXELinux por defecto)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, 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]
opcional , nil permitido

ID de medios

Validations:

  • Must be a number.

hostgroup[ptable_id]
opcional , nil permitido

ID de la tabla de particiones

Validations:

  • Must be a number.

hostgroup[subnet_id]
opcional , nil permitido

ID de subred

Validations:

  • Must be a number.

hostgroup[domain_id]
opcional , nil permitido

ID de dominio

Validations:

  • Must be a number.

hostgroup[realm_id]
opcional , nil permitido

ID de reino

Validations:

  • Must be a number.

hostgroup[config_group_ids]
opcional , nil permitido

ID de grupos de configuración asociados

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
opcional , nil permitido

Conjunto de parámetros

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
opcional

Nombre del parámetro

Validations:

  • String

hostgroup[group_parameters_attributes][value]
opcional

Valor del parámetro

Validations:

  • String

hostgroup[puppet_proxy_id]
opcional , nil permitido

ID del Proxy Puppet

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
opcional , nil permitido

ID del Proxy Puppet CA

Validations:

  • Must be a number.

hostgroup[root_pass]
opcional , nil permitido

Contraseña raíz en hosts aprovisionados

Validations:

  • String

hostgroup[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type

hostgroup[content_source_id]
opcional

Content source ID

Validations:

  • Must be a number.

hostgroup[content_view_id]
opcional

Content view ID

Validations:

  • Must be a number.

hostgroup[lifecycle_environment_id]
opcional

Lifecycle environment ID

Validations:

  • Must be a number.

hostgroup[kickstart_repository_id]
opcional

Kickstart repository ID

Validations:

  • Must be a number.


DELETE /api/hostgroups/:id
Borrar un grupo de hosts

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Integer

organization_id
opcional

Alcance por organización

Validations:

  • Integer

id
requerido

Validations:

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


POST /api/hostgroups/:id/clone
Clonar un grupo de hosts

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Integer

organization_id
opcional

Alcance por organización

Validations:

  • Integer

name
requerido

Validations:

  • String


PUT /api/hostgroups/:id/rebuild_config
Volver a construir la configuración de orquestación

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Integer

organization_id
opcional

Alcance por organización

Validations:

  • Integer

id
requerido

Validations:

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

only
opcional

Limitar los pasos de reconstrucción. Los pasos válidos son DHCP, DNS, TFTP

Validations:

  • Must be an array of any type

children_hosts
opcional

Operar en hosts del grupo de hosts secundario

Validations:

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