Hostgroups

>>>

GET /api/hostgroups
Afficher tous les groupes d'hôtes

GET /api/puppetclasses/:puppetclass_id/hostgroups
Afficher tous les groupes d'hôtes pour une classe Puppet

GET /api/locations/:location_id/hostgroups
Afficher tous les groupes d'hôtes par emplacement

GET /api/organizations/:organization_id/hostgroups
Afficher tous les groupes d'hôtes par organisation

Paramètres

Nom du paramètre Description
puppetclass_id
optionel

ID de la classe Puppet

Validations:

  • Must be a String
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer
organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer
search
optionel

filtrer les résultats

Validations:

  • Must be a String
order
optionel

Champ et sens de tri, ex: 'id DESC'

Validations:

  • Must be a String
page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.
per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.
include
optionel

Tableau de types d'informations supplémentaires à ajouter

Validations:

  • Must be an array of [“parameters”]

Rechercher les champs

Nom du champ Type Valeurs possibles
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 string
template
title
>>>

GET /api/hostgroups/:id
Afficher un groupe d'hôtes

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

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
optionel

Afficher les valeurs de paramètre masquées

Validations:

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

POST /api/hostgroups
Créer un groupe d'hôtes

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
hostgroup
requis

Validations:

  • Must be a Hash
hostgroup[name]
requis

Nom du groupe d'hôtes

Validations:

  • Must be a String
hostgroup[description]
optionel , nil autorisé

Description du groupe d'hôtes

Validations:

  • Must be a String
hostgroup[parent_id]
optionel , nil autorisé

ID du groupe d'hôtes parent

Validations:

  • Must be a number.
hostgroup[environment_id]
optionel , nil autorisé

ID de l'environnement

Validations:

  • Must be a number.
hostgroup[compute_profile_id]
optionel , nil autorisé

ID du profil de calcul

Validations:

  • Must be a number.
hostgroup[compute_resource_id]
optionel , nil autorisé

ID de ressource de calcul

Validations:

  • Must be a number.
hostgroup[operatingsystem_id]
optionel , nil autorisé

ID du système d'exploitation

Validations:

  • Must be a number.
hostgroup[architecture_id]
optionel , nil autorisé

ID de l'architecture

Validations:

  • Must be a number.
hostgroup[pxe_loader]
optionel , nil autorisé

option nom de fichier DHCP (Grub2/PXELinux par defaut)

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]
optionel , nil autorisé

ID du media

Validations:

  • Must be a number.
hostgroup[ptable_id]
optionel , nil autorisé

ID de la table de partition

Validations:

  • Must be a number.
hostgroup[subnet_id]
optionel , nil autorisé

ID du sous-réseau

Validations:

  • Must be a number.
hostgroup[subnet6_id]
optionel , nil autorisé

ID du sous-réseau IPv6

Validations:

  • Must be a number.
hostgroup[domain_id]
optionel , nil autorisé

ID du domaine

Validations:

  • Must be a number.
hostgroup[realm_id]
optionel , nil autorisé

ID du domaine

Validations:

  • Must be a number.
hostgroup[puppetclass_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type
hostgroup[config_group_ids]
optionel , nil autorisé

ID des groupes de configuration associés

Validations:

  • Must be an array of any type
hostgroup[group_parameters_attributes]
optionel , nil autorisé

Tableau des paramètres

Validations:

  • Must be an Array of nested elements
hostgroup[group_parameters_attributes][name]
requis

Nom du paramêtre

Validations:

  • Must be a String
hostgroup[group_parameters_attributes][value]
requis

Valeur du paramètre

Validations:

  • Must be a String
hostgroup[group_parameters_attributes][parameter_type]
optionel , nil autorisé

Type de valeur

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
hostgroup[group_parameters_attributes][hidden_value]
optionel , nil autorisé

Validations:

  • Must be one of: true, false, 1, 0.
hostgroup[puppet_proxy_id]
optionel , nil autorisé

ID du Proxy Puppet

Validations:

  • Must be a number.
hostgroup[puppet_ca_proxy_id]
optionel , nil autorisé

ID du Proxy Puppet CA

Validations:

  • Must be a number.
hostgroup[root_pass]
optionel , nil autorisé

Mot de passe root pour les machines provisionnées

Validations:

  • Must be a String
hostgroup[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type
hostgroup[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type
>>>

PUT /api/hostgroups/:id
Mise à jour d'un groupe d'hôtes

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

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
requis

Validations:

  • Must be a Hash
hostgroup[name]
optionel

Nom du groupe d'hôtes

Validations:

  • Must be a String
hostgroup[description]
optionel , nil autorisé

Description du groupe d'hôtes

Validations:

  • Must be a String
hostgroup[parent_id]
optionel , nil autorisé

ID du groupe d'hôtes parent

Validations:

  • Must be a number.
hostgroup[environment_id]
optionel , nil autorisé

ID de l'environnement

Validations:

  • Must be a number.
hostgroup[compute_profile_id]
optionel , nil autorisé

ID du profil de calcul

Validations:

  • Must be a number.
hostgroup[compute_resource_id]
optionel , nil autorisé

ID de ressource de calcul

Validations:

  • Must be a number.
hostgroup[operatingsystem_id]
optionel , nil autorisé

ID du système d'exploitation

Validations:

  • Must be a number.
hostgroup[architecture_id]
optionel , nil autorisé

ID de l'architecture

Validations:

  • Must be a number.
hostgroup[pxe_loader]
optionel , nil autorisé

option nom de fichier DHCP (Grub2/PXELinux par defaut)

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]
optionel , nil autorisé

ID du media

Validations:

  • Must be a number.
hostgroup[ptable_id]
optionel , nil autorisé

ID de la table de partition

Validations:

  • Must be a number.
hostgroup[subnet_id]
optionel , nil autorisé

ID du sous-réseau

Validations:

  • Must be a number.
hostgroup[subnet6_id]
optionel , nil autorisé

ID du sous-réseau IPv6

Validations:

  • Must be a number.
hostgroup[domain_id]
optionel , nil autorisé

ID du domaine

Validations:

  • Must be a number.
hostgroup[realm_id]
optionel , nil autorisé

ID du domaine

Validations:

  • Must be a number.
hostgroup[puppetclass_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type
hostgroup[config_group_ids]
optionel , nil autorisé

ID des groupes de configuration associés

Validations:

  • Must be an array of any type
hostgroup[group_parameters_attributes]
optionel , nil autorisé

Tableau des paramètres

Validations:

  • Must be an Array of nested elements
hostgroup[group_parameters_attributes][name]
optionel

Nom du paramêtre

Validations:

  • Must be a String
hostgroup[group_parameters_attributes][value]
optionel

Valeur du paramètre

Validations:

  • Must be a String
hostgroup[group_parameters_attributes][parameter_type]
optionel , nil autorisé

Type de valeur

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
hostgroup[group_parameters_attributes][hidden_value]
optionel , nil autorisé

Validations:

  • Must be one of: true, false, 1, 0.
hostgroup[puppet_proxy_id]
optionel , nil autorisé

ID du Proxy Puppet

Validations:

  • Must be a number.
hostgroup[puppet_ca_proxy_id]
optionel , nil autorisé

ID du Proxy Puppet CA

Validations:

  • Must be a number.
hostgroup[root_pass]
optionel , nil autorisé

Mot de passe root pour les machines provisionnées

Validations:

  • Must be a String
hostgroup[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type
hostgroup[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type
>>>

DELETE /api/hostgroups/:id
Supprimer un groupe d'hôtes

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

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
Cloner un groupe d'hôtes

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
name
requis

Validations:

  • Must be a String
>>>

PUT /api/hostgroups/:id/rebuild_config
Reconstruire la configuration d'orchestration

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

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
optionel

Limiter les étapes de reconstruction, les étapes valides sont DHCP, DNS, TFTP

Validations:

  • Must be an array of any type
children_hosts
optionel

Opérer sur les hôtes de groupes d'hôtes enfants

Validations:

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