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:

  • Must be a String

location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., 'id DESC'

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

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
class
config_group string
environment
host
id
label
location
location_id
medium
name
organization
organization_id
os
os_description
os_id
os_major
os_minor
os_title
params
template
title

GET /api/hostgroups/:id
Mostrar un grupo de hosts

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

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.

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

hostgroup
requerido

Validations:

  • Must be a Hash

hostgroup[name]
requerido

Nombre del grupo de hosts

Validations:

  • Must be a String

hostgroup[description]
opcional , nil permitido

Descripción del grupo de hosts

Validations:

  • Must be a 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 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]
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[subnet6_id]
opcional , nil permitido

Subnet IPv6 ID

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[puppetclass_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

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:

  • Must be a String

hostgroup[group_parameters_attributes][value]
requerido

Valor del parámetro

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][parameter_type]
opcional , nil permitido

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

hostgroup[group_parameters_attributes][hidden_value]
opcional , nil permitido

Validations:

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

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:

  • Must be a 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


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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

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.

hostgroup
requerido

Validations:

  • Must be a Hash

hostgroup[name]
opcional

Nombre del grupo de hosts

Validations:

  • Must be a String

hostgroup[description]
opcional , nil permitido

Descripción del grupo de hosts

Validations:

  • Must be a 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 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]
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[subnet6_id]
opcional , nil permitido

Subnet IPv6 ID

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[puppetclass_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

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:

  • Must be a String

hostgroup[group_parameters_attributes][value]
opcional

Valor del parámetro

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][parameter_type]
opcional , nil permitido

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

hostgroup[group_parameters_attributes][hidden_value]
opcional , nil permitido

Validations:

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

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:

  • Must be a 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


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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

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.


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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

name
requerido

Validations:

  • Must be a 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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

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.

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.